Donate using PayPal

CycleStreets API (v2)

  • Details for:
  • API overview
  • Obtain API key
  • Usage policy
  • Uptime policy

The CycleStreets API (v2) is a modern JSON interface to the routing engine and other CycleStreets components.
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.

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.

We welcome your feedback, especially to report bugs or give us route feedback.

My comments relate to: *






Your comments: *
URL of page: * https://www.cyclestreets.net/api/v2/overview/
How did you find out about CycleStreets?:
Your name:
Our ref: Please leave blank - anti-spam measure

* Items marked with an asterisk [*] are required fields and must be fully completed.