行政区划查询服务

GET

/api_region_search/v1/

status服务状态码

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

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.map.baidu.com/api_region_search/v1/?keyword=山东&ak='

响应示例

{
    "status": 0,
    "data_version": 0,
    "result_size": 0,
    "districts": {
        "code": 0,
        "name": "string",
        "level": "string",
        "districts": "string"
    }
}

请求参数

Query 参数

keyword

string

必需

检索行政区划关键字。行政区划区域检索不支持多关键字检索关键字可填写：行政区名称（"中华人民共和国"/"中国"/"全国"，省、市、区和镇名称）以及 adcode； Adcode信息可参考（百度地图行政区划adcode映射表）

示例值:

山东

sub_admin

string

可选

行政区划显示子级级数（可显示行政区划级别包含多级行政区划：国家（仅限中国）、省/直辖市、市、区/县、乡镇/街道）

示例值:

extensions_code

string

可选

是否召回国标行政区划编码，1(召回)；0(不召回)

string

必需

开发者的访问密钥，必填项。v2之前该属性为key。申请秘钥

默认值:

返回响应

🟢200成功

application/json

Body

status

integer

必需

状态码本次API访问状态，如果成功返回0，如果失败返回其他数字。（见服务状态码）

data_version

integer

行政区划数据版本

必需

result_size

integer

必需

行政区划个数检索到的包含关键字（keyword）信息的行政区划个数。如keyword=朝阳，返回result_size=44 检索结果中包括“北京市朝阳区”，“辽宁省朝阳市”及其他42个带有“朝阳”关键字的乡镇街道信息。

districts

object

必需

code

integer

行政区划编码

必需

name

string

行政区划名称

必需

level

string

必需

行政区划级别 0：全国 1：省份（直辖市会在province和city中显示） 2：市（直辖市会在province和city中显示） 3：区/县 4：镇/乡/街道

districts

string

下级行政区列表

必需

修改于 2022-08-22 02:39:57

服务文档

服务介绍