---
title: "Settlement messages by settlement date and period (SMSG)"
method: GET
path: "/balancing/settlement/messages/{settlementDate}/{settlementPeriod}"
tags: ["Indicative Imbalance Settlement"]
---

# Settlement messages by settlement date and period (SMSG)

`GET /balancing/settlement/messages/{settlementDate}/{settlementPeriod}`

## Request

- Base URL: `https://data.elexon.co.uk/bmrs/api/v1`
- URL: `https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/messages/{settlementDate}/{settlementPeriod}`
- Auth: none declared

Returns settlement messages generated by the SAA for a given settlement period, relating to the data
for a settlement run.
            
Only messages generated for the latest settlement run are returned.
            
Settlement date parameter must be provided in the exact format yyyy-MM-dd.

## Path parameters

- `settlementPeriod` integer, required
- `settlementDate` string, date, required

## Query parameters

- `format` 'json' | 'xml' | 'csv'

## Response `200`

Data retrieved

- InsightsApiModelsResponsesResponseWithMetadata1InsightsApiModelsResponsesBalancingSettlementSettlementMessageResponse
  - `data` InsightsApiModelsResponsesBalancingSettlementSettlementMessageResponse[], nullable
    - `settlementDate` string, date
    - `settlementPeriod` integer
    - `startTime` string, date-time
    - `messageReceivedDateTime` string, date-time
    - `messageSeverity` string, nullable
    - `messageTypeCode` string, nullable
    - `messageType` string, nullable
    - `messageText` string, nullable
  - `metadata` InsightsApiModelsMetadataApiResponseSourceMetadata
    - `datasets` string[], nullable

## 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.dev/elexon/apis/bmrs-insights.md) - [All operations](https://skmtc.dev/elexon/apis/bmrs-insights/llms.txt) - [OpenAPI document](https://skmtc.dev/elexon/apis/bmrs-insights/revisions/d992cbaa9351?raw)
