Appearance
数据模型
本文档列出了API使用的所有数据模型,按照公共模型在前,终端模型在后的顺序排列。
公共模型
Point
描述地理坐标点。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| latitude | integer | 纬度 | 3994079 |
| longitude | integer | 经度 | 11609452 |
BaseGeoPoint
基础地理点模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| latitude | number | 纬度 | 40.04811 |
| longitude | number | 经度 | 116.28069 |
LatLng
经纬度点模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| lat | number | 纬度 | 39.986989 |
| lng | number | 经度 | 116.29522 |
Location
字符串经纬度点模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| lat | string | 纬度 | "39.868578" |
| lng | string | 经度 | "116.437006" |
BadResponse
错误响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 30000 |
| msg | string | 返回消息 | ENGINE_RESPONSE_DATA_ERROR |
| trace_id | string | 请求追踪 ID | 0ac5186e67e3f692 |
| results | - | 错误结果 | - |
UnauthedResponse
鉴权失败的响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 40100 |
| msg | string | 返回消息 | API_AUTH_ERROR |
| trace_id | string | 请求追踪 ID | 0ac5186e67e3f692 |
Polyline
边界坐标串模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| coordinates | string | 边界坐标,格式为 "经度1,纬度1;经度2,纬度2;..." | - |
逆地理编码相关模型
ReverseGeoRequest
逆地理编码请求模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| location | string | 坐标,经纬度,格式"lng,lat" | 116.424790,39.956953 |
ReverseGeoResponse
逆地理编码响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | success |
| trace_id | string | 请求追踪 ID | 0ac5186e67e3f692 |
| results | array | 逆地理编码结果列表 | 见ReverseGeoRes |
| 查看逆地理编码API |
ReverseGeoRes
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| name | string | 显示名称 | 体坛中医医院-南3门 |
| location | object | 纬度 | {"lng":116.437006,"lat":39.868578} |
| address | string | 地址 | 北京市丰台区芳城路 |
| city | string | 城市 | 北京市 |
| district | string | 区县 | 丰台区 |
| adcode | string | 区县 ID | 110106 |
| address_all | string | 完整地址 | 北京市丰台区芳城路体坛中医医院-南3门 |
| province | string | 省份 | 山东省 |
| poi_id | string | POI唯一标识 | 169598629118985969836542403885541727679 |
地理编码相关模型
GeocodeRequest
地理编码请求模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| address | string | 地址信息 | 北京市海淀区海淀公园 |
| city | string | 城市名称 | 北京市 |
| 查看地理编码API |
GeocodeRPCResponse
地理编码响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | success |
| trace_id | string | 请求追踪 ID | 0ac5186e67e50a9c190b048d5ef3dab0 |
| results | object | 结果列表 | 见GeocodeResponse |
| 查看地理编码API |
GeocodeResponse
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| count | integer | 返回结果数量 | 1 |
| geocodes | array | 地理编码结果列表 | 见GeocodeResult |
| 查看地理编码API |
GeocodeResult
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| adcode | string | 行政区划代码 | "110108" |
| city | string | 城市 | 北京市 |
| country | string | 国家代码 | CN |
| district | string | 区县 | 海淀区 |
| location | object | 经纬度 | {"lat":39.986989,"lng":116.29522} |
| province | string | 省份 | 北京市 |
| poi_id | string | POI唯一标识 | 169598629118985969836542403885541727679 |
| 查看地理编码API |
坐标转换相关模型
ConvertCoordinateRequest
坐标转换请求模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| coordsys | string | 坐标系类型,gps/baidu | gps |
| locations | string | 多个经纬度对,格式:lng,lat;lng,lat | 116.281840,40.042980;116.281841,40.042981 |
| 查看坐标转换API |
ConvertCoordinateResponse
坐标转换响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| results | array | 转换后的坐标 | [{"lng":116.281840,"lat":40.042980},{"lng":116.281840,"lat":40.042980}] |
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | success |
| trace_id | string | 请求追踪 ID | 0ac5186e67e6475a5c1c047e51063cb0 |
| 查看坐标转换API |
静态地图相关模型
StaticMapRequest
静态地图请求模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| background | string | 背景色 | #FFFFFF |
| labels | string | 标签 | 测试,0xFF0000,0,0,0:116.437006,39.868578 |
| location | string | 地图中心点 | 116.437006,39.868578 |
| markers | string | 标记点 | large,0xFF0000,A:116.437006,39.868578 |
| paths | string | 路径 | 5,0xFF0000,0.5,0,0:116.437006,39.868578;116.437006,39.868578 |
| size | string | 图片尺寸 | 1024*768 |
| zoom | integer | 缩放级别 | 12 |
| 查看静态地图API |
路径规划相关模型
BicyclingRequest
骑行路径规划请求模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| origin | string | 起点坐标 | 116.281801,40.043007 |
| destination | string | 终点坐标 | 116.285056,40.049829 |
BicyclingResponse
骑行路径规划响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | success |
| trace_id | string | 请求追踪 ID | 0ac5186e67e3f692f0fb048158e0f9b0 |
| results | array | 骑行路线规划结果列表 | 见BicyclingResult |
BicyclingResult
骑行路线规划结果模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| dist | integer | 距离(单位:米) | 1083 |
| duration | integer | 时长(单位:秒) | 1083 |
| errcode | integer | 错误码 | 0 |
| errmsg | string | 错误消息 | ok |
| geo_list | array | 路径点列表 | 见BaseGeoPoint |
WalkRouteRequest
步行路线规划请求模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| origin | string | 起点坐标 | 116.281801,40.043007 |
| destination | string | 终点坐标 | 116.285056,40.049829 |
WalkRouteResponse
步行路线规划响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | success |
| trace_id | string | 请求追踪 ID | 0ac5186e67e3f692f0fb048158e0f9b0 |
| results | array | 步行路线规划结果列表 | 见WalkRouteResult |
WalkRouteResult
步行路线规划结果模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| dist | integer | 距离(单位:米) | 1083 |
| duration | integer | 时长(单位:秒) | 1083 |
| errcode | integer | 错误码 | 0 |
| errmsg | string | 错误消息 | ok |
| geo_list | array | 路径点列表 | 见BaseGeoPoint |
RoutePlanReq
批量路径规划请求模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| packs | array | 路线规划请求参数列表 | 见PackReq |
| 查看驾车路径规划API |
PackReq
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| origin | string | 起点坐标 | 116.397128,39.916527 |
| destination | string | 终点坐标 | 116.407396,39.904200 |
| departure_time | integer | 传入时间,可用于eta计算 | 1741662325 |
| eta_strategy | integer | 用于eta计算,与departure_time配合使用 | 0:当前时间(默认值);3:未来时间 |
| routeplan_type | string | 路线规划类型 | "0":接驾;"1":送驾 |
| need_polyline | boolean | 是否需要返回路线折线 | true |
| waypoints | string | 途径点坐标串,多个途径点坐标按顺序以英文分号;分隔。最大支持3个途经点 | 116.397128,39.916527;116.407396,39.904200 |
| strategy | string | 驾车选择策略 | "1":默认;"2":时间优先;"5":距离更短;"11":高速优先;"13":不走高速 |
| 查看驾车路径规划API |
RoutePlanResponse
批量路径规划响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | success |
| trace_id | string | 请求追踪 ID | 0ac5186e67e6475a5c1c047e51063cb0 |
| results | array | 路线规划结果列表 | 见RoutePlanResult |
| 查看驾车路径规划API |
RoutePlanResult
批量路径规划结果模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| errcode | integer | 错误码 | 0 |
| errmsg | string | 错误消息 | ok |
| routes | array | 多路线列表 | 见RoutePlanRoute |
| 查看驾车路径规划API |
RoutePlanRoute
批量路径规划多路线模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| dist | integer | 距离(单位:米) | 1817 |
| duration | integer | 时长(单位:秒) | 383 |
| geo_list | array | 路径点列表 | 见BaseGeoPoint |
| tag | string | 路线标签 | 红绿灯少 |
| 查看驾车路径规划API |
红绿灯相关模型
CrossInfoRequest
路口信息请求模型。
| 参数名 | 必选 | 类型 | 描述 | 示例值 |
|---|---|---|---|---|
| citycode | 是 | integer | 城市代码,见城市代码表 | 1 |
| format | 否 | string | 返回格式,proto/json,默认为 json | json |
| version | 否 | string | 当前版本号,若服务端版本号与参数一致则返回304未更新,不一致或不传则返回全量数据和最新版本号 | 2025121912 |
CrossInfoResponse
路口信息响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | OK |
| trace_id | string | 请求追踪ID | ac197dab67ecfc86cae83742d7dd86b0 |
| results | array | 路口信息列表和最新版本号 | 见CrossInfoResult |
CrossInfoResult
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| version | string | 最新版本号 | 2025121912 |
| data | array | 路口信息列表 | 见CrossInfo |
CrossInfo
路口信息模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| crossId | integer | 路口ID | 9000119041941 |
| crossName | string | 路口名称 | 顺黄路,孙河组团六号路交界 |
| longitude | integer | 经度 | 11652326 |
| latitude | integer | 纬度 | 4005840 |
| cityCode | integer | 城市代码,见城市代码表 | 1 |
| systemTimeStamp | integer | 系统时间戳 | 1743584391 |
TrafficLightRequest
红绿灯请求模型。
| 字段名 | 必选 | 类型 | 描述 | 示例 |
|---|---|---|---|---|
| citycode | 是 | integer | 城市代码,见城市代码表 | 1 |
| cross_ids | 是 | array | 路口ID列表 | ["9000194204687","73340538"] |
| format | 否 | string | 返回格式,proto/json,默认为 json | json |
| version | 否 | string | 当前版本号,若服务端版本号与参数一致则返回304未更新,不一致或不传则返回全量数据和最新版本号 | 202512241031 |
TrafficLightResponse
红绿灯响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | success |
| trace_id | string | 请求追踪 ID | 0ac5186e67ecfd1531920473f30856b0 |
| results | array | 红绿灯信息列表和最新版本号 | 见TrafficLightResult |
TrafficLightResult
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| version | string | 最新版本号 | 2025121912 |
| data | array | 红绿灯信息列表 | 见TrafficLight |
TrafficLight
红绿灯信息模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| cityCode | integer | 城市代码,见城市代码表 | 1 |
| confidence | integer | 可信度 | 100 |
| crossId | integer | 路口ID | 9000194204687 |
| crossName | string | 路口名称 | 增产路,黑山大街交界 |
| latitude | integer | 纬度 | 3994087 |
| longitude | integer | 经度 | 11609462 |
| phaseLampStatusList | array | 相位状态列表 | 见PhaseLampStatus |
| systemTimeStamp | integer | 系统时间戳 | 1743584533 |
PhaseLampStatus
交通灯相位状态模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| batchTime | integer | 批次时间 | 1743577200 |
| confidence | integer | 可信度 | 100 |
| cycle | integer | 周期 | 86 |
| direction | integer | 方向 | 5 |
| greenDuration | integer | 绿灯持续时间 | 51 |
| redDuration | integer | 红灯持续时间 | 31 |
| yellowDuration | integer | 黄灯持续时间 | 4 |
| lampStatus | integer | 灯状态 | 11 |
| version | string | 版本 | "2.0" |
| offset | integer | 偏移量 | 84 |
| phaseStartTime | integer | 相位开始时间 | 1022 |
| phaseEndTime | integer | 相位结束时间 | 1032 |
| 查看路口信息API |
TrafficRasterRequest
路况栅格图请求模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| city | string | 城市名称 | 北京市 |
| x | integer | 瓦片坐标x | 843 |
| y | integer | 瓦片坐标y | 414 |
| z | integer | 层级 | 10 |
地点搜索相关模型
PlaceAroundRequest
周边搜索请求模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| keywords | string | 检索关键词 | 麦当劳 |
| location | string | 坐标,经纬度,格式"lng,lat" | 116.424790,39.956953 |
| city | string | 城市名 | 北京市 |
| max_distance | string | 检索距离的最大米数 | "1000" |
| sort_rule | string | 排序规则 | "distance" |
| types | string | POI过滤类型(每个类型6位数字),支持传多个。全部POI编码参考POI分类表 | "101000,101020" |
| show_fields | string | 返回结果的扩展信息,sub_poi_list:返回子点数据, 不传则不返回子点数据 | "sub_poi_list" |
| city_limit | boolean | 是否限定在当前城市检索,默认false 不限定城市 | false |
TextSearchRequest
关键词搜索请求模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| keywords | string | 检索关键词 | 麦当劳 |
| city | string | 查询城市 | 北京市 |
| location | string | 坐标,经纬度,格式"lng,lat" | 117.147277,39.14752 |
| types | string | POI过滤类型(每个类型6位数字),支持传多个。全部POI编码参考POI分类表 | "101000,101020" |
| show_fields | string | 返回结果的扩展信息,sub_poi_list:返回子点数据, 不传则不返回子点数据 | "sub_poi_list" |
| city_limit | boolean | 是否限定在当前城市检索,默认false 不限定城市 | false |
TextSearchResponse
POI搜索响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | OK |
| trace_id | string | 请求追踪ID | 0ac5186e6800fd050728047bd68f26b0 |
| results | array | POI结果列表 | 见TextSearchRes |
TextSearchRes
POI搜索结果模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| name | string | 显示名称 | 麦当劳(和平里东街店) |
| location | object | 经纬度坐标 | {"lng": 116.42479,"lat": 39.956953} |
| address | string | 地址 | 东城区和平里街道和平里6区8号楼1层109-2号 |
| province | string | 省份 | 北京市 |
| city | string | 城市名称 | 北京市 |
| district | string | 行政区 | 东城区 |
| adcode | string | 行政编码,最高精确到区县 | 110101 |
| address_all | string | 完整地址 | 东城区和平里街道和平里6区8号楼1层109-2号麦当劳(和平里东街店) |
| distance | int | 距离,米 | 130 |
| poi_id | string | POI唯一标识 | 169598629118985969836542403885541727679 |
| sub_poi_list | array | 子点列表,包含子POI点的详细信息 | 见OpenSubPoi |
| type | string | poi点的类型 | "102000" |
OpenSubPoi
POI子点信息模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| poi_id | string | 子点ID,POI唯一标识 | "179919584780088526038817699620865083589" |
| name | string | 子点名称 | 体坛中医医院-南3门 |
| address | string | 子点地址 | 北京市丰台区芳城路 |
| location | object | 子点经纬度 | {"lng": 116.42479,"lat": 39.956953} |
| type | string | 子点类型 | "131000" |
| select_tag | string | 子点热度标签 | "" |
公交相关模型
MetroStop
地铁站点模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| id | string | 站点ID | - |
| name | string | 站点名称 | - |
| location | string | 站点位置 | - |
MetroEntrance
地铁入口模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| name | string | 入口名称 | - |
| location | string | 入口位置 | - |
BusWalkingStep
公交步行步骤模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| action | array | 行动 | - |
| action_code | array | 行动代码 | - |
| direction | array | 方向 | - |
| distance | integer | 距离 | - |
| duration | integer | 时长 | - |
| instruction | string | 指令 | - |
| polyline | string | 折线路径 | - |
| road | string | 道路 | - |
BusWalking
公交步行模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| origin | string | 起点 | - |
| destination | string | 终点 | - |
| distance | integer | 距离 | - |
| duration | integer | 时长 | - |
| steps | array | 步骤列表 | - |
MetroBus
地铁公交模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| id | string | ID | - |
| name | string | 名称 | - |
| type | integer | 类型 | - |
| distance | integer | 距离 | - |
| duration | integer | 时长 | - |
| polyline | string | 折线路径 | - |
| departure_stop | object | 出发站 | - |
| arrival_stop | object | 到达站 | - |
| via_stops | array | 途径站点 | - |
| via_stops_count | integer | 途径站点数量 | - |
| first_time | string | 首班车时间 | - |
| last_time | string | 末班车时间 | - |
| start_station | string | 起始站 | - |
| terminal_station | string | 终点站 | - |
| cost | integer | 花费 | - |
BusSegment
公交路段模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| mode | string | 模式 | WALKING TRANSIT |
| walking | object | 步行信息 | - |
| entrance | object | 入口信息 | - |
| exit | object | 出口信息 | - |
| metrobus | array | 地铁公交信息 | - |
BusTransit
公交路线规划中的一条路线方案。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| origin | string | 起点坐标 | 116.28187,40.0429 |
| destination | string | 终点坐标 | 116.28512,40.04989 |
| cost | integer | 价格,单位:分 | 200 |
| duration | integer | 行程时间(秒) | 1440 |
| distance | integer | 总距离(米) | 1862 |
| walking_distance | integer | 步行距离(米) | 423 |
| segments | array | 路线段列表 | - |
BusWalking
公交路线规划中的步行段。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| origin | string | 步行起点坐标 | 116.28184,40.04298 |
| destination | string | 步行终点坐标 | 116.28142,40.04291 |
| distance | integer | 步行距离(米) | 36 |
| duration | integer | 步行时间(秒) | 60 |
| steps | array | 步行分段 | - |
BusWalkingStep
公交路线规划中的步行分段。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| instruction | string | 指示信息 | - |
| road | string | 道路名称 | - |
| distance | integer | 分段距离(米) | 36 |
| duration | integer | 分段时间(秒) | 0 |
| polyline | string | 分段坐标串 | 116.28184,40.04298;116.28167,40.04295;116.28142,40.04291 |
| action | array | 行动指示 | ["直行"] |
| action_code | array | 行动代码 | [0] |
| direction | array | 方向指示 | ["东"] |
MetroBus
公交路线规划中的公交/地铁线路。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| name | string | 线路名称 | 软件园通勤环线(一二期) |
| id | string | 线路ID | 60000015617510001 |
| type | integer | 类型,1表示公交 | 1 |
| departure_stop | object | 上车站点 | - |
| arrival_stop | object | 下车站点 | - |
| start_station | string | 起始站 | - |
| terminal_station | string | 终点站 | 地铁西二旗站南 |
| distance | integer | 乘车距离(米) | 1439 |
| duration | integer | 乘车时间(秒) | 603 |
| cost | integer | 票价(分) | 200 |
| first_time | string | 首班车时间 | 07:30 |
| last_time | string | 末班车时间 | 19:30 |
| polyline | string | 路线坐标串 | 116.281443,40.042871;116.28113,40.04282;116.28046,40.04273 |
| via_stops_count | integer | 途经站点数量 | 2 |
| via_stops | array | 途经站点列表 | - |
MetroStop
公交/地铁站点。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| name | string | 站点名称 | 软件园西一路南口 |
| id | string | 站点ID | 90002773733280001 |
| location | string | 站点坐标 | 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,默认5 | 5 |
TransitRouteResponse
公交路线规划响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | OK |
| trace_id | string | 请求追踪ID | 0ac5186e6809ecb33aac047eab35b4b0 |
| results | array | 公交路线规划结果列表 | 见BusTransit |
交通事件相关模型
TrafficIncidentResponse
交通事件响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | OK |
| trace_id | string | 请求追踪ID | 0ac5186e67e513a96bd404838be2d3b0 |
| results | object | 交通事件结果 | 见Results |
Results
交通事件结果模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| eventsData | array | 交通事件列表 | 见Event |
| lastTraceId | integer | 最后一个事件ID | 470037591 |
Event
交通事件模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| eventID | integer | 事件ID | 470037591 |
| eventType | integer | 事件类型 | 100 |
| brief | string | 事件简述 | 裕安路发生事故 |
| eventDesc | string | 事件详细描述 | 裕安路发生事故 |
| roadName | string | 道路名称 | 裕安路 |
| expressway | boolean | 是否高速公路 | false |
| startTime | integer | 开始时间(时间戳) | 1747033837 |
| endTime | integer | 结束时间(时间戳) | 1747034737 |
| updateTime | integer | 更新时间(时间戳) | 1747034008 |
| x | number | 事件位置经度 | 116.54529 |
| y | number | 事件位置纬度 | 40.08189 |
| lines | array | 事件相关路线坐标点 | 见Line |
Line
交通事件线路点模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| longitude | number | 线路点经度 | 116.54529 |
| latitude | number | 线路点纬度 | 40.08189 |
定位相关模型
LocRgeoRequest
基站/WiFi定位请求模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| accesstype | string | 接入网络方式,1-移动网络 2-wifi 3-融合定位 | "1" |
| bts | string | 接入基站信息 | 460,1,12345,987654321,-75,1 |
| diu | string | 设备唯一编号 | "123456" |
| historybts | string | 历史基站信息 | 460,1,12346,987654322,-80,2 |
| macs | string | WiFi列表信息 | 88:6A:D3:4F:2E:1C,-68,HomeWiFi,120 |
| mmac | string | 已连接WiFi信息 | 00:1A:2B:3C:4D:5E,-45,TP-Link_5G,60 |
| nearbts | string | 周边基站信息 | 460,1,12346,987654322,-80,2 |
| type | string | 基站类型,0-未知,1-GTW,2-CDMA,3-LTE | "1" |
LocRgeoResponse
基站/WiFi定位响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | success |
| trace_id | string | 请求追踪 ID | 0ac5186e67e50a9c190b048d5ef3dab0 |
| results | array | 搜索结果列表 | - |
LocRgeoResult
基站/WiFi定位结果模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| city | string | 城市 | 石家庄市 |
| province | string | 省份 | 河北省 |
| poi | string | POI | 体坛中医医院-南3门 |
| radius | integer | 定位半径 | 1000 |
| location | object | 经纬度 | {"lat":39.986989,"lng":116.29522} |
IP定位相关模型
IPLocationRPCResponse
IP定位响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | success |
| trace_id | string | 请求追踪 ID | 0ac5186e67e50a9c190b048d5ef3dab0 |
| results | object | 结果列表 | 见IPLocationResponse |
| 查看IP定位API |
IPLocationResponse
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| city | string | 城市 | 北京市 |
| country | string | 国家 | 中国 |
| district | string | 区县 | 海淀区 |
| location | object | 经纬度 | {"lat":39.986989,"lng":116.29522} |
| province | string | 省份 | 北京市 |
| 查看IP定位 |
行政区域查询相关模型
DistrictRPCResponse
行政区划查询响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | success |
| trace_id | string | 请求追踪 ID | 0ac5186e67e50a9c190b048d5ef3dab0 |
| results | object | 结果列表 | 见DistrictSearchResponse |
DistrictSearchResponse
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| districts | array | 行政区划列表 | 见District |
| 查看行政区域查询API |
District
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| adcode | string | 行政区划编码 | - |
| name | string | 行政区划名称 | - |
| level | string | 行政区划级别 | - |
| center | object | 经纬度,格式为 "经度,纬度" | {"lng":116.29522,"lat":39.986989} |
| polyline | object | 行政区划边界坐标 | - |
| districts | array | 下级行政区划 | - |
| 查看行政区域查询API |
AOI查询相关模型
AoiRequest
AOI查询请求模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| key | string | 鉴权用的 API Key | YOUR_API_KEY |
| poi_id | string | 要查询轮廓区域的 POI ID,可以通过检索类接口获取POI ID | "115771255188811515789773365485059874514" |
| location | string | 所在地的经纬度,格式'lng,lat',(经度,纬度) | 116.314230,39.979392 |
AoiResponse
AOI查询响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | success |
| trace_id | string | 请求追踪 ID | 0ac5186e67e50a9c190b048d5ef3dab0 |
| results | object | 结果列表 | 见AoiResult |
见AoiResult
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| count | integer | 数量 | 1 |
| data | array | 结果数组 | 见 PoiDetail |
PoiDetail
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| name | string | 显示名称 | 体坛中医医院-南3门 |
| location | object | 位置 | {"lng":116.437006,"lat":39.868578} |
| address | string | 地址 | 北京市丰台区芳城路 |
| province | string | 省份 | 北京市 |
| city | string | 城市 | 北京市 |
| district | string | 行政区 | 丰台区 |
| adcode | string | 行政编码,最高精确到区县 | 110108 |
| address_all | string | 完整地址 | 北京市丰台区芳城路体坛中医医院-南3门 |
| poi_id | string | POI唯一标识 | 179919584780088526038817699620865083589 |
| area | number | 面积,单位平方米 | 14617.951 |
| coordinates | string | 经纬度点串结果,格式为经度在前,纬度在后,中间英文逗号分隔,坐标点串之间分号分隔 | 116.3140162,39.9798514;116.313515,39.9800486; 116.3133198,39.9800192 |
周边推荐相关模型
AroundRecommendRequest
周边推荐请求模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| key | string | 鉴权用的 API Key | YOUR_API_KEY |
| location | string | 所在地的经纬度,格式'lng,lat',(经度,纬度) | 116.314230,39.979392 |
AroundRecommendResponse
周边推荐响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | success |
| trace_id | string | 请求追踪 ID | 0ac5186e67e50a9c190b048d5ef3dab0 |
| results | object | 结果列表 | 见AroundRecommendResult |
AroundRecommendResult
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| address | string | 地址 | 北京市海淀区丹棱街甲1号 |
| city | string | 城市 | 北京市 |
| distance | number | 与请求输入的经纬度所在位置的距离,单位: 米 | 1000 |
| district | string | 行政区 | 海淀区 |
| location | object | 位置 | {"lng":116.29522,"lat":39.986989} |
| name | string | 名称 | 北京中关村领展广场 |
| poi_id | string | POI唯一标识 | 115771255188811515789773365485059874514 |
| province | string | 省份 | 北京市 |
| type | string | poi类型 | 131000 |
规避限行相关模型
VehicleRestrictionRequest
规避限行请求模型
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| vehicles | array | 车辆信息,最多20个 | 见VehicleInfo |
VehicleInfo
规避限行车辆信息模型
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| city | string | 城市名称 | 北京市 |
| number | string | 车牌号码 | 津A12345 |
| start | string | 起点经纬度,格式'lng,lat',(经度,纬度) | 117.24034,39.11563 |
| end | string | 终点经纬度,格式'lng,lat',(经度,纬度) | 117.34882,39.0665 |
| time | string | 出发时间,秒级时间戳,默认使用当前时间 | 1753326977 |
| plate_color | string | 车牌颜色 | Blue:蓝,Yellow: 黄,Black:黑,White:白,Green:绿,YellowAndGreen:黄绿 |
| is_license | string | 是否有通行证 | 0:无(默认),1:有 |
VehicleRestrictionResponse
规避限行响应模型
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | OK |
| trace_id | string | 请求追踪 ID | 0aa9cc8068ccc548b7eecaa73d3e0702 |
| results | array | 结果列表 | 见VehicleRestriction |
VehicleRestriction
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| restricted | integer | 车辆是否限行 | 0:不限行,1:起点限行,2:终点限行 |
地址文本解析相关模型
AddressIdentifyRequest
地址文本解析请求模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| key | string | 鉴权用的 API Key | YOUR_API_KEY |
| address_text | string | 要解析的地址文本信息 | 北京北京市海淀区上地街道东软大厦 |
| show_code | string | 等于1时,返回省市区街道 对应的编码。默认不返回 | 1 |
| order_no | string | 订单号/运单号 | 125435247675889 |
| la | string | 语种识别标记。cht表示繁体,en表示英文,chs表示简体,传其它值或不传时取值chs | chs |
| address_tag | string | 地址标签。src表示寄件地址,dest表示派件地址,other 其它类型地址 | src |
AddressIdentifyResponse
地址文本解析响应模型。
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 状态码 | 10000 |
| msg | string | 返回消息 | success |
| trace_id | string | 请求追踪 ID | 0ac5186e67e50a9c190b048d5ef3dab0 |
| results | object | 结果列表 | 见AddressIdentifyResult |
AddressIdentifyResult
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| code | integer | 请求状态:0-成功,1-地址识别失败,2-请求地址识别服务失败 | 0 |
| message | string | code=1或2时,展示具体错误信息 | - |
| paidata | object | 响应数据集 | 见AddressidentifyPaiData |
| src | string | 数据的来源 | - |
| data | object | 响应数据集 | 见AddressidentifyData |
| sn | string | 结果标识 sn 码(唯一标识) | 1662412025102819305080141832 |
| multiple | string | 提示用户补全省市地址信息。返回“1”,表示请求文本中不包含省市信息,且区县在全国范围内有重复 | 1 |
| mark | string | 返回“1”,表示请求地址中包含省市区任意信息; 返回“0”,表示请求地址中不包含省市区信息 | 1 |
| result | string | 对比文本提取的省市区与服务识别的结果是否一致。 返回“1”,表示二者完全一致; 返回“0”,表示二者不完全一致,存在字段内容不一致的情况。 注意:如果二者中一方缺失,则默认二者一致,即result=1 | 1 |
| moreThan | string | 返回“0”,表示省市区都无多个; 返回“1”,表示省有多个,不论市区是否有多个; 返回“2”,表示省无多个,市有多个,不论区是否有多个; 返回“3”,表示省市都无多个,区有多个 | 0 |
| dispatchMark | string | 返回“0”,表示不可收派; 返回“1”,表示可收派 | 1 |
| conflict | string | 对比识别的省市区与从文本中提取的结果是否一致。 返回“2”,表示省不一致; 返回“3”,表示市不一致; 返回“4”,表示区不一致; 返回“5”,表示街道不一致 | 4 |
AddressidentifyPaiData
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| personname | array | 文本中可能的人名,有多个时只输出一个 | ["张三"] |
| nationalPhoneCode | string | 电话号码的区号 | 010 |
| phoneNumber | string | 本中可能的联系电话,有多个时只输出一个 | 010-65891234 |
| extension | string | 分机号 | - |
| address | string | 提取出人名电话后的地址 | 北京北京市海淀区上地街道东软大厦 |
| remark | string | 备注信息 | - |
AddressidentifyData
| 字段名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| province | string | 省份 | 北京市 |
| city | string | 城市 | 北京市 |
| county | string | 区县 | 海淀区 |
| town | string | 乡镇 | 上地街道 |
| adcode | string | 地址所在的6位行政区划代码 | 110108 |
| citycode | string | 城市编码 | 010 |
| detailaddr | string | 详细地址 | 北京东软大厦 |
| provinceCode | string | 省份编码。showcode=1时返回 | 110000 |
| cityLevCode | string | 城市编码。showcode=1时返回 | 110100 |
| countyCode | string | 区县编码。showcode=1时返回 | 110108 |
| townCode | string | 乡镇(街道)编码。showcode=1时返回 | 110108022000 |
| tipProvince | string | 直接从请求文本中提取的省份,如与识别的一致则为空 | - |
| tipCity | string | 直接从请求文本中提取的城市,如与识别的一致则为空 | - |
| tipCounty | string | 直接从请求文本中提取的区县,如与识别的一致则为空 | - |
| tipTown | string | 直接从请求文本中提取的乡镇(街道),如与识别的一致,则为空 | - |