Get Cross Margin Overview

Path Parameters

entity_id

string

required

XM customer Prime Entity ID

Response

200 - application/json

A successful response.

overview

object

Show child attributes

overview.control_status

enum<string>

default:XM_CONTROL_STATUS_UNSPECIFIED

TRADES_AND_WITHDRAWALS: Allowed to trade and withdraw. See XM Margin Methodology for full description of when trading and withdrawals are enabled or disabled.
TRADES_ONLY: Allowed to trade but not withdraw. See XM Margin Methodology for full description of when trading and withdrawals are enabled or disabled.
SESSION_LOCKED: Not allowed to trade or withdraw. See XM Margin Methodology for full description of when trading and withdrawals are enabled or disabled.

Available options:

XM_CONTROL_STATUS_UNSPECIFIED,

TRADES_AND_WITHDRAWALS,

TRADES_ONLY,

SESSION_LOCKED

overview.call_status

enum<string>

default:XM_ENTITY_CALL_STATUS_UNSPECIFIED

XMEntityCallStatus summarizes the state of open margin calls or debit calls. When multiple calls exist, the status reflects the highest priority call type. Priority order (highest to lowest): aged > urgent > standard > debit.

ENTITY_NO_CALL: There are no margin calls or debit calls.
ENTITY_OPEN_STANDARD_CALL: There is a standard margin call. There may also be debit calls, but there are no urgent margin calls or expired calls..
ENTITY_OPEN_URGENT_CALL: There is an urgent margin call. There may also be standard margin calls or debit calls, but there are no expired calls.
ENTITY_AGED_CALL: At least one open margin call (standard or urgent) or debit call is aged. This will trigger the SESSION_LOCKED control status.
ENTITY_OPEN_DEBIT_CALL: There is a debit call. There are no standard margin calls, urgent margin calls, or expired calls.

Available options:

XM_ENTITY_CALL_STATUS_UNSPECIFIED,

ENTITY_NO_CALL,

ENTITY_OPEN_STANDARD_CALL,

ENTITY_OPEN_URGENT_CALL,

ENTITY_AGED_CALL,

ENTITY_OPEN_DEBIT_CALL

overview.margin_level

enum<string>

default:XM_MARGIN_LEVEL_UNSPECIFIED

HEALTHY_THRESHOLD: Margin level is healthy
DEFICIT_THRESHOLD: Margin level is breaching the deficit threshold (DT) which will result in the issuance of a Margin Call if this is still the case by the scheduled next Margin Call time (as defined in the margin methodology)
WARNING_THRESHOLD: Margin level is breaching the warning threshold (WT) which will result in the issuance of a Margin Call if this is still the case by the scheduled next Margin Call (as defined in the margin methodology). WT is differentiated from DT in that it means margin health is approaching the UMCT
URGENT_MARGIN_CALL_THRESHOLD: Margin level is breaching the UMCT and, as defined in the margin methodology, this will trigger an urgent margin call
LIQUIDATION_THRESHOLD: Margin level is breaching the liquidation threshold (LT) and, as defined in the margin methodology, this will trigger the SESSION_LOCKED control status and liquidation may commence.

Available options:

XM_MARGIN_LEVEL_UNSPECIFIED,

HEALTHY_THRESHOLD,

DEFICIT_THRESHOLD,

WARNING_THRESHOLD,

URGENT_MARGIN_CALL_THRESHOLD,

LIQUIDATION_THRESHOLD

overview.margin_summary

XMSummary is the realtime evaluated XM margin model, containing positions and netting info · object

Show child attributes

overview.margin_summary.margin_requirement

string

Cross Margin Margin Requirement (XMMR) notional

Example:

"10362.72"

overview.margin_summary.account_equity

string

Equity notional

Example:

"-21542.63"

overview.margin_summary.margin_excess_shortfall

string

Equity - XMMR (margin excess is > 0)

Example:

"-31891.67"

overview.margin_summary.consumed_credit

string

Credit consumed from Cross Margin Credit Limit (XMCL)

Example:

"22906.34"

overview.margin_summary.xm_credit_limit

string

XM Credit Limit (XMCL) is the maximum notional USD of total fiat and digital asset loans

Example:

"1222322.00"

overview.margin_summary.xm_margin_limit

string

XM Margin Limit (XMML) is the maximum notional USD deficit

Example:

"22123.00"

overview.margin_summary.spot_equity

string

Equity attributed by spot

Example:

"-21505.91"

overview.margin_summary.futures_equity

string

Equity attributed by futures

Example:

"-36.71"

overview.margin_summary.risk_netting_info

object

