服务文档

接口功能介绍

行政区划区域检索

https://api.map.baidu.com/place/v2/search?query=ATM机&tag=银行&region=北京&output=json&ak=您的ak //GET请求

请求参数

参数名	参数含义	类型	示例	是否必须
query	检索关键字。行政区划区域检索不支持多关键字检索。 如果需要按POI分类进行检索，请将分类通过query参数进行设置，如query=美食	string(45)	天安门、美食	必选
tag	检索分类偏好，与q组合进行检索，多个分类以","分隔 （POI分类），如果需要严格按分类检索，请通过query参数设置	string(50)	美食	可选
region	检索行政区划区域（增加区域内数据召回权重，如需严格限制召回数据在区域内，请搭配使用city_limit参数），可输入行政区划名或对应cityCode	string(50)	北京、131（北京的code）、海淀区、全国，等	必选
city_limit	区域数据召回限制，为true时，仅召回region对应区域内数据。	string(50)	true、false	可选
extensions_adcode	是否召回国标行政区划编码， true（召回）、false（不召回）	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搭配使用，仅当返回结果为poi时可以翻页。	int	0、1、2	可选
ak	开发者的访问密钥，必填项。v2之前该属性为key。申请密钥	string(50)		必选
sn	开发者的权限签名。Sn校验说明	string(50)		可选，若开发者所用AK的校验方式为SN校验时该参数必须。
timestamp	设置sn后该值必填。	string(50)		设置sn后该值必填。
photo_show	是否输出图片信息：true(输出) 、false(不输出)	bool	true、false	可选
address_result	query传入结构化地址（如：上地十街10号），检索结果返回数据的类型。 若不传入该字段，默认召回门址数据，仅当address_result=false时，召回相应的POI数据	string(50)	false	可选

返回参数见下方页面内容

圆形区域检索

https://api.map.baidu.com/place/v2/search?query=银行&location=39.915,116.404&radius=2000&output=xml&ak=您的密钥 //GET请求

请求参数

参数名	参数含义	类型	示例	是否必须
query	检索关键字。圆形区域检索和多边形区域内检索支持多个关键字并集检索，不同关键字间以符号分隔，最多支持10个关键字检索。如:”银行酒店” 如果需要按POI分类进行检索，请将分类通过query参数进行设置，如query=美食	string(45)	天安门	必选
tag	检索分类偏好，与q组合进行检索，多个分类以","分隔 （POI分类），如果需要严格按分类检索，请通过query参数设置	string(50)	美食	可选
location	圆形区域检索中心点，不支持多个点	string(50)	38.76623,116.43213lat<纬度>,lng<经度>	必选
radius	圆形区域检索半径，单位为米。（增加区域内数据召回权重，如需严格限制召回数据在区域内，请搭配使用radius_limit参数），当半径过大，超过中心点所在城市边界时，会变为城市范围检索，检索范围为中心点所在城市	string(50)	1000（默认）	可选
radius_limit	是否严格限定召回结果在设置检索半径范围内。true（是），false（否）。设置为true时会影响返回结果中total准确性及每页召回poi数量， 设置为false时可能会召回检索半径外的poi。	string(50)	false	可选
extensions_adcode	是否召回国标行政区划编码，true（召回）、false（不召回）	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。多关键词检索时，单页返回总数=关键词数量page_size	int	10	可选
page_num	分页页码，默认为0,0代表第一页，1代表第二页，以此类推。常与page_size搭配使用，仅当返回结果为poi时可以翻页。	int	0、1、2	可选
ak	开发者的访问密钥，必填项。v2之前该属性为key。申请秘钥	string(50)		必选
sn	开发者的权限签名。Sn校验说明	string(50)		可选，若开发者所用AK的校验方式为SN校验时该参数必须。
timestamp	设置sn后该值必填。	string(50)		设置sn后该值必填。
photo_show	是否输出图片信息：true(输出) 、false(不输出)	bool	true、false	可选

返回参数（行政区划区域检索、圆形区域检索）

名称	类型	说明
status	Int	本次API访问状态，如果成功返回0，如果失败返回其他数字。（见服务状态码）
message	string	对API访问状态值的英文说明，如果成功返回"ok"，并返回结果字段，如果失败返回错误说明。
total	int	POI检索总数，开发者请求中设置了page_num字段才会出现total字段。出于数据保护目的，单次请求total最多为150。
name	string	poi名称
result_type	string	当返回结果为城市列表时，result_type=city_type当返回结果为普通poi时，result_type=poi_type当返回结果为行政区划数据时，result_type=region_type当返回结果为门址数据时，result_type=address_type
location	object	poi经纬度坐标
	lat	float	纬度值
lng	float	经度值
address	string	poi地址信息
province	string	所属省份
city	string	所属城市
area	string	所属区县
adcode	int	行政区划代码
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	导航引导点纬度
alias	string	poi别名
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	签到数
	brand	string	poi对应的品牌（如加油站中的『中石油』、『中石化』）
	content_tag	string	poi标签信息
	photos	array	poi图片的下载链接。 注意：该功能为高级付费功能，您可提交工单咨询。

地点详情检索服务

https://api.map.baidu.com/place/v2/detail?uid=435d7aea036e54355abbbcc8&output=json&scope=2&ak=您的密钥 //GET请求

请求参数

参数	是否必须	默认值	格式举例	含义
uid	是	无	‘8ee4560cf91d160e6cc02cd7’	poi的uid
uids	否	无	‘8ee4560cf91d160e6cc02cd7’,‘5ffb1816cf771a226f476058’	uid的集合，最多可以传入10个uid，多个uid之间用英文逗号分隔。
extensions_adcode	否	false	true、false	是否召回国标行政区划编码，true（召回）、false（不召回）
output	否	xml	json或xml	请求返回格式
ret_coordtype	否	bd09ll	gcj02ll	可选参数，添加后POI返回国测局经纬度坐标 坐标详细说明
scope	是	1	1、2	检索结果详细程度。取值为1 或空，则返回基本信息；取值为2，返回检索POI详细信息
ak	是	无	您的ak	开发者的访问密钥，必填项。v2之前该属性为key。
sn	否	无	Sn生成方法	开发者的权限签名。
timestamp	否	无		设置sn后该值必填。
photo_show	否	无	true、false	是否输出图片信息：true(输出) 、false(不输出)

返回参数（行政区划区域检索、圆形区域检索、多边形区域检索、地点详情检索）

名称	类型	说明
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	所属区县
adcode	int	行政区划代码
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	导航引导点纬度
alias	string	poi别名
detail_url	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	签到数
	brand	string	poi对应的品牌（如加油站中的『中石油』、『中石化』）
	content_tag	string	poi标签信息
	photos	array	poi图片的下载链接。 注意：该功能为高级付费功能，您可提交工单咨询。

服务状态码

返回码	英文描述	定义	常见原因
0	ok	正常	服务请求正常召回
2	Parameter Invalid	请求参数非法	必要参数拼写错误或漏传（如query和tag请求中均未传入）
3	Verify Failure	权限校验失败
4	Quota Failure	配额校验失败	服务当日调用次数已超限，请前往API控制台提升（请优先进行开发者认证）
5	AK Failure	ak不存在或者非法	未传入ak参数；ak已被删除（可前往回收站恢复）；
8	Parse Proto Failure	数据解析失败	一般是query输入有误导致，如query输入特殊字符，全角符号。
9	Permission Denied	高级权限校验失败