补全英国房产搜索地点,获取候选区域
查看 Rightmove 英国房产搜索与成交价查询 的全部接口 →通过必填的 location 查询参数,按输入的地点词或短语获取候选地点。文档示例为 ch,已观测到的成功测试使用 London。该次 JSON 响应包含 status=true、字符串类型的 message,以及由地点候选对象组成的 data 数组。文档列出的候选字段包括展示名称 displayName、地点标识 locationIdentifier 和规范化搜索文本 normalisedSearchTerm;这些字段在出现时均为字符串。响应没有被声明为必返的字段。测试确认的是响应外层结构及当次已出现字段的类型,并不代表每条候选地点都始终包含全部字段。将选中地点的标识用于后续搜索前,应先核对目标接口对标识的要求;仅凭本接口不能确认标识可跨接口通用。
API 功能
按地点词生成候选建议 提交必填的 location 字符串,为正式发起房产搜索前输入的地点词或短语获取候选建议。
搜索框候选名称展示 候选对象提供 displayName 字符串时,可将其作为搜索表单中地点选项的展示名称。
选中地点标识核对 查看选中候选对象的 locationIdentifier,并先按下一步搜索接口的要求验证其格式,再决定是否复用。
规范化地点文本读取 返回 normalisedSearchTerm 时,可读取并保留该地点建议所对应的规范化搜索文本。
在线 API 演示
未找到可用的 API Key,请前往控制台创建后刷新本页。 控制台 →
GET
/api/project/rightmove/auto-complete API 响应 (JSON)
{} curl -X GET 'https://api.opendata-api.com/api/project/rightmove/auto-complete?key=<API_KEY>&location=<location>'
curl -X GET 'https://api.opendata-api.com/api/project/rightmove/auto-complete?key=<API_KEY>&location=<location>'
查询结果
需要帮助?
如遇接口异常,或需要其他接口需求,可联系我们
使用场景
- 在英国搬家选址表单中加入输入联想地点选择器,让用户先查看候选区域再作出选择。
- 当房产搜索词可能对应多个地点时,增加明确的地点确认步骤,避免直接选错区域。
- 同时保存选中地点的展示名称及其可用标识,构造目标搜索请求前再验证该标识。
- 在 normalisedSearchTerm 存在时,将其与输入短语对照,使保存的地点选择与返回的规范化文本保持一致。
常见问题
location 参数应该填写什么?
在必填的 location 查询参数中填写地点词或短语。文档示例为 ch,已观测到的成功测试使用 London。这里填写的是搜索文本,不是房源 ID。
哪些字段用于描述候选地点?
文档中的 data 条目可包含字符串字段 displayName、locationIdentifier 和 normalisedSearchTerm。各字段存在时,可分别用作展示名称、待核对的地点标识和规范化搜索文本。
每次响应都会包含所有文档字段吗?
不会作此保证,响应没有被声明为必返的字段。已观测到的成功响应包含 status=true、字符串类型的 message 和地点候选对象组成的 data 数组,当次已出现的文档字段类型符合声明。使用时应兼容条目字段缺失,也不能要求候选列表一定非空。
locationIdentifier 可以直接传给任意房产搜索接口吗?
不能假定它可通用于所有接口。使用前应根据目标接口及其标识参数要求,验证选中地点的标识;自动补全测试并未确认跨接口标识兼容性。