Skip to main content
GET
/
api
/
public
/
v1
/
live
/
risk
/
coins
/
{coin}
Get API public v1 live risk coins by coin
curl --request GET \
  --url https://api.coinversa.ai/api/public/v1/live/risk/coins/{coin} \
  --header 'X-API-Key: <api-key>'
{
  "availability": {
    "historicalClearinghouse": true,
    "liquidations": true,
    "liveCandles": true,
    "markPrices": true,
    "userActions": true
  },
  "coin": "<string>",
  "concentrationTop5": 123,
  "freshness": {
    "historicalClearinghouse": "<string>",
    "liquidations": "<string>",
    "liveCandles": "<string>",
    "livePositions": "<string>",
    "longShort": "<string>",
    "markPrices": "<string>"
  },
  "generatedAt": "<string>",
  "liquidationHeatmap": {
    "buckets": [
      {
        "cumulativeLongNotional": 123,
        "cumulativeShortNotional": 123,
        "longNotionalAtRisk": 123,
        "longPositions": 123,
        "priceHigh": 123,
        "priceLow": 123,
        "shortNotionalAtRisk": 123,
        "shortPositions": 123,
        "totalNotionalAtRisk": 123
      }
    ],
    "coin": "<string>",
    "currentPrice": 123,
    "timestamp": 123,
    "totalLongAtRisk": 123,
    "totalShortAtRisk": 123,
    "$schema": "<string>"
  },
  "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>"
  },
  "longShort": {
    "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
  },
  "market": {
    "avgLongLeverage": 123,
    "avgShortLeverage": 123,
    "coin": "<string>",
    "longNotional": 123,
    "longPositions": 123,
    "shortNotional": 123,
    "shortPositions": 123,
    "totalOi": 123,
    "totalPositions": 123,
    "totalUnrealizedPnl": 123,
    "uniqueWallets": 123
  },
  "nearLiquidationNotional": 123,
  "nearLiquidationPositions": 123,
  "recentLiquidations": [
    {
      "address": "<unknown>",
      "closedPnl": {
        "Exp": 123,
        "InfinityModifier": 123,
        "Int": "<string>",
        "NaN": true,
        "Valid": true
      },
      "coin": "<string>",
      "liquidator": "<unknown>",
      "penaltyFee": {
        "Exp": 123,
        "InfinityModifier": 123,
        "Int": "<string>",
        "NaN": true,
        "Valid": true
      },
      "pnlTier": {
        "String": "<string>",
        "Valid": true
      },
      "timestampMs": 123
    }
  ],
  "sizeBreakdown": [
    {
      "longCount": 123,
      "longNotional": 123,
      "positionCount": 123,
      "shortCount": 123,
      "shortNotional": 123,
      "sizeBucket": "<string>",
      "sortOrder": 123,
      "totalNotional": 123
    }
  ],
  "topPositions": [
    {
      "address": "<unknown>",
      "coin": "<string>",
      "entryPx": {
        "Exp": 123,
        "InfinityModifier": 123,
        "Int": "<string>",
        "NaN": true,
        "Valid": true
      },
      "fundingSinceOpen": {
        "Exp": 123,
        "InfinityModifier": 123,
        "Int": "<string>",
        "NaN": true,
        "Valid": true
      },
      "leverage": {
        "Exp": 123,
        "InfinityModifier": 123,
        "Int": "<string>",
        "NaN": true,
        "Valid": true
      },
      "leverageType": {
        "String": "<string>",
        "Valid": true
      },
      "liquidationPx": {
        "Exp": 123,
        "InfinityModifier": 123,
        "Int": "<string>",
        "NaN": true,
        "Valid": true
      },
      "marginUsed": {
        "Exp": 123,
        "InfinityModifier": 123,
        "Int": "<string>",
        "NaN": true,
        "Valid": true
      },
      "markPx": {
        "Exp": 123,
        "InfinityModifier": 123,
        "Int": "<string>",
        "NaN": true,
        "Valid": true
      },
      "notional": {
        "Exp": 123,
        "InfinityModifier": 123,
        "Int": "<string>",
        "NaN": true,
        "Valid": true
      },
      "openedAtRaw": {
        "Int64": 123,
        "Valid": true
      },
      "pOpenedAt": {
        "InfinityModifier": 123,
        "Time": "2023-11-07T05:31:56Z",
        "Valid": true
      },
      "pUpdatedAt": {
        "InfinityModifier": 123,
        "Time": "2023-11-07T05:31:56Z",
        "Valid": true
      },
      "pnlTier": {
        "String": "<string>",
        "Valid": true
      },
      "roe": {
        "Exp": 123,
        "InfinityModifier": 123,
        "Int": "<string>",
        "NaN": true,
        "Valid": true
      },
      "side": "<string>",
      "size": {
        "Exp": 123,
        "InfinityModifier": 123,
        "Int": "<string>",
        "NaN": true,
        "Valid": true
      },
      "sizeTier": {
        "String": "<string>",
        "Valid": true
      },
      "traderTotalPnl": "<string>",
      "traderTotalTrades": {
        "Int64": 123,
        "Valid": true
      },
      "traderWinRate": {
        "Exp": 123,
        "InfinityModifier": 123,
        "Int": "<string>",
        "NaN": true,
        "Valid": true
      },
      "unrealizedPnl": {
        "Exp": 123,
        "InfinityModifier": 123,
        "Int": "<string>",
        "NaN": true,
        "Valid": true
      }
    }
  ],
  "$schema": "<string>",
  "avgLiquidationDistancePct": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.coinversa.ai/llms.txt

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

Authorizations

X-API-Key
string
header
required

Path Parameters

coin
string
required

Response

OK

availability
object
required
coin
string
required
concentrationTop5
number<double>
required
freshness
object
required
generatedAt
string
required
liquidationHeatmap
object
required
liquidationSummary7d
object
required
longShort
object
required
market
object
required
nearLiquidationNotional
number<double>
required
nearLiquidationPositions
integer<int64>
required
recentLiquidations
object[] | null
required
sizeBreakdown
object[] | null
required
topPositions
object[] | null
required
$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/CoinRiskSnapshotBody.json"

avgLiquidationDistancePct
number<double>