cURL
curl "https://api.ruseo.cn/api/china_region?action=provinces&code=440000&name=%E5%B9%BF%E4%B8%9C%E7%9C%81&province=%E5%B9%BF%E4%B8%9C%E7%9C%81&city=%E5%B9%BF%E5%B7%9E%E5%B8%82&keyword=%E5%A4%A9%E6%B2%B3"
基于 cblink/region 库,提供中国行政区划数据查询,支持省、市、县三级行政区划。数据来源:国家统计局。
https://api.ruseo.cn/api/china_region
接口调用前需要确认的核心配置。
/api/china_regionchina_region必填参数必须传入,示例值可直接用于联调。
免费API不强制要求API Key,但如果您希望统计个人调用次数,请在请求时附加参数 key=您的API_KEY。
注册账号后即可获得API Key。
| 参数名 | 必填 | 类型 | 说明 | 示例值 |
|---|---|---|---|---|
key |
否 | string | 可选参数:携带此参数可统计您的个人调用次数。请注册账号获取API Key。 | YOUR_API_KEY |
action |
是 | string | 操作类型:provinces(省份)、cities(城市)、districts(区县)、tree(树形)、search(搜索)、location(编码查询)、path(名称路径) | provinces |
code |
否 | string | 区域编码,用于cities、districts、location查询 | 440000 |
name |
否 | string | 区域名称,用于cities、districts查询 | 广东省 |
province |
否 | string | 省份名称,用于path查询 | 广东省 |
city |
否 | string | 城市名称,用于path、districts查询 | 广州市 |
keyword |
否 | string | 搜索关键词,用于search查询 | 天河 |
优先使用示例地址测试请求参数是否正确。
https://api.ruseo.cn/api/china_region?action=provinces&code=440000&name=%E5%B9%BF%E4%B8%9C%E7%9C%81&province=%E5%B9%BF%E4%B8%9C%E7%9C%81&city=%E5%B9%BF%E5%B7%9E%E5%B8%82&keyword=%E5%A4%A9%E6%B2%B3
curl "https://api.ruseo.cn/api/china_region?action=provinces&code=440000&name=%E5%B9%BF%E4%B8%9C%E7%9C%81&province=%E5%B9%BF%E4%B8%9C%E7%9C%81&city=%E5%B9%BF%E5%B7%9E%E5%B8%82&keyword=%E5%A4%A9%E6%B2%B3"
$url = 'https://api.ruseo.cn/api/china_region?action=provinces&code=440000&name=%E5%B9%BF%E4%B8%9C%E7%9C%81&province=%E5%B9%BF%E4%B8%9C%E7%9C%81&city=%E5%B9%BF%E5%B7%9E%E5%B8%82&keyword=%E5%A4%A9%E6%B2%B3';
$response = file_get_contents($url);
$data = json_decode($response, true);
fetch('https://api.ruseo.cn/api/china_region?action=provinces&code=440000&name=%E5%B9%BF%E4%B8%9C%E7%9C%81&province=%E5%B9%BF%E4%B8%9C%E7%9C%81&city=%E5%B9%BF%E5%B7%9E%E5%B8%82&keyword=%E5%A4%A9%E6%B2%B3')
.then(res => res.json())
.then(data => console.log(data));
实际返回内容以接口脚本处理结果为准。
{
"code": 0,
"msg": "success",
"data": {
"route": "china_region",
"example": true
}
}
| 参数名 | 类型 | 说明 | 示例值 |
|---|---|---|---|
provinces |
array | 省份列表 | [{"code":"440000","name":"广东省"}] |
cities |
array | 城市列表 | [{"code":"440100","name":"广州市"}] |
districts |
array | 区县列表 | [{"code":"440106","name":"天河区"}] |
tree |
array | 省市区树形结构 | [{"code":"440000","name":"广东省","children":[]}] |
results |
array | 搜索结果列表 | [{"code":"440106","name":"天河区","level":3,"path":"广东省/广州市/天河区"}] |
path |
array | 区域完整路径 | [{"code":"440000","name":"广东省","level":1}] |
found |
boolean | 是否找到 | true |
full_name |
string | 完整名称 | 广东省广州市天河区 |
codes |
array | 编码路径 | ["440000","440100","440106"] |
total |
int | 结果数量 | 34 |
province_code |
string | 省份编码 | 440000 |
province_name |
string | 省份名称 | 广东省 |
city_code |
string | 城市编码 | 440100 |
city_name |
string | 城市名称 | 广州市 |
level |
int | 区域级别:1省份/2城市/3区县 | 3 |
level_name |
string | 级别名称:省份/城市/区县 | 区县 |
点击左侧“发送请求”查看结果...