Get Cross Margin Liquidation
curl --request GET \
--url https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/liquidationimport requests
url = "https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/liquidation"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/liquidation', 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/liquidation",
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/liquidation"
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/liquidation")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/liquidation")
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{
"liquidation": {
"liquidation_id": "63a2577a-930d-413b-81e4-9e77765da8f9",
"status": "XM_LIQUIDATION_STATUS_UNSET",
"shortfall_amount": "32083.26",
"pre_liquidation_start_time": "2023-11-07T05:31:56Z",
"margin_summary": {
"margin_requirement": "10362.72",
"account_equity": "-21542.63",
"margin_excess_shortfall": "-31891.67",
"consumed_credit": "22906.34",
"xm_credit_limit": "1222322.00",
"xm_margin_limit": "22123.00",
"spot_equity": "-21505.91",
"futures_equity": "-36.71",
"risk_netting_info": {
"dco_margin_requirement": "9243.25",
"portfolio_margin_requirement": "9003.67",
"integrated_portfolio_margin_requirement": "10154.67",
"ineligible_futures_margin_requirement": "194.36",
"position_margin_requirement": "3376.45",
"portfolio_margin_addon": "5627.21",
"integrated_position_margin_requirement": "3376.45",
"integrated_portfolio_margin_addon": "6778.21",
"netted_futures_notional": "11510.00",
"total_gmv_basis": "<string>",
"ipm_cash_balance": "1002.94",
"integrated_scenario_addon": {
"amount": "<string>",
"add_on_type": "MARGIN_ADD_ON_TYPE_UNSPECIFIED"
},
"all_integrated_scenario_addons": [
{
"amount": "<string>",
"add_on_type": "MARGIN_ADD_ON_TYPE_UNSPECIFIED"
}
],
"xm_positions": [
{
"currency": "BTC",
"market_price": "114531.73",
"margin_eligible": true,
"market_cap": "770000000000.00",
"adv30_days": "1166623585.534257",
"hist5d_vol": "0.010996074377389616",
"hist30d_vol": "0.013617999336643158",
"hist90d_vol": "0.015196480084775355",
"margin_requirement": "0.015",
"spot_balance": "-0.19652944",
"spot_balance_notional": "-22508.85",
"spot_total_position_margin": "<string>",
"futures_balance": "-0.19652944",
"futures_balance_notional": "-22508.85",
"futures_total_position_margin": "<string>",
"gmv_basis": "<string>",
"base_requirement": "<string>",
"liq_shorts_add_on": "<string>",
"liq_longs_add_on": "<string>",
"vol_shorts_add_on": "<string>",
"vol_longs_add_on": "<string>",
"vol5days_add_on": "<string>",
"vol30days_add_on": "<string>",
"vol90days_add_on": "<string>",
"total_position_margin": "<string>"
}
]
}
},
"liquidation_start_time": "2023-11-07T05:31:56Z",
"filled_amount": "15000.00",
"remaining_amount": "17083.26",
"liquidation_finish_time": "2023-11-07T05:31:56Z",
"asset_breakdown": [
{
"asset": "BTC",
"liquidated_amount": "0.1",
"liquidated_notional": "11453.17",
"remaining_amount": "0.05",
"remaining_notional": "5726.59"
}
]
}
}Financing
Get Cross Margin Liquidation
Gets detailed liquidation data for an XM customer. Returns the active or most recent liquidation by default.
GET
/
v1
/
entities
/
{entity_id}
/
cross_margin
/
liquidation
Get Cross Margin Liquidation
curl --request GET \
--url https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/liquidationimport requests
url = "https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/liquidation"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/liquidation', 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/liquidation",
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/liquidation"
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/liquidation")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prime.coinbase.com/v1/entities/{entity_id}/cross_margin/liquidation")
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{
"liquidation": {
"liquidation_id": "63a2577a-930d-413b-81e4-9e77765da8f9",
"status": "XM_LIQUIDATION_STATUS_UNSET",
"shortfall_amount": "32083.26",
"pre_liquidation_start_time": "2023-11-07T05:31:56Z",
"margin_summary": {
"margin_requirement": "10362.72",
"account_equity": "-21542.63",
"margin_excess_shortfall": "-31891.67",
"consumed_credit": "22906.34",
"xm_credit_limit": "1222322.00",
"xm_margin_limit": "22123.00",
"spot_equity": "-21505.91",
"futures_equity": "-36.71",
"risk_netting_info": {
"dco_margin_requirement": "9243.25",
"portfolio_margin_requirement": "9003.67",
"integrated_portfolio_margin_requirement": "10154.67",
"ineligible_futures_margin_requirement": "194.36",
"position_margin_requirement": "3376.45",
"portfolio_margin_addon": "5627.21",
"integrated_position_margin_requirement": "3376.45",
"integrated_portfolio_margin_addon": "6778.21",
"netted_futures_notional": "11510.00",
"total_gmv_basis": "<string>",
"ipm_cash_balance": "1002.94",
"integrated_scenario_addon": {
"amount": "<string>",
"add_on_type": "MARGIN_ADD_ON_TYPE_UNSPECIFIED"
},
"all_integrated_scenario_addons": [
{
"amount": "<string>",
"add_on_type": "MARGIN_ADD_ON_TYPE_UNSPECIFIED"
}
],
"xm_positions": [
{
"currency": "BTC",
"market_price": "114531.73",
"margin_eligible": true,
"market_cap": "770000000000.00",
"adv30_days": "1166623585.534257",
"hist5d_vol": "0.010996074377389616",
"hist30d_vol": "0.013617999336643158",
"hist90d_vol": "0.015196480084775355",
"margin_requirement": "0.015",
"spot_balance": "-0.19652944",
"spot_balance_notional": "-22508.85",
"spot_total_position_margin": "<string>",
"futures_balance": "-0.19652944",
"futures_balance_notional": "-22508.85",
"futures_total_position_margin": "<string>",
"gmv_basis": "<string>",
"base_requirement": "<string>",
"liq_shorts_add_on": "<string>",
"liq_longs_add_on": "<string>",
"vol_shorts_add_on": "<string>",
"vol_longs_add_on": "<string>",
"vol5days_add_on": "<string>",
"vol30days_add_on": "<string>",
"vol90days_add_on": "<string>",
"total_position_margin": "<string>"
}
]
}
},
"liquidation_start_time": "2023-11-07T05:31:56Z",
"filled_amount": "15000.00",
"remaining_amount": "17083.26",
"liquidation_finish_time": "2023-11-07T05:31:56Z",
"asset_breakdown": [
{
"asset": "BTC",
"liquidated_amount": "0.1",
"liquidated_notional": "11453.17",
"remaining_amount": "0.05",
"remaining_notional": "5726.59"
}
]
}
}Path Parameters
XM customer Prime Entity ID
Query Parameters
Financing liquidation UUID. If omitted, returns the active or most recent liquidation.
Response
200 - application/json
A successful response.
liquidation
XMLiquidationDetail provides detailed information about a single XM liquidation · object
Show child attributes
Show child attributes
Was this page helpful?
⌘I