Schemas
GatewayError
errorcodeA four-digit number starting with 50 that says exactly why the request was refused. It is
an addition, so a client that reads only error is unaffected.
Retry on the status; read the code to explain. Several refusals share a status. The status tells your code whether to retry; the code tells you what to tell your user. New codes starting with 50 may be added.
Coordinate
A [longitude, latitude] pair, in that order.
MatrixRequest
locationsThe points the matrix is computed over. At least two.
sourcesIndices into locations to use as sources. Leave it out, or send ["all"], to use
every location. Cost is |sources| × |destinations|.
destinationsIndices into locations to use as destinations. Leave it out, or send ["all"], to
use every location. Cost is |sources| × |destinations|.
metricsWhich matrices to return. Defaults to durations only.
resolve_locationsReturn the name of the nearest road for each snapped point.
unitsUnits for the distance matrix. Durations are always seconds.
idAn arbitrary identifier echoed back in the response metadata.
MatrixResponse
durationsTravel times in seconds, as rows of sources by columns of destinations. A null
entry means no route was found between that pair.
distancesDistances, present only when requested via metrics.
Details about the request and the data behind the answer, plus element_count.
SnappedPoint
locationA [longitude, latitude] pair, in that order.
snapped_distanceMeters from the requested point to the road it was snapped to.
nameRoad name, present only when resolve_locations was set.
DirectionsRequest
coordinatesThe waypoints, in order, starting at the origin.
preferenceunitslanguageLanguage for turn instructions.
instructionsInclude turn-by-turn instructions. Default true.
instructions_formatgeometryInclude the route geometry. Default true.
geometry_simplifyelevationextra_infoattributescontinue_straightalternative_routesRequest alternative routes.
optionsAdvanced routing options such as avoid_features or avoid_polygons.
Note: requests with options are much slower to compute, and have a much lower
limit on route distance.
radiusesbearingsmaximum_speedsuppress_warningsidDirectionsJsonResponse
bboxDetails about the request and the data behind the answer, plus element_count.
IsochronesRequest
locationsThe centers of the isochrones.
rangeThe ranges to compute, in seconds or meters depending on range_type. There's a
maximum; going over it returns 400 (code 3004), and the message names the limit.
range_typeWhether range is seconds or meters. Default time.
intervalProduce intermediate bands at this step within each range.
unitsarea_unitslocation_typeWhether the locations are origins (start, the default) or destinations — the
difference matters on one-way roads.
attributesintersectionssmoothingidIsochronesResponse
typebboxDetails about the request and the data behind the answer, plus element_count.
Metadata
attributionRequired by license. The Open Database License requires this credit to stay with the data.
servicetimestampMilliseconds since the Unix epoch.
queryThe request, echoed back.
element_countAdded by this service. How many elements this call was charged. Free calls and failed calls are never charged.