全国省市区街道区域信息 API 接口

提供全国省市区街道区域信息。

gugudata_api_cover

1. 产品功能

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

• 第一时间更新区域信息变动；

• 最小级别可以详细到镇、街道级别，为国内区域单元最小级别；

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

• 全面兼容 Apple ATS；

• 全国多节点 CDN 部署；

• 接口极速响应，多台服务器构建 API 接口负载均衡。

2. API 文档

API 详情地址: https://www.gugudata.com/api/details/chinaregions

接口请求地址: https://api.gugudata.com/location/chinaregions

返回格式: application/json; charset=utf-8

请求方式: GET

请求协议: HTTPS

请求示例: https://api.gugudata.com/location/chinaregions?appkey=YOUR_APPKEY&regioncode=YOUR_VALUE

接口测试: https://api.gugudata.com/location/chinaregions/demo

3. 请求参数（如果为 POST 请求，那么参数以 JSON 的格式传递）

参数名	参数类型	是否必须	默认值	备注
appkey	string	是	YOUR_APPKEY	付费后获取的 APPKEY
regioncode	string	是	YOUR_VALUE	需要查询的父级区域编码，0 获取全国所有省；编码格式为 00000000，每两位分别对应省、市、区、镇/街道编码

4. 返回参数

参数名	参数类型	备注
DataStatus.StatusCode	int	接口返回状态码
DataStatus.StatusDescription	string	接口返回状态说明
DataStatus.ResponseDateTime	string	接口数据返回时间
DataStatus.DataTotalCount	int	此条件下的总数据量，一般用于分页计算
Data.RegionCode	string	区域编码
Data.RegionName	string	区域名称
Data.RegionType	string	区域级别

5. 接口响应状态码

状态码	状态码解释	备注
100	正常返回	可通过判断此状态码断言接口正常返回
-1	请求失败	请求处理请求失败
501	参数错误	请检查您传递的参数个数以及参数类型是否匹配
502	请求频率受限	一般建议每秒请求不超过 100 次
503	APPKEY 权限超限/订单到期	请至开发者中心检查您的 APPKEY 是否到期或是否权限超限
504	APPKEY 错误	请检查传递的 APPKEY 是否为开发者中心获取到的值
505	请求的次数超出接口限制	请检查对应接口是否有请求次数限制以及您目前的接口请求剩余次数
900	接口内部响应错误	接口可用性为 99.999%，如获取到此状态码请邮件联系我们

6. 开发语言请求示例代码

示例代码包含的开发语言：C#, Go, Java, jQuery, Node.js, Objective-C, PHP, Python, Ruby, Swift 等，其他语言进行对应的 RESTful API 请求实现即可。

image-20210629091827770