全国省市区街道区域信息 - 咕咕数据 API 文档

全国省市区街道村信息
接口详情官网地址: https://www.gugudata.com/api/details/chinaregions

提供全国省市区街道居委会信息

请求方法: GET
接口路径: /location/chinaregions
调试地址: https://api.gugudata.com/location/chinaregions/demo
OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

请求参数:

appkey (string, 必填): 付费后获取的 APPKEY

regioncode (string, 必填): 需要查询的父级区域编码，传递 0 获取全国所有省级别数据；编码格式为 00000000，每两位分别对应省、市、区、镇/街道编码（注意：v2 版本会在国家 6 位行政区划标准代码后添加 00 两位编码以保持接口兼容，v3 版本为 12 位编码格式）

version (int, 必填): 当传递参数值为 2 时，调用 v2 版本的接口，regioncode 遵循国家行政区划代码标准，同时可返回新增区划中心点坐标。当传递参数值为 3 时，调用 v3 版本的接口（v1 版本主要为了兼容历史用户调用逻辑，新用户强烈建议调用 v3 接口）

返回字段:

DataStatus.StatusCode: 接口返回状态码

DataStatus.StatusDescription: 接口返回状态说明

DataStatus.ResponseDateTime: 接口数据返回时间

DataStatus.DataTotalCount: 此条件下的总数据量，一般用于分页计算

Data.RegionCode: 区域编码（在 v2 版本中，前六位为国家行政区划标准编码，镇/街道是没有国家标准编码的，对应的编码只是对应的序号。v3 版本中，为最新的 12 位国家行政区划标准编码。）

Data.RegionName: 区域名称（部分城市在“市”级别后没有“区”级别，会直接返回“镇/街道”信息，注意根据「区域级别」字段进行处理）

Data.RegionType: 区域级别，枚举值为：省/自治区/直辖市/特别行政区 | 市 | 区 | 镇/街道｜居委会/村

Data.CenterLonLat: 部分数据包含区划中心点坐标，格式为 [经度,纬度]，地理坐标系为 GCJ-02。需要转换坐标系请调用地理坐标系转换接口

HTTP 状态码:

200 接口正常响应: 业务状态码请结合响应体中的状态字段判断。

400 请求参数错误: 参数缺失、格式错误或非法组合。

401 鉴权失败: 缺少 APPKEY 或 APPKEY 无效。

403 无权限或额度不可用: 订单到期、权限不足或剩余额度不可用。

404 资源不存在: 请求路径不存在。

405 请求方法不允许: 请求方法与接口定义不匹配。

415 请求内容类型不支持: 文件上传或请求体格式不符合要求。

429 请求频率超限: 触发接口或网关限流策略。

500 服务内部异常: 服务执行异常，请联系技术支持。

502 上游依赖异常: 上游服务响应异常或暂不可用。

业务状态码:

100 正常返回: 暂无说明

101 参数错误: 暂无说明

102 请求频率受限: 每秒请求不能超过 100 次

103 账号欠费: 暂无说明

104 APPKEY 错误: 请检查传递的 APPKEY 是否为开发者中心获取到的值

110 接口响应错误: 暂无说明

接口特性:

更新了最新的 12 位编码的行政区划编码格式；

三种行政区划编码格式，与国家规范一致，最新建议调用 v3 版本；

提供全国最新、最全的省市区镇街道区域信息；

每周校对、清洗、更新数据，第一时间同步更新区域信息变动；

可返回行政区划中心点地理坐标；

最小级别可以详细到镇、街道以及居委会/村级别，为国内区域单元最小级别；

围绕“全国省市区街道村信息”提供标准化能力，便于快速接入现有业务；

适合将“全国省市区街道村信息”结果接入业务系统、后台工具和自动化流程；

全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；

全面兼容 Apple ATS；

全国多节点 CDN 部署；

接口调用状态与状态监控：https://www.gugudata.com/status。

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
  "DataStatus": {
    "StatusCode": 0,
    "StatusDescription": "string",
    "ResponseDateTime": "string",
    "DataTotalCount": 0
  },
  "Data": {
    "RegionCode": "string",
    "RegionName": "string",
    "RegionType": "string",
    "CenterLonLat": "string"
  }
}