概述
本接口提供中国标准行政区划数据,可用于生成城市列表控件等功能时使用。
请求URL
list接口: 获取全部行政区划数据。该请求为GET请求。
https://apis.map.qq.com/ws/district/v1/list
getchildren接口:获取指定行政区划的子级行政区划。该请求为GET请求。
https://apis.map.qq.com/ws/district/v1/getchildren
search接口:根据关键词搜索行政区划。该请求为GET请求。
https://apis.map.qq.com/ws/district/v1/search
请求参数
参数 | 必填 | 说明 | 示例 |
---|---|---|---|
list接口参数: | |||
无需任何参数 | |||
getchildren接口参数: | |||
id | 否 | 父级行政区划ID,缺省时则返回最顶级行政区划 | id=110000 |
search接口参数:根据关键词搜索行政区划 | |||
keyword | 是 | 搜索关键词: 1.支持输入一个文本关键词 2.支持多个行政区划代码,英文逗号分隔 |
keyword=北京 keyword=130681, 419001 |
通用参数: | |||
key | 是 | 开发密钥(Key) | key=OB4BZ-D4W3U-B7VVO-4PJWW-6TKDJ-WPB77 |
output | 否 | 返回格式:支持JSON/JSONP,默认JSON | output=json |
callback | 否 | JSONP方式回调函数 | callback=function1 |
响应结果
名称 | 类型 | 必填 | 说明 | ||
---|---|---|---|---|---|
status | number | 是 | 状态码,0为正常, 310请求参数信息有误, 311Key格式错误, 306请求有护持信息请检查字符串, 110请求来源未被授权 |
||
message | string | 是 | 状态说明 | ||
data_version | string | 是 | 行政区划数据版本,用于定期更新 | ||
result | array | 是 | 结果数组,第0项,代表一级行政区划,第1项代表二级行政区划,以此类推;使用getchildren接口时,仅为指定父级行政区划的子级 | ||
id | number | 是 | 行政区划唯一标识 注:省直辖地区,在数据表现上有一个重复的虚拟节点(其id最后两位为99),其目的是为了表明省直辖关系而增加的,开发者可根据实际需要选用 |
||
name | string | 否 | 简称,如“内蒙古” | ||
fullname | string | 是 | 全称,如“内蒙古自治区” | ||
location | string | 是 | 中心点坐标 | ||
lat | number | 是 | 纬度 | ||
lng | number | 是 | 经度 | ||
pinyin | array | 否 | 行政区划拼音,每一下标为一个字的全拼,如:["nei","meng","gu"] | ||
cidx | array | 否 | 子级行政区划在下级数组中的下标位置 |
调用示例
// GET请求,注意参数值要进行URL编码
// list接口:获取全部行政区划数据
https://apis.map.qq.com/ws/district/v1/list?key=OB4BZ-D4W3U-B7VVO-4PJWW-6TKDJ-WPB77
// getchildren接口:获取北京市的子级行政区划
https://apis.map.qq.com/ws/district/v1/getchildren?id=110000&key=OB4BZ-D4W3U-B7VVO-4PJWW-6TKDJ-WPB77
// search接口:搜索关键词为香格里拉的行政区划
https://apis.map.qq.com/ws/district/v1/search?&keyword=香格里拉&key=OB4BZ-D4W3U-B7VVO-4PJWW-6TKDJ-WPB77
// list接口:获取全部行政区划数据
https://apis.map.qq.com/ws/district/v1/list?key=OB4BZ-D4W3U-B7VVO-4PJWW-6TKDJ-WPB77
// getchildren接口:获取北京市的子级行政区划
https://apis.map.qq.com/ws/district/v1/getchildren?id=110000&key=OB4BZ-D4W3U-B7VVO-4PJWW-6TKDJ-WPB77
// search接口:搜索关键词为香格里拉的行政区划
https://apis.map.qq.com/ws/district/v1/search?&keyword=香格里拉&key=OB4BZ-D4W3U-B7VVO-4PJWW-6TKDJ-WPB77