Show child attributes

overview.margin_summary.risk_netting_info.nodal_margin_requirement

string

Nodal Margin Requirement (NMR) is the margin requirement for all futures positions, derived from the Nodal model

Example:

"9243.25"

overview.margin_summary.risk_netting_info.portfolio_margin_requirement

string

Portfolio Margin Requirement (PMR) is the margin requirement for all spot positions, derived from the XM model

Example:

"9003.67"

overview.margin_summary.risk_netting_info.integrated_portfolio_margin_requirement

string

Integrated Portfolio Margin Requirement (IPMR) is the margin requirement for all spot positions + futures positions with underlying assets eligible in Portfolio Margin, via the XM model with one-leg netting

Example:

"10154.67"

overview.margin_summary.risk_netting_info.ineligible_futures_margin_requirement

string

Ineligible Futures Margin Requirement (IFMR) is the margin requirement for IPMR-ineligible futures contracts

Example:

"194.36"

overview.margin_summary.risk_netting_info.position_margin_requirement

string

Position margin requirement for all spot positions

Example:

"3376.45"

overview.margin_summary.risk_netting_info.portfolio_margin_addon

string

Portfolio margin addon for all spot positions

Example:

"5627.21"

overview.margin_summary.risk_netting_info.integrated_position_margin_requirement

string

Position margin requirement for spot + futures positions

Example:

"3376.45"

overview.margin_summary.risk_netting_info.integrated_portfolio_margin_addon

string

Portfolio margin addon for spot + futures positions

Example:

"6778.21"

overview.margin_summary.risk_netting_info.netted_futures_notional

string

Post-netting USD notional for all futures positions

Example:

"11510.00"

overview.margin_summary.risk_netting_info.total_gmv_basis

string

Total basis gross market value of all XM-eligible positions (i.e. crypto underliers)

overview.margin_summary.risk_netting_info.ipm_cash_balance

string

Integrated Portfolio Margin cash balance

Example:

"1002.94"

overview.margin_summary.risk_netting_info.integrated_scenario_addon

object

Show child attributes

overview.margin_summary.risk_netting_info.integrated_scenario_addon.amount

string

margin add on amount

overview.margin_summary.risk_netting_info.integrated_scenario_addon.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

overview.margin_summary.risk_netting_info.all_integrated_scenario_addons

object[]

All integrated scenario add-ons

Show child attributes

amount

string

margin add on amount

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

overview.margin_summary.risk_netting_info.xm_positions

XMPosition · object[]

Netted positions used in the model calculation

Show child attributes

currency

string

Position currency

Example:

"BTC"

market_price

string

Current market price

Example:

"114531.73"

margin_eligible

boolean

True if margin eligible, false otherwise

Example:

true

market_cap

string

Total market capitalization

Example:

"770000000000.00"

adv30_days

string

Average daily volume calculated over a 30-day period

Example:

"1166623585.534257"

hist5d_vol

string

Historic volatility calculated over a 5-day period

Example:

"0.010996074377389616"

hist30d_vol

string

Historic volatility calculated over a 30-day period

Example:

"0.013617999336643158"

hist90d_vol

string

Historic volatility calculated over a 90-day period

Example:

"0.015196480084775355"

margin_requirement

string

Base margin requirement for the specific asset

Example:

"0.015"

spot_balance

string

XM spot balance nominal

Example:

"-0.19652944"

spot_balance_notional

string

XM spot balance notional

Example:

"-22508.85"

spot_total_position_margin

string

Pre-netted spot total position margin

futures_balance

string

XM futures balance nominal

Example:

"-0.19652944"

futures_balance_notional

string

XM futures balance notional

Example:

"-22508.85"

futures_total_position_margin

string

Pre-netted futures total position margin

gmv_basis

string

base_requirement

string

Base margin requirement notional

liq_shorts_add_on

string

Effective liquidity add-on for the short positions

liq_longs_add_on

string

Effective liquidity add-on for the long positions

vol_shorts_add_on

string

Effective volatility add-on for the short positions

vol_longs_add_on

string

Effective volatility add-on for the long positions

vol5days_add_on

string

5-day volatility add-on

vol30days_add_on

string

30-day volatility add-on

vol90days_add_on

string

90-day volatility add-on

total_position_margin

string

Total margin required

overview.active_margin_calls

XMMarginCall contains details about a margin call in Cross Margin · object[]

List of active XM margin calls

Show child attributes

margin_call_id

string

Financing margin call UUID

Example:

"63a2577a-930d-413b-81e4-9e77765da8f9"

currency

string

Margin call currency

Example:

"USD"

