Modes in HERE Matrix Routing API v8
The purpose of the Matrix Routing service is to calculate routing matrices for given origins and destinations. The service supports three general modes, each of which comes with a trade-off.
The values of the regionDefinition and profile parameters determine which mode is used.
The following table describes the capabilities and limitations of each mode.
| Mode | regionDefinition parameter | profile parameter provided? | Custom options and time awareness (incl. live traffic) | Unlimited region | Matrix size limit (synchronous) | Matrix size limit (asynchronous) |
|---|---|---|---|---|---|---|
| Flexible | world | no | yes | yes | 15 x 100 or 100 x 1 | 15 x 100 or 100 x 1 |
| Region | one of:<ul><li>circle<li>boundingBox<li>polygon<li>autoCircle | no | yes | no origins and destinations must be within a region of max 400 km diameter | 500 x 500 | 10,000 x 10,000 |
| Profile | world | yes | no | yes | 500 x 500 or 1 x 2000 or 2000 x 1 | 10,000 x 10,000 |
The Flexible mode allows custom options and/or dynamic traffic when calculating matrices with routes of arbitrary length, but is only available for matrices with a maximum size of 15x100 or 100x1. To learn more, see Flexible mode.
The trade-off of the Region mode is that it enables custom options and/or dynamic traffic only for matrices with origins and destinations that lie in a specific region of at most 400 km diameter. The service requires the region to be defined in the request. In particular, this means that this mode does not support routes of arbitrary length. To learn more, see Region mode.
The trade-off of the Profile mode is that only predefined sets of options are supported and that the calculation uses free-flow speeds based on historical traffic. To learn more, see Profile mode.
The API requires the user to explicitly choose one of the modes.
- For Flexible mode, provide the region definition
worldand no more than 15 origins and 100 destinations, or no more than 100 origins and 1 destination. - For Region mode, provide any region definition except
world. - For Profile mode, provide the region definition
worldand select one of the predefined profiles.
For tutorials on how to use each mode, see these sections:
Updated 8 days ago