Skip to content

Historic Traffic DateTime parameter to Route Endpoints #623

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -642,9 +642,9 @@ Autocompletes partial addresses and place names, sorted by relevance and proximi
- **`lang`** (string, optional): Specifies the language for the results. A string, one of `ar`, `de`, `en`, `es`, `fr`, `ja`, `ko`, `pt`, `ru`, `zh`. Defaults to `en`.

###### Query best practices
**US/CA:** For customers using autocomplete for full address completion (i.e. checkout page), pass in **`layers`**: `address`, **`countryCode`**: `US, CA`.
**US/CA:** For customers using autocomplete for full address completion (i.e. checkout page), pass in **`layers`**: `address`, **`countryCode`**: `US, CA`.

**International:** For customers implementing autocomplete for international address completion use cases, contact your solutions engineer for best practices based on your use case.
**International:** For customers implementing autocomplete for international address completion use cases, contact your solutions engineer for best practices based on your use case.

###### Authentication level

Expand Down Expand Up @@ -985,6 +985,7 @@ Calculates the travel distance and duration between an origin and a destination.
- **`units`** (string, optional): The distance units. A string, `metric` or `imperial`. Defaults to `imperial` if not provided. In the response, `distance.value` will be in meters for `metric` and in feet for `imperial`.
- **`avoid`** (string, optional): The features that calculated routes should avoid. A string, comma-separated, including one or more of `tolls`, `highways`, `ferries` and `borderCrossings`. No features are avoided if not provided.
- **`geometry`** (string, optional): The format of the `geometry` in the response. Valid values are `linestring`, `polyline5` and `polyline6`. `linestring` returns a GeoJSON `LineString`, `polyline5` returns a polyline with 5 decimal places of precision (compatible with other mapping providers) and `polyline6` returns a polyline with 6 decimal places of precision. Defaults to none if not provided.
- ** `departureTime`** (string, optional): The date and time of the route provided as an ISO date string which will be used for historical traffic times. If not provided, the current date and time will be used.

###### Authentication level

Expand Down Expand Up @@ -1054,6 +1055,7 @@ Calculates the travel distances and durations between multiple origins and desti
- **`mode`** (string, required): The travel mode. A string, one of `car`, `truck`, `foot`, or `bike`.
- **`units`** (string, optional): The distance units. A string, `metric` or `imperial`. Defaults to `imperial` if not provided.
- **`avoid`** (string, optional): The features that calculated routes should avoid. A string, comma-separated, including one or more of `tolls`, `highways` and `ferries`. No features are avoided if not provided.
- ** `departureTime`** (string, optional): The date and time of the route provided as an ISO date string which will be used for historical traffic times. If not provided, the current date and time will be used.

###### Authentication level

Expand Down Expand Up @@ -1304,6 +1306,7 @@ Calculates the most efficient route between two or more locations to visit in or
- **`units`** (string, optional): The distance units. A string, `metric` or `imperial`. Defaults to `imperial`.
- **`avoid`** (string, optional): The features that calculated routes should avoid. A string, comma-separated, including one or more of `tolls`, `highways`, `ferries` and `borderCrossings`. No features are avoided if not provided.
- **`geometry`** (string, optional): The format of the `geometry` in the response. Valid values are `linestring`, `polyline5` and `polyline6`. `linestring` returns a GeoJSON `LineString`, `polyline5` returns a polyline with 5 decimal places of precision (compatible with other mapping providers) and `polyline6` returns a polyline with 6 decimal places of precision. Defaults to `polyline6` if not provided.
- ** `departureTime`** (string, optional): The date and time of the route provided as an ISO date string which will be used for historical traffic times. If not provided, the current date and time will be used.

###### Turn by Turn

Expand Down Expand Up @@ -2301,6 +2304,7 @@ Calculates the optimal ordering and route to visit a list of locations.
- **`mode`** (string, optional): The travel mode. A string, one of `car`, `truck`, `foot`, or `bike`. Defaults to `car`.
- **`units`** (string, optional): The distance units. A string, `metric` or `imperial`. Defaults to `imperial`.
- **`geometry`** (string, optional): The format of the `geometry` in the response. Valid values are `linestring`, `polyline5` and `polyline6`. `linestring` returns a GeoJSON `LineString`, `polyline5` returns a polyline with 5 decimal places of precision (compatible with other mapping providers) and `polyline6` returns a polyline with 6 decimal places of precision. Defaults to none if not provided.
- ** `departureTime`** (string, optional): The date and time of the route provided as an ISO date string which will be used for historical traffic times. If not provided, the current date and time will be used.

###### Authentication level

Expand Down