Skip to main content

Sneak preview

Take a look at our next release and other upcoming features and improvements. For the latest API updates, see Release notes.

What's in the next release?

The next release is version 2.9.0. We expect this to include the following:

New

Fill amounts in WebSocket order events

To allow you to track the filled amounts for your orders and calculate the average fill prices, we will add the following parameters to the order event of the Track your orders WebSocket channel:

  • filledAmount: The amount of the base currency that was filled.
  • filledAmountQuote: The amount of the quote currency that was filled.

Execution type indicator in WebSocket events

In the order event of the Track your orders WebSocket channel, we will add an executionType parameter to indicate how the order was updated. Depending on the type, it will have one of the following values: new, trade, canceled, expired, updated, triggered, or restated.

Changed

Market data not available HTTP status codes

We will return a more specific HTTP status code when market data is not available. If the market is in a halted, auction, or auctionMatching status and you send a Get order book request, we will return 409 Conflict instead of 503 Service Unavailable.

This is because there is a conflict with the current market status, not the availability of the service.

Operator ID required parameter

The operatorId will now be a required request parameter in the following requests:

Reason for order status change

We will add a new restatementReason parameter to specify the reason for the order status change, for example when an order is canceled by the Price protection checks. This parameter will be returned in the responses and events of the following requests:

Removed

orderId query parameter

We will remove the deprecated orderId query parameter from the Get orders REST API request.

tradeId query parameter

We will remove the deprecated tradeId query parameter from the Get trades REST API and WebSocket API requests.

What you need to do

  • Prepare to handle the new filledAmount and filledAmountQuote parameters in the order events.
  • Update your code to handle the new executionType parameter in the WebSocket events.
  • Update your code to handle the new HTTP status code 409 Conflict when market data is not available.
  • Always specify operatorId in the body of all order lifecycle requests.
  • Prepare to handle the new restatementReason parameter in the order lifecycle requests and events.
  • Remove the deprecated orderId and tradeId query parameters from your code.