Logo

API Documentation

Attribution

Customer shall display in its weather service the Foreca logo. In case displaying the logo is not possible due to technical reasons, the text ”Foreca” shall be displayed in customer’s weather service in connection with the content referring to the source of information. Customer agrees to cease use of the logo and name ”Foreca” in case requested by Foreca, and also to follow Foreca’s reasonable instructions in using the logo, trade name or other trademarks of Foreca.

https://corporate.foreca.com/en/logo

Third Party Attributions

Customer’s application must show attribution as given in API response. For example, the Capabilities endpoint in Weather Map API responds with layer info telling the required attribution text.

Currently the following organisations must be attributed if their data is used:

Radar data: Aemet, BOM, DMI, DWD, EC, FMI, InMet, JMA, KMI, KNMI, MET, Eireann, MeteoSchweiz, MF, Met Office, MET Norway, NWS, Protezione Civile, SMHI, SMN, ZAMG

Satellite data: EUMETSAT


Authorization

Authorization endpoint is used to fetch tokens for API access. Tokens are disposable, and should only be used for a single session. User and password must be kept secret and this request must be performed from a trusted source. Token lifetime in seconds is given in the authorization response.

Token

  • user

    Application key username

  • password

    Application key password

  • expire_hours (optional)

    Expiry time in hours (default 1, maximum 168)

POST
/authorize/token
{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9mbnc2LmZvcmVjYS5jb21cL2F1dGhvcml6ZVwvdG9rZW4iLCJpYXQiOjE1MjYzMDAzODAsImV4cCI6MTUyNjMwMzk4MCwibmJmIjoxNTI2MzAwMzgwLCJqdGkiOiJxSXl3WVlQNjc1NkczejBEIiwic3ViIjoibFFHa1Y4Z2pIeGUyZU1ibndUUUs4NktqVTY3RXJlS2htenY1IiwicHJ2IjoiYWY3YTAzOThkZGNiNWE3YTUzN2Q3YzdkMjU2NWEyZjgxZGM4ZTQxNCJ9.V8xg6L9yrY9__VH-jdrL_CqXisEpgcfdUa0NoxlGz0k",
  "expires_in": 3600,
  "token_type": "bearer"
}

Weather API

Weather API exposes an HTTP interface, providing global weather point forecasts.

Location search

Locations and associated identifiers matching a search query. Can be used as alternatives to coordinates.

  • query

    Search query

  • lang (optional)

    Language (ISO 639-1 codes). Options: de, en, es, fr, it, pl, ru, fi, sv, nl, ko, pt, th, tr, zh, zh_TW (Chinese in Taiwan), zh_CN (Chinese in China). (default en)

