您现在的位置: 开发 > Web服务 API > 开发指南 > API文档 > 搜索POI 2.0

搜索POI 2.0 最后更新时间: 2021年10月14日

产品概述


地点搜索服务2.0是一类Web API接口服务;服务提供多种场景的地点搜索能力,包括关键字搜索、周边搜索、多边形区域搜索、ID搜索。

功能介绍 


关键字搜索:

开发者可通过文本关键字搜索地点信息,文本可以是结构化地址,例如:北京市朝阳区望京阜荣街10号;也可以是POI名称,例如:首开广场;

周边搜索:

开发者可设置圆心和半径,搜索圆形区域内的地点信息;

多边形区域搜索:

开发者可设置首尾连接的几何点组成多边形区域,搜索坐标对应多边形内的地点信息;

ID搜索:

开发者可通过已知的地点ID(POI ID)搜索对应地点信息,建议结合输入提示接口使用。

流量限制


本服务目前是面向企业开发者试用阶段,如果您有上线使用需求,请通过工单跟我们确认好流量配额限制,避免上线后给您业务造成影响。

使用说明


第一步,申请Web服务API类型Key

第二步,参考接口参数文档发起HTTP/HTTPS请求,第一步申请的 Key 需作为必填参数一同发送;

第三步,解析请求返回的数据(JSON格式),参考返回参数文档解析数据。

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

服务文档


关键字搜索

关键字搜索 API 服务地址

URL

https://restapi.amap.com/v5/place/text?parameters

请求方式

GET

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

高德Key

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

必填

keywords

地点关键字

需要被检索的地点文本信息。

多个关键字用“|”分割,文本总长度不可超过80字符

必填(keyword或者types二选一必填)

types

指定地点类型

地点文本搜索接口支持按照设定的POI类型限定地点搜索结果;地点类型与poi typecode是同类内容,可以传入多个poi typecode,相互之间用“|”分隔,内容可以参考POI分类码表;地点(POI)列表的排序会按照高德搜索能力进行综合权重排序;

可选(keyword或者types二选一必填)

120000(商务住宅)

150000(交通设施服务)

region

搜索区划

增加指定区域内数据召回权重,如需严格限制召回数据在区域内,请搭配使用city_limit参数,可输入citycode,adcode,cityname;cityname仅支持到城市级别,如“北京市”。

可选

无,默认全国范围内搜索

city_limit

指定城市数据召回限制

可选值:true/false

为true时,仅召回region对应区域内数据。

可选

false

show_fields

返回结果控制

show_fields用来筛选response结果中可选字段。show_fields的使用需要遵循如下规则:

1、具体可指定返回的字段类请见下方返回结果说明中的show_fields内字段类型;

2、多个字段间采用“,”进行分割;

3、show_fields未设置时,只返回基础信息类内字段。

可选

page_size

当前分页展示的数据条数

page_size的取值1-25

可选

page_size默认为10

page_num

请求第几分页

page_num的取值1-100

可选

page_num默认为1

sig

数字签名

请参考数字签名获取和使用方法

可选

output

返回结果格式类型

默认格式为json,目前只支持json格式;

可选

json

callback

回调函数

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

可选

  • 返回结果

名称

类型

说明

status

string

本次API访问状态,如果成功返回1,如果失败返回0。

info

string

访问状态值的说明,如果成功返回"ok",失败返回错误原因,具体见错误码说明

infocode

string

返回状态说明,10000代表正确,详情参阅info状态表

count

string

单次请求返回的实际poi点的个数

pois

object

返回的poi完整集合

poi

单个poi内包含的完整返回数据

name

string

poi名称

id

string

poi唯一标识

location

string

poi经纬度

type

string

poi所属类型

typecode

string

poi分类编码

pname

string

poi所属省份

cityname

string

poi所属城市

adname

string

poi所属区县

address

string

poi详细地址

pcode

string

poi所属省份编码

adcode

string

poi所属区域编码

citycode

string

poi所属城市编码

注意以下字段如需返回需要通过“show_fields”进行参数类设置。

children

object

设置后返回子POI信息

id

string

子poi唯一标识

