• 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 Nearest point Add feedback Geocoder Points of Interest (POIs) Points of Interest (POIs) - types Collisions data Collision report Collisions metadata Traffic counts data GPS tracks - add Photomap locations Photomap location Photomap categories Add photo Update photo Like photo Photo of the day List galleries Retrieve a specified gallery Create a gallery Update a gallery User authenticate User create Status API testing - multiple API testing - run one API testing - list of tests API V1 documentation (deprecated)
• API overview
• Obtain API key
• Usage policy
• Uptime policy

API testing - run one

This API call is used internally for testing the system.

It is meant for the development team and so should be considered fluid.

The API testing system has a long list of predefined named tests. Each test defines an expected result, which can be compared with the actual result of running the test. The result of this API call indicates whether that test passed or failed.

Example

This example runs a named test:

https://api.cyclestreets.net/v2/apitesting.runtest?name=Photomap+categories

Result:

{
    "status": true,
    "time": 55,
    "call": "photomap.categories",
    "apiVersion": 2,
    "name": "Photomap categories",
    "note": false,
    "response": "Hidden",
    "percentage": false,
    "diagnosis": "",
    "diagnosisHtml": false
}

Request parameters - required

name string

Name of the test. These which can contain spaces, so must be URL-encoded. The full list, which contains 251 tests, is:

