Housing Market API integration guide
The reference tables, endpoint descriptions, error codes and examples are generated from the API specification and stay in English in every language. Names, parameters and codes are identical everywhere.
Pagination
Every list endpoint uses cursors. A response carries data, next_cursor and has_more.
Pass the next_cursor of one response as the cursor of the next request, and stop when has_more is false.
There is no total and there are no page numbers. This is by design: the API is built to look listings up, not to copy the database.
The limit parameter sets the page size. It defaults to 50 and may not exceed 100.
A cursor is opaque. Do not parse it, build one or keep it for later. It is bound to your key and to the filters of the request that produced it, and an invalid one is refused with invalid_cursor.
Results come in a stable order within one walk, but the order carries no meaning. Do not rely on it.
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. |