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. |