📡 API 接口文档

🌐 基础信息

Base URL: https://map.ruiduobao.com

数据格式: JSON / GeoJSON

编码: UTF-8

📍 行政区划查询接口

参数	类型	必填	说明
year	string	否	年份，可选值：2023, 2021, 2018, 2017, 2010，默认2023
province	string	是	省份名称，如：四川省

参数	类型	必填	说明
year	string	否	年份，默认2023
province	string	是	省份名称
city	string	是	地级市名称

参数	类型	必填	说明
year	string	否	年份，默认2023
province	string	是	省份名称
city	string	是	地级市名称
county	string	是	县/区名称

参数	类型	必填	说明
year	string	否	年份，默认2023
province	string	是	省份名称
city	string	是	地级市名称
county	string	是	县/区名称
town	string	是	乡镇名称

🗺️ 矢量数据获取接口

参数	类型	必填	说明
code	string	是	行政区划编码
year	int	否	年份，默认2023（仅省/市/县级有效）

编码规则

编码格式	级别	示例
6位，后4位为0000	省级	510000（四川省）
6位，后2位为00	地级	510100（成都市）
6位，后2位不为00	县级	510104（锦江区）
12位，后3位为000	乡镇级	510104017000
12位	村级	510104017001

参数	类型	必填	说明
code	string	是	行政区划编码（URL路径参数）
format	string	否	格式：gson(GeoJSON), shp(Shapefile), kml, gpkg(GeoPackage), svg，默认gson
year	int	否	年份，默认2023

🔍 搜索接口

参数	类型	必填	说明
keyword	string	是	搜索关键词（名称或编码）
province	string	否	当前省份，优先搜索省内
limit	int	否	返回数量限制，默认10

返回格式（Server-Sent Events）

data: {"type":"result","data":{"name":"锦江区","code":"510104","level":"xian"},"scope":"province"}
data: {"type":"provinceDone","hasResults":true}
data: {"type":"result","data":{"name":"锦江社区居委会","code":"..."},"scope":"nationwide"}
data: {"type":"done","total":5}

📊 统计数据接口

参数	类型	必填	说明
year	int	否	年份，默认2023

💡 使用示例

JavaScript (Fetch API)

// 获取四川省的矢量数据
fetch('https://map.ruiduobao.com/getGsonDB?code=510000&year=2023')
  .then(res => res.json())
  .then(data => {
    if (data.status === 'success') {
      // 获取GeoJSON文件
      fetch('https://map.ruiduobao.com' + data.filepath)
        .then(res => res.json())
        .then(geojson => {
          console.log('GeoJSON数据:', geojson);
        });
    }
  });

Python (requests)

import requests

# 获取四川省矢量数据
response = requests.get('https://map.ruiduobao.com/getGsonDB', params={
    'code': '510000',
    'year': 2023
})
data = response.json()

if data['status'] == 'success':
    # 下载GeoJSON
    geojson_url = 'https://map.ruiduobao.com' + data['filepath']
    geojson = requests.get(geojson_url).json()
    print(f"获取到 {len(geojson['features'])} 个要素")

⚠️ 注意事项

📋 错误码说明

状态	说明
success	请求成功
error	请求失败，查看 message 字段
HTTP 400	参数错误（缺少必填参数）
HTTP 404	数据不存在
HTTP 500	服务器内部错误

常见错误示例

// 缺少必填参数
GET /api/tree/cities
响应: {"status":"error","message":"需要省份参数"}

// 编码不存在
GET /getGsonDB?code=999999
响应: Data not found (HTTP 404)

// 年份不可用
GET /getGsonDB?code=510000&year=2030
响应: {"status":"error","message":"年份2030数据不可用"}