VRM API

https://vrm-api-docs.victronenergy.com/
Admin
The VRM API is a REST API providing programmatic access to Victron Energy's Victron Remote...
Tokens:874
Snippets:3
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### VRM API Endpoints

Source: https://vrm-api-docs.victronenergy.com/index

Overview of available VRM API endpoints for login, logout, retrieving attributes, and firmware details.

```APIDOC
## VRM API

### Introduction

This document provides a brief overview of some of the available endpoints and their parameters. The API is a REST API, accepting JSON as request body.

### Authentication

Most endpoints require authentication, using a JWT token. This token should be placed in the `x-authorization` field in the HTTP header. There are two types of tokens:

*   **Bearer token**: Uses the `Bearer <token_value>` format. This is used when logging in to VRM, for example. Can be retrieved from `/auth/login` or `/auth/loginAsDemo`.
*   **Access token**: Uses the `Token <token_value>` format. This is commonly used for third party applications using the VRM API. Can be created using `/users/{idUser}/accesstokens/create`.

### Rate Limiting

Most endpoints are by default rate limited with a rolling window of max 200 requests, where every 0.33 seconds a request gets removed from the rolling window (so on average maximum of 3 requests per second won't get rate limited). There are different types of rate limiting in VRM. If you receive a 429 with a JSON response, you can check the `Retry-After` response header to check the amount of seconds you have to wait until retrying.

### Endpoints

#### Log in using an e-mail and password

*   **Method**: POST
*   **Endpoint**: `/auth/login`
*   **Description**: Logs in a user using their email and password.

#### Log in as the demo account

*   **Method**: GET
*   **Endpoint**: `/auth/loginAsDemo`
*   **Description**: Logs in as the demo account and returns a Bearer token.

#### Log out using a token

*   **Method**: GET
*   **Endpoint**: `/auth/logout`
*   **Description**: Logs out the current user and invalidates their token.

#### Retrieve filtered and sorted attributes

*   **Method**: GET
*   **Endpoint**: `/installations/{id}/devices/{id}/attributes`
*   **Description**: Retrieves a list of filtered and sorted attributes for a specific device within an installation.

#### Get firmware details

*   **Method**: GET
*   **Endpoint**: `/firmware`
*   **Description**: Retrieves firmware details for devices.

### Other Sections

*   Users
*   Installations
*   General Widgets
*   State Widgets
*   Summary Widgets
```
Tokens:
Raw