地点检索

所有文档

服务概览

快速开始

使用准备开始使用

接口文档

服务功能

行政区划区域检索多边形区域检索圆形区域检索地点详情检索地点输入提示

进阶能力

获取POI图片获取POI营业状态

相关资料

更新日志常见问题资源下载使用指南

行政区划区域检索

下载开发文档

接口说明

开发者可通过该功能，检索某一行政区划内（目前最细到城市级别）的地点信息。

使用说明

获取POI图片及获取POI营业状态为高级服务。

服务调用量的限制请点击这里查阅。

API服务地址

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

请求参数

参数名称	参数含义	示例	字段类型	必选
query	检索关键字。行政区划区域检索不支持多关键字检索。如果需要按POI分类进行检索，请将分类通过query参数进行设置，如query=美食	天安门、美食	string(45)	是
region	检索行政区划区域（增加区域内数据召回权重，如需严格限制召回数据在区域内，请搭配使用city_limit参数），可输入行政区划名或对应cityCode	北京、131（北京的code）、全国，等	string(50)	是
ak	开发者的访问密钥，必填项。v2之前该属性为key。申请密钥		string(50)	是
tag	检索分类偏好，与query组合进行检索，多个分类以","分隔（POI分类），如果需要严格按分类检索，请通过query参数设置	美食	string(50)	否
city_limit	区域数据召回限制，为true时，仅召回region对应区域内数据。	true、false	string(50)	否
extensions_adcode	是否召回国标行政区划编码，true（召回）、false（不召回）	true、false	string(50)	否
output	输出格式为json或者xml	json或xml	string(50)	否
scope	检索结果详细程度。取值为1 或空，则返回基本信息；取值为2，返回检索POI详细信息	1、2	string(50)	否
center	传入poi坐标，辅助检索结果按照距离排序返回。注意：需要结合filter字段一起使用并结合coord_type字段说明该字段的坐标类型	38.76623,116.43213 lat<纬度>,lng<经度>	string(50)	否
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（距离排序，需结合center字段一起使用） 2、industry_type为cater时，sort_name取值有： default（默认）；taste_rating（口味）；price（价格）；overall_rating（好评）；service_rating（服务）；distance（距离排序，需结合center字段一起使用） 3、industry_type为life时，sort_name取值有： default（默认）；price（价格）；overall_rating（好评）；comment_num（服务）；distance（距离排序，需结合center字段一起使用）sort_rule：排序规则：0（从高到低），1（从低到高）price_section：价格区间groupon：是否有团购：1（有），0（无）discount：是否有打折：1（有），0（无）	sort_name:distance\|sort_rule:1	string(50)	否
coord_type	传入的坐标类型，1（wgs84ll即GPS经纬度），2（gcj02ll即国测局经纬度坐标），3（bd09ll即百度经纬度坐标），4（bd09mc即百度米制坐标）注："ll为小写LL"坐标详细说明	1、2、3(默认)、4	int	否
ret_coordtype	返回的坐标类型，可选参数，添加后POI返回国测局经纬度坐标坐标详细说明	gcj02ll	string(50)	否
page_size	单次召回POI数量，默认为10条记录，最大返回20条。多关键字检索时，返回的记录数为关键字个数*page_size。	10	int	否
page_num	分页页码，默认为0,0代表第一页，1代表第二页，以此类推。常与page_size搭配使用，仅当返回结果为poi时可以翻页。	0、1、2	int	否
sn	开发者的权限签名。sn校验说明		string(50)	可选，若开发者所用AK的校验方式为SN校验时该参数必须。
timestamp	设置sn后该值必填。		string(50)	设置sn后该值必填。
photo_show	是否输出图片信息：true(输出) 、false(不输出)	true、false	bool	否
address_result	query传入结构化地址（如：上地十街10号），检索结果返回数据的类型。若不传入该字段，默认召回门址数据，仅当address_result=false时，召回相应的POI数据	false	string(50)	否
extenstions_town	当取值为true时，召回POI的乡镇街道信息注意：该功能为高级付费功能，您可提交工单咨询	false、true 默认值：false	string(50)	否
language	指定输入参数和召回参数的语言类型，可支持的语言类型为英文注意：该功能为高级付费功能，您可提交工单咨询	en	string(50)	否

返回参数

