接口文档

通信协议

目前支持HTTP、HTTPS 两种通讯方式

请求方法

请求接口:

GET http://lbs.baidubce.com

公共请求头

头域 类型 说明
x-bce-request-id uuid 请求id 36位uuid(非必须)
x-bce-date String UTC时间 格式%YYYY-%mm-%ddT%HH:%MM:%SSZ
x-app-id uuid 应用ID 在console上可见
Host String Http HEADER必须项
Authorization String 百度智能云统一认证字符串详情

说明:字符集 charset=utf-8

接口定义

地理编码

请求示例

HTTP_METHOD URI 说明
GET /geocoder/v2/ 调用请求

请求例子:

curl -H "x-bce-user-id: 9e8ef339f58f4d70b442bc55a7c13a3f" -H "x-app-id: XX....XX" -H "x-bce-date:2018-02-22T09:47:52Z" -H "Authorization:bce-auth-v1/XXXXXX.." http://lbs.baidubce.com/geocoder/v2/?address=北京市海淀区上地十街10号&output=json&callback=showLocation

请求参数

参数名 参数含义 类型 举例 默认值 是否必须
address 待解析的地址。最多支持84个字节。
可以输入两种样式的值,分别是:
1、标准的结构化地址信息,如北京市海淀区上地十街十号 【推荐,地址结构越完整,解析精度越高】
2、支持“∗路与∗路交叉口”描述方式,如北一环路和阜阳路的交叉路口
第二种方式并不总是有返回结果,只有当地址库中存在该地址描述时才有返回。
string 北京市海淀区上地十街10号
city 地址所在的城市名。用于指定上述地址所在的城市,当多个城市都有上述地址时,该参数起到过滤作用,但不限制坐标召回城市。 string 北京市
ret_coordtype 可选参数,添加后返回国测局经纬度坐标或百度米制坐标
坐标系说明书
string gcj02ll(国测局坐标)、bd09mc(百度墨卡托坐标) bd09ll(百度经纬度坐标)
output 输出格式为json或者xml string json或xml xml
callback 将json格式的返回值通过callback函数返回以实现jsonp功能 string callback=showLocation(JavaScript函数名)

返回结果

名称 含义 类型
status 返回结果状态值, 成功返回0,其他值请查看下方返回码列表 int
location 经纬度坐标 object
+lat 纬度值 float
+lng 经度值 float
precise 位置的附加信息,是否精确查找。1为精确查找,即准确打点;0为不精确,即模糊打点(模糊打点无法保证准确度,不建议使用)。 int
confidence 可信度,描述打点准确度,大于80表示误差小于100m。该字段仅作参考,返回结果准确度主要参考precise参数。 int
level 能精确理解的地址类型,包含:UNKNOWN、国家、省、城市、区县、乡镇、村庄、道路、地产小区、商务大厦、政府机构、交叉路口、商圈、生活服务、休闲娱乐、餐饮、宾馆、购物、金融、教育、医疗 、工业园区 、旅游景点 、汽车服务、火车站、长途汽车站、桥 、停车场/停车区、港口/码头、收费区/收费站、飞机场 、机场 、收费处/收费站 、加油站、绿地、门址 string

返回码列表

返回码 英文描述 定义 常见原因
0 ok 正常 服务请求正常召回
1 服务器内部错误
2 Parameter Invalid 请求参数非法 必要参数拼写错误或漏传(如query和tag请求中均未传入)
3 Verify Failure 权限校验失败
4 Quota Failure 配额校验失败 服务当日调用次数已超限,联系我们
101 服务禁用
102 不通过白名单或者安全码不对
2xx 无权限
3xx 配额错误

逆向地理编码

请求示例

HTTP_METHOD URI 说明
GET /geocoder/v2/ 调用请求

请求例子:

curl -H "x-bce-user-id: 9e8ef339f58f4d70b442bc55a7c13a3f" -H "x-app-id: XX....XX" -H "x-bce-date:2018-02-22T09:47:52Z" -H "Authorization:bce-auth-v1/XXXXXX.." http://lbs.baidubce.com/geocoder/v2/callback=renderReverse&location=35.658651,139.745415&output=json&pois=1

请求参数

