POI搜索
关键字搜索
服务介绍
根据输入关键字或者类型查询相关地点查询信息
接口地址
/restapi/search/v1/text
请求方式
GET
请求参数
关键字搜索说明请参见下表:
参数名 | 类型 | 含义 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
ak | string | 开发者密钥 | 是 | ||
guid | string | 设备id | 否 | ||
kw | string | 关键字 | 是 | 若搜索的词语在当前城市无结果,且城市分布中无出类拔萃的结果,则返回省份列表信息; | |
city | string | 查询城市 | 是 | 搜索行政区域的adcode/名称,示例“北京市” | |
lonlat | string | 当前位置经纬度 | 否 | 如果该字段值为空,则获取当前城市中心点 | |
exinfo | int | 返回poi信息控制 | 否 | 1 | 默认1,取值范围:1:返回基本信息;2:返回POI详细信息 3:返回POI详细信息,但不返回子POI信息 |
sort | string | 排序 | 否 | 取值范围:(POI类型) | |
psize | int | 每页记录数 | 否 | 15 | 默认15,小于1按1处理,大于15按15处理 |
pnum | int | 当前页 | 否 | 1 | 默认返回第1页,小于1按1处理,大于20按20处理 |
inGb | string | 输入的坐标系 | 否 | g02 | 默认:g02, |
outGb | string | 输出的坐标系 | 否 | g02 | 默认:g02, |
language | string | 语言类型 | 否 | 默认:ch |
响应数据
名称 | 类型 | 含义 | 备注 | |||||
---|---|---|---|---|---|---|---|---|
status | int | 返回状态 | 详情参照状态码表 | |||||
msg | string | 返回状态描述 | 详情参照状态码表 | |||||
data | object | 返回的结果 | ||||||
total | int | 检索的结果总数 | ||||||
ftype | string | 获取筛选排序配置信息的标识 | 默认:0 | |||||
provs | array | 返回省份分布结果列表 | ||||||
pnm | string | 省份名字 | ||||||
lonlat | string | 中心点经纬度 | 省级行政区域的中心点(是指整个省的行政区域中心点),经度和纬度用","分隔 | |||||
adcode | string | 省份的区域编码 | ||||||
num | int | 省份的分布数量 | ||||||
count | int | 省份下的城市数量 | ||||||
cities | array | 省份下的城市分布结果列表 | ||||||
cnm | string | 城市名称 | ||||||
lonlat | string | 中心点经纬度 | 城市中心点(是指城区的中心点),经度和纬度用","分隔 | |||||
adcode | string | 该城市的adcode | 6位国标码 | |||||
num | int | 总数 | 该城市包含此关键字的个数 | |||||
pois | array | 返回的POI信息列表 | ||||||
pid | string | poi唯一ID | 可用于地点详情检索 | |||||
nm | string | poi名称 | ||||||
snm | string | Poi名称简称 | 子poi信息才会返回值 | |||||
lonlat | string | poi经纬度 | ||||||
nlonlat | string | 导航经纬度 | 用于导航,经度和纬度用“,”分隔 | |||||
addr | string | poi地址信息 | ||||||
prov | string | 所属省份 | ||||||
city | string | 所属城市 | ||||||
dist | string | 所属区县 | ||||||
phone | string | 该POI的电话 | ||||||
tp | string | 所属类型名称 | ||||||
tcode | string | 所属类型编码 | ||||||
dis | string | 离中心点距离 | ||||||
brand | string | 品牌 | ||||||
tag | string | 标签 | 标签,多个标签之间用","分隔, | |||||
photo | string | 图片URL列表,多张图片之间用”;”分隔 | ||||||
rinfo | string | 简介 | ||||||
extend | object | poi的扩展信息 | 仅当exinfo=2或3时,显示该字段,不同的poi类型,显示的内容不一样 | |||||
price | string | poi商户价格 | 取值范围: | |||||
taste | string | 口味 | ||||||
service | string | 服务 | 取值范围: | |||||
envi | string | 环境 | ||||||
score | float | 评分 | ||||||
time | string | 营业时间 | ||||||
faci | string | 设施 | 多个之间用逗号分隔,建议最多3个。示例:"1,2,3,5" | |||||
rank | string | 星级 | 艺龙酒店类特有说明,当返回值为0时艺龙酒店对外显示可用reco的值,但请进行图标区分 | |||||
reco | string | cp推荐信息 | 取值范围: | |||||
cpid | string | 合作方id | 合作方数据,按tcode进行数据融合 | |||||
cpnm | string | 合作方名字 | 合作方数据,按tcode进行数据融合 | |||||
cpurl | string | 合作方官方网址 | ||||||
status | int | 停车场或加油站状态 | 和tcode配合使用: | |||||
total | int | 车位总数 | 和tcode配合使用: | |||||
sfree | int | 空车位数 | (仅停车场相关poi返回,返回值为-1,表示未知) | |||||
model | int | 充电站类别 | 1表示标准充电、2表示中速充电、3表示快速充电,多个充电器类别之间用"|"分隔(该字段已废弃,建议使用sinfo字段) | |||||
payment | string | 支付方式 | tcode=停车场、加油站、充电桩类型时有效 | |||||
zcode | string | 邮编 | tcode=汽车类型时有效 | |||||
ebnum | int | 换电箱数量 | tcode=充电站类型时有效 | |||||
ptype | string | 插头规格 | 插头规格(港澳),11表示3孔家用、12表示7孔欧式单相电、21表示7孔欧式三相电、22表示5孔美式、23表示3孔家用、31表示日本CHAdeMO标准插头,多个插头规格之间用"|"分隔 | |||||
parknum | string | 电动车停车泊位号 | tcode=充电站类型时有效 | |||||
fee | string | 收费标准 | tcode=停车场类型时有效 | |||||
ftext | string | 收费信息 | tcode=停车场类型时有效 | |||||
tollway | string | 收费方式 | tcode=停车场类型时有效 | |||||
ports | array | 停车场出入口列表 | tcode=停车场类型时有效 | |||||
dir | string | 出入口方向 | ||||||
lonlat | string | 经纬度坐标 | 经度和纬度用","分隔 | |||||
type | int | 出入口类型 | 0 表示入口、1 表示出口、2 表示出入口 | |||||
sinfo | array | 充电桩设备列表 | tcode=充电站类型有效 | |||||
etype | int | 设备类型 | 1:直流设备 | |||||
ctotal | int | 充电桩总数 | ||||||
cftotal | int | 充电桩空闲数 | ||||||
childrens | array | 子POI信息列表 | 若poi无子点,该字段为空 | |||||
tag | object | 子poi标签信息 | ||||||
tnm | string | 标签名称 | ||||||
pois | array | 子poi信息列表 | ||||||
dist | object | 行政区域切换信息 | (搜索结果为城市跳转返回该信息) | |||||
parents | string | 父行政区名称列表 | 多个名称之间用”|”分隔 | |||||
nm | string | 名称 | ||||||
adcode | string | 区域编码 | ||||||
lv | int | 行政区域级别 | 0:国家、1:省、2:市、3:县 | |||||
lonlat | string | 行政区域中心点 | (市级行政区的中心点是城区的中心点),经度和纬度用","分隔 | |||||
lonlats | 行政区域边界 | 所属省份 | 目前只返回最东、最南、最西、最北4个点的经纬度,格式:最东经度,最东纬度;最南经度,最南纬度;最西经度,最西纬度;最北经度,最北纬度 |
服务示例
圆形搜索
服务介绍
根据某个坐标点检索周边相关地点信息(常用于周边检索场景)
接口地址
/restapi/search/v1/around
请求方式
GET
请求参数
圆形搜输入提示说明请参见下表:
参数名 | 类型 | 含义 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
ak | string | 开发者密钥 | 是 | ||
guid | string | 设备id | 否 | ||
kw | string | 关键字 | 是 | ||
city | string | 查询城市 | 是 | 搜索行政区域的adcode/名称,示例“北京市” | |
exinfo | int | 返回poi信息控制 | 否 | 1 | 默认1,取值范围: |
lonlat | string | 当前位置坐标 | 是 | 格式:经度,纬度 | |
radius | int | 检索半径 | 否 | 3000 | 单位:米,取值范围:0-50000。规则:大于50000按默认值,默认:3000 |
sort | string | 排序 | 否 | 取值范围:(POI类型) | |
inGb | string | 输入的坐标系 | 否 | g02 | 默认:g02, |
outGb | string | 输出的坐标系 | 否 | g02 | 默认:g02, |
psize | int | 每页记录数 | 否 | 15 | 默认15,小于1按1处理,大于15按15处理 |
pnum | int | 当前页 | 否 | 1 | 默认返回第1页,小于1按1处理,大于20按20处理 |
language | string | 语言类型 | 否 | 默认:ch |
响应数据
返回结果字段说明见关键字搜索。
服务示例
矩形搜索
服务介绍
检索坐标对应多边形内的地点信息(常用于手机或PC端地图视野内检索)
接口地址
/restapi/search/v1/polygon
请求方式
GET
请求参数
矩形搜输入提示说明请参见下表:
参数名 | 类型 | 含义 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
ak | string | 开发者密钥 | 是 | ||
guid | string | 设备id | 否 | ||
kw | string | 关键字 | 是 | ||
city | string | 查询城市 | 是 | 搜索行政区域的adcode/名称,示例“北京市” | |
exinfo | int | 返回poi信息控制 | 否 | 1 | 默认1,取值范围: |
lonlats | string | 矩形坐标串 | 是 | 规则:经度和纬度用","分隔,坐标对用";"分隔。传入左上右下两顶点坐标对 | |
sort | string | 排序 | 否 | 取值范围:(POI类型) | |
inGb | string | 输入的坐标系 | 否 | g02 | 默认:g02, |
outGb | string | 输出的坐标系 | 否 | g02 | 默认:g02, |
psize | int | 每页记录数 | 否 | 15 | 默认15,小于1按1处理,大于15按15处理 |
pnum | int | 当前页 | 否 | 1 | 默认返回第1页,小于1按1处理,大于20按20处理 |
language | string | 语言类型 | 否 | 默认:ch |
响应数据
返回结果字段说明见关键字搜索。
服务示例
沿途搜索
服务介绍
检索路径周边的地点信息(常配合路径规划接口使用)
接口地址
/restapi/search/v1/line
请求方式
GET
请求参数
沿途搜索输入提示说明请参见下表:
参数名 | 类型 | 含义 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
ak | string | 开发者密钥 | 是 | ||
guid | string | 设备id | 否 | ||
kw | string | 关键字 | 是 | ||
lonlats | string | 多边形坐标串 | 是 | 规则:经度和纬度用","分隔,坐标对用";"分隔。经纬度至少2对以上 | |
city | string | 查询城市 | 是 | 搜索行政区域的adcode/名称,示例“北京市” | |
sort | string | 排序 | 否 | 取值范围:(POI类型) | |
exinfo | int | 返回poi信息控制 | 否 | 1 | 默认1,取值范围: |
limit | int | 路线长度 | 否 | 20000 | 单位是米,默认20000米,当lonlats参数所指定的线路长度大于该参数时,以起点开始截取该参数所指定的线路长度进行沿线路搜索,小于1按20000处理,大于20000按20000处理 |
radius | int | 搜索半径 | 否 | 单位:米,取值范围:1-10000。默认3000米 | |
inGb | string | 输入的坐标系 | 否 | g02 | 默认:g02, |
outGb | string | 输出的坐标系 | 否 | g02 | 默认:g02, |
psize | int | 每页记录数 | 否 | 15 | 默认15,小于1按1处理,大于15按15处理 |
pnum | int | 当前页 | 否 | 1 | 默认返回第1页,小于1按1处理,大于20按20处理 |
language | string | 语言类型 | 否 | 默认:ch |
响应数据
返回结果字段说明见关键字搜索。
服务示例
详情查询
服务介绍
根据poi唯一标识,查询POI详细信息
接口地址
/restapi/search/v1/detail
请求方式
GET
请求参数
地点详情查询输入提示说明请参见下表:
参数名 | 类型 | 含义 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
ak | string | 开发者密钥 | 是 | ||
guid | string | 设备id | 否 | ||
id | string | POI唯一id | 是 | ||
exinfo | int | 返回poi信息控制 | 否 | 1 | 默认1,取值范围: |
outGb | string | 输出的坐标系 | 否 | g02 | 默认:g02, |
language | string | 语言类型 | 否 | 默认:ch |
响应数据
返回结果字段说明见关键字搜索。
服务示例
合作方信息查询
服务介绍
根据cpid,cpnm查询第三方酒店、景点、美食、停车场等深度信息
接口地址
/restapi/search/v1/cpdetail
请求方式
GET
请求参数
合作方详情检索输入提示说明请参见下表:
参数名 | 类型 | 含义 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
ak | string | 开发者密钥 | 是 | ||
guid | string | 设备id | 否 | ||
cpid | string | cp唯一标识 | 是 | ||
cpnm | string | cp名称 | 是 | ||
adate | string | 入住日期 | 否 | 大于等于昨天。如果入住的时间为凌晨,那么传入前一天的日期。格式:yyyy-MM-dd示例:2018-11-18(酒店信息查询专用字段) 默认值 | |
ddate | string | 离店日期 | 否 | 至少晚于到店时间1天,不多于30天,格式:yyyy-MM-dd示例:2017-11-19(酒店信息查询专用字段) 默认值 | |
exinfo | int | 返回信息控制 | 否 | 1 | 默认1,取值范围: |
outGb | string | 输出的坐标系 | 否 | g02 | 默认:g02, |
响应数据
名称 | 类型 | 含义 | 备注 | ||
---|---|---|---|---|---|
status | int | 返回状态 | 详情参照状态码表 | ||
msg | string | 返回状态描述 | 详情参照状态码表 | ||
data | object | 返回的结果 | |||
cpid | string | cp唯一ID | |||
cpnm | string | cp名称 | |||
lonlat | string | 经纬度 | |||
addr | string | 地址信息 | |||
city | string | 所属城市 | |||
phone | string | 电话 | |||
otime | string | 营业时间 | |||
type | string | cp | 返回值说明: hotel:酒店、cater:美食、scenery:景点、parking:停车场、charge:充电站、gas:加油站(暂时不支持) | ||
rinfo | string | cp简介 | |||
rimgurl | int | cp封面图 | |||
faci | string | 设施 | 仅酒店和美食有数据返回 | ||
rec | array | cp推荐信息 | type=scenery,返回购票须知(仅景点有数据返回) | ||
rimgurls | array | cp图片集 | 最多5个 | ||
extend | object | cp的扩展信息 | 仅当exinfo =2时,显示该字段,不同的cp类型,显示的内容不一样 | ||
detail | cp扩展信息 | cp扩展信息的具体字段,参见下面的文档 |
美食:cpinfo 中type= cater(美食)时detail 字段格式
名称 | 类型 | 含义 | 备注 | |
---|---|---|---|---|
deals | array | 团购信息列表 | ||
id | string | 团购id | ||
name | string | 团购名称 | ||
oprice | float | 原价 | ||
price | float | 团购价格 | ||
stime | string | 开始时间 | ||
etime | string | 结束时间 | ||
snums | int | 销量 | ||
score | string | 评分 | 0-5分,精度0.1 | |
link | string | pc前端页面 | cp下单页面 | |
comment | array | 评论信息 | 最多5条 | |
tating | int | 评分 | 取值范围0-50,除以10转成评分 | |
content | string | 内容 | ||
time | long | 时间戳 | ||
imgurls | string | 评论图片 | 最多5个,多张图片之间用";"间隔 |
酒店:cpinfo 中type= hotel(酒店)时detail 字段格式
名称 | 类型 | 含义 | 备注 | ||
---|---|---|---|---|---|
rooms | array | 房型列表 | |||
rid | string | 展示房型编号 | |||
rnm | string | 房型名称 | |||
picurl | string | 房型封面图片 | 房型封面图片url地址 | ||
area | string | 面积 | |||
btype | string | 床型 | |||
floor | string | 楼层 | |||
bnet | string | 上网情况 | 0-无 | ||
capcity | string | 可容纳人数 | 床位房购买的为床位,与此处的入住人数无关。 | ||
imgurls | array | 房型图片集 | 最多5个 | ||
pros | array | 产品信息列表 | |||
pid | int | 产品编号 | |||
pnm | string | 产品名称 | |||
price | double | 日均价 | |||
isbf | string | 是否含有早餐 | true:含早 | ||
ptype | string | 付款类型 | SelfPay-担保、Prepay-预付 | ||
pdesc | string | 付款类型描述 | |||
link | string | 下单地址 | cp下单页面url | ||
review | object | 评价 | |||
good | int | 好评数 | |||
poor | int | 差评数 | |||
count | int | 评论总数 | |||
score | string | 好评率 | 0-5分,精度0.1 |
景点:seninfo 中type= scenery(景点)时detail 字段格式
名称 | 类型 | 含义 | 备注 | |
---|---|---|---|---|
policys | array | 价格列表 | ||
id | int | 价格策略id | ||
nm | string | 价格策略名称 | ||
putil | int | 产品单元 | ||
putilnm | string | 产品单元名称 | ||
price | double | 门市价格 | 单位:元 | |
tcprice | double | 同城价格 | 单位:元 | |
ptype | int | 付款类型 | 支付方式 0:景区现付 1:在线支付 3:其他支付 | |
time | string | 提前预定时间 | 格式:HH:mm | |
gmode | string | 入园方式 | ||
cltems | string | 景区包含项目 | ||
remark | string | 预定说明 | SelfPay-担保、Prepay-预付 | |
indesc | string | 发票说明 | ||
rerule | string | 退票说明 | ||
link | string | 下单地址 | 预订跳转 |
停车场(喜泊客/ETCP):seninfo 中type= parking(停车场)时detail 字段格式
名称 | 类型 | 含义 | 备注 | |
---|---|---|---|---|
status | string | 停车场当前繁忙状态 | 空/忙/满/关 | |
total | int | 总车位数 | 返回值为-1时,表示无数据返回 | |
sfree | int | 空闲车位数 | 返回值为-1时,表示无数据返回 | |
fee | string | 标准收费 | ||
feew | string | 双休日标准收费 | ||
feeh | string | 节假日标准收费 | ||
pay | string | 收费方式 | POS机/银联卡/支付宝二维码/微信二维码/闪付二维码/手机应用/缴费机 | |
plink | string | 支付链接 | 可还原为二维码 | |
feep | float | 下一个小时预测收费标准 | ||
feelv | int | 标准收费高低 | 0:未知;1:低价;2:中价;3:高价 | |
feex | int | 优惠收费高低 | 0:未知;1:低价;2:中价;3:高价 | |
diff | int | 停车难易度 | 0:未知;1:容易;2:普通;3:困难 | |
recom | int | 停车场综合推荐度 | 0:未知;1:推荐;2:普通;3:不推荐 | |
ports | array | 停车场出入口列表 | ||
nm | string | 出入口名称 | 示例:北清路 | |
lonlats | string | 出入口坐标串 | 格式为”经度1,纬度1; 经度2,纬度2….” | |
type | string | 出入口类型 | 0表示入口、1表示出口、2表示出入口 |
充电站(桩家):seninfo 中type= charge(充电站)时detail 字段格式
名称 | 类型 | 含义 | 备注 | ||
---|---|---|---|---|---|
stype | string | 充电站点类型 | 1:公共 | ||
status | int | 充电站状态 | 0:未知 | ||
pnums | int | 可停放充电车位总数 | |||
cons | int | 建筑物 | 1:居民区 | ||
mcars | string | 描述该站点接受的车大小以及类型 | 如大巴、物流车、私家乘用车、出租车等 | ||
efee | string | 电费 | |||
cfree | int | 是否免费 | 0: 免费 | ||
sfee | string | 充电服务费 | |||
pfee | string | 停车费用 | |||
pfree | int | 是否免费停车 | 0: 免费 | ||
pay | string | 支付方式 | |||
recom | int | 推荐站 | 默认值:2 | ||
sorder | int | 是否支持预约 | 默认值:0 | ||
einfos | array | 设备信息列表 | |||
eid | string | 设备唯一编码 | |||
egun | int | 是否带充电枪 | 默认值:2 | ||
etype | int | 设备类型 | 1:直流设备 | ||
lonlat | string | 设备经纬度 | |||
power | int | 功率 | |||
ename | string | 充电设备接口名称 | |||
cinfos | array | 充电设备信息列表 | |||
cid | string | 充电设备接口编码 | |||
cname | string | 充电设备接口名称 | |||
ctype | int | 插口类型 | 1:家用插座(模式2) | ||
vulimits | int | 最高电压,单位:V | |||
vllimits | int | 最低电压,单位:V | |||
current | int | 充电电流 | |||
power | int | 功率 | |||
status | int | 桩状态 | 0:离网 | ||
parkno | string | 停车场位置编号 |
服务示例
类型筛选项
服务介绍
根据poi类型,返回该类型所支持的筛选项信息。(用于poi二次搜索)
接口地址
/restapi/search/v1/config
请求方式
GET
请求参数
类型筛选项输入提示说明请参见下表:
参数名 | 类型 | 含义 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
ak | string | 开发者密钥 | 是 | ||
guid | string | 设备id | 否 | ||
ftype | string | 数据类型 | 是 | 目前只支持如下类型: |
返回参数
名称 | 类型 | 含义 | 备注 | |||
---|---|---|---|---|---|---|
status | int | 返回状态 | 详情参照状态码表 | |||
msg | string | 返回状态描述 | 详情参照状态码表 | |||
data | object | 返回的结果 | ||||
total | int | 配置项的数量 | ||||
configs | array | 配置项列表 | ||||
nm | string | 配置项名称 | 范围筛选、类型/品牌筛选、排序选择 | |||
pnm | string | 配置项对应搜索方式名称 | 取值范围: | |||
content | array | 配置项内容 | ||||
detail | string | 配置项内容详细信息 |
configs 中pnm= kws 且(类型为餐饮/汽车)时detail 字段格式
名称 | 类型 | 含义 | 备注 |
---|---|---|---|
code | string | 类型编码 | |
nm | string | 类型名称 | |
categories | array | 子类列表 | 数据结构和父类一致 |
configs 中pnm 等于其他类型时detail 字段格式
名称 | 类型 | 含义 | 备注 |
---|---|---|---|
nm | string | 类型名称 | |
value | string | 类型值 | |
isdef | int | 是否是默认值 | 1:默认值,0:非默认 |
服务示例