POI 简易搜索

按关键词快速搜索兴趣点

POST/api/service/search

接口说明

POI 简易搜索接口支持以地址或关键词为核心,快速搜索匹配的地点信息,返回名称、坐标、类型等基础信息,适合轻量级周边推荐场景。

请求方式POST
支持地区中国大陆
坐标系GCJ02(火星坐标系)

认证方式

所有 API 请求均需通过 HTTP Authorization 请求头携带 Bearer Token 进行身份验证。 Token 可在控制台的「团队设置 → API 密钥」中创建和管理。

// 请求头示例
Authorization: Bearer <YOUR_API_KEY>

Token 属于密钥凭证,请勿提交到代码仓库或公开渠道。建议通过服务端代理调用 API,避免在前端直接暴露 Token。

请求参数

POST/api/service/search
参数名类型必填说明
addressstring必填搜索地址或关键词,如"威海 水饺"

返回字段

成功响应result: 1HTTP 200
字段名类型说明
resultinteger成功标识,1 为成功
listarray搜索结果 POI 列表
idstringPOI 唯一标识
pointobject坐标,GCJ02 坐标系
lngnumber经度
latnumber纬度
typestringPOI 类型,如 Entity
namestringPOI 名称
codestring地点编码
categoriesarrayPOI 分类列表
idstring分类 ID
namestring分类名称
addressobject地址信息
namestring格式化地址
contextobject行政区划上下文
relevancenumber与查询关键词的相关度分数
distanceinteger距离(米)
phonestring联系电话

代码示例

请求示例
JavaScript
fetch('https://lts.maiyun.net/api/service/search', {
    method: 'POST',
    headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    body: JSON.stringify({
        address: '威海 水饺',
    }),
})
    .then(r => r.json())
    .then(data => {
        console.log(data.list);
    });
返回示例(成功)
JSON
{
    "result": 1,
    "list": [
        {
            "id": "2a9c1c0d49800c0d7c29bdde",
            "point": { "lng": 122.123891, "lat": 37.505005 },
            "type": "Entity",
            "name": "威海**特色水饺",
            "code": "",
            "categories": [{ "id": "100100", "name": "餐饮服务" }],
            "address": {
                "name": "山东省威海市环翠区鲸园街道威高广场负一楼食尚地美食广场",
                "context": {
                    "country": { "name": "中国", "code": "CN" },
                    "province": { "name": "山东省", "code": "370000" },
                    "city": { "name": "威海市", "code": "371000" },
                    "district": { "name": "环翠区", "code": "371002" },
                    "township": { "name": "鲸园街道", "code": "371002001" }
                }
            },
            "relevance": 166.73686,
            "distance": 0,
            "phone": ""
        }
    ]
}

错误码

错误码描述
-1参数错误:address 字段缺失或不为字符串类型
-400未提供授权信息,请检查 Authorization 请求头
-401Token 不存在或已过期,请重新获取
-402关联的团队账号不存在
-429超出 QPS 限制,请适当降低请求频率后重试

当请求失败时,接口将返回对应的 result 值(≤ 0)及错误描述字符串。 其中 -400 及以下为通用鉴权错误,其余为当前接口特有错误。