An XML/JSON interface to the routing engine (and other CycleStreets components) is available.
Our API is used in a range of mobile apps and websites and we are keen to encourage wide usage.
Apply for an API key for use in your mobile/website application.
Formats (XML/JSON): The examples below all show .xml which will return XML. For JSON output, change this file extension to .json, or, for JSON-P, use .json?callback=method&….
RESTful calls: in almost all cases, arguments are all passed via the query string directly from the URL as a standard GET request. (Only the few calls which require user credentials must be POSTed.)
API keys: An API key is required for all calls.
API usage policy: Please read our API usage policy, which attempts to ensure reasonable use. We aim to be flexible where possible; if you have any concerns about provisions please contact us as we are keen not to put off potential users.
Uptime: Please see our Server reliability and uptime policy.
Compression: Gzip compression is enabled, so ensure your client library is set to send the appropriate Accept-encoding header.
Schema: We hope to publish a formal XML Schema in due course.
Plans fastest / quietest / balanced cycle journeys in the UK (and some other areas), knows Sustrans routes, avoids hills, and supports waypoints.
Retrieve an already-planned route.
Our leisure routing API will suggest circular leisure routes based on a specified distance or time, optionally via points of interest.
The nearest point API returns the nearest point to a given longitude/latitude. (Not normally needed for journey planning.)
The Feedback addition API enables users to send feedback on planned cycle journeys, helping us continually provide better routes.
With the geocoder API you can get suggested best-location matches for streets, towns and cities, places, postcodes, and stations.
The Points of Interest (POIs) API provides locations of places of interest, both utility and practical locations.
The Photomap locations API provides a data interface to our Photomap, enabling you to retrieve photos of cycling-related infrastructure.
The Photomap location API lets you retrieve an individual photo in the Photomap.
The Photomap categories API enables clients to retrieve the list of Photomap categories.
With the Add photo API you can add a photo to the Photomap.
The User authenticate API authenticate CycleStreets user account credentials.
The User create API enables the creation of a new CycleStreets user account.
The Status API provides an overview of details about the journey planner API, such as the maximum journey length and countries covered.