Travel Boundary API computes areas reachable within a specific time or distance from a given point. It returns these as polygons or lines for easy map visualization and zone planning.
Request
- Base URL: https://api.cloud.precisely.com
- URL: https://api.cloud.precisely.com/v1/isochrone/location
- Auth: one of:
- HTTP bearer
- API key in header Authorization
Query parameters
Specifies the order of coordinates in the request. Use 'LonLat' when providing coordinates in Longitude,Latitude order (X,Y). If not specified or set to 'LatLon', coordinates are expected in Latitude,Longitude order. This parameter applies to the 'coordinates' parameter. Default: LatLon, Example: LatLon
The address of the location which acts as the starting point for which the isochrone lines need to be determined. Example: POINT REYES STATION CA
Country name used only when the starting location is provided as an address. Example: USA
The coordinates of the location which acts as the starting point for which the isochrone lines need to be determined. Format will be latitude, longitude.
The time, in minutes, for which an isochrone contour needs to be determined. You can request up to 4 time based contours in a single request using a , as a separator.Please note that, when requesting multiple isochrones, the times must be provided in an increasing order.The maximum time that can be specified is 40 minutes.This parameter is mandatory when contours_meters is not provided in the request.
The distance, in meters, for which an isochrone contour needs to be determined. You can request up to 4 distance based contours in a single request using a , as a separator.Please note that, when requesting multiple isochrones, the distances must be provided in an increasing order.The maximum distance that can be specified is 60000 meters (60km).This parameter is mandatory when contours_minutes is not provided in the request.
Set which driving mode the service should use to determine the contour.For example, if you use car, the API will return an isochrone contour that a car can reach within the specified time or after driving the specified distance. Using truck will return a contour that a truck can reach after taking into account appropriate truck routing restrictions.[Note: Only the car profile is enabled by default. Please note that customized profiles (including truck) might not be available for all regions.
The hex code of the color to fill isochrone contour. When requesting multiple contours, it is recommended to provide color codes for each of the requested contours, separated by a ,. If no colors are specified, the Isochrone API will assign a random color scheme to the output.
When true the contour is returned as a GeoJSON polygon. The contour is returned as a linestring when this parameter is false. Default value is false
A floating point value from 0.0 to 1.0 that can be used to remove smaller contours. A value of 1.0 will only return the largest contour for a given value. A value of 0.5 drops any contours that are less than half the area of the largest contour in the set of contours for that same value. Minimum: 0,Maximum: 1 and Default is 1
A positive floating point value, in meters, used as the tolerance for Douglas-Peucker generalization. There is no upper bound. As the generalization value goes higher, more and more straight lines form the resulting contour because of higher approximation of actual contour boundary. If no value is specified in the request, the Isochrone API will choose the most optimized generalization to use for the request.Please note that the generalization of contours can lead to self-intersections, as well as intersections of adjacent contours. Values under 2 metres are going to time out and are not sensible, since if you want to generalize you should use at least 10 or more meters
Use this parameter to set a departure time, expressed as UNIX epoch timestamp in seconds, for calculating the isochrone contour. The response will consider the typical traffic conditions at the given time and return a contour which can be reached under those traffic conditions. Please note that if no input is provided for this parameter then the traffic conditions at the time of making the request are considered.
Use this parameter to specify departure time in local time format (day name and time). Format: 'DayName HH:mm'. The API will automatically convert this to the appropriate UTC timestamp based on the timezone of the start location. Cannot be used together with departure_time parameter. Examples: Monday 08:00
Headers
The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting.
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.