• 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

Photomap location

The photomap location API retrieves a single photo of cycling-related infrastructure which has been submitted by a user. The same data is visible on our Photomap.

This call is effectively a single-location version of the photomap.locations call, which retrieves the same data but on an area basis.

Each location has various metadata attached to it, such as a caption, a category (e.g. cycleparking/obstruction/etc.), a metacategory (e.g. good/bad), date/time, location, and more.

You can retrieve arbitrary metadata fields added to a location using additionalMetadata. This could be useful for auditing and similar uses.

Note that each location has a license (e.g. Creative Commons, Public Domain, No reproduction permitted, etc.) as specified by the contributor. You are required to respect the specified license. Also, CycleStreets naturally has a database right in the collective dataset.

Not all locations have a photo attached to them. Such 'placeholders', however, do contain the other metadata.

Example

Example which returns a location in an area of Cambridge, returning the fields specified.

https://api.cyclestreets.net/v2/photomap.location?id=80&fields=id,latitude,longitude,caption,hasPhoto,thumbnailUrl,username,licenseName&thumbnailsize=400

Result:

{
    "type": "FeatureCollection",
    "features": [
        {
            "type": "Feature",
            "properties": {
                "id": 80,
                "caption": "Bicycle outside a house in York Street.",
                "hasPhoto": true,
                "thumbnailUrl": "https://www.cyclestreets.net/location/80/cyclestreets80-size400.jpg",
                "username": "martin",
                "licenseName": "CC Attribution-Share Alike (by-sa)"
            },
            "geometry": {
                "type": "Point",
                "coordinates": [
                    0.141554,
                    52.205318
                ]
            }
        }
    ]
}

Request parameters - required

id int

The location ID.

Request parameters - optional

It is strongly recommended to specify a fields list, so that clients receive exactly the data they need.

fields string, comma-separated list of fields from the list below,
  default id,latitude,longitude,caption,hasPhoto,thumbnailUrl,username,licenseName

Controls what information is returned for each location. It is strongly recommended to send this, so that clients receive exactly the data they need.

Available fields are listed below.

If fields is not supplied, the default is used, which represents a sensible and useful set of fields.

The fields id,latitude,longitude,caption are always returned.

When the data is returned in the geojson format, the values for latitude,longitude appear only in the /geometry/coordinates field rather than being duplicated in the properties list.

Fields are returned in the ordering specified by the caller, which can be useful when using format=csv.

Unrecognised fieldnames are simply ignored rather than an error being thrown.

thumbnailsize int 60|120|150|180|200|250|300|350|400|425|450|500|640|800|1000|1200|1500|1800|2000 (default 425)

The thumbnail size used in the thumbnail URLs shown within the data. At present, only the stated sizes are supported; however we plan to remove this limitation shortly; for now, if you require another size, please let us know and we will add it as a supported size. If an unsupported size is specified, the default (425) is currently returned.

iconset string cyclestreets|camcycle (default cyclestreets)

Specifies the style of the icons.

iconformat string svg|png|@2x.png (default svg)

Format of icons, if specifying iconProperties/iconLocation/iconUrl in the fields list. For retina displays, use a value containing @2x. (Please note that the camcycle iconset supports only png and the API will respond with an error if a different format is requested.)

format string, default geojson

Sets the output format. Available values are:

• geojson: GeoJSON output (see example) (default)
• flat: Flat-structured JSON. This can be more useful if the data is to be pre-loaded into an editing form, e.g. for submission to photomap.update.

datetime string

If specified, the datetime field (if requested in the fields list) will be converted from unixtime (the default output format) to a formatted version; the available output formats are:

• friendly A friendly format suitable for showing on a webpage, e.g. '6:55pm, 4th October 2013'; this is equivalent to date ('g:ia, jS F Y', $date) in PHP
• friendlydate A friendly date format suitable for showing on a webpage, e.g. '4th October, 2013'; this is equivalent to date ('jS F, Y', $date) in PHP
• sqldatetime SQL DATETIME format (i.e. simplified ISO 8601 format): YYYY-MM-DD HH:MM:SS
• unixtime Unixtime (the default)

Fields available

The additionalMetadata field

https://api.cyclestreets.net/v2/photomap.location?id=62972&fields=id,caption,hasPhoto,additionalMetadata[landtype,capacity],thumbnailUrl,username,licenseName

{
    "type": "FeatureCollection",
    "features": [
        {
            "type": "Feature",
            "properties": {
                "id": 62972,
                "caption": "This is a very busy cycling haven every weekend and so secure parking is needed.",
                "hasPhoto": false,
                "Landtype": "unknown",
                "Capacity": "6",
                "thumbnailUrl": "",
                "username": "martin",
                "licenseName": "Public domain"
            },
            "geometry": {
                "type": "Point",
                "coordinates": [
                    -0.343738,
                    51.403187
                ]
            }
        }
    ]
}

Response

GeoJSON object containing one Point feature:

See example above.

Example using format=flat:

{
    "id": 80,
    "latitude": 52.205318,
    "longitude": 0.141554,
    "caption": "Bicycle outside a house in York Street.",
    "hasPhoto": true,
    "thumbnailUrl": "https://www.cyclestreets.net/location/80/cyclestreets80-size400.jpg",
    "username": "martin",
    "licenseName": "CC Attribution-Share Alike (by-sa)"
}

Error response

JSON object containing an error key and a text string.

Example error (text string will vary):

{
    "error": "Photo #999999999 does not exist."
}