Integrationsleitfaden für die Housing Market API
Die Referenztabellen, Endpunktbeschreibungen, Fehlercodes und Beispiele werden aus der API-Spezifikation generiert und bleiben in jeder Sprache auf Englisch. Namen, Parameter und Codes sind überall identisch.
Paginierung
Jeder Listen-Endpunkt verwendet Cursor. Eine Antwort enthält data, next_cursor und has_more.
Übergeben Sie den next_cursor einer Antwort als cursor der nächsten Anfrage, und hören Sie auf, wenn has_more den Wert false hat.
Es gibt keine Gesamtzahl und keine Seitennummern. Das ist beabsichtigt: Die API ist zum Nachschlagen von Inseraten gebaut, nicht zum Kopieren der Datenbank.
Der Parameter limit legt die Seitengröße fest. Der Standardwert ist 50, und er darf 100 nicht überschreiten.
Ein Cursor ist opak. Parsen Sie ihn nicht, erzeugen Sie keinen selbst und bewahren Sie ihn nicht für später auf. Er ist an Ihren Schlüssel und an die Filter der Anfrage gebunden, die ihn erzeugt hat, und ein ungültiger Cursor wird mit invalid_cursor abgelehnt.
Innerhalb eines Durchlaufs kommen die Ergebnisse in einer stabilen Reihenfolge, doch diese Reihenfolge hat keine Bedeutung. Verlassen Sie sich nicht darauf.
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. |