Ir para o conteúdo principal

Documentação

Tudo de que você precisa para integrar

O guia, a referência e a especificação são gerados a partir de um único arquivo OpenAPI, por isso estão sempre de acordo. Os identificadores são os mesmos em todos os idiomas.

  • Guia de integração

    Como obter uma chave, autenticação, filtros, paginação, limites e erros, no seu idioma.

    Abrir o guia

  • Especificação OpenAPI

    O arquivo OpenAPI 3.1 a partir do qual a referência é gerada, para geradores de código e ferramentas de API.

    Baixar a especificação

  • Guia em PDF

    O guia de integração em um único documento, para ler offline ou compartilhar com seu time.

    Baixar o PDF

A documentação é pública. Você só precisa de uma chave para chamar a API.

Início rápido

Verifique sua chave e o endereço que vemos
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"
Leia a primeira página de anúncios de um país
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/properties?country=TH&listing_type=sale&property_type=condominium&limit=100"

Visão geral

URL base
https://api.housingmarketapi.com
Autenticação
A chave no cabeçalho x-api-key, enviada a partir do endereço de servidor registrado para ela.

Endpoints

EndpointNívelDescrição
GET /v1/pingStandardConfirma que sua chave funciona a partir do endereço para o qual está registrada e devolve esse endereço.
GET /v1/propertiesStandardAnúncios publicados de um país coberto pela sua chave, uma página por vez.
GET /v1/insights/*AvançadoDados de mercado agregados por local e período, para chaves Avançado. Em breve: estes endpoints ainda não estão ativos.

Códigos de erro

Todo erro traz um status HTTP e um destes códigos. Baseie sua lógica no código, não na mensagem.

  • invalid_parameter
  • invalid_cursor
  • unauthenticated
  • ip_not_allowed
  • key_paused
  • country_not_entitled
  • upgrade_required
  • not_found
  • method_not_allowed
  • rate_limited
  • quota_exceeded
  • internal_error
  • not_configured
  • service_unavailable
Obter sua chave de APIVer preços