Skip to main content
GET
/
v1
/
entities
/
{entity_id}
/
cross_margin
/
risk_parameters
Get Cross Margin Risk Parameters
curl --request GET \
  --url https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/risk_parameters
import requests

url = "https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/risk_parameters"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/risk_parameters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/risk_parameters",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/risk_parameters"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/risk_parameters")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/risk_parameters")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "risk_parameters": [
    {
      "asset_tier": "0",
      "base_ratio_long": "0.3540",
      "base_ratio_short": "0.4051",
      "volatility_rate_long": "0.0365",
      "volatility_rate_short": "0.0484",
      "volatility_low_threshold": "0.0385",
      "volatility_high_threshold": "0.0777",
      "liquidity_a_long": "0.132227",
      "liquidity_a_short": "0.153226",
      "liquidity_b_short": "0.634878",
      "liquidity_threshold": "0.2395",
      "basis_offset_credit_rate": "0.92"
    }
  ],
  "offset_credit_matrix_long_short": [
    {
      "tier_a": "0",
      "tier_b": "0",
      "rate": "0.4579"
    }
  ],
  "offset_credit_matrix_long_long": [
    {
      "tier_a": "0",
      "tier_b": "0",
      "rate": "0.4579"
    }
  ],
  "offset_credit_matrix_short_short": [
    {
      "tier_a": "0",
      "tier_b": "0",
      "rate": "0.4579"
    }
  ],
  "margin_period_of_risk": 5
}

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

Example:

5