GET
/api/v1/location/search/:query
{
  "locations": [
    {
      "id": 102643743,
      "name": "London",
      "country": "United Kingdom",
      "timezone": "Europe/London",
      "lon": -0.125532746,
      "lat": 51.508415222
    },
    {
      "id": 103458449,
      "name": "Londrina",
      "country": "Brazil",
      "timezone": "America/Sao_Paulo",
      "lon": -51.162776947,
      "lat": -23.310277939
    },
    {
      "id": 106058560,
      "name": "London",
      "country": "Canada",
      "timezone": "America/Toronto",
      "lon": -81.233039856,
      "lat": 42.983390808
    }
  ]
}
  • idnumber

    Identifier to be used with weather queries

  • namestring

    Location name eg. London

  • countrystring

    Location country name eg. United Kingdom

  • statestring

    U.S. state abbreviation (if applicable)

  • timezonestring

    Location timezone eg. Europe/London

  • lonnumber

    Location longitude

  • latnumber

    Location latitude


  • Observations

    Observations from a nearby representative weather station.

    • location

      "Longitude,latitude" or location identifier (id) from the location endpoint

    • tz (optional)

      Time zone of returned times (IANA time zone database names)

    • stations (optional)

      Amount of stations (default 3, maximum 6)

    • tempunit (optional)

      Temperature unit: "C", "F" (default "C")

    • windunit (optional)

      Wind unit: "MS" (m/s), "KTS" (knots), "KMH" (km/h), or "MPH" (mph) (default m/s)

    GET
    /api/v1/observation/latest/:location
    {
      "observations": [
        {
          "station": "Espoo Tapiola",
          "distance": "21 km N",
          "time": "2020-03-16T14:30:00+02:00",
          "temperature": 5,
          "feelsLikeTemp": 2,
          "symbol": "d400",
          "windDirString": "NW",
          "windDir": 315,
          "windSpeed": 4,
          "windGust": 6,
          "pressure": 1007.9,
          "relHumidity": 80,
          "visibility": 48992
        },
        {
          "station": "Helsinki Kaisaniemi",
          "distance": "24 km NE",
          "time": "2020-03-16T14:30:00+02:00",
          "temperature": 5,
          "feelsLikeTemp": 2,
          "symbol": "d400",
          "windDirString": "NW",
          "windDir": 336,
          "windSpeed": 4,
          "windGust": 6,
          "pressure": 1007.8,
          "relHumidity": 77,
          "visibility": 50000
        },
        {
          "station": "Helsinki Kumpula",
          "distance": "27 km NE",
          "time": "2020-03-16T14:30:00+02:00",
          "temperature": 5,
          "feelsLikeTemp": 2,
          "symbol": "d400",
          "windDirString": "NW",
          "windDir": 300,
          "windSpeed": 4,
          "windGust": 6,
          "pressure": 1007.8,
          "relHumidity": 79,
          "visibility": 50000
        }
      ]
    }
  • stationstring

    Name of the obsveration station

  • distancestring

    Distance from the location to the station eg. 13 km E

  • timestring

    ISO 8601 date and time for the observation parameters

  • temperaturenumber

    Temperature (°C or requested unit)

  • feelsLikeTempnumber

    Feels like temperature (°C or requested unit)

  • symbolstring

    Weather symbol code

  • windDirStringstring

    Wind direction (N, NE, E, SE, S, SW, W, NW)

  • windDirnumber

    Wind direction in degrees

  • windSpeednumber

    Wind speed (m/s or requested unit)

  • windGustnumber

    Wind gust speed (m/s or requested unit)

  • pressurenumber

    Atmospheric pressure normalized to sea level (hPa)

  • relHumiditynumber

    Relative humidity (%)

  • visibilitynumber

    visibility in meters, e.g. "10000" for 10 km


  • Current

    Current weather estimate.

    • location

      "Longitude,latitude" or location identifier (id) from the location endpoint

    • alt (optional)

      Altitude in meters

    • tempunit (optional)

      Temperature unit

    • windunit (optional)

      Wind unit: "MS" (m/s), "KTS" (knots), "KMH" (km/h), or "MPH" (mph) (default m/s)

    • tz (optional)

      Time zone of returned times (IANA time zone database names)

    GET
    /api/v1/current/:location
    {
      "current": {
        "time": "2020-06-02T04:17-06:00",
        "symbol": "n200",
        "symbolPhrase": "partly cloudy",
        "temperature": 19,
        "feelsLikeTemp": 19,
        "relHumidity": 50,
        "dewPoint": 8,
        "windSpeed": 1,
        "windDirString": "SW",
        "windGust": 4,
        "precipProb": 1,
        "precipRate": 0,
        "cloudiness": 61,
        "thunderProb": 0,
        "uvIndex": 0,
        "pressure": 1011.46,
        "visibility": 33516
      }
    }
  • timestring

    ISO 8601 date and time

  • symbolstring

    Weather symbol code

  • symbolPhrasestring

    Description of weather symbol

  • temperaturenumber

    Temperature (°C or requested unit)

  • feelsLikeTempnumber

    Feels like temperature (°C or requested unit)

  • relHumiditynumber

    Relative humidity (%)

  • dewPointnumber

    Dew point (°C or requested unit)

  • windSpeednumber

    Wind speed (m/s or requested unit)

  • windDirStringstring

    Wind direction (N, NE, E, SE, S, SW, W, NW)

  • windGustnumber

    Wind gust (m/s or requested unit)

  • precipProbnumber

    Probability of precipitation (%)

  • precipRatenumber

    Intensity of precipitation rate (mm/h)

  • cloudinessnumber

    Cloudiness (%)

  • thunderProbnumber

    Probability of thunder nearby (%)

  • uvIndexnumber

    UV index

  • pressurenumber

    Atmospheric pressure normalized to sea level (hPa)

  • visibilitynumber

    Visibility (m)


  • Nowcast

    3-hour forecast in 15-minute time steps. The values represent the conditions at the associated time stamp unless otherwise specified.

    • location

      "Longitude,latitude" or location identifier (id) from the location endpoint

    • periods (optional)

      Number of time steps (default 8, maximum 12)

    • alt (optional)

      Altitude in meters

    • tempunit (optional)

      Temperature unit: "C", "F" (default "C")

    • windunit (optional)

      Wind unit: "MS" (m/s), "KTS" (knots), "KMH" (km/h), or "MPH" (mph) (default m/s)

    • tz (optional)

      Time zone of returned times (IANA time zone database names)

    • dataset (optional)

      Variable set: "standard" or "full" (default "standard")

    GET
    /api/v1/forecast/15minutely/:location
    {
      "forecast": [
        {
          "time": "2020-03-16T16:00+02:00",
          "symbol": "d240",
          "temperature": 29,
          "feelsLikeTemp": 33,
          "windDir": 292,
          "windGust": 8,
          "windSpeed": 1,
          "windDirString": "W",
          "precipProb": 68,
          "precipRate": 0.374569
        },
        {
          "time": "2020-03-16T16:15+02:00",
          "symbol": "d240",
          "temperature": 28,
          "feelsLikeTemp": 32,
          "windDir": 290,
          "windGust": 8,
          "windSpeed": 2,
          "windDirString": "W",
          "precipProb": 74,
          "precipRate": 0.374569
        },
        {
          "time": "2020-03-16T16:30+02:00",
          "symbol": "d240",
          "temperature": 28,
          "feelsLikeTemp": 31,
          "windDir": 289,
          "windGust": 9,
          "windSpeed": 2,
          "windDirString": "W",
          "precipProb": 81,
          "precipRate": 0.374569
        }
      ]
    }
  • timestring

    ISO 8601 date and time

  • symbolstring

    Weather symbol code

  • symbolPhrasestring

    Weather description

  • temperaturenumber

    Temperature (°C)

  • feelsLikeTempnumber

    Feels like temperature (°C)

  • relHumiditynumber

    Relative humidity (%) (dataset=full)

  • windDirnumber

    Wind direction in degrees

  • windGustnumber

    Wind gust speed (m/s or requested unit)

  • windSpeednumber

    Wind speed (m/s or requested unit)

  • windDirStringstring

    Wind direction (N, NE, E, SE, S, SW, W, NW)

  • precipProbnumber

    Probability of precipitation (%)

  • precipRatenumber

    Intensity of precipitation rate (mm/h)

  • cloudinessnumber

    Cloudiness (%)

  • thunderProbnumber

    Thunder probability (%)

  • uvIndexnumber

    Ultraviolet index

  • pressurenumber

    Atmospheric pressure extrapolated to sea level (%)


  • Hourly

    Hourly forecasts. The values represent the conditions at the associated time stamp unless otherwise specified.

    • location

      "Longitude,latitude" or location identifier (id) from the location endpoint

    • periods (optional)

      Number of time steps (default 24, maximum 168)

    • alt (optional)

      Altitude in meters

    • tempunit (optional)

      Temperature unit: "C", "F" (default "C")

    • windunit (optional)

      Wind unit: "MS" (m/s), "KTS" (knots), "KMH" (km/h), or "MPH" (mph) (default m/s)

    • tz (optional)

      Time zone of returned times (IANA time zone database names)

    • dataset (optional)

      Variable set: "standard" or "full" (default "standard")

    GET
    /api/v1/forecast/hourly/:location
    {
      "forecast": [
        {
          "time": "2020-03-16T14:00+01:00",
          "symbol": "d410",
          "temperature": 14,
          "feelsLikeTemp": 14,
          "windSpeed": 4,
          "windGust": 12,
          "windDir": 54,
          "windDirString": "NE",
          "precipProb": 76,
          "precipAccum": 0.04
        },
        {
          "time": "2020-03-16T15:00+01:00",
          "symbol": "d410",
          "temperature": 15,
          "feelsLikeTemp": 15,
          "windSpeed": 4,
          "windGust": 12,
          "windDir": 56,
          "windDirString": "NE",
          "precipProb": 69,
          "precipAccum": 0.04
        },
        {
          "time": "2020-03-16T16:00+01:00",
          "symbol": "d410",
          "temperature": 15,
          "feelsLikeTemp": 15,
          "windSpeed": 4,
          "windGust": 13,
          "windDir": 59,
          "windDirString": "NE",
          "precipProb": 62,
          "precipAccum": 0.07
        }
      ]
    }
  • timestring

    ISO 8601 date and time

  • symbolstring

    Weather symbol code

  • symbolPhrasestring

    Description of weather (dataset=full)

  • temperaturenumber

    Temperature (°C or requested unit)

  • feelsLikeTempnumber

    Feels like temperature (°C or requested unit)

  • relHumiditynumber

    Relative humidity (%) (dataset=full)

  • dewPointnumber

    Dew point (°C or requested unit) (dataset=full)

  • windSpeednumber

    Wind speed (m/s or requested unit)

  • windGustnumber

    Wind gust speed (m/s or requested unit)

  • windDirnumber

    Wind direction in degrees

  • windDirStringstring

    Wind direction (N, NE, E, SE, S, SW, W, NW)

  • precipProbnumber

    Probability of precipitation (%)

  • precipAccumnumber

    Accumulated precipitation (mm)

  • cloudinessnumber

    Cloudiness (%) (dataset=full)

  • thunderProbnumber

    Thunder probability (%) (dataset=full)

  • uvIndexnumber

    Ultraviolet index (dataset=full)

  • pressurestring

    Pressure (hPa) (dataset=full)

  • visibilitynumber

    Visibility (m) (dataset=full)


  • Daily

    Daily forecasts.

    • location

      "Longitude,latitude" or location identifier (id) from the location endpoint

    • periods (optional)

      Number of time steps (default 7, maximum 14)

    • alt (optional)

      Altitude in meters

    • tempunit (optional)

      Temperature unit: "C", "F" (default "C")

    • windunit (optional)

      Wind unit: "MS" (m/s), "KTS" (knots), "KMH" (km/h), or "MPH" (mph) (default m/s)

    • dataset (optional)

      Variable set: "standard" or "full" (default "standard")

    GET
    /api/v1/forecast/daily/:location
    {
      "forecast": [
        {
          "date": "2020-03-16",
          "symbol": "d320",
          "maxTemp": 16,
          "minTemp": 12,
          "precipAccum": 12.34,
          "maxWindSpeed": 4,
          "windDir": 51
        },
        {
          "date": "2020-03-17",
          "symbol": "d320",
          "maxTemp": 17,
          "minTemp": 13,
          "precipAccum": 9.54,
          "maxWindSpeed": 5,
          "windDir": 40
        },
        {
          "date": "2020-03-18",
          "symbol": "d000",
          "maxTemp": 19,
          "minTemp": 11,
          "precipAccum": 0.01,
          "maxWindSpeed": 4,
          "windDir": 71
        }
      ]
    }
  • datestring

    ISO 8601 date

  • symbolstring

    Weather symbol code

  • symbolPhrasestring

    Description of weather during the day (dataset=full)

  • maxTempnumber

    24h maximum temperature (°C)

  • minTempnumber

    24h minimum temperature (°C)

  • maxFeelsLikeTempnumber

    24h maximum feels-like temperature (°C) (dataset=full)

  • minFeelsLikeTempnumber

    24h minimum feels-like temperature (°C) (dataset=full)

  • maxRelHumiditynumber

    24h maximum relative humidity (°C) (dataset=full)

  • minRelHumiditynumber

    24h minimum relative humidity (°C) (dataset=full)

  • maxDewPointnumber

    maximum dew point (°C) (dataset=full)

  • minDewPointnumber

    minimum dew point (°C) (dataset=full)

  • precipAccumnumber

    Accumulated precipitation (mm)

  • maxWindSpeednumber

    Maximum wind speed (m/s or requested unit)

  • windDirnumber

    Wind direction at maximum wind speed (degrees)

  • maxWindGustnumber

    Maximum wind gust speed (m/s or requested unit) (dataset=full)

  • precipProbnumber

    Precipitation probability during the day (%) (dataset=full)

  • cloudinessnumber

    Daytime cloudiness average (%) (dataset=full)

  • sunrisestring

    Sunrise time of day in local time (dataset=full)

  • sunsetstring

    Sunset time of day in local time (dataset=full)

  • moonrisestring

    Moonrise time of day in local time (dataset=full)

  • moonsetstring

    Moonset time of day in local time (dataset=full)

  • moonPhasenumber

    Phase of moon at midday (degrees) (dataset=full)

  • uvIndexnumber

    Maximum ultraviolet index (dataset=full)

  • minVisibilitynumber

    Minimum visibility (m) (dataset=full)

  • pressurenumber

    Daytime average sea level pressure (hPa) (dataset=full)


  • Map API

    Weather Map API provides global weather forecast, radar and satellite data as map tiles compatible with commonly used map services such as Open Street Maps or Google Maps. All required and optional parameters are given as path and query parameters respectively. To obtain images one must first request an access token using valid credentials. The access token can then be used to fetch capabilities-response, which contains information on how to fetch images.

    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.

    • token

      Access token as provided by authorization endpoint

    GET
    /api/v1/capabilities
    {
      "images": [
        {
          "title": "Cell simulated precipitation",
          "description": "Precipitation with more intricate convection visualization",
          "formats": [
            "image/png"
          ],
          "colorschemes": [
            "default",
            "csdata-blue"
          ],
          "extent": {
            "minLat": -79.171,
            "maxLat": 79.171,
            "minLon": -180,
            "maxLon": 180,
            "maxZoom": 11,
            "minZoom": 3
          },
          "times": {
            "updated": "2017-01-01T00:00:00Z",
            "available": [
              "2017-09-01T03:00:00Z",
              "2017-09-01T06:00:00Z"
            ],
            "current": 1
          },
          "id": 1
        },
        {
          "title": "Wind symbol",
          "description": "Traditional wind symbol",
          "formats": [
            "image/svg+xml"
          ],
          "colorschemes": [
            "default",
            "data-pt"
          ],
          "extent": {
            "minLat": -79.171,
            "maxLat": 79.171,
            "minLon": -180,
            "maxLon": 180,
            "maxZoom": 11,
            "minZoom": 3
          },
          "times": {
            "updated": "2017-01-01T00:00:00Z",
            "available": [
              "2017-09-18T06:00:00Z",
              "2017-09-18T07:00:00Z"
            ],
            "current": 0
          },
          "id": 2
        }
      ]
    }

    Tile

    Tile endpoint is used to obtain weather map tiles for the given layer and color scheme

    • id

      Layer id

    • x

      X index of the requested tile

    • y

      Y index of the requested tile

    • z

      Zoom level of the requested tile

    • time

      UTC timestamp value for the data to retrieve in ISO 8601 format. Must appear in the available times list

    • token

      Access token as provided by authorization endpoint

    • colorscheme (optional)

      Layer color scheme. Must appear in the color scheme list returned by capabilities endpoint

    GET
    /api/v1/image/tile/:z/:x/:y/:time/:id
    tile_example.png

    Legend

    Legend endpoint is used to obtain legend image for a color scheme

    • colorscheme

      Color scheme id. Must appear in the color scheme list returned by capabilities endpoint

    • id

      Layer id

    • token

      Access token as provided by authorization endpoint

    GET
    /api/v1/legend/:colorscheme/:id
    legend_example.png

    Climate API

    Weather statistics.

    Monthly climate

    Averages in given location for each month. The numbers reflect both day and night conditions.

    • location

      "Longitude,latitude" or location identifier (id) from the location endpoint

    • tempunit (optional)

      Temperature unit: "C", "F" (default "C")

    • windunit (optional)

      Wind unit: "MS" (m/s), "KTS" (knots), "KMH" (km/h), or "MPH" (mph) (default m/s)

    GET
    /api/v1/climate/monthly/:location
    {
      "climate": [
        {
          "month": "01",
          "dayMaxTemp": 0.4,
          "dayMinTemp": -2.15,
          "precipSum": 36.471,
          "dailyPrecip": 1.176,
          "rainDays": 18.75,
          "relHumidity": 89.333,
          "minRelHumidity": 74.5,
          "solarRadiationSum": 185.7,
          "windSpeed": 7.947
        },
        {
          "month": "02",
          "dayMaxTemp": 0.21,
          "dayMinTemp": -2.09,
          "precipSum": 25.253,
          "dailyPrecip": 0.9034,
          "rainDays": 14.4444,
          "relHumidity": 91.33,
          "minRelHumidity": 77.5,
          "solarRadiationSum": 610.2,
          "windSpeed": 7.167
        },
        {
          "month": "03",
          "dayMaxTemp": 2.01,
          "dayMinTemp": -0.46,
          "precipSum": 26.318,
          "dailyPrecip": 0.8489,
          "rainDays": 13.3845,
          "relHumidity": 87.5,
          "minRelHumidity": 70.5,
          "solarRadiationSum": 1609.5,
          "windSpeed": 7.133
        }
      ]
    }
  • monthstring

    Month of year

  • dayMaxTempnumber

    Daily maximum temperature

  • dayMinTempnumber

    Daily minimum temperature

  • precipSumnumber

    Precipitation sum (mm/h)

  • dailyPrecipnumber

    Precipitation accumulation during a day (mm/h)

  • rainDaysnumber

    Number of rain days

  • relHumiditynumber

    Relative humidity (%)

  • minRelHumiditynumber

    Minimum relative humidity (%)

  • solarRadiationSumnumber

    Total daily radiation sum on a horizontal surface (Wh/m²)

  • windSpeednumber

    Wind speed


  • Warning API

    Governmental severe weather warnings are currently delivered from: Australia, Austria, Belgium, Canada, Denmark, Estonia, Finland, France, Germany, Ireland, Italy, Japan, Latvia, Luxembourg, Netherlands, Norway, Poland, Portugal, Spain, Sweden, Switzerland, United Kingdom and United States.

    Point warnings

    • location

      "Longitude,latitude" or location identifier (id) from the location endpoint

    GET
    /api/v1/warning/:location
    {
      "warnings": [
        {
          "type": "FD",
          "significance": "Y",
          "attribution": "FMI",
          "attributionUrl": null,
          "validFrom": "2020-06-23T09:00:00Z",
          "validUntil": "2020-06-24T08:00:00Z",
          "description": [
            {
              "lang": "en",
              "text": "A forest fire warning is in force"
            },
            {
              "lang": "fi",
              "text": "Metsäpalovaroitus on voimassa"
            },
            {
              "lang": "sv",
              "text": "Varning för skogsbrand"
            }
          ],
          "name": "Fire danger",
          "significanceDescription": "Potentially dangerous"
        },
        {
          "type": "TH",
          "significance": "Y",
          "attribution": "FMI",
          "attributionUrl": null,
          "validFrom": "2020-06-23T09:00:00Z",
          "validUntil": "2020-06-23T17:52:50Z",
          "description": [
            {
              "lang": "en",
              "text": "Heat warning: Warm weather is expected during the coming 24 hours in the southern and middle parts of the country, province North Ostrobothnia except in the municipalities of Taivalkoski and Kuusamo and in the municipalities of Simo, Kemi, Keminmaa, Tornio, Ylitornio, Tervola and Pello."
            },
            {
              "lang": "fi",
              "text": "Hellevaroitus: Lähivuorokauden aikana on odotettavissa tukalaa hellettä maan etelä- ja keskiosassa, Pohjois-Pohjanmaan maakunnassa lukuun ottamatta Taivalkosken ja Kuusamon kuntia sekä seuraavissa Lapin kunnissa: Simo, Kemi, Keminmaa, Tornio, Ylitornio, Tervola ja Pello."
            },
            {
              "lang": "sv",
              "text": "Varning för värmebölja: Under det närmaste dygnet är det svåra hettan att vänta i landets södra och mellersta delar, landskapet Norra Österbotten frånsett kommunerna Taivalkoski och Kuusamo och i följande kommuner i Lappland: Simo, Kemi, Keminmaa, Torneå, Övertorneå, Tervola och Pello."
            }
          ],
          "name": "Extremely high temperature",
          "significanceDescription": "Potentially dangerous"
        }
      ]
    }
  • typestring

    Warning ID

  • significancestring

    One of: Y (yellow), O (orange), R (red), P (purple)

  • attributionstring

    Attribution: organization abbreviations

  • attributionUrlstring

    Attribution URL

  • validFromstring

    ISO 8601 date and time

  • validUntilstring

    ISO 8601 date and time

  • langstring

    Language of warning description (ISO 639-1 codes)

  • textstring

    Description of the particular warning in the associated language

  • significanceDescriptionstring

    Description of significance level


  • Warning type names

    Metadata for all warning types.

      GET
      /api/v1/warning/types
      {
        "AQ": {
          "name": "Air quality"
        },
        "AS": {
          "name": "Volcanic ashfall"
        },
        "AV": {
          "name": "Avalanche"
        },
        "CD": {
          "name": "Civil danger"
        },
        "CE": {
          "name": "Coastal event"
        }
      }
    • namestring

      Name of warning type


    • Marine API

      Marine forecasts of waves and sea temperatures.

      Hourly

      Hourly marine forecasts.

      • location

        "Longitude,latitude" or location identifier (id) from the location endpoint

      • periods (optional)

        Number of time steps (default 24, maximum 168)

      • tempunit (optional)

        Temperature unit: "C", "F" (default "C")

      • tz (optional)

        Time zone of returned times (IANA time zone database names)

      GET
      /api/v1/marine/forecast/hourly/:location
      {
        "forecast": [
          {
            "time": "2020-07-03T11:00",
            "sigWaveHeight": 0.95,
            "waveDir": 225,
            "sigSwellHeight": 0.02,
            "seaTemp": 18,
            "swimTemp": 18
          },
          {
            "time": "2020-07-03T12:00",
            "sigWaveHeight": 1.01,
            "waveDir": 225,
            "sigSwellHeight": 0.02,
            "seaTemp": 18,
            "swimTemp": 18
          },
          {
            "time": "2020-07-03T13:00",
            "sigWaveHeight": 1,
            "waveDir": 225,
            "sigSwellHeight": 0.02,
            "seaTemp": 18,
            "swimTemp": 18
          }
        ]
      }
    • timestring

      ISO 8601 date and time

    • sigWaveHeightnumber

      Significant wave height (m)

    • waveDirnumber

      Mean wave direction (degrees)

    • sigSwellHeightnumber

      Significant swell wave height (m)

    • seaTempnumber

      Sea temperature

    • swimTempnumber

      Sea temperature in swimming locations


    • Daily

      Daily marine forecasts.

      • location

        "Longitude,latitude" or location identifier (id) from the location endpoint

      • periods (optional)

        Number of time steps (default 24, maximum 168)

      • tempunit (optional)

        Temperature unit: "C", "F" (default "C")

      GET
      /api/v1/marine/forecast/daily/:location
      {
        "forecast": [
          {
            "date": "2020-07-03",
            "maxSigWaveHeight": 1.01,
            "maxSwellHeight": 0.05,
            "maxSeaTemp": 19,
            "maxSwimTemp": 18
          },
          {
            "date": "2020-07-04",
            "maxSigWaveHeight": 1.18,
            "maxSwellHeight": 0.18,
            "maxSeaTemp": 18,
            "maxSwimTemp": 17
          },
          {
            "date": "2020-07-05",
            "maxSigWaveHeight": 0.99,
            "maxSwellHeight": 0.99,
            "maxSeaTemp": 18,
            "maxSwimTemp": 18
          }
        ]
      }
    • datestring

      ISO 8601 date

    • maxSigWaveHeightnumber

      Maximum significant wave height (m)

    • maxSwellHeightnumber

      Maximum swell wave height (m)

    • maxSeaTempnumber

      Maximum sea temperature

    • maxSwimTempnumber

      Maximum sea temperature in swimming locations


    • Usage API

      Monitor your API usage.

      Month's usage

      Given month's hit sums by API

      • month

        Month (e.g. "2020-03")

      • user

        Username

      • password

        Administrative password

      GET
      /usage/month/:month
      {
        "apis": [
          {
            "name": "Weather API",
            "hits": 3252
          },
          {
            "name": "Map API",
            "hits": 2
          },
          {
            "name": "Administrative",
            "hits": 136
          }
        ],
        "hits": 3390
      }

      Day's usage

      Given day's hit sums by API

      • day

        Day (e.g. "2020-03-15")

      • user

        Username

      • password

        Administrative password

      GET
      /usage/day/:day
      {
        "apis": [
          {
            "name": "Weather API",
            "hits": 156
          },
          {
            "name": "Map API",
            "hits": 2
          },
          {
            "name": "Administrative",
            "hits": 0
          }
        ],
        "hits": 158
      }