Skip to main content

Route Matrix

The Route Matrix API returns the travel time and distance for a matrix of origins and destinations. It does not provide any detailed information about the route. The limit of origins and destinations is 10 * 10.

The time and distance for each origin and destination pair are returned in the following order:

  • Origin A to destinations (A, B, C …);
  • Origin B to destinations (A, B, C …);
  • And so on up to 10 origins and 10 destinations per API call.

Requires add-on license

GET /route/matrix

Resource URL

https://pcmiler.alk.com/apis/rest/v1.0/Service.svc/route/matrix

Parameters

Required parameters are marked with an asterisk.

Request

API KEY
GET

Response

Route Matrix Response

Data ElementDescriptionData TypeValue/Example
OriginsA collection of Geocoded origins.List of GeocodeOutputLocation Object
DestinationsA collection of Geocoded destination.List of GeocodeOutputLocation Object
MatrixInfoA list of RouteMatrixInfo objects that contain the time and distance between each origin and destination.List of RouteMatrixInfo Object

RouteMatrixInfo

Data ElementDescriptionData TypeValue/Example
SuccessIndicate if route is success or not.
boolean
ErrorsRoute errors
List of Errors Object
TimeRoute time
string
DistanceRoute distance
string

Errors

Data ElementDescriptionData TypeValue/Example
TypeIndicates whether the error is an exception or warning
Enum
Warning Exception
CodeError code
Enum
LegacyErrorCodeThe legacy error code with is an integer valued code that would have been returned in PC*MILER Web Services v25 and earlier.
Int
DescriptionThe detailed error description.
string
Last updated November 23, 2021.