EBXv1

API reference

Introduction

A REST API over JSON for managing and interacting with your energy assets.

Base URL
https://api.ebx.energy/v1
Timestamps
UTC · ISO 8601
Auth
Authorization: Bearer <access_token>

Endpoints

Assets

5

List, create, get, update and delete assets.

Open →

Virtual segmentation

4

Get, replace, activate and delete an asset’s virtual segmentation.

Open →

Unavailability

4

Get, schedule, shorten and delete asset unavailability.

Open →

Power & energy limits

11

Set, shorten and delete power and energy limits; read curtailment.

Open →

Restriction requests

6

Submit, list, approve, reject and cancel restriction requests.

Open →

Dispatch

6

Set immediate or scheduled dispatch; read its history and forecast.

Open →

Telemetry

3

Read asset state, state history and the planned state view.

Open →

Markets · FCR

7

Submit, update and delete FCR bids; read intervals and results.

Open →

Markets · aFRR

19

aFRR capacity and energy bids, intervals, results and backup markets.

Open →

Alarms

13

List, acknowledge and mute alarms; read the rule catalogue.

Open →

Reporting & settlement

8

aFRR dispatch and performance reports; settlement over a range.

Open →

Onboarding

80

Onboarding workflows, gates, DPL, RfI, documents and PQ submission.

Open →

Users & access

7

List, create and delete users; update their scopes.

Open →

Integrations

6

List, create and delete machine to machine integrations and secrets.

Open →

Optimizers

1

Read the public profile of the optimiser acting for your assets.

Open →

Pools (beta)

6

List, create, get, update and delete organisation pools. Beta.

Open →

Send feedback

This goes straight to the docs team on Slack, with the page you are on. It is not attributed to you, so say who you are if you would like an answer.

0/2000