Sign in

v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Trading
Private

Retrieves settlement, delivery, and bankruptcy events for a specific instrument that have affected your account. Settlements occur when futures or options contracts expire and are settled at the delivery price.

Results can be filtered by settlement type and timestamp. Use pagination parameters (count and continuation) to retrieve large settlement histories. This method is useful for tracking settlement events for a specific instrument.

Scope: trade:read

Try in API console

get/private/get_settlement_history_by_instrument

Query parameters

instrument_namestring required

Unique instrument identifier

Example:BTC-PERPETUAL

Instrument name

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

The type of settlement. settlement, delivery or 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
      }
    ]
  }
}