Você precisa das taxas de hipoteca de 2 anos atuais que pode inserir em seu aplicativo esta semana. Ao final deste guia, você chamará um endpoint real que retorna dados de taxas de hipoteca fixas de 2 anos (com provedores e pagamentos de exemplo), analisá-los-á e enviará uma integração funcional.
O que você obtém da API de Taxas de Hipoteca do Canadá
A API de Taxas de Hipoteca do Canadá expõe listagens de hipoteca a taxa fixa por prazo. Ela retorna arrays estruturados de taxas com o nome do credor/provedor e um pagamento periódico de exemplo. Isso é útil para:
- Widgets de comparação de taxas e páginas de destino que devem permanecer atualizados.
- Fluxos de pré-qualificação onde os usuários escolhem um prazo e um credor.
- Roteamento de leads e e-mails de alerta de taxas em mercados de hipoteca.
No Zyla API Hub, você usa uma conta, uma chave de API e um modelo de assinatura e cota em milhares de APIs. Para este caso de uso financeiro, focaremos no endpoint de 2 anos e também notaremos opções de 3 anos e 5 anos da mesma listagem.
Começando no Zyla API Hub
Abra a página do marketplace da API e inicie um teste para obter sua chave:
- Visite a listagem: Iniciar teste de 7 dias na API de Taxas de Hipoteca do Canadá.
- Clique em Assinar ou Iniciar Teste Gratuito (quando disponível) e copie sua chave de API.
- Autentique-se com Authorization: Bearer YOUR_API_KEY.
A cobrança no Zyla é por assinatura + cota (não por chamada). Verifique a página da API para opções de acesso e preços atuais.
Endpoints que você pode chamar
Todos os endpoints abaixo são solicitações POST e, de acordo com a documentação, não requerem parâmetros de solicitação. Envie apenas o cabeçalho de Autorização.
Taxas de Hipoteca 2 Anos
- Método: POST
- URL: https://zylalabs.com/api/5180/canada-mortgage-rates-api/11347/mortgage-rates-2-year
- Descrição: Retorna uma lista de taxas de hipoteca fixas de 2 anos com nomes de provedores e pagamentos de exemplo.
exemplo de cURL (copiar-colar):
curl -s -X POST "https://zylalabs.com/api/5180/canada-mortgage-rates-api/11347/mortgage-rates-2-year" \
-H "Authorization: Bearer YOUR_API_KEY"
Taxas de Hipoteca 3 Anos
- Método: POST
- URL: https://zylalabs.com/api/5180/canada-mortgage-rates-api/11348/mortgage-rates-3-year
- Descrição: Retorna uma lista de taxas de hipoteca fixas de 3 anos com nomes de provedores e pagamentos de exemplo.
exemplo de cURL:
Taxas de Hipoteca 5 Anos
- Método: POST
- URL: https://zylalabs.com/api/5180/canada-mortgage-rates-api/11349/mortgage-rates-5-year
- Descrição: Retorna uma lista de taxas de hipoteca fixas de 5 anos com nomes de provedores e pagamentos de exemplo.
exemplo de cURL:
Formato de resposta oficial de 2 anos
Abaixo está o exemplo oficial para o endpoint de 2 anos. Use-o para moldar seus modelos e testes.
[
{
"best_2_year_fixed_mortgage_rates": [
{
"rate": "3.99%",
"provider": "Big 6 Bank",
"payment": "$2,077"
},
{
"rate": "4.09%",
"provider": "Scotiabank",
"payment": "$2,098"
},
{
"rate": "4.49%",
"provider": "CanwiseA Ratehub.ca Company",
"payment": "$2,185"
},
{
"rate": "4.49%",
"provider": "Canadian LenderRatehub.ca Exclusive",
"payment": "$2,185"
},
{
"rate": "4.59%",
"provider": "TD Bank",
"payment": "$2,207"
},
{
"rate": "4.64%",
"provider": "MCAP",
"payment": "$2,218"
},
{
"rate": "4.74%",
"provider": "First National",
"payment": "$2,240"
},
{
"rate": "4.79%",
"provider": "RBC Royal Bank",
"payment": "$2,251"
},
{
"rate": "4.84%",
"provider": "National Bank of Canada",
"payment": "$2,263"
},
{
"rate": "4.93%",
"provider": "Bank of Montreal",
"payment": "$2,283"
},
{
"rate": "5.14%",
"provider": "Alterna Savings",
"payment": "$2,330"
},
{
"rate": "5.74%",
"provider": "Meridian Credit Union",
"payment": "$2,468"
},
{
"rate": "7.54%",
"provider": "ICICI Bank Canada",
"payment": "$2,901"
},
{
"rate": "4.49%",
"provider": "CIBC",
"payment": "$2,185"
},
{
"rate": "5.14%",
"provider": "Tangerine",
"payment": "$2,330"
},
{
"rate": "5.74%",
"provider": "Simplii Financial",
"payment": "$2,468"
}
]
}
]
O que ler:
- best_2_year_fixed_mortgage_rates: array de entradas de taxa para o prazo de 2 anos.
- Cada entrada inclui:
- rate: string percentual.
- provider: nome do credor ou instituição.
- payment: string de pagamento periódico de exemplo, incluindo um símbolo de moeda e separadores conforme mostrado.
Exemplo em Python: buscar e exibir as melhores taxas fixas de 2 anos
Este script chama o endpoint de 2 anos, verifica a carga útil e imprime uma lista de comparação simples. Ele usa apenas a URL documentada e o cabeçalho de Autorização.
import os
import requests
API_KEY = os.getenv("ZYLALABS_API_KEY", "YOUR_API_KEY")
URL = "https://zylalabs.com/api/5180/canada-mortgage-rates-api/11347/mortgage-rates-2-year"
headers = {
"Authorization": f"Bearer {API_KEY}"
}
resp = requests.post(URL, headers=headers, timeout=20)
resp.raise_for_status()
data = resp.json()
# Análise defensiva conforme o exemplo oficial
rates = []
if isinstance(data, list) and data:
payload = data[0]
rates = payload.get("best_2_year_fixed_mortgage_rates", [])
# Imprimir uma tabela compacta
for item in rates:
provider = item.get("provider")
rate = item.get("rate")
payment = item.get("payment")
print(f"{provider:<30} {rate:>6} {payment:>8}")
Notas de implementação que economizam tempo
- Autenticação: Envie Authorization: Bearer YOUR_API_KEY em cada solicitação.
- Corpo da solicitação: Nenhum é necessário para esses endpoints; não adicione parâmetros extras.
- Strings e formatação: rate e payment são retornados como strings (por exemplo, "3.99%", "$2,077"). Se você precisar de comparações numéricas, remova símbolos e separadores antes de analisar.
- Moeda e cadência: O valor do pagamento é apresentado como uma string de moeda formatada. Use-o para exibição ou derive números com cuidado; a cadência (mensal/bissemanal) não é especificada no exemplo, então não assuma.
- Atualizações e cache: Se sua interface não exigir frescor de sub-minuto, armazene em cache as respostas no lado do servidor (por exemplo, por vários minutos) para reduzir chamadas e latência da página.
- Paginação: Não aplicável aqui; a resposta retorna um único array de listagens.
- Tratamento de erros: Trate não-2xx como falhas transitórias ou de autenticação. Registre o corpo da resposta completa para depuração e apresente uma alternativa amigável ao usuário na interface.
Casos de uso práticos
- Módulos de página de destino: Mostre "Melhor taxa fixa de 2 anos hoje" com a linha superior do array e vincule a uma tabela completa.
- Fluxos de pré-aprovação: Deixe os usuários selecionarem uma opção de 2 anos da lista de provedores; persista a seleção e o instantâneo da taxa no registro do seu aplicativo.
- Distribuição de leads: Roteie leads para credores cujas entradas aparecem no feed, anexando as strings de taxa e pagamento exibidas.
- E-mails de alerta de taxa: Compare a melhor taxa de 2 anos de hoje com sua linha de base armazenada; se a string percentual diminuir, acione uma notificação.
Expandindo além dos prazos de 2 anos
Se sua jornada precisar de comparações lado a lado de prazos, chame os endpoints de 3 anos e 5 anos e renderize tabelas adjacentes. Como esses endpoints compartilham o mesmo padrão de autenticação e sem parâmetros, você pode reutilizar seu código cliente e mudar apenas a URL.
Chame esta API de agentes de IA via MCP
Você também pode invocar APIs de marketplace de agentes de codificação de IA usando o endpoint Zyla MCP. Aponte seu cliente para https://mcp.zylalabs.com/mcp?apikey=YOUR_API_KEY e configure uma ferramenta que envia para a URL do hub desejado. Veja a página MCP para detalhes sobre como conectar isso ao seu ambiente de desenvolvimento.
Por que enviar no Zyla API Hub
- Uma chave de API e modelo de assinatura em mais de 10.000 APIs públicas.
- Padrões de autenticação e solicitação consistentes simplificam seu código de backend.
- Adicione mais capacidades de finanças e pagamentos sem sobrecarga de aquisição.
Explore mais listagens financeiras no Zyla API Hub sempre que precisar expandir sua superfície de produto.
FAQ
O endpoint de 2 anos requer algum parâmetro?
Não. De acordo com a documentação, envie uma solicitação POST com apenas o cabeçalho de Autorização.
Quais campos devo exibir para os usuários?
No mínimo: provedor, taxa e pagamento. Mantenha a formatação da taxa e do pagamento intactas se você não precisar de matemática numérica, uma vez que já incluem símbolos e separadores.
Com que frequência os dados são atualizados?
A documentação não especifica a frequência de atualização. Implemente um cache que atenda às necessidades da sua interface e verifique o endpoint periodicamente.
Há um plano gratuito?
Os planos no Zyla usam assinatura + cota. Verifique a página da API para opções de acesso e preços atuais. Você pode iniciar um teste de 7 dias a partir da página do item quando disponível.
Posso comparar taxas de 2 anos vs 3 anos vs 5 anos em uma única visualização?
Sim. Chame os três endpoints independentemente e renderize seus arrays em tabelas ou abas adjacentes.
Pronto para construir seu widget de taxa de hipoteca ou fluxo de integração? Comece sua integração com o endpoint de 2 anos hoje: abra a listagem da API de Taxas de Hipoteca do Canadá e inicie o teste de 7 dias.