initial_notional_amount

string

Call amount (notional) as of the margin call creation

Example:

"32083.26"

outstanding_notional_amount

string

Current outstanding call amount (notional)

Example:

"32083.26"

margin_call_type

enum<string>

default:XM_CALL_TYPE_UNSPECIFIED

CALL_TYPE_STANDARD: Evaluated at standard margin call evaluation time
CALL_TYPE_URGENT: Evaluated in realtime
CALL_TYPE_DEBIT: Evaluated at debit call evaluation time

Available options:

XM_CALL_TYPE_UNSPECIFIED,

CALL_TYPE_STANDARD,

CALL_TYPE_URGENT,

CALL_TYPE_DEBIT

margin_call_status

enum<string>

default:XM_CALL_STATUS_UNSPECIFIED

CALL_STATUS_OPEN: Margin call is open and not expired
CALL_STATUS_AGED: Margin call is open and it is expired
CALL_STATUS_SETTLED: Margin call is fully settled
CALL_STATUS_CANCELED: Margin call was canceled by Credit Risk

Available options:

XM_CALL_STATUS_UNSPECIFIED,

CALL_STATUS_OPEN,

CALL_STATUS_AGED,

CALL_STATUS_SETTLED,

CALL_STATUS_CANCELED

called_with_margin_level

enum<string>

default:XM_MARGIN_LEVEL_UNSPECIFIED

HEALTHY_THRESHOLD: Margin level is healthy
DEFICIT_THRESHOLD: Margin level is breaching the deficit threshold (DT) which will result in the issuance of a Margin Call if this is still the case by the scheduled next Margin Call time (as defined in the margin methodology)
WARNING_THRESHOLD: Margin level is breaching the warning threshold (WT) which will result in the issuance of a Margin Call if this is still the case by the scheduled next Margin Call (as defined in the margin methodology). WT is differentiated from DT in that it means margin health is approaching the UMCT
URGENT_MARGIN_CALL_THRESHOLD: Margin level is breaching the UMCT and, as defined in the margin methodology, this will trigger an urgent margin call
LIQUIDATION_THRESHOLD: Margin level is breaching the liquidation threshold (LT) and, as defined in the margin methodology, this will trigger the SESSION_LOCKED control status and liquidation may commence.

Available options:

XM_MARGIN_LEVEL_UNSPECIFIED,

HEALTHY_THRESHOLD,

DEFICIT_THRESHOLD,

WARNING_THRESHOLD,

URGENT_MARGIN_CALL_THRESHOLD,

LIQUIDATION_THRESHOLD

called_with_margin_summary

XMSummary is the realtime evaluated XM margin model, containing positions and netting info · object

Show child attributes

called_with_margin_summary.margin_requirement

string

Cross Margin Margin Requirement (XMMR) notional

Example:

"10362.72"

called_with_margin_summary.account_equity

string

Equity notional

Example:

"-21542.63"

called_with_margin_summary.margin_excess_shortfall

string

Equity - XMMR (margin excess is > 0)

Example:

"-31891.67"

called_with_margin_summary.consumed_credit

string

Credit consumed from Cross Margin Credit Limit (XMCL)

Example:

"22906.34"

called_with_margin_summary.xm_credit_limit

string

XM Credit Limit (XMCL) is the maximum notional USD of total fiat and digital asset loans

Example:

"1222322.00"

called_with_margin_summary.xm_margin_limit

string

XM Margin Limit (XMML) is the maximum notional USD deficit

Example:

"22123.00"

called_with_margin_summary.spot_equity

string

Equity attributed by spot

Example:

"-21505.91"

called_with_margin_summary.futures_equity

string

Equity attributed by futures

Example:

"-36.71"

called_with_margin_summary.risk_netting_info

object

Show child attributes

called_with_margin_summary.risk_netting_info.nodal_margin_requirement

string

Nodal Margin Requirement (NMR) is the margin requirement for all futures positions, derived from the Nodal model

Example:

"9243.25"

called_with_margin_summary.risk_netting_info.portfolio_margin_requirement

string

Portfolio Margin Requirement (PMR) is the margin requirement for all spot positions, derived from the XM model

Example:

"9003.67"

called_with_margin_summary.risk_netting_info.integrated_portfolio_margin_requirement

string

Example:

"10154.67"

called_with_margin_summary.risk_netting_info.ineligible_futures_margin_requirement

string

Ineligible Futures Margin Requirement (IFMR) is the margin requirement for IPMR-ineligible futures contracts

Example:

"194.36"

called_with_margin_summary.risk_netting_info.position_margin_requirement

string

