Amap Maps Get V3 Assistant Inputtips

1 credits/call
ae_amap_maps_get_v3_assistant_inputtips

Get search suggestions and keyword completions for places, addresses, and transit in mainland China using Amap (Gaode).

Maps
1 credits/call

Pricing

1 credits/call
ConditionCharge
Each call1 credits/call

Parameters

Optional parameters use the platform defaults when omitted.

ParameterTypeRequiredDescriptionDefault
citystringNo搜索城市 可选值:citycode、adcode,不支持县级市。如:010/110000adcode信息可参考[城市编码表](https://lbs.amap.com/api/webservice/download)获取。填入此参数后,会尽量优先返回此城市数据,但是不一定仅局限此城市结果,若仅需要某个城市数据请调用citylimit参数。如:在深圳市搜天安门,返回北京天安门结果。—
typestringNoPOI分类 服务可支持传入多个分类,多个类型剑用“|”分隔 可选值:POI分类名称、分类代码 此处强烈建议使用分类代码,否则可能会得到不符合预期的结果 注意:该参数在 schema 中定义为 string;如果传 POI 分类代码、城市编码或行政区划编码,请按字符串传入并保留前导 0,例如 "050301",不要传数字 50301。—
outputenum (JSON | XML)No返回数据格式类型 可选值:JSON,XMLJSON
callbackstringNo回调函数 callback值是用户定义的函数名称,此参数只在output=JSON时有效—
datatypeenum (all | poi | bus | busline)No返回的数据类型 多种数据类型用“|”分隔,可选值:all-返回所有数据类型、poi-返回POI数据类型、bus-返回公交站点数据类型、busline-返回公交线路数据类型all
keywordsstringYes查询关键词—
locationstringNo坐标 格式:“X,Y”(经度,纬度),不可以包含空格 建议使用location参数,可在此location附近优先返回搜索关键词信息 在请求参数city不为空时生效—
citylimitbooleanNo仅返回指定城市数据 可选值:true/falsefalse

Invocation example

Copy the request and explore its response example.

POST/agent-api/v1/tool/executeX-Api-Key
Request coderequest.sh
curl --request POST \
  --url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_amap_maps_get_v3_assistant_inputtips' \
  --header "X-Api-Key: $AGENTEARTH_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "params": {
    "city": "惠州",
    "citylimit": true,
    "datatype": "poi",
    "keywords": "新宜"
  }
}'
Response exampleresponse.json
JSONPartial content
{
  "count": "9",
  "info": "OK",
  "infocode": "10000",
  "status": "1",
  "tips": [
    {
      "adcode": "441303",
      "address": "西区办事处禾塘村49号",
      "city": [],
      "district": "广东省惠州市惠阳区",
      "id": "B0FFG9OPUW",
      "name": "新宜兴自选商场"
    }
  ]
}

This example shows part of the response. Copied content is valid JSON.

Guides using this tool

See how this tool fits into real workflows