Snap to Road API FAQ

Snap To Roads API takes a series of locations and snaps them to nearby roads representing the best-matched route where a trip took place connecting all the given locations. Users can choose to retrieve a geometry of the route connecting all the points while using several other configurations. They can also choose to receive the segment-wise speed limits of the route identified in the response.

You can use a basic GET request using the 2 required parameters, key and path, to obtain accurate road-snap data. you can further customise the request by including other optional parameters.

You can use the “path” parameter to use Pipe-separated list of coordinate points along a path which would be snapped to a road. You can use up to 200 coordinate points in the “path” parameter by using POST request. However, It is recommended to use the GET method when the number of coordinate points in the path parameter is less than 100.

This parameter allows you to snap the available road within a provided radius. You can provide radiuses in metres (m),

Please note, if no valid road is available within the specified radius, the API would snap the points to nearest, most viable road.

The default radius value while using SnapToRoad is 25 metres.

Note: If the number of radiuses in the request does not match the number of coordinates in 'path'. Response is generated using the default radius value for all locations.

You can use Pipe-separated UNIX epoch timestamp in seconds for each location. The number of timestamps must be equal to the number of coordinate points in the path parameter.

The timestamps must increase monotonically starting from the first timestamp. This means that each subsequent timestamp should either be more than or equal to the preceding one.

The “road_info” parameter allows you to receive segment-wise maximum speed information of the route returned in the request. max_speed is the only allowed value for this parameter.

“Max_speed” returns an array of objects containing maximum speed, in kilometres per hour, for each segment of the route. Each object represents one road segment.

Please note that returning speed information is a function of the “road_info” parameter, which is effective only when option=flexible is used in the request.

This parameter supports a boolean value to ignore any coordinate outside the service boundary.
When true, the service would ignore path coordinates points falling outside the accessible area, which otherwise would cause an error when this parameter is false.

The bearing angle of the snapped point from the original point in radians. It indicates the direction of the snapped point

Snap To Road API supports both HTTPS GET and POST methods. .

For GET Request, It is recommended to use it when the number of coordinate points in the path parameter is less than 100.
For POST Requests, the maximum number of path coordinate points allowed is 200.