webapi

服务介绍

服务文档

使用指南

常见问题

更新日志

内容（服务介绍）

行政区划查询服务

行政区划查询服务是一类Web API接口服务；

行政区划查询服务可根据用户输入的搜索条件帮助客户快速查找特定的行政区划信息。
行政区划查询服务当前未推出国际化服务，查询行政区划仅限中国内地地区（暂不含港、澳、台地区）

功能介绍

行政区划查询

该服务用于查询行政区划信息。可以根据用户输入的搜索条件，帮助用户快速的查找特定的行政区域信息

内容（服务文档）

服务文档

在线接口请求服务名

https://api.map.baidu.com/api_region_search/v1/?  //GET请求

在线接口请求示例

https://api.map.baidu.com/api_region_search/v1/?keyword=山东&sub_admin=2&ak=您的ak

请求参数

参数名称	参数含义	示例	字段类型	默认值	是否必须
keyword	检索行政区划关键字。行政区划区域检索不支持多关键字检索关键字可填写：行政区名称（"中华人民共和国"/"中国"/"全国"，省、市、区和镇名称）以及 adcode； Adcode信息可参考（百度地图行政区划adcode映射表）	若sub_admin=2 检索关键字搜索省份（例如河北），能够显示市（例如石家庄市），区（例如桥西区）	string	无	是
ak	用户服务访问密钥	CO3seSdqC***ObPGW04	string	无	是
sub_admin	行政区划显示子级级数（可显示行政区划级别包含多级行政区划：国家（仅限中国）、省/直辖市、市、区/县、乡镇/街道）	显示下级行政区划级数可填入：0、1、2、3等数字，并以此类推 0：不返回下级行政区； 1：返回下一级行政区； 2：返回下两级行政区； 3：返回下三级行政区；	string	0	否
extensions_code	是否召回国标行政区划编码，1(召回)；0(不召回)	1(召回)或者0(不召回)	string	0	否

返回参数

参数名		含义	备注	示例
status		状态码	本次API访问状态，如果成功返回0，如果失败返回其他数字。（见服务状态码）	0
data_version		行政区划数据版本		20201101
result_size		行政区划个数	检索到的包含关键字（keyword）信息的行政区划个数。如keyword=朝阳，返回result_size=44 检索结果中包括“北京市朝阳区”，“辽宁省朝阳市”及其他42个带有“朝阳”关键字的乡镇街道信息。	44
districts
	code	行政区划编码
	name	行政区划名称
	level	行政区划级别	0：全国 1：省份（直辖市会在province和city中显示） 2：市（直辖市会在province和city中显示） 3：区/县 4：镇/乡/街道
	districts	下级行政区列表		包含请求下级行政区划内容

服务状态码

返回码	英文描述	定义
0	OK	正常状态
-1	Keyword is empty	关键字为空
-3	Unknown error	未知错误

内容（使用指南）

使用指南

坐标系说明

WGS84：为一种大地坐标系，也是目前广泛使用的GPS全球卫星定位系统使用的坐标系。
GCJ02：是由中国国家测绘局制订的地理信息系统的坐标系统。由WGS84坐标系经加密后的坐标系。
BD09：为百度坐标系，在GCJ02坐标系基础上再次加密。其中bd09ll表示百度经纬度坐标，bd09mc表示百度墨卡托米制坐标。

编码说明

API请求中需要用到中文或一些特殊字符的参数，如query、region等，为了避免提交到后台乱码，需要对这几个参数值进行编码处理，转换成UTF-8字符的二字符十六进制值，凡是不在下表中的字符都需要进行编码。

字符集合	字符
URL非保留字	a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 - _ . ~
URL保留字	! * ' ( ) ; : @ & = + $ , / ? % # [ ]

如果中文参数中使用URL保留字字符的字面意思，例如：region关键字取值为"?北京"，检索关键字包含一个问号，此问号也必须进行编码。

附注：

Javascript中一般采用EncodeURIComponent函数对特殊字符进行编码。

Java中可以使用函数URLEncoder.encode对特殊字符进行编码。

C#中可以使用函数HttpUtility.UrlEncode对特殊字符进行编码。

Php中可以使用函数Urlencode对特殊字符进行编码。

服务调用限制

行政区划查询功能的服务调用量的限制请查阅开发者权益进行查询

内容（常见问题）

常见问题

1、行政区划查询功能的使用配额/并发满了要怎么办？

行政区划查询功能与其他API服务一样，具有每天使用配额和并发次数的限制。使用前，您需要提交工单申请对应服务权限，权限开通后，使用额度可查阅开发者权益，如果您需要对服务进行大量测试，当前配额或并发不能满足业务使用需求，需联系我们申请做进一步提升，请详细填写日配额和并发预估计算方法，以便评估。

2.为什么提示服务被禁用？

请在控制台确认您的AK是否有该服务的权限。
可在”控制台“->"查看应用"->“设置” 确认是否已获得“逆地理编码服务”权限。
如有其他问题，可通过“反馈与帮助”反馈给我们。

内容（更新日志）

2021年3月3日

V1.0

产品发布

行政区划查询功能上线

WebAPI文档全面上新