Skip to content

Omi

Other Market Information

GET /omi/other-market-information

Other Market Information

GET
/omi/other-market-information

Request limit: Each request may cover a period of up to 1 year.

  • It applies to PeriodStart and PeriodEnd if PeriodStartUpdate and PeriodEndUpdate parameters are not included in the request.

  • It applies only to PeriodStartUpdate and PeriodEndUpdate if included in the request.

Response limit: A maximum of 200 XML documents contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 200 XML documents, where offset=0 returns the first 200 documents, offset=200 returns the next 200, and so on.

Authorizations

SecurityToken
Type
API Key (query: securityToken)

Parameters

Query Parameters

documentType*

Other market information

Type
string
Required
Example"B47"
ControlArea_Domain*

EIC code of a Scheduling Area

Type
string
Required
Example"10YDE-EON------1"
periodStart*

Pattern yyyyMMddHHmm e.g. 201601010000

Type
integer
Required
Example"202409232200"
periodEnd*

Pattern yyyyMMddHHmm e.g. 201601010000

Type
integer
Required
Example"202409242200"
DocStatus

A05: Active; A09: Cancelled; A13: Withdrawn

Type
string
Example"A05"
PeriodStartUpdate

Pattern yyyyMMddHHmm e.g. 201601010000 (mandatory if PeriodStart and PeriodEnd are not defined)

Type
integer
Example"202402221000"
PeriodEndUpdate

Pattern yyyyMMddHHmm e.g. 201601010000 (mandatory if PeriodStart and PeriodEnd are not defined)

Type
integer
Example"202402231200"
Offset

Integer: Zero‑based index of the first XML document to return. The offset parameter paginates the response in batches of 200 XML documents (e.g., offset = n returns the XMLs in the range n+1 to n+200).

Type
integer
Example"12"
mRID

If mRID is included, individual versions of the particular event are queried using the rest of the parameters

Type
string
Example"NDE5ODBiYjFkM2ExMTljYTM5Mzk2ODcxNDFkZDE4MzU="

Responses

Successful response

application/xml
XML

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI