POST

/routes/v0/calculators/{CalculatorName}/calculate/route-matrix

http://geo.{region}.amazonaws.com/routes/v0/calculators/{CalculatorName}/calculate/route-matrix

<a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html"> Calculates a route matrix</a> given the following required parameters: <code>DeparturePositions</code> and <code>DestinationPositions</code>. <code>CalculateRouteMatrix</code> calculates routes and returns the travel time and travel distance from each departure position to each destination position in the request. For example, given departure positions A and B, and destination positions X and Y, <code>CalculateRouteMatrix</code> will return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned (and routes calculated) will be the number of <code>DeparturePositions</code> times the number of <code>DestinationPositions</code>. <note> Your account is charged for each route calculated, not the number of requests. </note> Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a route calculator resource</a>. By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating routes. Additional options include: <ul> <li> <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html"> Specifying a departure time</a> using either <code>DepartureTime</code> or <code>DepartNow</code>. This calculates routes based on predictive traffic data at the given time. <note> You can't specify both <code>DepartureTime</code> and <code>DepartNow</code> in a single request. Specifying both parameters returns a validation error. </note> </li> <li> <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel mode</a> using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or <code>TruckModeOptions</code> if traveling by <code>Truck</code>. </li> </ul>

Access Token Required: API Key

Path Parameters

CalculatorNamestringrequired

The name of the route calculator resource that you want to use to calculate the route matrix.

Body Params

DepartNowboolean

Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both <code>DepartureTime</code> and <code>DepartNow</code>. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix. Default Value: <code>false</code> Valid Values: <code>false</code> | <code>true</code>

TravelModestring

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. The <code>TravelMode</code> you specify also determines how you specify route preferences: <ul> <li> If traveling by <code>Car</code> use the <code>CarModeOptions</code> parameter. </li> <li> If traveling by <code>Truck</code> use the <code>TruckModeOptions</code> parameter. </li> </ul> <note> <code>Bicycle</code> or <code>Motorcycle</code> are only valid when using <code>Grab</code> as a data provider, and only within Southeast Asia. <code>Truck</code> is not available for Grab. For more information about using Grab as a data provider, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html">GrabMaps</a> in the Amazon Location Service Developer Guide. </note> Default Value: <code>Car</code>

DistanceUnitstring

Set the unit system to specify the distance. Default Value: <code>Kilometers</code>

DepartureTimestring

Specifies the desired time of departure. Uses the given time to calculate the route matrix. You can't set both <code>DepartureTime</code> and <code>DepartNow</code>. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix. <note> Setting a departure time in the past returns a <code>400 ValidationException</code> error. </note> <ul> <li> In <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. For example, <code>2020–07-2T12:15:20.000Z+01:00</code> </li> </ul>

CarModeOptionsobject

Contains details about additional route preferences for requests that specify <code>TravelMode</code> as <code>Car</code>.

TruckModeOptionsobject

Contains details about additional route preferences for requests that specify <code>TravelMode</code> as <code>Truck</code>.

DeparturePositionsarrayrequired

The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in <a href="https://earth-info.nga.mil/GandG/wgs84/index.html">WGS 84</a> format: <code>[longitude, latitude]</code>. For example, <code>[-123.115, 49.285]</code>. <important> Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits"> Position restrictions</a> in the Amazon Location Service Developer Guide. </important> <note> For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html"> moves the position to the nearest road</a>. The snapped value is available in the result in <code>SnappedDeparturePositions</code>. </note> Valid Values: <code>[-180 to 180,-90 to 90]</code>

DestinationPositionsarrayrequired

The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in <a href="https://earth-info.nga.mil/GandG/wgs84/index.html">WGS 84</a> format: <code>[longitude, latitude]</code>. For example, <code>[-122.339, 47.615]</code> <important> Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits"> Position restrictions</a> in the Amazon Location Service Developer Guide. </important> <note> For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html"> moves the position to the nearest road</a>. The snapped value is available in the result in <code>SnappedDestinationPositions</code>. </note> Valid Values: <code>[-180 to 180,-90 to 90]</code>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://geo.{region}.amazonaws.com/routes/v0/calculators/{CalculatorName}/calculate/route-matrix' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request POST \ 2 --url 'http://geo.{region}.amazonaws.com/routes/v0/calculators/{CalculatorName}/calculate/route-matrix' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'