浏览器版本低!无法浏览完整内容,建议升级或更换浏览器。

文档全面上新

更科技的视觉体验,更高效的页面结构,快前往体验吧!

体验新版
(未显示1个用户的142个中间版本)
第1行: 第1行:
 
{{webapi-sidebar}}
 
{{webapi-sidebar}}
Place API v2.0
+
<div class="labels"><div class="interiorNav"><div class="interiorLI">服务介绍</div><div class="interiorLI">服务文档</div><div class="interiorLI">使用指南</div><div class="interiorLI">常见问题</div><div class="interiorLI">更新日志</div><div class="interiorLI">资源下载</div></div></div><div class="contents"><div class="navRemark"><div class="handpointto">内容(服务介绍)</div></div><div class="txtstyle2"><div class="bluetitle"><div class="services-title-text">地点检索服务</div></div><div class="serve-explain-text">
 
+
地点检索服务(又名Place API)是一类Web API接口服务;<br/>服务提供多种场景的地点(POI)检索功能,包括城市检索、圆形区域检索、多边形区域检索。开发者可通过接口获取地点(POI)基础或详细地理信息。<br/><span style="color:#FF0000;">注意:</span>地点检索服务适用于【XX大厦】、【XX小区】等POI地点名称的检索,若需要检索结构化地址,如【北京市海淀区上地十街十号】,则推荐使用[http://lbsyun.baidu.com/index.php?title=webapi/guide/webservice-geocoding 地理编码]服务。
Place APIv1.0 访问入口 自2014年9月1日起,我们将废弃Place API v1.0。届时 Place API v1.0将无法正常使用。
+
</div><div class="bluetitle"><div class="services-title-text">功能介绍</div></div><div class="serveintor-min"><div class="serveintortxt"><div class="serveintorleft"><div class="serveintoor-title">行政区划区域检索</div>
 
+
开发者可通过该功能,检索某一行政区划内(目前最细到城市级别)的地点信息。
==什么是Place API?==
+
</div><div class="serveintorright">
Place API 是一类简单的HTTP接口,用于返回查询某个区域的某类POI数据,且提供单个POI的详情查询服务,用户可以使用C#、C++、Java等开发语言发送HTTP请求且接收json、xml的数据。
+
http://mapopen-pub-webserviceapi.bj.bcebos.com/images/place1.png
 
+
</div></div><div class="serveintortxt"><div class="serveintorleft"><div class="serveintoor-title">圆形区域检索</div>
==功能介绍==
+
开发者可设置圆心和半径,检索圆形区域内的地点信息(常用于周边检索场景)。
Place API 提供区域检索POI服务、POI详情服务与团购信息检索服务、商家团购详情查询。
+
</div><div class="serveintorright">
 
+
http://mapopen-pub-webserviceapi.bj.bcebos.com/images/place2.png
1. 区域检索POI服务提供三种区域检索方法:
+
</div></div><div class="serveintortxt"><div class="serveintorleft"><div class="serveintoor-title">地点详情检索</div>
 
+
不同于其他三种检索功能。地点详情检索针对指定POI,检索其相关的详情信息。开发者可以通过三种区域检索(或其他服务)功能,获取POI&nbsp;id。使用“地点详情检索”功能,传入id,即可检索POI详情信息,如评分、营业时间等(不同类型POI对应不同类别详情数据)。
{{bluepoint}}城市内检索(对应JavaScriptAPI的Search方法)
+
</div><div class="serveintorright">
 
+
http://mapopen-pub-webserviceapi.bj.bcebos.com/images/place4.png
{{bluepoint}}矩形检索(对应JavaScript API的SearchInBound方法)
+
</div></div><div class="serveintortxt"><div class="serveintorleft"><div class="serveintoor-title">多边形区域检索</div>
 
+
多边形区域检索为高级权限,如有需求请提交[http://lbsyun.baidu.com/apiconsole/fankui 【工单】]咨询。
{{bluepoint}}圆形区域检索(对应JavaScript的SearchNearBy方法)。
+
</div><div class="serveintorright">
 
+
http://mapopen-pub-webserviceapi.bj.bcebos.com/images/place3.png
2. POI详情服务提供查询单个POI的详情信息,如好评。
+
</div></div></div></div><div class="txtstyle2"><div class="bluetitle"><div class="services-title-text">接口功能介绍<br/></div></div><div class="serve-explain-text"><div class="serveintoor-title service-page-anchor">行政区划区域检索</div><div class="code-template"><pre class="get-url-pre">https://api.map.baidu.com/place/v2/search?query=ATM机&tag=银行&region=北京&output=json&ak=您的ak //GET请求
 
+
</pre>
3. 团购信息检索服务提供三种区域检索方法:
+
</div></div><div class="separate-title">请求参数</div>
 
+
{{bluepoint}}城市内检索
+
 
+
{{bluepoint}}矩形检索
+
 
+
{{bluepoint}}圆形区域检索
+
 
+
4. 商家团购详情查询。
+
 
+
用户可以使用C# 、C++、Java等开发语言发送HTTP请求且接收JSON、XML的返回数据。
+
 
+
==使用说明==
+
Place API 是一套免费使用的API接口,调用次数限制为10万次/天。
+
 
+
ak是API请求串的必填参数,请先[http://lbsyun.baidu.com/apiconsole/key?application=key 获取密钥],若无百度账号则首先需要[https://passport.baidu.com/v2/?reg&tpl=pp&u=http%3A%2F%2Flbsyun.baidu.com%2Fapiconsole%2Fkey%3Fapplication%3Dkey  注册百度账号]。
+
 
+
'''Hello, World'''
+
 
+
以下是一个关于place API的简单示例,设置检索城市为北京,检索关键字为“饭店”,检索后返回10条数据。
+
 
+
http://api.map.baidu.com/place/v2/search?&q=饭店&region=北京&output=json&ak=E4805d16520de693a3fe707cdc962045
+
 
+
'''结果说明:'''</b>点击上述请求url,返回符合检索条件的json格式的数据。
+
 
+
==Place服务地址==
+
百度地图Place API服务地址:
+
 
+
http://api.map.baidu.com/place/v2/search <span style="color:green;">//v2 place区域检索POI服务</span>
+
 
+
http://api.map.baidu.com/place/v2/detail <span style="color:green;">//v2 POI详情服务</span>
+
 
+
http://api.map.baidu.com/place/v2/eventsearch <span style="color:green;">//v2 团购信息检索服务</span>
+
 
+
http://api.map.baidu.com/place/v2/eventdetail <span style="color:green;">//v2 商家团购信息查询</span>
+
 
+
组成说明:
+
{{bluepoint}}域名:http://api.map.baidu.com
+
 
+
{{bluepoint}}服务名:place
+
 
+
{{bluepoint}}服务版本号:较之前版本,v2版本新增参数。
+
 
+
{{bluepoint}}Place方法名:如search表示区域POI查询,detail表示POI详情,eventsearch为团购信息检索,eventdetail为商家团购详情查询。
+
 
+
==Place区域检索POI服务==
+
 
+
===Place区域检索通用接口参数===
+
以下参数,适用于三种区域检索方法的Place API。
+
 
+
 
{|
 
{|
 
|-
 
|-
!width="96" |参数
+
! width="100" | 参数名
!width="70" |是否必须
+
! width="660" | 参数含义
!width="60" |默认值
+
! width="70" | 类型
!width="220" |格式举例
+
! width="50" style="width: 159px;" | 示例
!width="255" |含义
+
! width="100" style="width: 138px;" | 是否必须
 
|-
 
|-
|q(query)
+
| query
|
+
| 检索关键字。行政区划区域检索不支持多关键字检索。<br/>如果需要按POI分类进行检索,请将分类通过query参数进行设置,如query=美食
|
+
| string(45)
|中关村、ATM、百度大厦
+
| style="width: 141px;" | 天安门、美食
|检索关键字,周边检索和矩形区域内检索支持多个关键字并集检索,不同关键字间以$符号分隔,最多支持10个关键字检索。如:”银行$酒店”。
+
| style="width: 120px;" | '''必选'''
 
|-
 
|-
|tag  
+
| tag
|
+
| 检索分类偏好,与q组合进行检索,多个分类以","分隔<br/>([http://lbsyun.baidu.com/index.php?title=lbscloud/poitags POI分类]),如果需要严格按分类检索,请通过query参数设置<br/>
|
+
| string(50)
|日式烧烤/铁板烧、朝外大街
+
| style="width: 141px;" | 美食
|标签项,与q组合进行检索
+
| style="width: 120px;" | 可选
 
|-
 
|-
|output
+
| region
|
+
| 检索行政区划区域(增加区域内数据召回权重,如需严格限制召回数据在区域内,请搭配使用city_limit参数),可输入行政区划名或对应[https://mapopen-website-wiki.bj.bcebos.com/static_zip/BaiduMap_cityCode_1102.zip cityCode]
|xml
+
| string(50)
|json或xml
+
| style="width: 141px;" | 北京、131(北京的code)、海淀区、全国,等
|输出格式为json或者xml
+
| style="width: 120px;" | '''必选'''
 
|-
 
|-
|scope
+
| city_limit
|
+
| 区域数据召回限制,为true时,仅召回region对应区域内数据。
|1
+
| string(50)
|1、2
+
| style="width: 141px;" | true、false
|检索结果详细程度。取值为1 或空,则返回基本信息;取值为2,返回检索POI详细信息
+
| style="width: 120px;" | 可选
|-  
+
|-
|filter
+
| extensions_adcode<br/>
|
+
| 是否召回国标行政区划编码,<br/>true(召回)、false(不召回)
|
+
| string(50)<br/>
|filter=industry_type
+
| style="width: 141px;" | true、false<br/>
|检索过滤条件,当scope取值为2时,可以设置filter进行排序。
+
| style="width: 120px;" | 可选
{{bluepoint}}'''industry_type''':行业类型
+
|-
 +
| output
 +
| 输出格式为json或者xml
 +
| string(50)
 +
| style="width: 141px;" | json或xml
 +
| style="width: 120px;" | 可选
 +
|-
 +
| scope
 +
| 检索结果详细程度。取值为1 或空,则返回基本信息;取值为2,返回检索POI详细信息
 +
| string(50)
 +
| style="width: 141px;" | 1、2
 +
| style="width: 120px;" | 可选
 +
|-
 +
| center
 +
| 传入poi坐标,辅助检索结果按照距离排序返回。<br/><span style="color: #f5533d;">注意:需要结合filter字段一起使用并结合coord_type字段说明该字段的坐标类型</span>
 +
| string(50)
 +
| 38.76623,116.43213<br/>lat<纬度>,lng<经度>
 +
| 可选
 +
|-
 +
| 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字段一起使用)<br/>'''sort_rule''':排序规则:0(从高到低),1(从低到高)<br/>'''price_section''':价格区间<br/>'''groupon''':是否有团购:1(有),0(无)<br/>'''discount''':是否有打折:1(有),0(无)
  
注意:设置该字段可提高检索速度和过滤精度。
+
| string(50)
 +
| style="width: 141px;" | sort_name:distance&#124;sort_rule:1
 +
| style="width: 120px;" | 可选
 +
|-
 +
| coord_type
 +
| 坐标类型,1(wgs84ll即GPS经纬度),2(gcj02ll即国测局经纬度坐标),3(bd09ll即百度经纬度坐标),4(bd09mc即百度米制坐标)<br/>注:"ll为小写LL"<br/>[http://lbsyun.baidu.com/index.php?title=coordinate 坐标详细说明]
 +
| int
 +
| style="width: 141px;" | 1、2、3(默认)、4
 +
| style="width: 120px;" | 可选
 +
|-
 +
| ret_coordtype
 +
| 可选参数,添加后POI返回国测局经纬度坐标<br/>[http://lbsyun.baidu.com/index.php?title=coordinate 坐标详细说明]
 +
| string(50)
 +
| style="width: 141px;" | gcj02ll
 +
| style="width: 120px;" | 可选
 +
|-
 +
| page_size
 +
| 单次召回POI数量,默认为10条记录,最大返回20条。多关键字检索时,返回的记录数为关键字个数*page_size。
 +
| int
 +
| style="width: 141px;" | 10
 +
| style="width: 120px;" | 可选
 +
|-
 +
| page_num
 +
| 分页页码,默认为0,0代表第一页,1代表第二页,以此类推。
 +
常与page_size搭配使用,仅当返回结果为poi时可以翻页。
  
industry_type取值如下:
+
| int
 +
| style="width: 141px;" | 0、1、2
 +
| style="width: 120px;" | 可选
 +
|-
 +
| ak
 +
| 开发者的访问密钥,必填项。v2之前该属性为key。
 +
[http://lbsyun.baidu.com/apiconsole/key/create 申请密钥]
  
hotel:宾馆
+
| string(50)
 +
| style="width: 141px;" |
 +
| style="width: 120px;" | '''必选'''
 +
|-
 +
| sn
 +
| 开发者的权限签名。
 +
[http://lbsyun.baidu.com/index.php?title=webapi/appendix Sn校验说明]
  
cater:餐饮
+
| string(50)
 +
| style="width: 141px;" |
 +
| style="width: 120px;" | 可选,若开发者所用AK的校验方式为SN校验时该参数必须。
 +
|-
 +
| timestamp
 +
| 设置sn后该值必填。
 +
| string(50)
 +
| style="width: 141px;" |
 +
| style="width: 120px;" | 设置sn后该值必填。
 +
|-
 +
| photo_show
 +
| 是否输出图片信息:true(输出) 、false(不输出)
 +
| bool
 +
| style="width: 141px;" | true、false
 +
| style="width: 120px;" | 可选
 +
|-
 +
| address_result
 +
| query传入结构化地址(如:上地十街10号),检索结果返回数据的类型。<br/>若不传入该字段,默认召回门址数据,仅当address_result=false时,召回相应的POI数据
 +
| string(50)
 +
| style="width: 141px;" | false
 +
| style="width: 120px;" | 可选
 +
|}
  
life:生活娱乐
+
返回参数见下方页面内容
  
{{bluepoint}}'''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:距离排序,只有周边检索有
 
 
{{bluepoint}} '''sort_rule''':排序规则,取值如下:0:从高到低,1:从低到高;
 
 
{{bluepoint}} '''price_section''':价格区间;
 
 
{{bluepoint}} '''groupon''':是否有团购,1为有团购,0为无团购;
 
 
{{bluepoint}} '''discount''':是否打折,1为有打折,0为无打折;
 
  
 +
<div class="serve-explain-text"><div class="serveintoor-title service-page-anchor">圆形区域检索</div><div class="code-template"><pre class="get-url-pre">https://api.map.baidu.com/place/v2/search?query=银行&location=39.915,116.404&radius=2000&output=xml&ak=您的密钥 //GET请求
 +
</pre>
 +
</div></div><div class="separate-title">请求参数<br/></div>
 +
{|
 
|-
 
|-
|page_size
+
! width="100" | 参数名
|
+
! width="610" | 参数含义
|10
+
! width="70" | 类型
|10
+
! width="100" | 示例
|范围记录数量,默认为10条记录,最大返回20条。多关键字检索时,返回的记录数为关键字个数*page_size。
+
! width="100" | 是否必须
 
|-
 
|-
|page_num
+
| query
|
+
| 检索关键字。圆形区域检索和多边形区域内检索支持多个关键字并集检索,不同关键字间以$符号分隔,最多支持10个关键字检索。如:”银行$酒店”<br/>如果需要按POI分类进行检索,请将分类通过query参数进行设置,如query=美食<br/>
|0
+
| string(45)
|0、1、2
+
| 天安门
|分页页码,默认为0,0代表第一页,1代表第二页,以此类推。
+
| '''必选'''
 
|-
 
|-
|ak
+
| tag
|
+
| 检索分类偏好,与q组合进行检索,多个分类以","分隔<br/>([http://lbsyun.baidu.com/index.php?title=lbscloud/poitags POI分类]),如果需要严格按分类检索,请通过query参数设置<br/>
|
+
| string(50)
|E4805d16520de693a3fe707cdc962045
+
| 美食
|用户的访问密钥,必填项。v2之前该属性为key。
+
| 可选
 
|-
 
|-
|sn
+
| location
|
+
| 圆形区域检索中心点,不支持多个点
|
+
| string(50)
|  
+
| 38.76623,116.43213
|用户的权限签名。
+
lat&lt;纬度&gt;,lng&lt;经度&gt;
|-
+
|timestamp
+
|否
+
|无
+
|
+
|设置sn后该值必填。
+
|}
+
'''编码说明:'''
+
  
对于query和region参数,因为这两个参数取值可以是中文或一些特殊字符(如:空格),举例:query可以取值“小吃”,region可以取值“北京”,为了避免提交到后台乱码,所以对于这2个参数值进行编码处理,编码成 UTF-8 字符的二字符十六进制值。 query和region参数取值时候,凡是不在下表中的字符都要进行编码。
+
| '''必选'''
 
+
{|
+
 
|-
 
|-
!width="74" |字符集合
+
| radius
!width="500" |字符
+
| 圆形区域检索半径,单位为米。(增加区域内数据召回权重,如需严格限制召回数据在区域内,请搭配使用radius_limit参数),当半径过大,超过中心点所在城市边界时,会变为城市范围检索,检索范围为中心点所在城市
 +
| string(50)
 +
| 1000(默认)
 +
| 可选
 
|-
 
|-
|URL非保留字
+
| radius_limit<br/>
|a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 - _ . ~
+
| 是否严格限定召回结果在设置检索半径范围内。true(是),false(否)。设置为true时会影响返回结果中total准确性及每页召回poi数量, 设置为false时可能会召回检索半径外的poi。<br/>
 +
| string(50)<br/>
 +
| false
 +
| 可选<br/>
 
|-
 
|-
|URL保留字
+
|  
|! * ' ( ) ; : @ & = + $ , / ? % # [ ]
+
extensions_adcode
|}
+
如果query和region参数中使用URL保留字字符的字面意思,例如:query关键字取值为"?小吃",检索关键字包含一个问号,此问号也必须进行编码,"?"的16进制编码为"%3F",所以整个检索关键字"?小吃"编码后为"%3F%E5%B0%8F%E5%90%83"。
+
  
附注:
+
|
 +
是否召回国标行政区划编码,
  
(1) javascript中一般采用encodeURIComponent函数对特殊字符进行编码。
+
true(召回)、false(不召回)
  
(2) Java中可以使用函数URLEncoder.encode对特殊字符进行编码。
+
|
 +
string(50)
  
(3) C#中可以使用函数HttpUtility.UrlEncode对特殊字符进行编码。
+
|
 +
true、false
  
(4) php中可以使用函数urlencode对特殊字符进行编码。
+
| 可选
 +
|-
 +
| 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(距离排序)<br/>'''sort_rule''':排序规则:0(从高到低),1(从低到高)<br/>'''price_section''':价格区间<br/>'''groupon''':是否有团购:1(有),0(无)<br/>'''discount''':是否有打折:1(有),0(无)
  
===Place检索示例:===
+
| string(50)
<div id="dev_wikiuse_iframe0">
+
| sort_name:distance&#124;sort_rule:1
    <div dir="http://developer.baidu.com/map/skins/MySkin/resources/iframs/webservice-placapi.html"></div>
+
| 可选
</div>
+
|-
 
+
| coord_type
===Place区域检索示例方法===
+
| 坐标类型,1(wgs84ll即GPS经纬度),2(gcj02ll即国测局经纬度坐标),3(bd09ll即百度经纬度坐标),4(bd09mc即百度米制坐标)<br/>注:"ll为小写LL"<br/>[http://lbsyun.baidu.com/index.php?title=coordinate 坐标详细说明]
Place API根据支持检索的区域类型,提供城市内、矩形、圆形三种检索方法,使用说明如下:
+
| int
 
+
| 1、2、3(默认)、4
====城市内检索请求参数====
+
| 可选
 
+
{|
+
 
|-
 
|-
!width="96" |参数
+
| ret_coordtype
!width="70" |是否必须
+
| 可选参数,添加后POI返回国测局经纬度坐标<br/>[http://lbsyun.baidu.com/index.php?title=coordinate 坐标详细说明]
!width="60" |默认值
+
| string(50)
!width="220" |格式举例
+
| gcj02ll
!width="255" |含义
+
| 可选
 
|-
 
|-
|region
+
| page_size
|
+
| 单次召回POI数量,默认为10条记录,最大返回20条。多关键字检索时,返回的记录数为关键字个数*page_size。多关键词检索时,单页返回总数=关键词数量*page_size
|
+
| int
|北京、131、全国
+
| 10
|检索区域,如果取值为“全国”或某省份,则返回指定区域的POI。
+
| 可选
|}
+
|-
'''城市检索示例(返回json数据):'''
+
| page_num
 +
| 分页页码,默认为0,0代表第一页,1代表第二页,以此类推。
 +
常与page_size搭配使用,仅当返回结果为poi时可以翻页。
  
http://api.map.baidu.com/place/v2/search?&query=%E9%93%B6%E8%A1%8C&region=%E6%B5%8E%E5%8D%97&output=json&ak=E4805d16520de693a3fe707cdc962045
+
| int
 +
| 0、1、2
 +
| 可选
 +
|-
 +
| ak
 +
| 开发者的访问密钥,必填项。v2之前该属性为key。
 +
[http://lbsyun.baidu.com/apiconsole/key/create 申请秘钥]
  
====矩形区域检索参数====
+
| string(50)
 +
|
 +
| '''必选'''
 +
|-
 +
| sn
 +
| 开发者的权限签名。
 +
[http://lbsyun.baidu.com/index.php?title=webapi/appendix Sn校验说明]
  
{|
+
| string(50)
 +
|
 +
| 可选,若开发者所用AK的校验方式为SN校验时该参数必须。
 
|-
 
|-
!width="96" |参数
+
| timestamp
!width="70" |是否必须
+
| 设置sn后该值必填。
!width="60" |默认值
+
| string(50)
!width="220" |格式举例
+
|  
!width="255" |含义
+
| 设置sn后该值必填。
 
|-
 
|-
|bounds(bds)  
+
| photo_show
|
+
| 是否输出图片信息:true(输出) 、false(不输出)
|
+
| bool
|38.76623,116.43213,39.54321,116.46773 lat,lng(左下角坐标),lat,lng(右上角坐标)
+
| style="width: 141px;" | true、false
|检索矩形区域
+
| style="width: 120px;" | 可选
 
|}
 
|}
'''矩形检索示例(返回json数据): '''
+
<div class="serve-explain-text"><div class="serveintoor-title service-page-anchor"><br/><span style="font-size: 13px;">返回参数(行政区划区域检索、圆形区域检索)</span><br/></div></div>
 
+
http://api.map.baidu.com/place/v2/search?&query=%E9%93%B6%E8%A1%8C&bounds=39.915,116.404,39.975,116.414&output=json&ak=E4805d16520de693a3fe707cdc962045
+
 
+
====圆形区域检索参数====
+
 
+
 
{|
 
{|
 
|-
 
|-
!width="96" |参数
+
! width="80" colspan="2" | 名称
!width="70" |是否必须
+
! width="80" | 类型
!width="60" |默认值
+
! 说明
!width="220" |格式举例
+
!width="255" |含义 
+
 
|-
 
|-
|location
+
| colspan="2" | status
|
+
| Int
|
+
| 本次API访问状态,如果成功返回0,如果失败返回其他数字。(见服务状态码)
|38.76623,116.43213
+
lat<纬度>,lng<经度>
+
|周边检索中心点,不支持多个点
+
 
|-
 
|-
|radius(r)
+
| colspan="2" | message
|
+
| string
|
+
| 对API访问状态值的英文说明,如果成功返回"ok",并返回结果字段,如果失败返回错误说明。
|2000
+
|-
|周边检索半径,单位为米
+
| colspan="2" | total
|}
+
| int
====圆形区域检索示例(返回xml数据):====
+
| POI检索总数,开发者请求中设置了page_num字段才会出现total字段。出于数据保护目的,单次请求total最多为150。
 +
|-
 +
| colspan="2" | name
 +
| string
 +
| poi名称
 +
|-
 +
| colspan="2" | result_type
 +
| string
 +
|
 +
当返回结果为城市列表时,result_type=city_type
  
http://api.map.baidu.com/place/v2/search?&query=%E9%93%B6%E8%A1%8C&location=39.915,116.404&radius=2000&output=xml&ak=E4805d16520de693a3fe707cdc962045
+
当返回结果为普通poi时,result_type=poi_type
  
====Place API检索返回结果字段====
+
当返回结果为行政区划数据时,result_type=region_type
  
'''状态字段'''
+
当返回结果为门址数据时,result_type=address_type
  
{|
 
 
|-
 
|-
!width="80"|名称
+
| colspan="2" | location
!width="80" |类型
+
| object
!说明
+
| poi经纬度坐标
 
|-
 
|-
|status
+
| rowspan="2" |
|Int
+
| lat
|本次API访问状态,如果成功返回0,如果失败返回其他数字。
+
| float
 +
| 纬度值
 
|-
 
|-
|message
+
| lng
|string
+
| float
|对API访问状态值的英文说明,如果成功返回"ok",并返回结果字段,如果失败返回错误说明。
+
| 经度值
 
|-
 
|-
|total
+
| colspan="2" | address
|int
+
| string
|检索总数,用户请求中设置了page_num字段才会出现total字段。
+
| poi地址信息
|}
+
'''结果字段(以结果集合里的一条数据为例,灰色表示扩展字段):'''
+
 
+
{|
+
 
|-
 
|-
!width="80" colspan="2"|名称
+
| colspan="2" | province<br/>
!width="80" |类型
+
| string<br/>
!说明
+
| 所属省份
 
|-
 
|-
|colspan="2" |name
+
| colspan="2" | city<br/>
|string
+
| string<br/>
|poi名称
+
| 所属城市
 
|-
 
|-
|colspan="2" |location
+
| colspan="2" | area<br/>
|object
+
| string<br/>
|poi经纬度坐标
+
| 所属区县
 
|-
 
|-
|rowspan="2" |
+
| colspan="2" | adcode
|lat
+
| int
|float
+
| [http://lbsyun.baidu.com/index.php?title=open/dev-res 行政区划代码]
|纬度值
+
 
|-
 
|-
|lng
+
| colspan="2" | telephone
|float
+
| string
|经度值
+
| poi电话信息
 
|-
 
|-
|colspan="2" |address
+
| colspan="2" | uid
|string
+
| string
|poi地址信息
+
| poi的唯一标示,可用于详情检索
 
|-
 
|-
|colspan="2" |telephone
+
| colspan="2" | street_id
|string
+
| string
|poi电话信息
+
| 街景图id
 
|-
 
|-
|colspan="2" |uid
+
| colspan="2" | detail
|string
+
| string
|poi的唯一标示
+
| 是否有详情页:1有,0没有
 
|-
 
|-
|colspan="2" |detail_info
+
| colspan="2" | detail_info
|object
+
| object
|poi的扩展信息,仅当scope=2时,显示该字段,不同的poi类型,显示的detail_info字段不同。
+
| poi的扩展信息,仅当scope=2时,显示该字段,不同的poi类型,显示的detail_info字段不同。
 
|-
 
|-
|rowspan="19" |
+
| rowspan="32" |  
|distance
+
| distance
|int32
+
| int32
|距离中心点的距离
+
| 距离中心点的距离,圆形区域检索时返回
 
|-
 
|-
|type
+
| type
|string
+
| string
|所属分类,如’hotel’、’cater’。
+
| 所属分类,如’hotel’、’cater’。
 
|-
 
|-
|tag
+
| tag
|string
+
| string
|标签
+
| 标签
 
|-
 
|-
|detail_url
+
| navi_location<br/>
|string
+
| <br/>
|poi的详情页
+
| POI对应的导航引导点坐标。大型面状POI的导航引导点,一般为各类出入口,方便结合导航、路线规划等服务使用
 
|-
 
|-
|price
+
| lng<br/>
|string
+
| float<br/>
|poi商户的价格
+
| 导航引导点经度<br/>
 
|-
 
|-
|shop_hours
+
| lat
|string
+
| float<br/>
|营业时间
+
| 导航引导点纬度
 
|-
 
|-
|overall_rating
+
| alias<br/>
|string
+
| string
|总体评分
+
| poi别名
 
|-
 
|-
|taste_rating
+
| detail_url
|string
+
| string
|口味评分
+
| poi的详情页
 
|-
 
|-
|service_rating
+
| children<br/>
|string
+
| <br/>
|服务评分
+
| poi子点数据,若某poi无子点,该字段为空
 
|-
 
|-
|environment_rating
+
| uid<br/>
|string
+
| string<br/>
|环境评分
+
| poi子点的唯一标示,可用于详情检索<br/>
 
|-
 
|-
|facility_rating
+
| name<br/>
|string
+
| string<br/>
|星级(设备)评分
+
| poi子点名称<br/>
 
|-
 
|-
|hygiene_rating
+
| show_name<br/>
|string
+
| string<br/>
|卫生评分
+
| poi子点简要名称<br/>
 
|-
 
|-
|technology_rating
+
| tag<br/>
|string
+
| string<br/>
|技术评分
+
| poi子点类别<br/>
 
|-
 
|-
|image_num
+
| location<br/>
|string
+
| <br/>
|图片数
+
| poi子点坐标
 
|-
 
|-
|groupon_num
+
| lat<br/>
|int
+
| float<br/>
|团购数
+
| poi子点纬度<br/>
 
|-
 
|-
|discount_num
+
| lng<br/>
|int
+
| float<br/>
|优惠数
+
| poi子点经度<br/>
 
|-
 
|-
|comment_num
+
| address<br/>
|string
+
| string<br/>
|评论数
+
| poi子点地址
 
|-
 
|-
|favorite_num
+
| price
|string
+
| string
|收藏数
+
| poi商户的价格
 
|-
 
|-
|checkin_num
+
| shop_hours
|string
+
| 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
 +
| 签到数
 +
|-
 +
| <br/>
 +
| brand
 +
| string
 +
| poi对应的品牌(如加油站中的『中石油』、『中石化』)
 +
|-
 +
| <br/>
 +
| content_tag
 +
| string
 +
| poi标签信息
 +
|-
 +
| <br/>
 +
| photos
 +
| array
 +
| poi图片的下载链接。<br/><span style="color:#FF0000;">注意:该功能为高级付费功能,您可提交[https://lbs.baidu.com/apiconsole/fankui#?typeOne=30046&typeTwo=53524&typeThree=95960 <span style="color:#FF0000;">工单</span>]咨询</span>。
 
|}
 
|}
 +
<div class="serve-explain-text"><div class="serveintoor-title service-page-anchor">地点详情检索服务</div><div class="code-template"><pre class="get-url-pre">https://api.map.baidu.com/place/v2/detail?uid=435d7aea036e54355abbbcc8&output=json&scope=2&ak=您的密钥 //GET请求
 +
</pre>
 +
</div></div><div class="separate-title">请求参数</div>
 +
{|
 +
|-
 +
! 参数
 +
! 是否必须
 +
! 默认值
 +
! 格式举例
 +
! 含义
 +
|-
 +
| uid
 +
| 是
 +
| 无
 +
| ‘8ee4560cf91d160e6cc02cd7’
 +
| poi的uid
 +
|-
 +
| uids
 +
| 否
 +
| 无
 +
| ‘8ee4560cf91d160e6cc02cd7’,‘5ffb1816cf771a226f476058’
 +
| uid的集合,最多可以传入10个uid,多个uid之间用英文逗号分隔。
 +
|-
 +
|
 +
extensions_adcode
  
==Place详情检索服务==
+
| 否
 +
| false
 +
|
 +
true、false
  
'''服务地址:'''
+
|
+
是否召回国标行政区划编码,
http://api.map.baidu.com/place/v2/detail
+
  
提供查询某个POI点的详情信息,如好评,评价等。
+
true(召回)、false(不召回)
  
'''请求参数说明:'''
 
 
{|
 
 
|-
 
|-
!参数
+
| output
!是否必须
+
| 否
!默认值
+
| xml
!格式举例
+
| json或xml
!含义
+
| 请求返回格式
 
|-
 
|-
|uid
+
| ret_coordtype<br/>
|
+
|
|
+
| bd09ll
|‘8ee4560cf91d160e6cc02cd7’
+
| gcj02ll<br/>
|poi的uid
+
| 可选参数,添加后POI返回国测局经纬度坐标<br/>[http://lbsyun.baidu.com/index.php?title=coordinate 坐标详细说明]<br/>
 
|-
 
|-
|output
+
| scope
|
+
|
|xml
+
| 1
|json或xml
+
| 1、2
|请求返回格式
+
| 检索结果详细程度。取值为1 或空,则返回基本信息;取值为2,返回检索POI详细信息
 
|-
 
|-
|scope
+
| ak
|是  
+
| 是
|1
+
|
|1、2
+
| 您的ak
|检索结果详细程度。取值为1 或空,则返回基本信息;取值为2,返回检索POI详细信息
+
| 开发者的访问密钥,必填项。v2之前该属性为key。
 
|-
 
|-
|ak
+
| sn
|
+
|
|无  
+
| 无
|E4805d16520de693a3fe707cdc962045
+
| [http://lbsyun.baidu.com/index.php?title=webapi/appendix Sn生成方法]
|用户的访问密钥,必填项。v2之前该属性为key。
+
| 开发者的权限签名。
 
|-
 
|-
|sn
+
| timestamp
|否  
+
| 否
|无  
+
| 无
 
|  
 
|  
|用户的权限签名。
+
| 设置sn后该值必填。
 
|-
 
|-
|timestamp
+
| photo_show
|否  
+
| 否
|无  
+
| 无
|  
+
| true、false
|设置sn后该值必填。
+
| 是否输出图片信息:true(输出) 、false(不输出)
 
|}
 
|}
 
+
<div class="separate-title">返回参数(行政区划区域检索、圆形区域检索、多边形区域检索、地点详情检索)</div>
'''返回值与Place API检索返回结果字段相同。'''
+
 
+
'''示例:'''
+
 
+
http://api.map.baidu.com/place/v2/detail?uid=8ee4560cf91d160e6cc02cd7&ak=E4805d16520de693a3fe707cdc962045&output=json&scope=2
+
 
+
'''返回值:'''
+
 
+
<source>
+
    {
+
        status: 0,
+
        message: "ok",
+
        result:
+
            {
+
                  name: "江边城外•巫山烤全鱼亚运村店",
+
                  location:
+
                      {
+
                          lng: 116.412347,
+
                          lat: 40.005328
+
                      },
+
                  address: "朝阳区慧忠北路慧忠里123号楼(近北辰东路)",
+
                  telephone: "(010)64924119",
+
                  uid: "8ee4560cf91d160e6cc02cd7",
+
                  detail_info:
+
                      {
+
                          tag: "美食 中餐馆 烤鱼 饭统北京 家人团聚 朋友聚会 烧烤 学生聚餐 二三人小聚 家庭团聚 生日PARTY 同事朋友聚会 亚运村店 川菜 适合大伙人 餐馆 川北凉粉 大拌菜 豆豉烤鱼 豆豉清江鱼 怪味清江鱼 会员卡商户 家常泡饼 家庭聚会 可以刷卡 麻辣烤鱼 免费停车 朋友聚餐 皮蛋豆腐 青椒皮蛋 情侣约会 商务宴请 跳水木耳 无线上网 香辣烤鱼 香辣清江鱼 休闲小憩 有无烟区",
+
                          detail_url: "http://api.map.baidu.com/place/detail?uid=8ee4560cf91d160e6cc02cd7&output=html&source=placeapi_v2",
+
                          type: "cater",
+
                          price: "63",
+
                          overall_rating: "5.0",
+
                          taste_rating: "5.0",
+
                          service_rating: "5.0",
+
                          environment_rating: "5.0",
+
                          image_num: "671",
+
                          comment_num: "1191",
+
                          favorite_num: "1851",
+
                          checkin_num: "45060",
+
                          shop_hours: "11:00-23:00"  
+
                      }
+
            }
+
    }
+
</source>
+
 
+
==Place团购检索服务==
+
===团购信息检索服务===
+
'''服务地址: '''
+
 
+
http://api.map.baidu.com/place/v2/eventsearch?
+
 
+
根据团购关键字、团购分类、区域范围等条件组合检索,支持按团购价格、距离等条件排序。
+
 
+
'''请求参数说明:'''
+
 
+
 
{|
 
{|
 
|-
 
|-
!width="96" |参数
+
! width="80" colspan="2" | 名称
!width="70" |是否必须
+
! width="80" style="width: 79px;" | 类型
!width="60" |默认值
+
! style="width: 741px;" | 说明
!width="220" |格式
+
!width="255" |含义
+
 
|-
 
|-
|q(query)
+
| colspan="2" | status
|
+
| style="width: 79px;" | Int
|
+
| style="width: 741px;" | 本次API访问状态,如果成功返回0,如果失败返回其他数字。(见服务状态码)
|小吃、宾馆、娱乐
+
|关键字检索
+
 
|-
 
|-
|event
+
| colspan="2" | message
|
+
| style="width: 79px;" | string
|
+
| style="width: 741px;" | 对API访问状态值的英文说明,如果成功返回"ok",并返回结果字段,如果失败返回错误说明。
|groupon、discount、all
+
|事件名称,可以是团购、打折或全部,目前只支持团购。
+
 
|-
 
|-
|region
+
| colspan="2" | total
|
+
| style="width: 79px;" | int
|131
+
| style="width: 741px;" | POI检索总数,开发者请求中设置了page_num字段才会出现total字段。出于数据保护目的,单次请求total最多为400。
|北京、131,注意:和search功能不同,此字段必须填写城市名称或城市代码,不能为全国或1。
+
|检索区域
+
 
|-
 
|-
|location
+
| colspan="2" | name
|是,二选一 1)location
+
| style="width: 79px;" | string
2)bounds 若都出现时,bounds优先级最大,location优先级小。
+
| style="width: 741px;" | poi名称
|
+
|38.76623,116.43213
+
|检索中心点,注意顺序:纬度,经度
+
 
|-
 
|-
|radius(r)
+
| colspan="2" | location
|
+
| style="width: 79px;" | object
|1000
+
| style="width: 741px;" | poi经纬度坐标
|2000
+
|检索半径。默认1000米,最大可设置2000米。
+
 
|-
 
|-
|bounds(bds)
+
| rowspan="2" |  
|是,二选一 1) location
+
| lat
2) bounds 若都出现时,bounds优先级最大,location优先级小。
+
| style="width: 79px;" | float
|
+
| style="width: 741px;" | 纬度值
|38.76623,116.43213,39.54321,116.46773
+
|检索矩形Bound,注意顺序:左下角纬度,左下角经度,右上角纬度,右上角经度。
+
 
|-
 
|-
|output
+
| lng
|
+
| style="width: 79px;" | float
|xml
+
| style="width: 741px;" | 经度值
|json或xml,默认xml
+
|输出格式
+
 
|-
 
|-
|filter
+
| colspan="2" | address
|否
+
| style="width: 79px;" | string
|无
+
| style="width: 741px;" | poi地址信息
|colspan="2" |检索过滤条件。
+
groupon_type为团购类型,取值如下:
+
1: 餐饮
+
2:生活
+
3:娱乐
+
4:旅游住宿
+
 
+
sort_name为排序字段,取值如下:
+
 
+
data_type:数据类型,默认排序
+
 
+
groupon_num:团购销量
+
 
+
groupon_price:团购价格
+
 
+
groupon_start:团购开始时间
+
 
+
distance:按距离排序,只对中心点检索有效
+
 
+
 
+
sort_rule为排序规则,取值如下:
+
 
+
0: 从高到低
+
 
+
1:从低到高
+
+
该规则对data_type和groupon_num字段无效。
+
 
+
示例:
+
 
+
groupon_type:1|sort_name:group_price|sort_rule:1
+
 
+
 
+
 
|-
 
|-
|page_size
+
| colspan="2" | province<br/>
|
+
| style="width: 79px;" | string<br/>
|10
+
| style="width: 741px;" | 所属省份
|10
+
|返回记录数量,默认为10条记录,最大可设置为20条。
+
 
|-
 
|-
|page_num
+
| colspan="2" | city<br/>
|
+
| style="width: 79px;" | string<br/>
|0
+
| style="width: 741px;" | 所属城市<br/>
|0、1、2
+
|分页页码,默认为0。 0代表第一页,1代表第二页,以此类推。 如果设置了此字段,则输出结果中含有total字段。
+
 
|-
 
|-
|ak
+
| colspan="2" | area<br/>
|
+
| style="width: 79px;" | string<br/>
|
+
| style="width: 741px;" | 所属区县<br/>
|vDh8mxgqaG4clKP7u
+
|用户的访问密钥
+
 
|-
 
|-
|sn
+
| colspan="2" | adcode
|
+
| style="width: 79px;" | int
|
+
| style="width: 741px;" | [http://lbsyun.baidu.com/index.php?title=open/dev-res 行政区划代码]
|LiD0WoSTit8b8teqHSNysUrK63a3m
+
|用户的权限签名
+
 
|-
 
|-
|timestamp
+
| colspan="2" | telephone
|sn存在时必选。
+
| style="width: 79px;" | string
|
+
| style="width: 741px;" | poi电话信息
|1352887837758
+
|时间戳
+
|}
+
备注:query和region取值说明详见编码说明。
+
 
+
''' 服务示例:'''
+
 
+
http://api.map.baidu.com/place/v2/eventsearch?query=%E7%BE%8E%E9%A3%9F&event=groupon&region=131&bounds=39.915,116.404,39.935,116.435&output=json&page_size=1&ak=E4805d16520de693a3fe707cdc962045
+
<span style="color:green;">//北京市的“美食”团购信息</span>
+
 
+
'''返回结果:'''
+
返回结果有两种形式,一种是json,另一种为xml,默认为xml格式,下面示例为json格式。
+
<source>
+
{
+
    status: 0,
+
    message: "ok",
+
    results: [
+
                {
+
                    uid: "9d18c725de1b540efb2d6192",
+
                    name: "DQ冰淇淋(王府井店)",
+
                    lcatin:
+
                        {
+
                            lat: "39.920411",
+
                            lng: "116.418224"
+
                        }
+
                    address: "东城区王府井大街138号新东安商场",
+
                    telephne: "(010)65283613",
+
                    event: [
+
                      {
+
                            cn_name: "大众点评",
+
                            grupn_end: "2013-05-05",
+
                            grupn_id: "4310671635",
+
                            grupn_image: "http%3A%2F%2Ftuanimg.baidu.cm%2Fdata%2F2_3b10ad0339b39176869831e787b1a9ea",
+
                            grupn_num: "38178",
+
                            grupn_price: "16.6",
+
                            grupn_rebate: "7.9",
+
                            grupn_site: :"http%3A%2F%2Ft.dianping.cm%2Fredirect%3Futm_surce%3Dtuan_baidu%26amp%3Bcityname%3Dbeijing",
+
                            grupn_start: "2013-04-12", grupn_tips: "< div class="detail-bx"> <h3 class="tit tit-c">特别提示</h3> </br> </br></p class="listitem">有效期:</br>北京地区套餐中杯暴风雪1杯 2013-04-12 至 2013-05-30<br/>天津地区套餐 2013-04-12 至 2013-05-30<《》br/>天津提拉米苏布朗尼套餐 2013-04-14 至 2013-05-30</br/>石家庄地区套餐 2013-04-12 至 2013-05-30</p><p class="listitem">仅限DQ(北京,天津,石家庄)使用,详情见页面附表使用</p><p class="listitem">无需预约</p><p class="listitem">团购券请于到店时出示</p><p class="listitem">不可与其他优惠同享</p><p class="listitem">本单团购不支持退款</p><p class="listitem">本单团购不能使用点评团抵用券/优惠代码</p></br> </br> </div>",
+
                            grupn_title: "DQ冰淇淋!仅售16.6元,最高价值21元中杯暴风雪1杯!3城97家店可选!缤纷滋味由你决定,倒杯不洒的诱惑,开启甜蜜瞬间!",
+
                          grupn_type: "1",
+
                            grupn_url_mbile: "http://tuan.baidu.cm/redirect?frm=bdmapwise&url=http%3A%2F%2Fwap.dianping.cm%2Ftuan%2Fredirect%3Fdid%3D152496",
+
                            grupn_url_pc:"http://tuan.baidu.cm/redirect?frm=bdmappc&url=http%3A%2F%2Ft.dianping.cm%2Fredirect%3Fdid%3D152496",
+
                            regular_price: "21",
+
                            reservatin: "1",
+
                            shrt_title: "DQ冰淇淋中杯暴风雪冰激凌",
+
                            spend_end_time: "1369929599"
+
                        }
+
                    ]
+
                }
+
            ]
+
}
+
</source>
+
 
+
===商家团购详情查询===
+
'''服务地址:'''
+
 
+
http://api.map.baidu.com/place/v2/eventdetail?
+
 
+
根据POI UID查询当前POI所有的团购详细信息。
+
 
+
'''请求参数说明:'''
+
 
+
{|
+
 
|-
 
|-
!width="96" |参数
+
| colspan="2" | uid
!width="70" |是否必须
+
| style="width: 79px;" | string
!width="60" |默认值
+
| style="width: 741px;" | poi的唯一标示
!width="220" |格式
+
!width="255" |含义
+
 
|-
 
|-
|uid
+
| colspan="2" | street_id
|
+
| style="width: 79px;" | string
|  
+
| style="width: 741px;" | 街景图id
|8ee4560cf91d160e6cc02cd7
+
|POI uid
+
 
|-
 
|-
|output
+
| colspan="2" | detail
|
+
| style="width: 79px;" | string
|  
+
| style="width: 741px;" | 是否有详情页:1有,0没有
|json或xml
+
|输出格式
+
 
|-
 
|-
|ak
+
| colspan="2" | detail_info
|必选
+
| style="width: 79px;" | object
|  
+
| style="width: 741px;" | poi的扩展信息,仅当scope=2时,显示该字段,不同的poi类型,显示的detail_info字段不同。
|vDh8mxgqaG4clKP7u
+
|用户的访问密钥
+
 
|-
 
|-
|sn
+
| rowspan="23" |  
|可选。
+
| distance
|  
+
| style="width: 79px;" | int32
|LiD0WoSTit8b8teqHSNysUrK63a3m
+
| style="width: 741px;" | 距离中心点的距离,圆形区域检索时返回
|用户的权限签名
+
 
|-
 
|-
|timestamp
+
| type
|sn存在时必选。
+
| style="width: 79px;" | string
|  
+
| style="width: 741px;" | 所属分类,如’hotel’、’cater’。
|1352887837758
+
|-
|时间戳
+
| tag
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | 标签
 +
|-
 +
| navi_location<br/>
 +
| style="width: 79px;" | <br/>
 +
| style="width: 741px;" | POI对应的导航引导点坐标。大型面状POI的导航引导点,一般为各类出入口,方便结合导航、路线规划等服务使用<br/>
 +
|-
 +
| lng<br/>
 +
| style="width: 79px;" | float
 +
| style="width: 741px;" | 导航引导点经度<br/>
 +
|-
 +
| lat
 +
| style="width: 79px;" | float<br/>
 +
| style="width: 741px;" | 导航引导点纬度<br/>
 +
|-
 +
| alias<br/>
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | poi别名<br/>
 +
|-
 +
| detail_url
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | poi的详情页
 +
|-
 +
| price
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | poi商户的价格
 +
|-
 +
| shop_hours
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | 营业时间
 +
|-
 +
| overall_rating
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | 总体评分
 +
|-
 +
| taste_rating
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | 口味评分
 +
|-
 +
| service_rating
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | 服务评分
 +
|-
 +
| environment_rating
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | 环境评分
 +
|-
 +
| facility_rating
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | 星级(设备)评分
 +
|-
 +
| hygiene_rating
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | 卫生评分
 +
|-
 +
| technology_rating
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | 技术评分
 +
|-
 +
| image_num
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | 图片数
 +
|-
 +
| groupon_num
 +
| style="width: 79px;" | int
 +
| style="width: 741px;" | 团购数
 +
|-
 +
| discount_num
 +
| style="width: 79px;" | int
 +
| style="width: 741px;" | 优惠数
 +
|-
 +
| comment_num
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | 评论数
 +
|-
 +
| favorite_num
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | 收藏数
 +
|-
 +
| checkin_num
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | 签到数
 +
|-
 +
| <br/>
 +
| brand<br/>
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | poi对应的品牌(如加油站中的『中石油』、『中石化』)<br/>
 +
|-
 +
| <br/>
 +
| content_tag
 +
| style="width: 79px;" | string
 +
| style="width: 741px;" | poi标签信息
 +
|-
 +
| <br/>
 +
| photos
 +
| array
 +
| poi图片的下载链接。<br/><span style="color:#FF0000;">注意:该功能为高级付费功能,您可提交[https://lbs.baidu.com/apiconsole/fankui#?typeOne=30046&typeTwo=53524&typeThree=95960 <span style="color:#FF0000;">工单</span>]咨询</span>。
 
|}
 
|}
'''服务示例:'''
+
<br/><div class="bluetitle"><div class="services-title-text">服务状态码</div></div>
 
+
http://api.map.baidu.com/place/v2/eventdetail?uid=c14fc238f7fadd4ea5da390f&output=json&ak=6cb3f458a482fcd009414370808ea219 <span style="color:green;">//根据uid: "c14fc238f7fadd4ea5da390f查询该POI对应的所有团购信息。</span>
+
 
+
'''返回结果:'''
+
返回结果有两种形式,一种是json,另一种为xml,默认为xml格式,下面示例为json格式。
+
<source>
+
{
+
    status: 0,
+
    message: "ok",
+
    result:
+
        {
+
            uid: "c14fc238f7fadd4ea5da390f",
+
            name: "觉品壹号",
+
            lcatin:
+
                {
+
                    lat: "39.905745",
+
                    lng: "116.390223"
+
                },
+
            address: "西城区南新华街1号瑞驰大酒店1楼(近地铁和平门站)",
+
            telephne: "(010)63022277,(010)63188187",
+
            events:
+
                [
+
                    {
+
                        cn_name: "糯米网",
+
                        grupn_end: "2013-08-01",
+
                        grupn_id: "4309423174",
+
                        grupn_image: "http%3A%2F%2Ftuanimg.baidu.cm%2Fdata%2F2_618fcdeff527f6c3e4af41be48693f4f",
+
                        grupn_num: "55",
+
                        grupn_price: "368",
+
                        grupn_rebate: "2.4",
+
                        grupn_price: "368",
+
                        grupn_site: "http%3A%2F%2Fbj.numi.cm",
+
                        grupn_start: "2013-02-05",
+
                        grupn_tips: "1、糯米券有效期为2013年02月05日至2013年08月04日</br>2、营业时间:11:00-14:00;17:00-21:00</br>3、请提前24小时预约,预约电话:010-63188187/13552470897</br>4、糯米券不限购买数量,每张糯米券建议6人使用</br>5、节假日通用(春节、情人节均可以使用)</br>6、糯米券不兑现、不找零,不与店内其他优惠同享",
+
                        grupn_title: "[觉品壹号会所]6人套餐!创意惊艳岁末宴,春节、假日通用!",
+
                        grupn_type: "1",
+
                        grupn_url_mbile: "http://tuan.baidu.cm/redirect?frm=bdmapwise&url=http%3A%2F%2Fm.numi.cm%2Fdeal%2Fview%3Ftinyurl%3D0wua4ryz",   
+
                        grupn_url_pc: "http://tuan.baidu.cm/redirect?frm=bdmappc&url=http%3A%2F%2Fbj.numi.cm%2Fdeal%2F0wua4ryz.html%3Futm_surce%3Dbaidu-cps%26amp%3Butm_medium%3Dny-pic%26amp%3Butm_campaign%3Dny-pic%26amp%3Bcid%3D006001",
+
                        regular_price: "1558",
+
                        reservatin: "1",
+
                        shrt_title: "觉品壹号368",
+
                        spend_end_time: "1375631999"
+
                    }
+
                ]
+
          }
+
}
+
</source>
+
 
+
==状态码附录==
+
 
{|
 
{|
 
|-
 
|-
!width="80" |返回码
+
! width="100" | 返回码
!width="180" |定义
+
! width="200" | 英文描述
!width="448" |英文返回描述
+
! width="200" | 定义
 +
! width="480" | 常见原因
 
|-
 
|-
|0
+
| 0
|正常
+
| ok
|ok
+
| 正常
 +
| 服务请求正常召回
 
|-
 
|-
|2
+
| 2
|请求参数非法
+
| Parameter Invalid
|Parameter Invalid
+
| 请求参数非法
 +
| 必要参数拼写错误或漏传(如query和tag请求中均未传入)
 
|-
 
|-
|3
+
| 3
|权限校验失败
+
| Verify Failure
|Verify Failure
+
| 权限校验失败
 +
|  
 
|-
 
|-
|4
+
| 4
|配额校验失败
+
| Quota Failure
|Quota Failure
+
| 配额校验失败
 +
| 服务当日调用次数已超限,请前往[http://lbsyun.baidu.com/apiconsole/quota API控制台]提升(请优先进行[http://lbsyun.baidu.com/apiconsole/auth 开发者认证])
 
|-
 
|-
|5
+
| 5
|ak不存在或者非法
+
| AK Failure
|AK Failure
+
| ak不存在或者非法
 +
| 未传入ak参数;ak已被删除(可前往[http://lbsyun.baidu.com/apiconsole/key/recycle 回收站]恢复);
 
|-
 
|-
|2xx
+
| 8
|无权限
+
| Parse Proto Failure
|
+
| 数据解析失败
 +
| 一般是query输入有误导致,如query输入特殊字符,全角符号。<br/>
 
|-
 
|-
|3xx
+
| 9
|配额错误
+
| Permission Denied
|
+
| 高级权限校验失败
 +
| <br/>
 
|}
 
|}
 +
</div><div class="navRemark"><div class="handpointto">内容(使用指南)</div></div><div class="txtstyle2"><div class="bluetitle"><div class="services-title-text">使用方法</div></div><div class="useguide"><div class="useguide_bg"></div><div class="useguide_li">
 +
<span>1</span> [https://passport.baidu.com/v2/?reg&tt=1494238640555&gid=E85D052-3B8B-45D0-9412-D0B861D79A5D&tpl=pp&u=https://passport.baidu.com/ 申请百度账号]
 +
</div><div class="useguide_li">
 +
<span>2</span> [http://lbsyun.baidu.com/apiconsole/key 申请成为百度开发者]
 +
</div><div class="useguide_li">
 +
<span>3</span> [http://lbsyun.baidu.com/apiconsole/key/create 获取服务密钥(ak)]
 +
</div><div class="useguide_li" style="margin-right:0;">
 +
<span>4</span> [http://passport.baidu.com 发送请求,使用服务]
  
==升级说明==
 
{{bluepoint}}v2版本较之v1版本,功能更新详见[[:webapi/theupdatelog |更新日志]],且请求url参数:新增版本号“v2”,修改“key”为“ak”。V2不兼容v1版本的key,若需升级,请重新[http://lbsyun.baidu.com/apiconsole/key?application=key 获取密钥]。
 
  
{{bluepoint}}若需查看v1文档,请访问“Place APIv1.0”。
+
</div></div><div class="bluetitle"><div class="services-title-text">编码说明</div></div>
 +
API请求中需要用到中文或一些特殊字符的参数,如query、region等,为了避免提交到后台乱码,需要对这几个参数值进行编码处理,转换成UTF-8字符的二字符十六进制值,凡是不在下表中的字符都需要进行编码。
 +
 
 +
{| border="1" cellspacing="1" cellpadding="1" style="width: 957px;"
 +
|-
 +
| style="text-align: center; width: 91px;" | '''字符集合'''
 +
| style="width: 823px; text-align: center;" | '''字符'''
 +
|-
 +
| style="text-align: center; width: 91px;" | URL非保留字<br/>
 +
| style="width: 823px;" | a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 - _ . ~<br/>
 +
|-
 +
| style="text-align: center; width: 91px;" | URL保留字<br/>
 +
| style="width: 823px;" | &nbsp;! * ' ( )&nbsp;;&nbsp;: @ & = + $ , /&nbsp;?&nbsp;% # [ ]<br/>
 +
|}
 +
 
 +
如果中文参数中使用URL保留字字符的字面意思,例如:region关键字取值为"?北京",检索关键字包含一个问号,此问号也必须进行编码。<br/><br/>附注:
 +
 
 +
{{bluepoint}}javascript中一般采用encodeURIComponent函数对特殊字符进行编码。
 +
 
 +
{{bluepoint}}Java中可以使用函数URLEncoder.encode对特殊字符进行编码。
 +
 
 +
{{bluepoint}}C#中可以使用函数HttpUtility.UrlEncode对特殊字符进行编码。
 +
 
 +
{{bluepoint}}php中可以使用函数urlencode对特殊字符进行编码。
 +
<div class="bluetitle"><div class="services-title-text">坐标系说明</div></div>
 +
{{bluepoint}}WGS84:为一种大地坐标系,也是目前广泛使用的GPS全球卫星定位系统使用的坐标系。<br/><br/>{{bluepoint}}GCJ02:是由中国国家测绘局制订的地理信息系统的坐标系统。由WGS84坐标系经加密后的坐标系。<br/><br/>{{bluepoint}}BD09:为百度坐标系,在GCJ02坐标系基础上再次加密。其中bd09ll表示百度经纬度坐标,bd09mc表示百度墨卡托米制坐标<br/><br/>{{bluepoint}}Place Suggestion API默认输入输出坐标类型为百度坐标(BD09),同时可通过参数("coord_type","ret_coordtype")控制输入输出坐标类型。输入坐标支持以上三种坐标系,输出坐标支持-国测局坐标(GCJ02)和百度坐标(BD09)<br/><br/><span style="color:#FF0000;">注意:不同类型坐标如需转换,请使用百度地图开放平台提供的</span>[http://lbsyun.baidu.com/index.php?title=webapi/guide/changeposition 标准坐标转换接口]<span style="color:#FF0000;">。请勿使用其他渠道提供的坐标转换方法,以免影响坐标转换精度。</span>
 +
<div class="bluetitle"><div class="services-title-text">服务使用限制</div></div>
 +
{{bluepoint}}服务相关配额及并发请求限制请访问[http://lbsyun.baidu.com/apiconsole/auth/privilege 开发者权益]页面查看。
 +
</div><div class="navRemark"><div class="handpointto">内容(常见问题)</div></div><div class="txtstyle2"><div class="bluetitle"><div class="services-title-text">服务常见问题</div></div><div class="serve-explain-text"><div class="serveintoor-title">1、为什么有些POI在接口服务中检索不到?</div>
 +
出于数据保护目的,地点检索服务使用的数据非最新版。若有需求,请[http://lbsyun.baidu.com/apiconsole/fankui#?typeOne=产品需求&typeTwo=新服务/功能需求 联系我们]。<br/>【排查方法】同一地点,使用百度地图PC端或手机客户端能检索到,使用API接口无数据。<br/><br/>百度地图数据库中无该地点数据。请通过[http://i.map.baidu.com/api/page/poicorrect/addpoipc?city_id=131&business_trigger=7&poi_name=123452 POI纠错平台]上报,我们会尽快核实数据并添加上线。<br/>【排查方法】同一地点,使用百度地图PC端或手机客户端和API接口均无返回数据。<br/><br/>检索结果中,相关数据过多,接口结果未展示完全。请通过"page_size","page_num"字段控制数据返回数量和翻页操作。<br/>【排查方法】返回结果中,"total"参数值大于返回POI数量。
 +
</div><div class="serve-explain-text"><div class="serveintoor-title">2、为什么每次访问服务,最多只返回150条数据?</div>
 +
出于数据保护目的,单次访问服务最多同时返回150条数据。此限制无法修改。请根据实际需求,通过添加分类、设置范围等方式,缩小检索范围。
 +
</div><div class="serve-explain-text"><div class="serveintoor-title">3、为什么我设置了"region=北京",结果返回了其他城市的数据?</div>
 +
"region"参数表示检索城市偏重,会增加对应城市返回结果的权重,从而影响返回数据排序。但部分权重较高的其他城市地点,仍有可能召回(如:在北京检索"迪士尼",会返回上海数据)。<br/>若需要限制返回结果仅为"region"参数对应的城市数据,请在使用"region"参数时,同时加上"city_limit=true"参数。
 +
</div></div><div class="navRemark"><div class="handpointto">内容(更新日志)</div></div><div class="txtstyle2"><div class="updatedemo"><div class="uptitle"><div class="next timecut"></div><div class="prve timecut"></div><div class="updatetime"><div class="controlshow"><div class="timeversions">
 +
2012年3月8日
 +
 
 +
V1.0
 +
</div><div class="timeversions">
 +
2013年4月7日
 +
 
 +
V2.0
 +
</div><div class="timeversions">
 +
2013年5月9日
 +
 
 +
V2.1
 +
</div><div class="timeversions">
 +
2016年10月28日
 +
 
 +
V2.2
 +
</div><div class="timeversions">
 +
2017年1月10日
 +
 
 +
V2.3
 +
</div><div class="timeversions intro">
 +
2022年9月05日
 +
 
 +
V2.4
 +
</div>
 +
<br/></div></div><div class="linellae"></div></div><div class="updatecenter"><div class="updatebox"><div class="bluetitle"><div class="services-title-text">产品发布</div></div><div class="serve-explain-text">地点检索服务V1.0正式上线</div></div><div class="updatebox"><div class="bluetitle"><div class="services-title-text">产品发布</div></div><div class="serve-explain-text">地点检索服务V2.0正式上线<br/><br/>1. 新增查询单个POI详情服务<br/><br/>2. 地点检索服务区域查询支持设置返回分页数及每页显示的POI数,较之v1版本,增加可返回的数据条目<br/><br/>3. 支持返回POI的扩展字段(如评分、价格、评论数等)。</div></div><div class="updatebox"><div class="bluetitle"><div class="services-title-text">新增功能</div></div><div class="serve-explain-text">开放团购API,支持城市内、多边形、圆形区域检索团购信息,且提供商家团购详情查询功能。</div></div><div class="updatebox"><div class="bluetitle"><div class="services-title-text">新增功能</div></div><div class="serve-explain-text">新增city_limit参数(行政区划检索范围限定功能)</div></div><div class="updatebox"><div class="bluetitle"><div class="services-title-text">新增功能</div></div><div class="serve-explain-text">新增"ret_coordtype=gcj02ll"参数,地点检索API服务全面支持国测局坐标</div></div><div class="updatebox"><div class="bluetitle"><div class="services-title-text">新增功能</div></div><div class="serve-explain-text">行政区划检索新增"center"请求参数,支持传入poi坐标,辅助检索结果按照距离排序返回。</div></div><br/></div></div></div><div class="navRemark"><div class="handpointto">内容(资源下载)</div></div><div class="txtstyle2"><div class="bluetitle"><div class="services-title-text">服务资源下载</div></div><div class="serve-explain-text"><div class="serveintoor-title">百度地图城市名称-中心点经纬度(cityCenter)关系对照</div>
 +
您可以通过此文件获知百度地图的全国各城市中心点(cityCenter)经纬度
 +
<div class="download-btn">[https://mapopen-website-wiki.bj.bcebos.com/static_zip/BaiduMap_cityCode_1102.zip 下载]</div><br/></div><div class="serve-explain-text"><div class="serveintoor-title">百度地图城市名称-城市代码(cityCode)关系对照</div>
 +
您可以通过此文件获知百度地图的全国各城市代码(cityCode)。 在使用百度地图API或SDK各种涉及citycode参数的服务时,您可参看此文件传入准确值,如JavaScript API的本地检索服务(根据cityCode获取本地检索结果)、Android SDK离线地图服务(根据cityCode,获取对应城市离线地图)等。<br/><font color="red">注意:cityCode为百度内部定义,已不再维护,请谨慎使用。</font>
 +
<div class="download-btn">[https://mapopen-website-wiki.bj.bcebos.com/static_zip/BaiduMap_cityCode_1102.zip 下载]</div><br/></div><div class="serve-explain-text"><div class="serveintoor-title">百度地图POI行业分类(tag)</div>
 +
您可以通过此链接获知百度地图POI(兴趣点)的tag引导体系,辅助您检索POI。 如检索query为百度地图的tag“生活服务”,返回的检索结果即包含关键字为“生活服务”的POI、也包含tag为“生活服务”的POI,从而聚焦检索结果。
 +
<div class="download-btn">[http://lbsyun.baidu.com/index.php?title=lbscloud/poitags 查看]</div><br/></div></div></div>

2022年9月5日 (一) 19:14的版本

服务介绍
服务文档
使用指南
常见问题
更新日志
资源下载
地点检索服务

地点检索服务(又名Place API)是一类Web API接口服务;
服务提供多种场景的地点(POI)检索功能,包括城市检索、圆形区域检索、多边形区域检索。开发者可通过接口获取地点(POI)基础或详细地理信息。
注意:地点检索服务适用于【XX大厦】、【XX小区】等POI地点名称的检索,若需要检索结构化地址,如【北京市海淀区上地十街十号】,则推荐使用地理编码服务。

功能介绍
行政区划区域检索

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

place1.png

圆形区域检索

开发者可设置圆心和半径,检索圆形区域内的地点信息(常用于周边检索场景)。

place2.png

地点详情检索

不同于其他三种检索功能。地点详情检索针对指定POI,检索其相关的详情信息。开发者可以通过三种区域检索(或其他服务)功能,获取POI id。使用“地点详情检索”功能,传入id,即可检索POI详情信息,如评分、营业时间等(不同类型POI对应不同类别详情数据)。

place4.png

多边形区域检索

多边形区域检索为高级权限,如有需求请提交【工单】咨询。

place3.png

接口功能介绍
行政区划区域检索
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 可选
center 传入poi坐标,辅助检索结果按照距离排序返回。
注意:需要结合filter字段一起使用并结合coord_type字段说明该字段的坐标类型
string(50) 38.76623,116.43213
lat<纬度>,lng<经度>
可选
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(无)

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.43213

lat<纬度>,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 高级权限校验失败
使用方法
编码说明

API请求中需要用到中文或一些特殊字符的参数,如query、region等,为了避免提交到后台乱码,需要对这几个参数值进行编码处理,转换成UTF-8字符的二字符十六进制值,凡是不在下表中的字符都需要进行编码。

字符集合 字符
URL非保留字
a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 - _ . ~
URL保留字
 ! * ' ( ) ; : @ & = + $ , / ? % # [ ]

如果中文参数中使用URL保留字字符的字面意思,例如:region关键字取值为"?北京",检索关键字包含一个问号,此问号也必须进行编码。

附注:

javascript中一般采用encodeURIComponent函数对特殊字符进行编码。

Java中可以使用函数URLEncoder.encode对特殊字符进行编码。

C#中可以使用函数HttpUtility.UrlEncode对特殊字符进行编码。

php中可以使用函数urlencode对特殊字符进行编码。

坐标系说明

WGS84:为一种大地坐标系,也是目前广泛使用的GPS全球卫星定位系统使用的坐标系。

GCJ02:是由中国国家测绘局制订的地理信息系统的坐标系统。由WGS84坐标系经加密后的坐标系。

BD09:为百度坐标系,在GCJ02坐标系基础上再次加密。其中bd09ll表示百度经纬度坐标,bd09mc表示百度墨卡托米制坐标

Place Suggestion API默认输入输出坐标类型为百度坐标(BD09),同时可通过参数("coord_type","ret_coordtype")控制输入输出坐标类型。输入坐标支持以上三种坐标系,输出坐标支持-国测局坐标(GCJ02)和百度坐标(BD09)

注意:不同类型坐标如需转换,请使用百度地图开放平台提供的标准坐标转换接口。请勿使用其他渠道提供的坐标转换方法,以免影响坐标转换精度。

服务使用限制

服务相关配额及并发请求限制请访问开发者权益页面查看。

服务常见问题
1、为什么有些POI在接口服务中检索不到?

出于数据保护目的,地点检索服务使用的数据非最新版。若有需求,请联系我们
【排查方法】同一地点,使用百度地图PC端或手机客户端能检索到,使用API接口无数据。

百度地图数据库中无该地点数据。请通过POI纠错平台上报,我们会尽快核实数据并添加上线。
【排查方法】同一地点,使用百度地图PC端或手机客户端和API接口均无返回数据。

检索结果中,相关数据过多,接口结果未展示完全。请通过"page_size","page_num"字段控制数据返回数量和翻页操作。
【排查方法】返回结果中,"total"参数值大于返回POI数量。

2、为什么每次访问服务,最多只返回150条数据?

出于数据保护目的,单次访问服务最多同时返回150条数据。此限制无法修改。请根据实际需求,通过添加分类、设置范围等方式,缩小检索范围。

3、为什么我设置了"region=北京",结果返回了其他城市的数据?

"region"参数表示检索城市偏重,会增加对应城市返回结果的权重,从而影响返回数据排序。但部分权重较高的其他城市地点,仍有可能召回(如:在北京检索"迪士尼",会返回上海数据)。
若需要限制返回结果仅为"region"参数对应的城市数据,请在使用"region"参数时,同时加上"city_limit=true"参数。

2012年3月8日

V1.0

2013年4月7日

V2.0

2013年5月9日

V2.1

2016年10月28日

V2.2

2017年1月10日

V2.3

2022年9月05日

V2.4


产品发布
地点检索服务V1.0正式上线
产品发布
地点检索服务V2.0正式上线

1. 新增查询单个POI详情服务

2. 地点检索服务区域查询支持设置返回分页数及每页显示的POI数,较之v1版本,增加可返回的数据条目

3. 支持返回POI的扩展字段(如评分、价格、评论数等)。
新增功能
开放团购API,支持城市内、多边形、圆形区域检索团购信息,且提供商家团购详情查询功能。
新增功能
新增city_limit参数(行政区划检索范围限定功能)
新增功能
新增"ret_coordtype=gcj02ll"参数,地点检索API服务全面支持国测局坐标
新增功能
行政区划检索新增"center"请求参数,支持传入poi坐标,辅助检索结果按照距离排序返回。

服务资源下载
百度地图城市名称-中心点经纬度(cityCenter)关系对照

您可以通过此文件获知百度地图的全国各城市中心点(cityCenter)经纬度


百度地图城市名称-城市代码(cityCode)关系对照

您可以通过此文件获知百度地图的全国各城市代码(cityCode)。 在使用百度地图API或SDK各种涉及citycode参数的服务时,您可参看此文件传入准确值,如JavaScript API的本地检索服务(根据cityCode获取本地检索结果)、Android SDK离线地图服务(根据cityCode,获取对应城市离线地图)等。
注意:cityCode为百度内部定义,已不再维护,请谨慎使用。


百度地图POI行业分类(tag)

您可以通过此链接获知百度地图POI(兴趣点)的tag引导体系,辅助您检索POI。 如检索query为百度地图的tag“生活服务”,返回的检索结果即包含关键字为“生活服务”的POI、也包含tag为“生活服务”的POI,从而聚焦检索结果。


  • 文档根本没法用

  • 文档水平很差

  • 文档水平一般

  • 文档不错

  • 文档写的很好

如发现文档错误,或对此文档有更好的建议,请在下方反馈。问题咨询请前往反馈平台提交工单咨询。

提交反馈

拖动标注工具

添加矩形标注

添加箭头标注

完成

取消