示例中心
功能在线体验
控制台
您现在的位置: 开发 > Web服务 API > 开发指南 > API文档 > 搜索POI >

高德 开发 Web服务 API 开发指南 API文档 搜索POI

更新时间:2018年12月10日

产品介绍

搜索服务API是一类简单的HTTP接口,提供多种查询POI信息的能力,其中包括关键字搜索、周边搜索、多边形搜索、ID查询四种筛选机制。

使用API前您需先申请Key,若无高德地图API账号需要先申请账号。

注意:在此接口之中,您可以通过city&citylimit参数指定希望搜索的城市或区县。而city参数能够接收citycode和adcode,citycode仅能精确到城市,而adcode却能够精确到区县。

例如:北京,citycode:010,adcode:110000

           北京-海淀区,citycode:010,adcode:110108

故使用citycode仅能在北京范围内搜索,而adcode能够指定在海淀区搜索。

综上所述,为了您查询的精确,我们强烈建议您使用adcode。

另外,无论您指定多少个type,每次请求最多返回1000个POI信息,若场景需要获取更可能多的POI;建议您不要在type之中指定过多的类别,而是分多次请求从而得到更加准确的结果。


适用场景

 

  • 关键字搜索:通过用POI的关键字进行条件搜索,例如:肯德基、朝阳公园等;同时支持设置POI类型搜索,例如:银行
  • 周边搜索:在用户传入经纬度坐标点附近,在设定的范围内,按照关键字或POI类型搜索;
  • 多边形搜索:在多边形区域内进行搜索
  • ID查询:通过POI ID,查询某个POI详情,建议可同输入提示API配合使用

使用限制

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

使用说明

第一步,申请”Web服务API”密钥(Key);

第二步,拼接HTTP请求URL,第一步申请的Key需作为必填参数一同发送;

第三步,接收HTTP请求返回的数据(JSON或XML格式),解析数据。

如无特殊声明,接口的输入参数和输出数据编码全部统一为UTF-8。

关键字搜索

关键字搜索API服务地址:

http://restapi.amap.com/v3/place/text?parameters 

parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。

 

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

用户在高德地图官网申请Web服务API类型KEY

必填

keywords

查询关键字

规则: 多个关键字用“|”分割

若不指定city,并且搜索的为泛词(例如“美食”)的情况下,返回的内容为城市列表以及此城市内有多少结果符合要求。

必填

(keywords和types两者至少必选其一)

types

查询POI类型

多个类型用“|”分割;

可选值:分类代码 或 汉字(若用汉字,请严格按照附件之中的汉字填写)

分类代码由六位数字组成,一共分为三个部分,前两个数字代表大类;中间两个数字代表中类;最后两个数字代表小类。

若指定了某个大类,则所属的中类、小类都会被显示。

例如:010000为汽车服务(大类)

             010100为加油站(中类)

                010101为中国石化(小类)

             010900为汽车租赁(中类)

                010901为汽车租赁还车(小类)

当指定010000,则010100等中类、010101等小类都会被包含。

当指定010900,则010901等小类都会被包含

下载POI分类编码和城市编码表         


若不指定city,返回的内容为城市列表以及此城市内有多少结果符合要求。 

当您的keywords和types都是空时,默认指定types为120000(商务住宅)&150000(交通设施服务)

必填

(keywords和types两者至少必选其一)

city

查询城市

可选值:城市中文、中文全拼、citycode、adcode

如:北京/beijing/010/110000

填入此参数后,会尽量优先返回此城市数据,但是不一定仅局限此城市结果,若仅需要某个城市数据请调用citylimit参数。

如:在深圳市搜天安门,返回北京天安门结果。

可选

无(全国范围内搜索)

citylimit

仅返回指定城市数据

可选值:true/false

可选

false

children

是否按照层级展示子POI数据

可选值:children=1

当为0的时候,子POI都会显示。

当为1的时候,子POI会归类到父POI之中。


仅在extensions=all的时候生效

可选

0

offset

每页记录数据

强烈建议不超过25,若超过25可能造成访问报错

可选

20

page

当前页数

最大翻页数100

可选

1

building

建筑物的POI编号

传入建筑物POI编号之后,则只在该建筑物之内进行搜索

