Panduan integrasi Housing Market API

Tabel referensi, deskripsi endpoint, kode kesalahan, dan contoh dihasilkan dari spesifikasi API dan tetap dalam bahasa Inggris di setiap bahasa. Nama, parameter, dan kode sama di semua tempat.

Paginasi

Setiap endpoint daftar menggunakan kursor. Respons memuat data, next_cursor, dan has_more.

Teruskan next_cursor dari satu respons sebagai cursor pada permintaan berikutnya, dan berhentilah ketika has_more bernilai false.

Tidak ada jumlah total dan tidak ada nomor halaman. Ini memang disengaja: API ini dibuat untuk mencari listing, bukan untuk menyalin basis data.

Parameter limit menentukan ukuran halaman. Nilai bawaannya 50 dan tidak boleh melebihi 100.

Kursor bersifat opak. Jangan mengurai, membuat sendiri, atau menyimpannya untuk nanti. Kursor terikat pada kunci Anda dan pada filter dari permintaan yang menghasilkannya, dan kursor yang tidak valid ditolak dengan invalid_cursor.

Hasil muncul dalam urutan yang stabil selama satu kali penelusuran, tetapi urutan tersebut tidak memiliki makna. Jangan mengandalkannya.

Response shape

FieldTypeDescription
data requiredarrayThe items on this page.
next_cursor requiredstring | nullPass as cursor to get the next page. Null on the last page.
has_more requiredbooleanFalse when there is no further page.

Request parameters

ParameterTypeRequiredValuesDescription
limitintegernodefault 50
min 1
max 100
Page size. At most the maximum shown; larger values are refused with invalid_parameter.
cursorstringnoThe 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.