返回参数				类型	备注
status				Int	本次API访问状态，如果成功返回0，如果失败返回其他数字。（见服务状态码）
message				string	对API访问状态值的英文说明，如果成功返回ok，并返回结果字段，如果失败返回错误说明。
total				int	POI检索总数，开发者请求中设置了page_num字段才会出现total字段。出于数据保护目的，单次请求total最多为150。
result_type				string	region_type 行政区划类型;address_type 结构化地址类型;poi_type poi类型;city_type 城市类型
results					返回的结果
	name			string	poi名称
	location			object	poi经纬度坐标
		lat		float	纬度值
		lng		float	经度值
	address			string	poi地址信息
	province			string	所属省份
	city			string	所属城市
	area			string	所属区县
	town			string	所属乡镇街道信息注意：该功能为高级付费功能，您可提交工单咨询
	adcode			int	行政区划代码
	telephone			string	poi电话信息
	uid			string	poi的唯一标识，可用于详情检索
	status			string	POI的状态：空（代表正常营业）推算位置（代表开放/营业/办公状态可能有变化）暂停营业可能已关闭已关闭注意：该功能为高级付费功能，您可提交工单咨询
	street_id			string	街景图id
	detail			string	是否有详情页：1有，0没有
	detail_info			object	poi的扩展信息，仅当scope=2时，显示该字段，不同的poi类型，显示的detail_info字段不同。
		classified_poi_tag		string	POI展示分类（细致分类）
		distance		int32	距离中心点的距离，圆形区域检索时返回
		type		string	所属分类，如hotel、cater。
		tag		string	标签
		label		string	标签细分解释，比如停车场标签（地上停车场/地下停车场），知名景区标签（几A级景区），酒店标签（什么类型酒店）等
		navi_location		object	POI对应的导航引导点坐标。大型面状POI的导航引导点，一般为各类出入口，方便结合导航、路线规划等服务使用
			lng	float	导航引导点经度
			lat	float	导航引导点纬度
		alias		array	poi别名
		detail_url		string	poi的详情页
		children			poi子点数据，若某poi无子点，该字段为空
			uid	string	poi子点的唯一标示，可用于详情检索
			name	string	poi子点名称
			show_name	string	poi子点简要名称
			tag	string	poi子点类别
			location	object	poi子点坐标 {"lat":39.911318,"lng":116.402284}, // lat poi子点纬度 , lng 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图片的下载链接。注意：该功能为高级付费功能，您可提交工单咨询。

如您需要获取POI图片及POI营业状态，请点击获取POI图片及获取POI营业状态

服务状态码

返回码	英文描述	定义	常见原因


0	ok	正常	服务请求正常召回
1		服务器内部错误	该服务响应超时或系统内部错误，请留下联系方式
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	高级权限校验失败
101		AK参数不存在	请求消息没有携带AK参数
200		APP不存在，AK有误请检查再重试	根据请求的ak，找不到对应的APP
201		APP被用户自己禁用，请在控制台解禁
202		APP被管理员删除	恶意APP被管理员删除
203		APP类型错误	当前API控制台支持Server(类型1), Mobile(类型2, 新版控制台区分为Mobile_Android(类型21)及Mobile_IPhone（类型22））及Browser（类型3），除此之外其他类型认为是APP类型错误
210		APP IP校验失败	在申请SERVER类型应用的时候选择IP校验，需要填写IP白名单，如果当前请求的IP地址不在IP白名单或者不是0.0.0.0/0就认为IP校验失败
211		APP SN校验失败	SERVER类型APP有两种校验方式IP校验和SN校验，当用户请求的SN和服务端计算出来的SN不相等的时候提示SN校验失败
240		APP 服务被禁用	用户在API控制台中创建或设置某APP的时候禁用了某项服务，若需开通权限，可进入API控制台为AK勾选对应服务
250		用户不存在	根据请求的user_id, 数据库中找不到该用户的信息，请携带正确的user_id
251		用户被自己删除	该用户处于未激活状态
252		用户被管理员删除	恶意用户被加入黑名单
260		服务不存在	服务器解析不到用户请求的服务名称
261		服务被禁用	该服务已下线
302		天配额超限，限制访问	配额超限，如果想增加配额请联系我们
401		当前并发量已经超过约定并发配额，限制访问	并发控制超限，请控制并发量或联系我们

开始使用

多边形区域检索

本篇文章对您是否有帮助？