Panduan integrasi Housing Market API

Jadual rujukan, perihalan titik akhir, kod ralat dan contoh dijana daripada spesifikasi API dan kekal dalam bahasa Inggeris dalam setiap bahasa. Nama, parameter dan kod adalah sama di mana-mana.

Penomboran halaman

Setiap titik akhir senarai menggunakan kursor. Respons mengandungi data, next_cursor dan has_more.

Hantar next_cursor daripada satu respons sebagai cursor bagi permintaan seterusnya, dan berhenti apabila has_more ialah false.

Tiada jumlah keseluruhan dan tiada nombor halaman. Ini memang disengajakan: API dibina untuk mencari penyenaraian, bukan untuk menyalin pangkalan data.

Parameter limit menetapkan saiz halaman. Nilai lalainya ialah 50 dan ia tidak boleh melebihi 100.

Kursor adalah legap. Jangan menghuraikannya, membinanya atau menyimpannya untuk kegunaan kemudian. Ia terikat pada kunci anda dan pada penapis permintaan yang menghasilkannya, dan kursor yang tidak sah ditolak dengan invalid_cursor.

Hasil datang dalam susunan yang stabil sepanjang satu penelusuran, tetapi susunan itu tidak membawa apa-apa makna. Jangan bergantung padanya.

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 `50` min `1` max `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`.