• 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

Batch routes matrix - job data

This API call provides a polling URL to determine availability of the data, following creation of the job using the batchroutes.createjob API call and following starting of the job using the batchroutes.controljob API call.

It returns a status code for whether the data is yet available, and URLs of the downloadable files upon completion.

A suitable polling interval is every 60 seconds, or 30 seconds if the job is very small.

Example

Example which requests the download status of a job.

POST https://api.cyclestreets.net/v2/batchroutes.jobdata?key=...
(
	[id] => 69158
	[username] => myusername
	[password] => mypassword
)

Result (before availability):

{
    "id": 69158,
    "status": "open"
    "percentageComplete": 20.1,
    "ready": false
    "files": {}
}

Result (upon availability) - generally the dataGz file will be the main one wanted:

{
    "id": 69158,
    "status": "complete"
    "percentageComplete": 100,
    "errors": {
        "Too short: journeys must be longer than 4 metres. (Your requested journey was 0 metres).": 1
    },
    "ready": true,
    "files": {
        "dataCsv": "https://api.cyclestreets.net/v2/batchroutes.download?...",
        "dataGz": "https://api.cyclestreets.net/v2/batchroutes.download?...",
        "gridCsv": "https://api.cyclestreets.net/v2/batchroutes.download?...",
        "gridGz": "https://api.cyclestreets.net/v2/batchroutes.download?..."
    }
}

Request parameters - required

id int

Batch job ID, as returned from batchroutes.createjob.

username string

Your CycleStreets account username. In due course this will be replaced with an OAuth token.

password string

Your CycleStreets account password.

Request parameters - optional

None.

Response

JSON response as above, containing a result status and, when available, the URLs to download the data.

It is recommended to use the 'ready' key, which returns a boolean.

Error response

JSON object containing an error key and a text string.

Example error (text string will vary):

{
    "error": "An error occurred while controlling the job."
}