Capabilities
Capabilities endpoint is used to fetch layer metadata. This metadata is used to perform image queries. Capabilities-response provides layer information such as description, temporal and spatial extents as well as available color schemes.
Images are layers renderable to image formats such as png or svg. The current data property in time element is the index to the most recent available time.
Image products may have additional color schemes which can be optionally specified. Several layers have transparency in the color scheme by default, enabling them to be overlaid directly onto a map. Alternatively, we also offer non-transparent color schemes when only the details of the map – like country borders, roads and city names – are to be placed on top of the weather layer. If an alternative color scheme is available, you can find it in the capabilities endpoint.
Request
- Base URL: https://weatherapi.foreca.net
- URL: https://weatherapi.foreca.net/api/v1/capabilities
- Auth: HTTP bearer
Query parameters
Access token as provided by authorization endpoint
Response
Success
Example response
{
"images": [
{
"id": 2,
"title": "Temperature",
"description": "Global surface temperature",
"formats": [
"image/png"
],
"colorschemes": [
"default"
],
"times": {
"updated": "2022-01-27T00:00:00Z",
"available": [
"2022-01-27T06:00:00Z"
],
"current": 33
},
"analysis": "20240222000000",
"extent": {
"minLat": -90,
"maxLat": 90,
"minLon": -180,
"maxLon": 180,
"minZoom": 2,
"maxZoom": 14
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.