Sign in

v2

OpenAPI 3.0.02026-07-311824171.4 MB
Trading
Private

Retrieves settlement, delivery, and bankruptcy events that have affected your account for a specific currency.

Settlement vs. delivery: Settlement is a daily event (at 08:00 UTC) for futures and perpetual positions that converts unrealized profit and loss into realized profit and loss. Option positions do not settle. Delivery is a one-time event that occurs when a futures or options contract expires — any remaining open position is closed at the delivery price. Delivery does not apply to perpetual or spot instruments. Both events take place at 08:00 UTC, which is why they are sometimes conflated.

Results can be filtered by settlement type and timestamp. Use pagination parameters (count and continuation) to retrieve large settlement histories. This data is useful for tracking account-affecting settlement events and understanding how contract expirations impact your account.

Scope: trade:read

Try in API console

get/private/get_settlement_history_by_currency

Query parameters

currency'BTC' | 'ETH' | 'USDC' | 'USDT' | 'EURR' required

Currency, i.e "BTC", "ETH", "USDC"

The currency symbol

type'settlement' | 'delivery' | 'bankruptcy'

The type of settlement event. settlement: daily settlement of futures and perpetual positions at 08:00 UTC, converting unrealized profit and loss into realized profit and loss (option positions do not settle). delivery: one-time expiration of a futures or options contract at 08:00 UTC, closing any remaining open position at the delivery price (does not apply to perpetual or spot instruments). bankruptcy.

Settlement type

countinteger

Number of requested items, default - 20, maximum - 1000

continuationstring
Example:xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT

Continuation token for pagination

search_start_timestampinteger

The timestamp (milliseconds since the Unix epoch)

Example:1536569522277

The latest timestamp to return result from (milliseconds since the UNIX epoch)

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": {
    "continuation": "xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT",
    "settlements": [
      {
        "funding": -0.000002511,
        "index_price": 11008.37,
        "instrument_name": "BTC-30MAR18",
        "mark_price": 11000,
        "position": 1000,
        "session_bankruptcy": 0.001160788,
        "session_profit_loss": 0.001160788,
        "session_tax": -0.001160788,
        "session_tax_rate": 0.000103333,
        "socialized": -0.001160788,
        "timestamp": 1536569522277
      }
    ]
  }
}