Housing Market API 整合指南
參考表格、端點說明、錯誤代碼和範例皆由 API 規格產生,在所有語言版本中均保留英文。名稱、參數和代碼在各處完全相同。
分頁
所有清單端點都使用游標。回應包含 data、next_cursor 和 has_more。
將一個回應的 next_cursor 作為下一個請求的 cursor 傳入,並在 has_more 為 false 時停止。
不提供總數,也沒有頁碼。這是刻意的設計:此 API 用於查詢房源,而非複製資料庫。
limit 參數用於設定每頁大小。預設值為 50,且不得超過 100。
游標是不透明的。請勿剖析、自行建構或保留以供日後使用。游標會與您的金鑰以及產生它的請求之篩選條件綁定,無效的游標會遭拒絕並傳回 invalid_cursor。
在單次走訪中,結果會以穩定的順序傳回,但此順序不具任何意義。請勿依賴此順序。
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. |