Reference

Protocols

The set of perp protocols PerpDB tracks, with their metadata.

List protocols

GET
List the supported protocols and their metadata.
Headers
x-api-keystringrequired
API key sent in the request header; never accepted as a query parameter.
Response
200
{ data: Protocol[] }
Protocol
idProtocol identifier.gmtrade | jupiter | phoenix
nameProtocol display name.
chainChain the protocol runs on.
Request
cURL
curl --request GET \
  --url https://api.perpdb.xyz/v1/protocols \
  --header 'x-api-key: ak_...'
Example
{
  "data": [
    {
      "id": "gmtrade",
      "name": "GMTrade",
      "chain": "solana"
    },
    {
      "id": "jupiter",
      "name": "Jupiter Perpetuals",
      "chain": "solana"
    }
  ]
}

Protocol stats

GET
Cross-protocol stats: current open interest, 24h volume, 24h fees, and 24h liquidations, broken out per protocol.
Headers
x-api-keystringrequired
API key sent in the request header; never accepted as a query parameter.
Response
200
{ data: ProtocolOverview[] }
ProtocolOverview
protocolProtocol identifier.gmtrade | jupiter | phoenix
open_interest_usdCurrent open interest across all markets.
volume_24h_usdTraded notional over the trailing 24 hours.
fees_24h_usdTrading fees over the trailing 24 hours; excludes funding and borrowing charges.
liquidations_24h_usdLiquidated notional over the trailing 24 hours.
marketsNumber of active markets.
Request
cURL
curl --request GET \
  --url https://api.perpdb.xyz/v1/protocols/stats \
  --header 'x-api-key: ak_...'
Example
{
  "data": [
    {
      "protocol": "gmtrade",
      "open_interest_usd": 213190295.97783953,
      "volume_24h_usd": 55746557.55007404,
      "fees_24h_usd": 10877.320698385376,
      "liquidations_24h_usd": 461142.5083434,
      "markets": 70
    },
    {
      "protocol": "jupiter",
      "open_interest_usd": 103675702.85744204,
      "volume_24h_usd": 155590183.53772718,
      "fees_24h_usd": 187274.7849609998,
      "liquidations_24h_usd": 20827910.490780003,
      "markets": 3
    }
  ]
}