Open Weather Map (OWM) API 2.5 closing, switch to 3.0 API

I’m sure most of you who are affected have been receiving the emails but I’m just posting this in case someone misses it. OWM is closing down their 2.5 API in June and requiring everyone to migrate to the 3.0 API. Luckily for us the 3.0 API is supported by the openHAB binding.

Once you resubscribe to the 3.0 API (it requires a separate subscription) you simply need to switch to the 3.0 API in the Open Weather Map Account Thing. I didn’t need to change the API key. YMMV.


thx Rich!

any idea how to change the binding version in textual configuration?

nothing in the doku about it :frowning:

No, I don’t use text .things files. But here is the YAML for my Thing (API key redacted of course). The property names are the same between the YAML and .things files.

UID: openweathermap:weather-api:owm_account
label: OpenWeatherMap Account
thingTypeUID: openweathermap:weather-api
  language: en
  apiVersion: "3.0"
  refreshInterval: 10
location: Global

It’s also worth mentioning that you can set a limit on the service so it will refuse calls instead of getting to where it starts charging you. Log in to OpenWeatherMap and click on “Billing plans”

Click the pencil icon and change it to your desired amount. It defaults to 2000 and you can see here that I changed it to 1000.


Textual config needs a small adaption: Add , apiVersion="3.0" to the config (right after apiKey="xxx").

See also [openweathermap] One Call API 2.5 to be discontinued June 2024 · Issue #16665 · openhab/openhab-addons · GitHub


I tried that, adding apiVersion to my definition, like that:

/* Openweathermap */
Bridge openweathermap:weather-api:api "OpenWeatherMap API" @ "openHABian"

But get that error right away:

2024-04-29 15:53:26.541 [INFO ] [el.core.internal.ModelRepositoryImpl] - Loading model 'bridge_openweathermap.things'

==> /var/log/openhab/events.log <==

2024-04-29 15:53:26.610 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'openweathermap:weather-api:api' changed from ONLINE to UNKNOWN
2024-04-29 15:53:41.813 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'openweathermap:onecall:api:local' changed from ONLINE to OFFLINE (CONFIGURATION_ERROR): Ungültiger API Schlüssel. Mehr Infos unter
2024-04-29 15:53:41.830 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'openweathermap:onecall-history:api:local-history' changed from ONLINE to OFFLINE (CONFIGURATION_ERROR): Ungültiger API Schlüssel. Mehr Infos unter
2024-04-29 15:53:41.831 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'openweathermap:weather-api:api' changed from UNKNOWN to OFFLINE

ApiKey not valid …

Make sure that your base plan now shows “One Call API 3.0” (see screen shot above).

Try creating a new API key to see if that works.

My subscription is Base Plan:

If I click on “view”:

Also under Billing Plans:

Already considered that …

You’ve not activated the OneCall API 3.0. It should show "“activated” under “Status” and the button at the end should show “Unsubscribe”, just like my screen shot above. Your screen shots shows a “Subscribe” button showing you have not subscribed to the 3.0 API yet.

You will have to enter payment information but you can set the calls per day to 1000 so they will never charge you.

Hmm, ok, had the impression I have nothing to do on openweathermap subscription, my bad. But now its like you told:

But still:

2024-04-29 16:44:13.797 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'openweathermap:onecall:api:local' changed from UNKNOWN to OFFLINE (CONFIGURATION_ERROR): Ungültiger API Schlüssel. Mehr Infos unter
2024-04-29 16:44:13.827 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'openweathermap:onecall-history:api:local-history' changed from ONLINE to OFFLINE (CONFIGURATION_ERROR): Ungültiger API Schlüssel. Mehr Infos unter
2024-04-29 16:44:13.828 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'openweathermap:weather-api:api' changed from UNKNOWN to OFFLINE

Using my old/existing apikey, as also on a new one I generated.

I am on:

                          _   _     _     ____   _
  ___   ___   ___   ___  | | | |   / \   | __ ) (_)  ____   ___
 / _ \ / _ \ / _ \ / _ \ | |_| |  / _ \  |  _ \ | | / _  \ / _ \
| (_) | (_) |  __/| | | ||  _  | / ___ \ | |_) )| || (_) || | | |
 \___/|  __/ \___/|_| |_||_| |_|/_/   \_\|____/ |_| \__|_||_| | |
      |_|                  openHAB 4.1.2 - Release Build

At this point I don’t have anything else to offer. It worked for me. I didn’t need to create a new API key after subscribing to the 3.0 API. Once the subscription was set up the next time the OWM binding polled the API it just worked.

1 Like

Hmm, strange enough, I just switched the apikey once more forth and back, et voilá:

2024-04-29 16:52:27.033 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'openweathermap:onecall:api:local' changed from OFFLINE (CONFIGURATION_ERROR): Ungültiger API Schlüssel. Mehr Infos unter to ONLINE
2024-04-29 16:52:27.096 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'openweathermap:onecall-history:api:local-history' changed from OFFLINE (CONFIGURATION_ERROR): Ungültiger API Schlüssel. Mehr Infos unter to ONLINE
2024-04-29 16:52:27.098 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'openweathermap:weather-api:api' changed from UNKNOWN to ONLINE

Maybe it took a moment on openweathermap to reflect changes to the keys …

I’m back now on my / the old original apikey I configured years ago.

1 Like

A couple of thoughts to add to Rich’s instructions.

When you subscribe to the 3.0 API, the billing page (where you enter your credit card) might be a bit confusing since it doesn’t mention the free 1000 calls per day.


However, the free 1000 calls show up on the Billing Plan page after you subscribe.

I lowered mine to 600, which is still more than twice what I need since I’m only refreshing data every 10 minutes (288 times a day).

When I updated my bridge to 3.0 and saved, the thing went offline. I paused/restarted the thing to reinitialize, and it came back online immediately. I didn’t need to to generate a new API key.

1 Like


don´t judge me but here is a OpenHab 2.4 still running (very fine!!).
I added the Openweather thing via the PaperUI in the past (at my first steps with OH)
What about that “old” System ? Can i use the new 3.0 API also ?

Br Peter

If it’s possible, you’ll see an option for it in your OpenWeatherMap bridge thing.

If not, you’ll need to update to OH4 before June to continue using OWM.

No, the 3.0 OneCall API didn’t exist when OH 2.4 was released.

Is it right that this change is required only if you use things provided by the binding relying on OneCall API ?
For other things not using the OneCall API, the binding will continue working without any change?

So if i configure the “bridge” thing with textual configuration i might be working with OH 2.4 ?

No, as @rlkoshak already wrote.

1 Like

I don’t know for sure but I think the non-OneCall API stuff is actually an even older API and is likely to be closed down too. I don’t actually see those API end points offered any more either in their account page.

If you’ve been getting emails from OWM I’d take that as an indication you need to change.

No. It’s a whole new API. Everything is different. It’s not just a matter of changing some String. The dbinding has to acutally implement the new API. The 2.4 binding doesn’t implement the 3.0 API, it couldn’t. The 3.0 OWM OneCall API didn’t exist five years ago when OH 2.4 was released.

hmm… so i added the , apiVersion=“3.0” to the bridge, then thing was offline, restartet couple of times and for me it’s working again.
But maybe just as fallback to version 2.x ? how to check that?
At least i did not put any pay information to openweathermap…