Skip to content

数据模型 ​

本文档列出了API使用的所有数据模型,按照公共模型在前,终端模型在后的顺序排列。

公共模型 ​

Point ​

描述地理坐标点。

字段名类型描述示例
latitudeinteger纬度3994079
longitudeinteger经度11609452

BaseGeoPoint ​

基础地理点模型。

字段名类型描述示例
latitudenumber纬度40.04811
longitudenumber经度116.28069

LatLng ​

经纬度点模型。

字段名类型描述示例
latnumber纬度39.986989
lngnumber经度116.29522

Location ​

字符串经纬度点模型。

字段名类型描述示例
latstring纬度"39.868578"
lngstring经度"116.437006"

BadResponse ​

错误响应模型。

字段名类型描述示例
statusinteger状态码30000
msgstring返回消息ENGINE_RESPONSE_DATA_ERROR
trace_idstring请求追踪 ID0ac5186e67e3f692
results-错误结果-

UnauthedResponse ​

鉴权失败的响应模型。

字段名类型描述示例
statusinteger状态码40100
msgstring返回消息API_AUTH_ERROR
trace_idstring请求追踪 ID0ac5186e67e3f692

Polyline ​

边界坐标串模型。

字段名类型描述示例
coordinatesstring边界坐标,格式为 "经度1,纬度1;经度2,纬度2;..."-

逆地理编码相关模型 ​

ReverseGeoRequest ​

逆地理编码请求模型。

字段名类型描述示例
locationstring坐标,经纬度,格式"lng,lat"116.424790,39.956953

查看逆地理编码API

ReverseGeoResponse ​

逆地理编码响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息success
trace_idstring请求追踪 ID0ac5186e67e3f692
resultsarray逆地理编码结果列表见ReverseGeoRes
查看逆地理编码API

ReverseGeoRes ​

字段名类型描述示例
namestring显示名称体坛中医医院-南3门
locationobject经纬度坐标{"lng":116.437006,"lat":39.868578}
addressstring地址北京市丰台区芳城路
citystring城市北京市
districtstring区县丰台区
adcodestring区县 ID110106
address_allstring完整地址北京市丰台区芳城路体坛中医医院-南3门
provincestring省份山东省
poi_idstringPOI唯一标识169598629118985969836542403885541727679

查看逆地理编码API

地理编码相关模型 ​

GeocodeRequest ​

地理编码请求模型。

字段名类型描述示例
addressstring地址信息北京市海淀区海淀公园
citystring城市名称北京市
查看地理编码API

GeocodeRPCResponse ​

地理编码响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息success
trace_idstring请求追踪 ID0ac5186e67e50a9c190b048d5ef3dab0
resultsobject结果列表见GeocodeResponse
查看地理编码API

GeocodeResponse ​

字段名类型描述示例
countinteger返回结果数量1
geocodesarray地理编码结果列表见GeocodeResult
查看地理编码API

GeocodeResult ​

字段名类型描述示例
adcodestring行政区划代码"110108"
citystring城市北京市
countrystring国家代码CN
districtstring区县海淀区
locationobject经纬度{"lat":39.986989,"lng":116.29522}
provincestring省份北京市
poi_idstringPOI唯一标识169598629118985969836542403885541727679
查看地理编码API

坐标转换相关模型 ​

ConvertCoordinateRequest ​

坐标转换请求模型。

字段名类型描述示例
coordsysstring坐标系类型,gps/baidugps
locationsstring多个经纬度对,格式:lng,lat;lng,lat116.281840,40.042980;116.281841,40.042981
查看坐标转换API

ConvertCoordinateResponse ​

坐标转换响应模型。

字段名类型描述示例
resultsarray转换后的坐标[{"lng":116.281840,"lat":40.042980},{"lng":116.281840,"lat":40.042980}]
statusinteger状态码10000
msgstring返回消息success
trace_idstring请求追踪 ID0ac5186e67e6475a5c1c047e51063cb0
查看坐标转换API

静态地图相关模型 ​

StaticMapRequest ​

静态地图请求模型。

字段名类型描述示例
backgroundstring背景色#FFFFFF
labelsstring标签测试,0xFF0000,0,0,0:116.437006,39.868578
locationstring地图中心点116.437006,39.868578
markersstring标记点large,0xFF0000,A:116.437006,39.868578
pathsstring路径5,0xFF0000,0.5,0,0:116.437006,39.868578;116.437006,39.868578
sizestring图片尺寸1024*768
zoominteger缩放级别12
查看静态地图API

路径规划相关模型 ​

BicyclingRequest ​

骑行路径规划请求模型。

