# Otark

## Otark Platform

### Otark Platform

- [Introduction for Customers](https://docs.otark.com/customers/intro.md): Getting started with the Otark green energy marketplace
- [Providing Metering Data](https://docs.otark.com/customers/metering-data.md): CSV format for uploading metering data to Otark

### Customer API

- [Customer API: Introduction](https://docs.otark.com/customers/api.md): REST API for discovering green energy offers and demands on the Otark platform
- [Customer API: Authentication](https://docs.otark.com/customers/api-auth.md): How to authenticate with the Otark Customer API using API keys
- [Customer API: Pagination](https://docs.otark.com/customers/api-pagination.md): How to paginate through results in the Otark Customer API

### Assets

- [Get assets](https://docs.otark.com/customers/api/assets/get-assets.md)

### Demands

- [Get demands](https://docs.otark.com/customers/api/demands/get-demands.md)

## BRP Connect

### BRP Connect

- [Introduction for BRPs](https://docs.otark.com/brp/intro.md): Information for Balancing Responsible Parties (BRPs) working with Otark Energy

### SFTP

- [SFTP Server](https://docs.otark.com/brp/sftp-server.md): Connecting to and using the Otark SFTP server for BRP nomination exports
- [SFTP: Nomination File Formats](https://docs.otark.com/brp/sftp-formats.md): Description of the CSV and Excel export formats for BRP nomination data.
- [SFTP: Nomination File Examples](https://docs.otark.com/brp/sftp-examples.md): Downloadable example BRP nomination exports for a sample scenario

### Webhooks

- [BRP Webhooks](https://docs.otark.com/brp/webhooks.md): Real-time event notifications for BRP Portal events

### BRP API

- [BRP API: Introduction](https://docs.otark.com/brp/api.md): API for Balancing Responsible Parties to manage contracts, transactions, nominations, and customers
- [BRP API: Conventions](https://docs.otark.com/brp/api-conventions.md): Pagination, error handling, timestamps, delivery periods, and rate limiting

### Contracts

- [List contracts](https://docs.otark.com/brp/api/contracts/list-contracts.md): List contracts accessible to the authenticated BRP. Supports filtering by status, type, EIC code, delivery period, and active date.
- [Get contract](https://docs.otark.com/brp/api/contracts/get-contract.md): Retrieve a single contract by ID.

### Transactions

- [List contract transactions](https://docs.otark.com/brp/api/transactions/list-contract-transactions.md): List transactions under a specific contract. Same filters as the global transactions endpoint, minus `contract_id` and `type`.
- [List all transactions](https://docs.otark.com/brp/api/transactions/list-all-transactions.md): List all transactions across contracts. Accepts the same filters as the contract-scoped endpoint, plus contract_id and type filters.
- [Get transaction](https://docs.otark.com/brp/api/transactions/get-transaction.md): Retrieve a single transaction by ID.
- [Get transaction history](https://docs.otark.com/brp/api/transactions/get-transaction-history.md): Retrieve the full version history of a transaction, following the `previous_transaction_id` chain. Returns all versions ordered from newest to oldest.
- [Bulk get transactions](https://docs.otark.com/brp/api/transactions/bulk-get-transactions.md): Retrieve multiple transactions by ID in a single request. Limited to 100 IDs via query parameter. Non-existent or inaccessible IDs are silently omitted.
- [Bulk get transactions (POST)](https://docs.otark.com/brp/api/transactions/bulk-get-transactions-post.md): Retrieve multiple transactions by ID using a request body. Use this for large ID sets that exceed the GET query parameter limit. Non-existent or inaccessible IDs are silently omitted.

### Nominations

- [List nominations](https://docs.otark.com/brp/api/nominations/list-nominations.md): List nominations accessible to the authenticated BRP.
- [Get nomination](https://docs.otark.com/brp/api/nominations/get-nomination.md): Retrieve a single nomination with its counterparties and slots.
- [Get nomination history](https://docs.otark.com/brp/api/nominations/get-nomination-history.md): Retrieve the full version history of a nomination, following the `previous_nomination_id` chain. Returns all versions ordered from newest to oldest.
- [Bulk get nominations](https://docs.otark.com/brp/api/nominations/bulk-get-nominations.md): Retrieve multiple nominations by ID in a single request. Limited to 100 IDs via query parameter. Non-existent or inaccessible IDs are silently omitted.
- [Bulk get nominations (POST)](https://docs.otark.com/brp/api/nominations/bulk-get-nominations-post.md): Retrieve multiple nominations by ID using a request body. Use this for large ID sets that exceed the GET query parameter limit. Non-existent or inaccessible IDs are silently omitted.

### Customers

- [List customers](https://docs.otark.com/brp/api/customers/list-customers.md): List customers assigned to the authenticated BRP.
- [Get customer](https://docs.otark.com/brp/api/customers/get-customer.md): Retrieve a single customer by ID.
- [Update customer](https://docs.otark.com/brp/api/customers/update-customer.md): Update a customer's status, balance group, or metadata. Used to activate a pending customer, deactivate an existing one, change their balance group, or manage custom metadata. Metadata is merged on update — only provided keys are added or overwritten. Set a key's value to `null` to remove it.

## OpenAPI Specs

- [openapi](/openapi.yaml)
- [brp-openapi](/brp-openapi.yaml)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [German (30 pages)](https://docs.otark.com/_llms/de.txt): Documentation for German.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.