示例中心
功能在线体验
控制台

高德 开发 Web服务 API 开发指南 API文档 行政区域查询

更新时间:2018年09月12日

产品介绍

行政区域查询是一类简单的HTTP接口,根据用户输入的搜索条件可以帮助用户快速的查找特定的行政区域信息。

使用API前您需先申请Key,若无高德地图API账号需要先申请账号。

目前高德提供的服务是唯一能让用户查询到乡镇/街道级别信息且小时级更新数据的公开API。

例如:中国>山东省>济南市>历下区>舜华路街道(国>省>市>区>街道)。


在使用前,需要特别说明两点

  1. 目前部分城市和省直辖县因为没有区县的概念,故在市级下方直接显示街道。例如:广东-东莞、海南-文昌市。
  2. 街道级别是不能返回边界数据polyline的。


适用场景

用户希望通过得到行政区域信息,进行开发工作。

使用限制

服务调用量的限制请点击这里查阅。

使用说明

第一步,申请”Web服务API”密钥(Key);

第二步,拼接HTTP请求URL,第一步申请的Key需作为必填参数一同发送;

第三步,接收HTTP请求返回的数据(JSON或XML格式),解析数据。

如无特殊声明,接口的输入参数和输出数据编码全部统一为UTF-8。

行政区域查询

行政区域查询API服务地址:

https://restapi.amap.com/v3/config/district?parameters 

parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。

 

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

用户在高德地图官网申请Web服务API类型KEY

必填

keywords

查询关键字

规则:只支持单个关键词语搜索关键词支持:行政区名称、citycode、adcode

例如,在subdistrict=2,搜索省份(例如山东),能够显示市(例如济南),区(例如历下区)

adcode信息可参考城市编码表获取

可选

subdistrict

子级行政区

规则:设置显示下级行政区级数(行政区级别包括:国家、省/直辖市、市、区/县、乡镇/街道多级数据)

可选值:0、1、2、3等数字,并以此类推

0:不返回下级行政区;

1:返回下一级行政区;

2:返回下两级行政区;

3:返回下三级行政区;


需要在此特殊说明,目前部分城市和省直辖县因为没有区县的概念,故在市级下方直接显示街道。

例如:广东-东莞、海南-文昌市

可选

1

page

需要第几页数据

最外层的districts最多会返回20个数据,若超过限制,请用page请求下一页数据。

例如page=2;page=3。默认page=1

可选

1

offset

最外层返回数据个数


可选

20

extensions

返回结果控制

此项控制行政区信息中返回行政区边界坐标点; 可选值:base、all;

base:不返回行政区边界坐标点;

all:只返回当前查询district的边界值,不返回子节点的边界值;

目前不能返回乡镇/街道级别的边界值

可选

base

filter

根据区划过滤

按照指定行政区划进行过滤,填入后则只返回该省/直辖市信息

需填入adcode,为了保证数据的正确,强烈建议填入此参数

可选


callback

回调函数

callback值是用户定义的函数名称,此参数只在output=JSON时有效

可选


output

返回数据格式类型

可选值:JSON,XML

可选

JSON

  • 返回结果参数说明

行政区域查询的响应结果的格式由请求参数output指定。

名称

含义

规则说明

status

返回结果状态值

值为0或1,0表示失败;1表示成功

info

返回状态说明

返回状态说明,status为0时,info返回错误原因,否则返回“OK”。

infocode

状态码

返回状态说明,10000代表正确,详情参阅info状态表

suggestion

建议结果列表



keywords

建议关键字列表



cites

建议城市列表


districts

行政区列表



district

行政区信息




citycode

城市编码




adcode

区域编码

街道没有独有的adcode,均继承父类(区县)的adcode



name

行政区名称




polyline

行政区边界坐标点

当一个行政区范围,由完全分隔两块或者多块的地块组

成,每块地的 polyline 坐标串以 | 分隔 。

如北京 的 朝阳区



center

城市中心点

必须说明

在区县级别,有28个区县不能返回中心点

在乡镇/街道界别,有9262个乡镇/街道不能返回中心点 



level

行政区划级别

country:国家

province:省份(直辖市会在province和city显示)

city:市(直辖市会在province和city显示)

district:区县

street:街道



districts

下级行政区列表,包含district元素


  • 服务示例
https://restapi.amap.com/v3/config/district?keywords=北京&subdistrict=2&key=<用户的key>

参数

备注

必选

keywords

规则:只支持单个关键词语搜索关键词支持:行政区名称、citycode、adcode

例如,在subdistrict=2,搜索省份(例如山东),能够显示市(例如济南),区(例如历下区)

subdistrict

规则:设置显示下级行政区级数(行政区级别包括:国家、省/直辖市、市、区/县4个级别)

可选值:0、1、2、3

0:不返回下级行政区;

1:返回下一级行政区;

2:返回下两级行政区;

3:返回下三级行政区;

extensions

此项控制行政区信息中返回行政区边界坐标点; 可选值:base、all;

base:不返回行政区边界坐标点;

all:只返回当前查询district的边界值,不返回子节点的边界值;



示例中心 功能
在线体验
常见问题