Skip to main content
GET
/
api
/
public
/
v1
/
live
/
risk
/
overview
Get API public v1 live risk overview
curl --request GET \
  --url https://api.coinversa.ai/api/public/v1/live/risk/overview \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.coinversa.ai/api/public/v1/live/risk/overview"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.coinversa.ai/api/public/v1/live/risk/overview', 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.coinversa.ai/api/public/v1/live/risk/overview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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.coinversa.ai/api/public/v1/live/risk/overview"

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

	req.Header.Add("X-API-Key", "<api-key>")

	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.coinversa.ai/api/public/v1/live/risk/overview")
  .header("X-API-Key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.coinversa.ai/api/public/v1/live/risk/overview")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "availability": {
    "historicalClearinghouse": true,
    "liquidations": true,
    "liveCandles": true,
    "markPrices": true,
    "userActions": true
  },
  "concentrationTop10": 123,
  "freshness": {
    "historicalClearinghouse": "<string>",
    "liquidations": "<string>",
    "liveCandles": "<string>",
    "livePositions": "<string>",
    "longShort": "<string>",
    "markPrices": "<string>"
  },
  "generatedAt": "<string>",
  "history": {
    "avgLeverage": [
      {
        "timestamp": 123,
        "long": 123,
        "short": 123
      }
    ],
    "liquidations": [
      {
        "bucketStart": 123,
        "count": 123,
        "totalClosedPnl": "<unknown>",
        "totalPenaltyFees": "<unknown>"
      }
    ],
    "netBias": [
      {
        "timestamp": 123,
        "value": 123
      }
    ],
    "oi": [
      {
        "timestamp": 123,
        "value": 123
      }
    ]
  },
  "liquidationSummary7d": {
    "availability": {
      "historicalClearinghouse": true,
      "liquidations": true,
      "liveCandles": true,
      "markPrices": true,
      "userActions": true
    },
    "avgClosedPnl": 123,
    "avgPenaltyFee": 123,
    "bucketSizeMs": 123,
    "byCoin": [
      {
        "coin": "<string>",
        "count": 123,
        "totalClosedPnl": "<unknown>",
        "totalPenaltyFees": "<unknown>"
      }
    ],
    "count": 123,
    "freshness": {
      "historicalClearinghouse": "<string>",
      "liquidations": "<string>",
      "liveCandles": "<string>",
      "livePositions": "<string>",
      "longShort": "<string>",
      "markPrices": "<string>"
    },
    "generatedAt": "<string>",
    "since": "<string>",
    "timeline": [
      {
        "bucketStart": 123,
        "count": 123,
        "totalClosedPnl": "<unknown>",
        "totalPenaltyFees": "<unknown>"
      }
    ],
    "totalClosedPnl": 123,
    "totalPenaltyFees": 123,
    "$schema": "<string>",
    "coin": "<string>"
  },
  "longPositions": 123,
  "longShort": {
    "accountRatio": 123,
    "avgLongSize": 123,
    "avgShortSize": 123,
    "bySymbol": [
      {
        "avgLongSize": 123,
        "avgShortSize": 123,
        "coin": "<string>",
        "concentrationTop5": 123,
        "longAccounts": 123,
        "longUnrealizedPnl": 123,
        "longVolume": 123,
        "netBias": 123,
        "ratio": 123,
        "sampleSize": 123,
        "shortAccounts": 123,
        "shortUnrealizedPnl": 123,
        "shortVolume": 123,
        "timestamp": 123,
        "topLongs": [
          {
            "address": "<string>",
            "notional": 123,
            "pnl": 123,
            "size": 123
          }
        ],
        "topShorts": [
          {
            "address": "<string>",
            "notional": 123,
            "pnl": 123,
            "size": 123
          }
        ],
        "totalUnrealizedPnl": 123,
        "volumeRatio": 123,
        "$schema": "<string>",
        "avgLongLeverage": 123,
        "avgShortLeverage": 123,
        "maxLeverage": 123
      }
    ],
    "concentrationTop5": 123,
    "longUnrealizedPnl": 123,
    "netBias": 123,
    "sampleSize": 123,
    "shortUnrealizedPnl": 123,
    "timestamp": 123,
    "totalLongAccounts": 123,
    "totalLongVolume": 123,
    "totalShortAccounts": 123,
    "totalShortVolume": 123,
    "totalUnrealizedPnl": 123,
    "tradersTracked": 123,
    "volumeRatio": 123,
    "$schema": "<string>",
    "avgLongLeverage": 123,
    "avgShortLeverage": 123,
    "maxLeverage": 123
  },
  "nearLiquidationNotional": 123,
  "netBias": 123,
  "shortPositions": 123,
  "topCrowdedCoins": [
    {
      "coin": "<string>",
      "concentrationTop5": 123,
      "liquidationClosedPnl7d": 123,
      "liquidationCount7d": 123,
      "liquidationPenaltyFees7d": 123,
      "longPositions": 123,
      "nearLiquidationNotional": 123,
      "netBias": 123,
      "shortPositions": 123,
      "totalOI": 123,
      "totalUnrealizedPnl": 123,
      "uniqueWallets": 123,
      "avgLeverage": 123,
      "avgLiquidationDistancePct": 123
    }
  ],
  "totalOI": 123,
  "totalUnrealizedPnl": 123,
  "uniqueWallets": 123,
  "$schema": "<string>",
  "avgLeverage": 123
}
{
  "$schema": "<string>",
  "code": "<string>",
  "current_tier": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "required_tier": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank",
  "upgrade_url": "<string>"
}
{
  "$schema": "<string>",
  "code": "<string>",
  "current_tier": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "required_tier": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank",
  "upgrade_url": "<string>"
}
{
  "$schema": "<string>",
  "code": "<string>",
  "current_tier": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "required_tier": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank",
  "upgrade_url": "<string>"
}
{
  "$schema": "<string>",
  "code": "<string>",
  "current_tier": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "required_tier": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank",
  "upgrade_url": "<string>"
}

Authorizations

X-API-Key
string
header
required

Response

OK

availability
object
required
concentrationTop10
number<double>
required
freshness
object
required
generatedAt
string
required
history
object
required
liquidationSummary7d
object
required
longPositions
integer<int64>
required
longShort
object
required
nearLiquidationNotional
number<double>
required
netBias
number<double>
required
shortPositions
integer<int64>
required
topCrowdedCoins
object[] | null
required
totalOI
number<double>
required
totalUnrealizedPnl
number<double>
required
uniqueWallets
integer<int64>
required
$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://api.coinversa.ai/schemas/RiskOverviewBody.json"

avgLeverage
number<double>