全國省市區(qū)街道區(qū)域信息 API 接口
提供全國省市區(qū)街道區(qū)域信息春贸。
1. 產(chǎn)品功能
更新了最新的 12 位編碼的行政區(qū)劃編碼格式疟羹;
三種行政區(qū)劃編碼格式卧抗,與國家規(guī)范一致,最新建議調(diào)用 v3 版本梗搅;
提供全國最新、最全的省市區(qū)鎮(zhèn)街道區(qū)域信息;
每周校對无切、清洗荡短、更新數(shù)據(jù),第一時間同步更新區(qū)域信息變動哆键;
可返回行政區(qū)劃中心點地理坐標掘托;
最小級別可以詳細到鎮(zhèn)、街道以及居委會/村級別籍嘹,為國內(nèi)區(qū)域單元最小級別烫映;
全接口支持 HTTPS(TLS v1.0 / v1.1 / v1.2 / v1.3);
全面兼容 Apple ATS噩峦;
全國多節(jié)點 CDN 部署锭沟;
接口極速響應,多臺服務器構(gòu)建 API 接口負載均衡识补。
2. API 文檔
API 詳情地址: https://www.gugudata.com/api/details/chinaregions
接口請求地址: https://api.gugudata.com/location/chinaregions
返回格式: application/json; charset=utf-8
請求方式: GET
請求協(xié)議: HTTPS
請求示例: https://api.gugudata.com/location/chinaregions?appkey={{YOUR_APPKEY}}®ioncode={{YOUR_VALUE}}&version={{3}}
接口測試: https://api.gugudata.com/location/chinaregions/demo
3. 請求參數(shù)
參數(shù)名 | 參數(shù)類型 | 是否必須 | 默認值 | 備注 |
---|---|---|---|---|
appkey | string | 是 | YOUR_APPKEY | 付費后獲取的 APPKEY |
regioncode | string | 是 | YOUR_VALUE | 需要查詢的父級區(qū)域編碼族淮,傳遞 0 獲取全國所有省級別數(shù)據(jù);編碼格式為 00000000凭涂,每兩位分別對應省祝辣、市、區(qū)切油、鎮(zhèn)/街道編碼(注意:v2 版本會在國家 6 位行政區(qū)劃標準代碼后添加 00 兩位編碼以保持接口兼容蝙斜,v3 版本為 12 位編碼格式) |
version | int | 是 | 3 | 當傳遞參數(shù)值為 2 時,調(diào)用 v2 版本的接口澎胡,regioncode 遵循國家行政區(qū)劃代碼標準孕荠,同時可返回新增區(qū)劃中心點坐標。當傳遞參數(shù)值為 3 時攻谁,調(diào)用 v3 版本的接口(v1 版本主要為了兼容歷史用戶調(diào)用邏輯稚伍,新用戶強烈建議調(diào)用 v3 接口) |
4. 返回參數(shù)
參數(shù)名 | 參數(shù)類型 | 備注 | |||
---|---|---|---|---|---|
DataStatus.StatusCode | int | 接口返回狀態(tài)碼 | |||
DataStatus.StatusDescription | string | 接口返回狀態(tài)說明 | |||
DataStatus.ResponseDateTime | string | 接口數(shù)據(jù)返回時間 | |||
DataStatus.DataTotalCount | int | 此條件下的總數(shù)據(jù)量,一般用于分頁計算 | |||
Data.RegionCode | string | 區(qū)域編碼(在 v2 版本中戚宦,前六位為國家行政區(qū)劃標準編碼个曙,鎮(zhèn)/街道是沒有國家標準編碼的,對應的編碼只是對應的序號受楼。v3 版本中垦搬,為最新的 12 位國家行政區(qū)劃標準編碼。) | |||
Data.RegionName | string | 區(qū)域名稱(部分城市在“市”級別后沒有“區(qū)”級別艳汽,會直接返回“鎮(zhèn)/街道”信息猴贰,注意根據(jù)「區(qū)域級別」字段進行處理) | |||
Data.RegionType | string | 區(qū)域級別,枚舉值為:省/自治區(qū)/直轄市/特別行政區(qū) | 市 | 區(qū) | 鎮(zhèn)/街道 | 居委會/村 |
Data.CenterLonLat | string | 新增區(qū)劃中心點坐標骚灸,格式為 [經(jīng)度,緯度]糟趾,地理坐標系為 GCJ-02。需要轉(zhuǎn)換坐標系請調(diào)用地理坐標系轉(zhuǎn)換接口 |