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:
# Recommended infrastructure
/v1/recommended.json
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
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
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
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
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
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
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
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
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 string, fatal|serious|slight
- Severity, based on STATS19 value
# Travel to Work Areas (TTWA)
/v1/ttwa.json
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
Required fields
- bbox string, w,s,e,n
- Bounding box of the map canvas.
- zoom int
- Zoom level of the map.