api Image


VRM API with Python for extracting data

I have little programming knowledge, so I would immensely appreciate any help I could get about how to extract data from the VRM portal to a spreadsheet automatically using a python integration. Example of data I would like to extract include Generator run hours, grid supply hours, power yield (gen, solar and grid) and power consumed (gen, solar, grid, battery).

I know you can extract this data with an excel sheet from the website, but it doesn't contain data on grid supply hours. I would also generally prefer using a program to automate the data capture.

Thank you.

cheedalu asked
matt1309 answered ·

1 Answer

Victron API

Hello people,

I noticed that Victron updated the API documentation web site. The weird thing is that they removed the ArttibutesCode list from the documentation and I could not be able to find it anywhere. Does anyone have the previous API documentation file? If so, Could you please shared it?

jhongiraldo asked
earthadam answered ·

2 Answers

Toggling "Charger Only" to "On" via API Call ?

Via the VRM Webapp, you are able to set the mode of a device (in this case a MultiPlus II) to Charger Only/Inverter Only/On/Off (please see screenshot).

I'd like to be able to toggle the state of this programatically. But I can't find anything in the VRM API that allows values like this to be set: https://vrm-api-docs.victronenergy.com/

In fact the only things that you seem to be able to retrieve via the API are 'read-only' metrics and the like, there doesn't appear to be a way to set variables that you can get to via the WebApp (like "Charger Only", "Inverter Only" etc.....).

Is this a limitation of the VRM API - or am I missing something ?

With Thanks in Advance,



patrick-rynhart asked
patrick-rynhart answered ·

1 Answer

VRM Portal API - Historical Data

Hi at all,


i testing the VRM API but i have a Problem,

i searching the "Historical Data" from "Today" -> From Grid, Solar and Consumption.

I think it is this :


I have me token, me id; the end and start is empty.

I Testing many instance but i dont get become datas.


i need help, what i do wrong ....

for many datas i use :

curl --request GET --url https://vrmapi.victronenergy.com/v2/installations/<ID-SITE>/diagnostics?count=1000 --header 'Content-Type: application/json' --header 'x-authorization: Bearer <TOKEN>'

plz help me

sefina asked

0 Answers

VRM API get time based grid meter data


I try to figure out how to get time based data out of victron for my smartmeter. I have a widget that show me the data of kWh for each Phase. How to get it from the API itself? I'm using python and I have tried out the VRM-API. I can get lot of data from VRM instead of the energy parameter of the smartmeter for L1/L2/L3.

Best wishes

tschaka81 asked

0 Answers

Octopus Agile API Support by Victron For Controlling Charging Off Peak Times

Thank you so much for the very informative webinar on 23/11/22.

Octopus Energy in the UK is disrupting the energy industry for good and their Kraken platform is in many countries bought by suppliers and growing.

Will Victron please look at integration with Octopus Kraken API to allow us to auto set charging times when energy prices are low and export when high?

“Works with Octopus” is a standard attained by many ESS systems and it would be great if Victron would look at putting this on their roadmap.

NodeRed and some technical challenges aren’t for all of us and I believe it would help in adoption of Victron into many domestic installations where people just aren’t getting the quality and support from certain other brands.

Standards to help home storage and EV take-up are so very crucial to environmental gains and the rapid change needed to combat climate change.

Many thanks for your great work. New Solar ESS Victron User in the UK, Installed by Callidus, another great cutting edge supplier and supporter of Victron.

dune7 asked
Jason - UK commented ·

3 Answers

VRM Excel Download and API Attributes for kWh data

Hello there.

I was wondering if there are API attributes for the VRM kWh data (the 15min interval data)? I use this regularly and wanted to directly connect to the data for use vs. having to get the excel downloads always.

Alternatively, is there a download that confirms the methodology for producing the kWh download data from the log data points (the per second and more detailed download)?

I tried to replicate for a month of data on my system and got close with some (Grid to battery, PV to consumers) but way off for others (Battery to consumers) and okayish for others (PV to battery and Grid to consumers). See below. Would love some guidance here...


nkt22 asked

0 Answers

Error 429 - no header value

Hi there

We are trying to get values via the API, but we get error 429, too many requests. What are the parameters of this restriction ? The documentation makes no note of what the limit is in seconds, and if it is too the API as a service, or to each of the nodes in our portal. Is there someone that can assist please ?

letabawireless asked
nickdb commented ·

0 Answers

Download GPS data with timestamps (and speeds) via VRM API?

When downloading historical GPS data using the API, I get a KML file (not JSON like the rest) containing only the coordinates. No timestamps nor speeds. Is it possible to get the full GPS data somehow? If not, please consider this a feature request :)

grasvezel asked

0 Answers

Access specific device data from API (e.g., tank level)

Is there a simple way to access data for a given instanceId via the API? I'm trying to get something simple like a specific tank level. The only way I see to do this is via the /diagnostics endpoint and sifting through the large array of data points to filter the right one.

mjrobichaud asked

0 Answers

Getting "Another export was started[...]" for every CSV download from specific VRM Installation

While trying to download CSV exports from the VRM portal for a specific installation, all I got in the export was the error message "Another export was started; since only one export may run at any given time this export was cancelled." I've confirmed that no one else with access had tried to download an export at the time, and tried re-downloading from this installation multiple times over 4 days with the same result. Interestingly, this problem isn't present in the other installations and I have been able to download from them just fine.

I also tried automating the downloads using a script and the VRM API which has downloaded every hour over the past 4 days with the same results: the downloads from the other installations worked except for this specific installation. I'm suspecting it's a system issue but still unsure. Would appreciate any input on this!

wvjug asked
Guy Stewart (Victron Community Manager) commented ·

1 Answer

Cerbo GX relay control command via API


I have installed many Victron products in our test house including Multiplus II, LiFePO4, solar MMPT, and Cerbo GX. I am wondering if I can control Cerbo GX relays with commands using VRM API? I am planning to use Matlab for this purpose. Any thoughts about it? many thanks

jchowdhury asked
shaneyake edited ·

1 Answer

Example of active alarm in installations API call with extended=1

I am working in an web app that has to use the API to get the current alarms. I found that the installation calls provide the current alarms for each installation when called with extended=1:

"current_alarms": [],

"num_alarms": 0,

The issue I'm having is that I can not find a sample of the data returned when there is actually an active alarm, nor in the documentation nor in the systems I have to test. Can any of you provide an example of an api response with an active alarm, please?


Javier Vegas asked

0 Answers

idSite value possible from API with user/pass login

Is this possible? I understand you can get it from the URL but I am building an app to utilize the API. I will have the user provide the username/password credentials. If that is sufficient to authenticate with the API can I get the idSite or "installation ID" from the API without having to have the user provide it? Otherwise I can try to login and get it from the URL for the user but I see this going badly and/or breaking when/if a change is made on the Victron side.

jimbo47 asked

0 Answers

Anyone getting a 401 error from VRM API?

Suddenly with no software changes from my side, I'm getting a 401 error when I fetch:


Tokens are correct... Can it be a ACL/CORs change from Victron?

Any info/help is appreciated...

Thanks in advance!

abascuna asked
abascuna answered ·

1 Answer

39 Posts
35 Users

Topic Experts