产品介绍
搜索服务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服务地址:
URLhttps://restapi.amap.com/v3/place/text?parameters
请求方式GET
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。请求参数
参数名含义规则说明是否必须缺省值
key请求服务权限标识必填无
keywords查询关键字规则: 多个关键字用“|”分割
若不指定city,并且搜索的为泛词(例如“美食”)的情况下,返回的内容为城市列表以及此城市内有多少结果符合要求。必填
(keywords和types两者至少必选其一)无
types查询POI类型可选值:分类代码 或 汉字(若用汉字,请严格按照附件之中的汉字填写)
分类代码由六位数字组成,一共分为三个部分,前两个数字代表大类;中间两个数字代表中类;最后两个数字代表小类。
若指定了某个大类,则所属的中类、小类都会被显示。
例如:010000为汽车服务(大类)
010100为加油站(中类)
010101为中国石化(小类)
010900为汽车租赁(中类)
010901为汽车租赁还车(小类)
当指定010000,则010100等中类、010101等小类都会被包含,当指定010900,则010901等小类都会被包含。
若不指定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
extensions返回结果控制此项默认返回基本地址信息;取值为all返回地址信息、附近POI、道路以及道路交叉口信息。可选base
output返回数据格式类型可选值:JSON,XML可选JSON
callback回调函数callback值是用户定义的函数名称,此参数只在output=JSON时有效可选无返回结果参数说明
关键字搜索的响应结果的格式由请求参数output指定。
名称含义规则说明
status结果状态值,值为0或10:请求失败;1:请求成功
info返回状态说明status为0时,info返回错误原因,否则返回“OK”。详情参阅info状态表
count搜索方案数目(最大值为1000)
suggestion城市建议列表当搜索的文本关键字在限定城市中没有返回时会返回建议城市列表;
keywords关键字
cities城市列表
name名称
num该城市包含此关键字的个数
citycode该城市的citycode
adcode该城市的adcode
sug_address建议地址结果当搜索结果并非是POI(是地址时),且没有搜索到POI时返回
name搜索文本内容搜索的文本内容
address地址地址描述
location经纬度
country国家
pname省市
cityname城市
adcodeadcode
adname区域名称
district地级市或县级市
aoi所属aoi
street街道名称
pois搜索POI信息列表
poiPOI信息
id唯一ID
parent父POI的ID当前POI如果有父POI,则返回父POI的ID。可能为空
name名称
type兴趣点类型顺序为大类、中类、小类
例如:餐饮服务;中餐厅;特色/地方风味餐厅
typecode兴趣点类型编码例如:050118
biz_type行业类型
address地址东四环中路189号百盛北门
location经纬度格式:X,Y
distance离中心点距离单位:米;仅在周边搜索的时候有值返回
telPOI的电话
postcode邮编extensions=all时返回
websitePOI的网址extensions=all时返回
emailPOI的电子邮箱extensions=all时返回
pcodePOI所在省份编码extensions=all时返回
pnamePOI所在省份名称若是直辖市的时候,此处直接显示市名,例如北京市
citycode城市编码extensions=all时返回
cityname城市名若是直辖市的时候,此处直接显示市名,例如北京市
adcode区域编码extensions=all时返回
adname区域名称区县级别的返回,例如朝阳区
entr_locationPOI的入口经纬度extensions=all时返回,也可用作于POI的到达点;
exit_locationPOI的出口经纬度目前不会返回内容;
navi_poiidPOI导航idextensions=all时返回
gridcode地理格IDextensions=all时返回
alias别名extensions=all时返回
business_area所在商圈extensions=all时返回
parking_type停车场类型仅在停车场类型POI的时候显示该字段
展示停车场类型,包括:地下、地面、路边
extensions=all的时候显示
tag该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具体链接https://restapi.amap.com/v3/place/text?keywords=北京大学&city=beijing&output=xml&offset=20&page=1&key=&extensions=all
参数值备注必选
keywords查询关键词是
types查询POI类型否
city城市名,可填:城市中文、中文全拼、citycode或adcode否
children按照层级展示子POI数据否
offset每页记录数据否
page当前页数否
extensionsall base返回结果控制否
说明:keywords(北京大学)是需要查询的关键词,city(beijing)是查询的城市范围,offset(20)为每页返回的POI数量,page(1)为当前页数,extensions(all)为返回信息控制参数,output(XML)用于指定返回数据的格式,key是用户请求数据的身份标识。
周边搜索
周边搜索API服务地址:
URLhttps://restapi.amap.com/v3/place/around?parameters
请求方式GET
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。请求参数
参数名含义规则说明是否必须缺省值
key请求服务权限标识必填无
location中心点坐标规则: 经度和纬度用","分割,经度在前,纬度在后,经纬度小数点后不得超过6位必填无
keywords查询关键字规则: 多个关键字用“|”分割可选无
types查询POI类型多个类型用“|”分割;
可选值:分类代码 或 汉字 (若用汉字,请严格按照附件之中的汉字填写)
分类代码由六位数字组成,一共分为三个部分,前两个数字代表大类;中间两个数字代表中类;最后两个数字代表小类。
若指定了某个大类,则所属的中类、小类都会被显示。
例如:010000为汽车服务(大类)
010100为加油站(中类)
010101为中国石化(小类)
010900为汽车租赁(中类)
010901为汽车租赁还车(小类)
当指定010000,则010100等中类、010101等小类都会被包含。
当指定010900,则010901等小类都会被包含
当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
output返回数据格式类型可选值:JSON,XML可选JSON
callback回调函数callback值是用户定义的函数名称,此参数只在output=JSON时有效可选无返回结果参数说明
周边搜索搜索的响应结果的格式由请求参数output指定,返回结果见关键字搜索
服务示例https://restapi.amap.com/v3/place/around?key=&location=116.473168,39.993015&radius=10000&types=011100
参数值备注必选
location中心点坐标是
keywords查询关键词否
types查询POI类型否
radius查询半径否
offset每页记录数据否
page当前页数否
extensionsall base返回结果控制否
说明:location(116.481488,39.990464)是需要查询的中心点,types(050301)为搜索的返回POI数据类型,extensions(all)为返回的数据内容,output(XML)用于指定返回数据的格式,key是用户请求数据的身份标识。参数,output(XML)用于指定返回数据的格式,key是用户请求数据的身份标识。
多边形搜索
多边形搜索API服务地址:
URLhttps://restapi.amap.com/v3/place/polygon?parameters
请求方式GET
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。请求参数
参数名含义规则说明是否必须缺省值
key请求服务权限标识必填无
polygon经纬度坐标对规则:经度和纬度用","分割,经度在前,纬度在后,坐标对用"|"分割。经纬度小数点后不得超过6位。 多边形为矩形时,可传入左上右下两顶点坐标对;其他情况下首尾坐标对需相同。必填无
keywords查询关键字规则: 多个关键字用“|”分割可选无
types查询POI类型多个类型用“|”分割;
可选值:分类代码 或 汉字 (若用汉字,请严格按照附件之中的汉字填写)
分类代码由六位数字组成,一共分为三个部分,前两个数字代表大类;中间两个数字代表中类;最后两个数字代表小类。
若指定了某个大类,则所属的中类、小类都会被显示。
例如:010000为汽车服务(大类)
010100为加油站(中类)
010101为中国石化(小类)
010900为汽车租赁(中类)
010901为汽车租赁还车(小类)
当指定010000,则010100等中类、010101等小类都会被包含。
当指定010900,则010901等小类都会被包含
当keywords和types为空的时候, 我们会默认指定types为120000(商务住宅)&150000(交通设施服务)可选
offset每页记录数据强烈建议不超过25,若超过25可能造成访问报错可选20
page当前页数最大翻页数100可选1
extensions返回结果控制此项默认返回基本地址信息;取值为all返回地址信息、附近POI、道路以及道路交叉口信息。可选base
output返回数据格式类型可选值:JSON,XML可选JSON
callback回调函数callback值是用户定义的函数名称,此参数只在output=JSON时有效可选无返回结果参数说明
多边形搜索搜索的响应结果的格式由请求参数output指定,返回结果见关键字搜索
服务示例https://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=
参数值备注必选
polygon经纬度坐标对,矩形时可传入左上右下两顶点坐标对;其他情况首尾坐标对需相同。是
keywords查询关键词否
types查询POI类型否
offset每页记录数据否
page当前页数否
extensionsall base返回结果控制否
说明: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服务地址:
URLhttps://restapi.amap.com/v3/place/detail?parameters
请求方式GET
parameters 代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。请求参数
参数名含义规则说明是否必须缺省值
key请求服务权限标识必填无
id兴趣点ID兴趣点的唯一标识ID必填无
output返回数据格式类型可选值:JSON,XML可选JSON
callback回调函数callback值是用户定义的函数名称,此参数只在output=JSON时有效可选无返回结果参数说明
ID查询搜索的响应结果的格式由请求参数output指定,返回结果见关键字搜索
服务示例https://restapi.amap.com/v3/place/detail?id=B0FFFAB6J2&output=xml&key=
参数值备注必选
id兴趣点ID是
说明:ID(B0FFFAB6J2)是查询POI ID,extensions(all)为返回的数据内容,output(XML)用于指定返回数据的格式,key是用户请求数据的身份标识。