搜索地点候选项,用于选择房产经纪人服务区域

查看 美国房产与房贷数据 API 的全部接口 →

使用必填的 input 文本搜索地点信息,为查找房产经纪人时的地区选择提供候选项。文档默认搜索文本为 cali。可选参数 area_types 用于限定地点类别,支持 neighborhood、city、county、postal_code、building 和 street;其文档默认值为逗号分隔的字符串 neighborhood,city,county,postal_code,building,street。limit 默认 10,文档规定最大为 20。应将返回结果作为供用户选择的服务区域候选项,不要自动选定地点或发起经纪人列表查询。本接口没有提供成功测试的响应。未经验证的响应示例内容不完整,开头是包含经纪人资料的 agents 数组,无法据此确定可靠的地点建议响应结构。因此,结果字段名、标识符格式、坐标以及无匹配结果时的响应结构均未验证。经纪人列表接口将 marketing_area_city 描述为本接口返回的地点 ID,但使用前仍需根据实际响应核对映射关系。不要假定本接口的标识符或字段与房源地点自动补全接口相同。

API 功能

以部分地名查找服务区域 通过必填的 input 文本构建地点搜索功能。文档起始值 cali 展示的是部分地名查询,而非经纪人姓名查询。
六类地点范围可选 使用文档列出的 neighborhood、city、county、postal_code、building 和 street 限定 area_types;默认字符串包含全部六类。
控制地区选择菜单的候选数量 通过 limit 请求适量候选项,默认 10,文档规定最大为 20。本接口不提供分页偏移参数。
确认地点后再衔接经纪人查询 让用户先选定返回的地点,再准备经纪人搜索。将结果映射到 marketing_area_city 前,需验证返回标识符的格式。
独立处理经纪人地点响应结构 经纪人地点解析应独立于房源地点自动补全。所提供的经纪人资料示例内容不完整,无法验证本接口的地点建议字段。

在线 API 演示

GET /api/project/realty-in-us/agents-v2-search-location

调用成本暂不可用,未假定任何价格。

查看价格

API 响应 (JSON)

{}
curl -X GET 'https://api.opendata-api.com/api/project/realty-in-us/agents-v2-search-location?key=<API_KEY>&area_types=neighborhood%2Ccity%2Ccounty%2Cpostal_code%2Cbuilding%2Cstreet&input=cali&limit=10'
📢
需要帮助?
如遇接口异常,或需要其他接口需求,可联系我们
联系我们

使用场景

常见问题

input 应该填写什么?

填写地点关键词或短语。文档默认值和示例为 cali,也将 California 列为地名示例。input 为必填项;本接口用于查找地点,不用于按姓名搜索经纪人。

area_types 支持哪些地点类别?

文档列出的类别为 neighborhood、city、county、postal_code、building 和 street。默认值是逗号分隔的字符串 neighborhood,city,county,postal_code,building,street。请保持字符串形式,不要传入 JSON 数组。

一次可以请求多少条地点结果?

limit 默认 10,文档规定最大为 20。虽然文档将其描述为分页输入,但本接口没有提供 offset 或 page 参数,因此尚不能确认获取下一页的机制。

地点响应字段是否已经验证?

尚未验证。现有资料中没有成功测试的响应。所提供的示例内容不完整,开头是经纪人资料记录,无法验证地点建议的响应结构。不要根据该示例确定地点建议的必需字段或无匹配结果时的响应格式。

可以将地点结果直接传入 marketing_area_city 吗?

经纪人列表文档将 marketing_area_city 描述为本地点搜索接口返回的 ID,但此处尚未验证返回标识符的格式。应要求用户先选定结果,核对实际响应中的字段映射,不要套用房源地点自动补全的规则。选中地点建议这一动作本身不应发起经纪人查询。

相关接口

相关指南

查看订阅方案 →