您当前的位置: 首页 > Web服务 API > 地点检索

地点检索
可通过多种方式搜索POI信息,其中包括关键字搜索、周边搜索、ID详情搜索等多种。
功能介绍
通过用户输入查询POI的关键字进行条件搜索,例如:麦当劳、电影院等。
接口名
https://api.careland.com.cn/api/v2/search/keyword
HTTP请求方式
post、get
请求参数
  • 参数名称 是否必填 默认值 格式举例 说明
    ak 0
    用户key
    xytype 0
    坐标类型:
    0为凯立德坐标系
    2为国家加密坐标系
    keyword
    查询关键词
    keywork、category至少一个不为空
    category
    西餐厅|快餐
    20050200|11010200
    分类,多个分类及分类编码用|隔开 (分类编码提示参见分类提示接口
    city 默认为全国
    city=北京
    city=110000
    查询城市
    可输入城市名或行政区划分代码(adcode),指定此参数表示在指定的城市查询
    center
    中心点:用于距离计算;当没有bounds时,对于一框搜,用于确定请求城市。
    bounds
    2个坐标点
    图面的左下右上点:当没有city时,用于确定请求城市
    output json json或xml
    输出格式为json或者xml(目前暂不支持xml)
    detail_level DETAIL_REGULAR
    默认
    DETAIL_REGULAR。 DETAIL_BRIEF:返回poi基础信息,如名称、地址等; DETAIL_REGULAR:增加返回poi其他信息,如团购信息、子poi信息等; DETAIL_VERBOSE:增加返回poi全量的深度信息,如小区的多边形等;
    start 0
    返回结果起始位置,默认为0
    adcode_type 0 0 或 1
    输入输出行政区编码类型
    0 凯立德标准编码
    1 国际标准编码
    count 10
    返回结果数,默认为10
    callback
    回调函数
    callback值是用户定义的函数名称,此参数只在output=json时有效
  • 请求示例
    https://api.careland.com.cn/api/v2/search/keyword?center=116.219559,39.842716&keyword=肯德基&city=北京&detail_leve=DETAIL_BRIEF&xytype=2&count=2&ak=<您的密钥>
    返回结果示例
    {
      "errorCode": 0,
      "errorMessage": "ok",
      "type": "RESULT_SEARCH",
      "count": 2,
      "pois": [
    	{
    	  "id": "12202833",
    	  "name": "肯德基(杜家坎DT餐厅)",
    	  "address": "北京市丰台区杜家坎南路1-7",
    	  "haspcd": true,
    	  "pcd": {
    		"adcode": 10106,
    		"province": "",
    		"province_code": 0, 
    		"city_code": 10000,
    		"city": "北京市",
    		"district": "丰台区"
    	  },
    	  "tel_num": [],
    	  "hasxy": true,
    	  "xy": {
    		"x": 116.208709,
    		"y": 39.841868
    	  },
    	  "type_code": 11030200,
    	  "type_name": "肯德基",
    	  "road_id": 0,
    	  "distance": 930,
    	  "preferred": true,
    	  "shapes_flag": false,
    	  "hassubpois": false,
    	  "hasdeepinfo": false,
    	  "routingpointscount": 0,
    	  "hasshapes": false
    	},
    {
    	"id": "606032",
    	"name": "肯德基(美域家园餐厅)",
    	"address": "北京市丰台区美域家园北区3号楼首层",
    	"haspcd": true,
    	"pcd": {
    		"adcode": 10106,
    		"province": "",
    		"province_code": 0,
    		"city_code": 10000,
    		"city": "北京市",
    		"district": "丰台区"
    	},
    	"tel_num": [],
    	"hasxy": true,
    	"xy": {
    		"x": 116.208709,
    		"y": 39.841868
    	},
    	"type_code": 11030200,
    	"type_name": "肯德基",
    	"road_id": 0,
    	"distance": 4659,
    	"preferred": true,
    	"shapes_flag": false,
    	"hassubpois": false,
    	"hasdeepinfo": false,
    	"routingpointscount": 0,
    	"hasshapes": false
       }
    ],
      "info": {
    	"showMap": false,
    	"bounds": [
    	  {
    		"x": 116.208709,
    		"y": 39.841868
    	  },
    	  {
    		"x": 116.252286,
    		"y": 39.876269
    	  }
    	]
      }
    }
    	
    返回参数说明
    如果关键字是行政区,则返回Json中增加了 行政区位置location和行政区形状shapes返回信息。
  • 名称 类型 说明
    errorCode String 错误代码
    errorMessage String 错误代码
    count String 返回记录数
    pois Object[] 返回的POI信息(仅包含id,名称,地址,PCD信息及坐标),或其他信息(包括公交线路信息、地址信息或其他信息),非POI信息的判断标准为是否包含POIID
    id String 选填 POI ID
    name Object 选填 POI名称
    pcd String 返回结果所在的省市区
    adcode String 行政区划代码
    province String 省、直辖市名称
    province_code Int 省、直辖市代码
    city_code In 地市代码
    city String 地市名称
    district String 县区名称
    address String 选填 地址信息
    tel_num String 重复 电话信息
    xy Object 选填 POI的经纬度坐标
    x String 经度
    y String 纬度
    type_code String POI 类型代码
    type_name String POI 类型名称
    road_id String 道路ID
    distance String 到指定点的距离
    preferred boolean 是否推荐显示
    sub_pois poi[] 重复 该POI包含的子POI信息
    deep_info 列表页用到的深度信息
    rating String POI的用户综合评分,通常来自BD数据,例如携程、点评
    price String 人均消费价格
    tag String 个性标签,例如适合情侣用餐,提供WIFI等
    has_group_buy boolean 是否有团购信息
    restaurant_reservation boolean 是否可订餐
    theater_reservation boolean 是否可订座
    business_hour boolean 该POI的营业时间
    book_button boolean 是否有预订按钮
    book_name String 预订按钮的名字
    book_url String 点击预订按钮跳转的url
    activity String 活动信息,比如有几条团购,最低打几折,道路:路况,可带颜色,语法同price
    has_wifi String 是否有wifi
    can_park String 是否可停车
    image String 主图片url
    deep_type String 深度信息的类型
    station_type String 充电站类型(开放类型) 公共,专用,自用
    routing_points 导航点
    x String 经度
    y String 纬度
    shapes String[] 重复 该POI的点、线、面数据描述线与面的点集,diff为当前点与上一点的差值。x_diff与y_diff必须一一对应
    base Object 基准点经纬度坐标
    x String 经度
    y String 纬度
    x_diff String 较上一个坐标点的经度差值
    x_diff String 较上一个坐标点的经度差值
    ......
    y_diff String 较上一个坐标点的纬度差值
    y_diff String 较上一个坐标点的纬度差值
    ......
    deep_detail Object 详情页用到的深度信息(暂不提供)
    info Object 其他信息,例如地图展现等
    show_map boolean 是否显示图面
    bounds Object[] 建议的显示范围,返回左下、右上两个坐标值
    x String 经度
    y String 纬度
    location Object 关键字是行政区则返回行政区位置location
    p Object 选填 POI的XY坐标
    x String X坐标
    y String Y坐标
    precise boolean 是否精确查询
    pcd String 返回结果所在的省市区
    adcode String 行政区划代码
    province String 省、直辖市名称
    city String 地市名称
    district String 县区名称
    matched String 匹配行政区
    name String 行政区名称
    level String GEO_CITY市级、GEO_COUNTY县级
    shapes String 关键字是行政区则返回行政区形状shapes 该POI的点、线、面数据 描述线与面的点集,diff为当前点与上一点的差值。x_diff与y_diff必须一一对应
    base Object 基准点经纬度坐标。
    x String 经度
    y String 纬度
    x_diff String 较上一个坐标点的经度差值。
    x_diff String 较上一个坐标点的经度差值。
    ......
    y_diff String 较上一个坐标点的纬度差值。
    y_diff String 较上一个坐标点的纬度差值。
  • 注意:如果关键字是行政区,则返回Json中增加了行政区位置location和行政区形状 shapes返回信息,非行政区无此信息。
    https://api.careland.com.cn/api/v2/search/keyword?ak=<您的密钥>&city=440300&keyword=丽水
    {
    "errorCode": 0, 
    "errorMessage": "ok", 
    "count": 0, 
    "pois": [ ], 
    "location": {
    	"p": {
    		"x": 432054993, 
    		"y": 102720880
    	}, 
    	"range": 0, 
    	"precise": false, 
    	"pcd": {
    		"adcode": 331100, 
    		"province": "浙江省", 
    		"city": "丽水市", 
    		"district": ""
    	}, 
    	"matched": [
    		{
    			"name": "丽水市", 
    			"level": "GEO_CITY"
    		}
    	], 
    	"shapes": [
    		{
    			"x_diff": [
    				"-74952.000000", 
    				"-55670.400000", 
    				"302.400000", 
    				"5684.400000", 
    				"17211.600000"
    			],                 
    		"y_diff": [
    				"-74952.000000", 
    				"-55670.400000", 
    				"302.400000", 
    				"5684.400000", 
    				"17211.600000"
    			], 
    
    			"base": {
    				"x": 427927993, 
    				"y": 101927156
    			}
    		}
    	], 
    	"confidence": 1
    }, 
    "info": {
    	"showMap": true, 
    	"bounds": [
    		{
    			"x": 430521253, 
    			"y": 101185549
    		}, 
    		{
    			"x": 433590987, 
    			"y": 104255283
    		}
    	]
    }}