可选

floor

搜索楼层

若传入 建筑物的POI编号 + 楼层 ,则返回该建筑物内当前楼层的关键字搜索结果

若只传入楼层,则返回参数不完全的提示

若传入建筑物的POI编号 + 楼层,该楼层没有对应的搜索结果,则会返回建筑物之内的内容。

可选

extensions

返回结果控制

此项默认返回基本地址信息;取值为all返回地址信息、附近POI、道路以及道路交叉口信息。

可选

base

sig

数字签名

数字签名获取和使用方法

可选

output

返回数据格式类型

可选值:JSON,XML

可选

JSON

callback

回调函数

callback值是用户定义的函数名称,此参数只在output=JSON时有效

可选

  • 返回结果参数说明

关键字搜索的响应结果的格式由请求参数output指定。

名称

含义

规则说明

status

结果状态值,值为0或1

0:请求失败;1:请求成功

info

返回状态说明

status为0时,info返回错误原因,否则返回“OK”。详情参阅info状态表

count

搜索方案数目(最大值为1000)


suggestion

城市建议列表

当用户输入的词语为泛搜索词的时候,将显示城市列表


keywords

唯一ID



cities

城市列表



name

名称


num

该城市包含此关键字的个数


citycode

该城市的citycode


adcode

该城市的adcode


pois

搜索POI信息列表



poi

POI信息



id

唯一ID


parent

父POI的ID

当前POI如果有父POI,则返回父POI的ID。可能为空

name

名称


type

兴趣点类型

顺序为大类、中类、小类

例如:餐饮服务;中餐厅;特色/地方风味餐厅

typecode

兴趣点类型编码

例如:050118

biz_type

行业类型


address

地址

东四环中路189号百盛北门

location

经纬度

格式:X,Y

distance

离中心点距离

单位:米

必须说明, 此结果仅在周边搜索的时候有值

tel

该POI的电话


postcode

邮编

 extensions=all的时候显示 

website

该POI的网址

 extensions=all的时候显示 

email

该POI的电子邮箱

 extensions=all的时候显示 

pcode

poi所在省份编码

 extensions=all的时候显示 

pname

poi所在省份名称

若是直辖市的时候,此处直接显示市名,例如北京市

citycode

城市编码

 extensions=all的时候显示 

cityname

城市名

 若是直辖市的时候,此处直接显示市名,例如北京市 

adcode

区域编码

 extensions=all的时候显示 

adname

区域名称

区县级别的返回,例如朝阳区

entr_location

入口经纬度

 extensions=all的时候显示 

exit_location

出口经纬度

 extensions=all的时候显示 

navi_poiid

地图编号

 extensions=all的时候显示 

gridcode

地理格ID

 extensions=all的时候显示 

alias

别名

 extensions=all的时候显示 

business_area

所在商圈

 extensions=all的时候显示 

parking_type

停车场类型

仅在停车场类型POI的时候显示该字段

展示停车场类型,包括:地下、地面、路边

 extensions=all的时候显示 

 tag 

 该POI的特色内容

 主要出现在POI为美食类的POI之中出现,此时代表特色菜

例如“烤鱼,麻辣香锅,老干妈回锅肉”


在其余POI类别的时候,会有小概率出现,此时代表此POI的特色内容

例如北京-第五季花艺 之中的“岁月静好,定情,如意花卡,圣诞之爱”


仅在extensions=all

indoor_map

是否有室内地图标志

1,表示有室内相关数据

0,代表没有室内相关数据

 extensions=all的时候显示 

indoor_data

室内地图相关数据

当indoor_map=0时,字段为空

 extensions=all的时候显示 


cpid

当前POI的父级POI

如果当前POI为建筑物类POI,则cpid为自身POI ID;如果当前POI为商铺类POI,则cpid为其所在建筑物的POI ID

floor

楼层索引

一般会用数字表示,例如8

truefloor

所在楼层

一般会带有字母,例如F8

groupbuy_num

团购数据

此字段逐渐废弃

business_area

所属商圈

 extensions=all的时候显示 

discount_num

优惠信息数目

此字段逐渐废弃 

biz_ext

深度信息

 extensions=all的时候显示 


rating

评分

