Signal K
    Preparing search index...

    Weather API

    The Signal K server Weather API provides a common set of operations for viewing information from weather data sources via a "provider plugin". The provider plugin facilitates the interaction with the weather service and transforms the data into the Signal K data schema.

    Requests to the Weather API are made to HTTP REST endpoints rooted at /signalk/v2/api/weather.

    Weather API requests require that a postion be supplied which determines the location from which the weather data is sourced.

    The following weather data sets are supported:

    • Observations
    • Forecasts
    • Warnings

    Following are examples of the types of requests that can be made.

    Note

    The data available is dependent on the weather service API and provider-plugin.

    Example 1: Return the latest observation data for the provided location

    GET "/signalk/v2/api/weather/observations?lat=5.432&lon=7.334"

    Example 2: Return the last 5 observations for the provided location

    GET "/signalk/v2/api/weather/observations?lat=5.432&lon=7.334&count=5"

    Example 3: Return the daily forecast for the next seven days for the provided location

    GET "/signalk/v2/api/weather/forecasts/daily?lat=5.432&lon=7.334&count=7"

    Example 4: Return point forecasts for the next 12 periods (service provider dependant) for the provided location

    GET "/signalk/v2/api/weather/forecasts/point?lat=5.432&lon=7.334&count=12"

    Example 5: Return current warnings for the provided location

    GET "/signalk/v2/api/weather/warnings?lat=5.432&lon=7.334"

    The Weather API supports the registration of multiple weather provider plugins.

    The first plugin registered is set as the default provider and all requests will be directed to it.

    Requests can be directed to a specific provider by using the provider parameter in the request with the id of the provider plugin.

    Example:

    GET "/signalk/v2/api/weather/warnings?lat=5.432&lon=7.334?provider=my-weather-plugin"
    Note

    Any installed weather provider can be set as the default. See Setting the Default provider

    To retrieve a list of installed weather provider plugins, submit an HTTP GET request to /signalk/v2/api/weather/_providers.

    The response will be an object containing all the registered weather providers, keyed by their identifier, detailing the service name and whether it is assigned as the default.

    HTTP GET "/signalk/v2/api/weather/_providers"

    Example: List of registered weather providers showing that open-meteo is assigned as the default.

    {
      "open-meteo": {
        "provider":"OpenMeteo",
        "isDefault": true
      },
      "openweather": {
        "provider":"OpenWeather",
        "isDefault": false
      }
    }

    To get the id of the default provider, submit an HTTP GET request to /signalk/v2/api/weather/_providers/_default.

    Example:

    HTTP GET "//signalk/v2/api/weather/_providers"

    Response:

    {
      "id":"open-meteo"
    }

    To set / change the weather provider that requests will be directed, submit an HTTP POST request to /signalk/v2/api/weather/_providers/_default/{id} where {id} is the identifier of the weather provider to use as the default.

    Example:

    HTTP POST "/signalk/v2/api/weather/_providers/_default/openweather"

    On This Page

    Providers