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

1,157 阅读4分钟

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

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

1. 产品功能

  • 提供全国最新、最全的省市区镇街道区域信息;
  • 第一时间更新区域信息变动;
  • 最小级别可以详细到镇、街道级别,为国内区域单元最小级别;
  • 全接口支持 HTTPS(TLS v1.0 / v1.1 / v1.2 / v1.3);
  • 全面兼容 Apple ATS;
  • 全国多节点 CDN 部署;
  • 接口极速响应,多台服务器构建 API 接口负载均衡。

2. API 文档

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

接口请求地址: api.gugudata.com/location/ch…

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

请求方式: GET

请求协议: HTTPS

请求示例: api.gugudata.com/location/ch…

接口测试: api.gugudata.com/location/ch…

3. 请求参数(如果为 POST 请求,那么参数以 JSON 的格式传递)

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

4. 返回参数

参数名参数类型备注
DataStatus.StatusCodeint接口返回状态码
DataStatus.StatusDescriptionstring接口返回状态说明
DataStatus.ResponseDateTimestring接口数据返回时间
DataStatus.DataTotalCountint此条件下的总数据量,一般用于分页计算
Data.RegionCodestring区域编码
Data.RegionNamestring区域名称
Data.RegionTypestring区域级别

5. 接口响应状态码

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

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

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

示例代码截图


咕咕数据,专业的数据提供商,提供专业全面的数据接口、商业数据分析,让数据成为您的生产原料。

image-20200716141435988

咕咕数据基于我们五年来为企业客户提供的海量数据支撑,将部分通用数据、通用功能抽象成产品级 API,大大满足了用户在产品开发过程中对基础数据的需求,同时降低了复杂功能的实现门槛与人力成本。

除了我们已开放的分类数据与接口外,还有海量数据正在整理、清洗、整合、构建中,后期会开放更多的数据与云端功能接口供用户使用。

目前已开放的数据接口 API