字段名必填类型描述示例
origin是string起点坐标116.281801,40.043007
destination是string终点坐标116.285056,40.049829

查看骑行路径规划API

BicyclingResponse ​

骑行路径规划响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息success
trace_idstring请求追踪 ID0ac5186e67e3f692f0fb048158e0f9b0
resultsarray骑行路线规划结果列表见BicyclingResult

查看骑行路径规划API

BicyclingResult ​

骑行路线规划结果模型。

字段名类型描述示例
distinteger距离(单位:米)1083
durationinteger时长(单位:秒)1083
errcodeinteger错误码0
errmsgstring错误消息ok
geo_listarray路径点列表见BaseGeoPoint

查看骑行路径规划API

WalkRouteRequest ​

步行路线规划请求模型。

字段名必填类型描述示例
origin是string起点坐标116.281801,40.043007
destination是string终点坐标116.285056,40.049829

查看步行路径规划API

WalkRouteResponse ​

步行路线规划响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息success
trace_idstring请求追踪 ID0ac5186e67e3f692f0fb048158e0f9b0
resultsarray步行路线规划结果列表见WalkRouteResult

查看步行路径规划API

WalkRouteResult ​

步行路线规划结果模型。

字段名类型描述示例
distinteger距离(单位:米)1083
durationinteger时长(单位:秒)1083
errcodeinteger错误码0
errmsgstring错误消息ok
geo_listarray路径点列表见BaseGeoPoint

查看步行路径规划API

RoutePlanReq ​

批量路径规划请求模型。

字段名类型描述示例
packsarray路线规划请求参数列表见PackReq
查看驾车路径规划API

PackReq ​

字段名必填类型描述示例
origin是string起点坐标116.397128,39.916527
destination是string终点坐标116.407396,39.904200
routeplan_type是string路线规划类型"0":接驾;"1":送驾
departure_time是integer传入时间,可用于eta计算1741662325
eta_strategy否integer用于eta计算,与departure_time配合使用0:当前时间(默认值);3:未来时间
need_polyline否boolean是否需要返回路线折线true
waypoints否string途径点坐标串,多个途径点坐标按顺序以英文分号;分隔。最大支持12个途经点116.397128,39.916527;116.407396,39.904200
strategy否string驾车选择策略"1":默认;"2":时间优先;"5":距离更短;"11":高速优先;"13":不走高速
show_fields否string返回结果的扩展信息,多个字段以英文逗号分隔segments:分级路况;cost:费用

查看驾车路径规划API

RoutePlanResponse ​

批量路径规划响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息success
trace_idstring请求追踪 ID0ac5186e67e6475a5c1c047e51063cb0
resultsarray路线规划结果列表见RoutePlanResult
查看驾车路径规划API

RoutePlanResult ​

批量路径规划结果模型。

字段名类型描述示例
errcodeinteger错误码0
errmsgstring错误消息ok
routesarray多路线列表见RoutePlanRoute
查看驾车路径规划API

RoutePlanRoute ​

批量路径规划多路线模型。

字段名类型描述示例
distinteger距离(单位:米)1817
durationinteger时长(单位:秒)383
geo_listarray路径点列表见BaseGeoPoint
tagstring路线标签红绿灯少
segmentsarray分级路况见RBSegment
costobject费用见Cost

查看驾车路径规划API

RBSegment ​

路况信息

字段名类型描述示例
statusinteger状态0 未知 1 畅通 2 缓行 3 拥堵 4 严重拥堵
distanceinteger距离(单位:米)100
start_indexinteger开始下标0
end_indexinteger结束下标11

查看驾车路径规划API

Cost ​

道路收费费用

字段名类型描述示例
tollsstring此路线道路收费总费用,单位:元20

查看驾车路径规划API

红绿灯相关模型 ​

CrossInfoRequest ​

路口信息请求模型。

参数名必填类型描述示例值
citycode是integer城市代码,见城市代码表1
format否string返回格式,可选 proto/json,默认为 jsonjson
version否string当前版本号,若服务端版本号与参数一致则返回304未更新,不一致或不传则返回全量数据和最新版本号2025121912

查看路口信息API

CrossInfoResponse ​

路口信息响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息OK
trace_idstring请求追踪IDac197dab67ecfc86cae83742d7dd86b0
resultsarray路口信息列表和最新版本号见CrossInfoResult

查看路口信息API

CrossInfoResult ​

字段名类型描述示例
versionstring最新版本号2025121912
dataarray路口信息列表见CrossInfo

CrossInfo ​

路口信息模型。

