• 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

Infrastructure location

This call retrieves a single location from an infrastructure dataset.

Data returned is licensed as per the respective owners.

Example

Example which retrieves an infrastructure location record.

https://api.cyclestreets.net/v2/infrastructure.location?dataset=tflcid&id=ABC123

Result:

{
    "type": "FeatureCollection",
    "features": [
        {
            "type": "Feature",
            "properties": {
		"_type": "cycle_parking",
                "type": "sheffield",
                "capacity": 2,
                "osm_id": 476102903,
                "images": [],
                "iconUrl": "https://www.example.com/images/icons/point.svg"
            },
            "geometry": {
                "type": "Point",
                "coordinates": [
                    -0.118422,
                    51.509905
                ]
            }
        }
    ]
}

Example which retrieves an infrastructure location record, with all versions (revisions). Note that each feature has an id field added, representing the version (revision) metadata.

https://api.cyclestreets.net/v2/infrastructure.location?dataset=tflcid&id=ABC123&versions=true

Result:

{
    "type": "FeatureCollection",
    "features": [
        {
            "type": "Feature",
            "id": {
                "version": 1,
                "surveydate": "2017-06-26",
                "status": "initial"
            },
            "properties": {
		"_type": "cycle_parking",
                "type": "sheffield",
                "capacity": 2,
                "osm_id": 476102903,
                "images": [],
                "iconUrl": "https://www.example.com/images/icons/point.svg"
            },
            "geometry": {
                "type": "Point",
                "coordinates": [
                    -0.118422,
                    51.509905
                ]
            }
        },
        {
            "type": "Feature",
            "id": {
                "version": 2,
                "surveydate": "2019-05-28",
                "status": "changed"
            },
            "properties": {
		"_type": "cycle_parking",
                "type": "sheffield",
                "capacity": 10,
		"covered": "yes",
                "osm_id": 476102903,
                "images": [],
                "iconUrl": "https://www.example.com/images/icons/point.svg"
            },
            "geometry": {
                "type": "Point",
                "coordinates": [
                    -0.118422,
                    51.509905
                ]
            }
        }
    ]
}

Request parameters - required

dataset string

Dataset name.

Currently-supported public values are: tflcid.

id string

ID of a location record.

Request parameters - optional

latest 1|0, default 0

Whether to obtain the latest revision (arising from crowdsourced updates) of the location, rather than the original published data. This will also add an additional key 'status' into the result data. This cannot be used when the versions parameter is enabled.

versions string true|false

Whether to retrieve all versions (revisions) of a location, e.g. as created using infrastructure.update. This cannot be used when the latest parameter is enabled.

Response

JSON structure as per example above.

Error response

JSON object containing an error key and a text string.

Example error (text string may vary):

{
    "error": "There is no such record."
}