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

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

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": 57796215.90431303,
      "volume_24h_usd": 56138937.34833192,
      "fees_24h_usd": 5541.261063732146,
      "liquidations_24h_usd": 1055729.0102897044,
      "markets": 68
    },
    {
      "protocol": "jupiter",
      "open_interest_usd": 94286346.60741402,
      "volume_24h_usd": 19296011.893606007,
      "fees_24h_usd": 16718.15276800002,
      "liquidations_24h_usd": 333567.354755,
      "markets": 3
    }
  ]
}