文档
测试

3.地址检索poi

POST
https://openapi-pre.huolala.cn/api/e-city-search

服务入口

测试环境:https://openapi-pre.huolala.cn/api/e-city-search 正式环境:https://openapi.huolala.cn/api/e-city-search

编码

数据编码: Accept:application/json Content-type: application/json 字符编码: utf-8

前端UI参考

![image.png](https://cos.easydoc.net/48578360/files/k9xst4ew)

公共请求参数

参数名
类型
描述
必填
app_key
string
开发者应用唯一标识
必填
access_token
string
货拉拉用户授权给开发者应用访问账户的令牌码
必填
nonce_str
string
随机数,用户自定义,60s内不可重复使用,仅用于保证签名不可预测;示例:474
必填
timestamp
string
Unix时间戳(单位:秒),60s内有效,超过60s则超时;示例:1565225482
必填

应用级请求参数

参数名
类型
描述
必填
kw
string
搜索关键字 如:深圳北站
必填
city
string
搜索城市(中文名称), 如:深圳
可选

响应参数

参数名
类型
描述
必填
ret
int
返回结果码, 示例:0
必填
msg
string
返回结果描述, 示例:Success
必填
data
object
数据字典
必填
poi
array
地址POI数据列表
必填
uid
string
地址uid
必填
name
string
地址名称,示例:深圳北站
必填
address
string
地址详情,示例:深圳市⻰华区致远中路28号
必填
city
string
地址所属城市名称, 示例:深圳市
必填
city_id
int
地址所属城市ID,示例:1002
必填
area
string
地址所属区(县),示例:⻰华区
必填
distance
string
距离(将返回与输入参数中经纬度的距离,如果输入参数中没有传经纬度 则返回空)
必填
location
object
地址经纬度(wgs84坐标系)
必填
lat
double
示例:22.572225758622768
必填
lon
double
示例:114.05484818497911
必填
children
array
可选子节点地址
必填
name
string
子节点地址名称, 示例:a口
必填
address
string
子节点地址详情, 示例:上梅林地铁站-A口
必填
location
object
子节点地址经纬度(wgs84坐标系)
必填
lat
double
示例:22.57354699223282
必填
lon
double
示例:114.05445635190402
必填
uid
string
示例:d22766de8fd188a254bfffda
必填

request Body请求示例

```json { "app_key":"*****************", "access_token":"*******************", "nonce_str":"8sZD2c7raj", "timestamp":1564022849, "kw":"卓悦汇" } ```

response响应示例

```json { "ret": 0, "data": { "poi": [ { "area": "福田区", "uid": "8d610da46e66da8ecf06a449", "address": "4号线;9号线", "distance": "", "api_type": 1, "city": "深圳市", "children": [ { "address": "上梅林地铁站-A口", "location": { "lat": 22.57354699223282, "lon": 114.05445635190402 }, "name": "a口", "uid": "d22766de8fd188a254bfffda" }, { "address": "上梅林地铁站-B口", "location": { "lat": 22.57355325261148, "lon": 114.05425059027392 }, "name": "b口", "uid": "3c3647dc0078618b8505bfd4" }, { "address": "上梅林地铁站-J1口", "location": { "lat": 22.571299859961048, "lon": 114.05620685330615 }, "name": "j1口", "uid": "2c37035acf98677e306212f5" }, { "address": "上梅林地铁站-C口", "location": { "lat": 22.57281247373533, "lon": 114.05423831232916 }, "name": "c口", "uid": "5cbf0144377370914354d725" }, { "address": "上梅林地铁站-G口", "location": { "lat": 22.571019660227975, "lon": 114.05448978355437 }, "name": "g口", "uid": "abcf34e3298d022107fef538" }, { "address": "上梅林地铁站-D口", "location": { "lat": 22.572818211078793, "lon": 114.05444506075415 }, "name": "d口", "uid": "fae6de13c2e960a02b02e1b7" } ], "name": "上梅林", "location": { "lat": 22.572225758622768, "lon": 114.05484818497911 }, "tag": "地铁站", "type": "", "city_id": 1002 }, { "area": "福田区", "uid": "4d5f4227d7f3683fd5b74e69", "address": "福田区", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "上梅林", "location": { "lat": 22.570998572378873, "lon": 114.05455572903412 }, "tag": "商圈", "type": "life", "city_id": 1002 }, { "area": "福田区", "uid": "e4467d4501d0046e25e0a008", "address": "n9路", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "上梅林", "location": { "lat": 22.567203273389424, "lon": 114.05011200576725 }, "tag": "公交车站", "type": "", "city_id": 1002 }, { "area": "福田区", "uid": "ff666df82cabb80bd8eced8f", "address": "广东省深圳市福田区梅村路", "distance": "", "api_type": 1, "city": "深圳市", "children": [ { "address": "上梅林新村-南门", "location": { "lat": 22.567430467961586, "lon": 114.05021753719015 }, "name": "南门", "uid": "4c0e42ca9b9248f40682c285" }, { "address": "上梅林新村-西门", "location": { "lat": 22.568521267484787, "lon": 114.0489173243696 }, "name": "西门", "uid": "7095c9c6cfe4b9607ec876bc" }, { "address": "上梅林新村-停车场", "location": { "lat": 22.56741393042804, "lon": 114.05000201749094 }, "name": "停车场", "uid": "bf6a0c93cc31629dc51b75d3" }, { "address": "上梅林新村-地上停车场", "location": { "lat": 22.568580230465365, "lon": 114.04951885298239 }, "name": "地上停车场", "uid": "15472e2e09eecd6f276e98bd" }, { "address": "上梅林新村-东停车场", "location": { "lat": 22.569499797388392, "lon": 114.05201889308411 }, "name": "东停车场", "uid": "4360c4ddae347dd603ff2d71" } ], "name": "上梅林新村", "location": { "lat": 22.568632583560532, "lon": 114.04964251795718 }, "tag": "房地产;住宅区", "type": "house", "city_id": 1002 }, { "area": "福田区", "uid": "6c8d1911c7dc4b206da3cc75", "address": "44路;60路;102路;216路;218路;222路;324路;328路;b912路;n12路;n6路;n9路", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "上梅林市场", "location": { "lat": 22.56719783770558, "lon": 114.05278707112305 }, "tag": "公交车站", "type": "", "city_id": 1002 }, { "area": "福田区", "uid": "22d2c12139342d808afc0604", "address": "广东省深圳市福田区", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "上梅林西横街", "location": { "lat": 22.568587047679575, "lon": 114.04327718517462 }, "tag": "道路", "type": "", "city_id": 1002 }, { "area": "福田区", "uid": "dbba1c569ec078191f3894ad", "address": "梅华路32-16号", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "上梅林大市场", "location": { "lat": 22.567536405150754, "lon": 114.05206588217273 }, "tag": "购物;市场", "type": "shopping", "city_id": 1002 }, { "area": "福田区", "uid": "50fb64ff016ef15de9f85311", "address": "深圳市福田区梅林路123号", "distance": "", "api_type": 1, "city": "深圳市", "children": [ { "address": "梅林阁-地下停车场", "location": { "lat": 22.570356786583105, "lon": 114.04865605327477 }, "name": "地下停车场", "uid": "be54cde91d63e75878f7963c" }, { "address": "梅林阁-东正门", "location": { "lat": 22.57069616236969, "lon": 114.04936900531638 }, "name": "东正门", "uid": "ffea2b77e67b99cec26c1418" } ], "name": "福田区上梅林阁", "location": { "lat": 22.570637494982286, "lon": 114.04915855581696 }, "tag": "房地产;住宅区", "type": "house", "city_id": 1002 }, { "area": "福田区", "uid": "10c3e5bc66ee498aeddfcade", "address": "44路;b821路;m579路", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "上梅林公交总站", "location": { "lat": 22.571535212616332, "lon": 114.05386004054905 }, "tag": "公交车站", "type": "", "city_id": 1002 }, { "area": "福田区", "uid": "fa0af548e500f7c3b72655c3", "address": "广东省深圳市福田区梅华路38号", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "上梅林祠堂村", "location": { "lat": 22.56828181541429, "lon": 114.05167677148309 }, "tag": "行政地标;村庄", "type": "life", "city_id": 1002 }, { "area": "福田区", "uid": "0a3fbdb858b3672b1676432c", "address": "广东省深圳市福田区中康路39号附近", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "上梅林公交总站", "location": { "lat": 22.571266351590936, "lon": 114.05378141218884 }, "tag": "交通设施;长途汽车站", "type": "life", "city_id": 1002 }, { "area": "福田区", "uid": "fc271b36bb7a40cf17948e08", "address": "b821路;高快巴士821号", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "上梅林地铁站", "location": { "lat": 22.57336054869453, "lon": 114.05402605041431 }, "tag": "公交车站", "type": "", "city_id": 1002 }, { "area": "福田区", "uid": "f675425970d249c240e192fa", "address": "梅村路与西横街交叉口西南50米", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "上梅林民兵应急分队", "location": { "lat": 22.569541466641986, "lon": 114.0485122500516 }, "tag": "政府机构;行政单位", "type": "life", "city_id": 1002 }, { "area": "福田区", "uid": "b1a08f17daa5f91d56bfffa9", "address": "深圳市福田区上梅林梅村路", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "上梅林牌坊", "location": { "lat": 22.565927751090335, "lon": 114.04884328235713 }, "tag": "行政地标;村庄", "type": "life", "city_id": 1002 }, { "area": "福田区", "uid": "19621e66de798fdec9c3db0f", "address": "44路;m579路", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "上梅林公交总站", "location": { "lat": 22.57156028812199, "lon": 114.05375415453744 }, "tag": "公交车站", "type": "", "city_id": 1002 }, { "area": "福田区", "uid": "feaffd284a07b480a3d23019", "address": "44路;b821路;m579路", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "上梅林公交总站", "location": { "lat": 22.57151112674846, "lon": 114.05396592814762 }, "tag": "公交车站", "type": "", "city_id": 1002 }, { "area": "福田区", "uid": "6deee3081dda2c6a29fc4812", "address": "深圳市福田区梅林路127号", "distance": "", "api_type": 1, "city": "深圳市", "children": [ { "address": "梅林三村-东门", "location": { "lat": 22.570370988899576, "lon": 114.04845054994111 }, "name": "东门", "uid": "01ee38a70851e038704b87c3" }, { "address": "梅林三村-停车场", "location": { "lat": 22.5703532521826, "lon": 114.0485164032673 }, "name": "停车场", "uid": "f696f3c21d269ee81a11d584" }, { "address": "梅林三村-北门", "location": { "lat": 22.57106011903777, "lon": 114.04759806825149 }, "name": "北门", "uid": "ded8f6ffad1e55849cec2bbe" }, { "address": "梅林三村-地下停车场", "location": { "lat": 22.57040447206444, "lon": 114.04832383549005 }, "name": "地下停车场", "uid": "19249d269c34f4b9931fc99c" }, { "address": "梅林三村-南2门", "location": { "lat": 22.569566305328422, "lon": 114.04776415219084 }, "name": "南2门", "uid": "8a10563156170213f7231084" }, { "address": "梅林三村-南1门", "location": { "lat": 22.569703273158346, "lon": 114.04822680373815 }, "name": "南1门", "uid": "ec59b9d911fd7c94eedfca79" } ], "name": "福田区上梅林三村", "location": { "lat": 22.57057892788044, "lon": 114.04774416446146 }, "tag": "房地产;住宅区", "type": "house", "city_id": 1002 }, { "area": "福田区", "uid": "8c449ce6fbe5fe527fc87659", "address": "广东省深圳市福田区", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "北环上梅林天桥", "location": { "lat": 22.56563876699193, "lon": 114.04830593060912 }, "tag": "道路", "type": "", "city_id": 1002 }, { "area": "福田区", "uid": "ad553bc8ace1b0b2f7e73b1d", "address": "福田区梅林街道上梅林祠堂村18号104", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "上梅林芳村煲仔饭", "location": { "lat": 22.568970668562326, "lon": 114.05101228930162 }, "tag": "美食;小吃快餐店", "type": "cater", "city_id": 1002 }, { "area": "福田区", "uid": "d3808ea7c4787d7c26d2bb61", "address": "梅村路上梅林新村160栋", "distance": "", "api_type": 1, "city": "深圳市", "children": [], "name": "大侠烹鸡(上梅林)", "location": { "lat": 22.56838445343823, "lon": 114.05080032348528 }, "tag": "美食;中餐厅", "type": "cater", "city_id": 1002 } ] }, "msg": "Success" } ```

返回状态码

|状态码|描述| |-|-|-| |0|成功| |1|服务器异常|