字段名类型描述示例
crossIdinteger路口ID9000119041941
crossNamestring路口名称顺黄路,孙河组团六号路交界
longitudeinteger经度11652326
latitudeinteger纬度4005840
cityCodeinteger城市代码,见城市代码表1
systemTimeStampinteger系统时间戳1743584391
lampStatusListarray分方向信控相位见 lampStatusList

lampStatusList ​

分方向静态信息

字段名类型描述示例
directioninteger行车方向,见 行车方向定义5
lampStatusinteger车道流向和信控,见 lampStatus11
dir_pointsPoint[]行车方向红绿灯入link的头部/尾部经纬度[{"latitude":4021097,"longitude":11666784},{"latitude":4020950,"longitude":11666784}]
lamp_pointsPoint[]信控方向红绿灯出link的头部/尾部经纬度[{"latitude":4020950,"longitude":11666784},{"latitude":4020931,"longitude":11666780}]

行车方向定义 ​

字段名类型描述示例说明
directioninteger行车方向5"0": "北向南",
"1": "东北向西南",
"2": "东向西",
"3": "东南向西北",
"4": "南向北",
"5": "西南向东北",
"6": "西向东",
"7": "西北向东南"

设正北方向为0度,则:

  • 南向北为 [-22.5, 22.5)
  • 西南向东北为 [22.5, 67.5)
  • 西向东为 [67.5, 112.5)
  • 西北向东南为 [112.5, 157.5)
  • 北向南为 [157.5, 202.5)
  • 东北向西南为 [202.5, 247.5)
  • 东向西为 [247.5, 292.5)
  • 东南向西北为 [292.5, 337.5)

以上方向均为左闭右开区间

lampStatus ​

字段名类型描述示例说明
lampStatusinteger车道流向和信控11"11": "直行, 驶出路口方向与驶入方向夹角<=30°"
"12": "左转,30°<驶出路口方向与驶入方向夹角<150°"
"13": "右转,30°<驶出路口方向与驶入方向夹角<150°"
"21": "直左混行"
"22": "直右混行"
"23": "左右混行"
"31": "150°<=掉头驶出路口方向与驶入方向夹角<=180°"
"57": "直左右混行"
"99": "其他"

TrafficLightRequest ​

红绿灯请求模型。

字段名必填类型描述示例
citycode是integer城市代码,见城市代码表1
cross_ids是array路口ID列表["9000194204687","73340538"]
format否string返回格式,可选 proto/json,默认为 jsonjson
version否string当前版本号,若服务端版本号与参数一致则返回304未更新,不一致或不传则返回全量数据和最新版本号202512241031

TrafficLightResponse ​

红绿灯响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息success
trace_idstring请求追踪 ID0ac5186e67ecfd1531920473f30856b0
resultsarray红绿灯信息列表和最新版本号见 TrafficLightResult

TrafficLightResult ​

字段名类型描述示例
versionstring最新版本号2025121912
dataarray红绿灯信息列表见TrafficLight

TrafficLight ​

红绿灯信息模型。

字段名类型描述示例
cityCodeinteger城市代码,见城市代码表1
confidenceinteger可信度100
crossIdinteger路口ID9000194204687
crossNamestring路口名称增产路,黑山大街交界
latitudeinteger纬度3994087
longitudeinteger经度11609462
phaseLampStatusListarray相位状态列表见PhaseLampStatus
systemTimeStampinteger系统时间戳1743584533

PhaseLampStatus ​

交通灯相位状态模型。

字段名类型描述示例
batchTimeinteger批次时间1743577200
confidenceinteger可信度,下线是0,准出是100100
cycleinteger周期86
directioninteger行车方向,见 行车方向定义5
greenDurationinteger绿灯持续时间(单位:秒)51
redDurationinteger红灯持续时间(单位:秒)31
yellowDurationinteger黄灯持续时间(单位:秒)4
lampStatusinteger车道流向和信控,见 lampStatus11
versionstring版本"2.0"
offsetinteger首次变灯偏移(生效时间内首次红变绿偏移时间,单位:秒)84
phaseStartTimeinteger相位开始时间(单位:分钟,(例:0:00 = 0;8:00 = 480))1022
phaseEndTimeinteger相位结束时间(单位:分钟,(例:0:00 = 0;8:00 = 480))1032
dir_pointsPoint[]行车方向红绿灯入link的头部/尾部经纬度-
lamp_pointsPoint[]信控方向红绿灯出link的头部/尾部经纬度-
in_linkid_naviuint64驶入该红绿灯节点的linkid123456789
out_linkid_naviuint64驶出该红绿灯节点的linkid987654321

TrafficRasterRequest ​

路况栅格图请求模型。

