DeFi Protocol Leaderboard (by TVL, Revenue, Fees, Volume, or Users)

{
  "type": "object",
  "required": [
    "metric"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page. Example: 20. Defaults to 20."
    },
    "metric": {
      "enum": [
        "tvl",
        "revenue",
        "fees",
        "volume",
        "users"
      ],
      "type": "string",
      "description": "Ranking metric. Can be tvl, revenue, fees, volume, or users. Example: tvl."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Pagination offset. Example: 0. Defaults to 0."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "tvl": {
            "type": "number",
            "description": "Total value locked, in USD."
          },
          "fees": {
            "type": "number",
            "description": "Fees generated, in USD."
          },
          "name": {
            "type": "string",
            "description": "Protocol or company display name, e.g. 'Aave'."
          },
          "slug": {
            "type": "string",
            "description": "URL-safe protocol identifier, e.g. 'aave'."
          },
          "users": {
            "type": "number",
            "description": "Active user count."
          },
          "symbol": {
            "type": "string",
            "description": "Token ticker, e.g. 'AAVE'. Not observed on every row (absent for stablecoin issuers and custodians like Tether, Circle, BitGo)."
          },
          "volume": {
            "type": "number",
            "description": "Trading volume, in USD."
          },
          "revenue": {
            "type": "number",
            "description": "Protocol revenue, in USD."
          }
        },
        "description": "Only `slug`, `name`, and the requested ranking metric are observed on every row. `symbol`, and the four non-requested metric fields (tvl/revenue/fees/volume/users), are present only when the protocol reports that value -- several real rows (e.g. BitGo, Ondo Finance, PayPal, BlackRock) carry only `tvl` with no revenue/fees/volume/users at all.",
        "additionalProperties": true
      },
      "description": "One entry per ranked protocol, in ranked order. Empty when the requested offset is past the last available row (see revenue-empty-page.json: offset 9000 on the revenue metric returned zero rows with meta.empty_reason set)."
    },
    "meta": {
      "type": "object",
      "properties": {
        "limit": {
          "type": "number"
        },
        "cached": {
          "type": "boolean"
        },
        "offset": {
          "type": "number"
        },
        "has_more": {
          "type": "boolean",
          "description": "True when more ranked rows exist beyond this page -- observed on the first page of a 20-row tvl request. Not observed on the empty-page fixture, so its presence when a page is empty is unconfirmed; do not assume it is always present."
        },
        "empty_reason": {
          "type": "string",
          "description": "Only observed present when `data` comes back empty (e.g. an offset past the last page) -- explains why no rows were returned. Absent on every non-empty page observed."
        }
      },
      "additionalProperties": true
    }
  },
  "description": "A page of the DeFi protocol leaderboard for the requested metric.",
  "additionalProperties": true
}