• Help
• Journey Planner
• How it works
• OSM
• Developers
• API
• Photomap
• Photo licensing

CycleStreets API (v2)

• Details for:

  * Introduction * Overview & how to specify the API key Cycle routing - plan new journey Cycle routing - retrieve Cycle routing - plan leisure (circular) route Journeys of user Isochrones - show Nearest point Batch routes matrix - create job Batch routes matrix - control job Batch routes matrix - job data Batch routes matrix - delete job Geocoder Photomap locations Photomap location Photomap categories Add photo Update photo Like photo Photo of the day Photomap tags Points of Interest (POIs) Points of Interest (POIs) - types Collisions data Collision report Collisions metadata Traffic counts data Popup cycleways - locations being implemented Popup cycleways - suggested LTNs: Modal filters LTNs: Streets LTN statistics Infrastructure locations Infrastructure location Infrastructure schema GPS tracks - add List galleries Retrieve a specified gallery Create a gallery Update a gallery User authenticate User create Map downloads Status API testing - multiple API testing - run one API testing - list of tests Add feedback API V1 documentation (deprecated)
• API overview
• Obtain API key
• Usage policy
• Uptime policy

JSON output: Output is exclusively JSON (JSON-P is also supported - see below). Calls which output geographical data normally plotted on a map are GeoJSON by default, for ease of processing.

JSON-P: If your application has to support legacy clients, JSON-P can be requested, using ?callback=method&….

HTTPS only: All calls are made to https://api.cyclestreets.net .

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. There are three ways to supply the API key:

1. As a GET parameter: https://api.cyclestreets.net/v2/method?key=registeredapikey&…
2. As a HTTP username: https://registeredapikey@api.cyclestreets.net/v2/method…
3. As a HTTP header: X-API-KEY:registeredapikey along with the call itself https://api.cyclestreets.net/v2/method…

API usage policy (best efforts): 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.

SLA available: We also offer the API on a paid-for SLA-supported basis. Please contact us for details.

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.