How Cloud Chart Items Map to API Variables
Hi

I'm getting my head around the API and have so far been using the following endpoint paths:

Code: Select all

/op/v0/device/real/query
/op/v0/device/report/query
I notice today, the FoxESS cloud UI has started showing a different set of metrics [see attached]
v2 Chart.jpg

Is there any information that tells me how those items in the legend map to the variables for the payload when making an API call?

Thanks in advance
Re: How Cloud Chart Items Map to API Variables
SurreyDude wrote: Fri Mar 06, 2026 1:01 pm Is there any information that tells me how those items in the legend map to the variables for the payload when making an API call?
Fox ESS's API documentation is pretty non-existant I found.

You might want to have a look at this python script/library https://github.com/TonyM1958/FoxESS-Clo ... openapi.py it seems to be based on Fox ESS's reference code, but the code in the API documents isn't indented correctly so it would take a lot of effort to make it work.

I've been using it to poke about the API to see what would be returned, the script actually has arrays of variables names for the different API calls.

You might also want to look into the history API, when you call it and specify "day" instead of "hour" you get 5 minutely records back.
Re: How Cloud Chart Items Map to API Variables
evilbunny wrote: Fri Mar 06, 2026 1:10 pm
SurreyDude wrote: Fri Mar 06, 2026 1:01 pm Is there any information that tells me how those items in the legend map to the variables for the payload when making an API call?
Fox ESS's API documentation is pretty non-existant I found.

You might want to have a look at this python script/library https://github.com/TonyM1958/FoxESS-Clo ... openapi.py it seems to be based on Fox ESS's reference code, but the code in the API documents isn't indented correctly so it would take a lot of effort to make it work.

I've been using it to poke about the API to see what would be returned, the script actually has arrays of variables names for the different API calls.

You might also want to look into the history API, when you call it and specify "day" instead of "hour" you get 5 minutely records back.
Thanks for the info -very helpful.

I've switched to the history API call because it actually gives me the granularity I was looking for. I'm still struggling to map the variable names though. Currently using this:

"batChargePower", "batDischargePower", "gridConsumptionPower", "feedinPower", "generationPower", "loadsPower", "SoC"

these don't seem quite to correspond with the figures I see on the FoxESS UI - discharge value doesn't relate.

Do you know if there is a * option for variables? If I make a request for all of them, I can probably deduce which ones relate to the numbers I am seeing in the UI. (The values will obviously be slightly different between real time in the UI and history in the 5 minute log)

Thanks
Post Reply