Get Margin Information

curl --request GET \
  --url https://api.prime.coinbase.com/v1/entities/{entity_id}/margin

{
  "margin_information": {
    "margin_call_records": [
      {
        "margin_call_id": "e8bbed13-fa33-41de-86d5-4335d8f08122",
        "initial_notional_amount": "123.45",
        "outstanding_notional_amount": "122.45",
        "created_at": "2023-01-01T00:00:00Z5",
        "due_at": "2023-01-01T00:00:00.000Z"
      }
    ],
    "margin_summary": {
      "entity_id": "e8bbed13-fa33-41de-86d5-4335d8f08166",
      "margin_equity": "2539231.5903575355",
      "margin_requirement": "15131.725279884091",
      "excess_deficit": "2524099.865077651",
      "pm_credit_consumed": "10000",
      "tf_credit_limit": "2000000",
      "tf_credit_consumed": "20000",
      "tf_adjusted_asset_value": "40000",
      "tf_adjusted_liability_value": "40000",
      "tf_adjusted_credit_consumed": "30000",
      "tf_adjusted_equity": "30000",
      "frozen": false,
      "tf_enabled": true,
      "pm_enabled": true,
      "market_rates": [
        {
          "symbol": "BTC",
          "rate": "27,123"
        }
      ],
      "asset_balances": [
        {
          "portfolio_id": "e8bbed13-fa33-41de-86d5-4335d8f08166",
          "symbol": "BTC",
          "amount": "4000",
          "notional_amount": "4000",
          "conversion_rate": "1000"
        }
      ],
      "tf_loans": [
        {
          "portfolio_id": "e8bbed13-fa33-41de-86d5-4335d8f08166",
          "symbol": "BTC",
          "amount": "150000",
          "notional_amount": "250000",
          "due_date": "1000"
        }
      ],
      "pm_loans": [
        {
          "portfolio_id": "e8bbed13-fa33-41de-86d5-4335d8f08166",
          "symbol": "BTC",
          "amount": "150000",
          "notional_amount": "250000",
          "due_date": "1000"
        }
      ],
      "short_collateral": [
        {
          "portfolio_id": "e8bbed13-fa33-41de-86d5-4335d8f08166",
          "symbol": "BTC",
          "amount": "150000",
          "notional_amount": "250000",
          "due_date": "1000"
        }
      ],
      "pm_credit_limit": "1000000",
      "pm_margin_limit": "200000",
      "pm_margin_consumed": "5000"
    }
  }
}

GET

entities

{entity_id}

margin

Get Margin Information

curl --request GET \
  --url https://api.prime.coinbase.com/v1/entities/{entity_id}/margin

{
  "margin_information": {
    "margin_call_records": [
      {
        "margin_call_id": "e8bbed13-fa33-41de-86d5-4335d8f08122",
        "initial_notional_amount": "123.45",
        "outstanding_notional_amount": "122.45",
        "created_at": "2023-01-01T00:00:00Z5",
        "due_at": "2023-01-01T00:00:00.000Z"
      }
    ],
    "margin_summary": {
      "entity_id": "e8bbed13-fa33-41de-86d5-4335d8f08166",
      "margin_equity": "2539231.5903575355",
      "margin_requirement": "15131.725279884091",
      "excess_deficit": "2524099.865077651",
      "pm_credit_consumed": "10000",
      "tf_credit_limit": "2000000",
      "tf_credit_consumed": "20000",
      "tf_adjusted_asset_value": "40000",
      "tf_adjusted_liability_value": "40000",
      "tf_adjusted_credit_consumed": "30000",
      "tf_adjusted_equity": "30000",
      "frozen": false,
      "tf_enabled": true,
      "pm_enabled": true,
      "market_rates": [
        {
          "symbol": "BTC",
          "rate": "27,123"
        }
      ],
      "asset_balances": [
        {
          "portfolio_id": "e8bbed13-fa33-41de-86d5-4335d8f08166",
          "symbol": "BTC",
          "amount": "4000",
          "notional_amount": "4000",
          "conversion_rate": "1000"
        }
      ],
      "tf_loans": [
        {
          "portfolio_id": "e8bbed13-fa33-41de-86d5-4335d8f08166",
          "symbol": "BTC",
          "amount": "150000",
          "notional_amount": "250000",
          "due_date": "1000"
        }
      ],
      "pm_loans": [
        {
          "portfolio_id": "e8bbed13-fa33-41de-86d5-4335d8f08166",
          "symbol": "BTC",
          "amount": "150000",
          "notional_amount": "250000",
          "due_date": "1000"
        }
      ],
      "short_collateral": [
        {
          "portfolio_id": "e8bbed13-fa33-41de-86d5-4335d8f08166",
          "symbol": "BTC",
          "amount": "150000",
          "notional_amount": "250000",
          "due_date": "1000"
        }
      ],
      "pm_credit_limit": "1000000",
      "pm_margin_limit": "200000",
      "pm_margin_consumed": "5000"
    }
  }
}

