Distance Matrix API 요청 및 응답

Distance Matrix API 요청의 형식은 다음과 같습니다.

https://maps.googleapis.com/maps/api/distancematrix/outputFormat?parameters

여기서 outputFormat은 다음 값 중 하나일 수 있습니다.

  • json (권장): JSON (JavaScript Object Notation) 형식으로 출력을 나타냅니다.
  • xml: 출력을 XML로 나타냅니다.

필수인 매개변수와 선택사항인 매개변수가 있습니다. URL에서와 마찬가지로 모든 매개변수는 앰퍼샌드 (&) 문자를 사용하여 구분합니다. 모든 예약된 문자 (예: 더하기 기호 '+')는 URL로 인코딩되어야 합니다. 매개변수와 가능한 값 목록은 아래에 나와 있습니다.

Required parameters

  • destinations

    One or more locations to use as the finishing point for calculating travel distance and time. The options for the destinations parameter are the same as for the origins parameter.

  • origins

    The starting point for calculating travel distance and time. You can supply one or more locations separated by the pipe character (|), in the form of a place ID, an address, or latitude/longitude coordinates:

    • Place ID: If you supply a place ID, you must prefix it with place_id:.
    • Address: If you pass an address, the service geocodes the string and converts it to a latitude/longitude coordinate to calculate distance. This coordinate may be different from that returned by the Geocoding API, for example a building entrance rather than its center.
      Note: using place IDs is preferred over using addresses or latitude/longitude coordinates. Using coordinates will always result in the point being snapped to the road nearest to those coordinates - which may not be an access point to the property, or even a road that will quickly or safely lead to the destination. Using the address will provide the distance to the center of the building, as opposed to an entrance to the building.
    • Coordinates: If you pass latitude/longitude coordinates, they they will snap to the nearest road. Passing a place ID is preferred. If you do pass coordinates, ensure that no space exists between the latitude and longitude values.
    • Plus codes must be formatted as a global code or a compound code. Format plus codes as shown here (plus signs are url-escaped to %2B and spaces are url-escaped to %20):
      • global code is a 4 character area code and 6 character or longer local code (849VCWC8+R9 is encoded to 849VCWC8%2BR9).
      • compound code is a 6 character or longer local code with an explicit location (CWC8+R9 Mountain View, CA, USA is encoded to CWC8%2BR9%20Mountain%20View%20CA%20USA).
    • Encoded Polyline Alternatively, you can supply an encoded set of coordinates using the Encoded Polyline Algorithm. This is particularly useful if you have a large number of origin points, because the URL is significantly shorter when using an encoded polyline.
      • Encoded polylines must be prefixed with enc: and followed by a colon :. For example: origins=enc:gfo}EtohhU:
      • You can also include multiple encoded polylines, separated by the pipe character |. For example:
        origins=enc:wc~oAwquwMdlTxiKtqLyiK:|enc:c~vnAamswMvlTor@tjGi}L:|enc:udymA{~bxM:
        

Optional parameters

  • arrival_time

    Specifies the desired time of arrival for transit directions, in seconds since midnight, January 1, 1970 UTC. You can specify either departure_time or arrival_time, but not both. Note that arrival_time must be specified as an integer.

  • avoid

    Distances may be calculated that adhere to certain restrictions. Restrictions are indicated by use of the avoid parameter, and an argument to that parameter indicating the restriction to avoid. The following restrictions are supported:

    • tolls indicates that the calculated route should avoid toll roads/bridges.
    • highways indicates that the calculated route should avoid highways.
    • ferries indicates that the calculated route should avoid ferries.
    • indoor indicates that the calculated route should avoid indoor steps for walking and transit directions.

    It's possible to request a route that avoids any combination of tolls, highways and ferries by passing both restrictions to the avoid parameter. For example avoid=tolls|highways|ferries.

    Note: The addition of restrictions does not preclude routes that include the restricted feature; it biases the result to more favorable routes.
  • departure_time

    Specifies the desired time of departure. You can specify the time as an integer in seconds since midnight, January 1, 1970 UTC. If a departure_time later than 9999-12-31T23:59:59.999999999Z is specified, the API will fall back the departure_time to 9999-12-31T23:59:59.999999999Z. Alternatively, you can specify a value of now, which sets the departure time to the current time (correct to the nearest second). The departure time may be specified in two cases:

    • For requests where the travel mode is transit: You can optionally specify one of departure_time or arrival_time. If neither time is specified, the departure_time defaults to now (that is, the departure time defaults to the current time).
    • For requests where the travel mode is driving: You can specify the departure_time to receive a route and trip duration (response field: duration_in_traffic) that take traffic conditions into account. The departure_time must be set to the current time or some time in the future. It cannot be in the past.
    Note: If departure time is not specified, choice of route and duration are based on road network and average time-independent traffic conditions. Results for a given request may vary over time due to changes in the road network, updated average traffic conditions, and the distributed nature of the service. Results may also vary between nearly-equivalent routes at any time or frequency.
    Note: Distance Matrix requests specifying `departure_time` when `mode=driving` are limited to a maximum of 100 elements per request. The number of origins times the number of destinations defines the number of elements.
  • language

    The language in which to return results.

    • See the list of supported languages. Google often updates the supported languages, so this list may not be exhaustive.
    • If language is not supplied, the API attempts to use the preferred language as specified in the Accept-Language header.
    • The API does its best to provide a street address that is readable for both the user and locals. To achieve that goal, it returns street addresses in the local language, transliterated to a script readable by the user if necessary, observing the preferred language. All other addresses are returned in the preferred language. Address components are all returned in the same language, which is chosen from the first component.
    • If a name is not available in the preferred language, the API uses the closest match.
    • The preferred language has a small influence on the set of results that the API chooses to return, and the order in which they are returned. The geocoder interprets abbreviations differently depending on language, such as the abbreviations for street types, or synonyms that may be valid in one language but not in another. For example, utca and tér are synonyms for street in Hungarian.
  • mode

    For the calculation of distances and directions, you may specify the transportation mode to use. By default, DRIVING mode is used. By default, directions are calculated as driving directions. The following travel modes are supported:

    • driving (default) indicates standard driving directions or distance using the road network.
    • walking requests walking directions or distance via pedestrian paths & sidewalks (where available).
    • bicycling requests bicycling directions or distance via bicycle paths & preferred streets (where available).
    • transit requests directions or distance via public transit routes (where available). Transit trips are available for up to 7 days in the past or 100 days in the future. If you set the mode to transit, you can optionally specify either a departure_time or an arrival_time. If neither time is specified, the departure_time defaults to now (that is, the departure time defaults to the current time). You can also optionally include a transit_mode and/or a transit_routing_preference.
    Note: Both walking and bicycling directions may sometimes not include clear pedestrian or bicycling paths, so these directions will return warnings in the returned result which you must display to the user.
  • region

    The region code, specified as a ccTLD ("top-level domain") two-character value. Most ccTLD codes are identical to ISO 3166-1 codes, with some notable exceptions. For example, the United Kingdom's ccTLD is "uk" (.co.uk) while its ISO 3166-1 code is "gb" (technically for the entity of "The United Kingdom of Great Britain and Northern Ireland").

  • traffic_model

    Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration_in_traffic field in the response, which contains the predicted time in traffic based on historical averages. The traffic_model parameter may only be specified for driving directions where the request includes a departure_time. The available values for this parameter are:

    • best_guess (default) indicates that the returned duration_in_traffic should be the best estimate of travel time given what is known about both historical traffic conditions and live traffic. Live traffic becomes more important the closer the departure_time is to now.
    • pessimistic indicates that the returned duration_in_traffic should be longer than the actual travel time on most days, though occasional days with particularly bad traffic conditions may exceed this value.
    • optimistic indicates that the returned duration_in_traffic should be shorter than the actual travel time on most days, though occasional days with particularly good traffic conditions may be faster than this value.

    The default value of best_guess will give the most useful predictions for the vast majority of use cases. It is possible the best_guess travel time prediction may be shorter than optimistic, or alternatively, longer than pessimistic, due to the way the best_guess prediction model integrates live traffic information.

  • transit_mode

    Specifies one or more preferred modes of transit. This parameter may only be specified for transit directions. The parameter supports the following arguments:

    • bus indicates that the calculated route should prefer travel by bus.
    • subway indicates that the calculated route should prefer travel by subway.
    • train indicates that the calculated route should prefer travel by train.
    • tram indicates that the calculated route should prefer travel by tram and light rail.
    • rail indicates that the calculated route should prefer travel by train, tram, light rail, and subway. This is equivalent to transit_mode=train|tram|subway.
  • transit_routing_preference

    Specifies preferences for transit routes. Using this parameter, you can bias the options returned, rather than accepting the default best route chosen by the API. This parameter may only be specified for transit directions. The parameter supports the following arguments:

    • less_walking indicates that the calculated route should prefer limited amounts of walking.
    • fewer_transfers indicates that the calculated route should prefer a limited number of transfers.
  • units

    Specifies the unit system to use when displaying results.

    Note: this unit system setting only affects the text displayed within distance fields. The distance fields also contain values which are always expressed in meters.

요청 예시

이 예에서는 위도/경도 좌표를 사용하여 대상 좌표를 지정합니다.

URL

https://maps.googleapis.com/maps/api/distancematrix/json
  ?destinations=40.659569%2C-73.933783%7C40.729029%2C-73.851524%7C40.6860072%2C-73.6334271%7C40.598566%2C-73.7527626
  &origins=40.6655101%2C-73.89188969999998
  &key=YOUR_API_KEY

cURL

curl -L -X GET 'https://maps.googleapis.com/maps/api/distancematrix/json?origins=40.6655101%2C-73.89188969999998&destinations=40.659569%2C-73.933783%7C40.729029%2C-73.851524%7C40.6860072%2C-73.6334271%7C40.598566%2C-73.7527626&key=YOUR_API_KEY'

이 예에서는 플러스 코드를 사용하여 대상 좌표를 지정합니다.

URL

https://maps.googleapis.com/maps/api/distancematrix/json
  ?destinations=San%20Francisco
  &origins=849VCWC8%2BR9
  &key=YOUR_API_KEY

cURL

curl -L -X GET 'https://maps.googleapis.com/maps/api/distancematrix/json?origins=849VCWC8%2BR9&destinations=San%20Francisco&key=YOUR_API_KEY'

다음 예시는 인코딩된 폴리라인을 사용하여 동일한 요청을 보여줍니다.

URL

https://maps.googleapis.com/maps/api/distancematrix/json
  ?destinations=enc%3A_kjwFjtsbMt%60EgnKcqLcaOzkGari%40naPxhVg%7CJjjb%40cqLcaOzkGari%40naPxhV%3A
  &origins=40.6655101%2C-73.89188969999998
  &key=YOUR_API_KEY

cURL

curl -L -X GET 'https://maps.googleapis.com/maps/api/distancematrix/json?origins=40.6655101%2C-73.89188969999998&destinations=enc%3A_kjwFjtsbMt%60EgnKcqLcaOzkGari%40naPxhVg%7CJjjb%40cqLcaOzkGari%40naPxhV%3A&key=YOUR_API_KEY'

교통 정보

교통정보는 다음 사항이 모두 적용되는 경우에 사용됩니다 (Distance Matrix 응답에서 duration_in_traffic 필드를 수신하는 데 필요한 조건입니다).

  • 이동 mode 매개변수driving이거나 지정되지 않았습니다(driving이 기본 이동 모드입니다).
  • 요청에 유효한 departure_time 매개변수가 포함되어 있습니다. departure_time은 현재 시간 또는 미래의 특정 시간으로 설정할 수 있습니다. 과거 시간으로 설정할 수는 없습니다.

원하는 경우 요청에 traffic_model 매개변수를 포함하여 교통량을 고려한 시간을 계산할 때 사용할 가정을 지정할 수 있습니다.

다음 URL은 매사추세츠 보스톤 또는 매사추세츠 찰스타운과 매사추세츠 렉싱턴 및 매사추세츠 콩코드 간의 운전 거리에 대한 거리 매트릭스 요청을 시작합니다. 요청에는 출발 시간이 포함되어 있으며, 이는 거리 행렬 응답에서 duration_in_traffic 필드를 반환하기 위한 모든 요구사항을 충족합니다.

URL

https://maps.googleapis.com/maps/api/distancematrix/json
  ?departure_time=now
  &destinations=Lexington%2CMA%7CConcord%2CMA
  &origins=Boston%2CMA%7CCharlestown%2CMA
  &key=YOUR_API_KEY

cURL

curl -L -X GET 'https://maps.googleapis.com/maps/api/distancematrix/json?origins=Boston%2CMA%7CCharlestown%2CMA&destinations=Lexington%2CMA%7CConcord%2CMA&departure_time=now&key=YOUR_API_KEY'

JSON

{
  "destination_addresses": ["Lexington, MA, USA", "Concord, MA, USA"],
  "origin_addresses": ["Boston, MA, USA", "Charlestown, Boston, MA, USA"],
  "rows":
    [
      {
        "elements":
          [
            {
              "distance": { "text": "33.3 km", "value": 33253 },
              "duration": { "text": "27 mins", "value": 1620 },
              "duration_in_traffic": { "text": "34 mins", "value": 2019 },
              "status": "OK",
            },
            {
              "distance": { "text": "41.5 km", "value": 41491 },
              "duration": { "text": "33 mins", "value": 1981 },
              "duration_in_traffic": { "text": "39 mins", "value": 2342 },
              "status": "OK",
            },
          ],
      },
      {
        "elements":
          [
            {
              "distance": { "text": "31.1 km", "value": 31100 },
              "duration": { "text": "26 mins", "value": 1543 },
              "duration_in_traffic": { "text": "29 mins", "value": 1754 },
              "status": "OK",
            },
            {
              "distance": { "text": "39.3 km", "value": 39338 },
              "duration": { "text": "32 mins", "value": 1904 },
              "duration_in_traffic": { "text": "35 mins", "value": 2077 },
              "status": "OK",
            },
          ],
      },
    ],
  "status": "OK",
}

XML

<DistanceMatrixResponse>
 <status>OK</status>
 <origin_address>Boston, MA, USA</origin_address>
 <origin_address>Charlestown, Boston, MA, USA</origin_address>
 <destination_address>Lexington, MA, USA</destination_address>
 <destination_address>Concord, MA, USA</destination_address>
 <row>
  <element>
   <status>OK</status>
   <duration>
    <value>1620</value>
    <text>27 mins</text>
   </duration>
   <distance>
    <value>33253</value>
    <text>33.3 km</text>
   </distance>
   <duration_in_traffic>
    <value>2018</value>
    <text>34 mins</text>
   </duration_in_traffic>
  </element>
  <element>
   <status>OK</status>
   <duration>
    <value>1981</value>
    <text>33 mins</text>
   </duration>
   <distance>
    <value>41491</value>
    <text>41.5 km</text>
   </distance>
   <duration_in_traffic>
    <value>2342</value>
    <text>39 mins</text>
   </duration_in_traffic>
  </element>
 </row>
 <row>
  <element>
   <status>OK</status>
   <duration>
    <value>1543</value>
    <text>26 mins</text>
   </duration>
   <distance>
    <value>31100</value>
    <text>31.1 km</text>
   </distance>
   <duration_in_traffic>
    <value>1759</value>
    <text>29 mins</text>
   </duration_in_traffic>
  </element>
  <element>
   <status>OK</status>
   <duration>
    <value>1904</value>
    <text>32 mins</text>
   </duration>
   <distance>
    <value>39338</value>
    <text>39.3 km</text>
   </distance>
   <duration_in_traffic>
    <value>2077</value>
    <text>35 mins</text>
   </duration_in_traffic>
  </element>
 </row>
</DistanceMatrixResponse>

위치 수정자

위치 수정자를 사용하여 운전자가 특정 위치에 어떻게 접근해야 하는지를 나타낼 수 있습니다. side_of_road 수정자를 사용하여 사용할 도로의 측면을 지정하거나, 방향을 지정하여 올바른 이동 방향을 나타낼 수 있습니다.

계산된 경로가 도로의 특정 측면을 통과해야 한다고 지정

위치를 지정할 때 side_of_road: 접두사를 사용하여 계산된 경로가 경유지가 편향된 도로의 어느 쪽을 지나가도록 요청할 수 있습니다. 예를 들어 이 요청은 차량이 중간 지점이 편향된 도로 측면에 종료되도록 긴 경로의 거리를 반환합니다.

URL

https://maps.googleapis.com/maps/api/distancematrix/json
  ?destinations=side_of_road%3A37.7663444%2C-122.4412006
  &origins=37.7680296%2C-122.4375126
  &key=YOUR_API_KEY

cURL

curl -L -X GET 'https://maps.googleapis.com/maps/api/distancematrix/json?origins=37.7680296%2C-122.4375126&destinations=side_of_road%3A37.7663444%2C-122.4412006&key=YOUR_API_KEY'

인코딩된 다중선과 함께 side_of_road:를 사용하면 다중선의 모든 위치에 수정자가 적용됩니다. 예를 들어 이 요청의 두 대상 모두 다음 매개변수를 사용합니다.

URL

https://maps.googleapis.com/maps/api/distancematrix/json
  ?destinations=side_of_road%3Aenc%3A%7BoqeF%60fejV%5BnC%3A
  &origins=San%20Francisco%20City%20hall
  &key=YOUR_API_KEY

cURL

curl -L -X GET 'https://maps.googleapis.com/maps/api/distancematrix/json?origins=San%20Francisco%20City%20hall&destinations=side_of_road%3Aenc%3A%7BoqeF%60fejV%5BnC%3A&key=YOUR_API_KEY'

side_of_road: 수정자는 다음과 같은 제한사항이 있는 경우에만 사용할 수 있습니다.

  • 이동 mode 매개변수driving이거나 지정되지 않았습니다 (driving이 기본 이동 모드입니다).

계산된 경로에 특정 제목이 있어야 한다고 지정

위치를 지정할 때 계산된 경로가 특정 방향으로 위치를 통과하도록 요청할 수 있습니다. 이 제목은 접두사 heading=X:로 지정되며, 여기서 X는 0 (양 끝값 포함)과 360 (양 끝값 제외) 사이의 정수 도 값입니다. 방위가 0이면 북쪽, 90이면 동쪽을 나타내며 시계 방향으로 계속됩니다. 예를 들어 이 요청에서 계산된 경로는 출발지에서 동쪽으로 이동한 후 유턴합니다.

URL

https://maps.googleapis.com/maps/api/distancematrix/json
  ?destinations=37.773245%2C-122.469502
  &origins=heading%3D90%3A37.773279%2C-122.468780
  &key=YOUR_API_KEY

cURL

curl -L -X GET 'https://maps.googleapis.com/maps/api/distancematrix/json?origins=heading%3D90%3A37.773279%2C-122.468780&destinations=37.773245%2C-122.469502&key=YOUR_API_KEY'

heading=X: 수정자는 다음과 같은 제한사항이 있는 경우에만 사용할 수 있습니다.

  • 이동 mode 매개변수driving, bicycling이거나 지정되지 않았습니다 (driving이 기본 이동 모드입니다).
  • side_of_road 수정자가 동일한 위치에 지정되지 않았습니다.
  • 위치는 위도/경도 값으로 지정됩니다. 주소, 장소 ID 또는 인코딩된 다중선에는 heading를 사용할 수 없습니다.

거리 행렬 요청 및 응답

아래의 샘플 HTTP 요청에서는 캐나다 BC 벤쿠버와 미국 WA 시애틀에서 미국 CA 샌프란시스코와 캐나다 BC 빅토리아까지의 소요 시간 및 거리를 요청합니다.

URL

https://maps.googleapis.com/maps/api/distancematrix/json
  ?destinations=San%20Francisco%7CVictoria%20BC
  &language=fr-FR
  &mode=bicycling
  &origins=Vancouver%20BC%7CSeattle
  &key=YOUR_API_KEY

cURL

curl -L -X GET 'https://maps.googleapis.com/maps/api/distancematrix/json?origins=Vancouver%20BC%7CSeattle&destinations=San%20Francisco%7CVictoria%20BC&mode=bicycling&language=fr-FR&key=YOUR_API_KEY'

이 요청은 2개의 출발지와 2개의 목적지를 곱한 다음 네 가지 요소를 반환합니다.

벤쿠버 - 샌프란시스코 벤쿠버 - 빅토리아
시애틀 - 샌프란시스코 시애틀 - 빅토리아

결과는 행으로 반환되며, 각 행에는 하나의 출발지와 각 목적지가 쌍으로 포함됩니다.

JSON

{
  "destination_addresses":
    ["San Francisco, Californie, États-Unis", "Victoria, BC, Canada"],
  "origin_addresses":
    ["Vancouver, BC, Canada", "Seattle, Washington, États-Unis"],
  "rows":
    [
      {
        "elements":
          [
            {
              "distance": { "text": "1 712 km", "value": 1711765 },
              "duration": { "text": "3 jours 16 heures", "value": 318119 },
              "status": "OK",
            },
            {
              "distance": { "text": "140 km", "value": 139695 },
              "duration": { "text": "6 heures 49 minutes", "value": 24567 },
              "status": "OK",
            },
          ],
      },
      {
        "elements":
          [
            {
              "distance": { "text": "1 452 km", "value": 1451704 },
              "duration": { "text": "3 jours 2 heures", "value": 266680 },
              "status": "OK",
            },
            {
              "distance": { "text": "146 km", "value": 146500 },
              "duration": { "text": "2 heures 53 minutes", "value": 10374 },
              "status": "OK",
            },
          ],
      },
    ],
  "status": "OK",
}

XML

<DistanceMatrixResponse>
 <status>OK</status>
 <origin_address>Vancouver, BC, Canada</origin_address>
 <origin_address>Seattle, Washington, États-Unis</origin_address>
 <destination_address>San Francisco, Californie, États-Unis</destination_address>
 <destination_address>Victoria, BC, Canada</destination_address>
 <row>
  <element>
   <status>OK</status>
   <duration>
    <value>318119</value>
    <text>3 jours 16 heures</text>
   </duration>
   <distance>
    <value>1711765</value>
    <text>1712 km</text>
   </distance>
  </element>
  <element>
   <status>OK</status>
   <duration>
    <value>24567</value>
    <text>6 heures 49 minutes</text>
   </duration>
   <distance>
    <value>139695</value>
    <text>140 km</text>
   </distance>
  </element>
 </row>
 <row>
  <element>
   <status>OK</status>
   <duration>
    <value>266680</value>
    <text>3 jours 2 heures</text>
   </duration>
   <distance>
    <value>1451704</value>
    <text>1452 km</text>
   </distance>
  </element>
  <element>
   <status>OK</status>
   <duration>
    <value>10374</value>
    <text>2 heures 53 minutes</text>
   </duration>
   <distance>
    <value>146500</value>
    <text>146 km</text>
   </distance>
  </element>
 </row>
</DistanceMatrixResponse>

DistanceMatrixResponse

FieldRequiredTypeDescription
requiredArray<string>

An array of addresses as returned by the API from your original request. As with origin_addresses, these are localized if appropriate. This content is meant to be read as-is. Do not programatically parse the formatted addresses.

requiredArray<string>

An array of addresses as returned by the API from your original request. These are formatted by the geocoder and localized according to the language parameter passed with the request. This content is meant to be read as-is. Do not programatically parse the formatted addresses.

required Array<DistanceMatrixRow>

An array of elements, which in turn each contain a status, duration, and distance element.

See DistanceMatrixRow for more information.

requiredDistanceMatrixStatus

Contains the status of the request, and may contain debugging information to help you track down why the request failed.

See DistanceMatrixStatus for more information.

optionalstring

A string containing the human-readable text of any errors encountered while the request was being processed.

DistanceMatrixStatus

Status codes returned by service.

  • OK indicates the response contains a valid result.
  • INVALID_REQUEST indicates that the provided request was invalid.
  • MAX_ELEMENTS_EXCEEDED indicates that the product of origins and destinations exceeds the per-query limit.
  • MAX_DIMENSIONS_EXCEEDED indicates that the number of origins or destinations exceeds the per-query limit.
  • OVER_DAILY_LIMIT indicates any of the following:
    • The API key is missing or invalid.
    • Billing has not been enabled on your account.
    • A self-imposed usage cap has been exceeded.
    • The provided method of payment is no longer valid (for example, a credit card has expired).
  • OVER_QUERY_LIMIT indicates the service has received too many requests from your application within the allowed time period.
  • REQUEST_DENIED indicates that the service denied use of the Distance Matrix service by your application.
  • UNKNOWN_ERROR indicates a Distance Matrix request could not be processed due to a server error. The request may succeed if you try again.

DistanceMatrixRow

FieldRequiredTypeDescription
required Array<DistanceMatrixElement>

When the Distance Matrix API returns results, it places them within a JSON rows array. Even if no results are returned (such as when the origins and/or destinations don't exist), it still returns an empty array.

Rows are ordered according to the values in the origin parameter of the request. Each row corresponds to an origin, and each element within that row corresponds to a pairing of the origin with a destination value.

Each row array contains one or more element entries, which in turn contain the information about a single origin-destination pairing.

See DistanceMatrixElement for more information.

DistanceMatrixElement

FieldRequiredTypeDescription
requiredDistanceMatrixElementStatus

A status for the element.

See DistanceMatrixElementStatus for more information.

optionalTextValueObject

The total distance of this route, expressed in meters (value) and as text. The textual value uses the unit system specified with the unit parameter of the original request, or the origin's region.

See TextValueObject for more information.

optionalTextValueObject

The length of time it takes to travel this route, expressed in seconds (the value field) and as text. The textual representation is localized according to the query's language parameter.

See TextValueObject for more information.

optionalTextValueObject

The length of time it takes to travel this route, based on current and historical traffic conditions. See the traffic_model request parameter for the options you can use to request that the returned value is optimistic, pessimistic, or a best-guess estimate. The duration is expressed in seconds (the value field) and as text. The textual representation is localized according to the query's language parameter. The duration in traffic is returned only if all of the following are true:

  • The request includes a departure_time parameter.
  • Traffic conditions are available for the requested route.
  • The mode parameter is set to driving.

See TextValueObject for more information.

optionalFare

If present, contains the total fare (that is, the total ticket costs) on this route. This property is only returned for transit requests and only for transit providers where fare information is available.

See Fare for more information.

Fare

The total fare for the route.

{
  "currency" : "USD",
  "value" : 6,
  "text" : "$6.00"
}
FieldRequiredTypeDescription
requiredstring

An ISO 4217 currency code indicating the currency that the amount is expressed in.

requiredstring

The total fare amount, formatted in the requested language.

requirednumber

The total fare amount, in the currency specified.

DistanceMatrixElementStatus

  • OK indicates the response contains a valid result.
  • NOT_FOUND indicates that the origin and/or destination of this pairing could not be geocoded.
  • ZERO_RESULTS indicates no route could be found between the origin and destination.
  • MAX_ROUTE_LENGTH_EXCEEDED indicates the requested route is too long and cannot be processed.

TextValueObject

An object containing a numeric value and its formatted text representation.

FieldRequiredTypeDescription
requiredstring

String value.

requirednumber

Numeric value.