# Introduction

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

API reference

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 →](https://docs.ebx.energy/reference/assets.md)

### Virtual segmentation

4

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

[Open →](https://docs.ebx.energy/reference/segmentation.md)

### Unavailability

4

Get, schedule, shorten and delete asset unavailability.

[Open →](https://docs.ebx.energy/reference/unavailability.md)

### Power & energy limits

11

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

[Open →](https://docs.ebx.energy/reference/limits.md)

### Restriction requests

6

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

[Open →](https://docs.ebx.energy/reference/restrictions.md)

### Dispatch

6

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

[Open →](https://docs.ebx.energy/reference/dispatch.md)

### Telemetry

3

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

[Open →](https://docs.ebx.energy/reference/telemetry.md)

### Markets · FCR

7

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

[Open →](https://docs.ebx.energy/reference/fcr.md)

### Markets · aFRR

19

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

[Open →](https://docs.ebx.energy/reference/afrr.md)

### Alarms

13

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

[Open →](https://docs.ebx.energy/reference/alarms.md)

### Reporting & settlement

8

aFRR dispatch and performance reports; settlement over a range.

[Open →](https://docs.ebx.energy/reference/reporting.md)

### Onboarding

80

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

[Open →](https://docs.ebx.energy/reference/onboarding.md)

### Users & access

7

List, create and delete users; update their scopes.

[Open →](https://docs.ebx.energy/reference/users.md)

### Integrations

6

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

[Open →](https://docs.ebx.energy/reference/integrations.md)

### Optimizers

1

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

[Open →](https://docs.ebx.energy/reference/optimizers.md)

### Pools (beta)

6

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

[Open →](https://docs.ebx.energy/reference/pools.md)