全部服务产品
开发者频道
服务升级
登录
行政区划区域检索
下载开发文档
接口说明

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

使用说明

获取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、falsestring(50)
extensions_adcode是否召回国标行政区划编码,true(召回)、false(不召回)true、falsestring(50)
output输出格式为json或者xmljson或xmlstring(50)
scope检索结果详细程度。取值为1 或空,则返回基本信息;取值为2,返回检索POI详细信息1、2string(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:1string(50)
coord_type

坐标类型,1(wgs84ll即GPS经纬度),2(gcj02ll即国测局经纬度坐标),3(bd09ll即百度经纬度坐标),4(bd09mc即百度米制坐标)注:"ll为小写LL"坐标详细说明

1、2、3(默认)、4int
ret_coordtype

可选参数,添加后POI返回国测局经纬度坐标坐标详细说明

gcj02llstring(50)
page_size单次召回POI数量,默认为10条记录,最大返回20条。多关键字检索时,返回的记录数为关键字个数*page_size。10int
page_num分页页码,默认为0,0代表第一页,1代表第二页,以此类推。常与page_size搭配使用,仅当返回结果为poi时可以翻页。0、1、2int
sn

开发者的权限签名。sn校验说明

string(50)可选,若开发者所用AK的校验方式为SN校验时该参数必须。
timestamp设置sn后该值必填。string(50)设置sn后该值必填。
photo_show是否输出图片信息:true(输出) 、false(不输出)true、falsebool
address_result

query传入结构化地址(如:上地十街10号),检索结果返回数据的类型。
若不传入该字段,默认召回门址数据,仅当address_result=false时,召回相应的POI数据

falsestring(50)
返回参数
返回参数类型备注
statusInt本次API访问状态,如果成功返回0,如果失败返回其他数字。(见服务状态码
messagestring对API访问状态值的英文说明,如果成功返回ok,并返回结果字段,如果失败返回错误说明。
totalintPOI检索总数,开发者请求中设置了page_num字段才会出现total字段。出于数据保护目的,单次请求total最多为150。
result_typestringregion_type 行政区划类型;address_type 结构化地址类型;poi_type poi类型;city_type 城市类型
results返回的结果
namestringpoi名称
locationobjectpoi经纬度坐标
latfloat纬度值
lngfloat经度值
addressstringpoi地址信息
provincestring所属省份
citystring所属城市
areastring所属区县
adcodeint行政区划代码
telephonestringpoi电话信息
uidstringpoi的唯一标识,可用于详情检索
statusstringPOI的状态:
空(代表正常营业)
推算位置(代表开放/营业/办公状态可能有变化)
暂停营业
可能已关闭
已关闭
注意:该功能为高级付费功能,您可提交工单咨询
street_idstring街景图id
detailstring是否有详情页:1有,0没有
detail_infoobjectpoi的扩展信息,仅当scope=2时,显示该字段,不同的poi类型,显示的detail_info字段不同。
distanceint32距离中心点的距离,圆形区域检索时返回
typestring所属分类,如hotel、cater。
tagstring标签
labelstring标签细分解释,比如停车场标签(地上停车场/地下停车场),知名景区标签(几A级景区),酒店标签(什么类型酒店)等
navi_locationobjectPOI对应的导航引导点坐标。大型面状POI的导航引导点,一般为各类出入口,方便结合导航、路线规划等服务使用
lngfloat导航引导点经度
latfloat导航引导点纬度
aliasstringpoi别名
detail_urlstringpoi的详情页
childrenpoi子点数据,若某poi无子点,该字段为空
uidstringpoi子点的唯一标示,可用于详情检索
namestringpoi子点名称
show_namestringpoi子点简要名称
tagstringpoi子点类别
locationobjectpoi子点坐标 {"lat":39.911318,"lng":116.402284}, // lat poi子点纬度 , lng poi子点经度
addressstringpoi子点地址
pricestringpoi商户的价格
shop_hoursstring营业时间
overall_ratingstring总体评分
taste_ratingstring口味评分
service_ratingstring服务评分
environment_ratingstring环境评分
facility_ratingstring星级(设备)评分
hygiene_ratingstring卫生评分
technology_ratingstring技术评分
image_numstring图片数
groupon_numint团购数
discount_numint优惠数
comment_numstring评论数
favorite_numstring收藏数
checkin_numstring签到数
brandstringpoi对应的品牌(如加油站中的『中石油』、『中石化』)
content_tagstringpoi标签信息
photosarraypoi图片的下载链接。注意:该功能为高级付费功能,您可提交工单咨询。
如您需要获取POI图片及POI营业状态,请点击获取POI图片获取POI营业状态
示例代码
填写您的AK

输入AK可生成包含IP/SN校验方式的代码

<?php
// 此处填写你在控制台-应用管理-创建应用后获取的AK
$ak = '您的AK';
// 发起一个http get请求,并返回请求的结果
// $url字段为请求的地址
// $param字段为请求的参数
function request_get($url = '', $param = array()) {
if (empty($url) || empty($param)) {
return false;
}
$getUrl = $url . "?" . http_build_query($param);
$curl = curl_init(); // 初始化curl
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); // 跳过证书检查
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 2); // 从证书中检查SSL加密算法是否存在
curl_setopt($curl, CURLOPT_URL, $getUrl); // 抓取指定网页
curl_setopt($curl, CURLOPT_TIMEOUT, 1000); // 设置超时时间1秒
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); // curl不直接输出到屏幕
curl_setopt($curl, CURLOPT_HEADER, 0); // 设置header
$data = curl_exec($curl); // 运行curl
if (!$data) {
print("an error occured in function request_get(): " . curl_error($curl) . "\n");
}
curl_close($curl);
return $data;
}
// 请求地址
$url = 'https://api.map.baidu.com/place/v2/search';
// 构造请求参数
$param['query'] = 'ATM机';
$param['tag'] = '银行';
$param['region'] = '北京';
$param['output'] = 'json';
$param['ak'] = $ak;
$res = request_get($url, $param);
// 将原始返回的结果打印出来
print("请求的原始返回结果为:\n");
print($res . "\n");
?>
{
"status": 0,
"message": "ok",
"result_type": "poi_type",
"results": [
{
"name": "中国工商银行24小时自助银行(北京府学路支行)",
"location": {
"lat": 40.227332,
"lng": 116.263379
},
"address": "北京市昌平区府学路福地家园7号楼07号1-2层",
"province": "北京市",
"city": "北京市",
"area": "昌平区",
"street_id": "22e11407287926b4d5b74e09",
"detail": 1,
"uid": "22e11407287926b4d5b74e09"
},
{
"name": "中国工商银行24小时自助银行(北京分行中关村支行丰慧中路店)",
"location": {
"lat": 40.08189,
"lng": 116.242144
},
"address": "丰慧中路7号",
"province": "北京市",
"city": "北京市",
"area": "海淀区",
"street_id": "dd33b83a0f8c6f55ab175a1f",
"detail": 1,
"uid": "dd33b83a0f8c6f55ab175a1f"
},
{
"name": "中国工商银行ATM(昌平支行)",
"location": {
"lat": 40.21018,
"lng": 116.244804
},
"address": "北京市昌平区科技园区超前路9号",
"province": "北京市",
"city": "北京市",
"area": "昌平区",
"street_id": "5508504dff802acbc7f0250d",
"detail": 1,
"uid": "5508504dff802acbc7f0250d"
},
{
"name": "招商银行24小时自助银行(立水桥支行)",
"location": {
"lat": 40.046176,
"lng": 116.421222
},
"address": "北京市朝阳区北苑路13号院1号楼1-9号",
"province": "北京市",
"city": "北京市",
"area": "朝阳区",
"street_id": "2e00c5ddfe1e6e62d6851f85",
"detail": 1,
"uid": "2e00c5ddfe1e6e62d6851f85"
},
{
"name": "中国建设银行24小时自助银行(北京昌平天通北苑支行)",
"location": {
"lat": 40.083388,
"lng": 116.420857
},
"address": "北京市昌平区东小口镇天通北苑一区甲4号楼3门(近地铁5号线天通苑站)",
"province": "北京市",
"city": "北京市",
"area": "昌平区",
"street_id": "ea4a3dc98279772e4e55471c",
"detail": 1,
"uid": "ea4a3dc98279772e4e55471c"
},
{
"name": "中国建设银行ATM(北京昌平回龙观支行)",
"location": {
"lat": 40.09399,
"lng": 116.350631
},
"address": "北京市昌平区龙回苑28号",
"province": "北京市",
"city": "北京市",
"area": "昌平区",
"street_id": "750368359a2e38af5e0d021b",
"detail": 1,
"uid": "750368359a2e38af5e0d021b"
},
{
"name": "招商银行24小时自助银行(回龙观支行)",
"location": {
"lat": 40.085153,
"lng": 116.344808
},
"address": "北京市昌平区龙冠商务中心1层",
"province": "北京市",
"city": "北京市",
"area": "昌平区",
"street_id": "5165c94b870f3ec5d92f289b",
"detail": 1,
"uid": "5165c94b870f3ec5d92f289b"
},
{
"name": "招商银行24小时自助银行服务(望京融科支行)",
"location": {
"lat": 40.003785,
"lng": 116.489532
},
"address": "北京市朝阳区望京东园523号融科望京中心A座101号",
"province": "北京市",
"city": "北京市",
"area": "朝阳区",
"street_id": "647a352e9bbbaa226268580a",
"detail": 1,
"uid": "647a352e9bbbaa226268580a"
},
{
"name": "中国工商银行24小时自助银行(北新桥支行)",
"location": {
"lat": 39.949826,
"lng": 116.423466
},
"address": "北京市东城区雍和宫大街52号",
"province": "北京市",
"city": "北京市",
"area": "东城区",
"street_id": "4a152d0030a8dc15f4b916d6",
"detail": 1,
"uid": "4a152d0030a8dc15f4b916d6"
},
{
"name": "中国工商银行24小时自助银行服务(京奥嘉园支行)",
"location": {
"lat": 39.966871,
"lng": 116.552054
},
"address": "东坝乡京奥家园186幢1-2号",
"province": "北京市",
"city": "北京市",
"area": "朝阳区",
"street_id": "f757e6eee5b37817260bd043",
"detail": 1,
"uid": "f757e6eee5b37817260bd043"
}
]
}
在线运行
参数备注必选
query
检索关键字。行政区划区域检索不支持多关键字检索。如果需要按POI分类进行检索,请将分类通过query参数进行设置,如query=美食
tag
检索分类偏好,与query组合进行检索,多个分类以","分隔 (POI分类),如果需要严格按分类检索,请通过query参数设置
region
检索行政区划区域(增加区域内数据召回权重,如需严格限制召回数据在区域内,请搭配使用city_limit参数),可输入行政区划名或对应cityCode
output
输出格式为json或者xml
服务状态码
返回码英文描述定义常见原因
0ok正常服务请求正常召回
1服务器内部错误该服务响应超时或系统内部错误,请留下联系方式
2Parameter Invalid请求参数非法必要参数拼写错误或漏传(如query和tag请求中均未传入)
3Verify Failure权限校验失败
4Quota Failure配额校验失败服务当日调用次数已超限,请前往API控制台提升(请优先进行)开发者认证
5AK Failureak不存在或者非法未传入ak参数;ak已被删除(可前往回收站恢复);
8Parse Proto Failure数据解析失败一般是query输入有误导致,如query输入特殊字符,全角符号。
9Permission Denied高级权限校验失败
101AK参数不存在请求消息没有携带AK参数
200APP不存在,AK有误请检查再重试根据请求的ak,找不到对应的APP
201APP被用户自己禁用,请在控制台解禁
202APP被管理员删除恶意APP被管理员删除
203APP类型错误当前API控制台支持Server(类型1), Mobile(类型2, 新版控制台区分为Mobile_Android(类型21)及Mobile_IPhone(类型22))及Browser(类型3),除此之外其他类型认为是APP类型错误
210APP IP校验失败在申请SERVER类型应用的时候选择IP校验,需要填写IP白名单,如果当前请求的IP地址不在IP白名单或者不是0.0.0.0/0就认为IP校验失败
211APP SN校验失败SERVER类型APP有两种校验方式IP校验和SN校验,当用户请求的SN和服务端计算出来的SN不相等的时候提示SN校验失败
240APP 服务被禁用用户在API控制台中创建或设置某APP的时候禁用了某项服务,若需开通权限,可进入API控制台为AK勾选对应服务
250用户不存在根据请求的user_id, 数据库中找不到该用户的信息,请携带正确的user_id
251用户被自己删除该用户处于未激活状态
252用户被管理员删除恶意用户被加入黑名单
260服务不存在服务器解析不到用户请求的服务名称
261服务被禁用该服务已下线
302天配额超限,限制访问配额超限,如果想增加配额请联系我们
401当前并发量已经超过约定并发配额,限制访问并发控制超限,请控制并发量或联系我们

上一篇

开始使用

下一篇

多边形区域检索

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