Donate using PayPal

CycleStreets API (v2)

  • Details for:
  • 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 376 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
  • Avoid+St.+James+Hospital,+Leeds
  • Beehive+Centre+name+inherited+from+open+space
  • Beehive+Centre+thru+car+storage
  • Best+leisure+from+previous+itinerary
  • Best+leisure+from+previous+itinerary+v2
  • Bingley+NCN696+stickiness
  • Brent+Cross
  • Bristol+Avon+Riverside+Saint+Phillips+Greenway+Marsh
  • Calder+Valley+Greenway+Viaduct
  • Cambridge+Highsett+Private+Intermittent
  • Cambridge+Lovers+Lane+intermittent
  • Cambridge+Scale+Naismith+virtual+leg
  • Cambridge+York+Street+partial+percentage+test
  • Cambridge+central+PHP+engine
  • Cambridge+central+PHP+engine+no+turns+and+no+cello+so+universally+available
  • Cambridge+dismounted+Burleigh+Street
  • 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
  • Clifton+Suspension+Bridge
  • 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
  • Cross+Cambridge+30mins
  • Cycle+across+Cutter+Ferry+Bridge,+Cambridge
  • Dangleway
  • 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:+australia_tasmania
  • Elevation+auto+generated+test:+austria
  • Elevation+auto+generated+test:+belgium
  • Elevation+auto+generated+test:+bogota
  • Elevation+auto+generated+test:+bratislava
  • Elevation+auto+generated+test:+brazil
  • Elevation+auto+generated+test:+cambridge
  • Elevation+auto+generated+test:+coverage-ar-buenosaires
  • Elevation+auto+generated+test:+coverage-at-vienna
  • Elevation+auto+generated+test:+coverage-au-adelaide
  • Elevation+auto+generated+test:+coverage-au-brisbane
  • Elevation+auto+generated+test:+coverage-au-melbourne
  • Elevation+auto+generated+test:+coverage-au-perth
  • Elevation+auto+generated+test:+coverage-au-sydney
  • Elevation+auto+generated+test:+coverage-az-baku
  • Elevation+auto+generated+test:+coverage-be-brussels
  • Elevation+auto+generated+test:+coverage-br-belohorizonte
  • Elevation+auto+generated+test:+coverage-br-curitiba
  • Elevation+auto+generated+test:+coverage-br-fortaleza
  • Elevation+auto+generated+test:+coverage-br-portoalegre
  • Elevation+auto+generated+test:+coverage-br-rio
  • Elevation+auto+generated+test:+coverage-br-saopaulo
  • Elevation+auto+generated+test:+coverage-ca-calgary
  • 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-ch
  • 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-de
  • Elevation+auto+generated+test:+coverage-de-hamburg
  • Elevation+auto+generated+test:+coverage-de-lowersaxony
  • Elevation+auto+generated+test:+coverage-de-munich
  • Elevation+auto+generated+test:+coverage-de-rhineneckar
  • Elevation+auto+generated+test:+coverage-de-rhineruhr
  • Elevation+auto+generated+test:+coverage-de-stuttgart
  • Elevation+auto+generated+test:+coverage-de-ulm
  • Elevation+auto+generated+test:+coverage-dk-copenhagen
  • Elevation+auto+generated+test:+coverage-dk-dk
  • Elevation+auto+generated+test:+coverage-ee-ee
  • Elevation+auto+generated+test:+coverage-ee-tallinn
  • Elevation+auto+generated+test:+coverage-es-barcelona
  • Elevation+auto+generated+test:+coverage-es-basquecountry
  • Elevation+auto+generated+test:+coverage-es-madrid
  • Elevation+auto+generated+test:+coverage-es-seville
  • Elevation+auto+generated+test:+coverage-fi-fi
  • Elevation+auto+generated+test:+coverage-fi-helsinki
  • Elevation+auto+generated+test:+coverage-fr-angers
  • Elevation+auto+generated+test:+coverage-fr-bordeaux
  • Elevation+auto+generated+test:+coverage-fr-brest
  • Elevation+auto+generated+test:+coverage-fr-dax
  • Elevation+auto+generated+test:+coverage-fr-fr
  • Elevation+auto+generated+test:+coverage-fr-grenoble
  • Elevation+auto+generated+test:+coverage-fr-larochesuryon
  • Elevation+auto+generated+test:+coverage-fr-lille
  • Elevation+auto+generated+test:+coverage-fr-lyon
  • Elevation+auto+generated+test:+coverage-fr-marseille
  • Elevation+auto+generated+test:+coverage-fr-metz
  • Elevation+auto+generated+test:+coverage-fr-nancy
  • 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-royan
  • 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-hu-szeged
  • Elevation+auto+generated+test:+coverage-ie-dublin
  • Elevation+auto+generated+test:+coverage-ie-ie
  • Elevation+auto+generated+test:+coverage-in-bangalore
  • Elevation+auto+generated+test:+coverage-in-mumbai
  • Elevation+auto+generated+test:+coverage-in-pune
  • Elevation+auto+generated+test:+coverage-is-iceland
  • Elevation+auto+generated+test:+coverage-it-bari
  • Elevation+auto+generated+test:+coverage-it-bologna
  • Elevation+auto+generated+test:+coverage-it-cagliari
  • Elevation+auto+generated+test:+coverage-it-florence
  • Elevation+auto+generated+test:+coverage-it-lecce
  • Elevation+auto+generated+test:+coverage-it-marche
  • Elevation+auto+generated+test:+coverage-it-matera
  • 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-trento
  • 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-lt-kaunas
  • Elevation+auto+generated+test:+coverage-lt-klaipeda
  • Elevation+auto+generated+test:+coverage-lt-vilnius
  • Elevation+auto+generated+test:+coverage-lu-luxembourg
  • Elevation+auto+generated+test:+coverage-lv-riga
  • 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-nz-auckland
  • Elevation+auto+generated+test:+coverage-ph-manila
  • Elevation+auto+generated+test:+coverage-pl-krakow
  • Elevation+auto+generated+test:+coverage-pl-szczecin
  • Elevation+auto+generated+test:+coverage-pl-wroclaw
  • 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-se
  • 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-aberdeen
  • Elevation+auto+generated+test:+coverage-uk-birmingham
  • Elevation+auto+generated+test:+coverage-uk-blackpool
  • Elevation+auto+generated+test:+coverage-uk-bristol
  • Elevation+auto+generated+test:+coverage-uk-cardiff
  • 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-uk-sheffield
  • Elevation+auto+generated+test:+coverage-uk-uk
  • Elevation+auto+generated+test:+coverage-uk-wales
  • Elevation+auto+generated+test:+coverage-us-albuquerque
  • Elevation+auto+generated+test:+coverage-us-atlanta
  • Elevation+auto+generated+test:+coverage-us-austin
  • Elevation+auto+generated+test:+coverage-us-boston
  • Elevation+auto+generated+test:+coverage-us-buffalo
  • Elevation+auto+generated+test:+coverage-us-chicago
  • Elevation+auto+generated+test:+coverage-us-cincinnati
  • Elevation+auto+generated+test:+coverage-us-cleveland
  • Elevation+auto+generated+test:+coverage-us-columbus
  • Elevation+auto+generated+test:+coverage-us-dallas
  • Elevation+auto+generated+test:+coverage-us-dc
  • Elevation+auto+generated+test:+coverage-us-denver
  • Elevation+auto+generated+test:+coverage-us-desmoines
  • Elevation+auto+generated+test:+coverage-us-detroit
  • Elevation+auto+generated+test:+coverage-us-honolulu
  • Elevation+auto+generated+test:+coverage-us-houston
  • Elevation+auto+generated+test:+coverage-us-indianapolis
  • Elevation+auto+generated+test:+coverage-us-jacksonville
  • Elevation+auto+generated+test:+coverage-us-kansascity
  • Elevation+auto+generated+test:+coverage-us-la
  • Elevation+auto+generated+test:+coverage-us-lasvegas
  • Elevation+auto+generated+test:+coverage-us-louisville
  • Elevation+auto+generated+test:+coverage-us-miami
  • Elevation+auto+generated+test:+coverage-us-milwaukee
  • Elevation+auto+generated+test:+coverage-us-minneapolis
  • Elevation+auto+generated+test:+coverage-us-nashville
  • Elevation+auto+generated+test:+coverage-us-neworleans
  • Elevation+auto+generated+test:+coverage-us-nyc
  • Elevation+auto+generated+test:+coverage-us-oklahomacity
  • Elevation+auto+generated+test:+coverage-us-orlando
  • Elevation+auto+generated+test:+coverage-us-philadelphia
  • Elevation+auto+generated+test:+coverage-us-phoenix
  • Elevation+auto+generated+test:+coverage-us-pittsburgh
  • Elevation+auto+generated+test:+coverage-us-portland
  • Elevation+auto+generated+test:+coverage-us-raleigh
  • Elevation+auto+generated+test:+coverage-us-sacramento
  • Elevation+auto+generated+test:+coverage-us-saltlakecity
  • Elevation+auto+generated+test:+coverage-us-sanantonio
  • 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-us-stlouis
  • Elevation+auto+generated+test:+coverage-us-tampa
  • Elevation+auto+generated+test:+coverage-us-tucson
  • Elevation+auto+generated+test:+coverage-za-capetown
  • 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:+emirates
  • Elevation+auto+generated+test:+estonia
  • Elevation+auto+generated+test:+fitchburg
  • Elevation+auto+generated+test:+france
  • Elevation+auto+generated+test:+georgetown_guyana
  • Elevation+auto+generated+test:+germany
  • Elevation+auto+generated+test:+ghana
  • 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:+israel-and-palestine
  • Elevation+auto+generated+test:+italy
  • Elevation+auto+generated+test:+latvia
  • 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:+new-caledonia
  • Elevation+auto+generated+test:+new-zealand
  • Elevation+auto+generated+test:+norway
  • Elevation+auto+generated+test:+perthWA
  • Elevation+auto+generated+test:+portugal
  • 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:+slovenia
  • Elevation+auto+generated+test:+spain
  • 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
  • Hurdle+virtual+Gonville+Place+into+Mill+Road,+Cambridge
  • Hurdles+survive+collation
  • 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
  • KML+URL
  • Kennington,+No+U+turn
  • Mainland+reachable+from+Isle+of+Sheppey
  • Map+data+for+network+browsing
  • Milestone+Green,+East+Sheen
  • 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+Statistics
  • Photomap+categories
  • Photomap+locations+in+Cambridge
  • Photomap+locations+selectedId
  • PhotomapCategories+v1
  • Photos+of+bad+cycleparking
  • Photos+of+good+and+bad,+cycleparking+and+car+storage
  • 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
  • Regent's+Canal+avoid+towpath+on+fastest
  • Retrieve+Cambridge+really+short+journey
  • Richmond+Park
  • Route+thru+Chemistry+between+nodes+delimiting+private+way
  • Routing+coverage
  • Routing+debug+v2
  • Saddle+Loop+Trail+way+with+many+points
  • Self+test+of+the+API+testing
  • Shire+Hall+thru+car+storage
  • Specific+leisure8+from+previous+itinerary+(not+displayable+in+gui)
  • Status+v2
  • Stoke+Biddulph+Way+NCN55+stickiness
  • Stourbridge+Common+to+Ditton+Meadows+jetty+closed
  • Tapner's+Road+short+journey+no+truncated+legs
  • Thakeham+to+Warminghurst
  • 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
  • Way+tagged:+oneway=-1+Coldham's+Lane+Sainsbury's
  • Whitehill+Close,+Cambridge+loop
  • WightLink:+ferry+between+Fairbourne+Isle+of+Wight+to+Gosport
  • barrier=gate+with+no+cycle+access
  • isochrones.show

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."
}

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/apitesting.runtest/
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.