Webcams API

Reference

• Response
• Query Parameter

• /list
• /list/bbox
• /list/category
• /list/continent
• /list/country
• /list/nearby
• /list/property
• /list/region
• /list/webcam
• /list/exclude
• /list/orderby
• /list/limit
• /map

• Examples

Response

The response of the API is always in JSON.

First, an example of a summarized response of the API. After this follows a breakdown of the different elements of the response.

{
  "status": "OK",
  "result": {
    "offset": 0,
    "limit": 10,
    "total": 1,
    "webcams": [ ... ],
    "categories": [ ... ],
    "properties": [ ... ],
    "continents": [ ... ],
    "countries": [ ... ],
    "regions": [ ... ]
  }
}

Breakdown of the different elements in a response:

{
  "status": "OK",
  "result": <result object>
}

{
  "offset": 0,
  "limit": 10,
  "total": 1,
  "webcams": [ <webcam object>... ],
  "categories": [ <category object>... ],
  "properties": [ <property object>... ],
  "continents": [ <continent object>... ],
  "countries": [ <country object>... ],
  "regions": [ <region object>... ]
}

{
  "id": "1171032474",
  "status": "active",
  "title": "Zurich › North: Best Carwash − Hardbrücke − Jumbo compact Zürich − Hard One − Abaton − KV Zürich Business School − Escher Wyss",
  "category": <webcam.category object>,
  "image": <webcam.image object>,
  "location": <webcam.location object>,
  "map": <webcam.map object>,
  "player": <webcam.player object>,
  "property": <webcam.property object>,
  "statistics": <webcam.statistics object>,
  "url": <webcam.url object>,
  "user": <webcam.user object>
}

[
  <category object>,
  ...
]

{
  "current": {
    "icon": "https://images.webcams.travel/icon/1171032474.jpg",
    "thumbnail": "https://images.webcams.travel/thumbnail/1171032474.jpg",
    "preview": "https://images.webcams.travel/preview/1171032474.jpg"
  },
  "daylight": {
    "icon": "https://images.webcams.travel/daylight/icon/1171032474.jpg",
    "thumbnail": "https://images.webcams.travel/daylight/thumbnail/1171032474.jpg",
    "preview": "https://images.webcams.travel/daylight/preview/1171032474.jpg"
  },
  "sizes": {
    "icon": {
      "width": 48,
      "height": 48
    },
    "thumbnail": {
      "width": 200,
      "height": 112
    },
    "preview": {
      "width": 400,
      "height": 224
    }
  },
  "update": 1460123709
}

{
  "city": "Zurich",
  "region": "Zurich",
  "region_code": "CH.ZH",
  "country": "Switzerland",
  "country_code": "CH",
  "continent": "Europe",
  "continent_code": "EU",
  "latitude": 47.36667,
  "longitude": 8.55,
  "timezone": "Europe/Zurich",
  "wikipedia": "https://en.wikipedia.org/wiki/Z%C3%BCrich"
}

{
  "clustersize": 127
}

{
  "live": {
    "available": true,
    "embed": "https://api.lookr.com/embed/player/1485691420/live"
  },
  "day": {
    "available": true,
    "link": "https://www.lookr.com/lookout/1485691420#action-play-day",
    "embed": "https://api.lookr.com/embed/player/1485691420/day"
  },
  "month": {
    "available": true,
    "link": "https://www.lookr.com/lookout/1485691420#action-play-month",
    "embed": "https://api.lookr.com/embed/player/1485691420/month"
  },
  "year": {
    "available": true,
    "link": "https://www.lookr.com/lookout/1485691420#action-play-year",
    "embed": "https://api.lookr.com/embed/player/1485691420/year"
  },
  "lifetime": {
    "available": true,
    "link": "https://www.lookr.com/lookout/1485691420#action-play-lifetime",
    "embed": "https://api.lookr.com/embed/player/1485691420/lifetime"
  }
}

[
  <property object>,
  ...
]

{
  "views": 588150
}

{
  "current": {
    "desktop": "http://www.webcams.travel/webcam/1171032474-Weather-Hardbr%C3%BCcke-Zurich",
    "mobile": "http://m.webcams.travel/webcam/1171032474-Weather-Hardbr%C3%BCcke-Zurich"
  },
  "daylight": {
    "desktop": "http://www.webcams.travel/webcam/1171032474-Weather-Hardbr%C3%BCcke-Zurich/daylight",
    "mobile": "http://m.webcams.travel/webcam/1171032474-Weather-Hardbr%C3%BCcke-Zurich/daylight"
  },
  "edit": "https://lookr.com/edit/1171032474"
}

{
  "id": "3626",
  "name": "ingo",
  "url": "http://www.webcams.travel/user/3626"
}

{
  "id": "building",
  "name": "Building",
  "count": 1
}

{
  "id": "hd",
  "name": "HD",
  "count": 25
}

{
  "id": "EU",
  "name": "Europe",
  "count": 23549
}

{
  "id": "CH",
  "name": "Switzerland",
  "count": 2077
}

{
  "id": "CH.BE",
  "name": "Bern",
  "count": 306
}

