Technical Documentation

技术文档

选择接口查看请求参数、调用示例和返回字段。调用前请开通对应产品,并确认访问来源已获准。

国内单基站查询

根据1个国内蜂窝网络小区标识查询基站参考位置。

参数名类型必填说明
mccint必填国家代码;中国代码为 460。
mncint必填通常为 0~999;radio=cdma 时填 SID(0~32767)。
lacint必填通常为 LAC/TAC;radio=cdma 时填 NID(0~65535)。
cidint必填通常为 Cell ID/NCI;radio=cdma 时填 BID(0~65535)。
rssint可选接收信号强度,单位 dBm,取值范围 -150~0。
radiostring可选支持 gsm、wcdma、cdma、lte、nr;CDMA 请显式填写 cdma。
coordstring可选坐标类型,支持 wgs84、gcj02、bd09,默认 wgs84。
outputstring可选返回格式,支持 csv、json、xml,默认 json。

请求代码示例

返回参数说明

名称类型说明
errcodeint返回码,0 表示查询成功。
messagestring返回结果说明。
dataobject / null查询结果;失败时为 null。
locationobject位置信息。
latitudenumber纬度,坐标类型以请求参数 coord 为准。
longitudenumber经度,坐标类型以请求参数 coord 为准。
accuracy_mnumber / null精度半径,单位为米。
addressstring / null参考地址。

CSV 字段:errcode,message,latitude,longitude,accuracy_m,address

errcode说明
0查询成功
10000请求参数错误
10001无查询结果
10002API Key、账号或权限错误
10003配额不足或请求频率超限
10004服务暂时不可用

每次请求查询一个基站;基站参考位置不等于终端实时位置。

国内WIFI查询

根据2-5个国内WIFI接入点信息查询参考位置。

参数名类型必填说明
macsstring必填WIFI 接入点列表,包含 2~20 项;每项格式为 BSSID,RSSI,多项使用分号 ; 分隔,建议提供至少 4 项。没有 RSSI 时填写 -65。
coordstring可选坐标类型,支持 wgs84、gcj02、bd09,默认 wgs84。
outputstring可选返回格式,支持 csv、json、xml,默认 json。

请求代码示例

返回参数说明

名称类型说明
errcodeint返回码,0 表示查询成功。
messagestring返回结果说明。
dataobject / null查询结果;失败时为 null。
locationobject位置信息。
latitudenumber纬度,坐标类型以请求参数 coord 为准。
longitudenumber经度,坐标类型以请求参数 coord 为准。
accuracy_mnumber / null精度半径,单位为米。
addressstring / null参考地址。

CSV 字段:errcode,message,latitude,longitude,accuracy_m,address

errcode说明
0查询成功
10000请求参数错误
10001无查询结果
10002API Key、账号或权限错误
10003配额不足或请求频率超限
10004服务暂时不可用

每个接入点均需包含有效的 BSSID 和 RSSI;RSSI 单位为 dBm,取值范围 -150~0。没有真实 RSSI 时统一填写 -65,不要留空或填写 0。

国内混合查询

综合国内基站与WIFI信息进行定位查询。

参数名类型必填说明
cellsstring条件必填基站列表,包含 1~8 项;每项为 mcc,mnc,lac,cid[,rss[,radio]],用分号 ; 分隔。无WIFI时必填。CDMA 请填 radio=cdma,此时 mnc=SID、lac=NID、cid=BID。
macsstring条件必填WIFI 接入点列表,包含 2~20 项;每项格式为 BSSID,RSSI,多项使用分号 ; 分隔。无基站时必填;没有 RSSI 时填写 -65。
coordstring可选坐标类型,支持 wgs84、gcj02、bd09,默认 wgs84。
outputstring可选返回格式,支持 csv、json、xml,默认 json。

请求代码示例

返回参数说明

名称类型说明
errcodeint返回码,0 表示查询成功。
messagestring返回结果说明。
dataobject / null查询结果;失败时为 null。
locationobject位置信息。
latitudenumber纬度,坐标类型以请求参数 coord 为准。
longitudenumber经度,坐标类型以请求参数 coord 为准。
accuracy_mnumber / null精度半径,单位为米。
addressstring / null参考地址。
positioning_modestringcell_only、wifi_only或mixed;前两者不是基站与WIFI融合定位。

CSV 字段:errcode,message,latitude,longitude,accuracy_m,address,positioning_mode

errcode说明
0查询成功
10000请求参数错误
10001无查询结果
10002API Key、账号或权限错误
10003配额不足或请求频率超限
10004服务暂时不可用

