diff --git a/docs/api.mdx b/docs/api.mdx index 39bbd41bc..d8677eae5 100644 --- a/docs/api.mdx +++ b/docs/api.mdx @@ -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 @@ -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 @@ -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 @@ -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 @@ -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