Trades (DRAFT)


GET https://isot.okte.sk/api/v1/idm/trades

Parameters

:productType
Enum (15, 60)
Type of traded product
:deliveryFrom
Date Time 8601 UTC
Start time of delivery range
:deliveryTo
Date Time 8601 UTC
End time of delivery range
:timeFrom
Date Time 8601 UTC
Start time of time range
:timeTo
Date Time 8601 UTC
End time of time range
:orderId
Integer numbers
A comma-delimited list of order IDs
:id
Integer numbers
A comma-delimited list of trade IDs
:offset
Integer number
Specifies the starting point for retrieving records. Used for pagination. Default: 0
:limit
Integer number
Defines the maximum number of records to retrieve in a single response. Default 50
Notes
One of time range parameters is required: 'DeliveryFrom' (with/without 'DeliveryTo') or 'TimeFrom' (with/without 'TimeTo') or 'OrderId' or 'Id'. For compatibility with public results API, product, skip and take parameters are supported as well.

Example

GET https://isot.okte.sk/api/v1/idm/trades?createdFrom=2024-11-13T16:58:00Z&createdFrom=2024-11-13T17:58:00Z[
  {
    "id": 112233,
    "orderId": 123456,
    "productType": 60,
    "deliveryDay": "2024-11-14",
    "deliveryStart": "2024-11-14T14:00:00Z",
    "deliveryEnd": "2024-11-14T15:00:00Z",
    "direction": "buy",
    "time": "2024-11-13T17:58:10",
    "quantity": 1.3,
    "price": 0.82
  }
]

Response fields description

Field Description Format
id Identifier Integer number
orderId Order identifier Integer number
productType Type of traded product Enum (15, 60)
deliveryDay Date of the delivery Date 8601
deliveryStart Delivery period start Date Time 8601 UTC
deliveryEnd Delivery period end Date Time 8601 UTC
direction Direction / side Enum (buy, sell)
time The time of the trade Date Time 8601 UTC
price Price in EUR/MWh Float number (two decimal places)
quantity Quantity in MW Float number (one decimal place)

Request may return HTTP status codes 200 (OK), 400 (Bad Request), 429 (Too Many Requests), or 500 (Internal Server Error).

Query error

GET https://isot.okte.sk/api/v1/idm/trades?offset=0&limit=10{
  "code": "RangeFilterRequired",
  "message": "Parameters 'DeliveryFrom' (with/without 'DeliveryTo') or 'TimeFrom' (with/without 'TimeTo') or 'OrderId' or 'Id' are required."
}

Trade list request message example (WebSocket)

WS wss://isot.okte.sk/api/v1/idm/ws?topics=trades{
  "type": "trade-list",
  "payload": {
    "correlationId": "request-20241218001",
    "productType": 60,
    "deliveryFrom": "2024-12-18T14:00:00Z",
    "deliveryTo": "2024-12-18T15:00:00Z",
    "timeFrom": "2024-12-18T14:00:00Z",
    "timeTo": "2024-12-18T15:00:00Z",
    "id": [
      112233
    ],
    "orderId": [
      123456
    ],
    "offset": 0,
    "limit": 50
  }
}

Request fields description

Field Description Format
type Message type for order list request Enum (order-list)
payload Message data TradeListFilterData object
     
TradeListFilterData    
correlationId Client message identifier String or null
productType Type of traded product Enum (15, 60) or null
deliveryFrom Start time of delivery range Date Time 8601 UTC or null
deliveryTo End time of delivery range Date Time 8601 UTC or null
timeFrom Start time of time range Date Time 8601 UTC or null
timeTo End time of time range Date Time 8601 UTC or null
orderId List of order IDs List of Integer number or null
id List of trade IDs List of Integer number or null
offset Specifies the starting point for retrieving records. Used for pagination. Default: 0 Integer number or null
limit Defines the maximum number of records to retrieve in a single response. Default 50 Integer number or null

One of time range parameters is required: 'DeliveryFrom' (with/without 'DeliveryTo') or 'TimeFrom' (with/without 'CreatedTo'), or Id or OrderId.

The earliest allowed value for any *From field is start of the previous calendar day. Id and OrderId are limited to 1000 ids.

Trade list response message example (WebSocket)

WS wss://isot.okte.sk/api/v1/idm/ws?topics=trades{
  "type": "trade-list",
  "payload": {
    "correlationId": "request-20241218001",
    "offset": 300,
    "limit": 100,
    "hasNext": true,
    "data": [
      {
        "id": 112233,
        "orderId": 123456,
        "productType": 60,
        "deliveryDay": "2024-11-14",
        "deliveryStart": "2024-11-14T14:00:00Z",
        "deliveryEnd": "2024-11-14T15:00:00Z",
        "direction": "buy",
        "time": "2024-11-13T17:58:10",
        "quantity": 1.3,
        "price": 0.82
      }
    ]
  }
}

Response fields description

Field Description Format
type Message type for order list response Enum (trade-list)
payload Message data OperationData object
     
OperationData    
correlationId Client message identifier String or null
offset The zero-based index of the first item included in the current page of results. It represents how many items were skipped from the beginning of the full result set. Integer number
limit The maximum number of items returned in the current response. This defines the page size used for pagination. Integer number
hasNext Indicates whether additional pages of data are available after the current response Boolean (true, false)
data Trades Array of Trade objects (see above)

 

Change message example

WS  wss://isot.okte.sk/api/v1/idm/ws?topics=trades{
  "type": "trade-change",
  "payload": {
    "id": 112233,
    "orderId": 123456,
    "productType": 60,
    "deliveryDay": "2024-11-14",
    "deliveryStart": "2024-11-14T14:00:00Z",
    "deliveryEnd": "2024-11-14T15:00:00Z",
    "direction": "buy",
    "time": "2024-11-13T17:58:10",
    "quantity": 1.3,
    "price": 0.82
  }
}

payload of trade-change message is same as Trade object above.