字段名类型描述示例
citystring城市名称北京市
xinteger瓦片坐标x843
yinteger瓦片坐标y414
zinteger层级10

地点搜索相关模型 ​

PlaceAroundRequest ​

周边搜索请求模型。

字段名类型描述示例
keywordsstring检索关键词麦当劳
locationstring坐标,经纬度,格式"lng,lat"116.424790,39.956953
citystring城市名北京市
max_distancestring检索距离的最大米数"1000"
sort_rulestring排序规则"distance"
typesstringPOI过滤类型(每个类型6位数字),支持传多个。全部POI编码参考POI分类表"101000,101020"
show_fieldsstring返回结果的扩展信息,sub_poi_list:返回子点数据, 不传则不返回子点数据"sub_poi_list"
city_limitboolean是否限定在当前城市检索,默认false 不限定城市false

查看周边搜索API

TextSearchRequest ​

关键词搜索请求模型。

字段名类型描述示例
keywordsstring检索关键词麦当劳
citystring查询城市北京市
locationstring坐标,经纬度,格式"lng,lat"117.147277,39.14752
typesstringPOI过滤类型(每个类型6位数字),支持传多个。全部POI编码参考POI分类表"101000,101020"
show_fieldsstring返回结果的扩展信息,sub_poi_list:返回子点数据, 不传则不返回子点数据"sub_poi_list"
city_limitboolean是否限定在当前城市检索,默认false 不限定城市false

查看关键词搜索API

TextSearchResponse ​

POI搜索响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息OK
trace_idstring请求追踪ID0ac5186e6800fd050728047bd68f26b0
resultsarrayPOI结果列表见TextSearchRes

查看关键词搜索API

TextSearchRes ​

POI搜索结果模型。

字段名类型描述示例
namestring显示名称麦当劳(和平里东街店)
locationobject经纬度坐标{"lng": 116.42479,"lat": 39.956953}
addressstring地址东城区和平里街道和平里6区8号楼1层109-2号
provincestring省份北京市
citystring城市名称北京市
districtstring行政区东城区
adcodestring行政编码,最高精确到区县110101
address_allstring完整地址东城区和平里街道和平里6区8号楼1层109-2号麦当劳(和平里东街店)
distanceint距离,米130
poi_idstringPOI唯一标识169598629118985969836542403885541727679
sub_poi_listarray子点列表,包含子POI点的详细信息见OpenSubPoi
typestringpoi点的类型"102000"

查看周边搜索API

OpenSubPoi ​

POI子点信息模型。

字段名类型描述示例
poi_idstring子点ID,POI唯一标识"179919584780088526038817699620865083589"
namestring子点名称体坛中医医院-南3门
addressstring子点地址北京市丰台区芳城路
locationobject子点经纬度{"lng": 116.42479,"lat": 39.956953}
typestring子点类型"131000"
select_tagstring子点热度标签""

查看周边搜索API

PolygonSearchRequest ​

关键词搜索请求模型。

字段名类型描述示例
keywordsstring检索关键词麦当劳
polygonsstring矩形数组,每个元素代表一个矩形,格式: ["左上经纬度;右下经纬度", ...],最多同时传 10 个矩形["122.12482,37.4808;122.14271,37.46796", "119.44238,36.68486;119.47902,36.64199"]

查看多边形检索API

PolygonSearchResponse ​

POI搜索响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息OK
trace_idstring请求追踪ID0ac5186e6800fd050728047bd68f26b0
resultsarrayPOI结果列表见PolygonSearchRes

查看多边形检索API

PolygonSearchRes ​

POI搜索结果模型。

字段名类型描述示例
namestring显示名称中国石化加油站(威海石岛第44加油站)
locationobject经纬度坐标{"lng": 122.382574,"lat": 36.931369}
addressstring地址山东省威海市荣成市吴家村
provincestring省份山东省
citystring城市名称威海市
districtstring行政区荣成市
adcodestring行政编码,最高精确到区县371082
address_allstring完整地址山东省威海市荣成市吴家村中国石化加油站(威海石岛第44加油站)
distanceint距离,米130
poi_idstringPOI唯一标识QSUa3erMXAIIjMX8WVOjSnHvvGAZ0F2OxOHOGYj86OU
typestringpoi点的类型"191000"

查看多边形检索API

公交相关模型 ​

MetroStop ​

地铁站点模型。

字段名类型描述示例
idstring站点ID-
namestring站点名称-
locationstring站点位置-

MetroEntrance ​

地铁入口模型。

字段名类型描述示例
namestring入口名称-
locationstring入口位置-

BusWalkingStep ​

公交步行步骤模型。