基站和WIFI至少提供一类;仅提供一类时不称为融合定位。冒号、逗号和分号可直接写入请求地址,部分客户端可能自动显示为等价的 URL 编码。

国内逆基站查询

根据经纬度查所在位置附近的基站编号

参数名类型必填说明
latnumber必填输入纬度,-90~90。
lngnumber必填输入经度,-180~180。
radiusint可选查询半径,1~10000 米,默认 2000。
limitint可选最多返回 1~10 条,默认 10。
input_coordstring可选输入坐标系:wgs84、gcj02 或 bd09,默认 wgs84。

请求代码示例

返回参数说明

名称类型说明
响应正文array成功时返回JSON数组;没有匹配数据时返回空数组 []。
mncstring / null网络码。
lacstring / null位置区或跟踪区代码。
cidstring / null小区标识;字符串避免大整数精度丢失。
accuracy_mnull暂无可用精度。

JSON 示例:[{"mnc":"11","lac":"16471","cid":"126122172","accuracy_m":null}]

使用 Authorization: Bearer <API_KEY>。空数组表示没有匹配数据。失败时返回HTTP状态(如400、401、403、429、503)及 error、message、request_id。

国内逆WiFi查询

根据经纬度查所在位置附近的WiFi-MAC地址

参数名类型必填说明
latnumber必填输入纬度,-90~90。
lngnumber必填输入经度,-180~180。
radiusint可选查询半径,1~10000 米,默认 2000。
limitint可选最多返回 1~10 条,默认 10。
input_coordstring可选输入坐标系:wgs84、gcj02 或 bd09,默认 wgs84。

请求代码示例

返回参数说明

名称类型说明
响应正文array成功时返回JSON数组;没有匹配数据时返回空数组 []。
macstring / nullWiFi接入点MAC地址。
accuracy_mnull暂无可用精度。

JSON 示例:[{"mac":"42:93:53:50:dc:99","accuracy_m":null}]

使用 Authorization: Bearer <API_KEY>。空数组表示没有匹配数据。失败时返回HTTP状态(如400、401、403、429、503)及 error、message、request_id。

国内地址解析

根据地址信息描述返回经纬度

参数名类型必填说明
addressstring必填待解析的地址描述,最长 200 字符;请进行 URL 编码。

请求代码示例

返回说明

名称类型说明
statusnumber业务状态,0 表示成功。
messagestring返回结果说明。
resultobject地址解析结果,包含位置坐标等字段;以实际返回为准。

使用 Authorization: Bearer <API_KEY>。成功时返回 JSON;失败时根据 HTTP 状态及 error、message、request_id 判断。

国内逆地址解析

根据经纬度返回地址描述信息

参数名类型必填说明
latnumber必填纬度,-85~85。
lngnumber必填经度,-180~180。

请求代码示例

返回说明

名称类型说明
statusnumber业务状态,0 表示成功。
messagestring返回结果说明。
resultobject逆地址解析结果,包含地址描述等字段;以实际返回为准。

使用 Authorization: Bearer <API_KEY>。输入坐标按纬度、经度分别传入;失败时根据 HTTP 状态及错误字段判断。

国内IP查询

根据IP地址进行定位查询

参数名类型必填说明
ipstring必填待查询的公网 IPv4 地址;不支持内网地址及 IPv6。

请求代码示例

返回说明

名称类型说明
statusnumber业务状态,0 表示成功。
messagestring返回结果说明。
resultobjectIP 位置参考信息;以实际返回为准。

使用 Authorization: Bearer <API_KEY>。IP 定位结果是区域参考位置,不代表终端的精确实时位置。

国内天气查询

通过经纬度查询对应位置的实时天气或预报天气。

参数名类型必填说明
adcodestring条件必填6 位行政区划代码;与坐标二选一。
latnumber条件必填纬度,-85~85;使用坐标查询时须与 lng 同时填写。
lngnumber条件必填经度,-180~180;使用坐标查询时须与 lat 同时填写。
typestring可选now(实时,默认)、future(预报)或 hours(逐小时)。
get_mdint可选仅用于 future,0 或 1。
added_fieldsstring可选附加字段:now 支持 alarm、air;future 支持 index、air;hours 支持 air,多个字段用逗号分隔。

请求代码示例

返回说明

名称类型说明
statusnumber业务状态,0 表示成功。
messagestring返回结果说明。
resultobject对应天气类型的结果;字段随 type 和附加字段变化,以实际返回为准。

使用 Authorization: Bearer <API_KEY>。adcode 与经纬度不能同时提交。