Get Route

Retrieve a route resource by its ID.

GET /v1/routes/{route_id}

Get Route

cURL

curl --request GET \
  --url http://localhost:8000/v1/routes/{route_id}

200

{
  "id": "route_01HYX3MPK5XJQJG0NB0PRSDVWC",
  "object": "route",
  "status": "processing",
  "createdAt": "2026-02-28T15:12:32Z",
  "routes": [
    {
      "routeLabels": [
        "DEFAULT_ROUTE"
      ],
      "legs": [
        {
          "distanceMeters": 123,
          "duration": "<string>",
          "staticDuration": "<string>",
          "polyline": {
            "encodedPolyline": "<string>"
          },
          "startLocation": {
            "latLng": {
              "latitude": 41.878,
              "longitude": -87.636
            }
          },
          "endLocation": {
            "latLng": {
              "latitude": 41.878,
              "longitude": -87.636
            }
          },
          "steps": [
            {
              "distanceMeters": 123,
              "staticDuration": "28s",
              "polyline": {
                "encodedPolyline": "<string>"
              },
              "startLocation": {
                "latLng": {
                  "latitude": 41.878,
                  "longitude": -87.636
                }
              },
              "endLocation": {
                "latLng": {
                  "latitude": 41.878,
                  "longitude": -87.636
                }
              },
              "navigationInstruction": {
                "maneuver": "DEPART",
                "instructions": "<string>"
              },
              "travelMode": "DRIVE",
              "enrichment": {
                "gradePercent": 2.5,
                "curvatureDegreesPerKm": 15.3,
                "fuelBurnLiters": 0.42,
                "zoneFlags": [
                  "SCHOOL_ZONE"
                ],
                "speedLimitKmh": 123,
                "roadClass": "MOTORWAY",
                "degradedFields": [
                  "<string>"
                ],
                "degradedReason": "<string>"
              },
              "travelAdvisory": {},
              "localizedValues": {},
              "transitDetails": {}
            }
          ],
          "travelAdvisory": {},
          "localizedValues": {},
          "stepsOverview": {}
        }
      ],
      "distanceMeters": 123,
      "duration": "<string>",
      "staticDuration": "<string>",
      "polyline": {
        "encodedPolyline": "<string>"
      },
      "description": "<string>",
      "warnings": [
        "<string>"
      ],
      "viewport": {
        "low": {
          "latitude": 123,
          "longitude": 123
        },
        "high": {
          "latitude": 123,
          "longitude": 123
        }
      },
      "travelAdvisory": {},
      "optimizedIntermediateWaypointIndex": [
        123
      ],
      "localizedValues": {},
      "routeToken": "<string>",
      "polylineDetails": {}
    }
  ],
  "fallbackInfo": {},
  "geocodingResults": {},
  "warnings": [
    "<string>"
  ],
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Completed routes are cached for 6 hours, then expire. Use DELETE to remove them earlier if needed.

Path Parameters

route_id · string · required

The unique route resource ID (prefixed with route_)

Example:

"route_01HYX3MPK5XJQJG0NB0PRSDVWC"

Response

200

application/json

Route resource found

A route resource. Used by the /v1/routes endpoint family.

id · string · required

Unique route ID (prefixed with route_)

Example:

"route_01HYX3MPK5XJQJG0NB0PRSDVWC"

object · enum<string> · required

Object type (always route)

Available options: route

status · enum<string> · required

Current status of the route computation.

• processing - route is still being computed (routes array is empty)
• complete - route computation finished (routes array is populated)
• failed - route computation failed (error object is populated)

Available options: processing, complete, failed

createdAt · string<date-time> · required

ISO 8601 UTC timestamp of creation

Example:

"2026-02-28T15:12:32Z"

routes · object[] · required

Computed routes (empty while processing)

Show child attributes

fallbackInfo · object

geocodingResults · object

warnings · string[]

error · object

Error details (populated when status is failed)

Show child attributes