字段名类型描述示例
actionarray行动-
action_codearray行动代码-
directionarray方向-
distanceinteger距离-
durationinteger时长-
instructionstring指令-
polylinestring折线路径-
roadstring道路-

BusWalking ​

公交步行模型。

字段名类型描述示例
originstring起点-
destinationstring终点-
distanceinteger距离-
durationinteger时长-
stepsarray步骤列表-

MetroBus ​

地铁公交模型。

字段名类型描述示例
idstringID-
namestring名称-
typeinteger类型-
distanceinteger距离-
durationinteger时长-
polylinestring折线路径-
departure_stopobject出发站-
arrival_stopobject到达站-
via_stopsarray途径站点-
via_stops_countinteger途径站点数量-
first_timestring首班车时间-
last_timestring末班车时间-
start_stationstring起始站-
terminal_stationstring终点站-
costinteger花费-

BusSegment ​

公交路段模型。

字段名类型描述示例
modestring模式WALKING TRANSIT
walkingobject步行信息-
entranceobject入口信息-
exitobject出口信息-
metrobusarray地铁公交信息-

BusTransit ​

公交路线规划中的一条路线方案。

字段名类型描述示例
originstring起点坐标116.28187,40.0429
destinationstring终点坐标116.28512,40.04989
costinteger价格,单位:分200
durationinteger行程时间(秒)1440
distanceinteger总距离(米)1862
walking_distanceinteger步行距离(米)423
segmentsarray路线段列表-

BusWalking ​

公交路线规划中的步行段。

字段名类型描述示例
originstring步行起点坐标116.28184,40.04298
destinationstring步行终点坐标116.28142,40.04291
distanceinteger步行距离(米)36
durationinteger步行时间(秒)60
stepsarray步行分段-

BusWalkingStep ​

公交路线规划中的步行分段。

字段名类型描述示例
instructionstring指示信息-
roadstring道路名称-
distanceinteger分段距离(米)36
durationinteger分段时间(秒)0
polylinestring分段坐标串116.28184,40.04298;116.28167,40.04295;116.28142,40.04291
actionarray行动指示["直行"]
action_codearray行动代码[0]
directionarray方向指示["东"]

MetroBus ​

公交路线规划中的公交/地铁线路。

字段名类型描述示例
namestring线路名称软件园通勤环线(一二期)
idstring线路ID60000015617510001
typeinteger类型,1表示公交1
departure_stopobject上车站点-
arrival_stopobject下车站点-
start_stationstring起始站-
terminal_stationstring终点站地铁西二旗站南
distanceinteger乘车距离(米)1439
durationinteger乘车时间(秒)603
costinteger票价(分)200
first_timestring首班车时间07:30
last_timestring末班车时间19:30
polylinestring路线坐标串116.281443,40.042871;116.28113,40.04282;116.28046,40.04273
via_stops_countinteger途经站点数量2
via_stopsarray途经站点列表-

MetroStop ​

公交/地铁站点。

字段名类型描述示例
namestring站点名称软件园西一路南口
idstring站点ID90002773733280001
locationstring站点坐标116.281443,40.042869

TransitRouteRequest ​

公交路线规划请求模型。

字段名必填类型描述示例
origin是string起点坐标,格式:经度,纬度116.28184,40.04298
destination是string终点坐标,格式:经度,纬度116.28516,40.04979
city是string城市名称北京市
strategy否integer偏好,0:推荐模式; 1:最快捷模式; 2:最少步行模式; 3:最少换乘模式; 4:不乘地铁模式; 5:地铁优先模式0
departure_time否integer出发时间,unix秒级时间戳,默认0表示现在出发0
route_num否integer返回方案个数,取值1-10,默认55

查看公交路径规划API

TransitRouteResponse ​

公交路线规划响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息OK
trace_idstring请求追踪ID0ac5186e6809ecb33aac047eab35b4b0
resultsarray公交路线规划结果列表见BusTransit

查看公交路径规划API

车信服务相关模型 ​

CarLaneResponse ​

车信服务响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息OK
trace_idstring请求追踪ID0ac5186e67e513a96bd404838be2d3b0
resultsobject车信变更结果见CarLaneResult

查看车信服务API

CarLaneResult ​

车信变更结果模型。

字段名类型描述示例
versionstring最新版本号2026033012
countinteger当前返回的车信变更条数2
itemsarray车信变更列表见CarLaneItem

查看车信服务API

CarLaneItem ​

车信变更项模型。

字段名类型描述示例
admincodestring行政区划代码340104
arrow1string变更前(上一版)的箭头1a_14
arrow2string变更后(最新版)的箭头14a
link_idstring进入 link 编号10068487280
versionstring最新版的版本号2026033012
inlink_coordsarray进入 link 的坐标串,截取20米,不足20米则提供完整 link 坐标[[117.21984,31.82142],[117.219956,31.8214284]]

