---
title: "Current Balancing State (CBS) stream"
method: GET
path: "/datasets/CBS/stream"
tags: ["BMRS Datasets"]
---

# Current Balancing State (CBS) stream

`GET /datasets/CBS/stream`

This endpoint provides information on the current system balance, in accordance with the Electricity Balancing Guidelines (EBGL) article 12.3.a.

This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

## Query parameters

- `publishDateTimeFrom` string, date-time, required
- `publishDateTimeTo` string, date-time, required

## Response `200`

Data retrieved

- InsightsApiModelsResponsesTransparencyDatasetRowsCbsDatasetRow[]
  - `dataset` string, nullable
  - `documentId` string, nullable
  - `documentRevisionNumber` integer
  - `publishTime` string, date-time
  - `flowDirection` string, nullable
  - `quantity` number, double
  - `timeFrom` string, date-time
  - `timeTo` string, date-time
  - `settlementDate` string, date
  - `settlementPeriod` integer

## Other responses

- `400` — Error with query parameters - see response for details
- `429` — Too many requests
- `500` — Server error - please try again later

---

[API](https://skmtc.net/elexon/apis/bmrs-insights.md) · [All operations](https://skmtc.net/elexon/apis/bmrs-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elexon/bmrs-insights/versions/d94e9edb295e/schema)
