Skip to main content

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/UserTraderReportWalletPV-party (BRP)
On Hold OrderYesNoNoNo
Order v2YesNoNoNo
Order statusYesNoNoNo
Platform statusYesYesNoNo
Reporting v2NoYesNoNo
Reporting v3NoNoNoYes
Trades v2YesYesNoNo
Trades v3YesYesNoNo
User ManagementYesYesYesNo
Wallet v2YesNoYesNo
Wallet v3YesNoYesNo
XBID Contract v1YesNoNoNo
XBID Order v1YesYesNoNo
XBID Order Status v1YesNoNoNo
XBID Public Trade v1YesNoNoNo
XBID Reporting v1NoYesNoNo
XBID Status v1YesNoNoNo
XBID Trades v1YesNoNoNo
XBID Trade Reports v1YesNoNoNo
XBID Wallet v1NoNoYesNo