接口说明
周边 POI 搜索接口支持以指定坐标为中心,按半径范围检索附近地点,可选关键词过滤,返回地点名称、坐标、分类、距离、联系电话及行政区划信息,适合附近门店、周边推荐、服务范围查询等场景。
请求方式POST
支持地区中国大陆
坐标系GCJ02(火星坐标系)
认证方式
所有 API 请求均需通过 HTTP Authorization 请求头携带 Bearer Token 进行身份验证。 Token 可在控制台的「团队设置 → API 密钥」中创建和管理。
// 请求头示例
Authorization: Bearer <YOUR_API_KEY>
Token 属于密钥凭证,请勿提交到代码仓库或公开渠道。建议通过服务端代理调用 API,避免在前端直接暴露 Token。
请求参数
POST
/api/service/nearbysearch| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| from | integer | 可选 | 输入坐标系,默认 3:0=WGS84,1=BD09(BD09LL),2=BD09MC,3=GCJ02 |
| point | object | 必填 | 中心点坐标,格式 { lat: number, lng: number } |
| radius | integer | 必填 | 搜索半径,单位米 |
| name | string | 可选 | 地点关键词,支持按名称或类型过滤 |
| category | string | 可选 | 地点分类过滤,支持按分类名称筛选 POI |
| page | integer | 可选 | 分页页码,从 1 开始,默认 1 |
| count | integer | 可选 | 每页返回数量,可选 5/10/20,默认 20 |
返回字段
成功响应
result: 1HTTP 200| 字段名 | 类型 | 说明 |
|---|---|---|
| result | integer | 成功标识,1 为成功 |
| list | array | 周边 POI 搜索结果列表 |
| └id | string | POI 唯一标识 |
| └point | object | 坐标,GCJ02 坐标系 |
| └lng | number | 经度 |
| └lat | number | 纬度 |
| └type | string | POI 类型,如 Entity |
| └name | string | POI 名称 |
| └code | string | 地点编码 |
| └categories | array | POI 分类列表 |
| └id | string | 分类 ID |
| └name | string | 分类名称 |
| └address | object | 地址信息 |
| └name | string | 格式化地址 |
| └context | object | 行政区划上下文 |
| └relevance | number | 与查询关键词的相关度分数 |
| └distance | number | 与中心点的距离,单位米 |
| └phone | array | 联系电话列表 |
代码示例
请求示例
JavaScript
fetch('https://lts.maiyun.net/api/service/nearbysearch', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
from: 3,
point: { lat: 30.551096, lng: 104.096249 },
radius: 1000,
name: '民宿',
category: '酒店',
page: 1,
count: 20,
}),
})
.then(r => r.json())
.then(data => {
console.log(data.list);
});返回示例(成功)
JSON
{
"result": 1,
"list": [
{
"id": "e943c4e7490fea2a6c4760f2",
"point": { "lng": 104.096249, "lat": 30.551096 },
"type": "Entity",
"name": "**民宿(**地铁站店)",
"code": "",
"categories": [{ "id": "100000", "name": "住宿服务" }],
"address": {
"name": "四川省成都市双流区中和街道中和大道三段香榭宸光里1栋",
"context": {
"country": { "name": "中国", "code": "CN" },
"province": { "name": "四川省", "code": "510000" },
"city": { "name": "成都市", "code": "510100" },
"district": { "name": "双流区", "code": "510116" },
"township": { "name": "中和街道", "code": "510116010" }
}
},
"relevance": 283.14478,
"distance": 500,
"phone": ["187****2901"]
}
]
}错误码
| 错误码 | 描述 |
|---|---|
| -1 | 参数错误:from 或 point 字段缺失或类型不正确 |
| -2 | 参数错误:radius 字段缺失或类型不正确 |
| -3 | 参数错误:name 字段类型不正确 |
| -4 | 参数错误:category 字段类型不正确 |
| -5 | 参数错误:page 字段类型不正确 |
| -6 | 参数错误:count 字段必须为 5、10 或 20 |
| -400 | 未提供授权信息,请检查 Authorization 请求头 |
| -401 | Token 不存在或已过期,请重新获取 |
| -402 | 关联的团队账号不存在 |
| -429 | 超出 QPS 限制,请适当降低请求频率后重试 |
当请求失败时,接口将返回对应的 result 值(≤ 0)及错误描述字符串。 其中 -400 及以下为通用鉴权错误,其余为当前接口特有错误。