查看车信服务API

交通事件相关模型 ​

TrafficIncidentResponse ​

交通事件响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息OK
trace_idstring请求追踪ID0ac5186e67e513a96bd404838be2d3b0
resultsobject交通事件结果见Results

查看交通事件API

Results ​

交通事件结果模型。

字段名类型描述示例
eventsDataarray交通事件列表见Event
lastTraceIdinteger最后一个事件ID470037591

查看交通事件API

Event ​

交通事件模型。

字段名类型描述示例
eventIDinteger事件ID470037591
eventTypeinteger事件类型100
briefstring事件简述裕安路发生事故
eventDescstring事件详细描述裕安路发生事故
roadNamestring道路名称裕安路
expresswayboolean是否高速公路false
startTimeinteger开始时间(时间戳)1747033837
endTimeinteger结束时间(时间戳)1747034737
updateTimeinteger更新时间(时间戳)1747034008
xnumber事件位置经度116.54529
ynumber事件位置纬度40.08189
linesarray事件相关路线坐标点见Line

查看交通事件API

Line ​

交通事件线路点模型。

字段名类型描述示例
longitudenumber线路点经度116.54529
latitudenumber线路点纬度40.08189

查看交通事件API

定位相关模型 ​

LocRgeoRequest ​

基站/WiFi定位请求模型。

字段名类型描述示例
accesstypestring接入网络方式,1-移动网络 2-wifi 3-融合定位"1"
btsstring接入基站信息460,1,12345,987654321,-75,1
diustring设备唯一编号"123456"
historybtsstring历史基站信息460,1,12346,987654322,-80,2
macsstringWiFi列表信息88:6A:D3:4F:2E:1C,-68,HomeWiFi,120
mmacstring已连接WiFi信息00:1A:2B:3C:4D:5E,-45,TP-Link_5G,60
nearbtsstring周边基站信息460,1,12346,987654322,-80,2
typestring基站类型,0-未知,1-GTW,2-CDMA,3-LTE"1"

LocRgeoResponse ​

基站/WiFi定位响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息success
trace_idstring请求追踪 ID0ac5186e67e50a9c190b048d5ef3dab0
resultsarray搜索结果列表-

LocRgeoResult ​

基站/WiFi定位结果模型。

字段名类型描述示例
citystring城市石家庄市
provincestring省份河北省
poistringPOI体坛中医医院-南3门
radiusinteger定位半径1000
locationobject经纬度{"lat":39.986989,"lng":116.29522}

IP定位相关模型 ​

IPLocationRPCResponse ​

IP定位响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息success
trace_idstring请求追踪 ID0ac5186e67e50a9c190b048d5ef3dab0
resultsobject结果列表见IPLocationResponse
查看IP定位API

IPLocationResponse ​

字段名类型描述示例
citystring城市北京市
countrystring国家中国
districtstring区县海淀区
locationobject经纬度{"lat":39.986989,"lng":116.29522}
provincestring省份北京市
查看IP定位

行政区域查询相关模型 ​

DistrictRPCResponse ​

行政区划查询响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息success
trace_idstring请求追踪 ID0ac5186e67e50a9c190b048d5ef3dab0
resultsobject结果列表见DistrictSearchResponse

查看行政区域查询API

DistrictSearchResponse ​

字段名类型描述示例
districtsarray行政区划列表见District
查看行政区域查询API

District ​

字段名类型描述示例
adcodestring行政区划编码-
namestring行政区划名称-
levelstring行政区划级别-
centerobject经纬度,格式为 "经度,纬度"{"lng":116.29522,"lat":39.986989}
polylineobject行政区划边界坐标-
districtsarray下级行政区划-
查看行政区域查询API

AOI查询相关模型 ​

AoiRequest ​

AOI查询请求模型。

字段名类型描述示例
keystring鉴权用的 API KeyYOUR_API_KEY
poi_idstring要查询轮廓区域的 POI ID,可以通过检索类接口获取POI ID"115771255188811515789773365485059874514"
locationstring所在地的经纬度,格式'lng,lat',(经度,纬度)116.314230,39.979392

查看AOI查询API

AoiResponse ​

AOI查询响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息success
trace_idstring请求追踪 ID0ac5186e67e50a9c190b048d5ef3dab0
resultsobject结果列表见AoiResult

查看AOI查询API

AoiResult ​

字段名类型描述示例
countinteger数量1
dataarray结果数组见 PoiDetail

查看AOI查询API

PoiDetail ​

