Skip to main content
Gary
Rank 1
Rank 1
March 9, 2017
Solved

Can we get access to the OVO energy online account API to download our smart meter usage data?

  • March 9, 2017
  • 227 replies
  • 36559 views

Hi Ovo,

I wondered whether the API that powers your live and historical usage page in the account menu is something you could look into opening up a bit so we can freely access our raw data and also perhaps it may stimulate some interesting community projects?

For instance (more sport related), Strava and Fitbit.

Best answer by g-de

Updated on 14/08/25 by Abby_OVO

 

Tim_OVO: “We love seeing the innovative ways our customers are using tech to help monitor and manage their energy usage. It’s inspiring us to think about ways to do energy differently. We know some customers have been using some of the application programming interface (APIs) behind our public facing services. While we’re OK with that, we do need to make you aware of a couple of things.

 

These APIs are designed to be used by OVO teams only, and aren't public facing. There are some downsides to using APIs that aren't for the public, and we wanted to let you know what these are. Behind the scenes, OVO uses APIs to share and update information between systems that power your bills and your online account. This is done in partnership with Kaluza, the tech company that’s part of the OVO family. They’ve built the billing platform designed to put our customers in the driving seat of their energy usage. 

 

These internal APIs are intended for use by Kaluza and its clients, who are energy retailers like OVO, rather than customers. Because of this, there’s no support for them being used anywhere else, which means they may be discontinued with no notice when we update our products and services. 

 

OVO Energy and Kaluza need to be able to monitor these APIs, and may block access if there's any problems in the future.

 

We know some customers may have put time and effort into developing solutions that use these API. So, now that you know the risks, we want to hear from you on how you’re using the APIs and the problems you’re solving with your DIY approach. 

 

Is there anything you’d like to see from OVO to help you monitor and manage your energy better? Leave a comment below to tell us.”

 

can you help me understand if the links above allow users to access raw data as if from an API?

I can certainly give it a go.

 

Firstly, big thanks to Timmo and other contributors for developing the library. All thanks go to them and links to buy them a coffee for their effort can be found on PyPi or GitHub:

https://pypi.org/project/ovoenergy/
https://github.com/timmo001/ovoenergy

 

I assume the way the library was developed this was to reverse engineer the My OVO website. That is, browse the website as normal and and monitor the traffic to see what OVO URLs and APIs it uses. Assuming this is the case, one of these URLs (get account IDs) already seems to be different but the library is still working for the moment. The APIs being used are not officially supported outside of the website, so first, a warning that any changes to the My OVO website may break the library.

 

For anyone using Python, you should be able to include the ovoenergy library and look at https://github.com/timmo001/ovoenergy/blob/master/ovoenergy/cli.py for how to use it.

 

For replicating this in other languages, the process seems to be as follows:

  1. Login by sending a POST request to https://my.ovoenergy.com/api/v2/auth/login with the following JSON in the body:
    {
    "username": "...",
    "password": "...",
    "rememberMe": true
    }

    From the response, save the cookies to use in all future requests.

  2. Next, send a GET request to https://smartpaym.ovoenergy.com/api/customer-and-account-ids . Be sure to save the items in the “accountIds” property (usually only one item).
  3. Finally, make a GET request to https://smartpaym.ovoenergy.com/api/energy-usage/daily/{accountId}?date={yyyy-MM} where {accountId} is the value from the previous request and {yyyy-MM} is the month in the format 2020-08.

You can also get monthly or half-hourly usage using the following URLs similar to step 3:

