Donate using PayPal

CycleStreets API (v2)

  • Details for:
  • 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."
}

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

My comments relate to: *






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