Orders list
GET https://isot.okte.sk/api/v1/idm/orders
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 |
|
:createdFrom
|
Date Time 8601 UTC Start time of createdAt range |
|
:createdTo
|
Date Time 8601 UTC End time of createdAt range |
|
:updatedFrom
|
Date Time 8601 UTC Start time of updatedAt range |
|
:updatedTo
|
Date Time 8601 UTC End time of updatedAt range |
|
:status
|
Enum (active, inactive, canceled, partiallyMatched, matched, expired, expiredInactive) A comma-delimited list of statuses of own orders. Default: "all" |
|
:groupId
DRAFT |
Integer numbers A comma-delimited list of group IDs for linked and rejectAll group |
|
:expandTrades
|
Enum (true, false) Specifies whether trades information should be included in response. Default: false |
|
: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 'CreatedFrom' (with/without 'CreatedTo') or 'UpdatedFrom' (with/without 'UpdatedTo'). For compatibility with public results API, productType, skip and take parameters are supported as well. |
|
Example
GET https://isot.okte.sk/api/v1/idm/orders?status=matched&createdFrom=2024-11-13T16:58:00Z&expandTrades=true[
{
"id": 123456,
"groupId": null,
"type": "simple",
"productType": 60,
"deliveryDay": "2024-11-14",
"deliveryStart": "2024-11-14T14:00:00Z",
"deliveryEnd": "2024-11-14T15:00:00Z",
"direction": "buy",
"quantity": 1.3,
"price": 0.82,
"peakQuantity": null,
"peakPriceDelta": null,
"status": "matched",
"isPending": false,
"realizedQuantity": 1.3,
"realizedPriceWeighted": 60.11,
"remainingQuantity": 0,
"expiration": null,
"note": "just my note",
"clientOrderId": "00001",
"createdAt": "2024-11-13T16:58:10Z",
"updatedAt": "2024-11-13T16:58:16Z",
"createdBy": "tester01",
"trades": [
{
"id": 112233,
"time": "2024-11-13T17:58:10",
"price": 60.11,
"quantity": 1.3
}
]
}
]
Response fields description
| Field | Description | Format |
| id | Identifier | Integer number |
| groupId DRAFT | Group identifier | Integer number or null |
| type | Order type | Enum (simple, block, iceberg DRAFT) |
| 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) |
| quantity | Quantity in MW | Float number (one decimal place) |
| price | Price in EUR/MWh | Float number (two decimal places) |
| peakQuantity DRAFT | Peak quantity of an iceberg order in MW | Float number (one decimal place) or null |
| peakPriceDelta DRAFT | Price shift for each new part of the order related to an iceberg order in EUR/MWh | Float number (two decimal places) or null |
| status | Current order status | Enum (active, inactive, canceled, partiallyMatched, matched, expired, expiredInactive) |
| isPending | Indicator of whether the order is still being processed by the system (e.g., waiting for activation). | Boolean (true, false) |
| realizedQuantity | Realized quantity in MW | Float number (one decimal place) |
| realizedPriceWeighted | Realized price in EUR/MWh | Float number (two decimal places) |
| remainingQuantity | Remaining quantity in MW | Float number (one decimal place) |
| expiration | Time of client defined order expiration | Date Time 8601 UTC or null |
| note | Custom client note | String or null |
| clientOrderId | Custom client identificator of order | String or null |
| createdAt | The time of the order's creation | Date Time 8601 UTC |
| updatedAt | The time of the order's latest update.' | Date Time 8601 UTC |
| createdBy | The name of the user who created the order. | String |
| trades | Realized trades | List of Trade objects or null |
| Trade | ||
| id | Identifier | Integer number |
| 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/orders?offset=0&limit=10{
"code": "RangeFilterRequired",
"message": "Parameters 'DeliveryFrom' (with/without 'DeliveryTo') or 'CreatedFrom' (with/without 'CreatedTo') or 'UpdatedFrom' (with/without 'UpdatedTo') or 'GroupId' are required."
}
Order list request message example (WebSocket) DRAFT
WS wss://isot.okte.sk/api/v1/idm/ws?topics=orders{
"type": "order-list",
"payload": {
"correlationId": "request-20241218001",
"productType": 60,
"deliveryFrom": "2024-12-18T14:00:00Z",
"deliveryTo": "2024-12-18T15:00:00Z",
"createdFrom": "2024-12-18T14:00:00Z",
"createdTo": "2024-12-18T15:00:00Z",
"updatedFrom": "2024-12-18T14:00:00Z",
"updatedTo": "2024-12-18T15:00:00Z",
"status": [
"active"
],
"id": [
968968
],
"groupId": [
235
],
"expandTrades": false
}
}
Request fields description
| Field | Description | Format |
| type | Message type for order list request | Enum (order-list) |
| payload | Message data | OrderListData object |
| OrderListData | ||
| 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 |
| createdFrom | Start time of createdAt range | Date Time 8601 UTC or null |
| createdTo | End time of createdAt range | Date Time 8601 UTC or null |
| updatedFrom | Start time of updatedAt range | Date Time 8601 UTC or null |
| updatedTo | End time of updatedAt range | Date Time 8601 UTC or null |
| status | List of statuses of own orders. | List of Enum (active, inactive, canceled, partiallyMatched, matched, expired, expiredInactive) or null |
| id | List of order IDs | List of Integer number or null |
| groupId | List of group IDs for linked and rejectAll group | List of Integer number or null |
| expandTrades | Specifies whether trades information should be included in response. | Boolean (true, false) or null |
Pagination is done by server, splitting orders to multiple messages sent by server.
One of time range parameters is required: 'DeliveryFrom' (with/without 'DeliveryTo') or 'CreatedFrom' (with/without 'CreatedTo') or 'UpdatedFrom' (with/without 'UpdatedTo'), or Id or GroupId.
The earliest allowed value for any *From field is start of the previous calendar day. Id and GroupId are limited to 1000 ids.
Order list response message example (WebSocket) DRAFT
WS wss://isot.okte.sk/api/v1/idm/ws?topics=orders{
"type": "order-list",
"payload": {
"correlationId": "request-20241218001",
"offset": 300,
"limit": 100,
"hasNext": true,
"data": [
{
"type": "simple",
"deliveryStart": "2024-12-18T14:00:00Z",
"deliveryEnd": "2024-12-18T15:00:00Z",
"direction": "buy",
"clientOrderId": "B-0001",
"quantity": 15.2,
"price": 35.55,
"peakQuantity": null,
"peakPriceDelta": null,
"expiration": "2024-12-18T11:12:13Z",
"note": "Just my note",
"id": 968968,
"groupId": null,
"productType": 60,
"deliveryDay": "2024-12-18T00:00:00Z",
"status": "partiallyMatched",
"isPending": true,
"realizedQuantity": 10.1,
"realizedPriceWeighted": 35.55,
"remainingQuantity": 5.1,
"createdAt": "2024-12-18T10:05:03Z",
"updatedAt": "2024-12-18T10:05:03Z",
"createdBy": "Ján Prúdový"
}
]
}
}
Response fields description
| Field | Description | Format |
| type | Message type for order list response | Enum (order-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 | Orders | Array of Order objects (see above) |