字段名类型描述示例
namestring显示名称体坛中医医院-南3门
locationobject位置{"lng":116.437006,"lat":39.868578}
addressstring地址北京市丰台区芳城路
provincestring省份北京市
citystring城市北京市
districtstring行政区丰台区
adcodestring行政编码,最高精确到区县110108
address_allstring完整地址北京市丰台区芳城路体坛中医医院-南3门
poi_idstringPOI唯一标识179919584780088526038817699620865083589
areanumber面积,单位平方米14617.951
coordinatesstring经纬度点串结果,格式为经度在前,纬度在后,中间英文逗号分隔,坐标点串之间分号分隔116.3140162,39.9798514;116.313515,39.9800486; 116.3133198,39.9800192

周边推荐相关模型 ​

AroundRecommendRequest ​

周边推荐请求模型。

字段名类型描述示例
keystring鉴权用的 API KeyYOUR_API_KEY
locationstring所在地的经纬度,格式'lng,lat',(经度,纬度)116.314230,39.979392

查看周边推荐API

AroundRecommendResponse ​

周边推荐响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息success
trace_idstring请求追踪 ID0ac5186e67e50a9c190b048d5ef3dab0
resultsobject结果列表见AroundRecommendResult

查看周边推荐API

AroundRecommendResult ​

字段名类型描述示例
addressstring地址北京市海淀区丹棱街甲1号
citystring城市北京市
distancenumber与请求输入的经纬度所在位置的距离,单位: 米1000
districtstring行政区海淀区
locationobject位置{"lng":116.29522,"lat":39.986989}
namestring名称北京中关村领展广场
poi_idstringPOI唯一标识115771255188811515789773365485059874514
provincestring省份北京市
typestringpoi类型131000

规避限行相关模型 ​

VehicleRestrictionRequest ​

规避限行请求模型

字段名类型描述示例
vehiclesarray车辆信息,最多20个见VehicleInfo

查看规避限行API

VehicleInfo ​

规避限行车辆信息模型

字段名类型描述示例
citystring城市名称北京市
numberstring车牌号码津A12345
startstring起点经纬度,格式'lng,lat',(经度,纬度)117.24034,39.11563
endstring终点经纬度,格式'lng,lat',(经度,纬度)117.34882,39.0665
timestring出发时间,秒级时间戳,默认使用当前时间1753326977
plate_colorstring车牌颜色Blue:蓝,Yellow: 黄,Black:黑,White:白,Green:绿,YellowAndGreen:黄绿
is_licensestring是否有通行证0:无(默认),1:有

查看规避限行API

VehicleRestrictionResponse ​

规避限行响应模型

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息OK
trace_idstring请求追踪 ID0aa9cc8068ccc548b7eecaa73d3e0702
resultsarray结果列表见VehicleRestriction

VehicleRestriction ​

字段名类型描述示例
restrictedinteger车辆是否限行0:不限行,1:起点限行,2:终点限行

查看规避限行API

地址文本解析相关模型 ​

AddressIdentifyRequest ​

地址文本解析请求模型。

字段名类型描述示例
keystring鉴权用的 API KeyYOUR_API_KEY
address_textstring要解析的地址文本信息北京北京市海淀区上地街道东软大厦
show_codestring等于1时,返回省市区街道 对应的编码。默认不返回1
order_nostring订单号/运单号125435247675889
lastring语种识别标记。cht表示繁体,en表示英文,chs表示简体,传其它值或不传时取值chschs
address_tagstring地址标签。src表示寄件地址,dest表示派件地址,other 其它类型地址src

查看地址文本解析API

AddressIdentifyResponse ​

地址文本解析响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息success
trace_idstring请求追踪 ID0ac5186e67e50a9c190b048d5ef3dab0
resultsobject结果列表见AddressIdentifyResult

查看地址文本解析API

AddressIdentifyResult ​

字段名类型描述示例
codeinteger请求状态:0-成功,1-地址识别失败,2-请求地址识别服务失败0
messagestringcode=1或2时,展示具体错误信息-
paidataobject响应数据集见AddressidentifyPaiData
srcstring数据的来源-
dataobject响应数据集见AddressidentifyData
snstring结果标识 sn 码(唯一标识)1662412025102819305080141832
multiplestring提示用户补全省市地址信息。返回“1”,表示请求文本中不包含省市信息,且区县在全国范围内有重复1
markstring返回“1”,表示请求地址中包含省市区任意信息;
返回“0”,表示请求地址中不包含省市区信息
1
resultstring对比文本提取的省市区与服务识别的结果是否一致。
返回“1”,表示二者完全一致;
返回“0”,表示二者不完全一致,存在字段内容不一致的情况。
注意:如果二者中一方缺失,则默认二者一致,即result=1
1
moreThanstring返回“0”,表示省市区都无多个;
返回“1”,表示省有多个,不论市区是否有多个;
返回“2”,表示省无多个,市有多个,不论区是否有多个;
返回“3”,表示省市都无多个,区有多个
0
dispatchMarkstring返回“0”,表示不可收派;
返回“1”,表示可收派
1
conflictstring对比识别的省市区与从文本中提取的结果是否一致。
返回“2”,表示省不一致;
返回“3”,表示市不一致;
返回“4”,表示区不一致;
返回“5”,表示街道不一致
4

