行政区划接口

GET

/administrativeDivision/get

接口描述

行政区划是国家为便于行政管理而分级划分的区域。行政区划由省级行政区、地级行政区、县级行政区、乡级行政区组成。

我们在接口坞的行政区划查询接口中还增加了村级（村委会/社区）查询，也就是省地（市）县乡村五级，数据来源于国家统计，稳当可靠，更新及时。

注：此接口暂不支持台湾省和港澳特别行政区数据查询。
注：我们历时数月时间对数据进行整理且又在外部购买数据进行整合只为更易使用。

为了方便查询和使用，我们对每级数据都进行了分类，如省级分为省、直辖市、自治区，地级分为地级市、地区、自治州、盟等等其他层级也都有相应的分类，可在枚举接口中查看全部（由于各区划单位会经常调整，所对应的分类也可能产生相应的变化）

通过此接口，不仅能快速实现我们最常用的省市联动，对于收货地址，归属地等等所有依赖地址的需求都能很好的支持。

频次限制

匿名用户：不允许使用
普通用户：100次/分钟
注：
匿名用户主要为请求中未携带任何身份标识的用户，主要以IP作为频次限制条件。
普通用户为通过API KEY或签名认证或登录TOKEN等所有有效身份标识的用户，以用户作为频次限制条件。

收费说明

普通用户会在资源包中扣除用量，余量不足时暂停访问。购买资源包

请求参数

Authorization

在 query 添加参数

api_key

示例：

api_key: ********************

Query 参数

fields

string

可选

指定返回结果中的字段，多个使用英文逗号分隔，枚举项通过枚举接口获取

示例值:

division_code

ids

string

可选

行政区划唯一标识，多个使用英文逗号分隔，可用来查询历史版本数据

示例值:

cc605ea80cc9e04a112830d061d66a6b85e9

levels

string

可选

行政区划层级，12345分别代表省地县乡村五级，多个使用英文逗号分隔，枚举项通过枚举接口获取

示例值:

types

string

可选

行政区划分类，如第一层级省分为了省、直辖市、自治区，多个使用英文逗号分隔，枚举项通过枚举接口获取

示例值:

provinceCodes

string

可选

省级统计用区划代码（12位），多个使用英文逗号分隔

示例值:

110000000000

prefectureCodes

string

可选

地级统计用区划代码（12位），多个使用英文逗号分隔

示例值:

110100000000

countyCodes

string

可选

县级统计用区划代码（12位），多个使用英文逗号分隔

示例值:

110105000000

townCodes

string

可选

乡级统计用区划代码（12位），多个使用英文逗号分隔

示例值:

110105038000

villageCodes

string

可选

村级统计用区划代码（12位），多个使用英文逗号分隔

示例值:

110105038203

divisionCodes

string

可选

任一统计用区划代码（12位），当只知道统计用区划代码不知道层级时使用，多个使用英文逗号分隔

示例值:

110105038203

page

integer

分页页码，从1开始

可选

示例值:

size

integer

可选

分页每页数量，最小为1，最大50

示例值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.apihubs.cn/administrativeDivision/get?fields=division_code&ids=cc605ea80cc9e04a112830d061d66a6b85e9&levels=1&types=10&provinceCodes=110000000000&prefectureCodes=110100000000&countyCodes=110105000000&townCodes=110105038000&villageCodes=110105038203&divisionCodes=110105038203&page=1&size=50&api_key'

返回响应

🟢200成功

application/json

Body

code

integer

错误码

必需

0为成功，可以作为判断成功的依据，其他错误码可通过枚举接口获取

示例值:

msg

string

错误信息

必需

ok为成功，不能作为判断成功的依据，其他错误码可通过枚举接口获取

示例值:

data

object

响应数据

必需

page

integer

页码，从1开始

必需

示例值:

size

integer

每页数量

必需

示例值:

total

integer

总条数

必需

示例值:

100

list

array[object (行政区划信息) {17}]

数据列表

必需

示例

{
    "code": 0,
    "msg": "ok",
    "data": {
        "page": 1,
        "size": 10,
        "total": 100,
        "list": [
            {
                "id": "0ba820cb06244045ef2851b0017d5e195145",
                "level": "1",
                "type": "10",
                "province_code": "110000000000",
                "province_name": "北京市",
                "prefecture_code": "110100000000",
                "prefecture_name": "市辖区",
                "county_code": "110105000000",
                "county_name": "朝阳区",
                "town_code": "110105038000",
                "town_name": "崔各庄地区",
                "village_code": "110105038000",
                "village_name": "马泉营村委会",
                "division_code": "110105038203",
                "division_name": "马泉营村委会",
                "division_alias": "马泉营村委会",
                "version": "2023"
            }
        ]
    }
}

修改于 2023-11-03 15:14:35

节假日获取工作日下一天接口

汉字转拼音接口

行政区划接口

接口描述#

频次限制#

收费说明#

请求参数

示例代码

返回响应

接口描述

频次限制

收费说明