As mentioned above, if this is wanted for Home Assistant, the integration was added in version 0.114 (https://www.home-assistant.io/integrations/ovo_energy/).


Unfortunately the data only goes up to the end of the previous day as OVO no longer provide real-time data:

 

227 replies

Newcomer
July 25, 2024

Just looking at the code and this needs a failure breakout rather than keep retrying. Has a check been added with Cloudflare being put in front of the API? I’m just wondering what caused the credentials to fail in the first place as they haven’t changed in over a year. I have them in Bitwarden.

I’ll have to brush up on my Python and submit a PR

    """Authenticate with OVO Energy."""
[client, client_session] = loop.run_until_complete(
_setup_client(username, password)
)

bootstrap_accounts = loop.run_until_complete(client.bootstrap_accounts())

typer.secho(
asdict(bootstrap_accounts),
fg=typer.colors.GREEN,
)

loop.run_until_complete(client_session.close())

 

Blastoise186
Super User
Super User
July 25, 2024

There are ways of testing it - GitHub Codespaces is pretty useful and easy to fire up.

If you think you can fix Timmo’s code, by all means please do. But you can’t bash OVO for trying to prevent hackers from getting in.

Securing energy by zapping security bugs... For that is The Blastoise Way! Remember, I'm just like you - AI Powered Evil Geniuses aren't Staff!
Newcomer
July 25, 2024

I was never bashing OVO for blocking hackers, I had mistakenly believed that Timmo was an OVO employee. 

Me fixing Timmo’s code is a stretch as being a typical DevOps I tend to dip in and out of python, Go, terraform, cloudformation, helm charts and ansible. I’m going to try and add an exception to it 

Emmanuelle_OVO
Retired Moderator
Retired Moderator
July 26, 2024

I can see there are two similar topics, I wonder if this thread has any helpful advice:

 

 

Renewable Energy? Big Fan.
November 6, 2024

Thanks for the app @MikeWilliams . I’ve downloaded V1.0.2.

I found I had to run the program as admin otherwise it wouldn’t work. This may be a “feature” of my current W11 setup, but I just wondered whether it might be worth mentioning in your README?

Also, when running for the first time, an exception was raised; here is the data from the log:

System.NullReferenceException: Object reference not set to an instance of an object.
   at OvoData.Helpers.SqliteHelper.UpsertMonthly(String fuelType, List`1 items) in C:\Dev\Mike\GitHub\My-Ovo-Data\Helpers\SqliteHelper.cs:line 114
   at OvoData.MainWindow.OnClick_Read(Object sender, RoutedEventArgs e) in C:\Dev\Mike\GitHub\My-Ovo-Data\MainWindow.xaml.cs:line 189
 

 

MikeWilliams
Newcomer
Newcomer
November 6, 2024

Thanks for the app @MikeWilliams . I’ve downloaded V1.0.2.

I found I had to run the program as admin otherwise it wouldn’t work. This may be a “feature” of my current W11 setup, but I just wondered whether it might be worth mentioning in your README?

Also, when running for the first time, an exception was raised; here is the data from the log:

System.NullReferenceException: Object reference not set to an instance of an object.
   at OvoData.Helpers.SqliteHelper.UpsertMonthly(String fuelType, List`1 items) in C:\Dev\Mike\GitHub\My-Ovo-Data\Helpers\SqliteHelper.cs:line 114
   at OvoData.MainWindow.OnClick_Read(Object sender, RoutedEventArgs e) in C:\Dev\Mike\GitHub\My-Ovo-Data\MainWindow.xaml.cs:line 189

I suspect that Windows 11 is not allowing the program to create the folder C:\ProgramData\OvoData
Please use admin account to create it and assign full permissions to all users

 

November 6, 2024

I had already created the folder, but the permissions weren’t set to the full control (although the logs folder and the .db file had been created).

So, I cleared out the contents of the OvoData folder, changed the permissions to allow Full Control and Modify, and reran your app. But got exactly the same exception. Again the Logs folder and the .db file have been created.

Anything else I can check for you?

MikeWilliams
Newcomer
Newcomer
November 7, 2024

Are you a Gas only customer?

I already fixed an issue for Electricity Only customers last with the aid of @Firedog 

 

/Mike

November 7, 2024

Mike: Electricity only. Economy 7 also, but that probably isn’t relevant. Thanks. 

MikeWilliams
Newcomer
Newcomer
November 7, 2024

I had already created the folder, but the permissions weren’t set to the full control (although the logs folder and the .db file had been created).

So, I cleared out the contents of the OvoData folder, changed the permissions to allow Full Control and Modify, and reran your app. But got exactly the same exception. Again the Logs folder and the .db file have been created.

Anything else I can check for you?

Can you post all the log file lines from the last beginning “Uri:” until the exception?
Be careful to mask out your account number with *****

/Mike