Guia de integração da Housing Market API
As tabelas de referência, as descrições dos endpoints, os códigos de erro e os exemplos são gerados a partir da especificação da API e permanecem em inglês em todos os idiomas. Nomes, parâmetros e códigos são idênticos em todos os lugares.
Paginação
Todos os endpoints de listagem usam cursores. Uma resposta contém data, next_cursor e has_more.
Passe o next_cursor de uma resposta como o cursor da próxima solicitação e pare quando has_more for false.
Não há total nem números de página. Isso é intencional: a API foi criada para consultar anúncios, não para copiar o banco de dados.
O parâmetro limit define o tamanho da página. O padrão é 50 e o valor não pode exceder 100.
Um cursor é opaco. Não o interprete, não o construa nem o guarde para depois. Ele está vinculado à sua chave e aos filtros da solicitação que o gerou, e um cursor inválido é recusado com invalid_cursor.
Os resultados vêm em uma ordem estável ao longo de uma mesma navegação, mas a ordem não tem significado. Não dependa dela.
Response shape
| Field | Type | Description |
|---|---|---|
data required | array | The items on this page. |
next_cursor required | string | null | Pass as cursor to get the next page. Null on the last page. |
has_more required | boolean | False when there is no further page. |
Request parameters
| Parameter | Type | Required | Values | Description |
|---|---|---|---|---|
limit | integer | no | default 50min 1max 100 | Page size. At most the maximum shown; larger values are refused with invalid_parameter. |
cursor | string | no | The next_cursor of the previous page. Opaque: do not parse it, store
it, or build one. It is bound to your key and to the filters of the
request that produced it, and a cursor used with different filters is
refused with invalid_cursor. |