API 文档 / POI 检索 / POI 多边形区域检索
POI 多边形区域检索
接口说明
POI 多边形区域检索
输入示例:多边形范围:湖州一块区域;关键词:美食;每页 50 条
返回示例:返回多边形范围内的 POI 列表,包含名称、地址、坐标、分类和商圈等信息。
请求地址
GEThttps://cloud.dtbgis.com/api/v1/poi/polygon
鉴权方式
在 HTTP Header 中携带你的 API Key:
X-API-Key: 你的API-Key
每个 Key 绑定已购接口与额度,调用成功扣减 1 次;调用失败(参数错误等)不扣额度。未开通该接口返回 403,额度耗尽返回 429。
请求参数
| 参数 | 必填 | 说明 | 示例 / 默认值 |
|---|---|---|---|
polygon |
必填 | 多边形区域坐标点,格式 "lng1,lat1,lng2,lat2,...,lngn,latn" | 120.283063,30.75784,120.464588,30.918838 |
keywords |
可选 | 搜索关键词,多个关键词用"|"分隔 | — |
types |
可选 | POI分类编码,多个分类用"|"分隔 | — |
page |
可选 | 页码,从1开始 | 1 |
offset |
可选 | 每页记录数,最大100 | 50 |
extensions |
可选 |
返回结果控制,base(基本信息)或all(全部信息)
可选值:
base base、all all |
all |
请求示例
curl -H "X-API-Key: 你的API-Key" \ "https://cloud.dtbgis.com/api/v1/poi/polygon?polygon=120.283063%2C30.75784%2C120.464588%2C30.918838&page=1"
import requests
resp = requests.get(
"https://cloud.dtbgis.com/api/v1/poi/polygon?polygon=120.283063%2C30.75784%2C120.464588%2C30.918838&page=1",
headers={"X-API-Key": "你的API-Key"},
)
print(resp.status_code, resp.json())
fetch("https://cloud.dtbgis.com/api/v1/poi/polygon?polygon=120.283063%2C30.75784%2C120.464588%2C30.918838&page=1", {
headers: { "X-API-Key": "你的API-Key" }
})
.then(r => r.json())
.then(console.log);
返回结果说明
所有接口统一返回 JSON 信封结构:
{
"code": 200,
"msg": "success",
"data": { ... },
"quota_remaining": 9999
}| 字段 | 说明 |
|---|---|
code | 业务状态码,200 表示成功 |
msg | 状态描述,成功为 success |
data | 查询结果对象,字段含义见上方“接口说明” |
quota_remaining | 本接口剩余可用调用次数 |
错误码
错误以统一结构返回:{"detail": {"code": 429, "msg": "..."}}
| HTTP | 含义 | 常见原因 / 处理 |
|---|---|---|
400 | 参数错误 | 缺少必填参数或格式不合法 |
401 | 鉴权失败 | API Key 缺失、不存在、已停用或已过期 |
403 | 权限不足 | 该 Key 未开通此接口,请购买对应额度 |
429 | 额度耗尽 / 限流 | 额度用完需续费;或超过速率(60 秒 200 次) |
404 | 资源不存在 | 路径错误,或查询对象无数据 |
503 | 上游不可用 | 服务商暂时异常,稍后重试 |
完整错误码见 文档首页 · 错误码总览。