Path Parameters

entity_id

string

required

The unique ID of the entity

Response

200 - application/json

A successful response.

margin_information

object

Show child attributes

margin_information.margin_call_records

object[]

The current margin call records

Show child attributes

margin_call_id

string

The unique ID of the margin call

Example:

"e8bbed13-fa33-41de-86d5-4335d8f08122"

initial_notional_amount

string

The initial margin call amount in notional value

Example:

"123.45"

outstanding_notional_amount

string

The outstanding margin call amount in notional value

Example:

"122.45"

created_at

string

The time the margin call is created in RFC3330 format

Example:

"2023-01-01T00:00:00Z5"

due_at

string

The time the margin call is due in RFC3339 format

Example:

"2023-01-01T00:00:00.000Z"

margin_information.margin_summary

object

Show child attributes

margin_information.margin_summary.entity_id

string

The unique ID of the entity

Example:

"e8bbed13-fa33-41de-86d5-4335d8f08166"

margin_information.margin_summary.margin_equity

string

The margin equity at the entity level. Margin Equity = LMV + SMV + Trading Cash Balance + Short Collateral - Pending Withdrawals

Example:

"2539231.5903575355"

margin_information.margin_summary.margin_requirement

string

USD notional value of required equity in entity portfolios

Example:

"15131.725279884091"

margin_information.margin_summary.excess_deficit

string

margin_equity - margin_requirement

Example:

"2524099.865077651"

margin_information.margin_summary.pm_credit_consumed

string

The raw amount of portfolio margin credit used

Example:

"10000"

margin_information.margin_summary.tf_credit_limit

string

The maximum trade finance credit limit. This field is deprecated and will be removed in the future.

Example:

"2000000"

margin_information.margin_summary.tf_credit_consumed

string

The amount of trade finance credit used (USD). This field is deprecated and will be removed in the future.

Example:

"20000"

margin_information.margin_summary.tf_adjusted_asset_value

string

TF Asset Adjusted Value (USD). This field is deprecated and will be removed in the future.

Example:

"40000"

margin_information.margin_summary.tf_adjusted_liability_value

string

TF Adjusted Liability Value (USD). This field is deprecated and will be removed in the future.

Example:

"40000"

margin_information.margin_summary.tf_adjusted_credit_consumed

string

The amount of adjusted credit used. This field is deprecated and will be removed in the future.

Example:

"30000"

margin_information.margin_summary.tf_adjusted_equity

string

The amount of adjusted equity. This field is deprecated and will be removed in the future.

Example:

"30000"

margin_information.margin_summary.frozen

boolean

Whether or not a entity is frozen due to balance outstanding or other reason

Example:

false

margin_information.margin_summary.frozen_reason

string

The reason why a entity is frozen

margin_information.margin_summary.tf_enabled

boolean

Whether TF is enabled for the entity. This field is deprecated and will be removed in the future.

Example:

true

margin_information.margin_summary.pm_enabled

boolean

Whether PM is enabled for the entity

Example:

true

margin_information.margin_summary.market_rates

object[]

Market rates for the list of assets

Show child attributes

symbol

string

The currency symbol

Example:

"BTC"

rate

string

The current market rate of currency

Example:

"27,123"

margin_information.margin_summary.asset_balances

object[]

Asset Balances across portfolios

Show child attributes

portfolio_id

string

The unique ID of the portfolio

Example:

"e8bbed13-fa33-41de-86d5-4335d8f08166"

symbol

string

The currency symbol

Example:

"BTC"

amount

string

Balance amount

Example:

"4000"

notional_amount

string

Notional balance amount

Example:

"4000"

conversion_rate

string

Conversion rate

Example:

