Route4Me API Documentation

View Route

This API method will return all the available route details for a specific route id.

URL: http://www.route4me.com/api/view_route.php

Your API key is available at this URL: http://www.route4me.com/myAccount_api.php

 

Method Parameter Type Required Default Description
GET api_key String Yes N/A A valid and active API key obtained from authentication or a user's API control panel.
GET route_id String Yes N/A The route_id returned by the route planner when the route was initially planned.
GET show_directions ENUM(0,1) No 1 Enable output of turn-by-turn directions and associated vector points for each point.
GET directions ENUM(0,1) No 1 A flag to enable or disable driving and turn-by-turn directions. Legacy variable that can be overwritten by the travelMode variable.
GET distanceUnit ENUM("mi", "km") No mi The measurement units for the route.
GET travelMode ENUM("Driving", "Walking") No Driving The mode of travel that the directions should be optimized for.
GET avoid ENUM("Highways", "Tolls", "minimizeHighways", "minimizeTolls") No NULL Options which let the user choose which road obstacles to avoid.
GET format ENUM("json", "xml", "serialized", "friendly", csv") No serialized The format in which to return the route data.
GET debug_log ENUM(True, False) No False If the initial request when creating this route had debug_logging enabled, then enabling the debug_log output will output the initial GET and POST with the results data.