行政区划区域检索

GET

/place/v2/search

status服务状态码

返回码	英文描述	定义	常见原因
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	高级权限校验失败

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.map.baidu.com/place/v2/search?query=ATM机&region=北京&ak=&sn='

响应示例

{
  "status": 0,
  "message": "string",
  "total": 0,
  "name": "string",
  "result_type": "string",
  "location": {
    "lat": 0,
    "lng": 0
  },
  "address": "string",
  "province": "string",
  "city": "string",
  "area": "string",
  "adcode": 0,
  "telephone": "string",
  "uid": "string",
  "street_id": "string",
  "detail": "string",
  "detail_info": {
    "distance": 0,
    "type": "string",
    "tag": "string",
    "navi_location": {
      "lng": 0,
      "lat": 0,
      "alias": "string",
      "detail_url": "string"
    },
    "children": {
      "uid": "string",
      "name": "string",
      "show_name": "string",
      "tag": "string"
    },
    "location": {
      "lat": 0,
      "lng": 0,
      "address": "string",
      "price": "string"
    },
    "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": 0,
    "discount_num": 0,
    "comment_num": "string",
    "favorite_num": "string",
    "checkin_num": "string",
    "brand": "string",
    "content_tag": "string",
    "photos": [
      "string"
    ]
  }
}

请求参数

Query 参数

query

string

必需

检索关键字。行政区划区域检索不支持多关键字检索。如果需要按POI分类进行检索，请将分类通过query参数进行设置，如query=美食

示例值:

ATM机

tag

string

可选

检索分类偏好，与q组合进行检索，多个分类以","分隔（POI分类），如果需要严格按分类检索，请通过query参数设置

示例值:

银行

region

string

必需

检索行政区划区域（增加区域内数据召回权重，如需严格限制召回数据在区域内，请搭配使用city_limit参数），可输入行政区划名或对应cityCode

示例值:

北京

city_limit

string

可选

区域数据召回限制，为true时，仅召回region对应区域内数据。

示例值:

true

extensions_adcode

string

可选

是否召回国标行政区划编码， true（召回）、false（不召回）

示例值:

true

output

string

可选

输出格式为json或者xml

示例值:

json

scope

string

可选

检索结果详细程度。取值为1 或空，则返回基本信息；取值为2，返回检索POI详细信息

示例值:

filter

string

可选

检索过滤条件。当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（无）

示例值:

sort_name:distance|sort_rule:1

coord_type

integer

可选

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

示例值:

ret_coordtype

string

可选

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

示例值:

gcj02ll

page_size

integer

可选

单次召回POI数量，默认为10条记录，最大返回20条。多关键字检索时，返回的记录数为关键字个数*page_size。

示例值:

page_num

integer

可选

分页页码，默认为0,0代表第一页，1代表第二页，以此类推。常与page_size搭配使用，仅当返回结果为poi时可以翻页。

示例值:

timestamp

string

可选

设置sn后该值必填。

photo_show

string

可选

是否输出图片信息：true(输出) 、false(不输出)

示例值:

true

address_result

string

可选

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

示例值:

false

string

必需

开发者的访问密钥，必填项。v2之前该属性为key。申请秘钥

默认值:

string

可选

可选，若开发者所用AK的校验方式为SN校验时该参数必须。

默认值:

返回响应

🟢200成功

application/json

Body

status

integer

必需

本次API访问状态，如果成功返回0，如果失败返回其他数字。（见服务状态码）

message

string

必需

对API访问状态值的英文说明，如果成功返回"ok"，并返回结果字段，如果失败返回错误说明。

total

integer

必需

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

number

纬度值

必需

lng

number

经度值

必需

address

string

poi地址信息

必需

province

string

所属省份

必需

city

string

所属城市

必需

area

string

所属区县

必需

adcode

integer

行政区划代码

必需

telephone

string

poi电话信息

必需

uid

string

必需

poi的唯一标示，可用于详情检索

street_id

string

街景图id

必需

detail

string

必需

是否有详情页：1有，0没有

detail_info

object

必需

poi的扩展信息，仅当scope=2时，显示该字段，不同的poi类型，显示的detail_info字段不同。

distance

integer

必需

距离中心点的距离，圆形区域检索时返回

type

string

必需

所属分类，如’hotel’、’cater’。

tag

string

标签

必需

navi_location

object

必需

POI对应的导航引导点坐标。大型面状POI的导航引导点，一般为各类出入口，方便结合导航、路线规划等服务使用

children

object

必需

poi子点数据，若某poi无子点，该字段为空

location

object

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

integer

团购数

必需

discount_num

integer

优惠数

必需

comment_num

string

评论数

必需

favorite_num

string

收藏数

必需

checkin_num

string

签到数

必需

brand

string

必需

poi对应的品牌（如加油站中的『中石油』、『中石化』）

content_tag

string

poi标签信息

必需

photos

array[string]

必需

poi图片的下载链接。注意：该功能为高级付费功能，您可提交工单咨询。

资源下载

圆形区域检索