BUbullish
history

Get Historical Hourly Derivatives Settlement

Get historical derivatives settlement.

  • supports pagination
  • filtering on settlementDatetime requires additional keywords, see filtering support
  • On a single query request you can retrieve data over a 7 day window, with the data available for the last 90 days. By default the results are returned and sorted in descending order if specific settlement datetime is not specified.
get/v1/history/derivatives-settlement

Request

Query parameters

tradingAccountIdstring

unique trading account ID

Example:111000000000001

Id of the trading account. tradingAccountId is mandatory in the query for users with multiple trading accounts. For users with a single trading account, it can be automatically retrieved from the login.

symbolstring

market symbol. E.g. BTC-USDC-PERP for PERPETUAL and BTC-USDC-20241201 for DATED FUTURE markets.

Example:BTC-USDC-20241201
settlementDatetime[gte]string date-time required

ISO 8601 with millisecond as string

Example:2025-05-20T01:01:01.000Z

start timestamp of window, ISO 8601 with millisecond as string

settlementDatetime[lte]string date-time required

ISO 8601 with millisecond as string

Example:2025-05-20T01:01:01.000Z

end timestamp of window, ISO 8601 with millisecond as string

Response

OK

tradingAccountIdstring

unique trading account ID

symbolstring

market symbol. E.g. BTC-USDC-PERP for PERPETUAL and BTC-USDC-20241201 for DATED FUTURE markets.

side'BUY' | 'SELL'
settlementQuantitystring

see asset value format

deltaTradingQuantitystring

see asset value format

mtmPnlstring

see asset value format

fundingPnlstring

see asset value format

eventTypestring

derivatives position update event types

settlementMarkPricestring

see asset value format

settlementIndexPricestring

see asset value format

settlementFundingRatestring

funding rate at which the position was settled for this past cycle. Applicable for perpetuals only.

settlementDatetimestring date-time

ISO 8601 with millisecond as string

settlementTimestampstring string

unsigned 64 bit integer value which is the number of milliseconds since EPOCH expressed as string

Example response

[
  {
    "tradingAccountId": "111000000000001",
    "symbol": "BTC-USDC-20241201",
    "side": "BUY",
    "settlementQuantity": "1.00000000",
    "deltaTradingQuantity": "1.00000000",
    "mtmPnl": "1.0000",
    "fundingPnl": "1.0000",
    "eventType": "settlementUpdate",
    "settlementMarkPrice": "1.0000",
    "settlementIndexPrice": "1.0000",
    "settlementFundingRate": "10.0",
    "settlementDatetime": "2025-05-20T01:01:01.000Z",
    "settlementTimestamp": "1621490985000"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.