参数名 参数含义 类型 举例 默认值 是否必须
location 根据经纬度坐标获取地址。 float 38.76623,116.43213
lat<纬度>,lng<经度>
coordtype 坐标的类型,目前支持的坐标类型包括:bd09ll(百度经纬度坐标)、bd09mc(百度米制坐标)、gcj02ll(国测局经纬度坐标,仅限中国)、wgs84ll( GPS经纬度)
坐标系说明书
string bd09ll、gcj02ll bd09ll
ret_coordtype 可选参数,添加后返回国测局经纬度坐标或百度米制坐标
坐标系说明书
string gcj02ll(国测局坐标,仅限中国)、bd09mc(百度墨卡托坐标) bd09ll(百度经纬度坐标)
pois 是否召回传入坐标周边的poi,0为不召回,1为召回。当值为1时,默认显示周边1000米内的poi。
注意:若需访问海外POI,需申请「逆地理编码海外POI」服务权限,联系我们
int 0 0
radius poi召回半径,允许设置区间为0-1000米,超过1000米按1000米召回。 int 500 1000
output 输出格式为json或者xml string json或xml xml
callback 将json格式的返回值通过callback函数返回以实现jsonp功能 string callback=showLocation(JavaScript函数名)
extensions_poi 区别于pois参数,pois=0,不召回pois数据,但后端仍访问poi相应服务;extensions_poi=null时,后端不调用poi相关服务,可减少服务访问时延。
注意:若需访问海外POI,需申请「逆地理编码海外POI」服务权限,联系我们
string null
extensions_road 当取值为true时,召回坐标周围最近的3条道路数据。区别于行政区划中的street参数(street参数为行政区划中的街道,和普通道路不对应)。 string false、true false
extensions_town 当取值为true时,行政区划返回乡镇级数据(仅国内召回乡镇数据)。默认不访问。 string true
language 指定召回的新政区划语言类型。
召回行政区划语言list(全量支持的语言见示例)。
当language=local时,根据请求中坐标所对应国家的母语类型,自动选择对应语言类型的行政区划召回。
目前支持多语言的行政区划区划包含country、provence、city、district
注意:多语言需申请「逆地理编码海外POI」服务权限,联系我们
string el gu en vi ca it iw sv eu ar cs gl id es en-GB ru sr nl pt tr tl lv en-AU lt zh-TW th ro fil ta fr bg hr bn de hu fa hi pt-BR fi da ja te pt-PT ml ko kn sk zh-CN pl uk sl mr
local
en,国内默认zh-CN
language_auto 是否自动填充行政区划。
1填充,0不填充。
填充:当服务按某种语言类别召回时,若某一行政区划层级数据未覆盖,则按照“英文→中文→本地语言”类别行政区划数据对该层级行政区划进行填充,保证行政区划数据召回完整性。
注意:多语言需申请「逆地理编码海外POI」服务权限,联系我们
int 0、1
latest_admin 是否访问最新版行政区划数据(仅对中国数据生效),1(访问),0(不访问) int 0、1 0

返回结果

名称 含义 类型
status 返回结果状态值, 成功返回0,其他值请查看下方返回码状态表。 int
location 经纬度坐标 object
+lat 纬度值 float
+lng 经度值 float
formatted_address 结构化地址信息 string
business 坐标所在商圈信息,如 "人民大学,中关村,苏州街"。最多返回3个。 string
addressComponent
(注意,国外行政区划,字段仅代表层级)country
国家 string
addressComponent
(注意,国外行政区划,字段仅代表层级)province
省名 string
addressComponent
(注意,国外行政区划,字段仅代表层级)city
城市名 string
addressComponent
(注意,国外行政区划,字段仅代表层级)district
区县名 string
addressComponent
(注意,国外行政区划,字段仅代表层级)town
乡镇名 string
addressComponent
(注意,国外行政区划,字段仅代表层级)street
街道名(行政区划中的街道层级) string
addressComponent
(注意,国外行政区划,字段仅代表层级)street_number
街道门牌号 string
addressComponent
(注意,国外行政区划,字段仅代表层级)adcode
行政区划代码 adcode映射表 int
addressComponent
(注意,国外行政区划,字段仅代表层级)country_code
国家代码 int
addressComponent
(注意,国外行政区划,字段仅代表层级)direction
相对当前坐标点的方向,当有门牌号的时候返回数据 string
addressComponent
(注意,国外行政区划,字段仅代表层级)distance
相对当前坐标点的距离,当有门牌号的时候返回数据 string
pois(周边poi数组) addr 地址信息 string
pois(周边poi数组) direction 和当前坐标点的方向 string
pois(周边poi数组) distance 离坐标点距离 int
pois(周边poi数组) name poi名称 string
pois(周边poi数组) poiType poi类型,如’ 办公大厦,商务大厦’ string
pois(周边poi数组) point poi坐标{x,y} float
pois(周边poi数组) tel 电话 int
pois(周边poi数组) uid poi唯一标识 string
pois(周边poi数组) zip 邮编 int
pois(周边poi数组) parent_poi poi对应的主点poi(如,海底捞的主点为上地华联,该字段则为上地华联的poi信息。如无,该字段为空),包含子字段和pois基础召回字段相同。
poiRegions direction_desc 请求中的坐标与所归属区域面的相对位置关系 string
poiRegions name 归属区域面名称 string
poiRegions tag 归属区域面类型 string
sematic_description 当前位置结合POI的语义化结果描述。 string
cityCode 百度定义的城市id(正常更新与维护,但建议使用adcode) int

服务状态码

返回码 英文描述 定义 常见原因
0 ok 正常 服务请求正常召回
1 服务器内部错误
2 Parameter Invalid 请求参数非法 必要参数拼写错误或漏传(如query和tag请求中均未传入)
3 Verify Failure 权限校验失败
4 Quota Failure 配额校验失败 服务当日调用次数已超限,联系我们
101 服务禁用
102 不通过白名单或者安全码不对
2xx 无权限
3xx 配额错误