| Name |
Type |
Description |
Notes |
| units |
DistanceUnit |
|
[optional] [default to DistanceUnit.KM] |
| language |
ValhallaLanguages |
|
[optional] [default to ValhallaLanguages.EN_MINUS_US] |
| directions_type |
str |
The level of directional narrative to include. Locations and times will always be returned, but narrative generation verbosity can be controlled with this parameter. |
[optional] [default to 'instructions'] |
| format |
str |
The output response format. The default JSON format is extremely compact and ideal for web or data-constrained use cases where you want to fetch additional attributes on demand in small chunks. The OSRM format is much richer and is configurable with significantly more info for turn-by-turn navigation use cases. |
[optional] |
| banner_instructions |
bool |
Optionally includes helpful banners with timing information for turn-by-turn navigation. This is only available in the OSRM format. |
[optional] |
| voice_instructions |
bool |
Optionally includes voice instructions with timing information for turn-by-turn navigation. This is only available in the OSRM format. |
[optional] |
| filters |
AnnotationFilters |
|
[optional] |
| id |
str |
An identifier to disambiguate requests (echoed by the server). |
[optional] |
| locations |
List[RoutingWaypoint] |
|
|
| costing |
CostingModel |
|
|
| costing_options |
CostingOptions |
|
[optional] |
| exclude_locations |
List[RoutingWaypoint] |
This has the same format as the locations list. Locations are mapped to the closed road(s), and these road(s) are excluded from the route path computation. |
[optional] |
| exclude_polygons |
List[List[List[float]]] |
One or multiple exterior rings of polygons in the form of nested JSON arrays. Roads intersecting these rings will be avoided during path finding. Open rings will be closed automatically. If you only need to avoid a few specific roads, it's much more efficient to use `exclude_locations`. |
[optional] |
| alternates |
int |
How many alternate routes are desired. Note that fewer or no alternates may be returned. Alternates are not yet supported on routes with more than 2 locations or on time-dependent routes. |
[optional] |
| elevation_interval |
float |
If greater than zero, attempts to include elevation along the route at regular intervals. The "native" internal resolution is 30m, so we recommend you use this when possible. This number is interpreted as either meters or feet depending on the unit parameter. Elevation for route sections containing a bridge or tunnel is interpolated linearly. This doesn't always match the true elevation of the bridge/tunnel, but it prevents sharp artifacts from the surrounding terrain. This functionality is unique to the route endpoint and is not available via the elevation API. |
[optional] [default to 0.0] |
| roundabout_exits |
bool |
Determines whether the output should include roundabout exit instructions. |
[optional] [default to True] |
from stadiamaps.models.route_request import RouteRequest
# TODO update the JSON string below
json = "{}"
# create an instance of RouteRequest from a JSON string
route_request_instance = RouteRequest.from_json(json)
# print the JSON string representation of the object
print(RouteRequest.to_json())
# convert the object into a dict
route_request_dict = route_request_instance.to_dict()
# create an instance of RouteRequest from a dict
route_request_from_dict = RouteRequest.from_dict(route_request_dict)[Back to Model list] [Back to API list] [Back to README]