Route API Overview¶
Route API is used to calculate optimized routes between points. This section describes the core features and usage scenarios of the Route API.
What is Route API?¶
Route API is an endpoint that calculates the most optimal route between origin and destination points. With a single API call, you can retrieve:
- Optimized route geometry
- Total distance and estimated duration
- Turn-by-turn directions
- Toll costs
- Restrictions based on vehicle properties
Basic Usage¶
For basic usage of the Route API, refer to the API Reference page.
Use Cases¶
1. Delivery Route Planning¶
Calculate the fastest route from point A to point B for a courier or delivery vehicle.
2. Multi-Stop Route¶
Create a single route with multiple delivery points using waypoints.
3. Truck Routing¶
Calculate suitable routes for trucks based on vehicle dimensions, weight, and hazardous material information.
4. Toll Calculation¶
Perform cost analysis by calculating tolls along the route.
5. Avoidance Zones¶
Generate routes that avoid specific areas or road features.
Configuration¶
The main parameters available for configuring the Route API:
| Parameter | Description |
|---|---|
minimize |
"distance" or "duration" — Specifies what to optimize |
tolls |
true/false — Toll calculation |
avoidFeatures |
Road features to avoid |
vehicle |
Vehicle properties (for truck routing) |
language |
Language for turn-by-turn directions |
Next Steps¶
Route API overview — Flio.ai