• Help
• Journey Planner
• How it works
• OSM
• Developers
• API
• Photomap
• Photo licensing

CycleStreets API (v2)

• Details for:

  * Introduction * Overview & how to specify the API key Cycle routing - plan new journey Cycle routing - retrieve Cycle routing - plan leisure (circular) route Journeys of user Isochrones - show Nearest point Batch routes matrix - create job Batch routes matrix - control job Batch routes matrix - job data Batch routes matrix - delete job Geocoder Photomap locations Photomap location Photomap categories Add photo Update photo Like photo Photo of the day Photomap tags Points of Interest (POIs) Points of Interest (POIs) - types Collisions data Collision report Collisions metadata Traffic counts data Popup cycleways - locations being implemented Popup cycleways - suggested LTNs: Modal filters LTNs: Streets LTN statistics Infrastructure locations Infrastructure location Infrastructure schema GPS tracks - add List galleries Retrieve a specified gallery Create a gallery Update a gallery User authenticate User create Map downloads Status API testing - multiple API testing - run one API testing - list of tests Add feedback API V1 documentation (deprecated)
• API overview
• Obtain API key
• Usage policy
• Uptime policy

Status

This API call gives information about the current availability and performance of the site.

For instance, it shows whether the journey planner and photomap are live, and the maximum journey distance that is plannable.

Example

Call to show the system status.

https://api.cyclestreets.net/v2/status

Result:

{
	"sitestatus": {
		"journeyplanner": "live",
		"photomap": "live"
	},
	"maxjourneylength": {
		"distance": 300,
		"units": "km"
	}
}

Request parameters - required

None.

Request parameters - optional

None.

Response

JSON object as above.

Error response

JSON object containing an error key and a text string.

Example error (text string will vary):

{
    "error": "There was a problem retrieving the status data."
}