BUbullish
derivatives

Get Derivatives Positions

Get derivatives positions

get/v1/derivatives-positions

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. BTCUSDC

Example:BTCUSDC
marketType'SPOT' | 'PERPETUAL' | 'DATED_FUTURE' | 'OPTION'

market type can have the following string values "SPOT", "PERPETUAL", "DATED_FUTURE", "OPTION"

Example:SPOT

Optional - Filter for results by expiry date

optionType'CALL' | 'PUT'

option type can have the following string values "CALL", "PUT"

Example:CALL

Optional - Filter for results by option type

sort'marketType' | 'optionType'

Sorting parameter that can have the following string values "marketType", "optionType"

Example:optionType

Optional - Sort results by Market Type or Option Type

Response

OK

tradingAccountIdstring

unique trading account ID

symbolstring

market symbol. E.g. BTCUSDC

side'BUY' | 'SELL'
quantitystring

see asset value format

notionalstring

see asset value format

entryNotionalstring

see asset value format

mtmPnlstring

see asset value format

reportedMtmPnlstring

see asset value format

reportedFundingPnlstring

see asset value format

realizedPnlstring

see asset value format

settlementAssetSymbolstring

Settlement Asset Symbol

createdAtDatetimestring date-time

ISO 8601 with millisecond as string

createdAtTimestampstring string

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

updatedAtDatetimestring date-time

ISO 8601 with millisecond as string

updatedAtTimestampstring string

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

Example response

[
  {
    "tradingAccountId": "111000000000001",
    "symbol": "BTCUSDC",
    "side": "BUY",
    "quantity": "1.00000000",
    "notional": "1.0000",
    "entryNotional": "1.0000",
    "mtmPnl": "1.0000",
    "reportedMtmPnl": "1.0000",
    "reportedFundingPnl": "1.0000",
    "realizedPnl": "1.0000",
    "settlementAssetSymbol": "USDC",
    "createdAtDatetime": "2025-05-20T01:01:01.000Z",
    "createdAtTimestamp": "1621490985000",
    "updatedAtDatetime": "2025-05-20T01:01:01.000Z",
    "updatedAtTimestamp": "1621490985000",
    "greeks": {
      "delta": "0.98000000",
      "gamma": "0.01000000",
      "theta": "-0.1700",
      "vega": "0.0500"
    }
  }
]

Changes

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