接口说明
正地址解析(Geocoding)接口能够将结构化或的文字地址解析为精确的经纬度坐标。支持省、市、区、街道等多粒度地址,仅支持中国大陆地区,统一返回 GCJ02(火星坐标系)坐标。
请求方式POST
支持地区中国大陆
坐标系GCJ02(火星坐标系)
认证方式
所有 API 请求均需通过 HTTP Authorization 请求头携带 Bearer Token 进行身份验证。 Token 可在控制台的「团队设置 → API 密钥」中创建和管理。
// 请求头示例
Authorization: Bearer <YOUR_API_KEY>
Token 属于密钥凭证,请勿提交到代码仓库或公开渠道。建议通过服务端代理调用 API,避免在前端直接暴露 Token。
请求参数
POST
/api/service/geocoding| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| address | string | 必填 | 待解析的地址字符串,规则遵循省份、城市、区县、城镇、乡村、街道、门牌号码、屋结构化地址信息、大厦,如:北京市昌平区龙泽龙域北街3号院1号 |
返回字段
成功响应
result: 1HTTP 200| 字段名 | 类型 | 说明 |
|---|---|---|
| result | integer | 成功标识,1 为成功 |
| lat | number | 纬度,GCJ02 坐标系,精确到小数点后 6 位 |
| lng | number | 经度,GCJ02 坐标系,精确到小数点后 6 位 |
| address | object | 结构化地址信息 |
| └name | string | 经过格式化处理后的标准化地址字符串 |
| └context | array | 行政区划上下文列表 |
| └type | string | 层级类型,如 province、city、district、township |
| └name | string | 层级名称 |
| └code | string | 层级编码 |
代码示例
请求示例
JavaScript
fetch('https://lts.maiyun.net/api/service/geocoding', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
address: '北京市昌平区龙泽龙域北街3号院1号',
}),
})
.then(r => r.json())
.then(data => {
const { lat, lng } = data;
console.log(lat, lng);
});返回示例(成功)
JSON
{
"result": 1,
"lat": 40.067784,
"lng": 116.313784,
"address": {
"name": "北京市昌平区回龙观街道昌平龙泽龙域北街3号院1号",
"context": [
{
"type": "province",
"name": "北京市",
"code": "110000"
},
{
"type": "city",
"name": "北京市",
"code": "110100"
},
{
"type": "district",
"name": "昌平区",
"code": "110114"
},
{
"type": "township",
"name": "回龙观街道",
"code": "110114011"
}
]
}
}错误码
| 错误码 | 描述 |
|---|---|
| -1 | 参数错误:address 字段缺失或不为字符串类型 |
| -3 | 地址无法解析,请确认地址内容是否正确 |
| -400 | 未提供授权信息,请检查 Authorization 请求头 |
| -401 | Token 不存在或已过期,请重新获取 |
| -402 | 关联的团队账号不存在 |
| -429 | 超出 QPS 限制,请适当降低请求频率后重试 |
当请求失败时,接口将返回对应的 result 值(≤ 0)及错误描述字符串。 其中 -400 及以下为通用鉴权错误,其余为当前接口特有错误。