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.

IconApply for an API key for use in your mobile/website application. The API is also available under a Commercial SLA.

The examples assume an API key is specified – see how to specify an API key.

# Journey planner

Cycle routing - plan new journey

Cycle routing - plan new journey

Plans fastest / quietest / balanced cycle journeys in the UK (and some other areas), knows Sustrans routes, avoids hills, and supports waypoints.

Cycle routing - retrieve

Cycle routing - retrieve

Retrieve an already-planned route.

Cycle routing - plan leisure (circular) route

Cycle routing - plan leisure (circular) route

Our leisure routing API will suggest circular leisure routes based on a specified distance or time, optionally via points of interest.

Journeys of user

Journeys of user

This API provides a listing of the journeys of a specified user, having regard to any privacy settings.

Nearest point

Nearest point

The nearest point API returns the nearest point to a given longitude/latitude. (Not normally needed for journey planning.)

# Feedback

Add feedback

Add feedback

The Feedback addition API enables users to send feedback on planned cycle journeys, helping us continually provide better routes.

# Geocoding

Geocoder

Geocoder

With the geocoder API you can get suggested best-location matches for streets, towns and cities, places, postcodes, and stations.

# Points of interest

Points of Interest (POIs)

Points of Interest (POIs)

The Points of Interest (POIs) API provides locations of places of interest, both utility and practical locations.

Collisions data

Collisions data

The collisions data API provides locations and details of every reported road traffic collision in the UK from 2005.

Collision report

Collision report

This call retrieves a single collision data location.

# GPS tracks

GPS tracks - add

GPS tracks - add

With the GPS tracks API you can upload a GPS track to a user profile.

# Photomap

Photomap locations

Photomap locations

The Photomap locations API provides a data interface to our Photomap, enabling you to retrieve photos of cycling-related infrastructure.

Photomap location

Photomap location

The Photomap location API lets you retrieve an individual photo in the Photomap.

Photomap categories

Photomap categories

The Photomap categories API enables clients to retrieve the list of Photomap categories.

Add photo

Add photo

With the Add photo API you can add a photo to the Photomap.

Update photo

Update photo

With the Update photo API you can update a photo in the Photomap.

Like photo

Like photo

Enables users to Like a photo, to guage popularity.

# Galleries

List galleries

List galleries

The Galleries List API enables clients to retrieve the list of Galleries.

Retrieve a specified gallery

Retrieve a specified gallery

The Galleries Get API enables clients to retrieve an specified gallery.

Create a gallery

Create a gallery

The Galleries Create API enables clients to create a Gallery.

Update a gallery

Update a gallery

The Galleries Update API enables clients to update a Gallery.

# User accounts

User authenticate

User authenticate

The User authenticate API authenticate CycleStreets user account credentials.

User create

User create

The User create API enables the creation of a new CycleStreets user account.

# System status

Status

Status

The Status API provides an overview of details about the journey planner API, such as the maximum journey length and countries covered.

# Developers

API testing - multiple

API testing - multiple

Runs a set of internal API tests

API testing - run one

API testing - run one

Runs a single internal API tests

API testing - list of tests

API testing - list of tests

Creates a listing of the tests available

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

My comments relate to: *






Your comments: *
URL of page: * http://www.cyclestreets.net/api/
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.