Skip to main content
GET
/
v1
/
entities
/
{entity_id}
/
cross_margin
/
risk_parameters
Get Cross Margin Risk Parameters (Beta)
curl --request GET \
  --url https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/risk_parameters
{
  "risk_parameters": [
    {
      "asset_tier": "<string>",
      "base_ratio_long": "<string>",
      "base_ratio_short": "<string>",
      "volatility_rate_long": "<string>",
      "volatility_rate_short": "<string>",
      "volatility_low_threshold": "<string>",
      "volatility_high_threshold": "<string>",
      "liquidity_a_long": "<string>",
      "liquidity_a_short": "<string>",
      "liquidity_b_short": "<string>",
      "liquidity_threshold": "<string>",
      "basis_offset_credit_rate": "<string>"
    }
  ],
  "offset_credit_matrix_long_short": [
    {
      "tier_a": "<string>",
      "tier_b": "<string>",
      "rate": "<string>"
    }
  ],
  "offset_credit_matrix_long_long": [
    {
      "tier_a": "<string>",
      "tier_b": "<string>",
      "rate": "<string>"
    }
  ],
  "offset_credit_matrix_short_short": [
    {
      "tier_a": "<string>",
      "tier_b": "<string>",
      "rate": "<string>"
    }
  ],
  "margin_period_of_risk": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.cloud.coinbase.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Supported Products

  • Cross Margin

Path Parameters

​
entity_id
string
required

XM customer Prime Entity ID

Response

200 - application/json

A successful response.

​
risk_parameters
object[]

Current XM tier risk parameters for the entity's client tier

​
offset_credit_matrix_long_short
object[]

Offset credit rate matrix for long/short tier pairs

​
offset_credit_matrix_long_long
object[]

Offset credit rate matrix for long/long tier pairs

​
offset_credit_matrix_short_short
object[]

Offset credit rate matrix for short/short tier pairs

​
margin_period_of_risk
number<double>

Margin period of risk (number of days)