概述
行政区划是国家为便于行政管理而分级划分的区域。行政区划由省级行政区、地级行政区、县级行政区、乡级行政区组成。
我们在接口坞的行政区划查询接口中还增加了村级(村委会/社区)查询,也就是省地(市)县乡村五级,数据来源于国家统计,稳当可靠,更新及时。
注:此文章更新可能不及时,最新动态请留意官网公告或加群获取。
注:此接口暂不支持台湾省和港澳特别行政区数据查询。
注:我们历时数月时间对数据进行整理且又在外部购买数据进行整合只为更易使用。
为了方便查询和使用,我们对每级数据都进行了分类,如省级分为省、直辖市、自治区,地级分为地级市、地区、自治州、盟等等其他层级也都有相应的分类,可在 枚举接口 中查看全部(由于各区划单位会经常调整,所对应的分类也可能产生相应的变化)
通过此接口,不仅能快速实现我们最常用的省市联动,对于收货地址,归属地等等所有依赖地址的需求都能很好的支持。
快速开始
行政区划查询的 接口地址 为:
https://api.apihubs.cn/administrativeDivision/get
直接访问接口地址会得到按照层级返回,包含了详细的行政区划信息
行政区划查询的 文档地址 为:
http://doc.apihubs.cn/api-86728007
行政区划查询的 示例页面地址 为:
http://www.apihubs.cn/#/division
在示例页面中会根据你选择的条件动态生成接口地址,然后可以直接点击浏览器中打开接口地址预览接口返回信息。
名词解释
- 行政区划代码
行政区划代码是国家对能够统治的行施管辖区域进行分级分层进行管辖用信息化手段编制的对各层级行政区划编制的替代数码。 - 统计用行政区划代码
统计用区划代码由1~12位代码构成,第1~2位,为省级代码;第3~4 位,为地级代码;第5~6位,为县级代码;第7~9位,为乡级代码;第10~12位,为村级代码。 城乡划分代码
城乡划分代码由13~17位代码构成,第13~14位,为城乡属性代码;第15~17位,为城乡分类代码。参数
行政区划查询接口提供了丰富的查询参数,所有参数都为可选参数,多个条件之间为AND的关系,可灵活搭配使用。
- fields 用来指定返回结果包含的字段,多个使用英文逗号分隔 枚举
- levels 用来指定要查询的行政区划层级,多个使用英文逗号分隔 枚举
- types 用来指定要查询的行政区划类型,多个使用英文逗号分隔 枚举
- provinceCodes 省级统计用区划代码(12位),多个使用英文逗号分隔
- prefectureCodes 地级统计用区划代码(12位),多个使用英文逗号分隔
- countyCodes 县级统计用区划代码(12位),多个使用英文逗号分隔
- townCodes 乡级统计用区划代码(12位),多个使用英文逗号分隔
- villageCodes 村级统计用区划代码(12位),多个使用英文逗号分隔
- divisionCodes 任一统计用区划代码(12位),当只知道统计用区划代码不知道层级时使用,多个使用英文逗号分隔
- version 数据版本,约每年更新一次
- page 分页页码,从1开始
size 分页每页数量,最小为1,最大50
响应
行政区划查询接口的枚举功能是基于 php-enum 实现的统一格式响应
行政区划查询接口响应始终为JSON数据格式,如下
{
"code": 0,
"msg": "ok",
"data": ""
}
- code 成功时始终为0,失败见 枚举
- msg 成功时始终为 ok,失败见 枚举
- data 成功时返回数据,失败时部分返回失败数据,如表单验证失败。
- data.page 当前页码
- data.size 当前每页数量
- data.total 根据查询条件查到的总数量
- data.list 行政区划列表
data.list包含了行政区划的详细信息,其中的所有字段都可以通过 fields 参数进行按需使用
默认会返回数字日期和枚举码,这非常适合用来做逻辑判断。如下
{
"id": "1b904d3f0768f041d32a0850b7749f3a7337",
"level": 5,
"type": 51,
"province_code": 110000000000,
"prefecture_code": 110100000000,
"county_code": 110101000000,
"town_code": 110101001000,
"village_code": 110101001001,
"division_code": 110101001001,
"division_name": "多福巷社区居委会",
"division_alias": "多福巷社区居委会",
"version": 2023
}
- id 数据唯一标识,在数据版本更新时可能会用到
- level 行政区划层级,枚举
- type 行政区划类型,枚举
- province_code 省级统计用行政区划代码,省级,一直有数据
- prefecture_code 地级统计用行政区划代码,地级,查省级数据时为0
- county_code 县级统计用行政区划代码,县级,查省地级数据时为0
- town_code 乡级统计用行政区划代码,乡级,查省地县级数据时为0
- village_code 村级统计用行政区划代码,村级,查省地县乡级数据时为0
- division_code 统计用行政区划代码,和最低级保持一致
- division_name 统计用行政区划名称,原有的数据名称
- division_alias 统计用行政区划别名,优化后的数据名称
- version 数据版本,约每年更新一次
行政区划查询的功能到这里就介绍完了,大家在使用过程中遇到任何问题都可以 联系我
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。