地图帮开放平台
API 文档 / 路径规划 / 步行路径规划

步行路径规划

GET route/walking

接口说明

步行路径规划

输入示例:起点:116.481028,39.989643;终点:116.434446,39.90816
返回示例:返回步行路线方案,包括步行距离、预计耗时和分段导航说明。

请求地址

GEThttps://cloud.dtbgis.com/api/v1/route/walking

鉴权方式

在 HTTP Header 中携带你的 API Key:

X-API-Key: 你的API-Key

每个 API Key 绑定已购接口与流量豆,调用成功扣减对应流量豆;调用失败(参数错误等)不扣流量豆。未开通该接口返回 403,流量豆不足返回 429

请求参数

参数必填说明示例 / 默认值
origin 必填 起点坐标,格式 lon,lat 116.481028,39.989643
destination 必填 终点坐标,格式 lon,lat 116.434446,39.90816

请求示例

curl -H "X-API-Key: 你的API-Key" \
  "https://cloud.dtbgis.com/api/v1/route/walking?origin=116.481028%2C39.989643&destination=116.434446%2C39.90816"

返回结果说明

本接口返回统一 JSON 信封结构:

{
  "code": 200,
  "msg": "success",
  "data": { ... },
  "quota_remaining": 9999
}
字段说明
code业务状态码,200 表示成功
msg状态描述,成功为 success
data查询结果对象,字段见下方「data 字段说明」
quota_remaining本次调用后剩余可用流量豆数量

data 为高德原始 JSON 透传,坐标系 GCJ-02。示例中 polyline 坐标串做了截断示意。

响应示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "status": "1",
    "info": "OK",
    "route": {
      "origin": "116.481028,39.989643",
      "destination": "116.434446,39.90816",
      "paths": [
        {
          "distance": "10200",
          "duration": "8400",
          "steps": [
            {
              "instruction": "沿阜通东大街向西步行500米",
              "orientation": "西",
              "road": "阜通东大街",
              "distance": "500",
              "duration": "420",
              "polyline": "116.481028,39.989643;116.478028,39.989643",
              "action": "左转",
              "assistant_action": "",
              "walk_type": "0"
            }
          ]
        }
      ]
    }
  },
  "quota_remaining": 9989
}

data 字段说明

字段类型说明示例
statusstring上游状态码,"1" 表示成功1
infostring上游状态说明OK
routeobject路径规划结果对象
originstring起点坐标(lng,lat)116.481028,39.989643
destinationstring终点坐标(lng,lat)116.434446,39.908160
pathsarray规划方案列表
distancestring方案总距离(米)1024
durationstring方案预计耗时(秒)820
stepsarray方案分段指引列表
instructionstring分段步行指引文本向西步行120米左转
orientationstring步行方向西
roadstring道路名称阜通东大街
distancestring该段距离(米)120
durationstring该段预计耗时(秒)96
polylinestring该段坐标串(lng,lat;lng,lat)116.480,39.989;116.479,39.989
actionstring导航主动作左转
assistant_actionstring导航辅助动作
walk_typestring人行道类型(0 普通 / 1 人行横道 等)0

错误码

错误以统一结构返回:{"detail": {"code": 429, "msg": "..."}}

HTTP含义常见原因 / 处理
400参数错误缺少必填参数或格式不合法
401鉴权失败API Key 缺失、不存在、已停用或已过期
403权限不足该 API Key 未开通此接口,请购买流量豆
429流量豆不足 / 限流流量豆用完需续费;或超过速率(60 秒 200 次)
404资源不存在路径错误,或查询对象无数据
503服务暂时不可用服务暂时异常,请稍后重试

完整错误码见 文档首页 · 错误码总览