name

string

子poi名称

location

string

子poi经纬度

address

string

子poi详细地址

subtype

string

子poi所属类型

typecode

string

子poi分类编码

business

object

设置后返回poi商业信息

business_area

string

poi所属商圈

opentime_today

string

poi今日营业时间,如 08:30-17:30 08:30-09:00 12:00-13:30 09:00-13:00

opentime_week

string

poi营业时间描述,如 周一至周五:08:30-17:30(延时服务时间:08:30-09:00;12:00-13:30);周六延时服务时间:09:00-13:00(法定节假日除外)

tel

string

poi的联系电话

tag

string

poi特色内容,目前仅在美食poi下返回

rating

string

poi评分,目前仅在餐饮、酒店、景点、影院类POI下返回

cost

string

poi人均消费,目前仅在餐饮、酒店、景点、影院类POI下返回

parking_type

string

停车场类型(地下、地面、路边),目前仅在停车场类POI下返回

alias

string

poi的别名,无别名时不返回

indoor

object

设置后返回室内相关信息

indoor_map

string

是否有室内地图标志,1为有,0为没有

cpid

string

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

indoor_map为0时不返回

floor

string

楼层索引,一般会用数字表示,例如8;indoor_map为0时不返回

truefloor

string

所在楼层,一般会带有字母,例如F8;indoor_map为0时不返回

navi

object

设置后返回导航位置相关信息

navi_poiid

string

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

entr_location

string

poi的入口经纬度坐标

exit_location

string

poi的出口经纬度坐标

gridcode

string

poi的地理格id

photos

object

设置后返回poi图片相关信息

title

string

poi的图片介绍

url

string

poi图片的下载链接

周边搜索

  • 周边搜索 API 服务地址

URL

https://restapi.amap.com/v5/place/around?parameters

请求方式

GET

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

高德Key

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

必填

keywords

地点关键字

需要被检索的地点文本信息。

多个关键字用“|”分割,文本总长度不可超过80字符

可选

types

指定地点类型

地点文本搜索接口支持按照设定的POI类型限定地点搜索结果;地点类型与poi typecode是同类内容,可以传入多个poi typecode,相互之间用“|”分隔,内容可以参考POI分类码表;地点(POI)列表的排序会按照高德搜索能力进行综合权重排序;

可选

120000(商务住宅)

150000(交通设施服务)

location

中心点坐标

圆形区域检索中心点,不支持多个点。经度和纬度用","分割,经度在前,纬度在后,经纬度小数点后不得超过6位

必填

radius

搜索半径

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

可选

3000

sortrule

排序规则

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

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

可选

distance

region

搜索区划

增加指定区域内数据召回权重,如需严格限制召回数据在区域内,请搭配使用city_limit参数,可输入行政区划名或对应citycode或adcode

可选

无,默认全国范围内搜索

show_fields

返回结果控制

show_fields用来筛选response结果中可选字段。show_fields的使用需要遵循如下规则:

1、具体可指定返回的字段类请见下方返回结果说明中的show_fields内字段类型;

2、多个字段间采用“,”进行分割;

3、show_fields未设置时,只返回基础信息类内字段。

可选

page_size

当前分页展示的数据条数

page_size的取值1-25

可选

page_size默认为10

page_num

请求第几分页

page_num的取值1-100

可选

page_num默认为1

sig

数字签名

请参考数字签名获取和使用方法

可选

output

返回结果格式类型

默认格式为json,目前只支持json格式;

可选

json

callback

回调函数

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

可选

  • 返回结果

名称

类型

说明

status

string

本次API访问状态,如果成功返回1,如果失败返回0。

info

string

访问状态值的说明,如果成功返回"ok",失败返回错误原因,具体见错误码说明

infocode

string

返回状态说明,10000代表正确,详情参阅info状态表

count

string

单次请求返回的实际poi点的个数

pois

object

返回的poi完整集合

poi

单个poi内包含的完整返回数据

name

string

poi名称

id

string

poi唯一标识

location

string

poi经纬度

type

string

poi所属类型

typecode

string

poi分类编码

pname

string

poi所属省份

cityname

