Get US Derivatives Balance Summary - Coinbase Developer Documentation

Get Futures Balance Summary

curl --request GET \
  --url https://api.coinbase.com/api/v3/brokerage/cfm/balance_summary \
  --header 'Authorization: Bearer <token>'

{
  "balance_summary": {
    "futures_buying_power": {
      "value": "<string>",
      "currency": "<string>"
    },
    "total_usd_balance": {
      "value": "<string>",
      "currency": "<string>"
    },
    "cbi_usd_balance": {
      "value": "<string>",
      "currency": "<string>"
    },
    "cfm_usd_balance": {
      "value": "<string>",
      "currency": "<string>"
    },
    "total_open_orders_hold_amount": {
      "value": "<string>",
      "currency": "<string>"
    },
    "unrealized_pnl": {
      "value": "<string>",
      "currency": "<string>"
    },
    "daily_realized_pnl": {
      "value": "<string>",
      "currency": "<string>"
    },
    "initial_margin": {
      "value": "<string>",
      "currency": "<string>"
    },
    "available_margin": {
      "value": "<string>",
      "currency": "<string>"
    },
    "liquidation_threshold": {
      "value": "<string>",
      "currency": "<string>"
    },
    "liquidation_buffer_amount": {
      "value": "<string>",
      "currency": "<string>"
    },
    "liquidation_buffer_percentage": "<string>",
    "intraday_margin_window_measure": {
      "margin_window_type": "FCM_MARGIN_WINDOW_TYPE_UNSPECIFIED",
      "margin_level": "MARGIN_LEVEL_TYPE_UNSPECIFIED",
      "initial_margin": "<string>",
      "maintenance_margin": "<string>",
      "liquidation_buffer": "<string>",
      "total_hold": "<string>",
      "futures_buying_power": "<string>"
    },
    "overnight_margin_window_measure": {
      "margin_window_type": "FCM_MARGIN_WINDOW_TYPE_UNSPECIFIED",
      "margin_level": "MARGIN_LEVEL_TYPE_UNSPECIFIED",
      "initial_margin": "<string>",
      "maintenance_margin": "<string>",
      "liquidation_buffer": "<string>",
      "total_hold": "<string>",
      "futures_buying_power": "<string>"
    },
    "total_pending_transfers_amount": {
      "value": "<string>",
      "currency": "<string>"
    },
    "funding_pnl": {
      "value": "<string>",
      "currency": "<string>"
    }
  }
}

GET

api

brokerage

cfm

balance_summary

Get Futures Balance Summary

curl --request GET \
  --url https://api.coinbase.com/api/v3/brokerage/cfm/balance_summary \
  --header 'Authorization: Bearer <token>'