查看地址文本解析API

AddressidentifyPaiData ​

字段名类型描述示例
personnamearray文本中可能的人名,有多个时只输出一个["张三"]
nationalPhoneCodestring电话号码的区号010
phoneNumberstring文本中可能的联系电话,有多个时只输出一个010-65891234
extensionstring分机号-
addressstring提取出人名电话后的地址北京北京市海淀区上地街道东软大厦
remarkstring备注信息-

查看地址文本解析API

AddressidentifyData ​

字段名类型描述示例
provincestring省份北京市
citystring城市北京市
countystring区县海淀区
townstring乡镇上地街道
adcodestring地址所在的6位行政区划代码110108
citycodestring城市编码010
detailaddrstring详细地址北京东软大厦
provinceCodestring省份编码。show_code=1 时返回110000
cityLevCodestring城市编码。show_code=1 时返回110100
countyCodestring区县编码。show_code=1 时返回110108
townCodestring乡镇(街道)编码。show_code=1 时返回110108022000
tipProvincestring直接从请求文本中提取的省份,如与识别的一致则为空-
tipCitystring直接从请求文本中提取的城市,如与识别的一致则为空-
tipCountystring直接从请求文本中提取的区县,如与识别的一致则为空-
tipTownstring直接从请求文本中提取的乡镇(街道),如与识别的一致,则为空-

查看地址文本解析API

违停区域查询相关模型 ​

ParkingJudgeRequest ​

违停区域查询请求模型。

字段名类型描述示例
locationstring查询点经纬度,格式:lng,lat116.314230,39.979392

查看违停区域查询API

ParkingJudgeResponse ​

违停区域查询响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息success
trace_idstring请求追踪 ID0ac5186e67e50a9c190b048d5ef3dab0
resultsobject查询结果见ParkingJudgeResult

查看违停区域查询API

ParkingJudgeResult ​

违停区域查询结果模型。

字段名类型描述示例
parking_statusstring违停状态:
- NO_PARKING: 禁止停车区域
- LIMIT_PARKING: 限停区域
- NORMAL: 正常区域,可停车
NORMAL
limit_durationinteger限停时长(秒),仅在 LIMIT_PARKING 时返回180

查看违停区域查询API

道路信息查询相关模型 ​

RouteFeatureRequest ​

道路信息查询请求模型。

字段名类型描述示例
packsarray按行驶顺序排列的 GPS 点数组,至少包含 1 个点,最多包含 100 个点见 RouteFeaturePack

查看道路信息查询API

RouteFeaturePack ​

道路信息查询 GPS 点模型。

字段名类型描述示例
locationstring点坐标,格式为 lng,lat。经度范围 [-180,180],纬度范围 [-90,90]113.953895,22.736234
timestampintegerGPS 点的采集时间,正数、秒级 Unix 时间戳;传入多个点时须按 packs 数组顺序非递减1789156040

查看道路信息查询API

RouteFeatureResponse ​

道路信息查询响应模型。

字段名类型描述示例
statusinteger状态码10000
msgstring返回消息OK
trace_idstring请求追踪 IDac197cb96aaa61ff64803f4a5a1eacb0
resultsobject道路信息查询结果见 RouteFeatureResult

查看道路信息查询API

RouteFeatureResult ​

道路信息查询结果模型。

字段名类型描述示例
countinteger返回道路数量,等于 roads 数组长度1
roadsarray按轨迹对应的道路顺序返回的道路信息列表见 RouteFeatureRoad

查看道路信息查询API

RouteFeatureRoad ​

道路信息模型。

字段名类型描述示例
namestring道路名称。无名称时为空字符串茶林路
typestring道路等级名称,例如“高速道路”“国道”“县道”。未知时为空字符串县道
speed_limitnumber限速,单位为 km/h40
geo_liststring道路几何点串,格式为 lng,lat;lng,lat。相邻点之间以英文分号分隔113.95387,22.73672;113.95385,22.73593

查看道路信息查询API