string

poi所属城市

adname

string

poi所属区县

address

string

poi详细地址

pcode

string

poi所属省份编码

adcode

string

poi所属区域编码

citycode

string

poi所属城市编码

注意以下字段如需返回需要通过“show_fields”进行参数类设置。

children

object

设置后返回子POI信息

id

string

子poi唯一标识

name

string

子poi名称

location

string

子poi经纬度

address

string

子poi详细地址

subtype

string

子poi所属类型

typecode

string

子poi分类编码

business

object

设置后返回poi商业信息

business_area

string

poi所属商圈

tel

string

poi的联系电话

tag

string

poi特色内容,目前仅在美食poi下返回

rating

string

poi评分,目前仅在餐饮、酒店、景点、影院类POI下返回

cost

string

poi人均消费,目前仅在餐饮、酒店、景点、影院类POI下返回

parking_type

string

停车场类型(地下、地面、路边),目前仅在停车场类POI下返回

alias

string

poi的别名,无别名时不返回

navi

object

设置后返回导航位置相关信息

navi_poiid

string

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

entr_location

string

poi的入口经纬度坐标

exit_location

string

poi的出口经纬度坐标

gridcode

string

poi的地理格id

photos

object

设置后返回poi图片相关信息

title

string

poi的图片介绍

url

string

poi图片的下载链接

多边形区域搜索

  • 多边形区域搜索 API 服务地址

URL

https://restapi.amap.com/v5/place/polygon?parameters

请求方式

GET

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

高德Key

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

必填

polygon

多边形区域

多个坐标对集合,坐标对用"|"分割。多边形为矩形时,可传入左上右下两顶点坐标对;其他情况下首尾坐标对需相同。

必填

keywords

地点关键字

需要被检索的地点文本信息。

多个关键字用“|”分割,文本总长度不可超过80字符

可选

types

指定地点类型

地点文本搜索接口支持按照设定的POI类型限定地点搜索结果;地点类型与poi typecode是同类内容,可以传入多个poi typecode,相互之间用“|”分隔,内容可以参考POI分类码表;地点(POI)列表的排序会按照高德搜索能力进行综合权重排序;

可选

120000(商务住宅)

150000(交通设施服务)

show_fields

返回结果控制

show_fields用来筛选response结果中可选字段。show_fields的使用需要遵循如下规则:

1、具体可指定返回的字段类请见下方返回结果说明中的show_fields内字段类型;

2、多个字段间采用“,”进行分割;

3、show_fields未设置时,只返回基础信息类内字段。

可选

page_size

当前分页展示的数据条数

page_size的取值1-25

可选

page_size默认为10

page_num

请求第几分页

page_num的取值1-100

可选

page_num默认为1

sig

数字签名

请参考数字签名获取和使用方法

可选

output

返回结果格式类型

默认格式为json,目前只支持json格式;

可选

json

callback

回调函数

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

可选

  • 返回结果

名称

类型

说明

status

string

本次API访问状态,如果成功返回1,如果失败返回0。

info

string

访问状态值的说明,如果成功返回"ok",失败返回错误原因,具体见错误码说明

infocode

string

返回状态说明,10000代表正确,详情参阅info状态表

count

string

单次请求返回的实际poi点的个数

pois

object

返回的poi完整集合

poi

单个poi内包含的完整返回数据

name

string

poi名称

id

string

poi唯一标识

location

string

poi经纬度

type

string

poi所属类型

typecode

string

poi分类编码

pname

string

poi所属省份

cityname

string

poi所属城市

adname

string

poi所属区县

address

string

poi详细地址

pcode

string

poi所属省份编码

adcode

string

poi所属区域编码

citycode

string

poi所属城市编码

注意以下字段如需返回需要通过“show_fields”进行参数类设置。

children

object

设置后返回子POI信息

id

string

子poi唯一标识

name

string

子poi名称

location

string

子poi经纬度

address

string

子poi详细地址

subtype

string

子poi所属类型

typecode

string

子poi分类编码

business

object

设置后返回子POI信息

business_area

string

poi所属商圈

tel

string

poi的联系电话

tag

string