仅存在于餐饮、酒店、景点、影院类POI之下


cost

人均消费

仅存在于餐饮、酒店、景点、影院类POI之下 


meal_ordering

是否可订餐

仅存在于餐饮相关POI之下(此字段逐渐废弃)


seat_ordering

是否可选座

仅存在于影院相关POI之下(此字段逐渐废弃) 


ticket_ordering    

是否可订票

仅存在于景点相关POI之下(此字段逐渐废弃) 


hotel_ordering

是否可以订房

仅存在于酒店相关POI之下(此字段逐渐废弃) 

photos

照片相关信息

extensions=all的时候显示


titile

图片介绍





url

具体链接


http://restapi.amap.com/v3/place/text?keywords=北京大学&city=beijing&output=xml&offset=20&page=1&key=<用户的key>&extensions=all 

参数

备注

必选

keywords

查询关键词

types

查询POI类型

city

城市名,可填:城市中文、中文全拼、citycode或adcode

children

按照层级展示子POI数据

offset

每页记录数据

page

当前页数

extensions

返回结果控制


说明:keywords(北京大学)是需要查询的关键词,city(beijing)是查询的城市范围,offset(20)为每页返回的POI数量,page(1)为当前页数,extensions(all)为返回信息控制参数,output(XML)用于指定返回数据的格式,key是用户请求数据的身份标识。

周边搜索

周边搜索API服务地址:

http://restapi.amap.com/v3/place/around?parameters 

parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。

 

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

用户在高德地图官网申请Web服务API类型KEY

必填

location

中心点坐标

规则: 经度和纬度用","分割,经度在前,纬度在后,经纬度小数点后不得超过6位

必填

keywords

查询关键字

规则: 多个关键字用“|”分割

可选

types

查询POI类型

多个类型用“|”分割;

可选值:分类代码 或 汉字 (若用汉字,请严格按照附件之中的汉字填写) 

分类代码由六位数字组成,一共分为三个部分,前两个数字代表大类;中间两个数字代表中类;最后两个数字代表小类。

若指定了某个大类,则所属的中类、小类都会被显示。

例如:010000为汽车服务(大类)

             010100为加油站(中类)

                010101为中国石化(小类)

             010900为汽车租赁(中类)

                010901为汽车租赁还车(小类)

当指定010000,则010100等中类、010101等小类都会被包含。

当指定010900,则010901等小类都会被包含

下载POI分类编码和城市编码表         


当keywords和types均为空的时候,默认指定types为050000(餐饮服务)、070000(生活服务)、120000(商务住宅)

可选


city

查询城市

可选值:城市中文、中文全拼、citycode、adcode

如:北京/beijing/010/110000

当用户指定的经纬度和city出现冲突,若范围内有用户指定city的数据,则返回相关数据,否则返回为空。

如:经纬度指定石家庄,而city却指定天津,若搜索范围内有天津的数据则返回相关数据,否则返回为空。

可选

无(全国范围内搜索)

radius

查询半径

取值范围:0-50000。规则:大于50000按默认值,单位:米

可选

3000

sortrule

排序规则

规定返回结果的排序规则。

按距离排序:distance;综合排序:weight

可选

distance

offset

每页记录数据

强烈建议不超过25,若超过25可能造成访问报错

可选

20

page

当前页数

最大翻页数100

可选

1

extensions

返回结果控制

此项默认返回基本地址信息;取值为all返回地址信息、附近POI、道路以及道路交叉口信息。

可选

base

sig

数字签名

数字签名获取和使用方法

可选

output

返回数据格式类型

可选值:JSON,XML

可选

JSON

callback

回调函数

callback值是用户定义的函数名称,此参数只在output=JSON时有效

可选

  • 返回结果参数说明

周边搜索搜索的响应结果的格式由请求参数output指定,返回结果见关键字搜索

 

  • 服务示例
http://restapi.amap.com/v3/place/around?key=<用户的key>&location=116.473168,39.993015&radius=10000&types=011100  

参数

备注

必选

location

中心点坐标

keywords

查询关键词

types

查询POI类型

radius

查询半径

offset

每页记录数据

page

当前页数

extensions

返回结果控制

