接口文档

通信协议

目前支持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 /place/v2/search 调用请求

请求例子:

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/place/v2/search?query=ATM机&tag=银行&region=北京&output=json

请求参数

参数名 参数含义 类型 示例 是否必须
query 检索关键字。行政区划区域检索不支持多关键字检索。如果需要按POI分类进行检索,请将分类通过query参数进行设置,如query=美食 string(45) 天安门、美食 必选
tag 检索分类偏好,与q组合进行检索,多个分类以","分隔(百度地图POI行业分类(tag)),如果需要严格按分类检索,请通过query参数设置 string(50) 美食 可选
region 检索行政区划区域(增加区域内数据召回权重,如需严格限制召回数据在区域内,请搭配使用city_limit参数),可输入行政区划名或对应cityCode string(50) 北京、131 必选
city_limit 区域数据召回限制,为true时,仅召回region对应区域内数据。 string(50) true、false 可选
output 输出格式为json或者xml string(50) json或xml 可选
scope 检索结果详细程度。取值为1 或空,则返回基本信息;取值为2,返回检索POI详细信息 string(50) 1、2 可选
filter 检索过滤条件。当scope取值为2时,可以设置filter进行排序。industry_type:行业类型,注意:设置该字段可提高检索速度和过滤精度,取值有: hotel(宾馆);cater(餐饮);life(生活娱乐) sort_name:排序字段,根据industry_type字段的值而定。 1、industry_type为hotel时,sort_name取值有: default(默认);price(价格);total_score(好评);level(星级);health_score(卫生);distance(距离排序,只有圆形区域检索有效)
2、industry_type为cater时,sort_name取值有: default(默认);taste_rating(口味);price(价格);overall_rating(好评);service_rating(服务);distance(距离排序,只有圆形区域检索有效)
3、industry_type为life时,sort_name取值有: default(默认);price(价格);overall_rating(好评)comment_num(服务);distance(距离排序,只有圆形区域检索有效)
sort_rule:排序规则:0(从高到低),1(从低到高)
price_section:价格区间
groupon:是否有团购:1(有),0(无)
discount:是否有打折:1(有)0(无)
string(50) sort_name:distance|sort_rule:1 可选
coord_type 坐标类型,1(wgs84ll即GPS经纬度),2(gcj02ll即国测局经纬度坐标),3(bd09ll即百度经纬度坐标),4(bd09mc即百度米制坐标)
注:"ll为小写LL"
坐标系说明书
int 1、2、3(默认)、4 可选
ret_coordtype 可选参数,添加后POI返回国测局经纬度坐标
坐标系说明书
string(50) gcj02ll 可选
page_size 单次召回POI数量,默认为10条记录,最大返回20条。多关键字检索时,返回的记录数为关键字个数*page_size。 int 10 可选
page_num 分页页码,默认为0,0代表第一页,1代表第二页,以此类推。常与page_size搭配使用。 int 0、1、2 可选

返回结果

名称 类型 说明
status Int 本次API访问状态,如果成功返回0,如果失败返回其他数字,见服务状态码
message string 对API访问状态值的英文说明,如果成功返回"ok",并返回结果字段,如果失败返回错误说明。
total int POI检索总数,开发者请求中设置了page_num字段才会出现total字段。出于数据保护目的,单次请求total最多为400。
name string poi名称
location object poi经纬度坐标
+lat float 纬度值
+lng float 经度值
address string poi地址信息
province string 所属省份
city string 所属城市
area string 所属区县
telephone string poi电话信息
uid string poi的唯一标示,可用于详情检索
street_id string 街景图id
detail string 是否有详情页:1有,0没有
detail_info object poi的扩展信息,仅当scope=2时,显示该字段,不同的poi类型,显示的detail_info字段不同。
+distance int32 距离中心点的距离,圆形区域检索时返回
+type string 所属分类,如’hotel’、’cater’。
+tag string 标签
+navi_location POI对应的导航引导点坐标。大型面状POI的导航引导点,一般为各类出入口,方便结合导航、路线规划等服务使用
+lng float 导航引导点经度
+lat float 导航引导点纬度
+detail_url string poi的详情页
+children poi子点数据,若某poi无子点,该字段为空
+uid string poi子点的唯一标示,可用于详情检索
+name string poi子点名称
+show_name string poi子点简要名称
+tag string poi子点类别
+location poi子点坐标
+lat float poi子点纬度
+lng float poi子点经度
+address string poi子点地址
+price string poi商户的价格
+shop_hours string 营业时间
+overall_rating string 总体评分
+taste_rating string 口味评分
+service_rating string 服务评分
+environment_rating string 环境评分
+facility_rating string 星级(设备)评分
+hygiene_rating string 卫生评分
+technology_rating string 技术评分
+image_num string 图片数
+groupon_num int 团购数
+discount_num int 优惠数
+comment_num string 评论数
+favorite_num string 收藏数
+checkin_num string 签到数

圆形区域检索服务

请求示例

HTTP_METHOD URI 说明
GET /place/v2/search 调用请求

请求例子:

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/place/v2/search?query=银行&location=39.915,116.404&radius=2000&output=xml

请求参数

参数名 参数含义 类型 示例 是否必须
query 检索关键字。圆形区域检索和矩形区域内检索支持多个关键字并集检索,不同关键字间以$符号分隔,最多支持10个关键字检索。如:”银行$酒店”
如果需要按POI分类进行检索,请将分类通过query参数进行设置,如query=美食
string(45) 天安门 必选
tag 检索分类偏好,与q组合进行检索,多个分类以","分隔(百度地图POI行业分类(tag),如果需要严格按分类检索,请通过query参数设置 string(50) 美食 可选
location 圆形区域检索中心点,不支持多个点 string(50) 38.76623,116.43213
lat<纬度>,lng<经度>
必选
radius 圆形区域检索半径,单位为米。(当半径过大,超过中心点所在城市边界时,会变为城市范围检索,检索范围为中心点所在城市) string(50) 1000(默认) 可选
radius_limit 是否严格限定召回结果在设置检索半径范围内。true(是),false(否)。设置为true时会影响返回结果中total准确性及每页召回poi数量,我们会逐步解决此类问题。 string(50) false 可选
output 输出格式为json或者xml string(50) json或xml 可选
scope 检索结果详细程度。取值为1 或空,则返回基本信息;取值为2,返回检索POI详细信息 string(50) 1、2 可选
filter 检索过滤条件。当scope取值为2时,可以设置filter进行排序。
industry_type:行业类型,注意:设置该字段可提高检索速度和过滤精度,取值有: hotel(宾馆);cater(餐饮);life(生活娱乐) sort_name:排序字段,根据industry_type字段的值而定。 1、industry_type为hotel时,sort_name取值有: default(默认);price(价格);total_score(好评);level(星级);health_score(卫生);distance(距离排序,只有圆形区域检索有效) 2、industry_type为cater时,sort_name取值有: default(