poi特色内容,目前仅在美食poi下返回

rating

string

poi评分,目前仅在餐饮、酒店、景点、影院类POI下返回

cost

string

poi人均消费,目前仅在餐饮、酒店、景点、影院类POI下返回

parking_type

string

停车场类型(地下、地面、路边),目前仅在停车场类POI下返回

alias

string

poi的别名,无别名时不返回

indoor

object

设置后返回室内相关信息

indoor_map

string

是否有室内地图标志,1为有,0为没有

cpid

string

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

indoor_map为0时不返回

floor

string

楼层索引,一般会用数字表示,例如8;indoor_map为0时不返回

truefloor

string

所在楼层,一般会带有字母,例如F8;indoor_map为0时不返回

navi

object

设置后返回导航位置相关信息

navi_poiid

string

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

entr_location

string

poi的入口经纬度坐标

exit_location

string

poi的出口经纬度坐标

gridcode

string

poi的地理格id

photos

object

设置后返回poi图片相关信息

title

string

poi的图片介绍

url

string

poi图片的下载链接

ID搜索

  • ID搜索 API 服务地址

URL

https://restapi.amap.com/v5/place/detail?parameters

请求方式

GET

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

高德Key

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

必填

id

poi唯一标识

最多可以传入10个id,多个id之间用“|”分隔。

必填

show_fields

返回结果控制

show_fields用来筛选response结果中可选字段。show_fields的使用需要遵循如下规则:

1、具体可指定返回的字段类请见下方返回结果说明中的show_fields内字段类型;

2、多个字段间采用“,”进行分割;

3、show_fields未设置时,只返回基础信息类内字段。

可选

sig

数字签名

请参考数字签名获取和使用方法

可选

output

返回结果格式类型

默认格式为json,目前只支持json格式;

可选

json

callback

回调函数

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

可选

  • 返回结果

名称

类型

说明

status

string

本次API访问状态,如果成功返回1,如果失败返回0。

info

string

访问状态值的说明,如果成功返回"ok",失败返回错误原因,具体见错误码说明

infocode

string

返回状态说明,10000代表正确,详情参阅info状态表

pois

object

完整的POI列表

poi

object

单个POI返回的数据字段

name

string

poi名称

id

string

poi唯一标识

location

string

poi经纬度

type

string

poi所属类型

typecode

string

poi分类编码

pname

string

poi所属省份

cityname

string

poi所属城市

adname

string

poi所属区县

address

string

poi详细地址

pcode

string

poi所属省份编码

adcode

string

poi所属区域编码

citycode

string

poi所属城市编码

注意以下字段如需返回需要通过“show_fields”进行参数类设置。

children

object

设置后返回子POI信息

id

string

子poi唯一标识

name

string

子poi名称

location

string

子poi经纬度

address

string

子poi详细地址

subtype

string

子poi所属类型

typecode

string

子poi分类编码

business

object

设置后返回子POI信息

business_area

string

poi所属商圈

tel

string

poi的联系电话

tag

string

poi特色内容,目前仅在美食poi下返回

rating

string

poi评分,目前仅在餐饮、酒店、景点、影院类POI下返回

cost

string

poi人均消费,目前仅在餐饮、酒店、景点、影院类POI下返回

parking_type

string

停车场类型(地下、地面、路边),目前仅在停车场类POI下返回

alias

string

poi的别名,无别名时不返回

indoor

object

设置后返回室内相关信息

indoor_map

string

是否有室内地图标志,1为有,0为没有

cpid

string

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

indoor_map为0时不返回

floor

string

楼层索引,一般会用数字表示,例如8;indoor_map为0时不返回

truefloor

string

所在楼层,一般会带有字母,例如F8;indoor_map为0时不返回

navi

object

设置后返回导航位置相关信息

navi_poiid

string

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

entr_location

string

poi的入口经纬度坐标

exit_location

string

poi的出口经纬度坐标

gridcode

string

poi的地理格id

photos

object

设置后返回poi图片相关信息

title

string

poi的图片介绍

url

string

poi图片的下载链接

新用户
福利
示例
中心
常见
问题
智能
客服