CycleStreets API (v2)

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. 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

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

Cycle routing - retrieve

Retrieve an already-planned route.

Cycle routing - plan leisure (circular) route

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

Journeys of user

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

Isochrones - show

Get isochrones from a location up to a time in seconds

Nearest point

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

Routing coverage

This API shows the areas which the routing engine covers.

# Batch routes matrix

Batch routes matrix - create job

Create a batch routes matrix job, setting the parameters for a job which can then be started/controlled.

Batch routes matrix - control job

Start/pause a batch routes matrix job.

Batch routes matrix - job data

Provides a polling URL to determine availability of the data.

Batch routes matrix - delete job

Delete a batch routes matrix job definition.

# Geocoding

Geocoder

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

# Photomap

Photomap locations

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

Photomap location

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

Photomap categories

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

Add photo

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

Update photo

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

Like photo

Enables users to Like a photo, to guage popularity.

Photo of the day

The Photo of the day API enables clients to retrieve today's featured photo.

Photomap tags

Retrieve a list of tags in the Photomap.

# Points of interest

Points of Interest (POIs)

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

Point of Interest (POI)

Gets a single POI.

Points of Interest (POIs) - types

POI types

# Advocacy data

Collisions data

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

Collision report

This call retrieves a single collision data location.

Collisions metadata

This call retrieves metadata structures relating to the collision data.

Traffic counts data

The traffic counts data API provides traffic counts, for all types of vehicles, on main roads around Great Britain, from 2000.

Popup cycleways - locations being implemented

Popup cycleway locations being implemented.

Popup cycleways - suggested

Suggested popup cycleway infrastructure, arising from research work at Leeds University.

LTNs: Modal filters

Modal filters, favouring walking, cycling and public transport.

LTNs: Streets

Streets, marked as no through-traffic (LTNs), through-traffic (rat run), or through-route but traffic-calmed.

LTN statistics

Statistics about low traffic neighbourhoods

# Infrastructure dataset auditing

Infrastructure locations

Retrieves locations from an infrastructure dataset.

Infrastructure location

Retrieves a single location from an infrastructure dataset.

Infrastructure schema

Provides the schema of an infrastructure dataset.

# GPS tracks

GPS tracks - add

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

# Galleries

List galleries

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

Retrieve a specified gallery

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

Create a gallery

The Galleries Create API enables clients to create a Gallery.

Update a gallery

The Galleries Update API enables clients to update a Gallery.

# User accounts

User authenticate

The User authenticate API authenticate CycleStreets user account credentials.

User create

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

# Map downloads

Map downloads

List of map download files in Mapsforge format, for use as offline map packs in the CycleStreets Android app.

# System 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

# Feedback

Add feedback

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

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