Position margin requirement for all spot positions

Example:

"3376.45"

called_with_margin_summary.risk_netting_info.portfolio_margin_addon

string

Portfolio margin addon for all spot positions

Example:

"5627.21"

called_with_margin_summary.risk_netting_info.integrated_position_margin_requirement

string

Position margin requirement for spot + futures positions

Example:

"3376.45"

called_with_margin_summary.risk_netting_info.integrated_portfolio_margin_addon

string

Portfolio margin addon for spot + futures positions

Example:

"6778.21"

called_with_margin_summary.risk_netting_info.netted_futures_notional

string

Post-netting USD notional for all futures positions

Example:

"11510.00"

called_with_margin_summary.risk_netting_info.total_gmv_basis

string

Total basis gross market value of all XM-eligible positions (i.e. crypto underliers)

called_with_margin_summary.risk_netting_info.ipm_cash_balance

string

Integrated Portfolio Margin cash balance

Example:

"1002.94"

called_with_margin_summary.risk_netting_info.integrated_scenario_addon

object

Show child attributes

called_with_margin_summary.risk_netting_info.integrated_scenario_addon.amount

string

margin add on amount

called_with_margin_summary.risk_netting_info.integrated_scenario_addon.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

called_with_margin_summary.risk_netting_info.all_integrated_scenario_addons

object[]

All integrated scenario add-ons

Show child attributes

amount

string

margin add on amount

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

called_with_margin_summary.risk_netting_info.xm_positions

XMPosition · object[]

Netted positions used in the model calculation

Show child attributes

currency

string

Position currency

Example:

"BTC"

market_price

string

Current market price

Example:

"114531.73"

margin_eligible

boolean

True if margin eligible, false otherwise

Example:

true

market_cap

string

Total market capitalization

Example:

"770000000000.00"

adv30_days

string

Average daily volume calculated over a 30-day period

Example:

"1166623585.534257"

hist5d_vol

string

Historic volatility calculated over a 5-day period

Example:

"0.010996074377389616"

hist30d_vol

string

Historic volatility calculated over a 30-day period

Example:

"0.013617999336643158"

hist90d_vol

string

Historic volatility calculated over a 90-day period

Example:

"0.015196480084775355"

margin_requirement

string

Base margin requirement for the specific asset

Example:

"0.015"

spot_balance

string

XM spot balance nominal

Example:

"-0.19652944"

spot_balance_notional

string

XM spot balance notional

Example:

"-22508.85"

spot_total_position_margin

string

Pre-netted spot total position margin

futures_balance

string

XM futures balance nominal

Example:

"-0.19652944"

futures_balance_notional

string

XM futures balance notional

Example:

"-22508.85"

futures_total_position_margin

string

Pre-netted futures total position margin

gmv_basis

string

base_requirement

string

Base margin requirement notional

liq_shorts_add_on

string

Effective liquidity add-on for the short positions

liq_longs_add_on

string

Effective liquidity add-on for the long positions

vol_shorts_add_on

string

Effective volatility add-on for the short positions

vol_longs_add_on

string

Effective volatility add-on for the long positions

vol5days_add_on

string

5-day volatility add-on

vol30days_add_on

string

30-day volatility add-on

vol90days_add_on

string

90-day volatility add-on

total_position_margin

string

Total margin required

due_at

string<date-time>

Timestamp when the margin call settlement is due

created_at

string<date-time>

Timestamp when the margin call was created

updated_at

string<date-time>

Timestamp when the margin call was last updated

overview.active_loans

XMLoan contains details about a Cross Margin loan · object[]

List of active XM loans

Show child attributes

loan_id

string

Financing loan UUID

Example:

"b91a0ed6-eeec-4496-a04e-98b72b33c2b4"

loan_party

enum<string>

default:XM_PARTY_UNSPECIFIED

CBE: Coinbase Exchange, trading venue that can receive the XM loan
FCM: Coinbase’s Futures Commission Merchant, trading venue that can receive the XM loan

Available options:

XM_PARTY_UNSPECIFIED,

CBE,

FCM

principal_currency

string

Loan principal currency

Example:

"BTC"

principal_currency_market_price

string

Loan principal currency market price

Example:

"114531.73"

initial_principal_amount

string

Principal amount (nominal) as of loan initiation

Example:

"0.2"

outstanding_principal_amount

string

Current outstanding amount (nominal)

Example:

"0.2"

created_at

string<date-time>

Timestamp when the loan was created / initiated

updated_at

string<date-time>

Timestamp when the loan was last updated

REST API

FIX API

Websocket Feed

Path Parameters

Response