概述

该服务支持按照中心点位置和检索半径进行检索,半径最大支持3000米,返回周边相关的POI信息。例如搜索首都师大附中附近半径1000米内的商场(一个圆形范围)。

服务地址

请求方式:GET请求

域名/IP地址+/ws/place/v1/search

请求参数

参数 必填 说明 示例
keyword 定义:搜索关键字,长度最大96个字节,:keyword仅支持检索一个。
(API采用UTF-8字符编码,1个英文字符占用1个字节,
1个中文字符占3个字节,具体请参阅相关技术资料)
keyword=酒店,注意键值要进行URL编码(推荐encodeURI),如
keyword=%e9%85%92%e5%ba%97
boundary 主参数定义:范围
取值:
boundary=nearby(lat,lng,radius[, auto_extend])
子参数定义:
lat,lng:搜索中心点的经纬度,格式顺序为纬度在前,经度在后
radius:搜索半径,单位:米,取值范围:10到1000
auto_extend:[可选] 当前范围无结果时,是否自动扩大范围,取值:
0 不扩大
1 [默认] 自动扩大范围(依次按照按1公里、2公里、5公里,
最大到全城市范围搜索)
boundary=nearby(28.681114,115.918377,1000,1)
get_subpois 是否返回子地点,如大厦停车场、出入口等取值:
0 [默认]不返回
1 返回
get_subpois=1
filter 定义:筛选条件
取值:
1. 指定分类筛选,语句格式为:
category=分类名1,分类名2
最多支持5个分类词(支持的分类请参考:POI分类表
2. 排除指定分类,语句格式为:
category<>分类名1,分类名2
最多支持5个分类词(支持的分类请参考:POI分类表
3. 筛选有电话的地点:tel<>null
搜索指定分类
filter=category=公交站
搜索多个分类
filter=category=大学,中学
排除指定分类
filter=category<>商务楼宇
筛选有电话的地点
filter=tel<>null
(注意参数值要进行url编码)
orderby 排序,支持按距离由近到远排序(当检索词为类别的时候)
取值:_distance
说明:
1. 周边搜索默认排序会综合考虑距离、权重等多方面因素
2. 设置按距离排序后则仅考虑距离远近,一些低权重的地点可能因距离近排在前面,导致体验下降
orderby=_distance
page_size 每页条目数,最大限制为20条,默认为10条 page_size=10
page_index 第x页,默认第1页 page_index=2
output 返回格式:
支持JSON/JSONP,默认JSON
output=json
callback JSONP方式回调函数 callback=function1

响应结果

名称 类型 必填 说明
status number 状态码,0为正常,其它为异常,详细请参阅状态码说明
message string 状态说明
count number 本次搜索结果总数,另外本服务限制最多返回200条数据(data),
翻页(page_index)超过搜索结果总数 或 最大200条限制时,将返回最后一页数据。
data array 搜索结果POI(地点)数组,每项为一个POI(地点)对象
id string POI(地点)唯一标识
title string POI(地点)名称
address string 地址
tel string 电话
category string POI(地点)分类
type number POI类型,值说明:0:普通POI / 1:公交车站 / 2:地铁站 / 3:公交线路 / 4:行政区划
location object 坐标
lat number 纬度
lng number 经度
_distance number 距离,单位: 米,在周边搜索、城市范围搜索传入定位点时返回
ad_info object 行政区划信息
adcode number 行政区划代码,详见:行政区划代码说明
province string
city string 市,如果当前城市为省直辖县级区划,此字段会返回为空,由district字段返回。
注:省直辖县级区划adcode第3和第4位分别为9、0,如济源市adcode为419001
district string

调用示例

//GET请求示例,注意参数值要进行URL编码
//周边搜索(圆形范围):boundary=nearby(lat,lng<中心坐标>,radius<半径/米>)
域名/IP地址+/ws/place/v1/search?boundary=nearby(28.5055549843 1189,121.41164053470072,2000)&keyword=美食

响应示例

{
    "status": 0,
    "message": "成功",
    "count": 317,
    "data": [
        {
            "title": "东门烤鸭店(故宫店)",
            "type": 0,
            "location": {
                "lat": 39.915357,
                "lng": 116.402702
            },
            "id": "1376521901188575736",
            "address": "北京市东城区东华门大街91号",
            "tel": "010-85186899;010-65281089;13661334373",
            "category": "美食:中餐厅:北京菜",
            "ad_info": {
                "adcode": 110101,
                "province": "北京市",
                "city": "北京市",
                "district": "东城区"
            },
            "_distance": 159.06
        },
        {
            "title": "81号家常菜(东华门店)",
            "type": 0,
            "location": {
                "lat": 39.915348,
                "lng": 116.403221
            },
            "id": "17337501500206448195",
            "address": "北京市东城区东华门大街81号",
            "tel": "13671096906",
            "category": "美食:小吃快餐",
            "ad_info": {
                "adcode": 110101,
                "province": "北京市",
                "city": "北京市",
                "district": "东城区"
            },
            "_distance": 188.28
        }
     //...省略更多
    ],
    "region": {
        "title": "中国"
    }
}