Query Parameter

These query parameter can be added to any of the API calls and are all optional.

Example

• /api/webcams/v2/list?show=webcams:image,location;categories&lang=de

  The response will contain the webcam and the category objects. The webcam objects will contain the basic, image, and location parts (show=webcams:image,location;categories). Where available, the results will be in German (lang=de).

/list

Returns a list of webcams according to the applied modifiers.

Syntax

/api/webcams/v2/list/{modifier}[/{modifier}...]

Description

Initially, the list contains all webcams. The resulting list of webcams from applying a modifier will be used as input for the following modifier. With every applied modifier, the list of webcams will be narrowed down.

Parameters

Please refer to the description of the various modifiers to learn more about their usage and defaults. The modifiers are:

Explicit modifiers

Implicit modifiers

Usage

The explicit modifiers are applied in the order as given in the API call. You may apply up to 10 explicit modifiers.

The implicit modifiers are always applied only once in this order and after any given explicit modifier (even if none are given).

If no explicit modifier is given then all available webcams are in the list before applying the implicit modifiers.

Examples

• /api/webcams/v2/list/nearby=40.11,12.05,5/orderby=distance/limit=20

  List the first 20 webcams (limit=20) that are closest to the coordinates (40.11, 12.05) within a radius of 5km (nearby=40.11,12.05,5).

  Use case: In your app, list the webcams that are around the current position of a user.

• /api/webcams/v2/list/category=beach/country=IT/orderby=popularity,desc/limit=20

  List the first 20 webcams (limit=20) that are in the category "beach" (category=beach) and in Italy (country=IT), ordered by their popularity (orderby=popularity).

  Use case: A directory of the most popular beaches in Italy.

• /api/webcams/v2/list/nearby=40.11,12.05,5/category=beach/orderby=distance/limit=1

  List the closest webcam (orderby=distance and limit=1) to the coordinates (40.11, 12.05) within a radius of 5km (nearby=40.11,12.05,5) and that is in the category "beach" (category=beach).

  Use case: Show the webcam of the beach that is closest to the current position of a user of your app.

/list/bbox

Returns the webcams in a bounding box.

Syntax

/api/webcams/v2/list/bbox={ne_lat},{ne_lng},{sw_lat},{sw_lng}

Description

This is a modifier and returns a list of the webcams in the bounding box given by the coordinates of the north-east and south-west corners, i.e. to display webcams in the visible area of a map.

Parameters

Examples

• /api/webcams/v2/list/bbox=45.900,6.117,40.500,3.624

  List the webcams that are in the bounding box with the north-east corner at the coordinates (45.900,6.117) and the south-west corner at the coordinates (40.500,3.624).

  Use case: You have a map on your website an want to list all webcams that are in the visible area of the map (together with some more specific criteria given by one or more of the other modifiers).

/list/category

Returns the webcams in a category.

Syntax

/api/webcams/v2/list/category={category}[,{category}...]

Description

This is a modifier and returns a list of webcams according to the listed categories. Multiple categories must be separated by comma.

Parameters

/list?show=categories

Examples

• /api/webcams/v2/list/category=beach

  List the webcams that are in the category "beach".

  Use case: It is summer and hot and you want to display webcams that show beaches in your weather app.

/list/continent

Returns the webcams on a continent.

Syntax

/api/webcams/v2/list/continent={continent}[,{continent}...]

Description

This is a modifier and returns a list of webcams according to the listed continents. Multiple continents must be separated by comma.

Parameters

/list?show=continents

Examples

• /api/webcams/v2/list/continent=EU

  List the webcams that are in Europe.

  Use case: For your trip planning app you want to show all european traffic webcams (together with the modifier category=beach).

/list/country

Returns the webcams in a country.

Syntax

/api/webcams/v2/list/country={country}[,{country}...]

Description

This is a modifier and returns a list of webcams according to the listed country. Multiple countries must be separated by comma.

Parameters

/list?show=countries

Examples

• /api/webcams/v2/list/country=DE

  List the webcams that are in Germany.

  Use case: Your website focuses on touristic destinations in Germany and thus you want to display matching webcams from only Germany.

/list/nearby

Returns the webcams near a position within a radius.

Syntax

/api/webcams/v2/list/nearby={lat},{lng},{radius}

Description

This is a modifier and returns a list of webcams near a center point up to a radius, i.e. to display the webcams around a user. The webcams can be ordered by their distance from the center point.

Parameters

Examples

• /api/webcams/v2/list/nearby=40.11,12.05,5

  List the webcams that are around the coordinates (40.11,12.05) within the radius of 5km.

  Use case: The coordinates are the current position of someone using your app and you want to display all beaches (together with the modifier category=beach) that are nearby.

/list/property

Returns the webcams with a certain property.

Syntax

/api/webcams/v2/list/property={property}[,{property}...]

Description

This is a modifier and returns a list of webcams according to the listed property. Multiple properties must be separated by comma.

Parameters

Examples

• /api/webcams/v2/list/property=hd

  List the webcams that have the property "hd".

  Use case: Listing only the webcams that have a high resolution image as special content.

