• 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

Points of Interest (POIs) - types

This API call returns the available types of Points of Interest.

You can then use the pois.locations API call to retrieve the actual locations data for an area.

Optionally, you can request an icon for each type to be included. This is returned as a base64-encoded string.

This is an interface to the same data used for the Points of interest pages.

The data will include a Unixtime value indicating the cache validity, e.g.: validuntil: 1284497262 . Clients should cache the data until this time. Currently this is set to 7 days.

Example

This example retrieves the list of POI types, and requests a 32x32 pixel icon to be included for each.

https://api.cyclestreets.net/v2/pois.types?icons=32

Result:

{
    "validuntil": 1407014249,
    "types": {
        "bandbs": {
            "id": "bandbs",
            "name": "B&Bs",
            "total": "265",
            "iconUrl": "https://www.cyclestreets.net/images/pois/iconsets/osm/tourist_archaeological.n.32.png",
            "icon": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAB30lE\nQVQ4ja2SvWtTYRTGf++H997cNCXJTUIrtIKgBWmjpFVRF7cOLi5OToKj4uBQFcFRJwUFF0Fw81+I\nCH7s4qBgrB0MTcCU1oS2yU1yc/M6aEI+WkTwmQ7nec6Pc3hfwePCCoibINKMaNpVhAY2/HDUAsMm\nQjwSPFmtYMiM+tmUzcXDUaQQvPy2Q+Fney9IRWOIjvaXZ12OJizel30ALhyKMu0q3pT84aAUUTk6\nfHkuxkxM82mz1e992GgyF7e4dGRibIkhwLVsHIFgrRaMBQvVNo6SXD8eHwcckIK7J5OU6x1Ku+PD\nPa3vBJR3O9xeSqCl+A1wLcWDsx6ft1osz7rcO+1xazEJwMpigivHJgF4ej7DnaUkWc/iazXg/hkP\nRwtkRCJerfsspGwmLYmrBTMxjecochmHKVeTjigyriJmSZKOYt6zeV3yiSgp5FYzNPlinSCEVmgA\nUAIWUhZrtYB5zyKXsWkEhlZoSDqKZtglX6xTbYVGD9744sv20M1vB54tX2z061NTTr8eAgzq3MEI\nwZ+NIlryrtzYM7cvwO90efixBsCNE/H9Yox9pH/VfwAY/L/H9pExDY0UzzDdqxU/mMilbdHzvm+H\nIdABWK22dS5tq573o94xQBsjnv8CvjGXEYbFUo8AAAAASUVORK5CYII=\n"
        },
        "bikeshops": {
            "id": "bikeshops",
            "name": "Bike shops",
            "total": "3756",
            "iconUrl": "https://www.cyclestreets.net/images/pois/iconsets/osm/shopping_bicycle.n.32.png",
            "icon": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAB/klE\nQVQ4jZWRP2hTURTGf+e+96IviQkhaUKiobTSJEOL0EApttLJwdWhoKA4ODk4VLDo5uBaxUnU6izt\n5Owk1EEoNKVNhgoFKW3aBEraJDfkz3sOwYBGqfnG737fj3vOkZXplUWER4IMMYBc1y0rR70wRWQB\nGKgMICIRx3AeKlx8g5Z7EMSn/ido2iZ2zEaU9L31AaJTUTL3MiTmEj3Pd9FHdjHL6M3RswHH+WPi\n1+LokiaUCRHKhFCmonna5PDbYf/v/jSsCxaCkJhNUPle6fmNUoPIlQjVH9V+gHHeIHU7RXgijOkz\nWX++Tvpumu032wCEJ8LYMZvY1Rjx2Ti6qMm/y9M8bWLMX5p/Ovl40lPOlTlYO8Cf9BMYCSCWEBgJ\nMHxjGKftIKbgjXpZW1ijVW0x/mCcvc97TQVgR232v+yTvJ4EIDGXIDgWJHUrxc7HHXY/7RK8HGRj\naYP0nTTlXBkAw2N0RxBDMG2T3Msclt9i6tkUxa9F9JHmZPcEgHa9jT7S5JfzGOcMLL9Fp9npAgrL\nBWaWZqjsVAiOBdl8tUmr1kIXdW9ZW6+3yD7JUi/V8ca8FD4UAJDV6dUqgk9ZCnvIRpc0TsvpO1c3\n3R23UW7gdlyAau+MTsuhtl/7e/GXXNCH+jdLiRL9j/iZEpG6SYe3KO4L4hmk7LouLu77n9ErqMOs\nMm5wAAAAAElFTkSuQmCC\n"
        },
        "busstops": {
            "id": "busstops",
            "name": "Bus stops",
            "total": "331140",
            "iconUrl": "https://www.cyclestreets.net/images/pois/iconsets/osm/transport_bus_stop.n.32.png",
            "icon": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAABvUlE\nQVQ4jZWQTWsTURSGn3Pno0lmkhG1qZI2tnan3Ug30m4KShH9A4JLCy5cunBVQQRpV0qKuNKFK5eC\nCIIbl0Ep2IISEvxA8aNq2knotJiJMy5Cph2cJvrChXvPfe9z33OEUuUqyBWQQf5HIT8RuSUsVdcI\nyQPkTMXFYzlmixYTB0zyaQ0l8GP7NzXX59mnLe69afLVa3cha0KpuglYWVPx+sIRRmyd0orL4/de\n7MPJ/AALUwdptgJOPPzIu4YPIpuqazg5lCJrKG68XOeL12YyPxBbAPPlOo1WwJliJgLr3c1Rx+DJ\nB49r5XrP1jXpeLuKEow7BlW31Xd2VddnPAkwljOouX5fQM31GcvtAKIWCrZOSpNYvCRlTWHYjp7t\nADSB+6eH+iYAcH8F0V718P2TYoDLz79z/um3Pc3z5Tqzjz7Havruw9lRC88P9wScGsn8NaMY4Nyo\n1TPuTCHNTCEdm0EEuLPaYHhKJ6MrFpbXEwFzxx2Kts71F/VdgJBtBOtBpcmlCYf9KcXi8kYiYPpw\nGsdU3H7ldgphuCUs1W4SBnMgZtHWlKGEt812kAQ4ZOmyzxSpbPid+1Du/gG184EgbPO+EQAAAABJ\nRU5ErkJggg==\n"
        },
    	…
    }
}

Request parameters - required

None.

Request parameters - optional

icons string: 12|16|20|24|32|48|64, default 16

If supplied, an icon property will be included for each type, shown as a base64-encoded string.

iconset string, default osm

Enables a different icon set. Different set names are known to specific API keyholders.

Response

JSON structure as per example above.

Error response

JSON object containing an error key and a text string.

Example error (text string will vary):

{
    "error": "The requested icon size was invalid."
}