{
  "balance_summary": {
    "futures_buying_power": {
      "value": "<string>",
      "currency": "<string>"
    },
    "total_usd_balance": {
      "value": "<string>",
      "currency": "<string>"
    },
    "cbi_usd_balance": {
      "value": "<string>",
      "currency": "<string>"
    },
    "cfm_usd_balance": {
      "value": "<string>",
      "currency": "<string>"
    },
    "total_open_orders_hold_amount": {
      "value": "<string>",
      "currency": "<string>"
    },
    "unrealized_pnl": {
      "value": "<string>",
      "currency": "<string>"
    },
    "daily_realized_pnl": {
      "value": "<string>",
      "currency": "<string>"
    },
    "initial_margin": {
      "value": "<string>",
      "currency": "<string>"
    },
    "available_margin": {
      "value": "<string>",
      "currency": "<string>"
    },
    "liquidation_threshold": {
      "value": "<string>",
      "currency": "<string>"
    },
    "liquidation_buffer_amount": {
      "value": "<string>",
      "currency": "<string>"
    },
    "liquidation_buffer_percentage": "<string>",
    "intraday_margin_window_measure": {
      "margin_window_type": "FCM_MARGIN_WINDOW_TYPE_UNSPECIFIED",
      "margin_level": "MARGIN_LEVEL_TYPE_UNSPECIFIED",
      "initial_margin": "<string>",
      "maintenance_margin": "<string>",
      "liquidation_buffer": "<string>",
      "total_hold": "<string>",
      "futures_buying_power": "<string>"
    },
    "overnight_margin_window_measure": {
      "margin_window_type": "FCM_MARGIN_WINDOW_TYPE_UNSPECIFIED",
      "margin_level": "MARGIN_LEVEL_TYPE_UNSPECIFIED",
      "initial_margin": "<string>",
      "maintenance_margin": "<string>",
      "liquidation_buffer": "<string>",
      "total_hold": "<string>",
      "futures_buying_power": "<string>"
    },
    "total_pending_transfers_amount": {
      "value": "<string>",
      "currency": "<string>"
    },
    "funding_pnl": {
      "value": "<string>",
      "currency": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Creating API Keys section of our Coinbase App Authentication docs for information on how to generate your Bearer Token.

Response

A successful response.

balance_summary

object

Show child attributes

balance_summary.futures_buying_power

Message that represents the monetary amount. · object

The amount of your cash balance that is available to trade CFM futures

Show child attributes

balance_summary.futures_buying_power.value

string

balance_summary.futures_buying_power.currency

string

balance_summary.total_usd_balance

Message that represents the monetary amount. · object

Aggregate USD maintained across your CFTC-regulated futures account and your Coinbase Inc. spot account

Show child attributes

balance_summary.total_usd_balance.value

string

balance_summary.total_usd_balance.currency

string

balance_summary.cbi_usd_balance

Message that represents the monetary amount. · object

USD maintained in your Coinbase Inc. spot account

Show child attributes

balance_summary.cbi_usd_balance.value

string

balance_summary.cbi_usd_balance.currency

string

balance_summary.cfm_usd_balance

Message that represents the monetary amount. · object

USD maintained in your CFTC-regulated futures account. Funds held in your futures account are not available to trade spot

Show child attributes

balance_summary.cfm_usd_balance.value

string

balance_summary.cfm_usd_balance.currency

string

balance_summary.total_open_orders_hold_amount

Message that represents the monetary amount. · object

Your total balance on hold for spot and futures open orders

Show child attributes

balance_summary.total_open_orders_hold_amount.value

string

balance_summary.total_open_orders_hold_amount.currency

string

balance_summary.unrealized_pnl

Message that represents the monetary amount. · object

Your current unrealized PnL across all open positions

Show child attributes

balance_summary.unrealized_pnl.value

string

balance_summary.unrealized_pnl.currency

string

balance_summary.daily_realized_pnl

Message that represents the monetary amount. · object

Your realized PnL from the current trade date. May include profit or loss from positions you've closed on the current trade date

Show child attributes

balance_summary.daily_realized_pnl.value

string

balance_summary.daily_realized_pnl.currency

string

balance_summary.initial_margin

Message that represents the monetary amount. · object

Margin required to initiate futures positions. Once futures orders are placed, these funds cannot be used to trade spot. The actual amount of funds necessary to support executed futures orders will be moved to your futures account

Show child attributes

balance_summary.initial_margin.value

string

balance_summary.initial_margin.currency

string

balance_summary.available_margin

Message that represents the monetary amount. · object

Funds available to meet your anticipated margin requirement. This includes your CBI spot USD, CFM futures USD, and Futures PnL, less any holds for open spot or futures orders

Show child attributes

balance_summary.available_margin.value

string

balance_summary.available_margin.currency

string

balance_summary.liquidation_threshold

Message that represents the monetary amount. · object

When your available funds for collateral drop to the liquidation threshold, some or all of your futures positions will be liquidated

Show child attributes

balance_summary.liquidation_threshold.value

string

balance_summary.liquidation_threshold.currency

string

balance_summary.liquidation_buffer_amount

Message that represents the monetary amount. · object

Funds available in excess of the liquidation threshold, calculated as available margin minus liquidation threshold. If your liquidation buffer amount reaches 0, your futures positions and/or open orders will be liquidated as necessary

Show child attributes

balance_summary.liquidation_buffer_amount.value

string

balance_summary.liquidation_buffer_amount.currency

string

balance_summary.liquidation_buffer_percentage

string

Funds available in excess of the liquidation threshold expressed as a percentage. If your liquidation buffer percentage reaches 0%, your futures positions and/or open orders will be liquidated as necessary

balance_summary.intraday_margin_window_measure

object

Show child attributes

balance_summary.intraday_margin_window_measure.margin_window_type

enum<string>

default:FCM_MARGIN_WINDOW_TYPE_UNSPECIFIED

Your margin window

Available options:

FCM_MARGIN_WINDOW_TYPE_UNSPECIFIED,

FCM_MARGIN_WINDOW_TYPE_OVERNIGHT,

FCM_MARGIN_WINDOW_TYPE_WEEKEND,

FCM_MARGIN_WINDOW_TYPE_INTRADAY,

FCM_MARGIN_WINDOW_TYPE_TRANSITION

balance_summary.intraday_margin_window_measure.margin_level

enum<string>

default:MARGIN_LEVEL_TYPE_UNSPECIFIED

Margin level for liquidation purposes

Available options:

MARGIN_LEVEL_TYPE_UNSPECIFIED,

MARGIN_LEVEL_TYPE_BASE,

MARGIN_LEVEL_TYPE_WARNING,

MARGIN_LEVEL_TYPE_DANGER,

MARGIN_LEVEL_TYPE_LIQUIDATION

balance_summary.intraday_margin_window_measure.initial_margin

string

Initial margin

balance_summary.intraday_margin_window_measure.maintenance_margin

string

Maintenance margin

balance_summary.intraday_margin_window_measure.liquidation_buffer

string

Liquidation buffer

balance_summary.intraday_margin_window_measure.total_hold

string

Total Hold

balance_summary.intraday_margin_window_measure.futures_buying_power

string

The amount of your cash balance that is available to trade CFM futures

balance_summary.overnight_margin_window_measure

object

Show child attributes

balance_summary.overnight_margin_window_measure.margin_window_type

enum<string>

default:FCM_MARGIN_WINDOW_TYPE_UNSPECIFIED

Your margin window

Available options:

FCM_MARGIN_WINDOW_TYPE_UNSPECIFIED,

FCM_MARGIN_WINDOW_TYPE_OVERNIGHT,

FCM_MARGIN_WINDOW_TYPE_WEEKEND,

FCM_MARGIN_WINDOW_TYPE_INTRADAY,

FCM_MARGIN_WINDOW_TYPE_TRANSITION

balance_summary.overnight_margin_window_measure.margin_level

enum<string>

default:MARGIN_LEVEL_TYPE_UNSPECIFIED

Margin level for liquidation purposes

Available options:

MARGIN_LEVEL_TYPE_UNSPECIFIED,

MARGIN_LEVEL_TYPE_BASE,

MARGIN_LEVEL_TYPE_WARNING,

MARGIN_LEVEL_TYPE_DANGER,

MARGIN_LEVEL_TYPE_LIQUIDATION

balance_summary.overnight_margin_window_measure.initial_margin

string

Initial margin

balance_summary.overnight_margin_window_measure.maintenance_margin

string

Maintenance margin

balance_summary.overnight_margin_window_measure.liquidation_buffer

string

Liquidation buffer

balance_summary.overnight_margin_window_measure.total_hold

string

Total Hold

balance_summary.overnight_margin_window_measure.futures_buying_power

string

The amount of your cash balance that is available to trade CFM futures

balance_summary.total_pending_transfers_amount

Message that represents the monetary amount. · object

Total value of pending transfers

Show child attributes

balance_summary.total_pending_transfers_amount.value

string

balance_summary.total_pending_transfers_amount.currency

string

balance_summary.funding_pnl

Message that represents the monetary amount. · object

Portfolio funding PnL (only for US Perpetuals Futures)

Show child attributes

balance_summary.funding_pnl.value

string

balance_summary.funding_pnl.currency

string

Get Current Margin Window

Get US Derivatives Position

⌘I

REST API

Authorizations

Response