CyIPT API documentation

Welcome to the API for the CyIPT project.

Please note that this API is subject to change without notice.

Use .json to return GeoJSON, or .csv (or .json with &format=csv) to return CSV. The examples below use the GeoJSON output format.

Jump to:

/v1/recommended.json

Example

/api/v1/recommended.json?bbox=-2.6404,51.4698,-2.5417,51.4926&zoom=15

Required fields

bbox string, w,s,e,n
Bounding box of the map canvas.
zoom int
Zoom level of the map.

# Schemes

/v1/schemes.json

Example

/api/v1/schemes.json?bbox=-2.6404,51.4698,-2.5417,51.4926&zoom=15&costfrom=50000&costto=750000

Required fields

bbox string, w,s,e,n
Bounding box of the map canvas.
zoom int
Zoom level of the map.
costto int, 0-999999999
Maximum cost
benefitcostfrom int, 0-9999
Benefit-cost ratio (BCR) at least
benefitfrom int, 0-999999999
Benefit (in £) at least

# Existing infrastructure

/v1/existing.json

Example

/api/v1/existing.json?bbox=-2.6404,51.4698,-2.5417,51.4926&zoom=15

Required fields

bbox string, w,s,e,n
Bounding box of the map canvas.
zoom int
Zoom level of the map.
layer string, cycleinfrastructure|speedlimits|footways
Map layer type: Cycle infrastructure / Speed limits / Footways

# Road width

/v1/width.json

Example

/api/v1/width.json?bbox=-2.6404,51.4698,-2.5417,51.4926&zoom=15&widthlayer=roadwidth

Required fields

bbox string, w,s,e,n
Bounding box of the map canvas.
zoom int
Zoom level of the map.
widthlayer string, roadwidth|widthstatus
CyIPT layer: road width (Including footway and verges), width status (Is there enough width for proposed infrastructure)

# Propensity to Cycle Tool

/v1/pct.json

Example

/api/v1/pct.json?bbox=-2.6404,51.4698,-2.5417,51.4926&zoom=15&pctlayer=pctcensus

Required fields

bbox string, w,s,e,n
Bounding box of the map canvas.
zoom int
Zoom level of the map.
pctlayer string, pctcensus|pctgov|pctgen|pctdutch|pctebike
PCT layer

# Traffic counts

/v1/traffic.json

Example

/api/v1/traffic.json?bbox=-2.6404,51.4698,-2.5417,51.4926&zoom=15

Required fields

bbox string, w,s,e,n
Bounding box of the map canvas.
zoom int
Zoom level of the map.

# Collisions (Roads)

/v1/collisionsroad.json

Example

/api/v1/collisionsroad.json?bbox=-2.6404,51.4698,-2.5417,51.4926&zoom=15&collisionsroadlayer=ncollisionsSlight

Required fields

bbox string, w,s,e,n
Bounding box of the map canvas.
zoom int
Zoom level of the map.
collisionsroadlayer string, ncollisionsSlight|ncollisionsSerious|ncollisionsFatal|bikeCasSlight|bikeCasSerious|bikeCasFatal
Collisions (Roads)

# Collisions (Roads)

/v1/collisionsjunctions.json

Example

/api/v1/collisionsjunctions.json?bbox=-2.6404,51.4698,-2.5417,51.4926&zoom=15&collisionsjunctionslayer=ncollisionsSlight

Required fields

bbox string, w,s,e,n
Bounding box of the map canvas.
zoom int
Zoom level of the map.
collisionsjunctionslayer string, ncollisionsSlight|ncollisionsSerious|ncollisionsFatal|bikeCasSlight|bikeCasSerious|bikeCasFatal
Collisions (Junctions)

# Collisions

/v1/collisions.json

Example

/api/v1/collisions.json?bbox=-2.6404,51.4698,-2.5417,51.4926&zoom=15&yearfrom=2013&yearto=2015&severity=1

Required fields

bbox string, w,s,e,n
Bounding box of the map canvas.
zoom int
Zoom level of the map.
yearfrom int, 1985-2015
Start year
yearto int, 1985-2015
Finish year
severity int, 1|2|3
Severity: 1 (fatal), 2 (serious), 3 (slight)

# Travel to Work Areas (TTWA)

/v1/ttwa.json

Example

/api/v1/ttwa.json?bbox=-2.6404,51.4698,-2.5417,51.4926&zoom=15

Required fields

bbox string, w,s,e,n
Bounding box of the map canvas.
zoom int
Zoom level of the map.

# Status

/v1/status.json

Example

/api/v1/status.json?bbox=-2.6404,51.4698,-2.5417,51.4926&zoom=15

Required fields

bbox string, w,s,e,n
Bounding box of the map canvas.
zoom int
Zoom level of the map.