No longer able to pull weather forecasts using the HA REST API

[wjdp (Will Pimblett)]

Using the REST API I was able to pull a weather entity state along with the attached forecast. A little while ago (perhaps over the new year) this was removed.

My use case is I have a custom-built dashboard that pulls in state information, including weather over the API.

Here is the weather entity in the UI:

And this is what I get from the API:

{
  "entity_id": "weather.met_office_xxx_daily",
  "state": "partlycloudy",
  "attributes": {
    "temperature": 14,
    "temperature_unit": "°C",
    "humidity": 84,
    "pressure_unit": "hPa",
    "wind_bearing": "WSW",
    "wind_speed": 11.27,
    "wind_speed_unit": "km/h",
    "visibility_unit": "km",
    "precipitation_unit": "mm",
    "attribution": "Data provided by the Met Office",
    "friendly_name": "Met Office xxx Daily",
    "supported_features": 3
  },
  "last_changed": "2024-07-09T19:53:10.313399+00:00",
  "last_reported": "2024-07-09T21:53:10.219105+00:00",
  "last_updated": "2024-07-09T21:53:10.219105+00:00",
  "context": {
    "id": "01J2CQRYJBNX1H4NN4E2GHCX3F",
    "parent_id": null,
    "user_id": null
  }
}

Looking at my implementation there used to be a forecast key under attributes but it has been removed. Any idea how to get this back?

[Sir_Goodenough ((SG) WhatAreWeFixing.Today)]

This was change a month or 2 ago. This search will help you find an example that will match your specifics.

site:home-assistant.io weather forecast

This is the weather integration page for further reference.

Weather

[paddy0174 (Patrick)]

As this has been discussed at length, please use the forum search as suggested.

Just to get you started, here are two threads:

New weather forecast template

With the new weather entities and “forecast” being removed, how do we get attribute values with a sensor template now? This template no longer works. I am using the Weatherflow Forecast integration. {{state_attr('weather.forecast.stratford', 'forecast')[0].temperature}} The value appears to be there when I do a daily service call (as shown below), but the template tester returns No element 0. forecast: - condition: lightning-rainy datetime: "2023-10-05T05:00:00+00:00" precipitatio…

How to migrate from weather integration approach to new weather.get_forecast service?

I have a beginner question on the migration path for conditions in automations using the weather forecast data. The setting: To automate my window blinds I use the weather forecast (cloudy, sunny, …) and the forecast temperature as a condition when running automations. All automations where created via UI and therefore the attributes for the weather entities could be selected in German. That all worked fine, but if I understand the documentation of the 2023.9 update correctly, this will stop …

[wjdp (Will Pimblett)]

Sorry, I did try to search but ‘weather rest API’ just gave results about building integrations with external sources. I’d not realised this was more of a core change rather than just an API interface change.

[wjdp (Will Pimblett)]

Coming around to actually fix this. This is what I did to restore an API to get weather forecast.

Couple of caveats:

• Firstly you cannot use POST /api/services/<domain>/<service> to call the weather.get_forecasts service as that API does not support responses. That’s be too easy! This stumped me for a bit as it was just returning a 500 without any detail. There’s a github issue that explains but I’ve closed it already.
• Use weather.get_forecasts, weather.get_forecast is deprecated.

Define a template sensor. I tried doing this via UI first (helpers tab) and couldn’t get very far, YAML instead:

template:
- trigger:
    - platform: time_pattern
      hours: /1
  action:
    - service: weather.get_forecasts
      data:
        type: hourly
      target:
        entity_id: weather.<YOUR PROVIDER>
      response_variable: hourly
  sensor:
    - name: Weather Forecast Hourly
      unique_id: weather_forecast_hourly
      state: "{{ now().isoformat() }}"
      attributes:
        forecast: "{{ hourly['weather.<YOUR PROVIDER>'].forecast }}"

From Template - Home Assistant

For the first run swap out hours: /1 for minutes: /1 so you have data now rather than on the next hour. Swap back after.

After this call the get sensor API and data is restored!

[MirCore]

Came across the same issue today. Turns out the API does support responses (maybe it has been implemented since your last post), but it has to be requested in the POST call.
It works like this: POST /api/services/weather/get_forecasts?return_response=true.