Skip to main content
Gary
Rank 1
Gary
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

    Show previous replies
    Tim_OVO
    OVO Staff
    Tim_OVO
    OVO Forum Legend
    October 15, 2020

    @Jequinlan I will have a read of this, but without an OVO account I won’t be able to test :pensive: Sounds like amazing customer-led action though!

     

    Please be advised that from OVO’s point of view, I neither condone or condemn this workaround. It’s untested and possibly insecure, either way it’s not made alongside OVO. However I know there's been lots of interest, and (whilst OVO/Kaluza developers are tabling an idea that will be of interest to everyone here in November) so far we haven't been able to deliver anything in house. 

     

    So I’m tagging everyone that's commented here to make sure you're aware of this work from @Jequinlan 

     

    Let us know how it goes please! 

     

    @Gary @GarethMarlow @rgphilpott @atilagiant @Deanohol @Peter_Mat @didge05 @sam_cat @jmontalvo @adec @Pramsbottom @ryck @CeeJayCee @alexbaulch @Random @maccordingley @sfgreenwood @johnk @jadam @Fordy @Steveo67 @Siggy0 @CerebralDigits @deanjames @ChrisB @jadam @DaveJenYearsley @ErTnEc @Marshcroft @jordanharper @Simonfea @obiwanzamora @AdamJ @dorinho @Ross2411 @Chrherms @MikeWilliams @blakedrayson @TerryE @VibroAxe @jdenver @maurorappa @adec @100903609 @Riscy @r3m0dul8 @MyZoe.Uk @Ajk @AlanN51 @CloudCircus @r3m0dul8 @technogeoff @resoai @Fuzzysteve @mattc @andsee @uvarvu @Transparent @g-de 

    Carbon neutral - we need a community to get there! My green tech: Aclara SGM 1411-B smart meter, Chameleon IHD6
      Jequinlan
      Rank 10
      Jequinlan
      Rank 10
      October 15, 2020

      Thanks @Jequinlan Have got it working, and it confirms last HH gas data was logged on 19 August 23:30!

      What’s the TOU comparison tool you’re working on next?

      I am working on creating a "price comparison tool" for taking your actuals and comparing to tarrifs from suppliers where rates may change on up to a half hourly basis. Allowing a true "annual cost projection"

      John Quinlan
        Jequinlan
        Rank 10
        Jequinlan
        Rank 10
        October 15, 2020

        Btw, I can confirm there is no risk of insecure as you will see from the command line the details are on your machine and provided to directly access ovo, the exe has been made by best practice .net core code and is a standalone on pc only exe.

        John Quinlan
          MikeWilliams
          Newcomer
          MikeWilliams
          Newcomer
          October 15, 2020

          Thanks this is great.

          What’s the purpose of the fields Login, Password and File in the appsettings.json

          The command line in the readme seems to negate their existence in the settings file!

          {

            "OvoUrls": {

              "Login": "https://my.ovoenergy.com/api/v2/auth/login",

              "Accounts": "https://smartpaym.ovoenergy.com/api/customer-and-account-ids",

              "Usage": "https://smartpaym.ovoenergy.com/api/energy-usage/"

            },

            "OvoAccount": {

              "Login": "x",

              "Password": "x"

            },

            "Output": {

              "File": "s:\\MyFile.csv"

            }

          }

           

          Jequinlan
          Rank 10
          Jequinlan
          Rank 10
          October 15, 2020

          You can put them in there to save typing them all the time! Thats all. Then you can omit those params from command line.

          John Quinlan
            Transparent
            Rank 20
            Transparent
            Rank 20
            October 15, 2020

            Please confirm @Jequinlan - does this solution only work on PCs running Windoze?

            Save energy... recycle electrons!
            MikeWilliams
            Newcomer
            MikeWilliams
            Newcomer
            October 15, 2020

            PS:

            In order to save the output in the same folder as the exe I had to specify .\output.csv as the file name

            MikeWilliams
            Newcomer
            MikeWilliams
            Newcomer
            October 15, 2020

            You can put them in there to save typing them all the time! Thats all. Then you can omit those params from command line.


            Ought to be in the readme (as a programmer I guessed that might be the case)

            MikeWilliams
            Newcomer
            MikeWilliams
            Newcomer
            October 15, 2020

            If I add my username and password into the settings json file I get

             

            OvoData.exe -f 01/01/2020 -t 04/02/2020 -o .\OvoData.csv
            Unable to login - 401 - Unauthorized
               at OvoData.OvoLiveRepository.OvoConnect.GetLoginCookieAsync(String userName, String password)
               at OvoData.OvoOrchestrator.ExportData()
               at OvoData.Program.EntryPoint.Run()

            Jequinlan
            Rank 10
            Jequinlan
            Rank 10
            October 15, 2020

            Please confirm @Jequinlan - does this solution only work on PCs running Windoze?

            Hmm, i would think so I am afraid  but i will see if i can make a docker version for mac or linux users.

            John Quinlan
            Show more replies
            Terms & ConditionsAccessibility statement

            OVO Energy Ltd, Floor 5, Crescent, Temple Back, Redcliffe, BS1 6EZ, (Company no. 06890795) registered in England and Wales.

            OVO (S) Gas Limited is registered in England and Wales (Company No. 02716495) at Floor 5, Crescent, Temple Back, Redcliffe, BS1 6EZ.

            OVO (S) Gas Limited is part of OVO Group Ltd