Schemas

An additional numeric code identifying the rejection, in a range the engine does not use. Additive: clients that read error as a string are unaffected.

Retry on the status; read the code to explain. More than one rejection shares a status, in both directions — a 429 may be a per-minute rate limit or a concurrency refusal, and a 403 may be an invalid key, an exhausted monthly quota, or a request from a web origin the key is not permitted to use. So the status is the reliable signal for whether to retry, and the code is the reliable signal for what to tell someone. New codes may be added within the range; a client that branches on the status keeps working when they are.

A [longitude, latitude] pair, in that order.

The points the matrix is computed over. At least two.

Indices into locations to use as sources. Omit, or send ["all"], for every location. This field is half of what the request costs.

Indices into locations to use as destinations. Omit, or send ["all"], for every location. This field is the other half of what the request costs.

Which matrices to return. Defaults to durations only.

Return the name of the nearest road for each snapped point.

Units for the distance matrix. Durations are always seconds.

An arbitrary identifier echoed back in the response metadata.

Travel times in seconds, as rows of sources by columns of destinations. A null entry means no route was found between that pair.

Distances, present only when requested via metrics.

The engine's metadata block, passed through unchanged, plus our added element count.

A [longitude, latitude] pair, in that order.

Metres from the requested point to the road it was snapped to.

Road name, present only when resolve_locations was set.

The waypoints, in order, starting at the origin.

Language for turn instructions.

Include turn-by-turn instructions. Default true.

Include the route geometry. Default true.

Request alternative routes.

Advanced routing options such as avoid_features or avoid_polygons.

Note: requests carrying options are computed in the engine's flexible mode, which bypasses its speed-up structures and is roughly ten times more expensive. The engine applies a much smaller size limit to them.

The engine's metadata block, passed through unchanged, plus our added element count.

The centres of the isochrones.

The ranges to compute, in seconds or metres depending on range_type. The engine enforces a maximum; exceeding it returns error 3004 naming the limit.

Whether range is seconds or metres. Default time.

Produce intermediate bands at this step within each range.

Whether the locations are origins (start, the default) or destinations — the difference matters on one-way roads.

The engine's metadata block, passed through unchanged, plus our added element count.

Required by licence. The Open Database Licence obliges this credit to travel with the data; it is never removed or altered.

Milliseconds since the Unix epoch.

The request, echoed back.

Added by this service. How many elements this call was metered for. Zero-cost and failed calls are not metered at all.