搜索地点候选项,用于选择房产经纪人服务区域
查看 美国房产与房贷数据 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 功能
在线 API 演示
未找到可用的 API Key,请前往控制台创建后刷新本页。 控制台 →
/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'
查询结果
使用场景
- 构建服务区域文本选择器,按部分地名搜索,并在用户明确选定地点后再准备经纪人名录查询。
- 使用文档支持的 area_types 取值提供城市与县级地区筛选模式,将搜索文本与选定结果的标识符分开保存。
- 为移动端设计简洁的地点选择菜单,使用默认的 10 条候选项,或设置不超过文档上限 20 的其他数量。
- 独立测试服务区域标识符的映射,不沿用房源地点自动补全的规则,避免同名地点被误用为格式不兼容的标识符。
- 遇到没有匹配项或含义不明确的地名时,引导用户进一步调整搜索文本,而不假定成功响应一定包含可用的地点建议。
常见问题
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,但此处尚未验证返回标识符的格式。应要求用户先选定结果,核对实际响应中的字段映射,不要套用房源地点自动补全的规则。选中地点建议这一动作本身不应发起经纪人查询。