AOI 区域边界查询

接口说明

根据 UID 获取 AOI 边界数据

输入示例：地点 UID：af7a23a1c6e2e21cc4257a99

返回示例：返回该地点的 AOI 边界数据，例如商场、园区或景区的面状范围，可用于地图绘制。

请求地址

GEThttps://cloud.dtbgis.com/api/v1/aoi

鉴权方式

在 HTTP Header 中携带你的 API Key：

X-API-Key: 你的API-Key

每个 API Key 绑定已购接口与流量豆，调用成功扣减对应流量豆；调用失败（参数错误等）不扣流量豆。未开通该接口返回 403，流量豆不足返回 429。

请求参数

参数	必填	说明	示例 / 默认值
`uid`	必填	地点 UID，16-24位十六进制字符串	`af7a23a1c6e2e21cc4257a99`

请求示例

curl -H "X-API-Key: 你的API-Key" \
  "https://cloud.dtbgis.com/api/v1/aoi?uid=af7a23a1c6e2e21cc4257a99"

import requests

resp = requests.get(
    "https://cloud.dtbgis.com/api/v1/aoi?uid=af7a23a1c6e2e21cc4257a99",
    headers={"X-API-Key": "你的API-Key"},
)
print(resp.status_code, resp.json())

fetch("https://cloud.dtbgis.com/api/v1/aoi?uid=af7a23a1c6e2e21cc4257a99", {
  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`	查询结果对象，字段见下方「`data` 字段说明」
`quota_remaining`	本次调用后剩余可用流量豆数量

data 为标准 GeoJSON FeatureCollection，坐标系 GCJ-02，可直接用于主流地图。UID 无对应 AOI 时返回 404。示例中坐标数组做了截断示意。

响应示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "properties": {
          "uid": "af7a23a1c6e2e21cc4257a99",
          "name": "望京SOHO"
        },
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [116.47234, 39.99678],
              [116.47456, 39.99712],
              [116.47523, 39.99534],
              [116.47234, 39.99678]
            ]
          ]
        }
      }
    ]
  },
  "quota_remaining": 9997
}

`data` 字段说明

字段	类型	说明	示例
`type`	string	固定值 FeatureCollection	`FeatureCollection`
`features`	array	Feature 数组	—
`type`	string	固定值 Feature	`Feature`
`properties`	object	属性信息，含 uid、name 等	`{uid: af7a23a1c6e2e21cc4257a99, name: 望京SOHO}`
`geometry`	object	几何对象（type 通常为 Polygon；coordinates 符合 GeoJSON 规范）	—

错误码

错误以统一结构返回：{"detail": {"code": 429, "msg": "..."}}

HTTP	含义	常见原因 / 处理
`400`	参数错误	缺少必填参数或格式不合法
`401`	鉴权失败	API Key 缺失、不存在、已停用或已过期
`403`	权限不足	该 API Key 未开通此接口，请购买流量豆
`429`	流量豆不足 / 限流	流量豆用完需续费；或超过速率（60 秒 200 次）
`404`	资源不存在	路径错误，或查询对象无数据
`503`	服务暂时不可用	服务暂时异常，请稍后重试

完整错误码见文档首页 · 错误码总览。