• 1.5+mile+route,+Charing+Cross+to+Westcheap+Cross,+(segments=0)
• 15+mile+route,+Charing+Cross+to+Waltham+Cross
• 150+mile+route,+Charing+Cross+to+Lincoln+Cross
• 24-minute+Cambridge+leisure+route
• Add+Feedback+v2
• Archived+route+retrieval
• Archived+route+retrieval+v1
• Beehive+Centre+name+inherited+from+open+space
• Best+leisure+from+previous+itinerary
• Best+leisure+from+previous+itinerary+v2
• Bingley+NCN696+stickiness
• Brent+Cross
• Bristol+Avon+Riverside+Saint+Phillips+Greenway+Marsh
• Cambridge+Highsett+Private+Intermittent
• Cambridge+Lovers+Lane+intermittent
• Cambridge+York+Street+partial+percentage+test
• Cambridge+central+PHP+engine
• Cambridge+central+PHP+engine+no+turns+and+no+cello+so+universally+available
• Cambridge+grid
• Cambridge+journey+three+waypoints
• Cambridge+leisure+route+v2
• Cambridge+really+short+journey+3+plans
• Cambridge+very+old+(start-finish)_(longitude-latitude)+params
• Cambridge+very+old+params+geojson
• Cambridge,+Honey+Hill+fifth+leg+balanceder+check
• Cambridge,+plan=shortest+v1
• Cambridge,+two+point+journey,+gml+(useDom=1)
• Cambridge,+two+point+journey,+marker+format+(useDom=0)
• Change+plan+type+in+V1
• Change+plan+type+in+V2+is+prohibited
• Collisions+bbox+locations
• Collisions+boundary+locations
• Collisions+single+location
• Confirm+no+leisure+route+for+existing+AtoB+itinerary
• Country+-+Australia+-+Corowa
• Country+-+Australia+-+Sydney
• Country+-+British+Isles+-+Dublin
• Country+-+California+-+LA
• Country+-+Canada+-+Vancouver
• Country+-+Czech+Republic+-+Prague
• Country+-+Denmark+-+Copenhagen
• Country+-+Nepal+-+Kathmandu
• Country+-+Pennsylvania+-+Philadelphia
• Country+-+Switzerland+-+Bern
• Coverage+-+RU+-+Moscow
• Coverage+-+UK+-+Cambridge
• Dartford+crossing
• Deepcut+Bridge+Roundabout+second+exit
• Disneyland,+Los+Angeles+is+the+resort+in+Anaheim
• Eleanor's+Cross+route,+marker+json
• Elevation+auto+generated+test:+australia_canberra
• Elevation+auto+generated+test:+australia_corowa
• Elevation+auto+generated+test:+belgium
• Elevation+auto+generated+test:+bratislava
• Elevation+auto+generated+test:+brazil
• Elevation+auto+generated+test:+cambridge
• Elevation+auto+generated+test:+coverage-au-melbourne
• Elevation+auto+generated+test:+coverage-au-sydney
• Elevation+auto+generated+test:+coverage-be-brussels
• Elevation+auto+generated+test:+coverage-br-rio
• Elevation+auto+generated+test:+coverage-br-saopaulo
• Elevation+auto+generated+test:+coverage-ca-edmonton
• Elevation+auto+generated+test:+coverage-ca-montreal
• Elevation+auto+generated+test:+coverage-ca-ottawa
• Elevation+auto+generated+test:+coverage-ca-toronto
• Elevation+auto+generated+test:+coverage-ca-vancouver
• Elevation+auto+generated+test:+coverage-ch-geneva
• Elevation+auto+generated+test:+coverage-ch-zurich
• Elevation+auto+generated+test:+coverage-cl-santiago
• Elevation+auto+generated+test:+coverage-cz-prague
• Elevation+auto+generated+test:+coverage-de-berlin
• Elevation+auto+generated+test:+coverage-de-hamburg
• Elevation+auto+generated+test:+coverage-de-munich
• Elevation+auto+generated+test:+coverage-de-rhineruhr
• Elevation+auto+generated+test:+coverage-de-stuttgart
• Elevation+auto+generated+test:+coverage-dk-copenhagen
• Elevation+auto+generated+test:+coverage-ee-tallinn
• Elevation+auto+generated+test:+coverage-es-barcelona
• Elevation+auto+generated+test:+coverage-es-madrid
• Elevation+auto+generated+test:+coverage-fi-helsinki
• Elevation+auto+generated+test:+coverage-fr-bordeaux
• Elevation+auto+generated+test:+coverage-fr-grenoble
• Elevation+auto+generated+test:+coverage-fr-lyon
• Elevation+auto+generated+test:+coverage-fr-marseille
• Elevation+auto+generated+test:+coverage-fr-nantes
• Elevation+auto+generated+test:+coverage-fr-nice
• Elevation+auto+generated+test:+coverage-fr-paris
• Elevation+auto+generated+test:+coverage-fr-rennes
• Elevation+auto+generated+test:+coverage-fr-strasbourg
• Elevation+auto+generated+test:+coverage-fr-toulouse
• Elevation+auto+generated+test:+coverage-hk-hongkong
• Elevation+auto+generated+test:+coverage-hu-budapest
• Elevation+auto+generated+test:+coverage-ie-dublin
• Elevation+auto+generated+test:+coverage-is-iceland
• Elevation+auto+generated+test:+coverage-it-bologna
• Elevation+auto+generated+test:+coverage-it-florence
• Elevation+auto+generated+test:+coverage-it-milan
• Elevation+auto+generated+test:+coverage-it-naples
• Elevation+auto+generated+test:+coverage-it-palermo
• Elevation+auto+generated+test:+coverage-it-rome
• Elevation+auto+generated+test:+coverage-it-turin
• Elevation+auto+generated+test:+coverage-it-venice
• Elevation+auto+generated+test:+coverage-jp-tokyo
• Elevation+auto+generated+test:+coverage-kr-seoul
• Elevation+auto+generated+test:+coverage-mx-df
• Elevation+auto+generated+test:+coverage-my-kl
• Elevation+auto+generated+test:+coverage-nl-randstad
• Elevation+auto+generated+test:+coverage-no-oslo
• Elevation+auto+generated+test:+coverage-ph-manila
• Elevation+auto+generated+test:+coverage-pt-lisbon
• Elevation+auto+generated+test:+coverage-ru-moscow
• Elevation+auto+generated+test:+coverage-ru-stpetersburg
• Elevation+auto+generated+test:+coverage-se-stockholm
• Elevation+auto+generated+test:+coverage-sg-singapore
• Elevation+auto+generated+test:+coverage-tr-istanbul
• Elevation+auto+generated+test:+coverage-tw-taipei
• Elevation+auto+generated+test:+coverage-uk-birmingham
• Elevation+auto+generated+test:+coverage-uk-edinburgh
• Elevation+auto+generated+test:+coverage-uk-glasgow
• Elevation+auto+generated+test:+coverage-uk-leeds
• Elevation+auto+generated+test:+coverage-uk-liverpool
• Elevation+auto+generated+test:+coverage-uk-london
• Elevation+auto+generated+test:+coverage-uk-manchester
• Elevation+auto+generated+test:+coverage-uk-newcastle
• Elevation+auto+generated+test:+coverage-uk-oxford
• Elevation+auto+generated+test:+coverage-us-atlanta
• Elevation+auto+generated+test:+coverage-us-boston
• Elevation+auto+generated+test:+coverage-us-chicago
• Elevation+auto+generated+test:+coverage-us-dc
• Elevation+auto+generated+test:+coverage-us-denver
• Elevation+auto+generated+test:+coverage-us-houston
• Elevation+auto+generated+test:+coverage-us-la
• Elevation+auto+generated+test:+coverage-us-miami
• Elevation+auto+generated+test:+coverage-us-nyc
• Elevation+auto+generated+test:+coverage-us-philadelphia
• Elevation+auto+generated+test:+coverage-us-portland
• Elevation+auto+generated+test:+coverage-us-sandiego
• Elevation+auto+generated+test:+coverage-us-seattle
• Elevation+auto+generated+test:+coverage-us-sf
• Elevation+auto+generated+test:+coverage-zz-barbados
• Elevation+auto+generated+test:+croatia
• Elevation+auto+generated+test:+czech-republic
• Elevation+auto+generated+test:+denmark
• Elevation+auto+generated+test:+estonia
• Elevation+auto+generated+test:+france
• Elevation+auto+generated+test:+georgetown_guyana
• Elevation+auto+generated+test:+germany
• Elevation+auto+generated+test:+great-britain
• Elevation+auto+generated+test:+guayaquil_ecuador
• Elevation+auto+generated+test:+guyane_cayenne
• Elevation+auto+generated+test:+helsinki
• Elevation+auto+generated+test:+iceland
• Elevation+auto+generated+test:+ireland-and-northern-ireland
• Elevation+auto+generated+test:+italy
• Elevation+auto+generated+test:+lima_peru
• Elevation+auto+generated+test:+lithuania
• Elevation+auto+generated+test:+luxembourg
• Elevation+auto+generated+test:+medellin
• Elevation+auto+generated+test:+nepal
• Elevation+auto+generated+test:+netherlands
• Elevation+auto+generated+test:+norway
• Elevation+auto+generated+test:+perthWA
• Elevation+auto+generated+test:+quito_ecuador
• Elevation+auto+generated+test:+sacremento
• Elevation+auto+generated+test:+sanluisobispo
• Elevation+auto+generated+test:+seinajoki
• Elevation+auto+generated+test:+suriname_paramaribo
• Elevation+auto+generated+test:+sweden
• Elevation+auto+generated+test:+switzerland
• Elevation+auto+generated+test:+tbilisi
• Elevation+auto+generated+test:+timisoara
• Elevation+coverage
• Elevation+manual+test:+Jersey
• Fallowfield+tram+crossing+chicanes
• Feedback+v1
• Fellows+walk+avoid+gate+bicycle=no
• Footway+is+private
• Footway+near+Regent's+Park+is+private
• GPX+URL
• Galleries+Add+V2
• Galleries+List+V2
• Galleries+Show+V2
• Galleries+Update+V2
• Geocoder+Ely+(station)
• Geocoder+Ely+(station),+using+JSON-P
• Geocoder+check+fail+-+bbox+in+wrong+order
• Geocoder+geojson+Station+Road
• Geocoder+v1+CR4+2AG
• Geocoder+v1+Ely
• Geocoder+v2+CR4+2AG
• Geocoder+with+full+geometries
• Greenwich+Foot+Tunnel
• Greenwich+short+leg
• Impossible+route+check+fail+-+Strand+Underpass+to+Charing+Cross+(oneway+deadend)
• Impossible+route,+Strand+Underpass+to+Charing+Cross+(oneway+deadend)
• Jersey+is+hilly
• Journey+without+archiving
• Mainland+reachable+from+Isle+of+Sheppey
• Map+data+for+network+browsing
• Millharbour+roundabout
• Motorway+roundabout+2nd+exit
• NearestPoint+18th+Street+versus+Mission+Street,+San+Francisco
• NearestPoint+Forth+Bridge
• NearestPoint+Great+St.+Mary's
• NearestPoint+Silver+St+and+Queens+Road+junction+matching+name+Queens
• NearestPoint+Silver+St+and+Queens+Road+junction+matching+name+Sidgwick
• NearestPoint+Strand
• NearestPoint+check+fail+-+not+found
• NearestPoint+gml+(useDom=1)
• NearestPoint+not+found+0,0+gml+(useDom=1)
• Neidpath+Tunnel
• Non+existent+route+retrieval+(useDom=1)
• Oxford+Street,+London+turn+restriction+leg+used+twice
• POI+types
• POI+types+v1
• POIs+CyclePoint+Cambridge
• POIs+cafes+bbox
• POIs+cafes+v1
• POIs+central+Cambridge+cycle+private+parking
• POIs+check+fail+-+invalid+type+xxxcafes
• POIs+pubs+polar+coordinates
• Photo+location
• Photomap+Like
• Photomap+categories
• Photomap+locations
• PhotomapCategories+v1
• Photos+of+bad+cycleparking
• Postcode+in+Belfast
• Postcode+introduced+March+2018
• Postcode+only+five+chars
• Reach+Ride+(multi-point+journey+plannning+test+-+more+than+two+points)
• Recent+route+retrieval
• Retrieve+Cambridge+really+short+journey
• Richmond+Park
• Routing+coverage
• Saddle+Loop+Trail+way+with+many+points
• Self+test+of+the+API+testing
• Specific+leisure8+from+previous+itinerary+(not+displayable+in+gui)
• Status+v2
• Stoke+Biddulph+Way+NCN55+stickiness
• Tapner's+Road+short+journey+no+truncated+legs
• Thames+Cable+Car
• Too+long+a+route,+Hugh+Town+to+Lincoln+Cross
• Treasury+-+bloated+journey.plan+APIv2+example
• Treasury+-+minimal+journey.plan+APIv2+example
• Tyne+Pedestrian+and+Cyclist+Tunnel
• Unusual+chars+and+emojis+😂+in+waypoint+names
• Unusual+chars+😸+in+waypoint+names
• Way+tagged:+oneway=-1+Cambridge+North+roundabout
• Whitehill+Close,+Cambridge+loop
• barrier=gate+with+no+cycle+access

Request parameters - optional

enablecache 0|1, default 0

Whether to enable cacheable results (generally those relating to journey planning) to be read from the cache, if already cached.

comparison 0|1, default 0

Whether to include a detailed report, in HTML, showing the comparison of the test against the received data.

force 0|1

Tests can be set to be skipped by default. Reasons for doing that include that the test takes time to run, that it is work in progress or that the relevant area data is not loaded. This option forces the test to be tried.

Response

JSON object as above, showing the outcome of the test.

Error response

JSON object containing an error key and a text string.

Example error (text string will vary):

{
    "error": "Cannot find named test."
}