Download OpenAPI specification:
HTTP API server for Südvolt customers to publish their nominations for the electricity balancing market
The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response — if not defined otherwise — will be JSON in the following format:
{
"message": "page not found"
}
The API is versioned following semantic versioning rules, i.e. within each major version only backwards-compatible changes are made to the API.
The major version is part of the API URL for maximum visibility into which API version a client is calling so that clients operating on resources from the /api/v1/ set of resources will always observe deterministic behaviour.
Future Nomi releases may ship changes to the API in a backwards-incompatible way by incrementing the major version number and only shipping those changes in the /api/v2/ realm of resources.
Authentication is performed through the use of API tokens obtained through the /tokens resource. The only way to authenticate to the API server at the moment is by providing the API token as a bearer token in the HTTP Authorization header:
Authentication: Bearer API_TOKEN
Retrieves one or more capacity nominations that the user has access to. Results
are returned in batches of 100 nominations each. Use the page parameter to
retrieve a particular page. Results can be filtered by a number of parameters.
| tu_code required | string >= 1 The technical unit code to filter nominations by. |
| delivery_day | string <date> Examples: delivery_day=2025-12-15 The delivery day to filter nominations by. If left empty, nominations for all delivery days are teturned. |
| product | string Enum: "FCR" "aFRR" "aFRR/mFRR" "mFRR" Examples: product=FCR product=aFRR The type of balancing product (e.g., FCR, aFRR, mFRR) to filter by. If left empty, nominations for all product types are returned. |
| page | number The result page to retrieve. If left empty, the first page is returned. |
[- {
- "tu_code": "TU-COPPERSOFT-01",
- "delivery_day": "2025-01-17",
- "resolution": "4h",
- "index": 1,
- "direction": "neg",
- "capacity": 129,
- "product_type": "FCR",
- "created_at": "2026-01-14T20:21:18.935297Z"
}
]Creates one or more capacity nominations for the given technical units. Each nomination specifies the product type, technical unit (TU), delivery times, direction, and capacity details.
| product_type required | string Enum: "FCR" "aFRR" "aFRR/mFRR" "mFRR" Examples: "FCR" "aFRR" The type of balancing product (e.g., FCR, aFRR, mFRR) |
| tu_code required | string Examples: "TU-001" Technical Unit code identifying the generation/consumption unit |
required | object (TimeRangeSlots) |
| direction required | string Enum: "neg" "negpos" "pos" Examples: "neg" Direction of regulation |
| capacity required | integer Examples: "100" The capacity amount in kW. To nominate no capacity at all for the given time slot, set this to 0. Otherwise, the value must be >= 10. |
| min_capacity_price | number or null <double> Examples: "10.5" Optional minimum capacity price threshold |
| min_energy_price | number or null <double> Examples: "50" Optional minimum energy price threshold |
| ram_flag | boolean or null Examples: "true" Optional RAM (Remedial Action Management) flag |
[- {
- "product_type": "FCR",
- "tu_code": "TU-001",
- "delivery_times": {
- "start_day": "2025-12-15",
- "end_day": "2025-12-15",
- "resolution": "PT15M",
- "slots": [
- 0,
- 1,
- 2,
- 3
]
}, - "direction": "neg",
- "capacity": 100,
- "min_capacity_price": 10.5,
- "min_energy_price": 50,
- "ram_flag": true
}
]By initiating a token request flow, a one-time code will be sent to the provided email address that can then be used to exchange the code for an API token.
foobar@example.org