README
Please read the documentation on https://developers.webcams.travel/
This guide describes how to migrate from our old API to the new API on mashape.
- wct.users.get_profile -> /users/list/user={userid}
- wct.users.list_favorite_webcams -> no replacement
- wct.webcams.get_details -> /webcams/list/webcam={webcamid}
- wct.webcams.get_details_multiple -> /webcams/list/webcam={webcamid}[,{webcamid}[, …]]
- wct.webcams.list_comments -> no replacement
- wct.webcams.list_nearby -> /webcams/list/nearby={lat},{lng},{radius}
- wct.webcams.list_by_tag -> no replacement
- wct.webcams.list_by_user -> no replacement
- wct.webcams.list_by_continent -> /webcams/list/continent={continent}
- wct.webcams.list_by_country -> /webcams/list/country={country}
- wct.webcams.list_new -> /webcams/list/orderby=new,desc
- wct.webcams.list_recent -> /webcams/list/orderby=recent,desc
- wct.webcams.list_random -> /webcams/list/orderby=random
- wct.webcams.list_timelapse -> no replacement, all webcams have a timelapse now
- wct.search.webcams -> no replacement
- wct.search.users -> no replacement
- wct.search.tags -> no replacement
- wct.map.bbox -> /webcams/map/{ne_lat},{ne_lng},{sw_lat},{sw_lng},{zoom}
- wct.countries.list -> /webcams/list/?show=countries
/users/list
URL:
/users/list/userid={userid}[,{userid}[,...]]
Examples:
/users/list/userid=3626
/users/list/userid=3635,87362
Returns details of one or more {userid}. Multiple {userid} must be separated by comma. Required: at least one {userid}. The maximum allowed number of {userid} is 25.
/webcams/list
URL:
/webcams/list/{modifier}[/{modifier}[/...]]
Examples:
/webcams/list/nearby=40.11,12.05,5/limit=20
/webcams/list/category=traffic/continent=europe/orderby=popularity/limit=20
/webcams/list/nearby=40.11,12.05,5/category=traffic/exclude=1171032474/orderby=distance/limit=1
Returns a list of webcams according to the applied {modifier}s. Initially, the list contains all webcams. The resulting list of webcams from applying a modifer will be used as input for the following modifier. With every applied modifier, the list of webcams will be narrowed down. Possible values for {modifier} are:
webcam
(list of webcams as initial list)nearby
(list of webcams around a position)bbox
(list of webcams in an area)category
(list of webcams in a category)property
(list of webcams with a certain property)continent
(list of webcams in a continent)country
(list of webcams in a country)region
(list of webcams in a region of a country)exclude
(exclude webcams from a list of webcams)orderby
(order the list of webcams)limit
(slice the list of webcams)
exclude
, orderby
, and limit
are always applied (even if not explicitly given) in this order and always after nearby
, bbox
, category
, property
, continent
, country
, region
, and webcam
have been applied.
If none of nearby
, bbox
, category
, property
, continent
, country
, region
, and webcam
are applied, then all webcams are in the list before applying exclude
, orderby
, and limit
.
Please refer to the description of the various {modifier}s to learn more about their parameter and defaults.
A {modifier} may be applied only once. If a {modifier} is listed multiple times, only one will be applied.
Available {modifer}s are:
nearby
nearby={lat},{lng},{radius}
Example: nearby=40.11,12.05,5
This is a modifier and returns a list of webcams near the given coordinates {lat},{lng} up to the given {radius} in kilometers. Required: {lat}, {lng}, {radius}. The maximum value for {radius} is 250.
bbox
bbox={ne_lat},{ne_lng},{sw_lat},{sw_lng}
Example: bbox=45.900,6.117,40.500,3.624
This is a modifier and returns a list of the webcams in the bounding box given by north-east ({ne_lat},{ne_lng}) and south-west ({sw_lat},{sw_lng}) coordinates. Required: {ne_lat},{ne_lng},{sw_lat},{sw_lng}
category
category={category}[,{category}[,...]]
Example: category=beach
This is a modifier and returns a list of webcams according to the listed categories. Multiple categories must be separated by comma. Required: at least one {category}
property
property={property}[,{property}[,...]]
Example: property=hd
This is a modifier. Returns a list of webcams according to the listed {property}. Multiple {property} must be separated by comma. Required: at least one {property}. Possible values are “editors” (featured from the editors), “hd” (high resolution webcams), and “live” (webcams with a live stream).
continent
continent={continent}[,{continent}[,...]]
Example: continent=EU
This is a modifier and returns a list of webcams according to the listed continents. Multiple continents must be separated by comma. Required: at least one {continent}. Possible values for {continent} are:
- AF (Africa)
- AN (Antarctica)
- AS (Asia)
- EU (Europe)
- NA (North America)
- OC (Oceania)
- SA (South America)
country
country={country}[,{country}[,...]]
Example: country=ES,IT
This is a modifier and returns a list of webcams according to the listed country. Multiple countries must be separated by comma. Required: at least one {country}. Possible values are ISO 3166-1-alpha-2 codes.
region
region={region}[,{region}[,...]]
Example: region=CH.ZH
This is a modifier and returns a list of webcams according to the listed region. Multiple regions must be separated by comma. Required: at least one {region}. Possible values are ISO 3166-1-alpha-2 codes for the country and a region code separated by a dot.
webcam
webcam={webcamid}[,{webcamid}[,...]]
Example: webcam=1361879037,1171032474
Returns details of one or more {webcamid}. Multiple {webcamid} must be separated by comma. Required at least one {webcamid}. The maximum number of allowed {webcamid} is 25.
exclude
exclude={webcamid}[,{webcamid}[,...]]
Example: exclude=1171032474
This is a modifier and exclude the {webcamid}s from the list. Multiple {webcamid} must be separated by comma. Required: at least one {webcamid}
orderby
orderby={sort}[,{order}]
Example: orderby=popularity,desc
This is a modifier and returns the list of webcams sorted by {sort}. The optional sorting direction is given by {order}. Required {sort}. Possible values for {sort} are:
popularity
(default order:desc
)hotness
(default order:desc
)new
(default order:desc
)recent
(default order:desc
)random
(default order:asc
)distance
(default order:asc
) (only available ifnearby
has been applied)
{order} defaults either to “asc” (ascendin)g or “desc” (descending) depending on the selected {sort}.
If orderby
is not given, no ordering is applied.
limit
limit={limit}[,{offset}]
Example: limit=25,50
This is a modifier and returns the list of webcams sliced by {limit}. The optional offset is given by {offset}. Required: {limit}. The maximum value for {limit} is 50. {offset} defaults to 0.
If limit
is not given, then a default of limit=10
is applied.
/webcams/map
URL:
/webcams/map/{ne_lat},{ne_lng},{sw_lat},{sw_lng},{zoom}
Example:
/webcams/map/45.900,6.117,40.500,3.624,4
Returns a list of webcams optimized for displaying on a map for a given bounding box and {zoom} level. The value for the zoom level is compatible with the Google Maps zoom level.
Required Query Parameter:
appid
The “appid” identifies the registered application that is accessing the API.
Optional Query Parameter
parts
The level of details for the in the responses. Possible values are:
- basic (default)
- location
- image
- …
lang
Localize the results to this language, if available. Default: “en”.
callback
The name of the callback function in which the JSON response should encapulated. This enables JSONP.
Please read the Terms of Use on https://developers.webcams.travel/#terms