全国行政区划
全国五级行政区划查询会员免费正常服务
接入点列表:
支持城市区划ID五级行政区划联动查询
post方式请求时,enctype应为application/x-www-form-urlencoded
上传文件二进制数据流方式,enctype必须为multipart/form-data
参数url、base64中有特殊字符时,建议对值urlencode编码后传递
| 名称 | 类型 | 必须 | 示例值/默认值 | 说明 |
|---|---|---|---|---|
| key | string | 是 | 您自己的APIKEY(注册账号后获得) | API密钥 |
| province | string | 否 | 420000 | 省级行政区ID(含直辖市),获取市级行政区 |
| city | string | 否 | 421100000000 | 市级行政区ID(市辖区/市辖县),获取区县级行政区 |
| county | string | 否 | 421123000000 | 区县级行政区ID,获取乡镇(街道)级行政区 |
| town | string | 否 | 421123100000 | 乡镇(街道)级行政区ID,获取社区(村)级行政区 |
| village | string | 否 | 421123100212 | 社区(村)级行政区ID,获取全部上级行政区 |
公共参数指所有接口都会返回的参数,应用参数每个接口都不同
| 名称 | 类型 | 示例值 | 说明 |
|---|---|---|---|
| 公共参数 | |||
| code | int | 200 | 状态码 |
| msg | string | success | 错误信息 |
| result | object | {} | 返回结果集 |
| 应用参数 | |||
| id | int | 1 | 数据编号 |
| provinceid | string | 420000 | 省级行政区ID |
| provincename | string | 湖北省 | 行政区名称 |
| cityid | string | 421100000000 | 市级行政区ID |
| cityname | string | 黄冈市 | 市级行政区名称 |
| countyid | string | 421123000000 | 区县级行政区ID |
| countyname | string | 罗田县 | 区县级行政区名称 |
| townid | string | 421123100000 | 乡镇(街道)行政区ID |
| townname | string | 凤山镇 | 乡镇(街道)级行政区名称 |
| villageid | string | 421123100212 | 社区(村)级行政区ID |
| villagename | string | 七里牌村 | 社区(村)级行政区名称 |
本接口为会员免费类接口,如业务有更高配额需求可点此升级会员
| 用户等级 | 免费接口数 | 每日调用量 | QPS | 会员价格 |
|---|---|---|---|---|
| 普通会员 | 10个 | 100次 | 5-10 | 免费 |
| 高级会员 | 不限 | 1万次 | 20 | 20元/月、 |
| 黄金会员 | 不限 | 50万次 | 30 | 65元/月、 |
| 钻石会员 | 不限 | 不限次 | 60 |
错误信息可能会有所调整,请根据错误状态码(code)进行流程判断
| 错误状态码 | 错误信息 | 解释帮助 |
|---|---|---|
| 100 | 内部服务器错误 | 报此错误码请及时反馈或等待官方修复 |
| 110 | 当前API已下线 | 接口已下线无法使用,可关注相关通知 |
| 120 | API暂时维护中 | 接口暂时关闭维护中,请注意相关公告 |
| 130 | API调用频率超限 | 超过每秒请求数上限,可在控制台-接口管理中查询 |
| 140 | API没有调用权限 | 请检查是否自行在接口管理中停用或被禁用了该接口 |
| 150 | API可用次数不足 | 免费类接口套餐超限或计次类接口余额不足,点此查看说明 |
| 160 | 账号未申请该API | 请先在接口文档页面申请该接口,点此查看说明 |
| 170 | Referer请求来源受限 | 设置了Referer白名单,但来源Referer不在白名单内 |
| 180 | IP请求来源受限 | 设置了IP白名单,但来源IP不在白名单内 |
| 190 | 当前key不可用 | 通常为账号无效,此状态无法恢复 |
| 230 | key错误或为空 | 请检查apikey是否填写错误,点此查看帮助 |
| 240 | 缺少key参数 | 请检查是否传递了key参数或者编码格式是否符合要求 |
| 250 | 数据返回为空 | 数据查询或转换失败,请检查输入值或注意中文编码问题 |
| 260 | 参数值不得为空 | 请检查关键参数是否传递了空值 |
| 270 | 参数值不符合要求 | 参数值不符合基本格式要求,点此查看说明 |
| 280 | 缺少必要的参数 | 缺少必填的参数,请根据接口文档检查 |
| 290 | 超过最大输入限制 | 参数值超过输入范围,请查看接口文档的说明 |
| 错误码1开头的是系统级错误,2开头的是用户级错误,其中200表示请求成功处理并计费。 | ||