"1000"

margin_information.margin_summary.tf_loans

object[]

Trade finance debit loan amounts. This field is deprecated and will be removed in the future.

Show child attributes

portfolio_id

string

The unique ID of the portfolio

Example:

"e8bbed13-fa33-41de-86d5-4335d8f08166"

symbol

string

The currency symbol

Example:

"BTC"

amount

string

Balance amount

Example:

"150000"

notional_amount

string

Notional balance amount

Example:

"250000"

due_date

string

Settlement due date

Example:

"1000"

margin_information.margin_summary.pm_loans

object[]

Portfolio Margin debit loan amounts

Show child attributes

portfolio_id

string

The unique ID of the portfolio

Example:

"e8bbed13-fa33-41de-86d5-4335d8f08166"

symbol

string

The currency symbol

Example:

"BTC"

amount

string

Balance amount

Example:

"150000"

notional_amount

string

Notional balance amount

Example:

"250000"

due_date

string

Settlement due date

Example:

"1000"

margin_information.margin_summary.short_collateral

object[]

Short collateral amounts

Show child attributes

portfolio_id

string

The unique ID of the portfolio

Example:

"e8bbed13-fa33-41de-86d5-4335d8f08166"

symbol

string

The currency symbol

Example:

"BTC"

amount

string

Balance amount

Example:

"150000"

notional_amount

string

Notional balance amount

Example:

"250000"

due_date

string

Settlement due date

Example:

"1000"

margin_information.margin_summary.gross_market_value

string

Gross market value (GMV) = LMV + Abs (SMV)

margin_information.margin_summary.net_market_value

string

Net Market Value (NMV) = LMV + SMV

margin_information.margin_summary.long_market_value

string

Long Market Value (LMV) = Sum of positive notional for all assets

margin_information.margin_summary.non_marginable_long_market_value

string

Non_Marginable LMV: Sum of positive notional for each non-margin eligible coin

margin_information.margin_summary.short_market_value

string

Short Market Value (SMV) = Sum of negative notional for each margin eligible coin

margin_information.margin_summary.gross_leverage

string

Gross Leverage = GMV / Margin Requirement

margin_information.margin_summary.net_exposure

string

Net Exposure = (LMV + SMV) / GMV

margin_information.margin_summary.portfolio_stress_triggered

object

Show child attributes

margin_information.margin_summary.portfolio_stress_triggered.amount

string

margin add on amount

margin_information.margin_summary.portfolio_stress_triggered.add_on_type

enum<string>

default:MARGIN_ADD_ON_TYPE_UNSPECIFIED

Available options:

MARGIN_ADD_ON_TYPE_UNSPECIFIED,

SINGLE_COIN_STRESS,

CONCENTRATION_STRESS,

MACRO_STRESS,

SHORT_BIASED_STRESS

margin_information.margin_summary.pm_asset_info

object[]

PM asset info netted across the entity

Show child attributes

symbol

string

The currency symbol

amount

string

Nominal amount of the currency

price

string

Spot price for the currency

notional_amount

string

Notional amount of the currency

asset_tier

string

Asset tier of the currency

margin_eligible

boolean

Whether the currency is margin eligible

base_margin_requirement

string

Base margin requirement of the currency

base_margin_requirement_notional

string

Notional amount of the currency's base margin requirement

adv_30d

string

The 30d adv of the currency

hist_5d_vol

string

Historic 5d volatility of the currency

hist_30d_vol

string

Historic 30d volatility of the currency

hist_90d_vol

string

Historic 90d volatility of the currency

volatility_addon

string

Volatility margin addon of the currency position

liquidity_addon

string

Liquidity margin addon of the currency position

total_position_margin

string

Total position margin of the currency

short_nominal

string

Nominal short position of the currency

long_nominal

string

Nominal long position of the currency

margin_information.margin_summary.pm_credit_limit

string

PM limit that monitors gross notional borrowings (crypto + fiat)

Example:

"1000000"

margin_information.margin_summary.pm_margin_limit

string

PM limit that monitors excess deficit

Example:

"200000"

margin_information.margin_summary.pm_margin_consumed

string

The amount of the margin limit that is consumed by the excess deficit

Example:

"5000"

Get Entity Locate Availabilities

Get Portfolio Buying Power

⌘I

REST API

FIX API

Websocket Feed

Path Parameters

Response