说明:location(116.481488,39.990464)是需要查询的中心点,types(050301)为搜索的返回POI数据类型,extensions(all)为返回的数据内容,output(XML)用于指定返回数据的格式,key是用户请求数据的身份标识。参数,output(XML)用于指定返回数据的格式,key是用户请求数据的身份标识。

多边形搜索

多边形搜索API服务地址:

http://restapi.amap.com/v3/place/polygon?parameters 

parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。

 

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

用户在高德地图官网申请Web服务API类型KEY

必填

polygon

经纬度坐标对

规则:经度和纬度用","分割,经度在前,纬度在后,坐标对用"|"分割。经纬度小数点后不得超过6位。         多边形为矩形时,可传入左上右下两顶点坐标对;其他情况下首尾坐标对需相同。

必填

keywords

查询关键字

规则: 多个关键字用“|”分割

可选

types

查询POI类型

多个类型用“|”分割;

可选值:分类代码 或 汉字 (若用汉字,请严格按照附件之中的汉字填写) 

分类代码由六位数字组成,一共分为三个部分,前两个数字代表大类;中间两个数字代表中类;最后两个数字代表小类。

若指定了某个大类,则所属的中类、小类都会被显示。

例如:010000为汽车服务(大类)

             010100为加油站(中类)

                010101为中国石化(小类)

             010900为汽车租赁(中类)

                010901为汽车租赁还车(小类)

当指定010000,则010100等中类、010101等小类都会被包含。

当指定010900,则010901等小类都会被包含

下载POI分类编码和城市编码表   


当keywords和types为空的时候, 我们会默认指定types为120000(商务住宅)&150000(交通设施服务) 

可选


offset

每页记录数据

强烈建议不超过25,若超过25可能造成访问报错

可选

20

page

当前页数

最大翻页数100

可选

1

extensions

返回结果控制

此项默认返回基本地址信息;取值为all返回地址信息、附近POI、道路以及道路交叉口信息。

可选

base

sig

数字签名

数字签名获取和使用方法

可选

output

返回数据格式类型

可选值:JSON,XML

可选

JSON

callback

回调函数

callback值是用户定义的函数名称,此参数只在output=JSON时有效

可选

  • 返回结果参数说明

多边形搜索搜索的响应结果的格式由请求参数output指定,返回结果见关键字搜索

 

  • 服务示例
http://restapi.amap.com/v3/place/polygon?polygon=116.460988,40.006919|116.48231,40.007381|116.47516,39.99713|116.472596,39.985227|116.45669,39.984989|116.460988,40.006919&keywords=kfc&output=xml&key=<用户的key>

参数

备注

必选

polygon

经纬度坐标对,矩形时可传入左上右下两顶点坐标对;其他情况首尾坐标对需相同。

keywords

查询关键词

types

查询POI类型

offset

每页记录数据

page

当前页数

extensions

返回结果控制


说明:polygon(116.460988,40.006919;116.48231,40.007381;116.47516,39.99713;116.472596,39.985227;116.45669,39.984989;116.460988,40.006919)是查询的区域范围,keywords(kfc)为查询的关键字,extensions(all)为返回的数据内容,output(XML)用于指定返回数据的格式,key是用户请求数据的身份标识。

ID查询

ID查询搜索API服务地址:

http://restapi.amap.com/v3/place/detail?parameters 

parameters 代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。

 

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

用户在高德地图官网申请Web服务API类型KEY

必填

id

兴趣点ID

兴趣点的唯一标识ID

必填

sig

数字签名

数字签名获取和使用方法

可选

output

返回数据格式类型

可选值:JSON,XML

可选

JSON

callback

回调函数

callback值是用户定义的函数名称,此参数只在output=JSON时有效

可选

  • 返回结果参数说明

ID查询搜索的响应结果的格式由请求参数output指定,返回结果见关键字搜索

 

  • 服务示例
http://restapi.amap.com/v3/place/detail?id=B0FFFAB6J2&output=xml&key=<用户的key>

参数

备注

必选

id

兴趣点ID

说明:ID(B0FFFAB6J2)是查询POI ID,extensions(all)为返回的数据内容,output(XML)用于指定返回数据的格式,key是用户请求数据的身份标识。

示例中心 功能
在线体验
常见问题