/list/region

Returns the webcams in a region of a country.

Syntax

/api/webcams/v2/list/region={region}[,{region}...]

Description

This is a modifier and returns a list of webcams according to the listed region. Multiple regions must be separated by comma.

Parameters

/list?show=regions

Examples

• /api/webcams/v2/list/region=CH.ZH

  List the webcams that are in the canton of Zürich in Switzerland.

  Use case: You run a regional website and want to display the webcams from only this region.

/list/webcam

Returns details of one or more webcams.

Syntax

/api/webcams/v2/list/webcam={webcamid}[,{webcamid}...]

Description

This is a modifier and returns the given webcams. Multiple webcamid must be separated by comma.

Parameters

Examples

• /api/webcams/v2/list/webcam=1361879037,1171032474

  Show the details of the webcams with the IDs 1361879037 and 1171032474.

  Use case: A user of your app bookmarked these webcams and you want to retrieve them for a listing.

/list/exclude

Exclude webcams from the list.

Syntax

/api/webcams/v2/list/exclude={webcamid}[,{webcamid}...]

Description

This is a modifier and excludes the given webcams from the list. Multiple webcamid must be separated by comma. Required at least one webcamid. The maximum number of allowed webcamid is 25.

Parameters

Examples

• /api/webcams/v2/list/exclude=1171032474

  Exclude the webcam with the ID 1171032474 from the results.

  Use case: You are currently displaying the webcam with the ID 1171032474 and want to exclude it from an additional listing of the webcams nearby.

/list/orderby

Sort the webcams.

Syntax

/api/webcams/v2/list/orderby={sort}[,{order}]

Description

This is a modifier and sorts the list of webcams according to a criteria.

Parameters

Defaults

If this modifier is not applied, no explicit ordering will be applied.

Examples

• /api/webcams/v2/list/orderby=popularity,desc

  Sort the webcams by their popularity with the most popular webcam first.

  Use case: For providing a list of the most popular webcams.

/list/limit

Slice the webcams.

Syntax

/api/webcams/v2/list/limit={limit}[,{offset}]

Description

This is a modifier and returns the list of webcams sliced by limit and offset.

Parameters

Defaults

If this modifier is not applied, a limit of 10 webcams will be applied.

Examples

• /api/webcams/v2/list/limit=20,60

  List 20 webcams, starting from 60th webcam in the list.

  Use case: Pagination

/map

Returns a list of webcams optimized for displaying on a map for a given bounding box and zoom level.

Syntax

/api/webcams/v2/map/{ne_lat},{ne_lng},{sw_lat},{sw_lng},{zoom}

Description

For each zoom level, the returned webcams are arranged in such a way that they are nicely distributed and not too close to each other on the map. The zoom level corresponds to the zoom levels from the Google Maps API.

The number of webcams in the result is limited to 150. The selection of the webcams is based on their popularity. Each webcam in the results represents a cluster of webcams. The number of webcams in each cluster is available in the webcams.map object.

Parameters

Examples

• /api/webcams/v2/map/45.900,6.117,40.500,3.624,4

  For the zoom level of 4, show the webcams that are within the bounding box whose north-east corner has the coordinates (45.900,6.117) and whose south-west corner has the coordinates (40.500,3.624).

  Use case: You want to enrich the map that you already have on your website.

Examples

If you just want to jump in, we give you a little walk-through for the API.

Let's list all available webcams:

/api/webcams/v2/list

Woah! That's too much. I'm planning to go to Italy soon, so let's check their webcams by adding the country modifier. A list of all countries can be obtained by calling /api/webcams/v2/list?show=countries.

/api/webcams/v2/list/country=IT

That's still a lot. Can I narrow it down a bit more? What about categories? The show query parameter will help:

/api/webcams/v2/list/country=IT?show=categories

Ahh, very interesting. There are beaches in Italy. Let's check them out by adding the category modifier:

/api/webcams/v2/list/country=IT/category=beach

Cool. However, I want to know which one is the most popular and add the orderby modifier:

/api/webcams/v2/list/country=IT/category=beach/orderby=popularity

We're getting somewhere. I want to see more beaches at once by adding the limit modifier:

/api/webcams/v2/list/country=IT/category=beach/orderby=popularity/limit=20

Good. But I also want to know where these beaches are and how they look like, so I need more information about them. Let's use the show query parameter again:

/api/webcams/v2/list/country=IT/category=beach/orderby=popularity/limit=20?show=webcams:location,image

Very nice! Enough beaches for now. Currently I'm in the swiss mountains and my phone gives me the coordinates 46.54 latitude and 7.98 longitude. What nice places are around me where I could hike to, but not more than 5 kilometer away? Let's check the nearby modifier and some more details with the show query parameter:

/api/webcams/v2/list/nearby=46.54,7.98,5?show=webcams:location,image

Awesome! But hey, everything is in English. If I want ask a local for directions I need to show the details in German. Luckily there's the lang query parameter to change to a different language:

/api/webcams/v2/list/nearby=46.54,7.98,5?show=webcams:location,image&lang=de