Evaluation of the Public Consultation on the Change of Technical Specifications of External Interfaces for ISOT
Exceptional service maintenance of SANDBOX on 12/20/2024
Exceptional service maintenance of SANDBOX
Exceptional service maintenance of information systems ISZO and ISOT on 12/19/2024

Introduction

 

The XMtrade®/ISOT private API enables clients to perform key operations in the intraday market trading system, including:

  • Order Management:
    Download, create, and modify own orders, and receive real-time updates on changes to those orders.

  • Orderbook Access:
    Download the orderbook and receive live updates.

  • Transfer Capacities:
    Download available transfer capacities and receive updates on changes.

  • Market Trading Status:
    Receive notifications about changes in market trading status.

All updates are delivered via a WebSocket connection.

 

Authentication

To access the intraday market trading API, clients must have:

  • A valid account in XMtrade®/ISOT.
  • A valid agreement for short term market trading.
  • A configured client certificate.

The API and WebSocket connections use a combination of:

  1. Basic Authentication: Username and password provided in the Authorization header.
  2. Client Certificate: A handshake is initiated by the server to validate the certificate.

 

Content Type

Both the API and WebSocket only support requests and server responses with Content-Type: application/json. null fields may be omitted.

 

Rate Limiting

The API enforces rate limiting to ensure fair usage and prevent abuse. When a client exceeds the allowed request limit, the server responds with a 429 Too Many Requests status code.

The following headers are included in the response to provide additional details:

  • X-RateLimit-Policy: The applied rate-limiting policy (e.g., 50;w=10 for 50 requests per 10 seconds).
  • X-RateLimit-Limit: The maximum number of requests allowed in the current window.
  • X-RateLimit-Remaining: The number of remaining requests within the current window.
  • X-RateLimit-Reset: The time (in seconds) until the request counter resets.

Clients exceeding the limit must wait until the reset time before retrying.

 

Pagination Headers

Endpoints that support pagination include the following headers in the response:

  • X-Page-Offset: The current offset used for the retrieved data.
  • X-Page-Limit: The maximum number of records returned in the response.
  • X-Page-HasNext: Indicates whether there are more pages available (true or false).

These headers help clients manage and navigate paginated data efficiently.

 

SOAP interface and AMQP protocol

In addition to the API and WebSocket, a SOAP interface and an interface based on the AMQP protocol are also available. For detailed documentation on these interfaces, please refer to the relevant technical specification.