Guide d’intégration de la Housing Market API
Les tableaux de référence, les descriptions des points de terminaison, les codes d’erreur et les exemples sont générés à partir de la spécification de l’API et restent en anglais dans toutes les langues. Les noms, paramètres et codes sont identiques partout.
Pagination des résultats
Tous les points de terminaison de liste utilisent des curseurs. Une réponse contient data, next_cursor et has_more.
Transmettez le next_cursor d’une réponse comme cursor de la requête suivante, et arrêtez-vous lorsque has_more vaut false.
Il n’y a ni total ni numéros de page. C’est voulu : l’API est conçue pour consulter des annonces, pas pour copier la base de données.
Le paramètre limit définit la taille de page. Sa valeur par défaut est 50 et elle ne peut pas dépasser 100.
Un curseur est opaque. Ne l’analysez pas, n’en construisez pas vous-même et ne le conservez pas pour plus tard. Il est lié à votre clé et aux filtres de la requête qui l’a produit, et un curseur non valide est refusé avec invalid_cursor.
Les résultats arrivent dans un ordre stable au cours d’un même parcours, mais cet ordre n’a aucune signification. Ne vous y fiez pas.
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. |