Settlement - One Trading API

You must be authenticated and subscribed to the TRADING channel in order to receive SETTLEMENT messages.

The SETTLEMENT message is sent via the trading channel every minute for any account with an open futures position. This message provides a real-time update of the account’s settlement details, reflecting the profit and margin changes associated with the position.

{
    "type": "SETTLEMENT",
    "channel_name": "TRADING",
    "instrument_code": "BTC_EUR_P",
    "time": 1737993490000000000,
    "direction": "LONG",
    "open_position": "1030",
    "open_volume": "0.01",
    "pending_buy_size": "0",
    "pending_sell_size": "0",
    "profit": "1.13",
    "total_profit": "1250",
    "account_ratio": "2.57",
    "maintenance_margin": "595",
    "quote_currency_balance": "5000",
    "margin_used": "101",
    "mark_price": "103000"
}

TradingSettlement

type

string

required

Always set to SETTLEMENT to identify the message type.

channel_name

string

required

Always set to TRADING to indicate the trading channel.

instrument_code

string

required

The unique identifier for the perpetual futures market (e.g., BTC_EUR_P).

time

integer

required

The timestamp of the settlement, represented in nanoseconds since the Unix epoch.

direction

enum<string>

required

Indicates the direction of the open position, either LONG or SHORT.

Allowed values:

LONGSHORT

open_position

string

required

open_volume

string

required

The current open contract volume for the position.

pending_buy_size

string

required

The size of any pending buy orders for the instrument.

pending_sell_size

string

required

The size of any pending sell orders for the instrument.

profit

string

required

The profit or loss realised in this specific minutely settlement interval, expressed in the quote currency.

total_profit

string

required

The cumulative profit or loss realised for the position since it was opened, expressed in the quote currency.

account_ratio

string

required

he current margin ratio, reflecting the account’s margin health.

maintenance_margin

string

required

The minimum margin required to maintain the open position.

quote_currency_balance

string

required

The account's remaining balance in the quote currency after accounting for positions and settlements.

margin_used

string

required

The total margin currently being used for the open position.

mark_price

string

required

The current mark price of the instrument used for the minutely settlement calculation.