输入提示 最后更新时间: 2021年01月22日

产品介绍

输入提示是一类简单的HTTP接口，提供根据用户输入的关键词查询返回建议列表。

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

适用场景

在高德客户端的使用场景，输入“仙林”之后出现提示相关。

使用限制

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

使用说明

第一步，申请”Web服务API接口”密钥（Key）；

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

第三步，接收HTTP请求返回的数据（JSON或XML格式），解析数据。

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

输入提示

输入提示API服务地址：

URL	https://restapi.amap.com/v3/assistant/inputtips?parameters
请求方式	GET

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

• 请求参数

参数名		含义	规则说明	是否必须	缺省值
key		请求服务权限标识	用户在高德地图官网申请Web服务API类型KEY	必填	无
keywords		查询关键词		必填	无
type		POI分类	服务可支持传入多个分类，多个类型剑用“|”分隔 可选值：POI分类名称、分类代码 此处强烈建议使用分类代码，否则可能会得到不符合预期的结果	可选	无
location		坐标	格式：“X,Y”（经度,纬度），不可以包含空格 建议使用location参数，可在此location附近优先返回搜索关键词信息 在请求参数city不为空时生效	可选	无
city		搜索城市	可选值：citycode、adcode，不支持县级市。 如：010/110000 adcode信息可参考城市编码表获取。 填入此参数后，会尽量优先返回此城市数据，但是不一定仅局限此城市结果，若仅需要某个城市数据请调用citylimit参数。 如：在深圳市搜天安门，返回北京天安门结果。	可选	无（默认在全国范围内搜索）
citylimit		仅返回指定城市数据	可选值：true/false	可选	false
datatype		返回的数据类型	多种数据类型用“|”分隔，可选值：all-返回所有数据类型、poi-返回POI数据类型、bus-返回公交站点数据类型、busline-返回公交线路数据类型	可选	all
sig		数字签名	数字签名获取和使用方法	可选	无
output		返回数据格式类型	可选值：JSON,XML	可选	JSON
callback		回调函数	callback值是用户定义的函数名称，此参数只在output=JSON时有效	可选	无

• 返回结果参数说明

输入提示的响应结果的格式由请求参数output指定。

名称					含义	规则说明
status					返回状态	值为0或1 1：成功；0：失败
info					返回的状态信息	status为0时，info返回错误原；否则返回“OK”。详情参阅info状态表
count					返回结果总数目
tips					建议提示列表
	tip				提示信息
		id			返回数据ID	若数据为POI类型，则返回POI ID;若数据为bus类型，则返回bus id;若数据为busline类型，则返回busline id。
		name			tip名称
		district			所属区域	省+市+区（直辖市为“市+区”）
		adcode			区域编码	六位区县编码
		location			tip中心点坐标	当搜索数据为busline类型时，此字段不返回
		address			详细地址

• 服务示例

https://restapi.amap.com/v3/assistant/inputtips?output=xml&city=010&keywords=招商银行&key=<用户的key>

参数	值	备注	必选
keywords		查询关键词	是
type		查询POI类型	否
location		经度,纬度;建议使用location参数，可在此location附近优先返回搜索关键词信息	否
city		查询城市。可选值：城市中文、中文全拼、citycode、adcode	否
datatype	all poi bus busline	多种数据类型用“|”分隔，可选值：all-返回所有数据类型、poi-返回POI数据类型、bus-返回公交站点数据类型、busline-返回公交线路数据类型	否