Orders modification


POST https://isot.okte.sk/api/v1/idm/orders/:orderId/:operation

Parameters

:orderId
required
Integer number
ID of own order
:operation
required
Enum (activate, deactivate, cancel)
Order operation

Order deactivation example

POST https://isot.okte.sk/api/v1/idm/orders/695896/deactivate{
  "correlationId": "695896-deact"
}

Request fields description

Field Description Format
correlationId Client message identifier String or null

 

Request may return HTTP status codes:

  • 204 (NoContent) - request processing is finished,
  • 202 (Accepted) - order processing is not finished on server side,
  • 400 (Bad Request) - request validation problem (see example here),
  • 429 (Too Many Requests) - request limit exceeded,
  • 500 (Internal Server Error).

Order deactivation message example (WebSocket)

WS wss://isot.okte.sk/api/v1/idm/ws?topics=orders{
  "type": "order-deactivate",
  "payload": {
    "id": 695896,
    "correlationId": "695896-deact"
  }
}

Request fields description

Field Description Format
type Message type for order operation Enum (order-activate, order-deactivate, order-cancel)
payload Message data OperationData object
     
OperationData    
id ID of own order Integer number
correlationId Client message identifier String or null

 

Order modification example DRAFT

PATCH https://isot.okte.sk/api/v1/idm/orders/695896{
  "correlationId": "request-20241218001",
  "quantity": 15.2,
  "price": 35.55,
  "peakQuantity": 5.5,
  "peakPriceDelta": 0.2,
  "expiration": "2024-12-18T11:12:13Z",
  "note": "Just my note"
}

Request fields description

Field Description Format
correlationId Client message identifier String or null
quantity Quantity in MW Float number (one decimal place)
price Price in EUR/MWh Float number (two decimal places)
peakQuantity Peak quantity of an iceberg order in MW Float number (one decimal place) or null
peakPriceDelta Price shift for each new part of the order related to an iceberg order in EUR/MWh Float number (two decimal places) or null
expiration Time of client defined order expiration Date Time 8601 UTC or null
note Custom client note String or null

All changeable properties must be included in the request, even those the client does not intend to change.

Request may return HTTP status codes:

  • 204 (NoContent) - request processing is finished,
  • 202 (Accepted) - order processing is not finished on server side,
  • 400 (Bad Request) - request validation problem (see example here),
  • 429 (Too Many Requests) - request limit exceeded,
  • 500 (Internal Server Error).

Orders modification message example (WebSocket) DRAFT

WS wss://isot.okte.sk/api/v1/idm/ws?topics=orders{
  "type": "order-modify",
  "payload": {
    "correlationId": "request-20241218001",
    "orders": [
      {
        "id": 968968,
        "quantity": 15.2,
        "price": 35.55,
        "peakQuantity": 5.5,
        "peakPriceDelta": 0.2,
        "expiration": "2024-12-18T11:12:13Z",
        "note": "Just my note"
      }
    ]
  }
}

Request fields description

Field Description Format
type Message type for order modification Enum (order-modify)
payload Message data ModificationData object
     
ModificationData    
correlationId Client message identifier String or null
orders List of orders modifications Array of ModificationItem
     
ModificationItem    
id Identifier Integer number
quantity Quantity in MW Float number (one decimal place)
price Price in EUR/MWh Float number (two decimal places)
peakQuantity Peak quantity of an iceberg order in MW Float number (one decimal place) or null
peakPriceDelta Price shift for each new part of the order related to an iceberg order in EUR/MWh Float number (two decimal places) or null
expiration Time of client defined order expiration Date Time 8601 UTC or null
note Custom client note String or null

All changeable properties must be included in the request, even those the client does not intend to change.