关键字搜索

GET/v5/place/text

请求参数

Query 参数

keywords

string

可选

地点关键字需要被检索的地点文本信息。多个关键字用“|”分割，文本总长度不可超过80字符

types

string

可选

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

region

string

可选

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

city_limit

string

可选

指定城市数据召回限制可选值：true/false 为true时，仅召回region对应区域内数据。

show_fields

string

可选

返回结果控制 show_fields用来筛选response结果中可选字段。show_fields的使用需要遵循如下规则： 1、具体可指定返回的字段类请见下方返回结果说明中的“show_fields”内字段类型； 2、多个字段间采用“,”进行分割； 3、show_fields未设置时，只返回基础信息类内字段。

page_size

string

可选

当前分页展示的数据条数 page_size的取值1-25

page_num

string

可选

请求第几分页 page_num的取值1-100

sig

string

可选

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

output

string

可选

返回结果格式类型默认格式为json，目前只支持json格式；

callback

string

可选

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

parameters

string

可选

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

status

string

可选

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

info

string

可选

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

infocode

string

可选

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

count

string

可选

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

pois

object

可选

返回的poi完整集合

poi

string

可选

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

name

string

poi名称

可选

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所属城市编码

可选

children

object

可选

 设置后返回子POI信息

{
  "status": "string",
  "info": "string",
  "infocode": "string",
  "count": "string",
  "pois": {
    "poi": "string",
    "name": "string",
    "id": "string",
    "location": "string",
    "type": "string",
    "typecode": "string",
    "pname": "string",
    "cityname": "string",
    "adname": "string",
    "address": "string",
    "pcode": "string",
    "adcode": "string",
    "citycode": "string",
    "children": {
      "id": "string",
      "name": "string",
      "location": "string",
      "address": "string",
      "subtype": "string",
      "typecode": "string",
      "business": {
        "business_area": "string",
        "opentime_today": "string",
        "opentime_week": "string",
        "tel": "string",
        "tag": "string",
        "rating": "string",
        "cost": "string",
        "parking_type": "string",
        "alias": "string",
        "indoor": {
          "\t indoor_map": "string",
          "cpid": "string",
          "floor": "string",
          "truefloor": "string",
          "navi": {
            "navi_poiid": "string",
            "entr_location": "string",
            "exit_location": "string",
            "gridcode": "string",
            "photos": {
              "title": "string",
              "url": "string"
            }
          }
        }
      }
    }
  }
}

最后修改时间： 2 年前