API Access roles
Introduction To API access roles
The table below outlines the access rights for each available API endpoint.
Each API is categorized by the type of operations it supports: Trade, Reporting, Wallet, and PV-party (BRP) functionality.
Use this matrix to determine which capabilities are enabled for a given API and to ensure proper integration based on your access level.
Note: When a participant account is created through our support team, the support team is responsible for enabling access for that participant according to their use cases and requirements.
Clarification for the Term PV-Party role:
“PV” (Programmaverantwoordelijke) is the older or alternative Dutch term for what is now officially called the Balance Responsible Party (BRP). Both refer to the same role: the party responsible for planning and balancing daily electricity transactions.
Table
| API/User | Trader | Report | Wallet | PV-party (BRP) |
|---|---|---|---|---|
| On Hold Order | Yes | No | No | No |
| Order v2 | Yes | No | No | No |
| Order status | Yes | No | No | No |
| Platform status | Yes | Yes | No | No |
| Reporting v2 | No | Yes | No | No |
| Reporting v3 | No | No | No | Yes |
| Trades v2 | Yes | Yes | No | No |
| Trades v3 | Yes | Yes | No | No |
| User Management | Yes | Yes | Yes | No |
| Wallet v2 | Yes | No | Yes | No |
| Wallet v3 | Yes | No | Yes | No |
| XBID Contract v1 | Yes | No | No | No |
| XBID Order v1 | Yes | Yes | No | No |
| XBID Order Status v1 | Yes | No | No | No |
| XBID Public Trade v1 | Yes | No | No | No |
| XBID Reporting v1 | No | Yes | No | No |
| XBID Status v1 | Yes | No | No | No |
| XBID Trades v1 | Yes | No | No | No |
| XBID Trade Reports v1 | Yes | No | No | No |
| XBID Wallet v1 | No | No | Yes | No |