Skip to main content
The Otark BRP API provides programmatic access to the BRP Portal, enabling Balancing Responsible Parties to manage contracts, view transactions and nominations, and handle customer assignments.

​
Base URL

https://api.otark.energy/v1
All requests must use HTTPS. Responses are returned in JSON format.

​
Authentication

All requests must include the X-Api-Key header: 
curl -X GET "https://api.otark.energy/v1/contracts" \
-H "X-Api-Key: YOUR_API_KEY"
API keys can be generated in the BRP Portal. Store your key securely — it grants full access to your BRP account.

​
Data Model

The API is organized around three core resources that form a hierarchy: 
Contract (PPA, etc.)
 └── Transaction (contractual energy volumes between buyer and seller)
       └── Nomination (net saldo, aggregated by balance group)
  • Contracts represent energy agreements (e.g., PPAs) between a seller and a buyer. Contracts are polymorphic — the schema varies by type.
  • Transactions represent the contractual energy volumes to be transferred between buyer and seller under a contract. Transactions are immutable; corrections produce a new version that supersedes the previous one.
  • Nominations are the net saldo of valid transactions, aggregated by balance group and delivery period. Nominations are also versioned.
  • Customers represent energy consumers or producers assigned to a BRP. Two customers make up either party of a contract. Customers can be approved, rejected, and configured with balance group settings.

​
Getting Started

  1. Obtain an API key from the BRP Portal.
  2. Explore your contracts and customers by calling GET /v1/contracts and GET /v1/customers.
  3. View transactions for a contract using GET /v1/contracts/{contract_id}/transactions.
  4. Check nominations with GET /v1/nominations.
See API Conventions for details on pagination, error handling, timestamps, and rate limiting.

​
Support

If you have any questions or need further assistance, contact us at support@otark.com.