{ "openapi": "3.0.3", "info": { "title": "DefiLlama Pro - OpenAPI 3.0", "version": "1.0.0", "description": "## Using AI?\n\nDefiLlama offers two ways to use our data with AI:\n\n| Resource | For | Description |\n|---|---|---|\n| llms.txt | AI assistants (ChatGPT, Claude, Cursor, etc.) | Paste this link into your AI assistant for LLM-optimized docs |\n| MCP Server | AI agents | Connect your agent directly to DefiLlama data — 23 tools, uses API credits |\n\n**Quick start (MCP)** — paste this into your AI agent:\n```\nRead https://raw.githubusercontent.com/DefiLlama/defillama-skills/refs/heads/master/defillama-setup/SKILL.md and follow the instructions to connect to DefiLlama MCP\n```\n\n---\n\nDocs for DefiLlama's Pro API\n\n## Authentication\n\nPut your API key between the base URL and the endpoint. Do NOT send the key as a query parameter (`?apikey=`) or header.\n\n```\nWRONG https://pro-api.llama.fi/api/overview/derivatives?apikey={YOUR_API_KEY}\nRIGHT https://pro-api.llama.fi/{YOUR_API_KEY}/api/overview/derivatives\n```\n\nThere are only two tiers: free (no key) and the API plan. One API plan key unlocks every Pro endpoint. There are no add-ons or separate keys for volumes, derivatives, or other data.\n\n### Troubleshooting\n\nA 200 from `/protocols` or `/overview/fees` on `api.llama.fi` does not validate your API key. Those endpoints require no authentication. A 402 from `api.llama.fi` does not prove your subscription expired. It means the endpoint needs the Pro API.\n\n1. Check the host and key placement: `https://pro-api.llama.fi/{YOUR_API_KEY}/...`, not `api.llama.fi` and not `?apikey=`.\n2. Call `https://pro-api.llama.fi/usage/{YOUR_API_KEY}` (key at the end, for this endpoint only). It returns your remaining credits, like `{\"creditsLeft\": 1000000}`.\n3. Retry the keyed URL: `https://pro-api.llama.fi/{YOUR_API_KEY}/api/overview/derivatives`.\n\n## SDK\n\n**JavaScript** — `npm install @defillama/api` — [GitHub](https://github.com/DefiLlama/api-sdk)\n\n**Python** — `pip install defillama-sdk` — [GitHub](https://github.com/DefiLlama/python-sdk)\n\nQuick start (JavaScript):\n```ts\nimport { DefiLlama } from '@defillama/api'\n\nconst proClient = new DefiLlama({ apiKey: 'your-api-key' })\nconst protocols = await proClient.tvl.getProtocols()\n```\n\nQuick start (Python):\n```py\nfrom defillama_sdk import DefiLlama\n\npro_client = DefiLlama({\"api_key\": \"your-api-key\"})\nprotocols = pro_client.tvl.getProtocols()\n```", "x-scalar-sdk-installation": [ { "lang": "node", "description": "Install the DefiLlama JavaScript SDK:", "source": "npm install @defillama/api" }, { "lang": "js", "description": "Install the DefiLlama JavaScript SDK:", "source": "npm install @defillama/api" }, { "lang": "python", "description": "Install the DefiLlama Python SDK:", "source": "pip install defillama-sdk" } ] }, "servers": [ { "url": "https://pro-api.llama.fi/{YOUR_API_KEY}", "description": "Your API key goes in the path, between the base URL and the endpoint. Never as a query parameter or header.", "variables": { "YOUR_API_KEY": { "default": "YOUR_API_KEY", "description": "Your DefiLlama API plan key" } } } ], "tags": [ { "name": "TVL", "description": "Retrieve TVL data - pro" }, { "name": "Treasury", "description": "Retrieve protocol treasury data" }, { "name": "stablecoins", "description": "Data from our stablecoins dashboard - pro" }, { "name": "RWA", "description": "Real World Asset assets, aggregate stats, and chain breakdowns" }, { "name": "active users", "description": "Data about active users on our chains and protocols dashboards" }, { "name": "Unlocks", "description": "Data about token unlocks from our Unlocks dashboard" }, { "name": "main page", "description": "Data from dashboards on our side menu" }, { "name": "token liquidity", "description": "Provides the available liquidity for swapping from one token to another on a specific chain" }, { "name": "yields", "description": "Data from our yields/APY dashboard\n\n> [!WARNING]\n> **The yield endpoints on the left of the arrows below stop working on November 13, 2026.** Migrate before then. From that date the yield API requires the [API plan](https://defillama.com/subscription).\n\n### How to migrate\n\n**Option 1, minimal: swap the URL.** The `/yields/v1/` routes serve the same response format as the endpoints they replace, so the URL is the only thing you change. They exist for compatibility only: all new features land on v2.\n\n- `/pools`, `/yields/pools`, `/yields/poolsOld`, `/yields/poolsPro` → `/yields/v1/pools`\n- `/chart/{pool}`, `/yields/chart/{pool}` → `/yields/v1/chart/{pool}`\n- `/yields/poolsBorrow` → `/yields/v1/poolsBorrow`\n- `/yields/chartLendBorrow/{pool}` → `/yields/v1/chartLendBorrow/{pool}`\n- `/yields/lsdRates` → `/api/lstRates`\n\n**Option 2, recommended: move to v2.** New response format, so this takes some integration work, but you get all the new features: Verified APY, 10-minute refreshes, the borrow router, and APYs split into components.\n\n- `/pools`, `/yields/pools`, `/yields/poolsOld`, `/yields/poolsPro` → `/yields/v2/earn`\n- `/chart/{pool}`, `/yields/chart/{pool}` → `/yields/v2/earn/{id}/history`\n- `/yields/poolsBorrow` → `/yields/v2/borrow/markets`\n- `/yields/chartLendBorrow/{pool}` → `/yields/v2/borrow/markets/{id}/history` (borrow side) and `/yields/v2/earn/{id}/history` (lend side)\n- `/yields/lsdRates` → `/api/lstRates` (no v2 version)\n\nGood to know:\n\n- Pool IDs are unchanged, so nothing needs re-mapping.\n- Values are computed by the new pipeline, so numbers may differ slightly from the legacy endpoints; the response format is unchanged.\n- `/yields/v1/pools` serves the `/poolsOld` format, which contains all the `/pools` fields, so parsers for either endpoint keep working.\n- Some legacy statistics fields (e.g. `predictions`) are always null on the `/yields/v1/` routes." }, { "name": "ETFs", "description": "Tradfi ETFs" }, { "name": "meta", "description": "Get information about your API Key" }, { "name": "narratives", "description": "Track performance of narratives" }, { "name": "DAT", "description": "Digital Asset Treasury" }, { "name": "Equities", "description": "Stock market data for publicly traded companies.\n\nData provided by [Twelve Data](https://twelvedata.com/)" }, { "name": "Pre-IPO", "description": "Valuation history, funding rounds, and live tradeable markets for private, pre-IPO companies.\n\nValuations are DefiLlama estimates reconciled from secondary marketplaces and disclosed funding rounds, not official company figures." }, { "name": "Oracles", "description": "Oracle TVL data and breakdowns by chain and protocol" }, { "name": "Forks", "description": "Fork TVL data and breakdowns by protocol" }, { "name": "Dimensions", "description": "Unified dimension endpoints for fees, liquidations, DEX volumes, derivatives, options, aggregators, bridge aggregators, bridges, open interest, and normalized volume.\n\nUse `metric=bridges` for bridge transfer volumes and transaction counts. `metric=bridge-aggregators` covers activity routed through bridge aggregators and uses `dailyBridgeVolume`.\n\n| dataType | Unit | Meaning |\n| --- | --- | --- |\n| dailyAggregatedVolume | USD | Default. At protocol level, total outgoing volume across chains. For each chain, incoming plus outgoing volume. |\n| dailyOutgoingVolume | USD | Value leaving each chain through the bridge. |\n| dailyIncomingVolume | USD | Value arriving on each chain through the bridge. |\n| dailyTxCount | Transfers | At protocol level, total outgoing transfer count across chains. For each chain, incoming plus outgoing transfer counts. |\n| dailyOutgoingTxCount | Transfers | Number of transfers leaving each chain. |\n| dailyIncomingTxCount | Transfers | Number of transfers arriving on each chain. |\n\nThe selected dataType controls the units of chart values and overview totals such as total24h and total7d. Chart timestamps are Unix seconds at the start of each UTC day. Missing dates or null totals do not mean zero activity.\n\nDirection is relative to each chain: Ethereum -> OP Mainnet is outgoing on Ethereum and incoming on OP Mainnet. For a chain, calculate netflow as dailyIncomingVolume minus dailyOutgoingVolume; a positive result is a net inflow.\n\nProtocol totals count the source side of transfers. Per-chain dailyAggregatedVolume and dailyTxCount count both incoming and outgoing activity, so summing a chain breakdown can count a transfer twice. Version breakdowns sum chain values within each version and can also exceed the protocol total. Use the protocol total chart for the protocol's volume or transfer count.\n\nDiscover protocol slugs and chain names from `/api/v2/metrics/bridges`. Use those slugs in protocol routes, for example `optimism-bridge` or `cbridge`; the legacy `/bridges/bridge/{id}` numeric IDs are a different identifier set. Discover categories with `/api/v2/metrics/bridges/categories`, then use their slug forms in category routes, such as `bridge` or `canonical-bridge`.\n\nExamples (replace YOUR_API_KEY):\n\n```text\nhttps://pro-api.llama.fi/{YOUR_API_KEY}/api/v2/metrics/bridges\nhttps://pro-api.llama.fi/{YOUR_API_KEY}/api/v2/chart/bridges/protocol/optimism-bridge?dataType=dailyAggregatedVolume\nhttps://pro-api.llama.fi/{YOUR_API_KEY}/api/v2/chart/bridges/protocol/optimism-bridge?dataType=dailyTxCount\nhttps://pro-api.llama.fi/{YOUR_API_KEY}/api/v2/chart/bridges/protocol/optimism-bridge/chain-breakdown?dataType=dailyIncomingVolume\nhttps://pro-api.llama.fi/{YOUR_API_KEY}/api/v2/chart/bridges/chain/ethereum?dataType=dailyOutgoingVolume\nhttps://pro-api.llama.fi/{YOUR_API_KEY}/api/v2/metrics/bridges/categories\n```\n\nLabel breakdowns are available only when the protocol supplies label data; they are not available for every bridge." }, { "name": "Financial Statements", "description": "Protocol income statement and financial reporting data" } ], "paths": { "/api/tokenProtocols/{symbol}": { "get": { "tags": ["TVL"], "x-api-plan-only": true, "summary": "Lists the amount of a certain token within all protocols. Data for the Token Usage page", "parameters": [ { "name": "symbol", "in": "path", "description": "token slug", "required": true, "schema": { "type": "string", "example": "usdt" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Portal" }, "category": { "type": "string", "example": "Bridge" }, "amountUsd": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "coingecko:tether-avalanche-bridged-usdt-e": 6485.2310529788765, "coingecko:xcusdt": 45.514624238131, "coingecko:layerzero-bridged-usdt-aptos": 7312.740629193999 } } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.tvl.getTokenProtocols('')" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.tvl.getTokenProtocols('')" } ] } }, "/api/inflows/{protocol}/{timestamp}": { "get": { "tags": ["TVL"], "x-api-plan-only": true, "summary": "Lists the amount of inflows and outflows for a protocol at a given date", "parameters": [ { "name": "protocol", "in": "path", "description": "protocol slug", "required": true, "schema": { "type": "string", "example": "compound-v3" } }, { "name": "timestamp", "in": "path", "description": "unix timestamp", "required": true, "schema": { "type": "integer", "example": 1767139200 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "outflows": { "type": "number", "example": -160563462.23474675 }, "oldTokens": { "type": "object", "properties": { "date": { "type": "number", "example": 1700005031 }, "tvl": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "POLYGONUSDC": 2800590.050521, "STMATIC": 5910852.971103674, "USDC.E": 213182.234023, "WETH": 138751.92261049704, "WSTETH": 21205.858768287606, "COMP": 899912.2484411557, "ARB": 5191395.55706979, "UNI": 3276947.8126982865, "WBTC": 15237.12702489, "WMATIC": 4316699.376111328, "USDBC": 1567657.999816, "GMX": 44027.42587184711, "CBETH": 10011.824096757742, "LINK": 2915041.329272804, "USDC": 27302168.767972, "MATICX": 5999572.681088426 } } } }, "currentTokens": { "type": "object", "properties": { "date": { "type": "number", "example": 1752771743 }, "tvl": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "SKY": 1839111.3665808514, "WSUPEROETHB": 610.1258731272615, "RETH": 335.9162918778323, "WEETH": 21264.320107593303, "STMATIC": 43248.612454883136, "TETH": 7537.467077317422, "USDT": 23936602.852221, "USDC.E": 457484.93217, "USDS": 986286.7461886762, "FBTC": 7.88084468, "WUSDM": 9912.583708525639, "COMP": 199962.19982196926, "UNI": 748399.6623864435, "WRON": 48676.91287257022, "WBTC": 8346.44481716, "EZETH": 9378.908917279387, "SDEUSD": 4476349.521512799, "OSETH": 1751.011747340086, "USDT0": 4807642.14842, "LINK": 629790.4518594383, "DEUSD": 14779291.40757071, "MATICX": 239292.60540364735, "ETHX": 7.643953648e-9, "POLYGONUSDC": 1130561.097829, "OP": 474055.27558234957, "RSWETH": 0.7588296185577288, "SFRAX": 32550977.989188965, "METH": 1256.0286269578846, "WETH": 106772.79955793211, "WSTETH": 127030.77547884149, "ARB": 8082828.497277849, "RSETH": 13198.88264941232, "WMATIC": 1192273.6401273129, "GMX": 6408.6736121308695, "USDBC": 200217.562935, "CBETH": 2094.7317932368333, "USDE": 1660443.2086449957, "ETH": 657.5898609775202, "SUSDS": 2360827.122683512, "USDC": 67152880.13345899, "TBTC": 297.109236856541, "AXS": 156.95240126041227, "CBBTC": 722.70428829, "WRSETH": 208.78735872239974, "AERO": 3582072.5610455093 } } } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.tvl.getInflows('', 1704067200, 1704153600)" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.tvl.getInflows('', 1704067200, 1704153600)" } ] } }, "/api/chainAssets": { "get": { "tags": ["TVL"], "summary": "Get assets of all chains", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "chain": { "type": "object", "properties": { "canonical": { "type": "object", "properties": { "total": { "type": "string", "example": "4482065428.82707789718257509123" }, "breakdown": { "type": "object", "additionalProperties": { "type": "string" }, "example": { "AGLD": "8.25709", "STPT": "263726.9847408758", "APU": "43899.14483171882", "CTX": "595333.6768847435", "APW": "37727.892544515686" } } } }, "native": { "type": "object", "properties": { "total": { "type": "string", "example": "10848868127.0093572327157505031494340578574406321858" }, "breakdown": { "type": "object", "additionalProperties": { "type": "string" }, "example": { "BENI": "1322294.3731837485", "ANIME": "10.7583162713828217314035397949084", "SACA": "114132.47631920826", "HOKK": "4966.3804669563400723148947324498025", "TOSHI": "91927630.6839119443580116994151258714" } } } }, "thirdParty": { "type": "object", "properties": { "total": { "type": "string", "example": "3182802062.49398527398560408906" }, "breakdown": { "type": "object", "additionalProperties": { "type": "string" }, "example": { "BRZ": "1810685.01887618296911", "BOBA": "0", "BURN": "0", "GGTK": "0.6545695", "GYFI": "2618437.7978" } } } }, "total": { "type": "object", "properties": { "total": { "type": "string", "example": "18513735618.330420403" }, "breakdown": { "type": "object", "additionalProperties": { "type": "string" }, "example": { "AGLD": "8.25709", "STPT": "263726.9847408758", "APU": "43899.14483171882", "CTX": "595333.6768847435", "APW": "37727.892544515686" } } } } } }, "timestamp": { "type": "number", "example": 1752843956 } } } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.tvl.getChainAssets()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.tvl.getChainAssets()" } ] } }, "/api/emissions": { "get": { "tags": ["Unlocks"], "summary": "List of all tokens along with basic info for each", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "token": { "type": "string", "example": "coingecko:whitebit" }, "sources": { "type": "array", "items": { "type": "string" }, "example": ["https://cdn.whitebit.com/wbt/whitepaper-en.pdf"] }, "protocolId": { "type": "string", "example": "6143" }, "name": { "type": "string", "example": "WhiteBIT" }, "circSupply": { "type": "number", "example": 293500000 }, "circSupply30d": { "type": "number", "example": 293500000 }, "totalLocked": { "type": "number", "example": 81500000 }, "maxSupply": { "type": "number", "example": 375000000 }, "gecko_id": { "type": "string", "example": "whitebit" }, "events": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "example": "A cliff of {tokens[0]} tokens was unlocked from Funds 1 on {timestamp}" }, "timestamp": { "type": "number", "example": 1659657600 }, "noOfTokens": { "type": "array", "items": { "type": "number" }, "example": [120000000] }, "category": { "type": "string", "example": "noncirculating" }, "unlockType": { "type": "string", "example": "cliff" } } } }, "nextEvent": { "type": "object", "properties": { "date": { "type": "number", "example": 1773360001 }, "toUnlock": { "type": "number", "example": 81500000 } } }, "unlocksPerDay": { "type": "number", "example": 0 }, "mcap": { "type": "number", "example": 6577845629.249915 } } } } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.emissions.getAll()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.emissions.getAll()" } ] } }, "/api/emission/{protocol}": { "get": { "tags": ["Unlocks"], "summary": "Unlocks data for a given token/protocol. You can find a list of available slugs to query by querying /emissions and then extracting the key `gecko_id`", "parameters": [ { "name": "protocol", "in": "path", "description": "protocol slug", "required": true, "schema": { "type": "string", "example": "hyperliquid" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "documentedData": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "example": "Hyper Foundation Budget" }, "data": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "number", "example": 1732838400 }, "unlocked": { "type": "number", "example": 60000000 }, "rawEmission": { "type": "number", "example": 60000000 }, "burned": { "type": "number", "example": 0 } } } } } } }, "tokenAllocation": { "type": "object", "properties": { "current": { "type": "object", "properties": { "insiders": { "type": "number", "example": 16 }, "noncirculating": { "type": "number", "example": 0.8 }, "publicSale": { "type": "number", "example": 0 }, "airdrop": { "type": "number", "example": 82.5 }, "farming": { "type": "number", "example": 0.7 } } }, "final": { "type": "object", "properties": { "insiders": { "type": "number", "example": 45.8 }, "noncirculating": { "type": "number", "example": 0.5 }, "publicSale": { "type": "number", "example": 0 }, "airdrop": { "type": "number", "example": 47.7 }, "farming": { "type": "number", "example": 6 } } }, "progress": { "type": "object", "properties": { "insiders": { "type": "number", "example": 20.1 }, "noncirculating": { "type": "number", "example": 100 }, "publicSale": { "type": "number", "example": 100 }, "airdrop": { "type": "number", "example": 100 }, "farming": { "type": "number", "example": 6.5 } } } } } } }, "metadata": { "type": "object", "properties": { "notes": { "type": "array", "items": { "type": "string" }, "example": [ "The Community Rewards schedule has been linearly extrapolated using the rate of unlocks as of 4 March 2025.", "The remaining allocation, not shown on the chart, belongs to Community Rewards. It has been excluded here to avoid obscuring the remaining data.", "Most vesting schedules will complete between 2027–2028; some will continue after 2028. Here we have used an end date of end of 2027.", "Although the full allocations for Hyper Foundation Budget and Community Grants were unlocked at TGE it is unclear what their spend rate is." ] }, "token": { "type": "string", "example": "coingecko:hyperliquid" }, "sources": { "type": "array", "items": { "type": "string" }, "example": ["https://hyperfnd.medium.com/hype-genesis-1830a4dc2e3f"] }, "protocolIds": { "type": "array", "items": { "type": "string" }, "example": ["4481", "5448", "5507", "5761"] }, "total": { "type": "number", "example": 1000000000 }, "chain": { "type": "string", "example": "hyperliquid" }, "name": { "type": "string", "example": "Hyperliquid" }, "gecko_id": { "type": "string", "example": "hyperliquid" }, "defillamaIds": { "type": "array", "items": { "type": "string" }, "example": ["4481"] }, "categories": { "type": "object", "properties": { "insiders": { "type": "array", "items": { "type": "string" }, "example": ["Core Contributors", "Hyper Foundation Budget"] }, "noncirculating": { "type": "array", "items": { "type": "string" }, "example": ["Community Grants"] }, "publicSale": { "type": "array", "items": { "type": "string" }, "example": ["HIP-2"] }, "airdrop": { "type": "array", "items": { "type": "string" }, "example": ["Genesis Distribution"] }, "farming": { "type": "array", "items": { "type": "string" }, "example": ["Community Rewards"] } } }, "protocolCategory": { "type": "string", "example": "Bridge" }, "chainName": { "type": "string", "example": "Hyperliquid L1" }, "pId": { "type": "string", "example": "4481" } } } } }, "lastModified": { "type": "string", "example": "2025-07-18T13:30:56.000Z" } } } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.emissions.getByProtocol('')" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.emissions.getByProtocol('')" } ] } }, "/api/categories": { "get": { "tags": ["main page"], "summary": "Overview of all categories accross all protocols", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "chart": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "properties": { "tvl": { "type": "number", "example": 45997965191.323425 }, "staking": { "type": "number", "example": 117946591.34734812 }, "pool2": { "type": "number", "example": 4467.975298299099 }, "doublecounted": { "type": "number", "example": 1259137973.0377812 }, "borrowed": { "type": "number", "example": 714082.8186222482 }, "offers": { "type": "number", "example": 0 }, "vesting": { "type": "number", "example": 0.0009596433739281769 }, "treasury": { "type": "number", "example": 11142.746348986766 }, "liquidstaking": { "type": "number", "example": 20838772668.74201 }, "dcAndLsOverlap": { "type": "number", "example": 24954437702.556156 } } } }, "example": { "1747440000": { "Bridge": { "tvl": 45997965191.323425, "staking": 117946591.34734812, "pool2": 4467.975298299099, "doublecounted": 1259137973.0377812, "borrowed": 714082.8186222482, "offers": 0, "vesting": 0.0009596433739281769 } } } }, "categories": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "example": { "Bridge": [ "WBTC", "RenVM", "The Tokenized Bitcoin", "hBTC", "Rhino.fi", "Strudel Finance", "Connext", "Injective Bridge", "pNetwork", "Allbridge Classic", "Multichain" ], "Risk Curators": [ "9Summits", "Alphaping", "Apostro", "B.Protocol Curator", "Block Analitica", "Clearstar", "Euler DAO", "Fence Finance", "Gauntlet", "Hakutora", "Hyperithm", "K3 Capital", "LlamaRisk", "M11 Credit", "MEV Capital", "Ouroboros Capital", "Re7 Labs", "Relend Network", "Steakhouse Financial", "Tulipa Capital", "Alterscope", "Yearn Curating", "CIAN Curating", "Vault Bridge" ], "DAO Service Provider": ["CreateDAO"] } } } } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.ecosystem.getCategories()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.ecosystem.getCategories()" } ] } }, "/api/forks": { "get": { "tags": ["main page"], "x-api-plan-only": true, "summary": "Overview of all forks accross all protocols", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "chart": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "properties": { "staking": { "type": "number", "example": 712008453.6943725 }, "tvl": { "type": "number", "example": 2580053162.908216 }, "pool2": { "type": "number", "example": 146782.46894897142 }, "doublecounted": { "type": "number", "example": 3013724.782369083 }, "borrowed": { "type": "number", "example": 925950.5791909688 }, "vesting": { "type": "number", "example": 0.0033932788318303733 }, "liquidstaking": { "type": "number", "example": 1184348.1365500058 }, "dcAndLsOverlap": { "type": "number", "example": 1184348.1365500058 } } } }, "example": { "1752624000": { "Uniswap V2": { "staking": 712008453.6943725, "tvl": 2580053162.908216, "pool2": 146782.46894897142, "doublecounted": 3013724.782369083, "borrowed": 925950.5791909688, "vesting": 0.0033932788318303733 } } } }, "forks": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "example": { "Uniswap V2": [ "SushiSwap", "Varen", "PancakeSwap AMM", "Defi Swap", "Energiswap", "Pangolin", "Cometh", "Honeyswap", "0.exchange", "YetiSwap", "Swapr V2", "Lydia", "Levinswap", "SpookySwap V2", "Quickswap Dex", "SpiritSwap AMM", "ViperSwap", "HyperJump", "Dfyn Network", "Unicly" ] } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.ecosystem.getForks()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.ecosystem.getForks()" } ] } }, "/api/oracles": { "get": { "tags": ["main page"], "summary": "Overview of all oracles accross all protocols", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "chart": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "properties": { "tvl": { "type": "number", "example": 48896114862.57202 }, "staking": { "type": "number", "example": 1564643922.8114228 }, "pool2": { "type": "number", "example": 107245076.47312777 }, "borrowed": { "type": "number", "example": 25132031822.258495 }, "treasury": { "type": "number", "example": 52.078623852211784 }, "vesting": { "type": "number", "example": 3347.9893057455306 } } } }, "example": { "1752624000": { "Chainlink": { "tvl": 48896114862.57202, "staking": 1564643922.8114228, "pool2": 107245076.47312777, "borrowed": 25132031822.258495, "treasury": 52.078623852211784, "vesting": 3347.9893057455306 } } } }, "oracles": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "example": { "Chainlink": ["AAVE V2", "Compound V2", "Synthetix v1+v2", "CREAM Lending"] } }, "chainsByOracle": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "example": { "Chainlink": [ "Ethereum", "Arbitrum", "BSC", "Avalanche", "Base", "Solana", "Polygon", "OP Mainnet", "Linea" ] } } } } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.ecosystem.getOracles()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.ecosystem.getOracles()" } ] } }, "/api/hacks": { "get": { "tags": ["main page"], "summary": "Overview of all hacks on our Hacks dashboard", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "number", "example": 1711065600 }, "name": { "type": "string", "example": "Super Sushi Samurai" }, "classification": { "type": "string", "example": "Protocol Logic" }, "technique": { "type": "string", "example": "Infinite Mint and Dump" }, "amount": { "type": "number", "example": 4800000 }, "chain": { "type": "array", "items": { "type": "string" }, "example": ["Blast"] }, "bridgeHack": { "type": "boolean", "example": false }, "targetType": { "type": "string", "example": "Gaming" }, "source": { "type": "string", "example": "https://rekt.news/sss-rekt/" }, "returnedFunds": { "type": ["number", "null"], "example": null }, "defillamaId": { "type": ["number", "null"], "example": null }, "language": { "type": ["string", "null"], "example": "Solidity" } } } } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.ecosystem.getHacks()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.ecosystem.getHacks()" } ] } }, "/api/raises": { "get": { "tags": ["main page"], "summary": "Overview of all raises on our Raises dashboard", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "raises": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "number", "example": 1740528000 }, "name": { "type": "string", "example": "Ethena Labs" }, "round": { "type": "string", "example": "Strategic" }, "amount": { "type": "number", "example": 16 }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum"] }, "sector": { "type": "string", "example": "Ethena is a synthetic dollar protocol built on Ethereum" }, "category": { "type": "string", "example": "DeFi" }, "categoryGroup": { "type": "string", "example": "DeFi & CeFi" }, "source": { "type": "string", "example": "https://www.benzinga.com/pressreleases/25/02/g43966782/mexc-invests-20-million-in-usde-to-drive-stablecoin-adoption-launches-1-000-000-reward-event" }, "leadInvestors": { "type": "array", "items": { "type": "string" }, "example": ["MEXC Ventures"] }, "otherInvestors": { "type": "array", "items": { "type": "string" }, "example": [] }, "valuation": { "type": ["number", "null"], "example": null }, "defillamaId": { "type": "string", "example": "parent#ethena" } } } } } } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.ecosystem.getRaises()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.ecosystem.getRaises()" } ] } }, "/api/treasuries": { "get": { "tags": ["main page"], "summary": "List all protocols on our Treasuries dashboard", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "6355-treasury" }, "name": { "type": "string", "example": "SharpLink Gaming (treasury)" }, "address": { "type": ["string", "null"], "example": null }, "symbol": { "type": "string", "example": "-" }, "url": { "type": "string", "example": "https://www.sharplink.com/" }, "description": { "type": "string", "example": "SharpLink is one of the first Nasdaq-listed companies to develop a treasury strategy centered on ETH" }, "chain": { "type": "string", "example": "Ethereum" }, "logo": { "type": "string", "example": "https://icons.llama.fi/sharplink-gaming.jpg" }, "audits": { "type": "string", "example": "0" }, "audit_note": { "type": ["string", "null"], "example": null }, "gecko_id": { "type": ["string", "null"], "example": null }, "cmcId": { "type": ["string", "null"], "example": null }, "category": { "type": "string", "example": "Treasury Manager" }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum"] }, "module": { "type": "string", "example": "treasury/sharplink-gaming.js" }, "treasury": { "type": "string", "example": "sharplink-gaming.js" }, "forkedFromIds": { "type": "array", "items": { "type": "string" }, "example": [] }, "twitter": { "type": "string", "example": "SharpLinkGaming" }, "slug": { "type": "string", "example": "sharplink-gaming-(treasury)" }, "tvl": { "type": "number", "example": 976150507.157045 }, "chainTvls": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "Ethereum": 976150507.157045 } }, "change_1h": { "type": "number", "example": -1.1231970563777622 }, "change_1d": { "type": "number", "example": 15.845546813803097 }, "change_7d": { "type": "number", "example": 75.57040101595928 }, "tokenBreakdowns": { "type": "object", "properties": { "ownTokens": { "type": "number", "example": 0 }, "stablecoins": { "type": "number", "example": 0.003 }, "majors": { "type": "number", "example": 67481592.5634468 }, "others": { "type": "number", "example": 908668914.5905982 } } }, "mcap": { "type": ["number", "null"], "example": null } } } } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.ecosystem.getTreasuries()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.ecosystem.getTreasuries()" } ] } }, "/api/entities": { "get": { "tags": ["main page"], "summary": "List all entities", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "entity-8" }, "name": { "type": "string", "example": "Blockchain Capital" }, "url": { "type": "string", "example": "https://blockchain.capital" }, "description": { "type": "string", "example": "Blockchain Capital is a leading venture firm in the blockchain industry. In the last 9 years we have made over 160 investments in companies and protocols in the sector, across different stages, geographies and asset types." }, "logo": { "type": "string", "example": "https://icons.llama.fi/blockchain-capital.jpg" }, "category": { "type": "string", "example": "VC" }, "module": { "type": "string", "example": "entities/blockchain-capital.js" }, "twitter": { "type": "string", "example": "blockchaincap" }, "symbol": { "type": "string", "example": "" }, "chain": { "type": "string", "example": "Ethereum" }, "gecko_id": { "type": ["string", "null"], "example": null }, "cmcId": { "type": ["string", "null"], "example": null }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum"] }, "slug": { "type": "string", "example": "blockchain-capital" }, "tvl": { "type": "number", "example": 131402986.1539898 }, "chainTvls": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "Ethereum": 131402986.1539898 } }, "change_1h": { "type": "number", "example": 0.5368786705972184 }, "change_1d": { "type": "number", "example": 5.632604890674784 }, "change_7d": { "type": "number", "example": 11.27548502629729 }, "tokenBreakdowns": { "type": "object", "properties": { "ownTokens": { "type": "number", "example": 0 }, "stablecoins": { "type": "number", "example": 0.06493662312 }, "majors": { "type": "number", "example": 29628575.4114822 }, "others": { "type": "number", "example": 101774410.67757098 } } }, "mcap": { "type": ["number", "null"], "example": null } } } } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.ecosystem.getEntities()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.ecosystem.getEntities()" } ] } }, "/api/historicalLiquidity/{token}": { "get": { "tags": ["token liquidity"], "summary": "Provides the name of contracts on a determined chain", "parameters": [ { "name": "token", "in": "path", "description": "token slug", "required": true, "schema": { "type": "string", "example": "usdt" } } ], "responses": { "200": { "description": "successful operation" } }, "x-api-plan-only": true } }, "/api/overview/derivatives": { "get": { "tags": ["perps"], "summary": "Lists all derivatives along summaries of their volumes filtering by chain", "parameters": [ { "name": "excludeTotalDataChart", "in": "query", "required": true, "description": "true to exclude aggregated chart from response", "schema": { "type": "boolean", "example": true } }, { "name": "excludeTotalDataChartBreakdown", "in": "query", "required": true, "description": "true to exclude broken down chart from response", "schema": { "type": "boolean", "example": true } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "totalDataChart": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Timestamp" }, { "type": "number", "description": "Volume value" } ] }, "description": "Total data chart with timestamps and volumes" }, "totalDataChartBreakdown": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Timestamp" }, { "type": "object", "description": "Protocol breakdown" } ] }, "description": "Total data chart breakdown by protocol" }, "breakdown24h": { "type": "object", "nullable": true, "description": "24 hour breakdown" }, "breakdown30d": { "type": "object", "nullable": true, "description": "30 day breakdown" }, "chain": { "type": "string", "nullable": true, "description": "Chain filter" }, "allChains": { "type": "array", "items": { "type": "string" }, "description": "All available chains" }, "total24h": { "type": "number", "description": "Total 24 hour volume" }, "total48hto24h": { "type": "number", "description": "Total 48h to 24h volume" }, "total7d": { "type": "number", "description": "Total 7 day volume" }, "total14dto7d": { "type": "number", "description": "Total 14d to 7d volume" }, "total60dto30d": { "type": "number", "description": "Total 60d to 30d volume" }, "total30d": { "type": "number", "description": "Total 30 day volume" }, "total1y": { "type": "number", "description": "Total 1 year volume" }, "change_1d": { "type": "number", "description": "1 day change percentage" }, "change_7d": { "type": "number", "description": "7 day change percentage" }, "change_1m": { "type": "number", "description": "1 month change percentage" }, "change_7dover7d": { "type": "number", "description": "7d over 7d change percentage" }, "change_30dover30d": { "type": "number", "description": "30d over 30d change percentage" }, "total7DaysAgo": { "type": "number", "description": "Total volume 7 days ago" }, "total30DaysAgo": { "type": "number", "description": "Total volume 30 days ago" }, "totalAllTime": { "type": "number", "description": "Total all time volume" }, "protocols": { "type": "array", "items": { "type": "object", "properties": { "total24h": { "type": "number", "description": "Protocol 24 hour volume" }, "total48hto24h": { "type": "number", "description": "Protocol 48h to 24h volume" }, "total7d": { "type": "number", "description": "Protocol 7 day volume" }, "total14dto7d": { "type": "number", "description": "Protocol 14d to 7d volume" }, "total60dto30d": { "type": "number", "description": "Protocol 60d to 30d volume" }, "total30d": { "type": "number", "description": "Protocol 30 day volume" }, "total1y": { "type": "number", "description": "Protocol 1 year volume" }, "totalAllTime": { "type": "number", "description": "Protocol all time volume" }, "average1y": { "type": "number", "description": "Protocol average 1 year volume" }, "change_1d": { "type": "number", "description": "Protocol 1 day change percentage" }, "change_7d": { "type": "number", "description": "Protocol 7 day change percentage" }, "change_1m": { "type": "number", "description": "Protocol 1 month change percentage" }, "change_7dover7d": { "type": "number", "description": "Protocol 7d over 7d change percentage" }, "change_30dover30d": { "type": "number", "description": "Protocol 30d over 30d change percentage" }, "breakdown24h": { "type": "object", "description": "Protocol 24 hour breakdown" }, "breakdown30d": { "type": "object", "description": "Protocol 30 day breakdown" }, "total7DaysAgo": { "type": "number", "description": "Protocol volume 7 days ago" }, "total30DaysAgo": { "type": "number", "description": "Protocol volume 30 days ago" }, "defillamaId": { "type": "string", "description": "DefiLlama protocol ID" }, "name": { "type": "string", "description": "Protocol name" }, "displayName": { "type": "string", "description": "Protocol display name" }, "module": { "type": "string", "description": "Protocol module" }, "category": { "type": "string", "description": "Protocol category" }, "logo": { "type": "string", "description": "Protocol logo URL" }, "chains": { "type": "array", "items": { "type": "string" }, "description": "Protocol chains" }, "protocolType": { "type": "string", "description": "Protocol type" }, "methodologyURL": { "type": "string", "description": "Methodology URL" }, "methodology": { "type": "object", "description": "Methodology details" }, "latestFetchIsOk": { "type": "boolean", "description": "Latest fetch status" }, "parentProtocol": { "type": "string", "description": "Parent protocol" }, "slug": { "type": "string", "description": "Protocol slug" }, "linkedProtocols": { "type": "array", "items": { "type": "string" }, "description": "Linked protocols" }, "id": { "type": "string", "description": "Protocol ID" } } }, "description": "List of protocols" } } }, "example": { "totalDataChart": [[1614211200, 24949], [1614297600, 103833], [1614384000, 49317]], "totalDataChartBreakdown": [ [ 1614211200, { "dYdX V3": 24949 } ], [ 1614297600, { "dYdX V3": 103833 } ] ], "breakdown24h": null, "breakdown30d": null, "chain": null, "allChains": ["Hyperliquid L1", "Solana", "Ethereum", "Arbitrum"], "total24h": 23537303133, "total48hto24h": 20741840211, "total7d": 125290755214, "total14dto7d": 71055642206, "total60dto30d": 397917690387, "total30d": 383278222548, "total1y": 3515064792266, "change_1d": 13.48, "change_7d": 40.49, "change_1m": 35.06, "change_7dover7d": 76.33, "change_30dover30d": -3.68, "total7DaysAgo": 16753244737, "total30DaysAgo": 17427351125, "totalAllTime": 6567303144819, "protocols": [ { "total24h": 8479946, "total48hto24h": 3440780, "total7d": 78424631, "total14dto7d": 60033358, "total60dto30d": 92505218, "total30d": 166435382, "total1y": 9698297388, "totalAllTime": 55654843707, "average1y": 26865089.717451524, "change_1d": 146.45, "change_7d": -55.7, "change_1m": 1226.98, "change_7dover7d": 30.64, "change_30dover30d": 79.92, "breakdown24h": { "optimism": { "Synthetix v1+v2": 3547540 } }, "breakdown30d": { "optimism": { "Synthetix v1+v2": 166435382 } }, "total7DaysAgo": 19143749, "total30DaysAgo": 639043, "defillamaId": "115", "name": "Synthetix v1+v2", "displayName": "Synthetix v1+v2", "module": "synthetix", "category": "Synthetics", "logo": "https://icons.llamao.fi/icons/protocols/synthetix.png", "chains": ["OP Mainnet"], "protocolType": "protocol", "methodologyURL": "https://github.com/DefiLlama/dimension-adapters/blob/master/dexs/synthetix", "methodology": { "UserFees": "Fees paid by users", "Fees": "Fees paid by users", "Revenue": "Fees paid by users", "ProtocolRevenue": "Percentage of fees going to treasury", "SupplySideRevenue": "LPs revenue" }, "latestFetchIsOk": true, "parentProtocol": "parent#synthetix", "slug": "synthetix-v1+v2", "linkedProtocols": ["Synthetix", "Synthetix v1+v2", "Synthetix V3"], "id": "115" } ] } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.volumes.getDerivativesOverview()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.volumes.getDerivativesOverview()" } ] } }, "/api/summary/derivatives/{protocol}": { "get": { "tags": ["perps"], "summary": "Volume Details about a specific perp protocol", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug", "schema": { "type": "string", "example": "hyperliquid" } }, { "name": "excludeTotalDataChart", "in": "query", "required": true, "description": "true to exclude aggregated chart from response", "schema": { "type": "boolean", "example": true } }, { "name": "excludeTotalDataChartBreakdown", "in": "query", "required": true, "description": "true to exclude broken down chart from response", "schema": { "type": "boolean", "example": true } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Protocol ID" }, "name": { "type": "string", "description": "Protocol name" }, "url": { "type": "string", "description": "Protocol URL" }, "referralUrl": { "type": "string", "description": "Referral URL" }, "description": { "type": "string", "description": "Protocol description" }, "logo": { "type": "string", "description": "Protocol logo URL" }, "gecko_id": { "type": "string", "description": "CoinGecko ID" }, "cmcId": { "type": "string", "description": "CoinMarketCap ID" }, "chains": { "type": "array", "items": { "type": "string" }, "description": "Supported chains" }, "twitter": { "type": "string", "description": "Twitter handle" }, "github": { "type": "array", "items": { "type": "string" }, "description": "GitHub repositories" }, "symbol": { "type": "string", "description": "Token symbol" }, "address": { "type": "string", "description": "Protocol address" }, "childProtocols": { "type": "array", "items": { "type": "object" }, "description": "Child protocols" }, "linkedProtocols": { "type": "array", "items": { "type": "string" }, "description": "Linked protocols" }, "defillamaId": { "type": "string", "description": "DefiLlama protocol ID" }, "disabled": { "type": "boolean", "nullable": true, "description": "Whether protocol is disabled" }, "displayName": { "type": "string", "description": "Display name" }, "module": { "type": "string", "nullable": true, "description": "Module name" }, "category": { "type": "string", "nullable": true, "description": "Protocol category" }, "methodologyURL": { "type": "string", "nullable": true, "description": "Methodology URL" }, "methodology": { "type": "object", "nullable": true, "description": "Methodology details" }, "forkedFrom": { "type": "string", "nullable": true, "description": "Forked from protocol" }, "audits": { "type": "array", "nullable": true, "description": "Audit information" }, "audit_links": { "type": "array", "nullable": true, "description": "Audit links" }, "versionKey": { "type": "string", "nullable": true, "description": "Version key" }, "governanceID": { "type": "string", "nullable": true, "description": "Governance ID" }, "treasury": { "type": "string", "nullable": true, "description": "Treasury address" }, "parentProtocol": { "type": "string", "nullable": true, "description": "Parent protocol" }, "previousNames": { "type": "array", "nullable": true, "description": "Previous names" }, "latestFetchIsOk": { "type": "boolean", "description": "Latest fetch status" }, "slug": { "type": "string", "description": "Protocol slug" }, "protocolType": { "type": "string", "description": "Protocol type" }, "total24h": { "type": "number", "description": "24 hour volume" }, "total48hto24h": { "type": "number", "description": "48h to 24h volume" }, "total7d": { "type": "number", "description": "7 day volume" }, "totalAllTime": { "type": "number", "description": "All time volume" }, "totalDataChart": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Timestamp" }, { "type": "number", "description": "Volume value" } ] }, "description": "Total data chart with timestamps and volumes" }, "totalDataChartBreakdown": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Timestamp" }, { "type": "object", "description": "Chain and protocol breakdown" } ] }, "description": "Total data chart breakdown by chain and protocol" }, "change_1d": { "type": "number", "description": "1 day change percentage" } } }, "example": { "id": "parent#hyperliquid", "name": "Hyperliquid", "url": "https://hyperliquid.xyz", "referralUrl": "https://app.hyperliquid.xyz/join/DEFILLAMAO", "description": "Hyperliquid is a decentralized perpetual exchange with best-in-class speed, liquidity, and price", "logo": "https://icons.llama.fi/hyperliquid.png", "gecko_id": "hyperliquid", "cmcId": "32196", "chains": ["Hyperliquid L1"], "twitter": "HyperliquidX", "github": ["hyperliquid-dex"], "symbol": "HYPE", "address": "hyperliquid:0x0d01dc56dcaaca66ad901c959b4011ec", "childProtocols": [{}], "linkedProtocols": ["Hyperliquid", "Hyperliquid Perps"], "defillamaId": "parent#hyperliquid", "disabled": null, "displayName": "Hyperliquid", "module": null, "category": null, "methodologyURL": null, "methodology": null, "forkedFrom": null, "audits": null, "audit_links": null, "versionKey": null, "governanceID": null, "treasury": null, "parentProtocol": null, "previousNames": null, "latestFetchIsOk": true, "slug": "hyperliquid", "protocolType": "protocol", "total24h": 16946528076, "total48hto24h": 14792562336, "total7d": 86747987334, "totalAllTime": 2003035982525, "totalDataChart": [[1752710400, 16946528076], [1752796800, 21220070880]], "totalDataChartBreakdown": [ [ 1752710400, { "Hyperliquid L1": { "Hyperliquid Perps": 16946528076 } } ], [ 1752796800, { "Hyperliquid L1": { "Hyperliquid Perps": 21220070880 } } ] ], "change_1d": 14.56 } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.volumes.getDerivativesSummary('')" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.volumes.getDerivativesSummary('')" } ] } }, "/api/protocols": { "get": { "tags": ["TVL"], "summary": "List all protocols on defillama along with their tvl", "responses": { "200": { "description": "Array of all protocols with their TVL data", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "2269" }, "name": { "type": "string", "example": "Aave" }, "symbol": { "type": "string", "example": "AAVE" }, "category": { "type": "string", "example": "Lending" }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Polygon"] }, "tvl": { "type": "number", "example": 5200000000 }, "chainTvls": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "Ethereum": 3200000000, "Polygon": 2000000000 } }, "change_1d": { "type": "number", "example": 2.1 }, "change_7d": { "type": "number", "example": -5.3 } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.tvl.getProtocols()" }, { "lang": "python", "label": "Python SDK", "source": "result = client.tvl.getProtocols()" } ] } }, "/api/protocol/{protocol}": { "get": { "tags": ["TVL"], "summary": "Get historical TVL of a protocol and breakdowns by token and chain", "parameters": [ { "name": "protocol", "in": "path", "description": "protocol slug", "required": true, "schema": { "type": "string", "example": "aave" } } ], "responses": { "200": { "description": "Protocol details with historical TVL data and chain breakdowns", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "parent#aave" }, "name": { "type": "string", "example": "AAVE" }, "symbol": { "type": "string", "example": "AAVE" }, "category": { "type": "string", "example": "Lending" }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Polygon", "Avalanche"] }, "currentChainTvls": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "Ethereum": 3200000000, "Polygon": 1500000000 } }, "chainTvls": { "type": "object", "additionalProperties": { "type": "object", "properties": { "tvl": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "number", "example": 1609459200 }, "totalLiquidityUSD": { "type": "number", "example": 1000000 } } } }, "tokens": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "number", "example": 1609459200 }, "tokens": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "USDC": 1000000, "USDT": 800000 } } } } } } } } } } } } }, "404": { "description": "Protocol not found" } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.tvl.getProtocol('')" }, { "lang": "python", "label": "Python SDK", "source": "result = client.tvl.getProtocol('')" } ] } }, "/api/v2/historicalChainTvl": { "get": { "tags": ["TVL"], "summary": "Get historical TVL (excludes liquid staking and double counted tvl) of DeFi on all chains", "responses": { "200": { "description": "Historical TVL data for all chains combined", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "number", "description": "Unix timestamp", "example": 1609459200 }, "tvl": { "type": "number", "description": "Total Value Locked in USD across all chains", "example": 15000000000 } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.tvl.getHistoricalChainTvl()" }, { "lang": "python", "label": "Python SDK", "source": "result = client.tvl.getHistoricalChainTvl()" } ] } }, "/api/v2/historicalChainTvl/{chain}": { "get": { "tags": ["TVL"], "summary": "Get historical TVL (excludes liquid staking and double counted tvl) of a chain", "parameters": [ { "name": "chain", "in": "path", "required": true, "description": "chain slug, you can get these from /chains or the chains property on /protocols", "schema": { "type": "string", "example": "Ethereum" } } ], "responses": { "200": { "description": "Historical TVL data for the specified chain", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "number", "description": "Unix timestamp", "example": 1609459200 }, "tvl": { "type": "number", "description": "Total Value Locked in USD for this chain", "example": 45000000000 } } } } } } }, "404": { "description": "Chain not found" } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.tvl.getHistoricalChainTvl('')" }, { "lang": "python", "label": "Python SDK", "source": "result = client.tvl.getHistoricalChainTvl()" } ] } }, "/api/tvl/{protocol}": { "get": { "tags": ["TVL"], "summary": "Simplified endpoint to get current TVL of a protocol", "description": "Simplified endpoint that only returns a number, the current TVL of a protocol", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug", "schema": { "type": "string", "example": "uniswap" } } ], "responses": { "200": { "description": "Current TVL of the protocol in USD", "content": { "application/json": { "schema": { "type": "number", "description": "Total Value Locked in USD", "example": 4962012809.795062 } } } }, "404": { "description": "Protocol not found" } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.tvl.getTvl('')" }, { "lang": "python", "label": "Python SDK", "source": "result = client.tvl.getTvl('')" } ] } }, "/api/v2/chains": { "get": { "tags": ["TVL"], "summary": "Get current TVL of all chains", "responses": { "200": { "description": "Array of all chains with their TVL data", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "gecko_id": { "type": "string", "nullable": true, "description": "CoinGecko ID for the chain's native token", "example": "ethereum" }, "tvl": { "type": "number", "description": "Total Value Locked in USD", "example": 65998652431.40251 }, "tokenSymbol": { "type": "string", "nullable": true, "description": "Native token symbol", "example": "ETH" }, "cmcId": { "type": "string", "nullable": true, "description": "CoinMarketCap ID", "example": "1027" }, "name": { "type": "string", "description": "Chain name", "example": "Ethereum" }, "chainId": { "type": "number", "nullable": true, "description": "Chain ID number", "example": 1 } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.tvl.getChains()" }, { "lang": "python", "label": "Python SDK", "source": "result = client.tvl.getChains()" } ] } }, "/api/v2/metrics/tvl/protocol/{protocol}": { "get": { "tags": ["TVL"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get aggregate TVL metrics for a protocol", "description": "Returns protocol metadata along with current TVL figures, chain breakdowns, and other aggregate metrics.", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug", "schema": { "type": "string", "example": "aave" } } ], "responses": { "200": { "description": "Protocol TVL metrics", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "parent#aave" }, "name": { "type": "string", "example": "Aave" }, "address": { "type": "string", "nullable": true, "example": "0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9" }, "symbol": { "type": "string", "nullable": true, "example": "AAVE" }, "url": { "type": "string", "example": "https://aave.com" }, "referralUrl": { "type": "string", "nullable": true }, "description": { "type": "string", "example": "Aave is an Open Source and Non-Custodial protocol to earn interest on deposits & borrow assets" }, "chain": { "type": "string", "example": "Multi-Chain" }, "logo": { "type": "string", "example": "https://icons.llama.fi/aave.png" }, "audits": { "type": "string", "nullable": true }, "audit_note": { "type": "string", "nullable": true }, "gecko_id": { "type": "string", "nullable": true, "example": "aave" }, "cmcId": { "type": "string", "nullable": true, "example": "7278" }, "category": { "type": "string", "example": "Lending" }, "tags": { "type": "array", "nullable": true, "items": { "type": "string" } }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Polygon", "Avalanche"] }, "module": { "type": "string", "nullable": true }, "treasury": { "type": "string", "nullable": true }, "twitter": { "type": "string", "example": "AaveAave" }, "audit_links": { "type": "array", "items": { "type": "string" } }, "openSource": { "type": "boolean" }, "forkedFrom": { "type": "array", "items": { "type": "string" } }, "oraclesByChain": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "example": { "Ethereum": ["Chainlink"], "Polygon": ["Chainlink"] } }, "parentProtocol": { "type": "string" }, "governanceID": { "type": "array", "items": { "type": "string" } }, "github": { "type": "array", "items": { "type": "string" } }, "currentChainTvls": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "Ethereum": 3200000000, "Polygon": 1500000000 } }, "isParentProtocol": { "type": "boolean" }, "mcap": { "type": "number", "nullable": true, "example": 2400000000 }, "methodology": { "type": "string", "nullable": true }, "raises": { "type": "array", "items": { "type": "object", "properties": { "round": { "type": "string", "example": "Series A" }, "amount": { "type": "number", "example": 25000000 }, "valuation": { "type": "string" }, "source": { "type": "string" }, "date": { "type": "number", "example": 1601510400 }, "defillamaId": { "type": "string" }, "leadInvestors": { "type": "array", "items": { "type": "string" } }, "otherInvestors": { "type": "array", "items": { "type": "string" } }, "investors": { "type": "array", "items": { "type": "string" } } } } }, "otherProtocols": { "type": "array", "items": { "type": "string" } }, "hallmarks": { "type": "array", "description": "Notable events in the protocol's history as [timestamp, description] pairs", "items": { "type": "array" } }, "stablecoins": { "type": "array", "items": { "type": "string" } }, "misrepresentedTokens": { "type": "boolean" }, "deprecated": { "type": "boolean" }, "rugged": { "type": "boolean" }, "deadUrl": { "type": "boolean" }, "warningBanners": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" }, "until": { "type": "string", "nullable": true }, "level": { "type": "string", "enum": ["low", "alert", "rug"] } } } }, "tokenRights": { "type": "object", "description": "Token governance and value accrual rights" }, "wrongLiquidity": { "type": "boolean" }, "tvlCodePath": { "type": "string", "description": "Path to the TVL adapter source code" } }, "example": { "id": "parent#aave", "name": "Aave", "url": "https://aave.com", "description": "Aave is an Open Source and Non-Custodial protocol to earn interest on deposits and borrow assets", "logo": "https://icons.llama.fi/aave.png", "chains": [], "gecko_id": "aave", "cmcId": "7278", "treasury": "aave.js", "twitter": "aave", "governanceID": ["snapshot:aave.eth", "eip155:1:0xEC568fffba86c094cf06b22134B23074DFE2252c"], "wrongLiquidity": true, "github": ["aave", "bgd-labs"], "stablecoins": ["gho"], "tokenRights": { "rights": [ { "label": "Governance", "hasRight": true, "details": "AAVE" }, { "label": "Treasury", "hasRight": true, "details": "AAVE" }, { "label": "Revenue", "hasRight": true, "details": "AAVE" } ], "governanceData": { "rights": "LIMITED", "details": "Governance includes protocol parameters, treasury management, upgrades & onchain revenue", "feeSwitchStatus": "ON", "feeSwitchDetails": "$50m annual budget for token buybacks" }, "holdersRevenueAndValueAccrual": { "buybacks": "ACTIVE", "dividends": "NONE", "burns": "NONE", "primaryValueAccrual": "Buybacks - $50M yearly budget for buybacks" }, "tokenAlignment": { "fundraising": "TOKEN", "raiseDetailsLink": { "label": "Strategic Round (Decrypt)", "url": "https://decrypt.co/44653/aave-raises-25-million-to-bring-defi-to-institutions" }, "associatedEntities": ["DAO", "Labs", "Parent / Holdings Co"], "equityRevenueCapture": "PARTIAL", "equityStatement": "Labs owns the interface and offchain revenue" } }, "symbol": "AAVE", "address": "0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9", "currentChainTvls": { "Ethereum-staking": 300390294, "Ethereum-pool2": 1001784, "Avalanche-borrowed": 230805193, "Ethereum": 21541108640, "Ethereum-borrowed": 13105470847, "Polygon": 164069009, "Avalanche": 425186004, "Polygon-borrowed": 71777370, "staking": 300390294, "pool2": 1001784, "borrowed": 16477546481, "Base": 720897079, "Base-borrowed": 539408955, "Arbitrum": 710909114, "Arbitrum-borrowed": 493502165, "OP Mainnet": 53112825, "OP Mainnet-borrowed": 30898499, "Gnosis": 67454440, "Gnosis-borrowed": 28683972, "Mantle": 285136854, "Mantle-borrowed": 186143806, "Plasma": 1958242285, "Plasma-borrowed": 1655750534, "BSC": 174954075, "BSC-borrowed": 70470380, "Linea": 49717184, "Linea-borrowed": 38569924, "Sonic": 12939987, "Sonic-borrowed": 5315322, "Scroll": 6971724, "Scroll-borrowed": 5290161, "ZKsync Era": 2782917, "ZKsync Era-borrowed": 1245328, "Soneium": 2038301, "Soneium-borrowed": 292179, "Metis": 959354, "Metis-borrowed": 159370, "Celo": 13373563, "Celo-borrowed": 4923675, "MegaETH": 19380664, "MegaETH-borrowed": 34443, "Aptos": 18649107, "Aptos-borrowed": 8493938, "Fantom": 4575, "Fantom-borrowed": 1034, "Harmony": 0, "Harmony-borrowed": 309375 }, "isParentProtocol": true, "raises": [ { "date": 1594771200, "name": "Aave", "round": "Private token sale", "amount": 3, "source": "https://www.dcforecasts.com/altcoin-news/aave-raises-3m-from-three-arrows-capital-and-framework-ventures/", "leadInvestors": ["Framework Ventures", "3AC"], "otherInvestors": [], "valuation": null, "defillamaId": "111" }, { "date": 1602460800, "name": "Aave", "round": "Strategic ", "amount": 25, "source": "https://decrypt.co/44653/aave-raises-25-million-to-bring-defi-to-institutions", "leadInvestors": ["Blockchain Capital", "Blockchain.com Ventures", "Standard Crypto"], "otherInvestors": [], "valuation": null, "defillamaId": "111" }, { "date": 1594166400, "name": "Aave", "round": "Private token sale", "amount": 4.5, "source": "https://decrypt.co/34991/parafi-invests-defi-lending-protocol", "leadInvestors": ["ParaFi Capital"], "otherInvestors": [], "valuation": null, "defillamaId": "111" }, { "date": 1512000000, "name": "Aave", "round": "ICO", "amount": 16.2, "source": "https://twitter.com/aaveaave/status/936247348816175104", "leadInvestors": [], "otherInvestors": [], "valuation": null, "defillamaId": "1838" } ], "mcap": 1775192426.0010407, "otherProtocols": [ "Aave", "Aave V3", "Aave Horizon RWA", "Aave V2", "Aave Aptos", "Aave V1", "Aave Arc" ], "hallmarks": [ [1619395200, "Start Ethereum V2 Rewards"], [1633305600, "Start AVAX V2 Rewards"], [1635292800, "Potential xSUSHI attack found"], [1650412800, "Start AVAX Rewards"], [1651881600, "UST depeg"], [1654819200, "stETH depeg"], [1659571200, "Start OP Rewards"] ] } } } } }, "404": { "description": "Protocol not found" } } } }, "/api/v2/chart/tvl/protocol/{protocol}": { "get": { "tags": ["TVL"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get historical TVL chart for a protocol", "description": "Returns an array of [timestamp, value] pairs representing the protocol's TVL over time. By default returns the base TVL metric. Use the `key` parameter to select a different metric or aggregate all metrics.", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug", "schema": { "type": "string", "example": "uniswap" } }, { "name": "key", "in": "query", "required": false, "description": "Metric to return. Omit for default TVL. Use \"all\" for the sum of tvl+borrowed+staking+pool2+vesting, or a specific metric like \"staking\", \"borrowed\", \"vesting\", \"pool2\".", "schema": { "type": "string", "enum": ["all", "staking", "borrowed", "vesting", "pool2"], "example": "all" } } ], "responses": { "200": { "description": "Array of [timestamp, value] pairs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2, "example": [1609459200, 5200000000] } } } } }, "404": { "description": "Protocol not found" } } } }, "/api/v2/chart/tvl/protocol/{protocol}/chain-breakdown": { "get": { "tags": ["TVL"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get historical TVL chart for a protocol broken down by chain", "description": "Returns an array of [timestamp, { chain: value }] pairs showing the selected metric per chain over time.", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug", "schema": { "type": "string", "example": "euler" } }, { "name": "key", "in": "query", "required": false, "description": "Metric to return. Omit for default TVL. Use \"all\" for the sum of tvl+borrowed+staking+pool2+vesting, or a specific metric like \"staking\", \"borrowed\", \"vesting\", \"pool2\".", "schema": { "type": "string", "enum": ["all", "staking", "borrowed", "vesting", "pool2"], "example": "borrowed" } } ], "responses": { "200": { "description": "Array of [timestamp, chainBreakdown] pairs. Each entry is a two-element array: first element is a unix timestamp, second is an object mapping chain names to values.", "content": { "application/json": { "schema": { "type": "array", "example": [ [ 1609459200, { "Ethereum": 3200000000, "Polygon": 1500000000 } ], [ 1609545600, { "Ethereum": 3250000000, "Polygon": 1520000000 } ] ] } } } }, "404": { "description": "Protocol not found" } } } }, "/api/v2/chart/tvl/protocol/{protocol}/token-breakdown": { "get": { "tags": ["TVL"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get historical TVL chart for a protocol broken down by token", "description": "Returns an array of [timestamp, { token: value }] pairs showing TVL per token over time. Values are in USD by default, set currency=tokens for raw token amounts.", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug", "schema": { "type": "string", "example": "aave" } }, { "name": "key", "in": "query", "required": false, "description": "Metric to return. Omit for default TVL. Use \"all\" for the sum of tvl+borrowed+staking+pool2+vesting, or a specific metric like \"staking\", \"borrowed\", \"vesting\", \"pool2\".", "schema": { "type": "string", "enum": ["all", "staking", "borrowed", "vesting", "pool2"] } }, { "name": "currency", "in": "query", "required": false, "description": "Set to \"tokens\" to return values denominated in raw token amounts instead of USD", "schema": { "type": "string", "enum": ["usd", "token", "raw"], "example": "usd" } } ], "responses": { "200": { "description": "Array of [timestamp, tokenBreakdown] pairs. Each entry is a two-element array: first element is a unix timestamp, second is an object mapping token names to values (USD by default, raw token amounts if currency=tokens).", "content": { "application/json": { "schema": { "type": "array", "example": [ [ 1609459200, { "USDC": 1000000000, "USDT": 800000000, "WETH": 500000000 } ], [ 1609545600, { "USDC": 1010000000, "USDT": 810000000, "WETH": 510000000 } ] ] } } } }, "404": { "description": "Protocol not found" } } } }, "/api/v2/metrics/treasury/protocol/{protocol}": { "get": { "tags": ["Treasury"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get aggregate treasury metrics for a protocol", "description": "Returns protocol metadata along with current treasury figures and chain breakdowns.", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug", "schema": { "type": "string", "example": "aave" } } ], "responses": { "200": { "description": "Protocol treasury metrics", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "parent#aave" }, "name": { "type": "string", "example": "Aave" }, "address": { "type": "string", "nullable": true, "example": "0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9" }, "symbol": { "type": "string", "nullable": true, "example": "AAVE" }, "url": { "type": "string", "example": "https://aave.com" }, "referralUrl": { "type": "string", "nullable": true }, "description": { "type": "string", "example": "Aave is an Open Source and Non-Custodial protocol to earn interest on deposits & borrow assets" }, "chain": { "type": "string", "example": "Multi-Chain" }, "logo": { "type": "string", "example": "https://icons.llama.fi/aave.png" }, "audits": { "type": "string", "nullable": true }, "audit_note": { "type": "string", "nullable": true }, "gecko_id": { "type": "string", "nullable": true, "example": "aave" }, "cmcId": { "type": "string", "nullable": true, "example": "7278" }, "category": { "type": "string", "example": "Lending" }, "tags": { "type": "array", "nullable": true, "items": { "type": "string" } }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Polygon", "Avalanche"] }, "module": { "type": "string", "nullable": true }, "treasury": { "type": "string", "nullable": true }, "twitter": { "type": "string", "example": "AaveAave" }, "audit_links": { "type": "array", "items": { "type": "string" } }, "openSource": { "type": "boolean" }, "forkedFrom": { "type": "array", "items": { "type": "string" } }, "oraclesByChain": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "example": { "Ethereum": ["Chainlink"], "Polygon": ["Chainlink"] } }, "parentProtocol": { "type": "string" }, "governanceID": { "type": "array", "items": { "type": "string" } }, "github": { "type": "array", "items": { "type": "string" } }, "currentChainTvls": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "Ethereum": 80000000, "Polygon": 20000000 } }, "isParentProtocol": { "type": "boolean" }, "mcap": { "type": "number", "nullable": true, "example": 2400000000 }, "methodology": { "type": "string", "nullable": true }, "raises": { "type": "array", "items": { "type": "object", "properties": { "round": { "type": "string", "example": "Series A" }, "amount": { "type": "number", "example": 25000000 }, "valuation": { "type": "string" }, "source": { "type": "string" }, "date": { "type": "number", "example": 1601510400 }, "defillamaId": { "type": "string" }, "leadInvestors": { "type": "array", "items": { "type": "string" } }, "otherInvestors": { "type": "array", "items": { "type": "string" } }, "investors": { "type": "array", "items": { "type": "string" } } } } }, "otherProtocols": { "type": "array", "items": { "type": "string" } }, "hallmarks": { "type": "array", "description": "Notable events in the protocol's history as [timestamp, description] pairs", "items": { "type": "array" } }, "stablecoins": { "type": "array", "items": { "type": "string" } }, "misrepresentedTokens": { "type": "boolean" }, "deprecated": { "type": "boolean" }, "rugged": { "type": "boolean" }, "deadUrl": { "type": "boolean" }, "warningBanners": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" }, "until": { "type": "string", "nullable": true }, "level": { "type": "string", "enum": ["low", "alert", "rug"] } } } }, "tokenRights": { "type": "object", "description": "Token governance and value accrual rights" }, "wrongLiquidity": { "type": "boolean" }, "tvlCodePath": { "type": "string", "description": "Path to the TVL adapter source code" } }, "example": { "id": "parent#aave-treasury", "name": "Aave (treasury)", "url": "https://aave.com", "description": "Aave is an Open Source and Non-Custodial protocol to earn interest on deposits and borrow assets", "logo": "https://icons.llama.fi/aave.png", "chains": ["Ethereum", "Arbitrum", "OP Mainnet", "Avalanche", "Fantom", "Polygon"], "gecko_id": "aave", "cmcId": "7278", "treasury": "aave.js", "twitter": "aave", "governanceID": ["snapshot:aave.eth", "eip155:1:0xEC568fffba86c094cf06b22134B23074DFE2252c"], "wrongLiquidity": true, "github": ["aave", "bgd-labs"], "stablecoins": ["gho"], "tokenRights": { "rights": [ { "label": "Governance", "hasRight": true, "details": "AAVE" }, { "label": "Treasury", "hasRight": true, "details": "AAVE" }, { "label": "Revenue", "hasRight": true, "details": "AAVE" } ], "governanceData": { "rights": "LIMITED", "details": "Governance includes protocol parameters, treasury management, upgrades & onchain revenue", "feeSwitchStatus": "ON", "feeSwitchDetails": "$50m annual budget for token buybacks" }, "holdersRevenueAndValueAccrual": { "buybacks": "ACTIVE", "dividends": "NONE", "burns": "NONE", "primaryValueAccrual": "Buybacks - $50M yearly budget for buybacks" }, "tokenAlignment": { "fundraising": "TOKEN", "raiseDetailsLink": { "label": "Strategic Round (Decrypt)", "url": "https://decrypt.co/44653/aave-raises-25-million-to-bring-defi-to-institutions" }, "associatedEntities": ["DAO", "Labs", "Parent / Holdings Co"], "equityRevenueCapture": "PARTIAL", "equityStatement": "Labs owns the interface and offchain revenue" } }, "symbol": "AAVE", "address": "0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9", "module": "treasury/aave.js", "category": "Treasury", "tvlCodePath": "https://github.com/DefiLlama/DefiLlama-Adapters/blob/main/projects/treasury/aave.js", "currentChainTvls": { "Ethereum-OwnTokens": 51486143.11756, "Arbitrum-OwnTokens": 108.33167, "OP Mainnet-OwnTokens": 339.41814, "Avalanche-OwnTokens": 200.26047, "Fantom-OwnTokens": 0, "Fantom": 5317.95627, "Polygon-OwnTokens": 0.49868, "Arbitrum": 7665284.15367, "Avalanche": 12653199.04222, "OP Mainnet": 266147.25573, "Ethereum": 50207476.33278, "Polygon": 774382.58832, "OwnTokens": 51486791.62651 }, "raises": [], "mcap": 1775192426.0010407 } } } } }, "404": { "description": "Protocol not found" } } } }, "/api/v2/chart/treasury/protocol/{protocol}": { "get": { "tags": ["Treasury"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get historical treasury chart for a protocol", "description": "Returns an array of [timestamp, value] pairs representing the protocol's treasury value over time. By default excludes the protocol's own tokens (OwnTokens).", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug", "schema": { "type": "string", "example": "uniswap" } }, { "name": "key", "in": "query", "required": false, "description": "Token filter. Omit to exclude OwnTokens (default). Use \"OwnTokens\" to return only the protocol's own tokens, or \"all\" for the sum of all tokens including OwnTokens.", "schema": { "type": "string", "enum": ["OwnTokens", "all"], "example": "all" } } ], "responses": { "200": { "description": "Array of [timestamp, value] pairs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2, "example": [1609459200, 120000000] } } } } }, "404": { "description": "Protocol not found" } } } }, "/api/v2/chart/treasury/protocol/{protocol}/chain-breakdown": { "get": { "tags": ["Treasury"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get historical treasury chart for a protocol broken down by chain", "description": "Returns an array of [timestamp, { chain: value }] pairs showing treasury value per chain over time. By default excludes the protocol's own tokens.", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug", "schema": { "type": "string", "example": "aave" } }, { "name": "key", "in": "query", "required": false, "description": "Token filter. Omit to exclude OwnTokens (default). Use \"OwnTokens\" to return only the protocol's own tokens, or \"all\" for the sum of all tokens including OwnTokens.", "schema": { "type": "string", "enum": ["OwnTokens", "all"], "example": "OwnTokens" } } ], "responses": { "200": { "description": "Array of [timestamp, chainBreakdown] pairs. Each entry is a two-element array: first element is a unix timestamp, second is an object mapping chain names to treasury values.", "content": { "application/json": { "schema": { "type": "array", "example": [ [ 1609459200, { "Ethereum": 80000000, "Polygon": 20000000 } ], [ 1609545600, { "Ethereum": 81000000, "Polygon": 20500000 } ] ] } } } }, "404": { "description": "Protocol not found" } } } }, "/api/v2/chart/treasury/protocol/{protocol}/token-breakdown": { "get": { "tags": ["Treasury"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get historical treasury chart for a protocol broken down by token", "description": "Returns an array of [timestamp, { token: value }] pairs showing treasury value per token over time. By default excludes OwnTokens and values are in USD. Use key and currency params to customize.", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug", "schema": { "type": "string", "example": "aave" } }, { "name": "key", "in": "query", "required": false, "description": "Token filter. Omit to exclude OwnTokens (default). Use \"OwnTokens\" to return only the protocol's own tokens, or \"all\" for the sum of all tokens including OwnTokens.", "schema": { "type": "string", "enum": ["OwnTokens", "all"], "example": "OwnTokens" } }, { "name": "currency", "in": "query", "required": false, "description": "Set to \"tokens\" to return values denominated in raw token amounts instead of USD", "schema": { "type": "string", "enum": ["usd", "token", "raw"], "example": "usd" } } ], "responses": { "200": { "description": "Array of [timestamp, tokenBreakdown] pairs. Each entry is a two-element array: first element is a unix timestamp, second is an object mapping token names to treasury values (USD by default, raw token amounts if currency=tokens).", "content": { "application/json": { "schema": { "type": "array", "example": [ [ 1609459200, { "AAVE": 50000000, "USDC": 30000000, "WETH": 20000000 } ], [ 1609545600, { "AAVE": 51000000, "USDC": 30500000, "WETH": 20500000 } ] ] } } } }, "404": { "description": "Protocol not found" } } } }, "/api/v2/metrics/oracle": { "get": { "tags": ["Oracles"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get oracle data overview", "description": "Returns an object mapping oracle names to arrays of protocol names that use each oracle.", "responses": { "200": { "description": "Oracle data overview", "content": { "application/json": { "schema": { "type": "object", "properties": { "oracles": { "type": "object", "description": "Mapping of oracle names to arrays of protocol names using that oracle", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "example": { "Chainlink": ["Aave V2", "Compound V2", "Synthetix v1+v2"], "Band": ["Mirror", "Anchor"], "TWAP": ["Uniswap V3"] } } } } } } } } } }, "/api/v2/chart/oracle": { "get": { "tags": ["Oracles"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get timeseries chart data for all oracles", "description": "Returns an array of [timestamp, value] pairs representing total TVL across all oracles over time.", "responses": { "200": { "description": "Array of [timestamp, value] pairs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2, "example": [1546560000, 273845651.27] } } } } } } } }, "/api/v2/chart/oracle/chain-breakdown": { "get": { "tags": ["Oracles"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get timeseries chart data breakdown by chain", "description": "Returns an array of objects with a timestamp and TVL values broken down by chain.", "responses": { "200": { "description": "Array of timestamped chain breakdowns", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "number", "description": "Unix timestamp", "example": 1546560000 } }, "additionalProperties": { "type": "number" } }, "example": [ { "timestamp": 1546560000, "Ethereum": 273845651.27 }, { "timestamp": 1546646400, "Ethereum": 288674544.41 } ] } } } } } } }, "/api/v2/chart/oracle/protocol-breakdown": { "get": { "tags": ["Oracles"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get timeseries chart data breakdown by protocol", "description": "Returns an array of objects with a timestamp and TVL values broken down by oracle/protocol.", "responses": { "200": { "description": "Array of timestamped protocol breakdowns", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "number", "description": "Unix timestamp", "example": 1546560000 } }, "additionalProperties": { "type": "number" } }, "example": [ { "timestamp": 1546560000, "Chronicle": 273845651.27 }, { "timestamp": 1546646400, "Chronicle": 288674544.41 } ] } } } } } } }, "/api/v2/chart/oracle/protocol/{protocol}": { "get": { "tags": ["Oracles"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get timeseries chart data by protocol/oracle", "description": "Returns an array of [timestamp, value] pairs representing TVL over time for a specific oracle/protocol.", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "oracle/protocol name", "schema": { "type": "string", "example": "Chainlink" } } ], "responses": { "200": { "description": "Array of [timestamp, value] pairs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2, "example": [1557273600, 9546.16] } } } } }, "404": { "description": "Protocol not found" } } } }, "/api/v2/chart/oracle/protocol/{protocol}/chain-breakdown": { "get": { "tags": ["Oracles"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get chain breakdown timeseries chart data by protocol/oracle", "description": "Returns an array of objects with a timestamp and TVL values broken down by chain for a specific oracle/protocol.", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "oracle/protocol name", "schema": { "type": "string", "example": "Chainlink" } } ], "responses": { "200": { "description": "Array of timestamped chain breakdowns", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "number", "description": "Unix timestamp", "example": 1557273600 } }, "additionalProperties": { "type": "number" } }, "example": [ { "timestamp": 1557273600, "Ethereum": 9546.16 }, { "timestamp": 1557360000, "Ethereum": 10826.13 } ] } } } }, "404": { "description": "Protocol not found" } } } }, "/api/v2/chart/oracle/chain/{chain}": { "get": { "tags": ["Oracles"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get timeseries chart data by chain", "description": "Returns an array of [timestamp, value] pairs representing oracle TVL over time for a specific chain.", "parameters": [ { "name": "chain", "in": "path", "required": true, "description": "chain name", "schema": { "type": "string", "example": "Ethereum" } } ], "responses": { "200": { "description": "Array of [timestamp, value] pairs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2, "example": [1546560000, 273845651.27] } } } } }, "404": { "description": "Chain not found" } } } }, "/api/v2/chart/oracle/chain/{chain}/protocol-breakdown": { "get": { "tags": ["Oracles"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get protocol breakdown timeseries chart data by chain", "description": "Returns an array of objects with a timestamp and TVL values broken down by oracle/protocol for a specific chain.", "parameters": [ { "name": "chain", "in": "path", "required": true, "description": "chain name", "schema": { "type": "string", "example": "Ethereum" } } ], "responses": { "200": { "description": "Array of timestamped protocol breakdowns", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "number", "description": "Unix timestamp", "example": 1546560000 } }, "additionalProperties": { "type": "number" } }, "example": [ { "timestamp": 1546560000, "Chronicle": 273845651.27 }, { "timestamp": 1546646400, "Chronicle": 288674544.41 } ] } } } }, "404": { "description": "Chain not found" } } } }, "/api/v2/metrics/fork": { "get": { "tags": ["Forks"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get fork data overview", "description": "Returns an object mapping fork names to arrays of protocol names that are forks of each protocol.", "responses": { "200": { "description": "Fork data overview", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "example": { "Uniswap V2": ["SushiSwap", "PancakeSwap AMM", "QuickSwap Dex"], "Aave V2": ["Geist Finance", "Hundred Finance"] } } } } } } } }, "/api/v2/chart/fork/protocol-breakdown": { "get": { "tags": ["Forks"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get timeseries chart data breakdown by protocol", "description": "Returns an array of objects with a timestamp and TVL values broken down by fork protocol.", "responses": { "200": { "description": "Array of timestamped protocol breakdowns", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "number", "description": "Unix timestamp", "example": 1599264000 } }, "additionalProperties": { "type": "number" } }, "example": [ { "timestamp": 1599696000, "Uniswap V2": 1082367977.05 }, { "timestamp": 1599868800, "Uniswap V2": 1456479137.61, "Saddle Finance": 41.34 } ] } } } } } } }, "/api/v2/chart/fork/protocol/{protocol}": { "get": { "tags": ["Forks"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get timeseries chart data by protocol", "description": "Returns an array of [timestamp, value] pairs representing TVL over time for all forks of a specific protocol.", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug", "schema": { "type": "string", "example": "aave-v3" } } ], "responses": { "200": { "description": "Array of [timestamp, value] pairs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2, "example": [1682899200, 31.73] } } } } }, "404": { "description": "Protocol not found" } } } }, "/api/overview/dexs": { "get": { "tags": ["volumes"], "summary": "List all dexs along with summaries of their volumes and dataType history data", "parameters": [ { "name": "excludeTotalDataChart", "in": "query", "required": true, "description": "true to exclude aggregated chart from response", "schema": { "type": "boolean", "example": true } }, { "name": "excludeTotalDataChartBreakdown", "in": "query", "required": true, "description": "true to exclude broken down chart from response", "schema": { "type": "boolean", "example": true } } ], "responses": { "200": { "description": "Overview of all DEXs with volume data", "content": { "application/json": { "schema": { "type": "object", "properties": { "protocols": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Uniswap" }, "displayName": { "type": "string", "example": "Uniswap V3" }, "total24h": { "type": "number", "example": 1500000000 }, "total7d": { "type": "number", "example": 10000000000 }, "change_1d": { "type": "number", "example": 5.2 }, "change_7d": { "type": "number", "example": -2.1 }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Polygon"] } } } }, "totalDataChart": { "type": "array", "items": { "type": "array", "items": { "oneOf": [ { "type": "number" }, { "type": "object" } ] }, "example": [1640995200, 2500000000] } }, "allChains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "BSC", "Polygon"] } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.volumes.getDexOverview()" }, { "lang": "python", "label": "Python SDK", "source": "result = client.volumes.getDexOverview()" } ] } }, "/api/overview/dexs/{chain}": { "get": { "tags": ["volumes"], "summary": "List all dexs along with summaries of their volumes and dataType history data filtering by chain", "parameters": [ { "name": "chain", "in": "path", "required": true, "description": "chain name, list of all supported chains can be found under allChains attribute in /overview/dexs response", "schema": { "type": "string", "example": "ethereum" } }, { "name": "excludeTotalDataChart", "in": "query", "required": true, "description": "true to exclude aggregated chart from response", "schema": { "type": "boolean", "example": true } }, { "name": "excludeTotalDataChartBreakdown", "in": "query", "required": true, "description": "true to exclude broken down chart from response", "schema": { "type": "boolean", "example": true } } ], "responses": { "200": { "description": "Overview of DEXs on specified chain with volume data", "content": { "application/json": { "schema": { "type": "object", "properties": { "protocols": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Uniswap" }, "total24h": { "type": "number", "example": 800000000 }, "change_1d": { "type": "number", "example": 3.2 } } } }, "totalDataChart": { "type": "array", "items": { "type": "array", "example": [1640995200, 1200000000] } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.volumes.getDexOverviewByChain('')" }, { "lang": "python", "label": "Python SDK", "source": "result = client.volumes.getDexOverviewByChain('')" } ] } }, "/api/summary/dexs/{protocol}": { "get": { "tags": ["volumes"], "summary": "Get summary of dex volume with historical data", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug", "schema": { "type": "string", "example": "uniswap" } }, { "name": "excludeTotalDataChart", "in": "query", "required": true, "description": "true to exclude aggregated chart from response", "schema": { "type": "boolean", "example": true } }, { "name": "excludeTotalDataChartBreakdown", "in": "query", "required": true, "description": "true to exclude broken down chart from response", "schema": { "type": "boolean", "example": true } } ], "responses": { "200": { "description": "DEX protocol volume summary with historical data", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Uniswap" }, "total24h": { "type": "number", "example": 1500000000 }, "totalAllTime": { "type": "number", "example": 500000000000 }, "totalDataChart": { "type": "array", "items": { "type": "array", "example": [1640995200, 1500000000] } }, "totalDataChartBreakdown": { "type": "array", "items": { "type": "array", "example": [ 1640995200, { "Uniswap V3": 1200000000, "Uniswap V2": 300000000 } ] } }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Polygon"] } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.volumes.getDexSummary('')" }, { "lang": "python", "label": "Python SDK", "source": "result = client.volumes.getDexSummary('')" } ] } }, "/api/overview/options": { "get": { "tags": ["volumes"], "summary": "List all options dexs along with summaries of their volumes and dataType history data", "parameters": [ { "name": "excludeTotalDataChart", "in": "query", "required": true, "description": "true to exclude aggregated chart from response", "schema": { "type": "boolean", "example": true } }, { "name": "excludeTotalDataChartBreakdown", "in": "query", "required": true, "description": "true to exclude broken down chart from response", "schema": { "type": "boolean", "example": true } }, { "name": "dataType", "in": "query", "required": false, "description": "Desired data type, dailyNotionalVolume by default.", "schema": { "type": "string", "enum": ["dailyPremiumVolume", "dailyNotionalVolume"], "example": "dailyPremiumVolume" } } ], "responses": { "200": { "description": "Overview of all options DEXs with volume data", "content": { "application/json": { "schema": { "type": "object", "properties": { "protocols": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Deribit" }, "total24h": { "type": "number", "example": 500000000 }, "change_1d": { "type": "number", "example": 8.5 } } } }, "totalDataChart": { "type": "array", "items": { "type": "array", "example": [1640995200, 750000000] } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.volumes.getOptionsOverview()" }, { "lang": "python", "label": "Python SDK", "source": "result = client.volumes.getOptionsOverview()" } ] } }, "/api/overview/options/{chain}": { "get": { "tags": ["volumes"], "summary": "List all options dexs along with summaries of their volumes and dataType history data filtering by chain", "parameters": [ { "name": "chain", "in": "path", "required": true, "description": "chain name, list of all supported chains can be found under allChains attribute in /overview/options response", "schema": { "type": "string", "example": "ethereum" } }, { "name": "excludeTotalDataChart", "in": "query", "required": true, "description": "true to exclude aggregated chart from response", "schema": { "type": "boolean", "example": true } }, { "name": "excludeTotalDataChartBreakdown", "in": "query", "required": true, "description": "true to exclude broken down chart from response", "schema": { "type": "boolean", "example": true } }, { "name": "dataType", "in": "query", "required": false, "description": "Desired data type, dailyNotionalVolume by default.", "schema": { "type": "string", "enum": ["dailyPremiumVolume", "dailyNotionalVolume"], "example": "dailyPremiumVolume" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "totalDataChart": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Unix timestamp" }, { "type": "number", "description": "Total volume value" } ] }, "description": "Historical chart data with timestamps and total volumes" }, "totalDataChartBreakdown": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Unix timestamp" }, { "type": "object", "additionalProperties": { "type": "number" }, "description": "Protocol breakdown with volume values" } ] }, "description": "Historical chart data broken down by protocol" }, "breakdown24h": { "type": "object", "nullable": true, "description": "24-hour breakdown data" }, "breakdown30d": { "type": "object", "nullable": true, "description": "30-day breakdown data" }, "chain": { "type": "string", "description": "Chain name" }, "allChains": { "type": "array", "items": { "type": "string" }, "description": "List of all supported chains" }, "total24h": { "type": "number", "description": "Total 24-hour volume" }, "total48hto24h": { "type": "number", "description": "Total 48-hour to 24-hour volume" }, "total7d": { "type": "number", "description": "Total 7-day volume" }, "total14dto7d": { "type": "number", "description": "Total 14-day to 7-day volume" }, "total60dto30d": { "type": "number", "description": "Total 60-day to 30-day volume" }, "total30d": { "type": "number", "description": "Total 30-day volume" }, "total1y": { "type": "number", "description": "Total 1-year volume" }, "change_1d": { "type": "number", "description": "1-day change percentage" }, "change_7d": { "type": "number", "description": "7-day change percentage" }, "change_1m": { "type": "number", "description": "1-month change percentage" }, "change_7dover7d": { "type": "number", "description": "7-day over 7-day change percentage" }, "change_30dover30d": { "type": "number", "description": "30-day over 30-day change percentage" }, "total7DaysAgo": { "type": "number", "description": "Total volume 7 days ago" }, "total30DaysAgo": { "type": "number", "description": "Total volume 30 days ago" }, "totalAllTime": { "type": "number", "description": "Total all-time volume" }, "protocols": { "type": "array", "items": { "type": "object", "properties": { "total24h": { "type": "number", "description": "24-hour volume" }, "total48hto24h": { "type": "number", "description": "48-hour to 24-hour volume" }, "total7d": { "type": "number", "description": "7-day volume" }, "total14dto7d": { "type": "number", "description": "14-day to 7-day volume" }, "total60dto30d": { "type": "number", "description": "60-day to 30-day volume" }, "total30d": { "type": "number", "description": "30-day volume" }, "total1y": { "type": "number", "description": "1-year volume" }, "totalAllTime": { "type": "number", "description": "All-time volume" }, "total7DaysAgo": { "type": "number", "description": "Volume 7 days ago" }, "total30DaysAgo": { "type": "number", "description": "Volume 30 days ago" }, "average1y": { "type": "number", "description": "Average 1-year volume" }, "change_1d": { "type": "number", "description": "1-day change percentage" }, "change_7d": { "type": "number", "description": "7-day change percentage" }, "change_1m": { "type": "number", "description": "1-month change percentage" }, "change_7dover7d": { "type": "number", "description": "7-day over 7-day change percentage" }, "change_30dover30d": { "type": "number", "description": "30-day over 30-day change percentage" }, "defillamaId": { "type": "string", "description": "DefiLlama protocol ID" }, "name": { "type": "string", "description": "Protocol name" }, "displayName": { "type": "string", "description": "Protocol display name" }, "module": { "type": "string", "description": "Protocol module name" }, "category": { "type": "string", "description": "Protocol category" }, "logo": { "type": "string", "description": "Protocol logo URL" }, "chains": { "type": "array", "items": { "type": "string" }, "description": "Supported chains" }, "protocolType": { "type": "string", "description": "Protocol type" }, "methodologyURL": { "type": "string", "description": "Methodology documentation URL" }, "methodology": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Protocol methodology details" }, "latestFetchIsOk": { "type": "boolean", "description": "Whether the latest data fetch was successful" }, "parentProtocol": { "type": "string", "description": "Parent protocol identifier" }, "slug": { "type": "string", "description": "Protocol slug" }, "linkedProtocols": { "type": "array", "items": { "type": "string" }, "description": "Linked protocol names" }, "id": { "type": "string", "description": "Protocol ID" } } }, "description": "List of protocols with their volume data" } } }, "example": { "totalDataChart": [[1656201600, 3947]], "totalDataChartBreakdown": [ [ 1656201600, { "Premia V2": 3947 } ], [ 1656288000, { "Premia V2": 4716 } ], [ 1656374400, { "Premia V2": 4716 } ] ], "breakdown24h": null, "breakdown30d": null, "chain": "Ethereum", "allChains": [ "Hyperliquid L1", "Derive Chain", "Arbitrum", "Ethereum", "Base", "Berachain", "Sui", "OP Mainnet", "Polygon", "Fantom", "Sonic", "Blast", "Mantle", "Bitlayer", "BSC", "Sei", "TON" ], "total24h": 38508, "total48hto24h": 57674, "total7d": 244966, "total14dto7d": 181066, "total60dto30d": 1543832, "total30d": 715276, "total1y": 38047667, "change_1d": -33.23, "change_7d": -0.13, "change_1m": 619.37, "change_7dover7d": 35.29, "change_30dover30d": -53.67, "total7DaysAgo": 38559, "total30DaysAgo": 5353, "totalAllTime": 212572409, "protocols": [ { "total24h": 0, "total48hto24h": 0, "total7d": 0, "total14dto7d": 0, "total60dto30d": 0, "total30d": 0, "total1y": 0, "totalAllTime": 920677, "total7DaysAgo": 0, "total30DaysAgo": 0, "defillamaId": "381", "name": "Premia V2", "displayName": "Premia V2", "module": "premia-v2", "category": "Options", "logo": "https://icons.llamao.fi/icons/protocols/premia-v2.jpg", "chains": ["Ethereum", "Arbitrum", "Fantom", "OP Mainnet"], "protocolType": "protocol", "methodologyURL": "https://github.com/DefiLlama/dimension-adapters/blob/master/options/premia-v2.ts", "methodology": { "UserFees": "Traders pay taker fees on each trade up to 3% of the option premium.", "Fees": "Fees paid by users", "Revenue": "Treasury and token holders revenue", "ProtocolRevenue": "The protocol collects 20% of the taker fees.", "HoldersRevenue": "vxPREMIA holders collect 80% of the taker fees.", "SupplySideRevenue": "Liquidity providers earn revenue from market-making options." }, "latestFetchIsOk": true, "parentProtocol": "parent#premia", "slug": "premia-v2", "linkedProtocols": ["Premia", "Premia V2", "Premia V3"], "id": "381" } ] } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.volumes.getOptionsOverviewByChain('')" }, { "lang": "python", "label": "Python SDK", "source": "result = client.volumes.getOptionsOverviewByChain('')" } ] } }, "/api/summary/options/{protocol}": { "get": { "tags": ["volumes"], "summary": "Get summary of options dex volume with historical data", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug", "schema": { "type": "string", "example": "derive" } }, { "name": "dataType", "in": "query", "required": false, "description": "Desired data type, dailyNotionalVolume by default.", "schema": { "type": "string", "enum": ["dailyPremiumVolume", "dailyNotionalVolume"], "example": "dailyPremiumVolume" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Protocol ID" }, "name": { "type": "string", "description": "Protocol name" }, "url": { "type": "string", "description": "Protocol website URL" }, "description": { "type": "string", "description": "Protocol description" }, "logo": { "type": "string", "description": "Protocol logo URL" }, "gecko_id": { "type": "string", "description": "CoinGecko ID" }, "cmcId": { "type": "string", "description": "CoinMarketCap ID" }, "chains": { "type": "array", "items": { "type": "string" }, "description": "Supported chains" }, "twitter": { "type": "string", "description": "Twitter handle" }, "governanceID": { "type": "array", "items": { "type": "string" }, "description": "Governance identifiers" }, "github": { "type": "array", "items": { "type": "string" }, "description": "GitHub repositories" }, "treasury": { "type": "string", "description": "Treasury information" }, "symbol": { "type": "string", "description": "Token symbol" }, "address": { "type": "string", "description": "Token contract address" }, "childProtocols": { "type": "array", "items": { "type": "object" }, "description": "Child protocols" }, "linkedProtocols": { "type": "array", "items": { "type": "string" }, "description": "Linked protocol names" }, "defillamaId": { "type": "string", "description": "DefiLlama protocol ID" }, "disabled": { "type": "object", "nullable": true, "description": "Disabled status" }, "displayName": { "type": "string", "description": "Protocol display name" }, "module": { "type": "object", "nullable": true, "description": "Protocol module" }, "category": { "type": "object", "nullable": true, "description": "Protocol category" }, "methodologyURL": { "type": "object", "nullable": true, "description": "Methodology documentation URL" }, "methodology": { "type": "object", "nullable": true, "description": "Protocol methodology details" }, "forkedFrom": { "type": "object", "nullable": true, "description": "Forked from protocol" }, "audits": { "type": "object", "nullable": true, "description": "Audit information" }, "audit_links": { "type": "object", "nullable": true, "description": "Audit links" }, "versionKey": { "type": "object", "nullable": true, "description": "Version key" }, "parentProtocol": { "type": "object", "nullable": true, "description": "Parent protocol" }, "previousNames": { "type": "object", "nullable": true, "description": "Previous protocol names" }, "latestFetchIsOk": { "type": "boolean", "description": "Whether the latest data fetch was successful" }, "slug": { "type": "string", "description": "Protocol slug" }, "protocolType": { "type": "string", "description": "Protocol type" }, "total24h": { "type": "number", "description": "24-hour volume" }, "total48hto24h": { "type": "number", "description": "48-hour to 24-hour volume" }, "total7d": { "type": "number", "description": "7-day volume" }, "totalAllTime": { "type": "number", "description": "All-time volume" }, "totalDataChart": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Unix timestamp" }, { "type": "number", "description": "Volume value" } ] }, "description": "Historical chart data with timestamps and volumes" }, "totalDataChartBreakdown": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Unix timestamp" }, { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } }, "description": "Chain and protocol breakdown with volume values" } ] }, "description": "Historical chart data broken down by chain and protocol" }, "change_1d": { "type": "number", "description": "1-day change percentage" } } }, "example": { "id": "parent#lyra", "name": "Derive", "url": "https://derive.xyz", "description": "Trade options & perps. Earn yield with restaking derivatives.", "logo": "https://icons.llama.fi/derive.png", "gecko_id": "derive", "cmcId": "35014", "chains": ["OP Mainnet", "Arbitrum", "Derive Chain"], "twitter": "derivexyz", "governanceID": ["snapshot:lyra.eth"], "github": ["lyra-finance"], "treasury": "lyra.js", "symbol": "DRV", "address": "0xb1d1eae60eea9525032a6dcb4c1ce336a1de71be", "childProtocols": [{}, {}], "linkedProtocols": ["Derive", "Derive V2", "Derive Options"], "defillamaId": "parent#lyra", "disabled": null, "displayName": "Derive", "module": null, "category": null, "methodologyURL": null, "methodology": null, "forkedFrom": null, "audits": null, "audit_links": null, "versionKey": null, "parentProtocol": null, "previousNames": null, "latestFetchIsOk": true, "slug": "derive", "protocolType": "protocol", "total24h": 849389, "total48hto24h": 529694, "total7d": 2327481, "totalAllTime": 156317108, "totalDataChart": [[1702684800, 15019], [1702771200, 15019]], "totalDataChartBreakdown": [ [ 1702684800, { "Ethereum": { "Derive V2": 15019 } } ], [ 1702771200, { "Derive Chain": { "Derive V2": 15019 } } ] ], "change_1d": 60.35 } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.volumes.getOptionsSummary('')" }, { "lang": "python", "label": "Python SDK", "source": "result = client.volumes.getOptionsSummary('')" } ] } }, "/api/overview/open-interest": { "get": { "tags": ["perps"], "summary": "List all open interest dex exchanges along with summaries of their open interest", "parameters": [ { "name": "excludeTotalDataChart", "in": "query", "required": true, "description": "true to exclude aggregated chart from response", "schema": { "type": "boolean", "example": true } }, { "name": "excludeTotalDataChartBreakdown", "in": "query", "required": true, "description": "true to exclude broken down chart from response", "schema": { "type": "boolean", "example": true } } ], "responses": { "200": { "description": "Overview of all open interest DEXs", "content": { "application/json": { "schema": { "type": "object", "properties": { "protocols": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Hyperliquid Perps" }, "displayName": { "type": "string", "example": "Hyperliquid Perps" }, "total24h": { "type": "number", "example": 14304709847 }, "total7d": { "type": "number", "example": 93112774041 }, "change_1d": { "type": "number", "example": 3.62 }, "change_7d": { "type": "number", "example": 12.63 }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Hyperliquid L1"] } } } }, "totalDataChart": { "type": "array", "items": { "type": "array", "items": { "oneOf": [ { "type": "number" }, { "type": "object" } ] }, "example": [1654819200, 607785941] } }, "allChains": { "type": "array", "items": { "type": "string" }, "example": ["Hyperliquid L1", "Off Chain", "zkLighter"] } } } } } } } } }, "/api/overview/fees": { "get": { "tags": ["fees and revenue"], "summary": "List all protocols along with summaries of their fees and revenue and dataType history data", "parameters": [ { "name": "excludeTotalDataChart", "in": "query", "required": true, "description": "true to exclude aggregated chart from response", "schema": { "type": "boolean", "example": true } }, { "name": "excludeTotalDataChartBreakdown", "in": "query", "required": true, "description": "true to exclude broken down chart from response", "schema": { "type": "boolean", "example": true } }, { "name": "dataType", "in": "query", "required": false, "description": "Desired data type, dailyFees by default.", "schema": { "type": "string", "enum": ["dailyFees", "dailyRevenue", "dailyHoldersRevenue"], "example": "dailyFees" } } ], "responses": { "200": { "description": "Overview of all protocols with fees and revenue data", "content": { "application/json": { "schema": { "type": "object", "properties": { "protocols": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Uniswap" }, "total24h": { "type": "number", "example": 5000000 }, "revenue24h": { "type": "number", "example": 2000000 }, "change_1d": { "type": "number", "example": 12.5 }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Polygon"] } } } }, "totalDataChart": { "type": "array", "items": { "type": "array", "example": [1640995200, 25000000] } }, "totalDataChartBreakdown": { "type": "array", "items": { "type": "array", "example": [ 1640995200, { "Uniswap": 5000000, "Compound": 3000000 } ] } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.fees.getOverview()" }, { "lang": "python", "label": "Python SDK", "source": "result = client.fees.getOverview()" } ] } }, "/api/overview/fees/{chain}": { "get": { "tags": ["fees and revenue"], "summary": "List all protocols along with summaries of their fees and revenue and dataType history data by chain", "parameters": [ { "name": "chain", "in": "path", "required": true, "description": "chain name, list of all supported chains can be found under allChains attribute in /overview/fees response", "schema": { "type": "string", "example": "ethereum" } }, { "name": "excludeTotalDataChart", "in": "query", "required": true, "description": "true to exclude aggregated chart from response", "schema": { "type": "boolean", "example": true } }, { "name": "excludeTotalDataChartBreakdown", "in": "query", "required": true, "description": "true to exclude broken down chart from response", "schema": { "type": "boolean", "example": true } }, { "name": "dataType", "in": "query", "required": false, "description": "Desired data type, dailyFees by default.", "schema": { "type": "string", "enum": ["dailyFees", "dailyRevenue", "dailyHoldersRevenue"], "example": "dailyFees" } } ], "responses": { "200": { "description": "Overview of all protocols with fees and revenue data", "content": { "application/json": { "schema": { "type": "object", "properties": { "protocols": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Uniswap" }, "total24h": { "type": "number", "example": 5000000 }, "revenue24h": { "type": "number", "example": 2000000 }, "change_1d": { "type": "number", "example": 12.5 }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Polygon"] } } } }, "totalDataChart": { "type": "array", "items": { "type": "array", "example": [1640995200, 25000000] } }, "totalDataChartBreakdown": { "type": "array", "items": { "type": "array", "example": [ 1640995200, { "Uniswap": 5000000, "Compound": 3000000 } ] } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.fees.getOverviewByChain('')" }, { "lang": "python", "label": "Python SDK", "source": "result = client.fees.getOverviewByChain('')" } ] } }, "/api/summary/fees/{protocol}": { "get": { "tags": ["fees and revenue"], "summary": "Get summary of protocol fees and revenue with historical data", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug", "schema": { "type": "string", "example": "derive" } }, { "name": "dataType", "in": "query", "required": false, "description": "Desired data type, dailyFees by default.", "schema": { "type": "string", "enum": ["dailyFees", "dailyRevenue", "dailyHoldersRevenue"], "example": "dailyFees" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Protocol ID" }, "name": { "type": "string", "description": "Protocol name" }, "url": { "type": "string", "description": "Protocol URL" }, "referralUrl": { "type": "string", "description": "Referral URL" }, "description": { "type": "string", "description": "Protocol description" }, "logo": { "type": "string", "description": "Protocol logo URL" }, "gecko_id": { "type": "string", "description": "CoinGecko ID" }, "cmcId": { "type": "string", "description": "CoinMarketCap ID" }, "chains": { "type": "array", "items": { "type": "string" }, "description": "Supported chains" }, "twitter": { "type": "string", "description": "Twitter handle" }, "github": { "type": "array", "items": { "type": "string" }, "description": "GitHub repositories" }, "symbol": { "type": "string", "description": "Token symbol" }, "address": { "type": "string", "description": "Protocol address" }, "childProtocols": { "type": "array", "items": { "type": "object" }, "description": "Child protocols" }, "linkedProtocols": { "type": "array", "items": { "type": "string" }, "description": "Linked protocols" }, "defillamaId": { "type": "string", "description": "DefiLlama protocol ID" }, "disabled": { "type": "boolean", "nullable": true, "description": "Whether protocol is disabled" }, "displayName": { "type": "string", "description": "Display name" }, "module": { "type": "string", "nullable": true, "description": "Module name" }, "category": { "type": "string", "nullable": true, "description": "Protocol category" }, "methodologyURL": { "type": "string", "nullable": true, "description": "Methodology URL" }, "methodology": { "type": "object", "nullable": true, "description": "Methodology details" }, "forkedFrom": { "type": "string", "nullable": true, "description": "Forked from protocol" }, "audits": { "type": "array", "nullable": true, "description": "Audit information" }, "audit_links": { "type": "array", "nullable": true, "description": "Audit links" }, "versionKey": { "type": "string", "nullable": true, "description": "Version key" }, "governanceID": { "type": "string", "nullable": true, "description": "Governance ID" }, "treasury": { "type": "string", "nullable": true, "description": "Treasury address" }, "parentProtocol": { "type": "string", "nullable": true, "description": "Parent protocol" }, "previousNames": { "type": "array", "nullable": true, "description": "Previous names" }, "latestFetchIsOk": { "type": "boolean", "description": "Latest fetch status" }, "slug": { "type": "string", "description": "Protocol slug" }, "protocolType": { "type": "string", "description": "Protocol type" }, "total24h": { "type": "number", "description": "24 hour fees" }, "total48hto24h": { "type": "number", "description": "48h to 24h fees" }, "total7d": { "type": "number", "description": "7 day fees" }, "totalAllTime": { "type": "number", "description": "All time fees" }, "change_1d": { "type": "number", "description": "1 day change percentage" }, "totalDataChart": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Timestamp" }, { "type": "number", "description": "Fee value" } ] }, "description": "Total data chart with timestamps and fees" }, "totalDataChartBreakdown": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Timestamp" }, { "type": "object", "description": "Chain and protocol breakdown" } ] }, "description": "Total data chart breakdown by chain and protocol" } } }, "example": { "id": "parent#hyperliquid", "name": "Hyperliquid", "url": "https://hyperliquid.xyz", "referralUrl": "https://app.hyperliquid.xyz/join/DEFILLAMAO", "description": "Hyperliquid is a decentralized perpetual exchange with best-in-class speed, liquidity, and price", "logo": "https://icons.llama.fi/hyperliquid.png", "gecko_id": "hyperliquid", "cmcId": "32196", "chains": ["Hyperliquid L1"], "twitter": "HyperliquidX", "github": ["hyperliquid-dex"], "symbol": "HYPE", "address": "hyperliquid:0x0d01dc56dcaaca66ad901c959b4011ec", "childProtocols": [{}], "linkedProtocols": ["Hyperliquid", "Hyperliquid Spot Orderbook"], "defillamaId": "parent#hyperliquid", "disabled": null, "displayName": "Hyperliquid", "module": null, "category": null, "methodologyURL": null, "methodology": null, "forkedFrom": null, "audits": null, "audit_links": null, "versionKey": null, "governanceID": null, "treasury": null, "parentProtocol": null, "previousNames": null, "latestFetchIsOk": true, "slug": "hyperliquid", "protocolType": "protocol", "total24h": 4890250, "total48hto24h": 4550411, "total7d": 26184696, "totalAllTime": 499292857, "change_1d": 7.47, "totalDataChart": [[1734912000, 1472923]], "totalDataChartBreakdown": [ [ 1734912000, { "Hyperliquid L1": { "Hyperliquid Spot Orderbook": 1472923 } } ] ] } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.fees.getSummary('')" }, { "lang": "python", "label": "Python SDK", "source": "result = client.fees.getSummary('')" } ] } }, "/api/v2/metrics/{metric}": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get dimension data overview", "description": "Returns aggregate metrics for the specified dimension including totals and percentage changes across different time periods.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume", "active-users" ], "example": "fees" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n- **active-users**: dailyActiveUsers (default), dailyTransactionCount, dailyGasUsed\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Dimension metrics overview", "content": { "application/json": { "schema": { "type": "object", "properties": { "allChains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Solana", "BSC", "Base"] }, "total24h": { "type": "number", "example": 42000000 }, "total48hto24h": { "type": "number", "example": 38000000 }, "total7d": { "type": "number", "example": 280000000 }, "total14dto7d": { "type": "number", "example": 260000000 }, "total60dto30d": { "type": "number", "example": 1100000000 }, "total30d": { "type": "number", "example": 1200000000 }, "total1y": { "type": "number", "example": 15000000000 }, "change_1d": { "type": "number", "example": 10.5 }, "change_7d": { "type": "number", "example": 7.8 }, "change_1m": { "type": "number", "example": 9.1 }, "change_7dover7d": { "type": "number", "example": 5.2 }, "change_30dover30d": { "type": "number", "example": 8.3 } } } } } } } } }, "/api/v2/chart/{metric}": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get historical timeseries chart data", "description": "Returns an array of [timestamp, value] pairs representing the total metric value over time.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume", "active-users" ], "example": "fees" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n- **active-users**: dailyActiveUsers (default), dailyTransactionCount, dailyGasUsed\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Array of [timestamp, value] pairs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2, "example": [1534550400, 42000000] } } } } } } } }, "/api/v2/chart/{metric}/chain-breakdown": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get historical timeseries chart data breakdown by chain", "description": "Returns an array of [timestamp, {chain: value}] pairs showing the metric broken down by chain over time. For bridges, dailyAggregatedVolume and dailyTxCount include incoming plus outgoing activity on each chain; summing chains can count a transfer twice.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume", "active-users" ], "example": "fees" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n- **active-users**: dailyActiveUsers (default), dailyTransactionCount, dailyGasUsed\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Array of [timestamp, chainBreakdown] pairs", "content": { "application/json": { "schema": { "type": "array", "example": [ [ 1534550400, { "Ethereum": 30000000, "Solana": 12000000 } ], [ 1534636800, { "Ethereum": 31000000, "Solana": 12500000 } ] ] } } } } } } }, "/api/v2/chart/{metric}/protocol-breakdown": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get historical timeseries chart data breakdown by protocol", "description": "Returns an array of [timestamp, {protocol: value}] pairs showing the metric broken down by protocol over time.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Array of [timestamp, protocolBreakdown] pairs", "content": { "application/json": { "schema": { "type": "array", "example": [ [ 1534550400, { "Uniswap V3": 15000000, "Aave": 8000000 } ], [ 1534636800, { "Uniswap V3": 15500000, "Aave": 8200000 } ] ] } } } } } } }, "/api/v2/metrics/{metric}/chain/{chain}": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get chain dimension data overview", "description": "Returns aggregate metrics for the specified dimension filtered by a specific chain. For bridges, dailyAggregatedVolume and dailyTxCount include incoming plus outgoing activity on each chain; summing chains can count a transfer twice.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "chain", "in": "path", "required": true, "description": "chain name", "schema": { "type": "string", "example": "Ethereum" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Chain dimension metrics overview", "content": { "application/json": { "schema": { "type": "object", "properties": { "allChains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Solana", "BSC", "Base"] }, "total24h": { "type": "number", "example": 42000000 }, "total48hto24h": { "type": "number", "example": 38000000 }, "total7d": { "type": "number", "example": 280000000 }, "total14dto7d": { "type": "number", "example": 260000000 }, "total60dto30d": { "type": "number", "example": 1100000000 }, "total30d": { "type": "number", "example": 1200000000 }, "total1y": { "type": "number", "example": 15000000000 }, "change_1d": { "type": "number", "example": 10.5 }, "change_7d": { "type": "number", "example": 7.8 }, "change_1m": { "type": "number", "example": 9.1 }, "change_7dover7d": { "type": "number", "example": 5.2 }, "change_30dover30d": { "type": "number", "example": 8.3 }, "chain": { "type": "string", "example": "Ethereum" } } } } } }, "404": { "description": "Not found" } } } }, "/api/v2/chart/{metric}/chain/{chain}": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get chain historical timeseries chart data", "description": "Returns an array of [timestamp, value] pairs for the metric filtered by a specific chain. For bridges, dailyAggregatedVolume and dailyTxCount include incoming plus outgoing activity on each chain; summing chains can count a transfer twice.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "chain", "in": "path", "required": true, "description": "chain name", "schema": { "type": "string", "example": "Ethereum" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Array of [timestamp, value] pairs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2, "example": [1534550400, 42000000] } } } } }, "404": { "description": "Not found" } } } }, "/api/v2/chart/{metric}/chain/{chain}/protocol-breakdown": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get chain timeseries chart data breakdown by protocol", "description": "Returns an array of [timestamp, {protocol: value}] pairs showing the metric on a specific chain broken down by protocol. For bridges, dailyAggregatedVolume and dailyTxCount include incoming plus outgoing activity on each chain; summing chains can count a transfer twice.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "chain", "in": "path", "required": true, "description": "chain name", "schema": { "type": "string", "example": "Ethereum" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Array of [timestamp, protocolBreakdown] pairs", "content": { "application/json": { "schema": { "type": "array", "example": [ [ 1534550400, { "Uniswap V3": 15000000, "Aave": 8000000 } ], [ 1534636800, { "Uniswap V3": 15500000, "Aave": 8200000 } ] ] } } } }, "404": { "description": "Not found" } } } }, "/api/v2/metrics/{metric}/protocol/{protocol}": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get protocol dimension data overview", "description": "Returns protocol metadata along with aggregate metrics for the specified dimension.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "protocol", "in": "path", "required": true, "description": "protocol slug (slugified protocol name)", "schema": { "type": "string", "example": "aave" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Protocol dimension metrics overview", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "2196" }, "name": { "type": "string", "example": "Aave" }, "url": { "type": "string", "example": "https://aave.com" }, "description": { "type": "string" }, "logo": { "type": "string", "example": "https://icons.llama.fi/aave.png" }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Polygon", "Avalanche"] }, "gecko_id": { "type": "string", "nullable": true, "example": "aave" }, "cmcId": { "type": "string", "nullable": true, "example": "7278" }, "symbol": { "type": "string", "nullable": true, "example": "AAVE" }, "twitter": { "type": "string", "nullable": true }, "github": { "type": "array", "nullable": true, "items": { "type": "string" } }, "treasury": { "type": "string", "nullable": true }, "governanceID": { "type": "array", "nullable": true, "items": { "type": "string" } }, "wrongLiquidity": { "type": "boolean", "nullable": true }, "stablecoins": { "type": "array", "nullable": true, "items": { "type": "string" } }, "total24h": { "type": "number", "example": 1200000 }, "total48hto24h": { "type": "number", "example": 1100000 }, "total7d": { "type": "number", "example": 8000000 }, "total30d": { "type": "number", "example": 35000000 }, "total1y": { "type": "number", "example": 400000000 }, "change_1d": { "type": "number", "example": 9.1 }, "change_7d": { "type": "number", "example": 5.3 }, "change_1m": { "type": "number", "example": 12.4 } } } } } }, "404": { "description": "Not found" } } } }, "/api/v2/chart/{metric}/protocol/{protocol}": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get protocol historical timeseries chart data", "description": "Returns an array of [timestamp, value] pairs for the metric of a specific protocol.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "protocol", "in": "path", "required": true, "description": "protocol slug (slugified protocol name)", "schema": { "type": "string", "example": "aave" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Array of [timestamp, value] pairs", "content": { "application/json": { "examples": { "dailyAggregatedVolume": { "summary": "Bridge dailyAggregatedVolume", "description": "metric=bridges, protocol=optimism-bridge, dataType=dailyAggregatedVolume. Historical example for 2022-10-17 UTC.", "value": [[1665964800, 834139]] }, "dailyOutgoingVolume": { "summary": "Bridge dailyOutgoingVolume", "description": "metric=bridges, protocol=optimism-bridge, dataType=dailyOutgoingVolume. Historical example for 2022-10-17 UTC.", "value": [[1665964800, 834139]] }, "dailyIncomingVolume": { "summary": "Bridge dailyIncomingVolume", "description": "metric=bridges, protocol=optimism-bridge, dataType=dailyIncomingVolume. Historical example for 2022-10-17 UTC.", "value": [[1665964800, 834139]] }, "dailyTxCount": { "summary": "Bridge dailyTxCount", "description": "metric=bridges, protocol=optimism-bridge, dataType=dailyTxCount. Historical example for 2022-10-17 UTC.", "value": [[1665964800, 33]] }, "dailyOutgoingTxCount": { "summary": "Bridge dailyOutgoingTxCount", "description": "metric=bridges, protocol=optimism-bridge, dataType=dailyOutgoingTxCount. Historical example for 2022-10-17 UTC.", "value": [[1665964800, 33]] }, "dailyIncomingTxCount": { "summary": "Bridge dailyIncomingTxCount", "description": "metric=bridges, protocol=optimism-bridge, dataType=dailyIncomingTxCount. Historical example for 2022-10-17 UTC.", "value": [[1665964800, 33]] } }, "schema": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2, "example": [1534550400, 42000000] } } } } }, "404": { "description": "Not found" } } } }, "/api/v2/chart/{metric}/protocol/{protocol}/chain-breakdown": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get protocol timeseries chart data breakdown by chain", "description": "Returns an array of [timestamp, {chain: value}] pairs showing the metric for a specific protocol broken down by chain. For bridges, dailyAggregatedVolume and dailyTxCount include incoming plus outgoing activity on each chain; summing chains can count a transfer twice.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "protocol", "in": "path", "required": true, "description": "protocol slug (slugified protocol name)", "schema": { "type": "string", "example": "aave" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Array of [timestamp, chainBreakdown] pairs", "content": { "application/json": { "examples": { "dailyAggregatedVolume": { "summary": "Bridge dailyAggregatedVolume", "description": "metric=bridges, protocol=optimism-bridge, dataType=dailyAggregatedVolume. Historical example for 2022-10-17 UTC.", "value": [ [ 1665964800, { "Ethereum": 834139, "OP Mainnet": 834139 } ] ] }, "dailyOutgoingVolume": { "summary": "Bridge dailyOutgoingVolume", "description": "metric=bridges, protocol=optimism-bridge, dataType=dailyOutgoingVolume. Historical example for 2022-10-17 UTC.", "value": [ [ 1665964800, { "Ethereum": 811248, "OP Mainnet": 22891 } ] ] }, "dailyIncomingVolume": { "summary": "Bridge dailyIncomingVolume", "description": "metric=bridges, protocol=optimism-bridge, dataType=dailyIncomingVolume. Historical example for 2022-10-17 UTC.", "value": [ [ 1665964800, { "Ethereum": 22891, "OP Mainnet": 811248 } ] ] }, "dailyTxCount": { "summary": "Bridge dailyTxCount", "description": "metric=bridges, protocol=optimism-bridge, dataType=dailyTxCount. Historical example for 2022-10-17 UTC.", "value": [ [ 1665964800, { "Ethereum": 33, "OP Mainnet": 33 } ] ] }, "dailyOutgoingTxCount": { "summary": "Bridge dailyOutgoingTxCount", "description": "metric=bridges, protocol=optimism-bridge, dataType=dailyOutgoingTxCount. Historical example for 2022-10-17 UTC.", "value": [ [ 1665964800, { "Ethereum": 28, "OP Mainnet": 5 } ] ] }, "dailyIncomingTxCount": { "summary": "Bridge dailyIncomingTxCount", "description": "metric=bridges, protocol=optimism-bridge, dataType=dailyIncomingTxCount. Historical example for 2022-10-17 UTC.", "value": [ [ 1665964800, { "Ethereum": 5, "OP Mainnet": 28 } ] ] } }, "schema": { "type": "array", "example": [ [ 1534550400, { "Ethereum": 30000000, "Solana": 12000000 } ], [ 1534636800, { "Ethereum": 31000000, "Solana": 12500000 } ] ] } } } }, "404": { "description": "Not found" } } } }, "/api/v2/chart/{metric}/protocol/{protocol}/version-breakdown": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get protocol timeseries chart data breakdown by version", "description": "Returns an array of [timestamp, {version: value}] pairs showing the metric for a specific protocol broken down by version (e.g. Aave V2, Aave V3). For bridges, version values sum chain activity and can exceed the protocol total for dailyAggregatedVolume and dailyTxCount. Use /api/v2/chart/bridges/protocol/{protocol} for the protocol total.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "protocol", "in": "path", "required": true, "description": "protocol slug (slugified protocol name)", "schema": { "type": "string", "example": "aave" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Array of [timestamp, versionBreakdown] pairs", "content": { "application/json": { "schema": { "type": "array", "example": [ [ 1607040000, { "Aave V2": 131 } ], [ 1607126400, { "Aave V2": 334, "Aave V3": 500 } ] ] } } } }, "404": { "description": "Not found" } } } }, "/api/v2/chart/{metric}/protocol/{protocol}/label-breakdown": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get protocol timeseries chart data breakdown by label", "description": "Returns an array of [timestamp, {label: value}] pairs showing the metric for a specific protocol broken down by label (e.g. Borrow Interest, Flash Loans). Currently only supported for metric=fees.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "protocol", "in": "path", "required": true, "description": "protocol slug (slugified protocol name)", "schema": { "type": "string", "example": "aave" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Array of [timestamp, labelBreakdown] pairs", "content": { "application/json": { "schema": { "type": "array", "example": [ [ 1607040000, { "Borrow Interest": 131 } ], [ 1607126400, { "Borrow Interest": 334, "Flash Loans": 50 } ] ] } } } }, "404": { "description": "Not found" } } } }, "/api/v2/metrics/{metric}/categories": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get categories available for a dimension", "description": "Returns the categories that have data for the selected metric and dataType, with aggregate totals and active chain names. Use category names in slug form for category routes, for example canonical-bridge for Canonical Bridge. For bridges, totals are in USD for volume dataTypes and transfer counts for TxCount dataTypes.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume", "active-users" ], "example": "fees" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n- **active-users**: dailyActiveUsers (default), dailyTransactionCount, dailyGasUsed\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Categories with data for the selected dimension and dataType", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "example": "Canonical Bridge" }, "total24h": { "type": "number", "nullable": true }, "total7d": { "type": "number", "nullable": true }, "total30d": { "type": "number", "nullable": true }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "OP Mainnet"] } } } } } } }, "500": { "description": "Category data not available" } } } }, "/api/v2/metrics/{metric}/category/{category}": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get category dimension data overview", "description": "Returns aggregate metrics for the specified dimension filtered by a specific category.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "category", "in": "path", "required": true, "description": "category slug (slugified category name, e.g. 'dexs', 'prediction-market', 'options')", "schema": { "type": "string", "example": "dexs" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Category dimension metrics overview", "content": { "application/json": { "schema": { "type": "object", "properties": { "allChains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Solana", "BSC", "Base"] }, "total24h": { "type": "number", "example": 42000000 }, "total48hto24h": { "type": "number", "example": 38000000 }, "total7d": { "type": "number", "example": 280000000 }, "total14dto7d": { "type": "number", "example": 260000000 }, "total60dto30d": { "type": "number", "example": 1100000000 }, "total30d": { "type": "number", "example": 1200000000 }, "total1y": { "type": "number", "example": 15000000000 }, "change_1d": { "type": "number", "example": 10.5 }, "change_7d": { "type": "number", "example": 7.8 }, "change_1m": { "type": "number", "example": 9.1 }, "change_7dover7d": { "type": "number", "example": 5.2 }, "change_30dover30d": { "type": "number", "example": 8.3 }, "category": { "type": "string", "example": "Dexs" }, "allCategories": { "type": "array", "items": { "type": "string" }, "example": ["Dexs", "Lending", "Bridge", "Derivatives"] } } } } } }, "404": { "description": "Not found" } } } }, "/api/v2/chart/{metric}/category/{category}": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get category historical timeseries chart data", "description": "Returns an array of [timestamp, value] pairs for the metric filtered by a specific category.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "category", "in": "path", "required": true, "description": "category slug (slugified category name, e.g. 'dexs', 'prediction-market', 'options')", "schema": { "type": "string", "example": "dexs" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Array of [timestamp, value] pairs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2, "example": [1534550400, 42000000] } } } } }, "404": { "description": "Not found" } } } }, "/api/v2/chart/{metric}/category/{category}/chain-breakdown": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get category timeseries chart data breakdown by chain", "description": "Returns an array of [timestamp, {chain: value}] pairs showing the metric for a specific category broken down by chain. For bridges, dailyAggregatedVolume and dailyTxCount include incoming plus outgoing activity on each chain; summing chains can count a transfer twice.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "category", "in": "path", "required": true, "description": "category slug (slugified category name, e.g. 'dexs', 'prediction-market', 'options')", "schema": { "type": "string", "example": "dexs" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Array of [timestamp, chainBreakdown] pairs", "content": { "application/json": { "schema": { "type": "array", "example": [ [ 1534550400, { "Ethereum": 30000000, "Solana": 12000000 } ], [ 1534636800, { "Ethereum": 31000000, "Solana": 12500000 } ] ] } } } }, "404": { "description": "Not found" } } } }, "/api/v2/chart/{metric}/category/{category}/protocol-breakdown": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get category timeseries chart data breakdown by protocol", "description": "Returns an array of [timestamp, {protocol: value}] pairs showing the metric for a specific category broken down by protocol.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "category", "in": "path", "required": true, "description": "category slug (slugified category name, e.g. 'dexs', 'prediction-market', 'options')", "schema": { "type": "string", "example": "dexs" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Array of [timestamp, protocolBreakdown] pairs", "content": { "application/json": { "schema": { "type": "array", "example": [ [ 1534550400, { "Uniswap V3": 15000000, "Aave": 8000000 } ], [ 1534636800, { "Uniswap V3": 15500000, "Aave": 8200000 } ] ] } } } }, "404": { "description": "Not found" } } } }, "/api/v2/metrics/{metric}/category/{category}/chain/{chain}": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get category chain dimension data overview", "description": "Returns aggregate metrics for the specified dimension filtered by both category and chain. For bridges, dailyAggregatedVolume and dailyTxCount include incoming plus outgoing activity on each chain; summing chains can count a transfer twice.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "category", "in": "path", "required": true, "description": "category slug (slugified category name, e.g. 'dexs', 'prediction-market', 'options')", "schema": { "type": "string", "example": "dexs" } }, { "name": "chain", "in": "path", "required": true, "description": "chain name", "schema": { "type": "string", "example": "Ethereum" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Category chain dimension metrics overview", "content": { "application/json": { "schema": { "type": "object", "properties": { "allChains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Solana", "BSC", "Base"] }, "total24h": { "type": "number", "example": 42000000 }, "total48hto24h": { "type": "number", "example": 38000000 }, "total7d": { "type": "number", "example": 280000000 }, "total14dto7d": { "type": "number", "example": 260000000 }, "total60dto30d": { "type": "number", "example": 1100000000 }, "total30d": { "type": "number", "example": 1200000000 }, "total1y": { "type": "number", "example": 15000000000 }, "change_1d": { "type": "number", "example": 10.5 }, "change_7d": { "type": "number", "example": 7.8 }, "change_1m": { "type": "number", "example": 9.1 }, "change_7dover7d": { "type": "number", "example": 5.2 }, "change_30dover30d": { "type": "number", "example": 8.3 }, "category": { "type": "string", "example": "Dexs" }, "allCategories": { "type": "array", "items": { "type": "string" }, "example": ["Dexs", "Lending", "Bridge", "Derivatives"] }, "chain": { "type": "string", "example": "Ethereum" } } } } } }, "404": { "description": "Not found" } } } }, "/api/v2/chart/{metric}/category/{category}/chain/{chain}": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get category chain historical timeseries chart data", "description": "Returns an array of [timestamp, value] pairs for the metric filtered by both category and chain. For bridges, dailyAggregatedVolume and dailyTxCount include incoming plus outgoing activity on each chain; summing chains can count a transfer twice.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "category", "in": "path", "required": true, "description": "category slug (slugified category name, e.g. 'dexs', 'prediction-market', 'options')", "schema": { "type": "string", "example": "dexs" } }, { "name": "chain", "in": "path", "required": true, "description": "chain name", "schema": { "type": "string", "example": "Ethereum" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Array of [timestamp, value] pairs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2, "example": [1534550400, 42000000] } } } } }, "404": { "description": "Not found" } } } }, "/api/v2/chart/{metric}/category/{category}/chain/{chain}/protocol-breakdown": { "get": { "tags": ["Dimensions"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get category chain timeseries chart data breakdown by protocol", "description": "Returns an array of [timestamp, {protocol: value}] pairs showing the metric filtered by both category and chain, broken down by protocol. For bridges, dailyAggregatedVolume and dailyTxCount include incoming plus outgoing activity on each chain; summing chains can count a transfer twice.", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "The dimension metric type", "schema": { "type": "string", "enum": [ "fees", "liquidations", "dexs", "derivatives", "options", "aggregators", "bridge-aggregators", "bridges", "open-interest", "normalized-volume" ], "example": "fees" } }, { "name": "category", "in": "path", "required": true, "description": "category slug (slugified category name, e.g. 'dexs', 'prediction-market', 'options')", "schema": { "type": "string", "example": "dexs" } }, { "name": "chain", "in": "path", "required": true, "description": "chain name", "schema": { "type": "string", "example": "Ethereum" } }, { "name": "dataType", "in": "query", "required": false, "description": "Metric-specific data type to return. Supported values per metric:\n- **fees**: dailyFees (default), dailyRevenue, dailySupplySideRevenue, dailyHoldersRevenue, dailyProtocolRevenue\n- **liquidations**: dailyLiquidationsVolume (default), dailyCollateralLiquidated\n- **dexs**: dailyVolume (default), dailyNotionalVolume\n- **derivatives**: dailyVolume (default), dailyNotionalVolume\n- **options**: dailyNotionalVolume (default), dailyPremiumVolume\n- **aggregators**: dailyVolume (default)\n- **bridge-aggregators**: dailyBridgeVolume (default)\n- **bridges**: dailyAggregatedVolume (default), dailyOutgoingVolume, dailyIncomingVolume, dailyTxCount, dailyOutgoingTxCount, dailyIncomingTxCount\n- **open-interest**: openInterestAtEnd (default), shortOpenInterestAtEnd, longOpenInterestAtEnd\n- **normalized-volume**: dailyNormalizedVolume (default), dailyActiveLiquidity\n\nFor bridges, volume values are in USD and TxCount values count transfers. Protocol dailyAggregatedVolume and dailyTxCount use outgoing totals; per-chain values add incoming and outgoing activity. Direction is relative to the chain.", "schema": { "type": "string", "example": "dailyFees" } } ], "responses": { "200": { "description": "Array of [timestamp, protocolBreakdown] pairs", "content": { "application/json": { "schema": { "type": "array", "example": [ [ 1534550400, { "Uniswap V3": 15000000, "Aave": 8000000 } ], [ 1534636800, { "Uniswap V3": 15500000, "Aave": 8200000 } ] ] } } } }, "404": { "description": "Not found" } } } }, "/api/v2/metrics/financial-statement/protocol/{protocol}": { "get": { "tags": ["Financial Statements"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get protocol income statement report", "description": "Returns protocol metadata, methodology details, and aggregated financial statement data (yearly, quarterly, monthly). Each period contains line items such as Gross Protocol Revenue, Cost Of Revenue, Gross Profit, Token Holder Net Income, Incentives, and Earnings, with values and optional label breakdowns.\n\nWhen querying a parent protocol (e.g. `aave`), the response includes a `childProtocols` array with per-version methodology. When querying a child protocol (e.g. `aave-v3`), methodology and breakdownMethodology are at the top level.", "parameters": [ { "name": "protocol", "in": "path", "required": true, "description": "protocol slug (e.g. aave-v3, hyperliquid)", "schema": { "type": "string", "example": "aave-v3" } } ], "responses": { "200": { "description": "Protocol income statement report", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Protocol ID. Parent protocols use 'parent#slug' format.", "example": "1599" }, "name": { "type": "string", "example": "Aave V3" }, "address": { "type": "string", "nullable": true, "example": "0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9" }, "symbol": { "type": "string", "nullable": true, "example": "AAVE" }, "url": { "type": "string", "example": "https://aave.com" }, "description": { "type": "string", "example": "Earn interest, borrow assets, and build applications" }, "chain": { "type": "string", "nullable": true, "description": "Primary chain (present for child protocols)", "example": "Optimism" }, "logo": { "type": "string", "example": "https://icons.llamao.fi/icons/protocols/aave-v3.png" }, "audits": { "type": "string", "nullable": true, "example": "2" }, "audit_links": { "type": "array", "nullable": true, "items": { "type": "string" }, "example": ["https://aave.com/security"] }, "category": { "type": "string", "nullable": true, "description": "Protocol category (present for child protocols)", "example": "Lending" }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Polygon", "Arbitrum", "Avalanche", "OP Mainnet", "Ethereum", "Base"] }, "oraclesBreakdown": { "type": "array", "nullable": true, "description": "Oracles used by the protocol", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Chainlink" }, "type": { "type": "string", "example": "Primary" }, "proof": { "type": "array", "items": { "type": "string" } } } } }, "module": { "type": "string", "nullable": true, "example": "aave-v3" }, "twitter": { "type": "string", "nullable": true, "example": "aave" }, "github": { "type": "array", "nullable": true, "items": { "type": "string" } }, "listedAt": { "type": "integer", "nullable": true, "description": "Unix timestamp when protocol was listed", "example": 1648776877 }, "parentProtocol": { "type": "string", "nullable": true, "description": "Parent protocol ID (present for child protocols)", "example": "parent#aave" }, "dimensions": { "type": "object", "nullable": true, "description": "Available dimension adapters for this protocol", "additionalProperties": { "oneOf": [ { "type": "string", "example": "aave-v3" }, { "type": "object", "properties": { "adapter": { "type": "string" }, "genuineSpikes": { "type": "array" } } } ] }, "example": { "fees": { "genuineSpikes": [["2024-08-05", "-"]], "adapter": "aave-v3" }, "liquidations": "aave-v3" } }, "methodology": { "type": "object", "nullable": true, "description": "Maps line item names to descriptions. Present at top level for child protocols, inside childProtocols for parent protocols.", "additionalProperties": { "type": "string" }, "example": { "Gross Protocol Revenue": "Include borrow interest, flashloan fee, liquidation fee, penalty paid by borrowers and swap fees from Paraswap.", "Cost Of Revenue": "Amount of fees distributed to suppliers.", "Gross Profit": "Amount of fees go to Aave treasury.", "Token Holder Net Income": "Aave starts buy back AAVE tokens using Aave Treasury after 9th April 2025." } }, "breakdownMethodology": { "type": "object", "nullable": true, "description": "Maps line item names to objects mapping label names to descriptions. Present at top level for child protocols, inside childProtocols for parent protocols.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "example": { "Gross Protocol Revenue": { "Borrow Interest": "All interest paid by borrowers from all markets (excluding GHO).", "Borrow Interest GHO": "All interest paid by borrowers from GHO only.", "Liquidation Fees": "Fees from liquidation penalty and bonuses.", "Flashloan Fees": "Flashloan fees paid by flashloan borrowers and executors.", "Paraswap Partner Fees": "Swap fees share from Paraswap from users by using Aave frontend." }, "Cost Of Revenue": { "Borrow Interest": "Amount of interest distributed to lenders from all markets (excluding GHO).", "Liquidation Fees": "Fees from liquidation penalty and bonuses are distributed to lenders." }, "Gross Profit": { "Borrow Interest": "A portion of interest paid by borrowers from all markets (excluding GHO).", "Borrow Interest GHO": "All 100% interest paid by GHO borrowers.", "Liquidation Fees": "A portion of fees from liquidation penalty and bonuses." }, "Token Holder Net Income": { "Token Buy Back": "Aave starts buy back AAVE tokens using Aave Treasury after 9th April 2025." } } }, "methodologyURL": { "type": "string", "nullable": true, "example": "https://github.com/DefiLlama/dimension-adapters/blob/master/fees/aave-v3.ts" }, "tvlCodePath": { "type": "string", "nullable": true, "example": "https://github.com/DefiLlama/DefiLlama-Adapters/blob/main/projects/aave-v3/index.js" }, "hallmarks": { "type": "array", "nullable": true, "description": "Notable events as [timestamp, description] pairs", "items": { "type": "array", "items": {} }, "example": [[1650412800, "Start AVAX Rewards"], [1659571200, "Start OP Rewards"]] }, "linkedProtocols": { "type": "array", "items": { "type": "string" }, "example": ["Aave", "Aave V2", "Aave V3"] }, "childProtocols": { "type": "array", "nullable": true, "description": "Child protocol versions with their methodology details. Only present for parent protocols.", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Aave V3" }, "defillamaId": { "type": "string", "example": "1599" }, "displayName": { "type": "string" }, "methodologyURL": { "type": "string", "nullable": true }, "methodology": { "type": "object", "additionalProperties": { "type": "string" } }, "breakdownMethodology": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "hasLabelBreakdown": { "type": "boolean", "example": true }, "defillamaId": { "type": "string", "example": "1599" }, "displayName": { "type": "string", "example": "Aave V3" }, "slug": { "type": "string", "example": "aave-v3" }, "protocolType": { "type": "string", "example": "protocol" }, "aggregates": { "type": "object", "description": "Financial data aggregated by time period", "properties": { "yearly": { "type": "object", "description": "Keyed by year (e.g. '2024'). Each value is an object of line items.", "additionalProperties": { "type": "object", "description": "Financial line items for a time period. Common line items include Gross Protocol Revenue, Cost Of Revenue, Gross Profit, Token Holder Net Income, Incentives, and Earnings. Each line item has a value and optional by-label breakdown.", "additionalProperties": { "type": "object", "properties": { "value": { "type": "number", "description": "Total USD value for this line item in the period", "example": 456472580 }, "by-label": { "type": "object", "description": "Breakdown by label (e.g. Borrow Interest, Liquidation Fees, Flash Loans). Not present for all line items.", "nullable": true, "additionalProperties": { "type": "number" }, "example": { "Borrow Interest": 416862749, "Liquidation Fees": 31413361, "Flashloan Fees": 1441 } } } }, "example": { "Gross Protocol Revenue": { "value": 456472580, "by-label": { "Borrow Interest": 416862749, "Liquidation Fees": 31413361, "Flashloan Fees": 1441 } }, "Cost Of Revenue": { "value": 384670312, "by-label": { "Borrow Interest": 356424169, "Liquidation Fees": 28246110 } }, "Gross Profit": { "value": 71802305 }, "Token Holder Net Income": { "value": 0 }, "Incentives": { "value": 4895806.72, "by-label": { "stkAAVE Rewards": 19461161.65, "Lending/Borrowing Rewards": 1197840.72 } }, "Earnings": { "value": 66906498.28 } } } }, "quarterly": { "type": "object", "description": "Keyed by quarter (e.g. '2024-Q1'). Each value is an object of line items.", "additionalProperties": { "type": "object", "description": "Financial line items for a time period.", "additionalProperties": { "type": "object", "properties": { "value": { "type": "number", "description": "Total USD value for this line item in the period", "example": 456472580 }, "by-label": { "type": "object", "description": "Breakdown by label. Not present for all line items.", "nullable": true, "additionalProperties": { "type": "number" } } } } } }, "monthly": { "type": "object", "description": "Keyed by month (e.g. '2024-01'). Each value is an object of line items.", "additionalProperties": { "type": "object", "description": "Financial line items for a time period.", "additionalProperties": { "type": "object", "properties": { "value": { "type": "number", "description": "Total USD value for this line item in the period", "example": 456472580 }, "by-label": { "type": "object", "description": "Breakdown by label. Not present for all line items.", "nullable": true, "additionalProperties": { "type": "number" } } } } } } } } } } } } }, "404": { "description": "Protocol not found" } } } }, "/stablecoins/stablecoindominance/{chain}": { "get": { "tags": ["stablecoins"], "summary": "Get stablecoin dominance per chain along with the info about the larges coin in a chain", "parameters": [ { "name": "chain", "in": "path", "required": true, "description": "chain slug, you can get these from /chains or the chains property on /protocols", "schema": { "type": "string", "example": "Ethereum" } }, { "name": "stablecoin", "in": "query", "required": false, "description": "stablecoin ID, you can get these from /stablecoins", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "example": "1752796800" }, "totalCirculatingUSD": { "type": "object", "properties": { "peggedUSD": { "type": "number", "example": 129531632690.44954 }, "peggedVAR": { "type": "number", "example": 100466426.71408615 }, "peggedEUR": { "type": "number", "example": 286714265.91542196 } } }, "greatestMcap": { "type": "object", "properties": { "gecko_id": { "type": "string", "example": "tether" }, "symbol": { "type": "string", "example": "USDT" }, "mcap": { "type": "number", "example": 65836754910.17763 } } } } } } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.stablecoins.getDominance('')" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.stablecoins.getDominance('')" } ] } }, "/yields/v1/pools": { "get": { "tags": ["yields"], "x-api-plan-only": true, "summary": "Retrieve the latest data for all pools in the legacy v1 response format", "description": "Serves the former `/yields/pools` response format, including the extra fields from `/yields/poolsOld`. Frozen for compatibility: the shape will not change and no new fields will be added - use `/yields/v2/earn` for new integrations.", "responses": { "200": { "description": "Array of all pools in the legacy v1 format", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "object", "properties": { "pool": { "type": "string", "description": "Pool id (UUID). Same id space as the v2 yields API.", "example": "747c1d2a-c668-4682-b9f9-296708a3dd90" }, "timestamp": { "type": "string", "description": "Timestamp of the latest data point.", "example": "2026-09-17T14:10:48.521Z" }, "project": { "type": "string", "example": "lido" }, "chain": { "type": "string", "example": "Ethereum" }, "symbol": { "type": "string", "description": "Uppercase symbol.", "example": "STETH" }, "poolMeta": { "type": ["string", "null"], "example": null }, "underlyingTokens": { "type": ["array", "null"], "description": "Underlying token addresses, lowercase.", "items": { "type": "string" }, "example": ["0x0000000000000000000000000000000000000000"] }, "rewardTokens": { "type": ["array", "null"], "description": "Reward token addresses, lowercase; null when no rewards are currently flowing.", "items": { "type": "string" }, "example": null }, "poolTokenAddress": { "type": ["string", "null"], "description": "Receipt/pool token address, lowercase.", "example": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84" }, "tvlUsd": { "type": "number", "description": "TVL in USD; for lending markets this is available liquidity, not total supplied.", "example": 23592091898 }, "apy": { "type": "number", "example": 2.212 }, "apyBase": { "type": ["number", "null"], "example": 2.212 }, "apyReward": { "type": ["number", "null"], "example": null }, "il7d": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "apyBase7d": { "type": ["number", "null"], "description": "7-day base APY, where the adapter reports one.", "example": null }, "volumeUsd1d": { "type": ["number", "null"], "example": null }, "volumeUsd7d": { "type": ["number", "null"], "description": "7-day volume in USD.", "example": null }, "apyBaseInception": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "url": { "type": "string", "example": "https://lido.fi/#networks" }, "apyPct1D": { "type": ["number", "null"], "description": "Absolute APY change vs 1 day ago, in percentage points.", "example": -0.02227 }, "apyPct7D": { "type": ["number", "null"], "example": -0.06154 }, "apyPct30D": { "type": ["number", "null"], "example": 0.01517 }, "apyMean30d": { "type": ["number", "null"], "description": "30-day mean APY.", "example": 2.21043 }, "stablecoin": { "type": "boolean", "description": "Whether every underlying asset is a stablecoin.", "example": false }, "ilRisk": { "type": "string", "example": "no" }, "exposure": { "type": "string", "example": "single" }, "return": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "count": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "apyMeanExpanding": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "apyStdExpanding": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "mu": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "sigma": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "outlier": { "type": ["boolean", "null"], "description": "True when the pool's APY is a statistical outlier within its cohort.", "example": false }, "project_factorized": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "chain_factorized": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "predictions": { "type": "object", "description": "Always null; no longer computed.", "properties": { "predictedClass": { "type": ["string", "null"], "example": null }, "predictedProbability": { "type": ["number", "null"], "example": null }, "binnedConfidence": { "type": ["number", "null"], "example": null } } }, "pool_old": { "type": "string", "description": "The original pool key (usually contains a pool address).", "example": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84" } } } } } } } } } } } }, "/yields/v1/chart/{pool}": { "get": { "tags": ["yields"], "x-api-plan-only": true, "summary": "Get historical APY and TVL of a pool in the legacy v1 response format", "description": "Daily history in the legacy v1 format. Every value is the day's last observation. Unknown pool ids return an empty `data` array.", "parameters": [ { "name": "pool", "in": "path", "required": true, "description": "pool id (UUID), from /yields/v1/pools (property is called pool)", "schema": { "type": "string", "example": "747c1d2a-c668-4682-b9f9-296708a3dd90" } } ], "responses": { "200": { "description": "Historical APY and TVL data for the specified pool", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-05-03T00:00:00.000Z" }, "tvlUsd": { "type": ["number", "null"], "description": "The day's last observation.", "example": 11074372760 }, "apy": { "type": ["number", "null"], "description": "The day's last observation.", "example": 3.6 }, "apyBase": { "type": ["number", "null"], "example": 3.6 }, "apyReward": { "type": ["number", "null"], "example": null }, "il7d": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "apyBase7d": { "type": ["number", "null"], "description": "7-day base APY, where the adapter reports one.", "example": null }, "pricePerShare": { "type": ["number", "null"], "description": "The day's last observation.", "example": null } } } } } } } } } } } }, "/yields/v1/poolsBorrow": { "get": { "tags": ["yields"], "x-api-plan-only": true, "summary": "Borrow costs APY of assets from lending markets in the legacy v1 response format", "description": "Serves the former `/yields/poolsBorrow` response format. Markets that cannot currently be borrowed from are not listed. Frozen for compatibility: the shape will not change and no new fields will be added - use `/yields/v2/borrow/markets` for new integrations.", "responses": { "200": { "description": "Array of lending markets in the legacy v1 format", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "object", "properties": { "chain": { "type": "string", "example": "Ethereum" }, "project": { "type": "string", "example": "aave-v3" }, "symbol": { "type": "string", "description": "Uppercase symbol.", "example": "WETH" }, "tvlUsd": { "type": ["number", "null"], "description": "TVL in USD; for lending markets this is available liquidity, not total supplied.", "example": 727935089 }, "apyBase": { "type": ["number", "null"], "example": 1.45716 }, "apyReward": { "type": ["number", "null"], "example": null }, "apy": { "type": ["number", "null"], "example": 1.45716 }, "rewardTokens": { "type": ["array", "null"], "description": "Reward token addresses, lowercase; null when no rewards are currently flowing.", "items": { "type": "string" }, "example": null }, "pool": { "type": "string", "description": "Pool id (UUID). Same id space as the v2 yields API.", "example": "e880e828-ca59-4ec6-8d4f-27182a4dc23d" }, "apyPct1D": { "type": ["number", "null"], "description": "Absolute APY change vs 1 day ago, in percentage points.", "example": -0.05531 }, "apyPct7D": { "type": ["number", "null"], "example": -0.06874 }, "apyPct30D": { "type": ["number", "null"], "example": -0.02456 }, "stablecoin": { "type": "boolean", "description": "Whether every underlying asset is a stablecoin.", "example": false }, "ilRisk": { "type": "string", "example": "no" }, "exposure": { "type": "string", "example": "single" }, "predictions": { "type": "object", "description": "Always null; no longer computed.", "properties": { "predictedClass": { "type": ["string", "null"], "example": null }, "predictedProbability": { "type": ["number", "null"], "example": null }, "binnedConfidence": { "type": ["number", "null"], "example": null } } }, "poolMeta": { "type": ["string", "null"], "example": null }, "mu": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "sigma": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "count": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "outlier": { "type": ["boolean", "null"], "description": "True when the pool's APY is a statistical outlier within its cohort.", "example": false }, "underlyingTokens": { "type": ["array", "null"], "description": "Underlying token addresses, lowercase.", "items": { "type": "string" }, "example": ["0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"] }, "il7d": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "apyBase7d": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "apyMean30d": { "type": ["number", "null"], "description": "30-day mean APY.", "example": 1.4662 }, "volumeUsd1d": { "type": ["number", "null"], "example": null }, "volumeUsd7d": { "type": ["number", "null"], "description": "7-day volume in USD.", "example": null }, "apyBaseInception": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null }, "apyBaseBorrow": { "type": ["number", "null"], "example": 2.05028 }, "apyRewardBorrow": { "type": ["number", "null"], "example": null }, "totalSupplyUsd": { "type": ["number", "null"], "example": 5234129189 }, "totalBorrowUsd": { "type": ["number", "null"], "example": 4376489739 }, "debtCeilingUsd": { "type": ["number", "null"], "example": null }, "ltv": { "type": ["number", "null"], "example": 0.805 }, "borrowable": { "type": ["boolean", "null"], "example": true }, "mintedCoin": { "type": ["string", "null"], "description": "The borrowed token's symbol when it differs from the deposited asset (CDP-style markets).", "example": null }, "borrowFactor": { "type": ["number", "null"], "description": "Always null; no longer computed.", "example": null } } } } } } } } } } } }, "/yields/v1/chartLendBorrow/{pool}": { "get": { "tags": ["yields"], "x-api-plan-only": true, "summary": "Historical borrow cost APY from a pool on a lending market in the legacy v1 response format", "description": "Daily borrow-market history in the legacy v1 format. Every value is the day's last observation. Unknown pool ids return an empty `data` array.", "parameters": [ { "name": "pool", "in": "path", "required": true, "description": "pool id (UUID), from /yields/v1/poolsBorrow (property is called pool)", "schema": { "type": "string", "example": "747c1d2a-c668-4682-b9f9-296708a3dd90" } } ], "responses": { "200": { "description": "Historical lend/borrow data for the specified pool", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2023-02-06T23:01:24.670Z" }, "totalSupplyUsd": { "type": ["number", "null"], "description": "The day's last observation.", "example": 60767153 }, "totalBorrowUsd": { "type": ["number", "null"], "description": "The day's last observation.", "example": 33150230 }, "debtCeilingUsd": { "type": ["number", "null"], "example": null }, "apyBase": { "type": ["number", "null"], "description": "The day's last observation.", "example": 1.66533 }, "apyReward": { "type": ["number", "null"], "example": null }, "apyBaseBorrow": { "type": ["number", "null"], "description": "The day's last observation.", "example": 3.59132 }, "apyRewardBorrow": { "type": ["number", "null"], "example": null } } } } } } } } } } } }, "/yields/v2/earn": { "get": { "tags": ["yields"], "x-api-plan-only": true, "summary": "Retrieve the latest data for all earn pools", "description": "Returns every tracked earn pool (supply-side yield), sorted by TVL descending. APY values are percentages, attributed into `base` (organic), `reward` (incentive emissions) and `total` (base + reward) over `current`, `avg_7d` and `avg_30d` windows. Pools whose underlying token is itself yield-bearing additionally report that yield under `intrinsic`; it is not included in the pool APY. For a filtered, paginated variant of the same rows use `/yields/v2/earn/query`.", "responses": { "200": { "description": "Array of all earn pools", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Pool id (UUID). Same id space as the v1 yields API pool field.", "example": "747c1d2a-c668-4682-b9f9-296708a3dd90" }, "pool_key": { "type": "string", "description": "Stable pool key.", "example": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84-ethereum" }, "pool_token": { "type": ["object", "null"], "description": "Receipt / vault token representing the position; null when the pool has no transferable pool token", "properties": { "address": { "type": "string", "example": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84" }, "symbol": { "type": ["string", "null"], "example": "stETH" }, "name": { "type": ["string", "null"], "example": "Liquid staked Ether 2.0" } } }, "display": { "type": "object", "description": "Display strings for listings", "properties": { "label": { "type": ["string", "null"], "example": "stETH" }, "detail": { "type": ["string", "null"], "example": "Liquid staked Ether 2.0" } } }, "reference_asset_symbol": { "type": ["string", "null"], "description": "The asset you provide to enter the pool (e.g. ETH, USDC, BTC)", "example": "ETH" }, "url": { "type": ["string", "null"], "description": "Pool page on the protocol app", "example": "https://lido.fi/#networks" }, "protocol": { "type": "string", "description": "Protocol display name", "example": "Lido" }, "chain": { "type": "string", "description": "Chain display name", "example": "Ethereum" }, "underlying_tokens": { "type": "array", "description": "Tokens deposited into the pool", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "0x0000000000000000000000000000000000000000" }, "symbol": { "type": ["string", "null"], "example": "ETH" }, "decimals": { "type": ["integer", "null"], "example": 18 } } } }, "reward_tokens": { "type": "array", "description": "Incentive tokens currently emitted to the pool; empty when there are none", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "0xd533a949740bb3306d119cc777fa900ba034cd52" }, "symbol": { "type": ["string", "null"], "example": "CRV" }, "decimals": { "type": ["integer", "null"], "example": 18 } } } }, "tvl_usd": { "type": ["number", "null"], "description": "Total value locked in USD", "example": 18050422129 }, "apy": { "type": "object", "description": "Supply APY in percent, attributed into base (organic) and reward (incentive emissions) components", "properties": { "current": { "type": "object", "description": "Latest observed values", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.206 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 2.206 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.18932 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 2.18932 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.22409 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 2.22409 } } } } }, "intrinsic": { "type": ["object", "null"], "description": "Yield accruing inside a yield-bearing underlying token, e.g. the stETH staking yield inside a wstETH pool. Intrinsic yield is reported separately and is NOT included in the base/reward/total APY. Null when there is no intrinsic yield source.", "properties": { "apy": { "type": "object", "description": "Intrinsic APY in percent", "properties": { "current": { "type": "object", "description": "Latest observed value", "properties": { "base": { "type": ["number", "null"], "example": 3.11 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.05 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.02 } } } } }, "source_pool": { "type": "object", "properties": { "id": { "type": "string", "description": "Earn pool the intrinsic yield is sourced from", "example": "747c1d2a-c668-4682-b9f9-296708a3dd90" }, "pool_token": { "type": "string", "description": "Address of the yield-bearing token", "example": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84" }, "symbol": { "type": ["string", "null"], "example": "stETH" } } } } }, "stability_30d": { "type": "object", "description": "Stability score (0 to 1) of the trailing 30-day APY series, computed as 1 / (1 + coefficient of variation); higher is steadier. Keyed by APY composition: read the leaf matching the APY components you consume (base, base + reward, base + intrinsic, base + reward + intrinsic).", "properties": { "base": { "type": ["number", "null"], "example": 0.9804 }, "base_reward": { "type": ["number", "null"], "example": 0.9804 }, "base_intrinsic": { "type": ["number", "null"], "example": 0.9804 }, "base_reward_intrinsic": { "type": ["number", "null"], "example": 0.9804 } } }, "price_per_share": { "type": ["number", "null"], "description": "Pool token price per share for vault-style pools; null otherwise", "example": null }, "volume_1d_usd": { "type": ["number", "null"], "description": "Trailing 24h trading volume in USD for DEX pools; null otherwise", "example": null }, "attributes": { "type": "object", "description": "Boolean attributes, also available as filters on /yields/v2/earn/query", "properties": { "stablecoin_only": { "type": "boolean", "description": "All pool assets are stablecoins", "example": false }, "single_asset_exposure": { "type": "boolean", "description": "Position is exposed to a single asset", "example": true }, "impermanent_loss_risk": { "type": "boolean", "description": "Position can suffer impermanent loss", "example": false } } }, "holders": { "type": "object", "description": "Pool token holder statistics; values are null where holder data is not tracked", "properties": { "count": { "type": ["number", "null"], "description": "Number of pool token holders", "example": 618311 }, "avg_position_usd": { "type": ["number", "null"], "description": "Average position size in USD", "example": 29423.56 }, "top_10_share_pct": { "type": ["number", "null"], "description": "Share of supply held by the top 10 holders, in percent", "example": 61.97 } } }, "available_supply_usd": { "type": ["number", "null"], "description": "Remaining deposit capacity in USD for lending pools with a supply cap (cap minus TVL, floored at 0); null when the pool has no cap", "example": null } } } } } } } } } } } }, "/yields/v2/earn/query": { "get": { "tags": ["yields"], "x-api-plan-only": true, "summary": "Retrieve a filtered, paginated page of earn pools", "description": "Same rows as `/yields/v2/earn`, filtered and paginated server-side while keeping the TVL-descending order. All filters combine with AND; `chain` and `protocol` may be repeated to match any of up to 20 values. Unknown query parameters and out-of-range values are rejected with `400 INVALID_QUERY_PARAM`. Without parameters the top 100 pools by TVL are returned.", "parameters": [ { "name": "chain", "in": "query", "required": false, "description": "Chain slug (lowercase). Repeat the parameter to match any of several chains, e.g. chain=ethereum&chain=arbitrum (at most 20 values)", "schema": { "type": "string", "example": "ethereum" } }, { "name": "protocol", "in": "query", "required": false, "description": "Protocol slug (lowercase, e.g. aave-v3). Repeat the parameter to match any of several protocols (at most 20 values)", "schema": { "type": "string", "example": "lido" } }, { "name": "stablecoin", "in": "query", "required": false, "description": "true keeps only pools whose assets are all stablecoins, false only the rest", "schema": { "type": "boolean", "example": true } }, { "name": "single_asset_exposure", "in": "query", "required": false, "description": "true keeps only pools exposed to a single asset, false only the rest", "schema": { "type": "boolean", "example": true } }, { "name": "impermanent_loss_risk", "in": "query", "required": false, "description": "true keeps only pools with impermanent loss risk, false only the rest", "schema": { "type": "boolean", "example": false } }, { "name": "min_tvl", "in": "query", "required": false, "description": "Minimum pool TVL in USD (inclusive)", "schema": { "type": "number", "example": 1000000 } }, { "name": "page", "in": "query", "required": false, "description": "1-based page number; default 1", "schema": { "type": "integer", "minimum": 1, "example": 1 } }, { "name": "limit", "in": "query", "required": false, "description": "Page size between 1 and 300; default 100. Values above 300 are rejected, not clamped", "schema": { "type": "integer", "minimum": 1, "maximum": 300, "example": 100 } } ], "responses": { "200": { "description": "Page of earn pools matching the filters", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Pool id (UUID). Same id space as the v1 yields API pool field.", "example": "747c1d2a-c668-4682-b9f9-296708a3dd90" }, "pool_key": { "type": "string", "description": "Stable pool key.", "example": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84-ethereum" }, "pool_token": { "type": ["object", "null"], "description": "Receipt / vault token representing the position; null when the pool has no transferable pool token", "properties": { "address": { "type": "string", "example": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84" }, "symbol": { "type": ["string", "null"], "example": "stETH" }, "name": { "type": ["string", "null"], "example": "Liquid staked Ether 2.0" } } }, "display": { "type": "object", "description": "Display strings for listings", "properties": { "label": { "type": ["string", "null"], "example": "stETH" }, "detail": { "type": ["string", "null"], "example": "Liquid staked Ether 2.0" } } }, "reference_asset_symbol": { "type": ["string", "null"], "description": "The asset you provide to enter the pool (e.g. ETH, USDC, BTC)", "example": "ETH" }, "url": { "type": ["string", "null"], "description": "Pool page on the protocol app", "example": "https://lido.fi/#networks" }, "protocol": { "type": "string", "description": "Protocol display name", "example": "Lido" }, "chain": { "type": "string", "description": "Chain display name", "example": "Ethereum" }, "underlying_tokens": { "type": "array", "description": "Tokens deposited into the pool", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "0x0000000000000000000000000000000000000000" }, "symbol": { "type": ["string", "null"], "example": "ETH" }, "decimals": { "type": ["integer", "null"], "example": 18 } } } }, "reward_tokens": { "type": "array", "description": "Incentive tokens currently emitted to the pool; empty when there are none", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "0xd533a949740bb3306d119cc777fa900ba034cd52" }, "symbol": { "type": ["string", "null"], "example": "CRV" }, "decimals": { "type": ["integer", "null"], "example": 18 } } } }, "tvl_usd": { "type": ["number", "null"], "description": "Total value locked in USD", "example": 18050422129 }, "apy": { "type": "object", "description": "Supply APY in percent, attributed into base (organic) and reward (incentive emissions) components", "properties": { "current": { "type": "object", "description": "Latest observed values", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.206 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 2.206 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.18932 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 2.18932 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.22409 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 2.22409 } } } } }, "intrinsic": { "type": ["object", "null"], "description": "Yield accruing inside a yield-bearing underlying token, e.g. the stETH staking yield inside a wstETH pool. Intrinsic yield is reported separately and is NOT included in the base/reward/total APY. Null when there is no intrinsic yield source.", "properties": { "apy": { "type": "object", "description": "Intrinsic APY in percent", "properties": { "current": { "type": "object", "description": "Latest observed value", "properties": { "base": { "type": ["number", "null"], "example": 3.11 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.05 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.02 } } } } }, "source_pool": { "type": "object", "properties": { "id": { "type": "string", "description": "Earn pool the intrinsic yield is sourced from", "example": "747c1d2a-c668-4682-b9f9-296708a3dd90" }, "pool_token": { "type": "string", "description": "Address of the yield-bearing token", "example": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84" }, "symbol": { "type": ["string", "null"], "example": "stETH" } } } } }, "stability_30d": { "type": "object", "description": "Stability score (0 to 1) of the trailing 30-day APY series, computed as 1 / (1 + coefficient of variation); higher is steadier. Keyed by APY composition: read the leaf matching the APY components you consume (base, base + reward, base + intrinsic, base + reward + intrinsic).", "properties": { "base": { "type": ["number", "null"], "example": 0.9804 }, "base_reward": { "type": ["number", "null"], "example": 0.9804 }, "base_intrinsic": { "type": ["number", "null"], "example": 0.9804 }, "base_reward_intrinsic": { "type": ["number", "null"], "example": 0.9804 } } }, "price_per_share": { "type": ["number", "null"], "description": "Pool token price per share for vault-style pools; null otherwise", "example": null }, "volume_1d_usd": { "type": ["number", "null"], "description": "Trailing 24h trading volume in USD for DEX pools; null otherwise", "example": null }, "attributes": { "type": "object", "description": "Boolean attributes, also available as filters on /yields/v2/earn/query", "properties": { "stablecoin_only": { "type": "boolean", "description": "All pool assets are stablecoins", "example": false }, "single_asset_exposure": { "type": "boolean", "description": "Position is exposed to a single asset", "example": true }, "impermanent_loss_risk": { "type": "boolean", "description": "Position can suffer impermanent loss", "example": false } } }, "holders": { "type": "object", "description": "Pool token holder statistics; values are null where holder data is not tracked", "properties": { "count": { "type": ["number", "null"], "description": "Number of pool token holders", "example": 618311 }, "avg_position_usd": { "type": ["number", "null"], "description": "Average position size in USD", "example": 29423.56 }, "top_10_share_pct": { "type": ["number", "null"], "description": "Share of supply held by the top 10 holders, in percent", "example": 61.97 } } }, "available_supply_usd": { "type": ["number", "null"], "description": "Remaining deposit capacity in USD for lending pools with a supply cap (cap minus TVL, floored at 0); null when the pool has no cap", "example": null } } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "description": "Total number of rows matching the filters, across all pages", "example": 4519 }, "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 100 } } } } } } } }, "400": { "description": "Unknown query parameter or invalid value", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_QUERY_PARAM" }, "message": { "type": "string", "example": "unknown query parameter: chains" } } } } } } } } } } }, "/yields/v2/earn/{id}/history": { "get": { "tags": ["yields"], "x-api-plan-only": true, "summary": "Retrieve daily history for an earn pool", "description": "Daily TVL, attributed APY and price per share for one earn pool, oldest first. APY carries `avg_1d` (that day), `avg_7d` and `avg_30d` (trailing averages ending that day) windows, each attributed into base/reward/total.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Earn pool id (UUID)", "schema": { "type": "string", "example": "747c1d2a-c668-4682-b9f9-296708a3dd90" } }, { "name": "range", "in": "query", "required": false, "description": "History window; defaults to max (the full series)", "schema": { "type": "string", "enum": ["30d", "90d", "max"], "example": "90d" } } ], "responses": { "200": { "description": "Daily history rows, oldest first", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "Day (UTC)", "example": "2026-07-27" }, "tvl_usd": { "type": ["number", "null"], "description": "Total value locked in USD at that day", "example": 18233358161 }, "apy": { "type": "object", "description": "Supply APY in percent, attributed into base (organic) and reward (incentive emissions) components", "properties": { "avg_1d": { "type": "object", "description": "Average over that day", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.26695 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 2.26695 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.18878 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 2.18878 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.22396 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 2.22396 } } } } }, "intrinsic": { "type": ["object", "null"], "description": "Intrinsic yield of a yield-bearing underlying token. Intrinsic yield is reported separately and is NOT included in the base/reward/total APY. Null when there is no intrinsic yield source.", "properties": { "apy": { "type": "object", "description": "Intrinsic APY in percent", "properties": { "avg_1d": { "type": "object", "description": "Average over that day", "properties": { "base": { "type": ["number", "null"], "example": 3.11 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.05 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.02 } } } } } } }, "price_per_share": { "type": ["number", "null"], "description": "Pool token price per share for vault-style pools; null otherwise", "example": null } } } } } } } } }, "404": { "description": "No earn pool with this id", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "example": "POOL_NOT_FOUND" }, "message": { "type": "string", "example": "earn pool not found" } } } } } } } } } } }, "/yields/v2/earn/verified": { "get": { "tags": ["yields"], "x-api-plan-only": true, "summary": "Retrieve the latest verified data for all measured earn pools", "description": "Measured yield for the `/yields/v2/earn` pools we simulate, sorted by verified TVL descending. Each figure is replayed from a real holder's withdrawal against archive state, so it shows what an exit would have paid rather than what the protocol reports; the two can disagree without either being wrong. APY is always the base leg, since a withdrawal cannot see reward emissions, and is unclamped, so it can be negative. A pool appears here only while it is listed on `/yields/v2/earn`, is not withheld for review, and has at least one measured day; join on `id`.", "responses": { "200": { "description": "Array of all verified earn pools", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Pool id (UUID); joins to `/yields/v2/earn`", "example": "e880e828-ca59-4ec6-8d4f-27182a4dc23d" }, "apy": { "type": "object", "description": "Measured base APY in percent. Base only, since a withdrawal cannot see reward emissions, and unclamped, so it can be negative. All three windows end at `apy_as_of`.", "properties": { "avg_1d": { "type": ["number", "null"], "description": "Trailing 1-day average", "example": 1.45698 }, "avg_7d": { "type": ["number", "null"], "description": "Trailing 7-day average", "example": 1.44895 }, "avg_30d": { "type": ["number", "null"], "description": "Trailing 30-day average", "example": 1.47156 } } }, "apy_as_of": { "type": ["string", "null"], "description": "Timestamp the APY windows end at", "example": "2026-09-14T09:19:11.000Z" }, "apy_note": { "type": ["string", "null"], "description": "Why the APY is absent or qualified. Show it wherever the APY renders blank; null for most pools.", "example": null }, "apy_confidence": { "type": ["string", "null"], "description": "How closely independent holders agreed on the redemption rate. Grades the measurement, not the pool.", "enum": ["high", "medium", "low", "conflict", null], "example": "high" }, "exit": { "type": "object", "description": "Exit health from the most recent simulated withdrawal.", "properties": { "status": { "type": ["string", "null"], "description": "What a withdrawal would do today: `instant` all of it leaves now, `queued` accepted but paid later, `partial` bounded by `exit_liquidity`, `depleted` the lane is dust (under 0.1% of TVL and under $10k), `unavailable` nothing was accepted, `blocked` reverted as paused or unrecognized. Null when unclassified.", "enum": ["instant", "queued", "partial", "depleted", "unavailable", "blocked", null], "example": "instant" }, "eta_seconds": { "type": ["number", "null"], "description": "Wait before a queued withdrawal can be claimed. Only set while `status` is `queued`.", "example": null }, "fee_bps": { "type": ["number", "null"], "description": "Exit fee in basis points. When the protocol discloses a structured fee, this is that fee, observed with `price_per_share` on `tvl.as_of`; otherwise the median discount against the reported rate over the last 30 discount observations. Null when unknown, never a claimed zero.", "example": 0 }, "as_of": { "type": ["string", "null"], "description": "Timestamp of the exit observation", "example": "2026-09-14T09:19:11.000Z" }, "fee_flat": { "type": "string", "description": "Flat exit fee in raw base units of `denomination`, as a decimal string; parse with BigInt, not Number. Present only when the protocol discloses a structured fee, observed with `price_per_share` on `tvl.as_of`. Estimated proceeds: max(0, balance × price_per_share × (1 − fee_bps / 1e4) − fee_flat / 10^denomination.decimals), subject to rounding and later fee changes.", "example": "0" } } }, "exit_liquidity": { "type": "object", "description": "Funded exit capacity, not backing inventory; for queued pools this is the on-chain funding buffer, not instant liquidity. Null means no on-chain capacity is exposed, not zero.", "properties": { "amount": { "type": ["string", "null"], "description": "Raw base units of `denomination`, as a decimal string; parse with BigInt, not Number.", "example": "302770028148448411826143" }, "usd": { "type": ["number", "null"], "description": "Capacity in USD. Null when `denomination` is, since the conversion needs its decimals.", "example": 749593682.56 }, "slippage_bps": { "type": ["number", "null"], "description": "Price impact of the simulated exit, in basis points", "example": 0 }, "as_of": { "type": ["string", "null"], "description": "Day (UTC) the capacity was measured", "example": "2026-09-14" } } }, "tvl": { "type": "object", "description": "Receipt supply priced at the rate an exit actually paid, not the reported figure.", "properties": { "amount": { "type": ["string", "null"], "description": "Receipt supply at the executed redemption rate. Raw base units of `denomination`, as a decimal string; parse with BigInt, not Number.", "example": "2120826166919814406207431" }, "usd": { "type": ["number", "null"], "description": "Verified TVL in USD. Null when `denomination` is.", "example": 5250710931.5 }, "as_of": { "type": ["string", "null"], "description": "Day (UTC) the TVL was measured", "example": "2026-09-14" } } }, "price_per_share": { "type": ["number", "null"], "description": "Underlying assets per position token, in human units. For rebasing tokens (aTokens, stETH) this is per internal share, so read it as a series normalized to its first point, not as an absolute.", "example": 1.0706808832358203 }, "denomination": { "type": ["object", "null"], "description": "Asset an exit pays out, and the decimals its raw amounts use. Null when it could not be pinned; the USD fields go null with it, and you must not assume 18.", "properties": { "address": { "type": "string", "description": "Payout token address", "example": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2" }, "decimals": { "type": ["integer", "null"], "description": "Decimals of the payout token", "example": 18 } } } } } } } } } } }, "400": { "description": "Unknown query parameter or invalid value", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_QUERY_PARAM" }, "message": { "type": "string", "example": "unknown query parameter: chain" } } } } } } } } } } }, "/yields/v2/earn/verified/{id}": { "get": { "tags": ["yields"], "x-api-plan-only": true, "summary": "Retrieve the latest verified data for one earn pool", "description": "The same row `/yields/v2/earn/verified` serves for this pool, plus `methods`: the on-chain calls the simulation executes, in order.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Earn pool id (UUID)", "schema": { "type": "string", "example": "e880e828-ca59-4ec6-8d4f-27182a4dc23d" } } ], "responses": { "200": { "description": "Verified data for the pool", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Pool id (UUID); joins to `/yields/v2/earn`", "example": "e880e828-ca59-4ec6-8d4f-27182a4dc23d" }, "apy": { "type": "object", "description": "Measured base APY in percent. Base only, since a withdrawal cannot see reward emissions, and unclamped, so it can be negative. All three windows end at `apy_as_of`.", "properties": { "avg_1d": { "type": ["number", "null"], "description": "Trailing 1-day average", "example": 1.45698 }, "avg_7d": { "type": ["number", "null"], "description": "Trailing 7-day average", "example": 1.44895 }, "avg_30d": { "type": ["number", "null"], "description": "Trailing 30-day average", "example": 1.47156 } } }, "apy_as_of": { "type": ["string", "null"], "description": "Timestamp the APY windows end at", "example": "2026-09-14T09:19:11.000Z" }, "apy_note": { "type": ["string", "null"], "description": "Why the APY is absent or qualified. Show it wherever the APY renders blank; null for most pools.", "example": null }, "apy_confidence": { "type": ["string", "null"], "description": "How closely independent holders agreed on the redemption rate. Grades the measurement, not the pool.", "enum": ["high", "medium", "low", "conflict", null], "example": "high" }, "exit": { "type": "object", "description": "Exit health from the most recent simulated withdrawal.", "properties": { "status": { "type": ["string", "null"], "description": "What a withdrawal would do today: `instant` all of it leaves now, `queued` accepted but paid later, `partial` bounded by `exit_liquidity`, `depleted` the lane is dust (under 0.1% of TVL and under $10k), `unavailable` nothing was accepted, `blocked` reverted as paused or unrecognized. Null when unclassified.", "enum": ["instant", "queued", "partial", "depleted", "unavailable", "blocked", null], "example": "instant" }, "eta_seconds": { "type": ["number", "null"], "description": "Wait before a queued withdrawal can be claimed. Only set while `status` is `queued`.", "example": null }, "fee_bps": { "type": ["number", "null"], "description": "Exit fee in basis points. When the protocol discloses a structured fee, this is that fee, observed with `price_per_share` on `tvl.as_of`; otherwise the median discount against the reported rate over the last 30 discount observations. Null when unknown, never a claimed zero.", "example": 0 }, "as_of": { "type": ["string", "null"], "description": "Timestamp of the exit observation", "example": "2026-09-14T09:19:11.000Z" }, "fee_flat": { "type": "string", "description": "Flat exit fee in raw base units of `denomination`, as a decimal string; parse with BigInt, not Number. Present only when the protocol discloses a structured fee, observed with `price_per_share` on `tvl.as_of`. Estimated proceeds: max(0, balance × price_per_share × (1 − fee_bps / 1e4) − fee_flat / 10^denomination.decimals), subject to rounding and later fee changes.", "example": "0" } } }, "exit_liquidity": { "type": "object", "description": "Funded exit capacity, not backing inventory; for queued pools this is the on-chain funding buffer, not instant liquidity. Null means no on-chain capacity is exposed, not zero.", "properties": { "amount": { "type": ["string", "null"], "description": "Raw base units of `denomination`, as a decimal string; parse with BigInt, not Number.", "example": "302770028148448411826143" }, "usd": { "type": ["number", "null"], "description": "Capacity in USD. Null when `denomination` is, since the conversion needs its decimals.", "example": 749593682.56 }, "slippage_bps": { "type": ["number", "null"], "description": "Price impact of the simulated exit, in basis points", "example": 0 }, "as_of": { "type": ["string", "null"], "description": "Day (UTC) the capacity was measured", "example": "2026-09-14" } } }, "tvl": { "type": "object", "description": "Receipt supply priced at the rate an exit actually paid, not the reported figure.", "properties": { "amount": { "type": ["string", "null"], "description": "Receipt supply at the executed redemption rate. Raw base units of `denomination`, as a decimal string; parse with BigInt, not Number.", "example": "2120826166919814406207431" }, "usd": { "type": ["number", "null"], "description": "Verified TVL in USD. Null when `denomination` is.", "example": 5250710931.5 }, "as_of": { "type": ["string", "null"], "description": "Day (UTC) the TVL was measured", "example": "2026-09-14" } } }, "price_per_share": { "type": ["number", "null"], "description": "Underlying assets per position token, in human units. For rebasing tokens (aTokens, stETH) this is per internal share, so read it as a series normalized to its first point, not as an absolute.", "example": 1.0706808832358203 }, "denomination": { "type": ["object", "null"], "description": "Asset an exit pays out, and the decimals its raw amounts use. Null when it could not be pinned; the USD fields go null with it, and you must not assume 18.", "properties": { "address": { "type": "string", "description": "Payout token address", "example": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2" }, "decimals": { "type": ["integer", "null"], "description": "Decimals of the payout token", "example": 18 } } }, "methods": { "type": ["array", "null"], "description": "On-chain calls the simulation executes, in order. Null when not recorded.", "items": { "type": "string", "example": "Pool.withdraw(underlying, type(uint256).max, holder) — EXECUTED as the holder; returns underlying actually received" } } } } } } } } }, "400": { "description": "Unknown query parameter or invalid value", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_QUERY_PARAM" }, "message": { "type": "string", "example": "unknown query parameter: range" } } } } } } } }, "404": { "description": "No verified pool with this id", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "example": "VERIFIED_POOL_NOT_FOUND" }, "message": { "type": "string", "example": "verified pool not found" } } } } } } } } } } }, "/yields/v2/earn/verified/{id}/history": { "get": { "tags": ["yields"], "x-api-plan-only": true, "summary": "Retrieve daily verified history for an earn pool", "description": "Daily measured APY, share price, verified TVL and exit health for one pool, oldest first. APY carries `avg_1d` (that day), `avg_7d` and `avg_30d` (trailing averages ending that day). Days the pool was not measured are omitted, so the dates are not contiguous. Every `range` is sliced from the same cached series.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Earn pool id (UUID)", "schema": { "type": "string", "example": "e880e828-ca59-4ec6-8d4f-27182a4dc23d" } }, { "name": "range", "in": "query", "required": false, "description": "History window; defaults to max (the full series)", "schema": { "type": "string", "enum": ["30d", "90d", "max"], "example": "90d" } } ], "responses": { "200": { "description": "Daily verified history rows, oldest first", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "Day (UTC)", "example": "2026-09-14" }, "outcome": { "type": ["string", "null"], "description": "Raw measurement outcome for that day, the uninterpreted form of `exit.status`. The `reverted_*` values are days a real withdrawal would have failed.", "enum": [ "ok_full", "ok_partial", "delayed", "no_exit_primary", "reverted_liquidity", "reverted_paused", "reverted_unknown", "error_rpc", null ], "example": "ok_full" }, "eta_seconds": { "type": ["number", "null"], "description": "Wait before that day's queued withdrawal could be claimed. Only set when `outcome` is `delayed`.", "example": null }, "confidence": { "type": ["string", "null"], "description": "Holder-consensus confidence in that day's measurement", "enum": ["high", "medium", "low", "conflict", null], "example": "high" }, "apy": { "type": "object", "description": "Measured base APY in percent. Base only, since a withdrawal cannot see reward emissions, and unclamped, so it can be negative.", "properties": { "avg_1d": { "type": ["number", "null"], "description": "Average over that day", "example": 1.45698 }, "avg_7d": { "type": ["number", "null"], "description": "Trailing 7-day average ending that day", "example": 1.44895 }, "avg_30d": { "type": ["number", "null"], "description": "Trailing 30-day average ending that day", "example": 1.47156 } } }, "price_per_share": { "type": ["number", "null"], "description": "Underlying assets per position token, in human units. For rebasing tokens (aTokens, stETH) this is per internal share, so read it as a series normalized to its first point, not as an absolute.", "example": 1.0706808832358203 }, "price_per_share_quoted": { "type": ["number", "null"], "description": "The pool's reported price, for days the executed exit could not price one. A quote, not a measurement, so mark it differently in a chart. Null unless corroborated.", "example": 1.0706808832358203 }, "reason": { "type": ["string", "null"], "description": "Why `price_per_share` is null on a day that was otherwise measured; null when it is present.", "enum": ["rate_quality_floor", "nav_quote_no_exit_path", "no_executed_exit_path", null], "example": null }, "exit_liquidity": { "type": "object", "description": "Funded exit capacity, not backing inventory; for queued pools this is the on-chain funding buffer, not instant liquidity. Null means no on-chain capacity is exposed, not zero.", "properties": { "amount": { "type": ["string", "null"], "description": "Raw base units of `denomination`, as a decimal string; parse with BigInt, not Number.", "example": "302770028148448411826143" }, "usd": { "type": ["number", "null"], "description": "Capacity in USD. Null when `denomination` is, since the conversion needs its decimals.", "example": 749593682.56 }, "slippage_bps": { "type": ["number", "null"], "description": "Price impact of the simulated exit, in basis points", "example": 0 } } }, "tvl": { "type": "object", "description": "Receipt supply priced at the rate an exit actually paid, not the reported figure.", "properties": { "amount": { "type": ["string", "null"], "description": "Receipt supply at the executed redemption rate. Raw base units of `denomination`, as a decimal string; parse with BigInt, not Number.", "example": "2120826166919814406207431" }, "usd": { "type": ["number", "null"], "description": "Verified TVL in USD. Null when `denomination` is.", "example": 5250710931.5 } } }, "tvl_quoted": { "type": "object", "description": "Supply valued at the reported rate, for the days `tvl` is null. A valuation, not an exit measure.", "properties": { "amount": { "type": ["string", "null"], "description": "Raw base units of `denomination`, as a decimal string; parse with BigInt, not Number.", "example": "2120826166919814406207431" }, "usd": { "type": ["number", "null"], "description": "Quoted valuation in USD", "example": 5250710931.5 } } } } } } } } } } }, "400": { "description": "Unknown query parameter or invalid value", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_QUERY_PARAM" }, "message": { "type": "string", "example": "range must be one of: 30d, 90d, max" } } } } } } } }, "404": { "description": "No verified pool with this id", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "example": "VERIFIED_POOL_NOT_FOUND" }, "message": { "type": "string", "example": "verified pool not found" } } } } } } } } } } }, "/yields/v2/borrow/markets": { "get": { "tags": ["yields"], "x-api-plan-only": true, "summary": "Retrieve the latest data for all borrow markets", "description": "One row per borrow market: collateral and debt token, maximum loan-to-value, USD supply/borrow totals and attributed APY for both sides over `current`, `avg_7d` and `avg_30d` windows. Reward emissions offset borrowing costs, so `borrow_cost_apy` totals can be negative (the borrower is net paid).", "responses": { "200": { "description": "Array of all borrow markets", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Market id (UUID)", "example": "e880e828-ca59-4ec6-8d4f-27182a4dc23d" }, "pool_key": { "type": "string", "description": "Stable market key.", "example": "0x4d5f47fa6a74757f35c14fd3a6ef8e3c9bc514e8-ethereum" }, "pool_token": { "type": ["object", "null"], "description": "Receipt / vault token representing the position; null when the market has no transferable pool token", "properties": { "address": { "type": "string", "example": "0x4d5f47fa6a74757f35c14fd3a6ef8e3c9bc514e8" }, "symbol": { "type": ["string", "null"], "example": "aEthWETH" }, "name": { "type": ["string", "null"], "example": "Aave Ethereum WETH" } } }, "display": { "type": "object", "description": "Display strings for listings", "properties": { "label": { "type": ["string", "null"], "description": "Collateral symbol, or \"COLLATERAL / DEBT\" for isolated pairs", "example": "WETH" }, "detail": { "type": ["string", "null"], "example": null } } }, "url": { "type": ["string", "null"], "description": "Market page on the protocol app", "example": "https://app.aave.com/reserve-overview/?underlyingAsset=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2&marketName=proto_mainnet_v3" }, "protocol": { "type": "string", "description": "Protocol display name", "example": "Aave V3" }, "chain": { "type": "string", "description": "Chain display name", "example": "Ethereum" }, "collateral_token": { "type": "object", "description": "Token supplied as collateral; null when unknown", "properties": { "address": { "type": "string", "example": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2" }, "symbol": { "type": ["string", "null"], "example": "WETH" }, "decimals": { "type": ["integer", "null"], "example": 18 } } }, "borrow_token": { "type": "object", "description": "Token borrowed from the market; null when unknown", "properties": { "address": { "type": "string", "example": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2" }, "symbol": { "type": ["string", "null"], "example": "WETH" }, "decimals": { "type": ["integer", "null"], "example": 18 } } }, "reward_tokens": { "type": "array", "description": "Incentive tokens currently emitted to the market; empty when there are none", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "0xd533a949740bb3306d119cc777fa900ba034cd52" }, "symbol": { "type": ["string", "null"], "example": "CRV" }, "decimals": { "type": ["integer", "null"], "example": 18 } } } }, "loan_to_value": { "type": ["number", "null"], "description": "Maximum loan-to-value as a fraction (0.805 = 80.5%)", "example": 0.805 }, "total_supply_usd": { "type": ["number", "null"], "description": "Total supplied to the market, in USD", "example": 3683494475 }, "total_borrow_usd": { "type": ["number", "null"], "description": "Total borrowed from the market, in USD", "example": 3022727877 }, "available_borrow_usd": { "type": ["number", "null"], "description": "Liquidity still available to borrow, in USD", "example": 568755149 }, "supply_apy": { "type": "object", "description": "APY in percent earned by suppliers", "properties": { "current": { "type": "object", "description": "Latest observed values", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 1.49954 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 1.49954 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 1.46669 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 1.46669 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 1.40929 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 1.40929 } } } } }, "borrow_cost_apy": { "type": "object", "description": "APY in percent paid by borrowers. Reward emissions reduce the cost, so total = base - reward and can be negative", "properties": { "current": { "type": "object", "description": "Latest observed values", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.14984 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base minus reward, in percent; negative means the borrower is net paid", "example": 2.14984 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.12582 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base minus reward, in percent; negative means the borrower is net paid", "example": 2.12582 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.08412 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base minus reward, in percent; negative means the borrower is net paid", "example": 2.08412 } } } } }, "intrinsic": { "type": "object", "description": "Intrinsic yield of yield-bearing tokens on either side of the market", "properties": { "supply": { "type": ["object", "null"], "description": "Intrinsic yield of the supply-side token. Intrinsic yield is reported separately and is NOT included in the base/reward/total APY. Null when there is no intrinsic yield source.", "properties": { "apy": { "type": "object", "description": "Intrinsic APY in percent", "properties": { "current": { "type": "object", "description": "Latest observed value", "properties": { "base": { "type": ["number", "null"], "example": 3.11 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.05 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.02 } } } } }, "source_pool": { "type": "object", "properties": { "id": { "type": "string", "description": "Earn pool the intrinsic yield is sourced from", "example": "747c1d2a-c668-4682-b9f9-296708a3dd90" }, "pool_token": { "type": "string", "description": "Address of the yield-bearing token", "example": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84" }, "symbol": { "type": ["string", "null"], "example": "stETH" } } } } }, "borrow": { "type": ["object", "null"], "description": "Intrinsic yield of the borrowed token. Borrowing a yield-bearing token adds this rate to the effective borrow cost, since the debt appreciates by it. Intrinsic yield is reported separately and is NOT included in the base/reward/total APY. Null when there is no intrinsic yield source.", "properties": { "apy": { "type": "object", "description": "Intrinsic APY in percent", "properties": { "current": { "type": "object", "description": "Latest observed value", "properties": { "base": { "type": ["number", "null"], "example": 3.11 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.05 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.02 } } } } }, "source_pool": { "type": "object", "properties": { "id": { "type": "string", "description": "Earn pool the intrinsic yield is sourced from", "example": "747c1d2a-c668-4682-b9f9-296708a3dd90" }, "pool_token": { "type": "string", "description": "Address of the yield-bearing token", "example": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84" }, "symbol": { "type": ["string", "null"], "example": "stETH" } } } } } } } } } } } } } } } } } }, "/yields/v2/borrow/markets/{id}/history": { "get": { "tags": ["yields"], "x-api-plan-only": true, "summary": "Retrieve daily borrow-side history for a borrow market", "description": "Daily borrow totals and borrow-cost APY for one market, oldest first. APY carries `avg_1d` (that day), `avg_7d` and `avg_30d` (trailing averages ending that day) windows, each attributed into base/reward/total. Supply-side history for the same id lives at `/yields/v2/earn/{id}/history`.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Borrow market id (UUID)", "schema": { "type": "string", "example": "e880e828-ca59-4ec6-8d4f-27182a4dc23d" } }, { "name": "range", "in": "query", "required": false, "description": "History window; defaults to max (the full series)", "schema": { "type": "string", "enum": ["30d", "90d", "max"], "example": "90d" } } ], "responses": { "200": { "description": "Daily history rows, oldest first", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "Day (UTC)", "example": "2026-08-10" }, "total_borrow_usd": { "type": ["number", "null"], "description": "Total borrowed from the market, in USD", "example": 3339035741 }, "available_borrow_usd": { "type": ["number", "null"], "description": "Liquidity still available to borrow, in USD", "example": 733495225 }, "borrow_cost_apy": { "type": "object", "description": "APY in percent paid by borrowers. Reward emissions reduce the cost, so total = base - reward and can be negative", "properties": { "avg_1d": { "type": "object", "description": "Average over that day", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.09904 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base minus reward, in percent; negative means the borrower is net paid", "example": 2.09904 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.10884 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base minus reward, in percent; negative means the borrower is net paid", "example": 2.10884 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.09608 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base minus reward, in percent; negative means the borrower is net paid", "example": 2.09608 } } } } }, "intrinsic": { "type": ["object", "null"], "description": "Intrinsic yield of the borrowed token. Borrowing a yield-bearing token adds this rate to the effective borrow cost, since the debt appreciates by it. Intrinsic yield is reported separately and is NOT included in the base/reward/total APY. Null when there is no intrinsic yield source.", "properties": { "apy": { "type": "object", "description": "Intrinsic APY in percent", "properties": { "avg_1d": { "type": "object", "description": "Average over that day", "properties": { "base": { "type": ["number", "null"], "example": 2.76481 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.97675 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "example": 4.99742 } } } } } } } } } } } } } } }, "404": { "description": "No borrow market with this id", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "example": "BORROW_MARKET_NOT_FOUND" }, "message": { "type": "string", "example": "borrow market not found" } } } } } } } } } } }, "/yields/v2/borrow/routes": { "get": { "tags": ["yields"], "x-api-plan-only": true, "summary": "Retrieve the latest data for all borrow routes", "description": "Every supported borrowing route: a collateral position paired with a debt market on the same protocol and chain. Each row reports the collateral side (supply APY earned on the collateral), the borrow side (cost APY of the debt token) and `net_apy` (collateral yield minus borrow cost). Negative net APY means the position costs more than the collateral earns.", "responses": { "200": { "description": "Array of all borrow routes", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "object", "description": "Display strings for listings", "properties": { "detail": { "type": ["string", "null"], "description": "Market variant label; null when there is only one market", "example": "Prime Instance" } } }, "protocol": { "type": "string", "description": "Protocol display name", "example": "Aave V3" }, "chain": { "type": "string", "description": "Chain display name", "example": "Ethereum" }, "collateral": { "type": "object", "description": "The supplied collateral position", "properties": { "id": { "type": "string", "description": "Collateral pool id (UUID)", "example": "ef8c5c38-6a41-4383-9dc8-6fb31e69a0c9" }, "pool_key": { "type": "string", "description": "Stable pool key of the collateral pool", "example": "0xfa1fdbbd71b0aa16162d76914d69cd8cb3ef92da-lido" }, "url": { "type": ["string", "null"], "example": "https://app.aave.com/reserve-overview/?underlyingAsset=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2&marketName=proto_lido_v3" }, "token": { "type": "object", "description": "Token supplied as collateral", "properties": { "address": { "type": "string", "example": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2" }, "symbol": { "type": ["string", "null"], "example": "WETH" }, "decimals": { "type": ["integer", "null"], "example": 18 } } }, "loan_to_value": { "type": ["number", "null"], "description": "Maximum loan-to-value as a fraction (0.84 = 84%)", "example": 0.84 }, "total_supply_usd": { "type": ["number", "null"], "description": "Total supplied to the collateral pool, in USD", "example": 35187139 }, "apy": { "type": "object", "description": "Supply APY in percent earned on the collateral", "properties": { "current": { "type": "object", "description": "Latest observed values", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 1.56065 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 1.56065 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 1.48621 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 1.48621 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 1.46718 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 1.46718 } } } } }, "intrinsic": { "type": ["object", "null"], "description": "Intrinsic yield of the collateral token. Intrinsic yield is reported separately and is NOT included in the base/reward/total APY. Null when there is no intrinsic yield source.", "properties": { "apy": { "type": "object", "description": "Intrinsic APY in percent", "properties": { "current": { "type": "object", "description": "Latest observed value", "properties": { "base": { "type": ["number", "null"], "example": 3.11 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.05 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.02 } } } } }, "source_pool": { "type": "object", "properties": { "id": { "type": "string", "description": "Earn pool the intrinsic yield is sourced from", "example": "747c1d2a-c668-4682-b9f9-296708a3dd90" }, "pool_token": { "type": "string", "description": "Address of the yield-bearing token", "example": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84" }, "symbol": { "type": ["string", "null"], "example": "stETH" } } } } }, "reward_tokens": { "type": "array", "description": "Incentive tokens emitted to the collateral side; empty when there are none", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "0xd533a949740bb3306d119cc777fa900ba034cd52" }, "symbol": { "type": ["string", "null"], "example": "CRV" }, "decimals": { "type": ["integer", "null"], "example": 18 } } } } } }, "borrow": { "type": "object", "description": "The borrowed debt position", "properties": { "id": { "type": "string", "description": "Debt market id (UUID)", "example": "effcb4a4-4dcb-45e5-935d-f15542c13e6b" }, "pool_key": { "type": "string", "description": "Stable pool key of the debt market", "example": "0x2a1fbcb52ed4d9b23dad17e1e8aed4bb0e6079b8-lido" }, "url": { "type": ["string", "null"], "example": "https://app.aave.com/reserve-overview/?underlyingAsset=0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48&marketName=proto_lido_v3" }, "token": { "type": "object", "description": "Token borrowed", "properties": { "address": { "type": "string", "example": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48" }, "symbol": { "type": ["string", "null"], "example": "USDC" }, "decimals": { "type": ["integer", "null"], "example": 6 } } }, "total_borrow_usd": { "type": ["number", "null"], "description": "Total borrowed from the market, in USD", "example": 3377912 }, "available_borrow_usd": { "type": ["number", "null"], "description": "Liquidity still available to borrow, in USD", "example": 1838568 }, "cost_apy": { "type": "object", "description": "Borrow cost APY in percent. Reward emissions reduce the cost, so total = base - reward and can be negative", "properties": { "current": { "type": "object", "description": "Latest observed values", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 3.8712 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base minus reward, in percent; negative means the borrower is net paid", "example": 3.8712 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 3.895 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base minus reward, in percent; negative means the borrower is net paid", "example": 3.895 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 3.89527 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base minus reward, in percent; negative means the borrower is net paid", "example": 3.89527 } } } } }, "intrinsic": { "type": ["object", "null"], "description": "Intrinsic yield of the borrowed token. Borrowing a yield-bearing token adds this rate to the effective borrow cost, since the debt appreciates by it. Intrinsic yield is reported separately and is NOT included in the base/reward/total APY. Null when there is no intrinsic yield source.", "properties": { "apy": { "type": "object", "description": "Intrinsic APY in percent", "properties": { "current": { "type": "object", "description": "Latest observed value", "properties": { "base": { "type": ["number", "null"], "example": 3.11 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.05 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.02 } } } } }, "source_pool": { "type": "object", "properties": { "id": { "type": "string", "description": "Earn pool the intrinsic yield is sourced from", "example": "747c1d2a-c668-4682-b9f9-296708a3dd90" }, "pool_token": { "type": "string", "description": "Address of the yield-bearing token", "example": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84" }, "symbol": { "type": ["string", "null"], "example": "stETH" } } } } }, "reward_tokens": { "type": "array", "description": "Incentive tokens emitted to the borrow side; empty when there are none", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "0xd533a949740bb3306d119cc777fa900ba034cd52" }, "symbol": { "type": ["string", "null"], "example": "CRV" }, "decimals": { "type": ["integer", "null"], "example": 18 } } } } } }, "net_apy": { "type": "object", "description": "Net APY in percent: collateral supply APY minus borrow cost. Keyed by APY composition: read the leaf matching the APY components you consume (base, base + reward, base + intrinsic, base + reward + intrinsic).", "properties": { "current": { "type": "object", "description": "Latest observed values", "properties": { "base": { "type": ["number", "null"], "example": -2.31055 }, "base_reward": { "type": ["number", "null"], "example": -2.31055 }, "base_intrinsic": { "type": ["number", "null"], "example": -2.31055 }, "base_reward_intrinsic": { "type": ["number", "null"], "example": -2.31055 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "example": -2.40879 }, "base_reward": { "type": ["number", "null"], "example": -2.40879 }, "base_intrinsic": { "type": ["number", "null"], "example": -2.40879 }, "base_reward_intrinsic": { "type": ["number", "null"], "example": -2.40879 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "example": -2.42809 }, "base_reward": { "type": ["number", "null"], "example": -2.42809 }, "base_intrinsic": { "type": ["number", "null"], "example": -2.42809 }, "base_reward_intrinsic": { "type": ["number", "null"], "example": -2.42809 } } } } } } } } } } } } } } } }, "/yields/v2/loops": { "get": { "tags": ["yields"], "x-api-plan-only": true, "summary": "Retrieve the latest data for all loop strategies", "description": "Leveraged looping opportunities: supply a token, borrow against it and re-supply, repeated `loop_count` times at the market maximum loan-to-value. `loop_apy.total` is the resulting net APY at that leverage; `leverage` reports the accumulated supply and borrow multipliers relative to the initial capital. Borrow reward emissions offset the borrowing cost, so looped APY can exceed the plain supply APY substantially.", "responses": { "200": { "description": "Array of all loop strategies", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Collateral pool id (UUID)", "example": "f2e554c5-2099-46cf-9fa6-918fb41a3297" }, "display": { "type": "object", "description": "Display strings for listings", "properties": { "detail": { "type": ["string", "null"], "description": "Market variant label; null when there is only one market", "example": null } } }, "protocol": { "type": "string", "description": "Protocol display name", "example": "Scallop Lend" }, "chain": { "type": "string", "description": "Chain display name", "example": "Sui" }, "token": { "type": "object", "description": "Token being looped (supplied and borrowed)", "properties": { "address": { "type": "string", "example": "0x0041f9f9344cac094454cd574e333c4fdb132d7bcc9379bcd4aab485b2a63942::wbtc::wbtc" }, "symbol": { "type": ["string", "null"], "example": "WBTC" }, "decimals": { "type": ["integer", "null"], "example": 8 } } }, "url": { "type": ["string", "null"], "description": "Market page on the protocol app", "example": "https://app.scallop.io/" }, "loan_to_value": { "type": ["number", "null"], "description": "Maximum loan-to-value as a fraction (0.7 = 70%)", "example": 0.7 }, "total_supply_usd": { "type": ["number", "null"], "description": "Total supplied to the market, in USD", "example": 99384 }, "total_borrow_usd": { "type": ["number", "null"], "description": "Total borrowed from the market, in USD", "example": 40704 }, "available_borrow_usd": { "type": ["number", "null"], "description": "Liquidity still available to borrow, in USD", "example": 58680 }, "supply_apy": { "type": "object", "description": "Unlevered supply APY in percent", "properties": { "current": { "type": "object", "description": "Latest observed values", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.50779 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 2.50779 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.38329 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 2.38329 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 2.35421 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": null }, "total": { "type": ["number", "null"], "description": "base plus reward, in percent", "example": 2.35421 } } } } }, "borrow_cost_apy": { "type": "object", "description": "Borrow cost APY in percent. Reward emissions reduce the cost, so total = base - reward and can be negative", "properties": { "current": { "type": "object", "description": "Latest observed values", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 7.852 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": 21.73055 }, "total": { "type": ["number", "null"], "description": "base minus reward, in percent; negative means the borrower is net paid", "example": -13.87855 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 7.74822 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": 38.54927 }, "total": { "type": ["number", "null"], "description": "base minus reward, in percent; negative means the borrower is net paid", "example": -30.80105 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "description": "Organic APY in percent, excluding incentive rewards", "example": 7.70641 }, "reward": { "type": ["number", "null"], "description": "APY in percent from incentive token emissions; null when there are none", "example": 25.32701 }, "total": { "type": ["number", "null"], "description": "base minus reward, in percent; negative means the borrower is net paid", "example": -17.6206 } } } } }, "loop_apy": { "type": "object", "description": "Looped position APY", "properties": { "loop_count": { "type": ["number", "null"], "description": "Number of borrow/re-supply iterations", "example": 5 }, "total": { "type": ["number", "null"], "description": "Net APY in percent of the looped position at loop_count iterations", "example": 34.31646 } } }, "leverage": { "type": "object", "description": "Accumulated leverage after loop_count iterations", "properties": { "supply_multiplier": { "type": ["number", "null"], "description": "Total supplied relative to initial capital", "example": 2.94117 }, "borrow_multiplier": { "type": ["number", "null"], "description": "Total borrowed relative to initial capital", "example": 1.94117 } } }, "intrinsic": { "type": ["object", "null"], "description": "Intrinsic yield of the looped token. Intrinsic yield is reported separately and is NOT included in the base/reward/total APY. Null when there is no intrinsic yield source.", "properties": { "apy": { "type": "object", "description": "Intrinsic APY in percent", "properties": { "current": { "type": "object", "description": "Latest observed value", "properties": { "base": { "type": ["number", "null"], "example": 3.11 } } }, "avg_7d": { "type": "object", "description": "Trailing 7-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.05 } } }, "avg_30d": { "type": "object", "description": "Trailing 30-day average", "properties": { "base": { "type": ["number", "null"], "example": 3.02 } } } } }, "source_pool": { "type": "object", "properties": { "id": { "type": "string", "description": "Earn pool the intrinsic yield is sourced from", "example": "747c1d2a-c668-4682-b9f9-296708a3dd90" }, "pool_token": { "type": "string", "description": "Address of the yield-bearing token", "example": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84" }, "symbol": { "type": ["string", "null"], "example": "stETH" } } } } }, "reward_tokens": { "type": "object", "description": "Incentive tokens per market side; empty arrays when there are none", "properties": { "supply": { "type": "array", "description": "Incentive tokens emitted to the supply side", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "0x5ca17430c1d046fae9edeaa8fd76c7b4193a00d764a0ecfa9418d733ad27bc1e::scallop_sca::scallop_sca" }, "symbol": { "type": ["string", "null"], "example": "sSCA" }, "decimals": { "type": ["integer", "null"], "example": 9 } } } }, "borrow": { "type": "array", "description": "Incentive tokens emitted to the borrow side", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "0x5ca17430c1d046fae9edeaa8fd76c7b4193a00d764a0ecfa9418d733ad27bc1e::scallop_sca::scallop_sca" }, "symbol": { "type": ["string", "null"], "example": "sSCA" }, "decimals": { "type": ["integer", "null"], "example": 9 } } } } } } } } } } } } } } } } }, "/api/perpFundingRates": { "get": { "tags": ["yields"], "summary": "Funding rates and open interest of perpetual futures", "description": "Latest funding rate, open interest and index price for Binance and OKX perpetual markets, with the 7d and 30d average and sum of settled funding rates.", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "object", "properties": { "perp_id": { "type": "string", "example": "61533906-1626-45fc-b3ed-9a1103705373" }, "timestamp": { "type": "string", "example": "2025-07-18T18:01:44.811Z" }, "marketplace": { "type": "string", "example": "Binance" }, "market": { "type": "string", "example": "1000000BOBUSDT" }, "baseAsset": { "type": "string", "example": "1000000BOT" }, "fundingRate": { "type": "number", "example": 0.00005 }, "fundingRatePrevious": { "type": "number", "example": 0.00045224 }, "fundingTimePrevious": { "type": "number", "example": 1752854400000 }, "openInterest": { "type": "number", "example": 51144394 }, "indexPrice": { "type": "number", "example": 0.05108 }, "fundingRate7dAverage": { "type": ["number", "null"], "example": null }, "fundingRate7dSum": { "type": ["number", "null"], "example": null }, "fundingRate30dAverage": { "type": ["number", "null"], "example": null }, "fundingRate30dSum": { "type": ["number", "null"], "example": null } } } } } } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.yields.getPerpFundingRates()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.yields.getPerpFundingRates()" } ] } }, "/api/lstRates": { "get": { "tags": ["yields"], "summary": "Exchange rates and ETH peg of liquid staking tokens", "description": "Latest expected (contract) redemption rate, executable market rate and resulting ETH peg for major LSTs.", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the protocol issuing the LST" }, "symbol": { "type": "string", "nullable": true, "description": "The symbol of the LST" }, "address": { "type": "string", "description": "The contract address of the LST" }, "type": { "type": "string", "nullable": true, "description": "The type of the LST (rebase or accruing)" }, "expectedRate": { "type": "number", "nullable": true, "description": "ETH per token owed by the protocol, read from its contract" }, "marketRate": { "type": "number", "nullable": true, "description": "Executable market rate in ETH per token; null when no credible market quote exists" }, "ethPeg": { "type": "number", "nullable": true, "description": "Percent deviation of the market rate from the expected rate" }, "fee": { "type": "number", "nullable": true, "description": "The protocol fee percentage" } } } }, "example": [ { "name": "Lido", "symbol": "stETH", "address": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84", "type": "rebase", "expectedRate": 1, "marketRate": 0.9997, "ethPeg": -0.03, "fee": 0.1 }, { "name": "StakeWise V3", "symbol": "osETH", "address": "0xf1C9acDc66974dFB6dEcB12aA385b9cD01190E38", "type": "accruing", "expectedRate": 1.0775, "marketRate": 1.0615, "ethPeg": -1.48, "fee": 0.05 }, { "name": "Bifrost Liquid Staking", "symbol": "vETH", "address": "0x4Bc3263Eb5bb2Ef7Ad9aB6FB68be80E43b43801F", "type": "accruing", "expectedRate": 1.1353, "marketRate": null, "ethPeg": null, "fee": null } ] } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.yields.getLstRates()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.yields.getLstRates()" } ] } }, "/etfs/snapshot": { "get": { "tags": ["ETFs"], "summary": "Get ETFs and their metrics (aum, flows, fees...)", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string", "description": "ETF ticker symbol" }, "timestamp": { "type": "integer", "description": "Current timestamp" }, "asset": { "type": "string", "description": "Asset name" }, "issuer": { "type": "string", "description": "ETF issuer name" }, "etf_name": { "type": "string", "description": "Full ETF name" }, "custodian": { "type": "string", "description": "Custodian name" }, "pct_fee": { "type": "number", "description": "Percentage fee" }, "url": { "type": "string", "description": "ETF URL" }, "flows": { "type": "number", "description": "Net flows" }, "aum": { "type": "number", "description": "Assets under management" }, "volume": { "type": "number", "description": "Trading volume" } } } }, "example": [ { "ticker": "IBIT", "timestamp": 1755612389, "asset": "bitcoin", "issuer": "Blackrock", "etf_name": "iShares Bitcoin Trust", "custodian": "Coinbase", "pct_fee": 0.25, "url": "https://www.blackrock.com/us/individual/products/333011/ishares-bitcoin-trust", "flows": -68700000, "aum": 87276718199, "volume": 453293317.84999996 } ] } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.etfs.getOverview()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.etfs.getOverview()" } ] } }, "/etfs/flows": { "get": { "tags": ["ETFs"], "summary": "Historical Flows at the Asset Level", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "gecko_id": { "type": "string", "description": "CoinGecko ID" }, "day": { "type": "string", "description": "Day" }, "total_flow_usd": { "type": "number", "description": "Sum of all USD flows per asset" } } } }, "example": [ { "gecko_id": "bitcoin", "day": "2024-01-11T00:00:00.000Z", "total_flow_usd": 655300000 } ] } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.etfs.getHistory()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.etfs.getHistory()" } ] } }, "/fdv/performance/{period}": { "get": { "tags": ["narratives"], "summary": "Get chart of narratives based on category performance (with individual coins weighted by mcap)", "parameters": [ { "name": "period", "in": "path", "required": true, "description": "One of ['7', '30', 'ytd', '365']", "schema": { "type": "string", "example": "30" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "integer", "description": "Date timestamp" }, "Analytics": { "type": "number", "description": "Analytics category performance" }, "Artificial Intelligence (AI)": { "type": "number", "description": "AI category performance" }, "Bitcoin": { "type": "number", "description": "Bitcoin category performance" }, "Bridge Governance Tokens": { "type": "number", "description": "Bridge governance tokens category performance" }, "Centralized Exchange (CEX) Token": { "type": "number", "description": "CEX token category performance" }, "Data Availability": { "type": "number", "description": "Data availability category performance" }, "Decentralized Finance (DeFi)": { "type": "number", "description": "DeFi category performance" }, "Decentralized Identifier (DID)": { "type": "number", "description": "DID category performance" }, "DePIN": { "type": "number", "description": "DePIN category performance" }, "Ethereum": { "type": "number", "description": "Ethereum category performance" }, "Gaming (GameFi)": { "type": "number", "description": "Gaming category performance" }, "Liquid Staking Governance Tokens": { "type": "number", "description": "Liquid staking governance tokens category performance" }, "Meme": { "type": "number", "description": "Meme category performance" }, "NFT Marketplace": { "type": "number", "description": "NFT marketplace category performance" }, "Oracle": { "type": "number", "description": "Oracle category performance" }, "PolitiFi": { "type": "number", "description": "PolitiFi category performance" }, "Prediction Markets": { "type": "number", "description": "Prediction markets category performance" }, "Real World Assets (RWA)": { "type": "number", "description": "RWA category performance" }, "Rollup": { "type": "number", "description": "Rollup category performance" }, "Smart Contract Platform": { "type": "number", "description": "Smart contract platform category performance" }, "SocialFi": { "type": "number", "description": "SocialFi category performance" }, "Solana": { "type": "number", "description": "Solana category performance" } } } }, "example": [ { "date": 1751846400, "Analytics": 0, "Artificial Intelligence (AI)": 0, "Bitcoin": 0, "Bridge Governance Tokens": 0, "Centralized Exchange (CEX) Token": 0, "Data Availability": 0, "Decentralized Finance (DeFi)": 0, "Decentralized Identifier (DID)": 0, "DePIN": 0, "Ethereum": 0, "Gaming (GameFi)": 0, "Liquid Staking Governance Tokens": 0, "Meme": 0, "NFT Marketplace": 0, "Oracle": 0, "PolitiFi": 0, "Prediction Markets": 0, "Real World Assets (RWA)": 0, "Rollup": 0, "Smart Contract Platform": 0, "SocialFi": 0, "Solana": 0 } ] } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.etfs.getFdvPerformance('30')" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.etfs.getFdvPerformance('30')" } ] } }, "/bridges/bridges": { "get": { "tags": ["bridges"], "summary": "List all bridges along with summaries of recent bridge volumes.", "parameters": [ { "name": "includeChains", "in": "query", "required": false, "description": "set whether to include current previous day volume breakdown by chain", "schema": { "type": "boolean", "example": true } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "bridges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Bridge ID" }, "name": { "type": "string", "description": "Bridge name" }, "displayName": { "type": "string", "description": "Bridge display name" }, "icon": { "type": "string", "description": "Bridge icon" }, "volumePrevDay": { "type": "number", "description": "Previous day volume" }, "volumePrev2Day": { "type": "number", "description": "Previous 2 days volume" }, "lastHourlyVolume": { "type": "number", "description": "Last hourly volume" }, "last24hVolume": { "type": "number", "description": "Last 24 hours volume" }, "lastDailyVolume": { "type": "number", "description": "Last daily volume" }, "dayBeforeLastVolume": { "type": "number", "description": "Day before last volume" }, "weeklyVolume": { "type": "number", "description": "Weekly volume" }, "monthlyVolume": { "type": "number", "description": "Monthly volume" }, "chains": { "type": "array", "items": { "type": "string" }, "description": "Supported chains" }, "destinationChain": { "type": "string", "description": "Destination chain" }, "url": { "type": "string", "description": "Bridge URL" }, "slug": { "type": "string", "description": "Bridge slug" } } }, "description": "List of bridges" } } }, "example": { "bridges": [ { "id": 80, "name": "hyperliquid", "displayName": "Hyperliquid", "icon": "icons:hyperliquid", "volumePrevDay": 245562283.16810948, "volumePrev2Day": 205702464.62591228, "lastHourlyVolume": 0, "last24hVolume": 245562283.16810948, "lastDailyVolume": 245562283.16810948, "dayBeforeLastVolume": 205702464.62591228, "weeklyVolume": 1700279485.290507, "monthlyVolume": 3986810177.448681, "chains": ["Arbitrum", "Hyperliquid"], "destinationChain": "Hyperliquid", "url": "https://app.hyperliquid.xyz/trade", "slug": "hyperliquid-bridge" } ] } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.bridges.getAll()" }, { "lang": "python", "label": "Python SDK", "source": "result = client.bridges.getAll()" } ] } }, "/bridges/bridge/{id}": { "get": { "tags": ["bridges"], "summary": "Get summary of bridge volume and volume breakdown by chain", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "bridge ID, you can get these from /bridges", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Bridge ID" }, "name": { "type": "string", "description": "Bridge name" }, "displayName": { "type": "string", "description": "Bridge display name" }, "lastHourlyVolume": { "type": "number", "description": "Last hourly volume" }, "currentDayVolume": { "type": "number", "description": "Current day volume" }, "lastDailyVolume": { "type": "number", "description": "Last daily volume" }, "dayBeforeLastVolume": { "type": "number", "description": "Day before last volume" }, "weeklyVolume": { "type": "number", "description": "Weekly volume" }, "monthlyVolume": { "type": "number", "description": "Monthly volume" }, "lastHourlyTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposits" }, "withdrawals": { "type": "integer", "description": "Number of withdrawals" } }, "description": "Last hourly transactions" }, "currentDayTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposits" }, "withdrawals": { "type": "integer", "description": "Number of withdrawals" } }, "description": "Current day transactions" }, "prevDayTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposits" }, "withdrawals": { "type": "integer", "description": "Number of withdrawals" } }, "description": "Previous day transactions" }, "dayBeforeLastTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposits" }, "withdrawals": { "type": "integer", "description": "Number of withdrawals" } }, "description": "Day before last transactions" }, "weeklyTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposits" }, "withdrawals": { "type": "integer", "description": "Number of withdrawals" } }, "description": "Weekly transactions" }, "monthlyTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposits" }, "withdrawals": { "type": "integer", "description": "Number of withdrawals" } }, "description": "Monthly transactions" }, "chainBreakdown": { "type": "object", "description": "Volume breakdown by chain" }, "destinationChain": { "type": "string", "description": "Destination chain" } } }, "example": { "id": 1, "name": "polygon", "displayName": "Polygon PoS Bridge", "lastHourlyVolume": 118020.67633222912, "currentDayVolume": 0, "lastDailyVolume": 28740605.36474136, "dayBeforeLastVolume": 17294645.046479236, "weeklyVolume": 71188570.7201651, "monthlyVolume": 490635601.59313035, "lastHourlyTxs": { "deposits": 10, "withdrawals": 5 }, "currentDayTxs": { "deposits": 0, "withdrawals": 0 }, "prevDayTxs": { "deposits": 153, "withdrawals": 150 }, "dayBeforeLastTxs": { "deposits": 173, "withdrawals": 195 }, "weeklyTxs": { "deposits": 2095, "withdrawals": 1752 }, "monthlyTxs": { "deposits": 6945, "withdrawals": 5537 }, "chainBreakdown": { "Polygon": { "lastHourlyVolume": 118020.67633222912, "currentDayVolume": 0, "lastDailyVolume": 28740605.36474136, "dayBeforeLastVolume": 17294645.046479236, "weeklyVolume": 71188570.7201651, "monthlyVolume": 490635601.59313035, "last24hVolume": 34766385.06231544, "lastHourlyTxs": { "deposits": 10, "withdrawals": 5 }, "currentDayTxs": { "deposits": 0, "withdrawals": 0 }, "prevDayTxs": { "deposits": 153, "withdrawals": 150 }, "dayBeforeLastTxs": { "deposits": 173, "withdrawals": 195 }, "weeklyTxs": { "deposits": 2095, "withdrawals": 1752 }, "monthlyTxs": { "deposits": 6945, "withdrawals": 5537 } }, "Ethereum": { "lastHourlyVolume": 118020.67633222912, "currentDayVolume": 0, "lastDailyVolume": 28740605.36474136, "dayBeforeLastVolume": 17294645.046479236, "weeklyVolume": 71188570.7201651, "monthlyVolume": 490635601.59313035, "last24hVolume": 34766385.06231544, "lastHourlyTxs": { "deposits": 10, "withdrawals": 5 }, "currentDayTxs": { "deposits": 0, "withdrawals": 0 }, "prevDayTxs": { "deposits": 153, "withdrawals": 150 }, "dayBeforeLastTxs": { "deposits": 173, "withdrawals": 195 }, "weeklyTxs": { "deposits": 2095, "withdrawals": 1752 }, "monthlyTxs": { "deposits": 6945, "withdrawals": 5537 } } }, "destinationChain": "Polygon" } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.bridges.getById(1)" }, { "lang": "python", "label": "Python SDK", "source": "result = client.bridges.getById('')" } ] } }, "/bridges/bridgevolume/{chain}": { "get": { "tags": ["bridges"], "summary": "Get historical volumes for a bridge, chain, or bridge on a particular chain", "parameters": [ { "name": "chain", "in": "path", "required": true, "description": "chain slug, you can get these from /chains. Call also use 'all' for volume on all chains.", "schema": { "type": "string", "example": "Ethereum" } }, { "name": "id", "in": "query", "required": false, "description": "bridge ID, you can get these from /bridges", "schema": { "type": "integer", "example": 2 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "Date timestamp" }, "depositUSD": { "type": "number", "description": "Deposit volume in USD" }, "withdrawUSD": { "type": "number", "description": "Withdrawal volume in USD" }, "depositTxs": { "type": "integer", "description": "Number of deposit transactions" }, "withdrawTxs": { "type": "integer", "description": "Number of withdrawal transactions" } } } }, "example": [ { "date": "1665964800", "depositUSD": 11121806.082658675, "withdrawUSD": 13970177.335270314, "depositTxs": 218, "withdrawTxs": 56 }, { "date": "1666051200", "depositUSD": 32940139.204768553, "withdrawUSD": 157541586.9492474, "depositTxs": 2042, "withdrawTxs": 708 } ] } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.bridges.getVolumeByChain('')" }, { "lang": "python", "label": "Python SDK", "source": "result = client.bridges.getVolumeByChain('')" } ] } }, "/bridges/bridgedaystats/{timestamp}/{chain}": { "get": { "tags": ["bridges"], "summary": "Get a 24hr token and address volume breakdown for a bridge", "parameters": [ { "name": "timestamp", "in": "path", "required": true, "description": "Unix timestamp. Data returned will be for the 24hr period starting at 00:00 UTC that the timestamp lands in.", "schema": { "type": "integer", "example": 1755561600 } }, { "name": "chain", "in": "path", "required": true, "description": "chain slug, you can get these from /chains.", "schema": { "type": "string", "example": "Ethereum" } }, { "name": "id", "in": "query", "required": false, "description": "bridge ID, you can get these from /bridges", "schema": { "type": "integer", "example": 2 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "integer", "description": "Date timestamp" }, "totalTokensDeposited": { "type": "object", "description": "Total tokens deposited with their details", "additionalProperties": { "type": "object", "properties": { "usdValue": { "type": "number", "description": "USD value of the token" }, "amount": { "type": "string", "description": "Token amount as string" }, "symbol": { "type": "string", "description": "Token symbol" }, "decimals": { "type": "integer", "description": "Token decimals" } } } }, "totalTokensWithdrawn": { "type": "object", "description": "Total tokens withdrawn with their details", "additionalProperties": { "type": "object", "properties": { "usdValue": { "type": "number", "description": "USD value of the token" }, "amount": { "type": "string", "description": "Token amount as string" }, "symbol": { "type": "string", "description": "Token symbol" }, "decimals": { "type": "integer", "description": "Token decimals" } } } }, "totalAddressDeposited": { "type": "object", "description": "Total addresses that deposited with their details", "additionalProperties": { "type": "object", "properties": { "usdValue": { "type": "number", "description": "Total USD value deposited by this address" }, "txs": { "type": "integer", "description": "Number of transactions from this address" } } } }, "totalAddressWithdrawn": { "type": "object", "description": "Total addresses that withdrew with their details", "additionalProperties": { "type": "object", "properties": { "usdValue": { "type": "number", "description": "Total USD value withdrawn by this address" }, "txs": { "type": "integer", "description": "Number of transactions from this address" } } } } } }, "example": { "date": 1752796800, "totalTokensDeposited": { "ethereum:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": { "usdValue": 8538374.477027368, "amount": "17379331182", "symbol": "USDC", "decimals": 6 }, "ethereum:0x6De037ef9aD2725EB40118Bb1702EBb27e4Aeb24": { "usdValue": 2123785.5869, "amount": "2123785.5869", "symbol": "RNDR", "decimals": 18 } }, "totalTokensWithdrawn": { "ethereum:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": { "usdValue": 3020623.745962119, "amount": "14680842655", "symbol": "USDC", "decimals": 6 }, "ethereum:0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2": { "usdValue": 2214456.1061736266, "amount": "28501633217143430245", "symbol": "WETH", "decimals": 18 } }, "totalAddressDeposited": { "ethereum:0x3a23F943181408EAC424116Af7b7790c94Cb97a5": { "usdValue": 2447787.602843585, "txs": 13 }, "ethereum:0x348C31025754113F599ccEa72747A726a133799b": { "usdValue": 2115000, "txs": 1 } }, "totalAddressWithdrawn": { "ethereum:0xb60d0C2E8309518373b40f8Eaa2CAd0d1De3deCb": { "usdValue": 1196415.6440843595, "txs": 2 }, "ethereum:0x49c3FeaFDdaefC3Bed06F4ff87CE86610C2c1076": { "usdValue": 565794.5181076665, "txs": 1 } } } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.bridges.getDayStats(1704067200, '')" }, { "lang": "python", "label": "Python SDK", "source": "result = client.bridges.getDayStats(1704067200, '')" } ] } }, "/bridges/transactions/{id}": { "get": { "tags": ["bridges"], "summary": "Get all transactions for a bridge within a date range", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "bridge ID, you can get these from /bridges", "schema": { "type": "integer", "example": 1 } }, { "name": "starttimestamp", "in": "query", "required": false, "description": "start timestamp (Unix Timestamp) for date range", "schema": { "type": "integer", "example": 1667260800 } }, { "name": "endtimestamp", "in": "query", "required": false, "description": "end timestamp (Unix timestamp) for date range", "schema": { "type": "integer", "example": 1667347200 } }, { "name": "sourcechain", "in": "query", "required": false, "description": "Returns only transactions that are bridging from the specified source chain.", "schema": { "type": "string", "example": "Polygon" } }, { "name": "address", "in": "query", "required": false, "description": "Returns only transactions with specified address as \"from\" or \"to\". Addresses are quried in the form {chain}:{address}, where chain is an identifier such as ethereum, bsc, polygon, avax... .", "schema": { "type": "string", "example": "ethereum:0x69b4B4390Bd1f0aE84E090Fe8af7AbAd2d95Cc8E" } }, { "name": "limit", "in": "query", "required": false, "description": "limit to number of transactions returned, maximum is 6000", "schema": { "type": "integer", "example": 200 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "Bridge information (returned when no query parameters provided)", "properties": { "id": { "type": "integer", "description": "Bridge ID" }, "name": { "type": "string", "description": "Bridge name" }, "displayName": { "type": "string", "description": "Bridge display name" }, "lastHourlyVolume": { "type": "number", "description": "Last hourly volume" }, "currentDayVolume": { "type": "number", "description": "Current day volume" }, "lastDailyVolume": { "type": "number", "description": "Last daily volume" }, "dayBeforeLastVolume": { "type": "number", "description": "Day before last volume" }, "weeklyVolume": { "type": "number", "description": "Weekly volume" }, "monthlyVolume": { "type": "number", "description": "Monthly volume" }, "lastHourlyTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposit transactions" }, "withdrawals": { "type": "integer", "description": "Number of withdrawal transactions" } } }, "currentDayTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposit transactions" }, "withdrawals": { "type": "integer", "description": "Number of withdrawal transactions" } } }, "prevDayTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposit transactions" }, "withdrawals": { "type": "integer", "description": "Number of withdrawal transactions" } } }, "dayBeforeLastTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposit transactions" }, "withdrawals": { "type": "integer", "description": "Number of withdrawal transactions" } } }, "weeklyTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposit transactions" }, "withdrawals": { "type": "integer", "description": "Number of withdrawal transactions" } } }, "monthlyTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposit transactions" }, "withdrawals": { "type": "integer", "description": "Number of withdrawal transactions" } } }, "chainBreakdown": { "type": "object", "additionalProperties": { "type": "object", "properties": { "lastHourlyVolume": { "type": "number", "description": "Last hourly volume" }, "currentDayVolume": { "type": "number", "description": "Current day volume" }, "lastDailyVolume": { "type": "number", "description": "Last daily volume" }, "dayBeforeLastVolume": { "type": "number", "description": "Day before last volume" }, "weeklyVolume": { "type": "number", "description": "Weekly volume" }, "monthlyVolume": { "type": "number", "description": "Monthly volume" }, "last24hVolume": { "type": "number", "description": "Last 24 hour volume" }, "lastHourlyTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposit transactions" }, "withdrawals": { "type": "integer", "description": "Number of withdrawal transactions" } } }, "currentDayTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposit transactions" }, "withdrawals": { "type": "integer", "description": "Number of withdrawal transactions" } } }, "prevDayTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposit transactions" }, "withdrawals": { "type": "integer", "description": "Number of withdrawal transactions" } } }, "dayBeforeLastTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposit transactions" }, "withdrawals": { "type": "integer", "description": "Number of withdrawal transactions" } } }, "weeklyTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposit transactions" }, "withdrawals": { "type": "integer", "description": "Number of withdrawal transactions" } } }, "monthlyTxs": { "type": "object", "properties": { "deposits": { "type": "integer", "description": "Number of deposit transactions" }, "withdrawals": { "type": "integer", "description": "Number of withdrawal transactions" } } } } } }, "destinationChain": { "type": "string", "description": "Destination chain" } } }, { "type": "array", "description": "Transaction list (returned when query parameters provided)", "items": { "type": "object", "properties": { "tx_hash": { "type": "string", "description": "Transaction hash" }, "ts": { "type": "string", "description": "Timestamp in ISO format" }, "tx_block": { "type": "integer", "description": "Block number" }, "tx_from": { "type": "string", "description": "From address" }, "tx_to": { "type": "string", "description": "To address" }, "token": { "type": "string", "description": "Token contract address" }, "amount": { "type": "string", "description": "Transaction amount" }, "chain": { "type": "string", "description": "Blockchain name" }, "bridge_name": { "type": "string", "description": "Bridge name" }, "usd_value": { "type": ["number", "null"], "description": "USD value of transaction" }, "sourceChain": { "type": "string", "description": "Source chain name" } } } } ] }, "example": { "id": 1, "name": "polygon", "displayName": "Polygon PoS Bridge", "lastHourlyVolume": 118020.67633222912, "currentDayVolume": 0, "lastDailyVolume": 28740605.36474136, "dayBeforeLastVolume": 17294645.046479236, "weeklyVolume": 71188570.7201651, "monthlyVolume": 490635601.59313035, "lastHourlyTxs": { "deposits": 10, "withdrawals": 5 }, "currentDayTxs": { "deposits": 0, "withdrawals": 0 }, "prevDayTxs": { "deposits": 153, "withdrawals": 150 }, "dayBeforeLastTxs": { "deposits": 173, "withdrawals": 195 }, "weeklyTxs": { "deposits": 2095, "withdrawals": 1752 }, "monthlyTxs": { "deposits": 6945, "withdrawals": 5537 }, "chainBreakdown": { "Polygon": { "lastHourlyVolume": 118020.67633222912, "currentDayVolume": 0, "lastDailyVolume": 28740605.36474136, "dayBeforeLastVolume": 17294645.046479236, "weeklyVolume": 71188570.7201651, "monthlyVolume": 490635601.59313035, "last24hVolume": 34766385.06231544, "lastHourlyTxs": { "deposits": 10, "withdrawals": 5 }, "currentDayTxs": { "deposits": 0, "withdrawals": 0 }, "prevDayTxs": { "deposits": 153, "withdrawals": 150 }, "dayBeforeLastTxs": { "deposits": 173, "withdrawals": 195 }, "weeklyTxs": { "deposits": 2095, "withdrawals": 1752 }, "monthlyTxs": { "deposits": 6945, "withdrawals": 5537 } }, "Ethereum": { "lastHourlyVolume": 118020.67633222912, "currentDayVolume": 0, "lastDailyVolume": 28740605.36474136, "dayBeforeLastVolume": 17294645.046479236, "weeklyVolume": 71188570.7201651, "monthlyVolume": 490635601.59313035, "last24hVolume": 34766385.06231544, "lastHourlyTxs": { "deposits": 10, "withdrawals": 5 }, "currentDayTxs": { "deposits": 0, "withdrawals": 0 }, "prevDayTxs": { "deposits": 153, "withdrawals": 150 }, "dayBeforeLastTxs": { "deposits": 173, "withdrawals": 195 }, "weeklyTxs": { "deposits": 2095, "withdrawals": 1752 }, "monthlyTxs": { "deposits": 6945, "withdrawals": 5537 } } }, "destinationChain": "Polygon" } } } } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.bridges.getTransactions(1)" }, { "lang": "python", "label": "Python SDK", "source": "result = client.bridges.getTransactions('')" } ] } }, "/usage/{YOUR_API_KEY}": { "get": { "tags": ["meta"], "summary": "Get amount of credits left in the api key, these reset on the 1st of each month", "servers": [ { "url": "https://pro-api.llama.fi" } ], "parameters": [ { "name": "YOUR_API_KEY", "in": "path", "required": true, "description": "Your DefiLlama API plan key. For this endpoint only, the key goes at the end of the path.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "credits left" } }, "x-api-plan-only": true, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.account.getUsage()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.account.getUsage()" } ] } }, "/coins/prices/current/{coins}": { "get": { "tags": ["coins"], "summary": "Get current prices of tokens by contract address", "description": "The goal of this API is to price as many tokens as possible, including exotic ones that never get traded, which makes them impossible to price by looking at markets.\n\nThe base of our data are prices pulled from coingecko, which is then extended through multiple means:\n- We price all bridged tokens by using the price of the token in it's original chain, so we fetch all bridged versions of USDC on arbitrum, fantom, avax... and price all them using the price for the token on Ethereum, which we know. Right now we support 10 different bridging protocols.\n- We have multiple adapters to price specialized sets of tokens by running custom code:\n - We price yearn's yToken LPs by checking how much underlying token can be withdrawn for each LP\n - Aave, compound and euler LP tokens are also priced based on their relationship against underlying tokens\n - Uniswap, curve, balancer and stargate LPs are priced using the underlying tokens in each pair\n - GMX's GLP token is priced based on the value of tokens given on withdrawal (which includes calculations based on trader's PnL)\n \n - Synthetix tokens are priced using forex prices of the coin they are pegged to\n- For tokens that we haven't been able to price in any other way, we find the pool with most liquidity for each on uniswap, curve and serum and then use the prices provided on those exchanges.\n \n Unlike all the other tokens, we can't confirm that these prices are correct, so we only ingest the ones that have sufficient liquidity and, even in that case, we attach a `confidence` value to them that is related to the depth of liquidity and which represents our confidence in the quality of each price. API consumers can choose to filter out prices with low confidence values.\n \n Our API server is fully open source and we are constantly adding more pricing adapters, extending the amount of tokens we support.\n \nTokens are queried using {chain}:{address}, where chain is an identifier such as ethereum, bsc, polygon, avax... You can also get tokens by coingecko id by setting `coingecko` as the chain, eg: coingecko:ethereum, coingecko:bitcoin. Examples:\n - ethereum:0xdF574c24545E5FfEcb9a659c229253D4111d87e1\n - bsc:0x762539b45a1dcce3d36d080f74d1aed37844b878\n - coingecko:ethereum\n - arbitrum:0x4277f8f2c384827b5273592ff7cebd9f2c1ac258\n", "parameters": [ { "name": "coins", "in": "path", "required": true, "description": "set of comma-separated tokens defined as {chain}:{address}", "schema": { "type": "string", "example": "ethereum:0xdF574c24545E5FfEcb9a659c229253D4111d87e1,coingecko:ethereum,bsc:0x762539b45a1dcce3d36d080f74d1aed37844b878,ethereum:0xdB25f211AB05b1c97D595516F45794528a807ad8" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "coins": { "type": "object", "properties": { "ethereum:0xdF574c24545E5FfEcb9a659c229253D4111d87e1": { "type": "object", "required": ["price", "symbol", "timestamp"], "properties": { "decimals": { "type": "number", "description": "Token decimals. Omitted for coingecko-native assets (e.g. coingecko:ethereum).", "example": 8 }, "price": { "type": "number", "example": 0.022053735051098835 }, "symbol": { "type": "string", "example": "cDAI" }, "timestamp": { "type": "number", "example": 0.99 }, "confidence": { "type": "number", "description": "Confidence score between 0 and 1 indicating the reliability of the price.", "example": 0.99 } } } } } } } } } }, "502": { "description": "Internal error" } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.prices.getCurrentPrices([''])" }, { "lang": "python", "label": "Python SDK", "source": "result = client.prices.getCurrentPrices([''])" } ] } }, "/coins/prices/historical/{timestamp}/{coins}": { "get": { "tags": ["coins"], "summary": "Get historical prices of tokens by contract address", "description": "See /prices/current for explanation on how prices are sourced.", "parameters": [ { "name": "coins", "in": "path", "required": true, "description": "set of comma-separated tokens defined as {chain}:{address}", "schema": { "type": "string", "example": "ethereum:0xdF574c24545E5FfEcb9a659c229253D4111d87e1,coingecko:ethereum,bsc:0x762539b45a1dcce3d36d080f74d1aed37844b878,ethereum:0xdB25f211AB05b1c97D595516F45794528a807ad8" } }, { "name": "timestamp", "in": "path", "required": true, "description": "UNIX timestamp of time when you want historical prices", "schema": { "type": "number", "example": 1648680149 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "coins": { "type": "object", "properties": { "ethereum:0xdF574c24545E5FfEcb9a659c229253D4111d87e1": { "type": "object", "required": ["price", "symbol", "timestamp"], "properties": { "decimals": { "type": "number", "description": "Token decimals. Omitted for coingecko-native assets (e.g. coingecko:ethereum).", "example": 8 }, "price": { "type": "number", "example": 0.022053735051098835 }, "symbol": { "type": "string", "example": "cDAI" }, "timestamp": { "type": "number", "example": 1648680149 }, "confidence": { "type": "number", "description": "Confidence score between 0 and 1 indicating the reliability of the price.", "example": 0.99 } } } } } } } } } }, "502": { "description": "Internal error" } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.prices.getHistoricalPrices(1704067200, [''])" }, { "lang": "python", "label": "Python SDK", "source": "result = client.prices.getHistoricalPrices(1704067200, [''])" } ] } }, "/coins/batchHistorical": { "get": { "tags": ["coins"], "summary": "Get historical prices for multiple tokens at multiple different timestamps", "parameters": [ { "name": "coins", "in": "query", "required": true, "description": "object where keys are coins in the form {chain}:{address}, and values are arrays of requested timestamps", "schema": { "type": "string", "example": "{\"avax:0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e\": [1666876743, 1666862343], \"coingecko:ethereum\": [1666869543, 1666862343]}\n" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "coins": { "type": "object", "properties": { "avax:0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e": { "type": "object", "properties": { "symbol": { "type": "string", "example": "USDC" }, "prices": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "number", "example": 1666876674 }, "price": { "type": "number", "example": 0.999436 }, "confidence": { "type": "number", "example": 0.99 } } } } } } } } } } } } }, "502": { "description": "Internal error" } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.prices.getBatchHistoricalPrices({ '': [1704067200] })" }, { "lang": "python", "label": "Python SDK", "source": "result = client.prices.getBatchHistoricalPrices([''], '')" } ] } }, "/coins/chart/{coins}": { "get": { "tags": ["coins"], "summary": "Get token prices at regular time intervals", "description": "Strings accepted by period:\nCan use regular chart candle notion like '4h' etc where:\nW = week, D = day, H = hour, M = minute (not case sensitive)\n", "parameters": [ { "name": "coins", "in": "path", "required": true, "description": "set of comma-separated tokens defined as {chain}:{address}", "schema": { "type": "string", "example": "ethereum:0xdF574c24545E5FfEcb9a659c229253D4111d87e1,coingecko:ethereum,bsc:0x762539b45a1dcce3d36d080f74d1aed37844b878,ethereum:0xdB25f211AB05b1c97D595516F45794528a807ad8" } }, { "name": "start", "in": "query", "required": false, "description": "unix timestamp of earliest data point requested", "schema": { "type": "number", "example": 1664364537 } }, { "name": "end", "in": "query", "required": false, "description": "unix timestamp of latest data point requested", "schema": { "type": "number", "example": null } }, { "name": "span", "in": "query", "required": false, "description": "number of data points returned, defaults to 0", "schema": { "type": "number", "example": 10 } }, { "name": "period", "in": "query", "required": false, "description": "duration between data points, defaults to 24 hours", "schema": { "type": "string", "example": "2d" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "coins": { "type": "object", "properties": { "ethereum:0xdF574c24545E5FfEcb9a659c229253D4111d87e1": { "type": "object", "required": ["confidence", "prices", "symbol"], "properties": { "decimals": { "type": "number", "description": "Token decimals. Omitted for coingecko-native assets (e.g. coingecko:ethereum).", "example": 8 }, "confidence": { "type": "number", "description": "Confidence score between 0 and 1 indicating the reliability of the price.", "example": 0.99 }, "prices": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "number", "example": 1666790570 }, "price": { "type": "number", "example": 0.984519 } } } }, "symbol": { "type": "string", "example": "HUSD" } } } } } } } } } }, "502": { "description": "Internal error" } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.prices.getChart([''])" }, { "lang": "python", "label": "Python SDK", "source": "result = client.prices.getChart([''])" } ] } }, "/coins/percentage/{coins}": { "get": { "tags": ["coins"], "summary": "Get percentage change in price over time", "description": "Strings accepted by period:\nCan use regular chart candle notion like '4h' etc where:\nW = week, D = day, H = hour, M = minute (not case sensitive)\n", "parameters": [ { "name": "coins", "in": "path", "required": true, "description": "set of comma-separated tokens defined as {chain}:{address}", "schema": { "type": "string", "example": "ethereum:0xdF574c24545E5FfEcb9a659c229253D4111d87e1,coingecko:ethereum,bsc:0x762539b45a1dcce3d36d080f74d1aed37844b878,ethereum:0xdB25f211AB05b1c97D595516F45794528a807ad8" } }, { "name": "timestamp", "in": "query", "required": false, "description": "timestamp of data point requested, defaults to time now", "schema": { "type": "number", "example": 1664364537 } }, { "name": "lookForward", "in": "query", "required": false, "description": "whether you want the duration after your given timestamp or not, defaults to false (looking back)", "schema": { "type": "boolean", "example": false } }, { "name": "period", "in": "query", "required": false, "description": "duration between data points, defaults to 24 hours", "schema": { "type": "string", "example": "3w" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "coins": { "type": "object", "properties": { "ethereum:0xdF574c24545E5FfEcb9a659c229253D4111d87e1": { "type": "number", "example": -2.3009954568977147 } } } } } } } }, "502": { "description": "Internal error" } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.prices.getPercentageChange([''])" }, { "lang": "python", "label": "Python SDK", "source": "result = client.prices.getPercentageChange([''])" } ] } }, "/coins/prices/first/{coins}": { "get": { "tags": ["coins"], "summary": "Get earliest timestamp price record for coins", "parameters": [ { "name": "coins", "in": "path", "required": true, "description": "set of comma-separated tokens defined as {chain}:{address}", "schema": { "type": "string", "example": "ethereum:0xdF574c24545E5FfEcb9a659c229253D4111d87e1,coingecko:ethereum,bsc:0x762539b45a1dcce3d36d080f74d1aed37844b878,ethereum:0xdB25f211AB05b1c97D595516F45794528a807ad8" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "coins": { "type": "object", "properties": { "ethereum:0xdF574c24545E5FfEcb9a659c229253D4111d87e1": { "type": "object", "properties": { "price": { "type": "number", "example": 0.9992047673109988 }, "symbol": { "type": "string", "example": "HUSD" }, "timestamp": { "type": "number", "example": 1568883821 } } } } } } } } } }, "502": { "description": "Internal error" } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.prices.getFirstPrices([''])" }, { "lang": "python", "label": "Python SDK", "source": "result = client.prices.getFirstPrices([''])" } ] } }, "/coins/block/{chain}/{timestamp}": { "get": { "tags": ["coins"], "summary": "Get the closest block to a timestamp", "description": "Runs binary search over a blockchain's blocks to get the closest one to a timestamp.\nEvery time this is run we add new data to our database, so each query permanently speeds up future queries.\n", "parameters": [ { "name": "chain", "in": "path", "description": "Chain which you want to get the block from", "required": true, "schema": { "type": "string", "example": "Ethereum" } }, { "name": "timestamp", "in": "path", "description": "UNIX timestamp of the block you are searching for", "required": true, "schema": { "type": "integer", "example": 1603964988 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "height": { "type": "integer", "format": "uint", "example": 11150916 }, "timestamp": { "type": "integer", "format": "uint", "example": 1603964988 } } } } } }, "400": { "description": "Invalid chain or timestamp provided" } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.prices.getBlockAtTimestamp('', 1704067200)" }, { "lang": "python", "label": "Python SDK", "source": "result = client.prices.getBlockAtTimestamp('', 1704067200)" } ] } }, "/stablecoins/stablecoins": { "get": { "tags": ["stablecoins"], "summary": "List all stablecoins along with their circulating amounts", "parameters": [ { "name": "includePrices", "in": "query", "required": false, "description": "set whether to include current stablecoin prices", "schema": { "type": "boolean", "example": true } } ], "responses": { "200": { "description": "Array of all stablecoins with their circulation data", "content": { "application/json": { "schema": { "type": "object", "properties": { "peggedAssets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "1" }, "name": { "type": "string", "example": "Tether" }, "symbol": { "type": "string", "example": "USDT" }, "pegType": { "type": "string", "example": "peggedUSD" }, "pegMechanism": { "type": "string", "example": "fiat-backed" }, "circulating": { "type": "object", "properties": { "peggedUSD": { "type": "number", "example": 159510682147.76874 } } }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Tron", "BSC"] }, "chainCirculating": { "type": "object", "additionalProperties": { "type": "object", "properties": { "current": { "type": "object", "properties": { "peggedUSD": { "type": "number", "example": 50000000000 } } } } } }, "price": { "type": "number", "example": 1.001 } } } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.stablecoins.getStablecoins()" }, { "lang": "python", "label": "Python SDK", "source": "result = client.stablecoins.getStablecoins()" } ] } }, "/stablecoins/stablecoincharts/all": { "get": { "tags": ["stablecoins"], "summary": "Get historical mcap sum of all stablecoins", "parameters": [ { "name": "stablecoin", "in": "query", "required": false, "description": "stablecoin ID, you can get these from /stablecoins", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Historical market cap data for all stablecoins", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "number", "example": 1609459200 }, "totalCirculating": { "type": "object", "properties": { "peggedUSD": { "type": "number", "example": 45000000000 } } } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.stablecoins.getAllCharts()" }, { "lang": "python", "label": "Python SDK", "source": "result = client.stablecoins.getAllCharts()" } ] } }, "/stablecoins/stablecoincharts/{chain}": { "get": { "tags": ["stablecoins"], "summary": "Get historical mcap sum of all stablecoins in a chain", "parameters": [ { "name": "chain", "in": "path", "required": true, "description": "chain slug, you can get these from /chains or the chains property on /protocols", "schema": { "type": "string", "example": "Ethereum" } }, { "name": "stablecoin", "in": "query", "required": false, "description": "stablecoin ID, you can get these from /stablecoins", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Historical market cap data for stablecoins on specified chain", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "number", "example": 1609459200 }, "totalCirculating": { "type": "object", "properties": { "peggedUSD": { "type": "number", "example": 12000000000 } } } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.stablecoins.getChartsByChain('')" }, { "lang": "python", "label": "Python SDK", "source": "result = client.stablecoins.getChartsByChain('')" } ] } }, "/stablecoins/stablecoin/{asset}": { "get": { "tags": ["stablecoins"], "summary": "Get historical mcap and historical chain distribution of a stablecoin", "parameters": [ { "name": "asset", "in": "path", "required": true, "description": "stablecoin ID, you can get these from /stablecoins", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Historical market cap and chain distribution for specific stablecoin", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "1" }, "name": { "type": "string", "example": "Tether" }, "symbol": { "type": "string", "example": "USDT" }, "totalCirculating": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "number", "example": 1609459200 }, "totalCirculating": { "type": "number", "example": 50000000000 } } } }, "chainCirculating": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "number", "example": 1609459200 }, "circulating": { "type": "number", "example": 20000000000 } } } } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.stablecoins.getStablecoin('')" }, { "lang": "python", "label": "Python SDK", "source": "result = client.stablecoins.getStablecoin('')" } ] } }, "/stablecoins/stablecoinchains": { "get": { "tags": ["stablecoins"], "summary": "Get current mcap sum of all stablecoins on each chain", "responses": { "200": { "description": "Current market cap of stablecoins by chain", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Ethereum" }, "totalCirculating": { "type": "object", "properties": { "peggedUSD": { "type": "number", "example": 75000000000 } } } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.stablecoins.getChains()" }, { "lang": "python", "label": "Python SDK", "source": "result = client.stablecoins.getChains()" } ] } }, "/stablecoins/stablecoinprices": { "get": { "tags": ["stablecoins"], "summary": "Get historical prices of all stablecoins", "responses": { "200": { "description": "Historical prices for all stablecoins", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "number", "example": 1609459200 }, "prices": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "USDT": 1.001, "USDC": 0.999, "DAI": 1.002 } } } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await client.stablecoins.getPrices()" }, { "lang": "python", "label": "Python SDK", "source": "result = client.stablecoins.getPrices()" } ] } }, "/dat/institutions": { "get": { "tags": ["DAT"], "x-api-plan-only": true, "summary": "Get list of all institutions with Digital Asset Treasury data", "description": "Returns comprehensive data about institutions holding digital assets, including mNAV calculations (realized, realistic, maximum) as described in the [DAT Methodology](https://docs.llama.fi/analysts/dat-methodology)", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "institutionMetadata": { "type": "object", "additionalProperties": { "type": "object", "properties": { "institutionId": { "type": "integer", "description": "Unique institution identifier" }, "ticker": { "type": "string", "description": "Institution ticker symbol", "example": "MSTR" }, "name": { "type": "string", "description": "Institution name", "example": "Strategy, Inc. (Formerly: MicroStrategy Inc.)" }, "type": { "type": "string", "description": "Institution type", "example": "Stock" }, "price": { "type": "number", "description": "Current share price" }, "priceChange24h": { "type": "number", "description": "24h price change percentage" }, "volume24h": { "type": "number", "description": "24h trading volume" }, "mcapRealized": { "type": "number", "description": "Market cap using current outstanding shares" }, "mcapRealistic": { "type": "number", "description": "Market cap accounting for unavoidable dilution" }, "mcapMax": { "type": "number", "description": "Market cap under maximum dilution scenario" }, "realized_mNAV": { "type": "number", "description": "Ratio of marketcap to crypto treasury using current shares" }, "realistic_mNAV": { "type": "number", "description": "Ratio accounting for unavoidable dilution" }, "max_mNAV": { "type": "number", "description": "Ratio under maximum dilution scenario" }, "totalUsdValue": { "type": "number", "description": "Total USD value of crypto holdings" }, "totalCost": { "type": "number", "description": "Total cost basis of crypto holdings" }, "holdings": { "type": "object", "additionalProperties": { "type": "object", "properties": { "amount": { "type": "number", "description": "Amount of asset held" }, "avgPrice": { "type": "number", "description": "Average purchase price" }, "usdValue": { "type": "number", "description": "Current USD value" }, "cost": { "type": "number", "description": "Total cost basis" }, "transactionCount": { "type": "integer", "description": "Number of transactions" }, "firstAnnouncementDate": { "type": "string", "format": "date", "description": "Date of first announcement" }, "lastAnnouncementDate": { "type": "string", "format": "date", "description": "Date of last announcement" }, "supplyPercentage": { "type": "number", "description": "Percentage of total supply held" } } } } } } }, "assetMetadata": { "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string", "description": "Asset name", "example": "Bitcoin" }, "ticker": { "type": "string", "description": "Asset ticker", "example": "BTC" }, "geckoId": { "type": "string", "description": "CoinGecko ID" }, "companies": { "type": "integer", "description": "Number of companies holding this asset" }, "totalAmount": { "type": "number", "description": "Total amount held across all institutions" }, "totalUsdValue": { "type": "number", "description": "Total USD value across all institutions" }, "circSupplyPerc": { "type": "number", "description": "Percentage of circulating supply held" } } } }, "institutions": { "type": "array", "items": { "type": "object", "properties": { "institutionId": { "type": "integer", "description": "Institution ID" }, "totalUsdValue": { "type": "number", "description": "Total USD value of holdings" }, "totalCost": { "type": "number", "description": "Total cost basis" } } } }, "assets": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "institutionId": { "type": "integer", "description": "Institution ID" }, "usdValue": { "type": "number", "description": "USD value of holding" }, "amount": { "type": "number", "description": "Amount held" } } } } }, "totalCompanies": { "type": "integer", "description": "Total number of companies tracked" }, "flows": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Timestamp" }, { "type": "number", "description": "Net flow" }, { "type": "number", "description": "Inflow" }, { "type": "number", "description": "Outflow" }, { "type": "number", "description": "USD value" }, { "type": "number", "description": "USD value of net flow" } ] } } }, "mNAV": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Timestamp" }, { "type": "number", "description": "Realized mNAV" }, { "type": "number", "description": "Realistic mNAV" }, { "type": "number", "description": "Maximum mNAV" } ] } } } }, "lastUpdated": { "type": "string", "format": "date-time", "description": "Last update timestamp" } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.dat.getInstitutions()" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.dat.getInstitutions()" } ] } }, "/dat/institutions/{symbol}": { "get": { "tags": ["DAT"], "x-api-plan-only": true, "summary": "Get individual institution Digital Asset Treasury details", "description": "Returns detailed data for a specific institution, including mNAV calculations (realized, realistic, maximum) as described in the [DAT Methodology](https://docs.llama.fi/analysts/dat-methodology)", "parameters": [ { "name": "symbol", "in": "path", "required": true, "description": "Institution ticker symbol (e.g., MSTR for MicroStrategy)", "schema": { "type": "string", "example": "MSTR" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "institutionId": { "type": "integer", "description": "Unique institution identifier" }, "ticker": { "type": "string", "description": "Institution ticker symbol", "example": "MSTR" }, "name": { "type": "string", "description": "Institution name", "example": "Strategy, Inc. (Formerly: MicroStrategy Inc.)" }, "type": { "type": "string", "description": "Institution type", "example": "Stock" }, "rank": { "type": "integer", "description": "Institution rank" }, "price": { "type": "number", "description": "Current share price" }, "priceChange24h": { "type": "number", "description": "24h price change percentage" }, "volume24h": { "type": "number", "description": "24h trading volume" }, "fd_realized": { "type": "string", "description": "Fully diluted shares - realized count" }, "fd_realistic": { "type": "string", "description": "Fully diluted shares - realistic count" }, "fd_max": { "type": "string", "description": "Fully diluted shares - maximum count" }, "mcap_realized": { "type": "number", "description": "Market cap using realized share count" }, "mcap_realistic": { "type": "number", "description": "Market cap using realistic share count" }, "mcap_max": { "type": "number", "description": "Market cap using maximum share count" }, "realized_mNAV": { "type": "number", "description": "Realized mNAV ratio" }, "realistic_mNAV": { "type": "number", "description": "Realistic mNAV ratio" }, "max_mNAV": { "type": "number", "description": "Maximum mNAV ratio" }, "totalCost": { "type": "number", "description": "Total cost basis of crypto holdings" }, "totalUsdValue": { "type": "number", "description": "Total USD value of crypto holdings" }, "assets": { "type": "object", "additionalProperties": { "type": "object", "properties": { "amount": { "type": "number", "description": "Amount of asset held" }, "avgPrice": { "type": "number", "description": "Average purchase price" }, "usdValue": { "type": "number", "description": "Current USD value" }, "cost": { "type": "number", "description": "Total cost basis" } } }, "description": "Asset holdings by asset type" }, "assetsMeta": { "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string", "description": "Asset name", "example": "Bitcoin" }, "ticker": { "type": "string", "description": "Asset ticker", "example": "BTC" } } }, "description": "Metadata for assets held" }, "ohlcv": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Timestamp" }, { "type": "number", "description": "Open price" }, { "type": "number", "description": "High price" }, { "type": "number", "description": "Low price" }, { "type": "number", "description": "Close price" }, { "type": "number", "description": "Volume" } ] }, "description": "Historical OHLCV data" }, "assetValue": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Timestamp" }, { "type": "number", "description": "Asset value in USD" } ] }, "description": "Historical asset value data" }, "stats": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "description": "Timestamp" }, { "type": "number", "description": "Fully diluted shares - realized" }, { "type": "number", "description": "Fully diluted shares - realistic" }, { "type": "number", "description": "Fully diluted shares - maximum" }, { "type": "number", "description": "Market cap - realized" }, { "type": "number", "description": "Market cap - realistic" }, { "type": "number", "description": "Market cap - maximum" }, { "type": "number", "description": "mNAV - realized" }, { "type": "number", "description": "mNAV - realistic" }, { "type": "number", "description": "mNAV - maximum" } ] }, "description": "Compact historical stats: [timestamp, fd_realized, fd_realistic, fd_maximum, mcap_realized, mcap_realistic, mcap_max, mnav_realized, mnav_realistic, mnav_max]" }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Transaction ID" }, "asset": { "type": "string", "description": "Asset type", "example": "bitcoin" }, "amount": { "type": "string", "description": "Amount transacted" }, "avg_price": { "type": "string", "description": "Average price per unit" }, "usd_value": { "type": "string", "description": "Total USD value" }, "start_date": { "type": "string", "format": "date", "description": "Transaction start date" }, "end_date": { "type": "string", "format": "date", "description": "Transaction end date" }, "report_date": { "type": "string", "format": "date", "description": "Report date" }, "type": { "type": "string", "description": "Transaction type", "example": "purchase" }, "source_type": { "type": "string", "description": "Source type", "example": "filing" }, "source_url": { "type": "string", "description": "Source URL" }, "source_note": { "type": "string", "description": "Source note with transaction details" }, "is_approved": { "type": "boolean", "description": "Whether transaction is approved" }, "reject_reason": { "type": "string", "nullable": true, "description": "Rejection reason if not approved" }, "last_updated": { "type": "string", "format": "date-time", "description": "Last update timestamp" }, "ticker": { "type": "string", "description": "Institution ticker" }, "assetName": { "type": "string", "description": "Asset name" }, "assetTicker": { "type": "string", "description": "Asset ticker" } } }, "description": "Transaction history" }, "lastUpdated": { "type": "string", "format": "date-time", "description": "Last update timestamp" } } } } } } }, "x-codeSamples": [ { "lang": "javascript", "label": "JavaScript SDK", "source": "const result = await proClient.dat.getInstitution('MSTR')" }, { "lang": "python", "label": "Python SDK", "source": "result = pro_client.dat.getInstitution('')" } ] } }, "/equities/v1/companies-list": { "get": { "tags": ["Equities"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get list of all tracked public companies", "description": "Returns the tracked US-listed companies with their identity and sector and industry slugs, sorted by market cap (largest first). Use this to discover valid `ticker` + `country` pairs for the other equities endpoints.", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sector", "in": "query", "description": "Only return companies in this sector, as a slug (`technology`, `financial-services`) or as its label in any case (`Financial Services`). Valid values are the `sectorSlug`s returned by `GET /equities/v1/sectors`. An unknown value returns an empty list.", "required": false, "schema": { "type": "string", "example": "technology" } }, { "name": "industry", "in": "query", "description": "Only return companies in this industry, as a slug (`semiconductors`) or as its label in any case. Valid values are the `industrySlug`s returned by `GET /equities/v1/industries`. An unknown value returns an empty list.", "required": false, "schema": { "type": "string", "example": "semiconductors" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string", "example": "NVDA" }, "companyName": { "type": "string", "example": "NVIDIA Corporation" }, "country": { "type": "string", "example": "US" }, "countryName": { "type": "string", "example": "United States" }, "sectorSlug": { "type": "string", "description": "Sector id, the same value `GET /equities/v1/sectors` returns. `unknown` when the vendor left the company unclassified.", "example": "technology" }, "industrySlug": { "type": "string", "description": "Industry id, the same value `GET /equities/v1/industries` returns.", "example": "semiconductors" } } }, "example": [ { "ticker": "NVDA", "companyName": "NVIDIA Corporation", "country": "US", "countryName": "United States", "sectorSlug": "technology", "industrySlug": "semiconductors" }, { "ticker": "AAPL", "companyName": "Apple Inc.", "country": "US", "countryName": "United States", "sectorSlug": "technology", "industrySlug": "consumer-electronics" } ] } } } }, "500": { "description": "Invalid or missing API key (`{\"error\": \"API Key is wrong\"}`), or an internal server error" } } } }, "/equities/v1/statements": { "get": { "tags": ["Equities"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get financial statements for a company", "description": "Returns income statement, balance sheet, and cash flow statement for the given ticker, broken down by quarterly and annual periods.", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "ticker", "in": "query", "description": "Stock ticker symbol (case-insensitive)", "required": true, "schema": { "type": "string", "example": "COIN" } }, { "name": "country", "in": "query", "description": "Two-letter country code (ISO 3166-1 alpha-2) for the company, as returned by `GET /equities/v1/companies-list` (case-insensitive).", "required": true, "schema": { "type": "string", "example": "US" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "description": "Financial statements containing income statement, balance sheet, and cash flow data broken down by quarterly and annual periods.", "properties": { "incomeStatement": { "type": "object", "description": "Income statement data. The `labels` array defines the rows; `values` is a parallel array of arrays where each inner array holds one row's values across all periods.", "properties": { "labels": { "type": "array", "description": "Ordered list of income statement line items. Each index corresponds to an inner array in `quarterly.values` and `annual.values`.", "items": { "type": "string" }, "example": [ "Revenue", "Cost of Revenue", "Gross Profit", "Operating Expenses", "Operating Income", "Non-Operating Items", "Income Before Tax", "Income Tax", "Net Income", "Minority Interests", "Preferred Stock Dividends", "Net Income to Common", "Shares Outstanding (Basic)", "Shares Outstanding (Diluted)", "EPS (Basic)", "EPS (Diluted)", "EBIT", "EBITDA" ] }, "children": { "type": "object", "description": "Metadata describing which top-level labels have child breakdowns and what those child labels are, separately for quarterly and annual periods.", "properties": { "quarterly": { "type": "object", "description": "Child label definitions for quarterly data. Keys are parent label names from `labels`.", "additionalProperties": { "type": "object", "properties": { "labels": { "type": "array", "description": "Child line item names for this parent. Each index corresponds to an inner array in `quarterly.children[label].values`.", "items": { "type": "string" } } } } }, "annual": { "type": "object", "description": "Child label definitions for annual data. Keys are parent label names from `labels`.", "additionalProperties": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } } } } } } }, "quarterly": { "type": "object", "description": "Quarterly period data for the income statement.", "properties": { "periodEnding": { "type": "array", "description": "ISO 8601 date each quarter ended.", "items": { "type": "string", "format": "date" }, "example": ["2024-03-31", "2024-06-30", "2024-09-30", "2024-12-31"] }, "values": { "type": "array", "description": "Parallel to `labels`. Each inner array contains the values for that row across all `periodEnding` entries. Values may be `null` when not reported.", "items": { "type": "array", "items": { "type": "number", "nullable": true } } }, "children": { "type": "object", "description": "Breakdown data for parent labels that have sub-components. Keys match parent label names. Child labels are defined in `children.quarterly[label].labels`.", "additionalProperties": { "type": "object", "properties": { "values": { "type": "array", "description": "One inner array per child label, each containing values across all periods. Values may be `null`.", "items": { "type": "array", "items": { "type": "number", "nullable": true } } } } } } } }, "annual": { "type": "object", "description": "Annual period data for the income statement.", "properties": { "periodEnding": { "type": "array", "description": "ISO 8601 date each fiscal year ended.", "items": { "type": "string", "format": "date" }, "example": ["2022-12-31", "2023-12-31", "2024-12-31"] }, "values": { "type": "array", "description": "Parallel to `labels`. Each inner array contains the values for that row across all `periodEnding` entries. Values may be `null`.", "items": { "type": "array", "items": { "type": "number", "nullable": true } } }, "children": { "type": "object", "description": "Breakdown data for parent labels that have sub-components. Child labels are defined in `children.annual[label].labels`.", "additionalProperties": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "array", "items": { "type": "number", "nullable": true } } } } } } } } } }, "balanceSheet": { "type": "object", "description": "Balance sheet data. Follows the same structure as `incomeStatement`: top-level `labels`, `children` metadata, and `quarterly`/`annual` period objects each containing `periodEnding`, `values`, and `children`.", "properties": { "labels": { "type": "array", "description": "Ordered list of balance sheet line items.", "items": { "type": "string" }, "example": [ "Total Current Assets", "Total Non-Current Assets", "Total Assets", "Total Current Liabilities", "Total Non-Current Liabilities", "Total Liabilities", "Total Shareholders Equity", "Minority Interest", "Total Equity", "Total Liabilities and Equity" ] }, "children": { "type": "object", "properties": { "quarterly": { "type": "object", "additionalProperties": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } } } } }, "annual": { "type": "object", "additionalProperties": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } } } } } } }, "quarterly": { "type": "object", "properties": { "periodEnding": { "type": "array", "items": { "type": "string", "format": "date" } }, "values": { "type": "array", "items": { "type": "array", "items": { "type": "number", "nullable": true } } }, "children": { "type": "object", "additionalProperties": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "array", "items": { "type": "number", "nullable": true } } } } } } } }, "annual": { "type": "object", "properties": { "periodEnding": { "type": "array", "items": { "type": "string", "format": "date" } }, "values": { "type": "array", "items": { "type": "array", "items": { "type": "number", "nullable": true } } }, "children": { "type": "object", "additionalProperties": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "array", "items": { "type": "number", "nullable": true } } } } } } } } } }, "cashflow": { "type": "object", "description": "Cash flow statement data. Follows the same structure as `incomeStatement`: top-level `labels`, `children` metadata, and `quarterly`/`annual` period objects each containing `periodEnding`, `values`, and `children`.", "properties": { "labels": { "type": "array", "description": "Ordered list of cash flow line items.", "items": { "type": "string" }, "example": [ "Cash Flow from Operating Activities", "Cash Flow from Investing Activities", "Cash Flow from Financing Activities", "Net Cash Flow", "Free Cash Flow", "End Cash Position", "Income Tax Paid", "Interest Paid" ] }, "children": { "type": "object", "properties": { "quarterly": { "type": "object", "additionalProperties": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } } } } }, "annual": { "type": "object", "additionalProperties": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } } } } } } }, "quarterly": { "type": "object", "properties": { "periodEnding": { "type": "array", "items": { "type": "string", "format": "date" } }, "values": { "type": "array", "items": { "type": "array", "items": { "type": "number", "nullable": true } } }, "children": { "type": "object", "additionalProperties": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "array", "items": { "type": "number", "nullable": true } } } } } } } }, "annual": { "type": "object", "properties": { "periodEnding": { "type": "array", "items": { "type": "string", "format": "date" } }, "values": { "type": "array", "items": { "type": "array", "items": { "type": "number", "nullable": true } } }, "children": { "type": "object", "additionalProperties": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "array", "items": { "type": "number", "nullable": true } } } } } } } } } } } }, "example": { "incomeStatement": { "labels": [ "Revenue", "Cost of Revenue", "Gross Profit", "Operating Expenses", "Operating Income", "Non-Operating Items", "Income Before Tax", "Income Tax", "Net Income", "Minority Interests", "Preferred Stock Dividends", "Net Income to Common", "Shares Outstanding (Basic)", "Shares Outstanding (Diluted)", "EPS (Basic)", "EPS (Diluted)", "EBIT", "EBITDA" ], "children": { "quarterly": { "Operating Expenses": { "labels": [ "Research and Development", "Selling, General, and Administrative", "Other Operating Expenses" ] }, "Non-Operating Items": { "labels": [ "Non-Operating Interest Income", "Non-Operating Interest Expense", "Other Income/Expense" ] } }, "annual": { "Operating Expenses": { "labels": [ "Research and Development", "Selling, General, and Administrative", "Other Operating Expenses" ] }, "Non-Operating Items": { "labels": [ "Non-Operating Interest Income", "Non-Operating Interest Expense", "Other Income/Expense" ] } } }, "quarterly": { "periodEnding": ["2024-03-31", "2024-06-30", "2024-09-30", "2024-12-31"], "values": [ [1801112000, 2227962000, 1311908000, 2498462000], [234066000, 335426000, 197251000, 501181000], [1567046000, 1892536000, 1114657000, 1997281000], [987713000, 874725000, 791808000, 922324000], [579333000, 1017811000, 322849000, 1074957000], [8953000, -5844000, -20948000, -31784000], [588286000, 1011967000, 301901000, 1043173000], [123540000, 212513000, 63399000, 219066000], [464746000, 799454000, 238502000, 824107000], [0, 0, 0, 0], [0, 0, 0, 0], [464746000, 799454000, 238502000, 824107000], [243000000, 245000000, 247000000, 249000000], [256000000, 258000000, 260000000, 262000000], [1.91, 3.26, 0.97, 3.31], [1.82, 3.1, 0.92, 3.15], [588286000, 1011967000, 301901000, 1043173000], [678286000, 1101967000, 391901000, 1133173000] ], "children": { "Operating Expenses": { "values": [ [184225000, 291461000, 356264000, 459611000], [682257000, 535713000, 405395000, 461678000], [121231000, 47551000, 30149000, 1035000] ] }, "Non-Operating Items": { "values": [ [25000000, 28000000, 30000000, 32000000], [-12000000, -30000000, -45000000, -58000000], [-4047000, -3844000, -5948000, -5784000] ] } } }, "annual": { "periodEnding": ["2023-12-31", "2024-12-31"], "values": [ [3037428000, 7839444000], [811923000, 1267924000], [2225505000, 6571520000], [2890526000, 3576570000], [-665021000, 2994950000], [-54982000, -49623000], [-720003000, 2945327000], [-110000000, 615000000], [-610003000, 2330327000], [0, 0], [0, 0], [-610003000, 2330327000], [235000000, 246000000], [235000000, 259000000], [-2.6, 9.47], [-2.6, 9], [-720003000, 2945327000], [-540000000, 3300000000] ], "children": { "Operating Expenses": { "values": [[955264000, 1291561000], [1623040000, 2085743000], [312222000, 199266000]] }, "Non-Operating Items": { "values": [[85000000, 115000000], [-95000000, -145000000], [-44982000, -19623000]] } } } }, "balanceSheet": { "labels": [ "Total Current Assets", "Total Non-Current Assets", "Total Assets", "Total Current Liabilities", "Total Non-Current Liabilities", "Total Liabilities", "Total Shareholders Equity", "Minority Interest", "Total Equity", "Total Liabilities and Equity" ], "children": { "quarterly": { "Total Current Assets": { "labels": [ "Cash", "Cash Equivalents", "Cash and Cash Equivalents", "Other Short-Term Investments", "Accounts Receivable", "Other Receivables", "Inventory", "Prepaid Assets", "Restricted Cash", "Assets Held for Sale", "Hedging Assets", "Other Current Assets" ] }, "Total Non-Current Assets": { "labels": [ "Properties", "Land and Improvements", "Machinery, Furniture and Equipment", "Construction in Progress", "Leases", "Accumulated Depreciation", "Goodwill", "Investment Properties", "Financial Assets", "Intangible Assets", "Investments and Advances", "Other Non-Current Assets" ] }, "Total Current Liabilities": { "labels": [ "Accounts Payable", "Accrued Expenses", "Short-Term Debt", "Deferred Revenue", "Tax Payable", "Pensions", "Other Current Liabilities" ] }, "Total Non-Current Liabilities": { "labels": [ "Long-Term Provisions", "Long-Term Debt", "Provision for Risks and Charges", "Deferred Liabilities", "Derivative Product Liabilities", "Other Non-Current Liabilities" ] }, "Total Shareholders Equity": { "labels": [ "Common Stock", "Retained Earnings", "Other Shareholders' Equity", "Additional Paid-In Capital", "Treasury Stock" ] } }, "annual": { "Total Current Assets": { "labels": [ "Cash", "Cash Equivalents", "Cash and Cash Equivalents", "Other Short-Term Investments", "Accounts Receivable", "Other Receivables", "Inventory", "Prepaid Assets", "Restricted Cash", "Assets Held for Sale", "Hedging Assets", "Other Current Assets" ] }, "Total Non-Current Assets": { "labels": [ "Properties", "Land and Improvements", "Machinery, Furniture and Equipment", "Construction in Progress", "Leases", "Accumulated Depreciation", "Goodwill", "Investment Properties", "Financial Assets", "Intangible Assets", "Investments and Advances", "Other Non-Current Assets" ] }, "Total Current Liabilities": { "labels": [ "Accounts Payable", "Accrued Expenses", "Short-Term Debt", "Deferred Revenue", "Tax Payable", "Pensions", "Other Current Liabilities" ] }, "Total Non-Current Liabilities": { "labels": [ "Long-Term Provisions", "Long-Term Debt", "Provision for Risks and Charges", "Deferred Liabilities", "Derivative Product Liabilities", "Other Non-Current Liabilities" ] }, "Total Shareholders Equity": { "labels": [ "Common Stock", "Retained Earnings", "Other Shareholders' Equity", "Additional Paid-In Capital", "Treasury Stock" ] } } }, "quarterly": { "periodEnding": ["2024-03-31", "2024-06-30", "2024-09-30", "2024-12-31"], "values": [ [79373000, 204728000, 209604000, 215571000], [126996000, 248147000, 250536000, 254181000], [206369000, 452875000, 460140000, 469752000], [108736000, 110517000, 111958000, 113465000], [108736000, 110517000, 111958000, 113465000], [217472000, 221034000, 223916000, 226930000], [231489000, 234641000, 237270000, 314164000], [0, 0, 0, 0], [231489000, 234641000, 237270000, 314164000], [448961000, 455675000, 461186000, 541094000] ], "children": {} }, "annual": { "periodEnding": ["2023-12-31", "2024-12-31"], "values": [ [217472000, 226930000], [217472000, 226930000], [434944000, 453860000], [110517000, 113465000], [110517000, 113465000], [221034000, 226930000], [234641000, 314164000], [0, 0], [234641000, 314164000], [455675000, 541094000] ], "children": {} } }, "cashflow": { "labels": [ "Cash Flow from Operating Activities", "Cash Flow from Investing Activities", "Cash Flow from Financing Activities", "Net Cash Flow", "Free Cash Flow", "End Cash Position", "Income Tax Paid", "Interest Paid" ], "children": { "quarterly": { "Cash Flow from Operating Activities": { "labels": [ "Net Income", "Depreciation", "Deferred Taxes", "Stock-Based Compensation", "Other Non-Cash Items", "Accounts Receivable", "Accounts Payable", "Other Assets and Liabilities" ] }, "Cash Flow from Investing Activities": { "labels": [ "Capital Expenditures", "Net Intangibles", "Net Acquisitions", "Purchase of Investments", "Sale of Investments", "Other Investing Activity" ] }, "Cash Flow from Financing Activities": { "labels": [ "Long-Term Debt Issuance", "Long-Term Debt Payments", "Short-Term Debt Issuance", "Common Stock Issuance", "Common Stock Repurchase", "Common Dividends", "Other Financing Charges" ] } }, "annual": { "Cash Flow from Operating Activities": { "labels": [ "Net Income", "Depreciation", "Deferred Taxes", "Stock-Based Compensation", "Other Non-Cash Items", "Accounts Receivable", "Accounts Payable", "Other Assets and Liabilities" ] }, "Cash Flow from Investing Activities": { "labels": [ "Capital Expenditures", "Net Intangibles", "Net Acquisitions", "Purchase of Investments", "Sale of Investments", "Other Investing Activity" ] }, "Cash Flow from Financing Activities": { "labels": [ "Long-Term Debt Issuance", "Long-Term Debt Payments", "Short-Term Debt Issuance", "Common Stock Issuance", "Common Stock Repurchase", "Common Dividends", "Other Financing Charges" ] } } }, "quarterly": { "periodEnding": ["2024-03-31", "2024-06-30", "2024-09-30", "2024-12-31"], "values": [ [234066000, 335426000, 197251000, 501181000], [-121231000, -248195000, -242642000, -297324000], [-98771300, -87472500, -29180800, -92232400], [14063400, -291300, -74572000, 111624400], [112835000, 87231000, -45391000, 203857000], [450000000, 449708700, 375136700, 486761100], [123540000, 212513000, 63399000, 219066000], [12000000, 30000000, 45000000, 58000000] ], "children": {} }, "annual": { "periodEnding": ["2023-12-31", "2024-12-31"], "values": [ [277826000, 317042000], [-413578000, -362519000], [-55446300, 103406900], [-191198300, 57929900], [-135752000, -45477000], [450000000, 507929900], [110000000, 615000000], [95000000, 145000000] ], "children": {} } } } } } }, "404": { "description": "Missing, malformed or untracked `ticker` or `country` (`{\"error\": \"Not found\"}`)" }, "500": { "description": "Invalid or missing API key (`{\"error\": \"API Key is wrong\"}`), or an internal server error" } } } }, "/equities/v1/dimensions": { "get": { "tags": ["Equities"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get financial dimensions for a company", "description": "Returns time-series financial dimension metrics (revenue, holders revenue, earnings, and basic shares outstanding) for the given ticker, each broken down into annual and quarterly series. Every data point is a two-element array: ISO 8601 period-ending date, then the numeric value. Series are sorted by date descending (newest first).", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "ticker", "in": "query", "description": "Stock ticker symbol (case-insensitive)", "required": true, "schema": { "type": "string", "example": "COIN" } }, { "name": "country", "in": "query", "description": "Two-letter country code (ISO 3166-1 alpha-2) for the company, as returned by `GET /equities/v1/companies-list` (case-insensitive).", "required": true, "schema": { "type": "string", "example": "US" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "description": "Map of metric name to its annual and quarterly time series. Keys vary by company and by which metrics are available (for example `revenue`, `holdersRevenue`, `earnings`, `basicSharesOutstanding`).", "additionalProperties": { "type": "object", "description": "A single dimension metric, split into annual and quarterly series.", "properties": { "annual": { "type": "array", "description": "Annual data points, newest first. Each item is `[periodEnding, value]`.", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "anyOf": [ { "type": "string", "description": "ISO 8601 period-ending date" }, { "type": "number", "description": "Metric value" } ] } } }, "quarterly": { "type": "array", "description": "Quarterly data points, newest first. Each item is `[periodEnding, value]`.", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "anyOf": [ { "type": "string", "description": "ISO 8601 period-ending date" }, { "type": "number", "description": "Metric value" } ] } } } } }, "example": { "revenue": { "annual": [["2025-12-31", 7181325000], ["2024-12-31", 6564028000], ["2023-12-31", 3108383000]], "quarterly": [["2026-03-31", 1412982000], ["2025-12-31", 1781129000], ["2025-09-30", 1868693000]] }, "holdersRevenue": { "annual": [["2025-12-31", 790195000]], "quarterly": [["2026-03-31", 1062234000]] }, "earnings": { "annual": [["2025-12-31", 1260327000], ["2024-12-31", 2577755000], ["2023-12-31", 94752000]], "quarterly": [["2026-03-31", -394117000], ["2025-12-31", -666733000], ["2025-09-30", 432552000]] }, "basicSharesOutstanding": { "annual": [["2025-12-31", 254730000], ["2024-12-31", 245186000], ["2023-12-31", 234258000]], "quarterly": [["2026-03-31", 258413000], ["2025-12-31", 256109000], ["2025-09-30", 254730000]] } } } } } }, "404": { "description": "Missing, malformed or untracked `ticker` or `country` (`{\"error\": \"Not found\"}`)" }, "500": { "description": "Invalid or missing API key (`{\"error\": \"API Key is wrong\"}`), or an internal server error" } } } }, "/equities/v1/price-history": { "get": { "tags": ["Equities"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get historical price data for a company", "description": "Returns closing prices as two-element arrays: ISO 8601 date-time string, then numeric price. Sorted by date descending (newest first). Resolution follows `timeframe`: `1D`, `7D` and `1W` are 5-minute intraday bars whose date-time carries a real time of day, while `1M` and longer are daily closes stamped `T00:00:00Z`.", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "ticker", "in": "query", "description": "Stock ticker symbol (case-insensitive)", "required": true, "schema": { "type": "string", "example": "AAPL" } }, { "name": "country", "in": "query", "description": "Two-letter country code (ISO 3166-1 alpha-2) for the company, as returned by `GET /equities/v1/companies-list` (case-insensitive).", "required": true, "schema": { "type": "string", "example": "US" } }, { "name": "timeframe", "in": "query", "description": "Optional lookback window (case-insensitive). `1D` returns the most recent trading session and `7D`/`1W` (aliases) the last 7 days, both at 5-minute resolution; `1M` and longer are daily. `YTD` runs from January 1 of the current year. Omit or empty for full history (`MAX`). Intraday coverage is best-effort — a ticker without intraday data falls back to daily bars, and `1D` then returns the single most recent daily bar.", "required": false, "schema": { "type": "string", "enum": ["1D", "7D", "1W", "1M", "3M", "6M", "YTD", "1Y", "5Y", "MAX"], "default": "MAX", "example": "1Y" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "description": "Each item is `[timestamp, price]`: ISO 8601 string, then closing price.", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "anyOf": [ { "type": "string", "description": "ISO 8601 date-time" }, { "type": "number", "description": "Closing price" } ] } }, "example": [["2026-03-20T00:00:00Z", 247.99], ["2026-03-19T00:00:00Z", 248.96]] }, "examples": { "daily": { "summary": "Daily closes — `1M` and longer, or `MAX`", "description": "Daily bars are stamped `T00:00:00Z`.", "value": [["2026-03-20T00:00:00Z", 247.99], ["2026-03-19T00:00:00Z", 248.96]] }, "intraday": { "summary": "5-minute bars — `1D`, `7D`, `1W`", "description": "Intraday bars carry a real time of day. These are the last three bars of a session.", "value": [ ["2026-06-05T19:55:00Z", 251.34], ["2026-06-05T19:50:00Z", 251.11], ["2026-06-05T19:45:00Z", 250.88] ] } } } } }, "404": { "description": "Missing, malformed or untracked `ticker` or `country`, or an unsupported `timeframe` (`{\"error\": \"Not found\"}`)" }, "500": { "description": "Invalid or missing API key (`{\"error\": \"API Key is wrong\"}`), or an internal server error" } } } }, "/equities/v1/ohlcv": { "get": { "tags": ["Equities"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get OHLCV candle data for a company", "description": "Returns OHLCV bars as six-number arrays: Unix timestamp in seconds (UTC), open, high, low, close, volume. Sorted by time descending (newest first). Optional `timeframe` controls both how far back data goes and the bar resolution: `1D`, `7D` and `1W` return 5-minute bars, `1M` and longer return daily bars. Omit or empty for full history (`MAX`).", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "ticker", "in": "query", "description": "Stock ticker symbol (case-insensitive)", "required": true, "schema": { "type": "string", "example": "AAPL" } }, { "name": "country", "in": "query", "description": "Two-letter country code (ISO 3166-1 alpha-2) for the company, as returned by `GET /equities/v1/companies-list` (case-insensitive).", "required": true, "schema": { "type": "string", "example": "US" } }, { "name": "timeframe", "in": "query", "description": "Optional lookback window (case-insensitive), same values as price history. `1D` returns the most recent trading session and `7D`/`1W` (aliases) the last 7 days, both as 5-minute bars; `1M` and longer are daily bars. `YTD` runs from January 1 of the current year. Omit or empty for full history (`MAX`). Intraday coverage is best-effort — a ticker without intraday data falls back to daily bars.", "required": false, "schema": { "type": "string", "enum": ["1D", "7D", "1W", "1M", "3M", "6M", "YTD", "1Y", "5Y", "MAX"], "default": "MAX", "example": "6M" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "description": "Each item is `[timestamp, open, high, low, close, volume]`. `timestamp` is Unix epoch seconds (UTC).", "items": { "type": "array", "minItems": 6, "maxItems": 6, "items": { "type": "number" } }, "example": [ [1773964800, 247.98, 249.2, 246, 247.99, 88268000], [1773878400, 249.4, 251.83, 247.3, 248.96, 34864100] ] }, "examples": { "daily": { "summary": "Daily bars — `1M` and longer, or `MAX`", "description": "One bar per trading day, timestamped at midnight UTC.", "value": [ [1773964800, 247.98, 249.2, 246, 247.99, 88268000], [1773878400, 249.4, 251.83, 247.3, 248.96, 34864100] ] }, "intraday": { "summary": "5-minute bars — `1D`, `7D`, `1W`", "description": "One bar per 5 minutes of the session. These are the last three bars of a session.", "value": [ [1780689300, 251.12, 251.4, 251.05, 251.34, 412300], [1780689000, 250.9, 251.2, 250.82, 251.11, 388120], [1780688700, 250.75, 250.95, 250.7, 250.88, 351940] ] } } } } }, "404": { "description": "Missing, malformed or untracked `ticker` or `country`, or an unsupported `timeframe` (`{\"error\": \"Not found\"}`)" }, "500": { "description": "Invalid or missing API key (`{\"error\": \"API Key is wrong\"}`), or an internal server error" } } } }, "/equities/v1/summary": { "get": { "tags": ["Equities"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get live market summary for a company", "description": "Returns current market data for a single ticker. This is a compact snapshot (no `ticker` / `name` fields); use `GET /equities/v1/companies-list` for the list of tracked companies with their identity details.", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "ticker", "in": "query", "description": "Stock ticker symbol (case-insensitive)", "required": true, "schema": { "type": "string", "example": "AAPL" } }, { "name": "country", "in": "query", "description": "Two-letter country code (ISO 3166-1 alpha-2) for the company, as returned by `GET /equities/v1/companies-list` (case-insensitive).", "required": true, "schema": { "type": "string", "example": "US" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "currentPrice": { "type": "number", "example": 159.73 }, "volume": { "type": "number", "example": 6475902 }, "marketCap": { "type": "number", "example": 42074657239.22 }, "circulatingMarketCap": { "type": "number", "nullable": true, "example": 35036279538.35 }, "enterpriseValue": { "type": "number", "nullable": true, "example": 39601081568.22 }, "fiftyTwoWeekHigh": { "type": "number", "example": 444.65 }, "fiftyTwoWeekLow": { "type": "number", "example": 139.36 }, "dividendYield": { "type": "number", "nullable": true, "example": null }, "trailingPE": { "type": "number", "nullable": true, "example": 52.55 }, "priceToRevenue": { "type": "number", "nullable": true, "example": 6.414 }, "priceChangePercentage1d": { "type": "number", "example": -0.4363 }, "priceChangePercentage7d": { "type": "number", "example": 4.843 }, "priceChangePercentage1m": { "type": "number", "example": -20.82 }, "priceChange1d": { "type": "number", "example": -0.7 }, "marketCapChange1d": { "type": "number", "example": -184387779.8 }, "priceToBook": { "type": "number", "nullable": true, "example": 3.121 }, "enterpriseValueToEbitda": { "type": "number", "nullable": true, "example": 40.48 }, "holdersYield": { "type": "number", "nullable": true, "example": 2.525 }, "updatedAt": { "type": "string", "format": "date-time", "example": "2026-06-12T19:59:00Z" }, "revenueTTM": { "type": "number", "nullable": true, "example": 6560012000 }, "grossProfitTTM": { "type": "number", "nullable": true, "example": 4812835000 }, "earningsTTM": { "type": "number", "nullable": true, "example": 800602000 }, "ebitdaTTM": { "type": "number", "nullable": true, "example": 978345000 }, "operatingProfitMarginTTM": { "type": "number", "nullable": true, "example": 11.12 }, "holdersRevenueTTM": { "type": "number", "nullable": true, "example": 1062234000 }, "holderEarningsTTM": { "type": "number", "nullable": true, "example": 1062234000 }, "dividendsTTM": { "type": "number", "nullable": true, "example": 0 }, "stockRepurchaseTTM": { "type": "number", "nullable": true, "example": 1062234000 }, "stockIssuanceTTM": { "type": "number", "nullable": true, "example": 0 }, "stockBasedCompensationTTM": { "type": "number", "nullable": true, "example": 896766000 }, "cashAndCashEquivalents": { "type": "number", "nullable": true, "example": 10205022000 }, "totalAssets": { "type": "number", "nullable": true, "example": 28848792000 }, "totalLiabilities": { "type": "number", "nullable": true, "example": 15368219000 }, "totalShareholdersEquity": { "type": "number", "nullable": true, "example": 13480573000 }, "totalDebt": { "type": "number", "nullable": true, "example": 7964423000 }, "circulatingSupply": { "type": "number", "nullable": true, "example": 219346895 }, "totalSupply": { "type": "number", "nullable": true, "example": 263411114 }, "employeeCount": { "type": "integer", "nullable": true, "example": 4951 } } } } } }, "404": { "description": "Missing, malformed or untracked `ticker` or `country` (`{\"error\": \"Not found\"}`)" }, "500": { "description": "Invalid or missing API key (`{\"error\": \"API Key is wrong\"}`), or an internal server error" } } } }, "/equities/v1/filings": { "get": { "tags": ["Equities"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get filings for a company", "description": "Returns a list of company filings (such as annual reports, quarterly reports, and other important filings) for the given ticker, sorted by filing date descending (newest first).", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "ticker", "in": "query", "description": "Stock ticker symbol (case-insensitive)", "required": true, "schema": { "type": "string", "example": "COIN" } }, { "name": "country", "in": "query", "description": "Two-letter country code (ISO 3166-1 alpha-2) for the company, as returned by `GET /equities/v1/companies-list` (case-insensitive).", "required": true, "schema": { "type": "string", "example": "US" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "filingDate": { "type": "string", "format": "date", "example": "2025-02-28" }, "reportDate": { "type": "string", "format": "date", "example": "2024-12-31" }, "form": { "type": "string", "example": "10-K" }, "primaryDocumentUrl": { "type": "string", "format": "uri", "example": "https://www.sec.gov/Archives/edgar/data/1679788/0001679788-25-000123/0001679788-25-000123.htm" }, "documentDescription": { "type": "string", "example": "Annual Report" } } } } } } }, "404": { "description": "Missing, malformed or untracked `ticker` or `country` (`{\"error\": \"Not found\"}`)" }, "500": { "description": "Invalid or missing API key (`{\"error\": \"API Key is wrong\"}`), or an internal server error" } } } }, "/equities/v1/onchain": { "get": { "tags": ["Equities"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get on-chain tradeable markets for a company", "description": "Returns where the stock can be traded on-chain: `perps` are perpetual futures markets across exchanges, and `tokens` are tokenised-equity issuers. This is a live snapshot refreshed hourly and no history is kept. On-chain data is only collected for US-listed tickers, so a ticker in another market comes back with empty `perps` and `tokens` arrays rather than an error.", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "ticker", "in": "query", "description": "Stock ticker symbol (case-insensitive)", "required": true, "schema": { "type": "string", "example": "AAPL" } }, { "name": "country", "in": "query", "description": "Two-letter country code (ISO 3166-1 alpha-2) for the company, as returned by `GET /equities/v1/companies-list` (case-insensitive).", "required": true, "schema": { "type": "string", "example": "US" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "perps": { "type": "array", "description": "Perpetual futures markets tracking the stock.", "items": { "type": "object", "properties": { "pair": { "type": "string", "description": "Market pair as the venue names it.", "example": "AAPL-USDC" }, "price": { "type": "number", "nullable": true, "description": "Last traded price of the contract, in USD.", "example": 307.86 }, "volume24h": { "type": "number", "nullable": true, "description": "24 hour volume, in USD.", "example": 1823545.15 }, "openInterest": { "type": "number", "nullable": true, "description": "Open interest, in USD.", "example": 24278916.49 }, "annualizedFundingRate": { "type": "number", "nullable": true, "description": "Annualised funding rate, in percent, so `-70.13` is -70.13% a year. Negative means shorts pay longs.", "example": -70.13 }, "tradeUrl": { "type": "string", "description": "Direct link to the market on the venue.", "example": "https://app.hyperliquid.xyz/trade/xyz:AAPL" }, "contractSlug": { "type": "string", "description": "DefiLlama market identifier, `{venue}:{symbol}`.", "example": "xyz:AAPL" }, "exchangeProtocolSlug": { "type": "string", "description": "DefiLlama protocol slug for the exchange, when it has one.", "example": "hyperliquid-perps" }, "rwaPlatformSlug": { "type": "string", "description": "DefiLlama RWA platform slug for the venue, when it has one.", "example": "trade-xyz" }, "exchangeType": { "type": "string", "enum": ["CEX", "DEX"], "description": "Whether the venue is a centralised or an on-chain exchange.", "example": "DEX" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When this market was last refreshed.", "example": "2026-06-07T10:04:21Z" } } } }, "tokens": { "type": "array", "description": "Tokenised equity products tracking the stock.", "items": { "type": "object", "properties": { "issuer": { "type": "string", "description": "Legal entity issuing the tokenised share, not the listed company.", "example": "Backed Assets (JE) Limited" }, "issuerRwaPlatformSlug": { "type": "string", "description": "DefiLlama RWA platform slug for the issuer.", "example": "backed-finance" }, "price": { "type": "number", "nullable": true, "description": "Token price, in USD.", "example": 308.7 }, "assetSlug": { "type": "string", "description": "Token symbol as the issuer lists it.", "example": "AAPLx" }, "activeMarketcap": { "type": "number", "nullable": true, "description": "Market cap of the token across active markets, in USD. `null` when no market reports one.", "example": 30068771 } } } } }, "example": { "perps": [ { "pair": "AAPL-USDC", "price": 307.86, "volume24h": 1823545.15, "openInterest": 24278916.49, "annualizedFundingRate": -70.13, "tradeUrl": "https://app.hyperliquid.xyz/trade/xyz:AAPL", "contractSlug": "xyz:AAPL", "exchangeProtocolSlug": "hyperliquid-perps", "rwaPlatformSlug": "trade-xyz", "exchangeType": "DEX", "updatedAt": "2026-06-07T10:04:21Z" } ], "tokens": [ { "issuer": "Backed Assets (JE) Limited", "issuerRwaPlatformSlug": "backed-finance", "price": 308.7, "assetSlug": "AAPLx", "activeMarketcap": 30068771 } ] } } } } }, "404": { "description": "Missing, malformed or untracked `ticker` or `country` (`{\"error\": \"Not found\"}`)" }, "500": { "description": "Invalid or missing API key (`{\"error\": \"API Key is wrong\"}`), or an internal server error" } } } }, "/equities/v1/sectors": { "get": { "tags": ["Equities"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get all sectors", "description": "Returns one row per sector, sorted by market cap (largest first): market cap and weight, traded value, valuation ratios, price changes over seven windows, and the three largest holdings.\n\nCovers US-listed companies. All monetary values are in USD.\n\nSector and industry names come from the data vendor (a Morningstar-style list of 11 sectors and about 140 industries), not GICS. Companies with no sector are grouped as `Unknown` rather than dropped, so sector market caps add up to the market total.\n\nRatios such as `trailingPE` are aggregates (total market cap / total earnings), so the group is valued as one company rather than averaging its constituents' ratios. Price changes are weighted by market cap at the start of each window. Percentages are in percent, not fractions: `1.82` means +1.82%.", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "sector": { "type": "string", "description": "Sector name as the data vendor labels it (not GICS). Companies the vendor left unclassified roll up into `Unknown`.", "example": "Technology" }, "sectorSlug": { "type": "string", "description": "URL-safe sector id. Pass it as `sector` to the other equities endpoints.", "example": "technology" }, "rank": { "type": "integer", "description": "Position by market cap, starting at 1.", "example": 1 }, "weight": { "type": "number", "nullable": true, "description": "Share of all tracked US equity market cap, in percent. Sums to 100 across sectors, `Unknown` included.", "example": 35.54 }, "dollarVolumeShare24h": { "type": "number", "nullable": true, "description": "Share of all tracked US value traded in the latest session, in percent.", "example": 40.1 }, "industryCount": { "type": "integer", "description": "Number of distinct industries in the sector.", "example": 12 }, "marketCap": { "type": "number", "nullable": true, "description": "Total market cap of the constituents, in USD.", "example": 29484487070530.91 }, "marketCapChange1d": { "type": "number", "nullable": true, "description": "Change in total market cap over the latest session, in USD. Reconciles exactly with `priceChangePercentage1d`.", "example": 251664986364.37 }, "dollarVolume24h": { "type": "number", "nullable": true, "description": "Value traded in the latest session (shares traded × price, summed), in USD. Reads low while a session is still open; `volumeAsOf` says when it was taken.", "example": 233706720783.08 }, "revenueTTM": { "type": "number", "nullable": true, "description": "Total trailing twelve month revenue, in USD.", "example": 3618619651351 }, "earningsTTM": { "type": "number", "nullable": true, "description": "Total trailing twelve month earnings, in USD.", "example": 729280268773 }, "ebitdaTTM": { "type": "number", "nullable": true, "description": "Total trailing twelve month EBITDA, in USD.", "example": 1159818834166 }, "enterpriseValue": { "type": "number", "nullable": true, "description": "Total enterprise value, in USD.", "example": 30012989630394.37 }, "employeeCount": { "type": "number", "nullable": true, "description": "Total employees across the constituents that report a headcount. `null` when none do.", "example": 6808759 }, "trailingPE": { "type": "number", "nullable": true, "description": "Aggregate price to earnings: total market cap / total TTM earnings. `null` when total earnings are zero or negative; use `earningsYield` then.", "example": 40.3 }, "earningsYield": { "type": "number", "nullable": true, "description": "100 × total TTM earnings / total market cap, in percent. Signed, so it stays defined when `trailingPE` is `null` for a loss-making group.", "example": 2.482 }, "priceToRevenue": { "type": "number", "nullable": true, "description": "Aggregate price to sales: total market cap / total TTM revenue.", "example": 8.121 }, "priceToBook": { "type": "number", "nullable": true, "description": "Aggregate price to book: total market cap / total shareholders' equity.", "example": 12.1 }, "enterpriseValueToEbitda": { "type": "number", "nullable": true, "description": "Aggregate EV/EBITDA: total enterprise value / total TTM EBITDA.", "example": 25.8 }, "dividendYield": { "type": "number", "nullable": true, "description": "100 × total TTM dividends / total market cap, in percent.", "example": 0.5053 }, "holdersYield": { "type": "number", "nullable": true, "description": "100 × total TTM holders' revenue (dividends plus buybacks, net of share issuance) / total market cap, in percent.", "example": 1.719 }, "operatingProfitMarginTTM": { "type": "number", "nullable": true, "description": "Total TTM operating income / total TTM revenue, in percent. Weighted by revenue, not market cap.", "example": 24.65 }, "priceChangePercentage1d": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the latest session, in percent (`0.86` is +0.86%).", "example": 0.861 }, "priceChangePercentage7d": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 7 days, in percent.", "example": 2.951 }, "priceChangePercentage1m": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 30 days, in percent.", "example": 6.681 }, "priceChangePercentage3m": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 3 calendar months, in percent.", "example": 11.65 }, "priceChangePercentage6m": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 6 calendar months, in percent.", "example": 45.56 }, "priceChangePercentageYtd": { "type": "number", "nullable": true, "description": "Cap-weighted price change since January 1, in percent.", "example": 29.18 }, "priceChangePercentage1y": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last year, in percent.", "example": 30.25 }, "companyCount": { "type": "integer", "description": "Number of constituents.", "example": 475 }, "coverage": { "type": "object", "description": "Share of the constituents' market cap that supplied each metric's inputs, from 0 to 1, keyed by metric name. A ratio is served as `null` when its coverage is below 0.6, rather than as a figure computed over the wrong subset.", "additionalProperties": { "type": "number", "minimum": 0, "maximum": 1 }, "example": { "priceChangePercentage1d": 1, "priceChangePercentage7d": 1, "priceChangePercentage1m": 1, "priceChangePercentage3m": 0.9998, "priceChangePercentage6m": 0.9979, "priceChangePercentageYtd": 0.9976, "priceChangePercentage1y": 0.9964, "trailingPE": 0.9967, "earningsYield": 0.9967, "priceToRevenue": 0.9967, "priceToBook": 1, "enterpriseValueToEbitda": 0.9967, "dividendYield": 0.8057, "holdersYield": 0.9594, "operatingProfitMarginTTM": 0.9967 } }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true, "description": "Most recent quote time across the constituents.", "example": "2026-09-25T19:59:00Z" }, "volumeAsOf": { "type": "string", "format": "date-time", "nullable": true, "description": "When `dollarVolume24h` was taken.", "example": "2026-09-25T19:59:00Z" }, "topHoldings": { "type": "array", "description": "The three largest constituents by market cap. `GET /equities/v1/sector` returns ten.", "items": { "type": "object", "properties": { "ticker": { "type": "string", "example": "NVDA" }, "name": { "type": "string", "example": "NVIDIA Corporation" }, "marketCap": { "type": "number", "nullable": true, "description": "Market cap, in USD.", "example": 5451313781934.43 }, "sectorWeight": { "type": "number", "nullable": true, "description": "Share of this sector's market cap, in percent.", "example": 18.49 }, "priceChangePercentage1d": { "type": "number", "nullable": true, "description": "Price change over the latest session, in percent.", "example": 0.2182 } } } } } }, "example": [ { "sector": "Technology", "sectorSlug": "technology", "marketCap": 29484487070530.91, "marketCapChange1d": 251664986364.37, "dollarVolume24h": 233706720783.08, "revenueTTM": 3618619651351, "earningsTTM": 729280268773, "ebitdaTTM": 1159818834166, "enterpriseValue": 30012989630394.37, "employeeCount": 6808759, "trailingPE": 40.3, "earningsYield": 2.482, "priceToRevenue": 8.121, "priceToBook": 12.1, "enterpriseValueToEbitda": 25.8, "dividendYield": 0.5053, "holdersYield": 1.719, "operatingProfitMarginTTM": 24.65, "priceChangePercentage1d": 0.861, "priceChangePercentage7d": 2.951, "priceChangePercentage1m": 6.681, "priceChangePercentage3m": 11.65, "priceChangePercentage6m": 45.56, "priceChangePercentageYtd": 29.18, "priceChangePercentage1y": 30.25, "companyCount": 475, "coverage": { "priceChangePercentage1d": 1, "priceChangePercentage7d": 1, "priceChangePercentage1m": 1, "priceChangePercentage3m": 0.9998, "priceChangePercentage6m": 0.9979, "priceChangePercentageYtd": 0.9976, "priceChangePercentage1y": 0.9964, "trailingPE": 0.9967, "earningsYield": 0.9967, "priceToRevenue": 0.9967, "priceToBook": 1, "enterpriseValueToEbitda": 0.9967, "dividendYield": 0.8057, "holdersYield": 0.9594, "operatingProfitMarginTTM": 0.9967 }, "weight": 35.54, "dollarVolumeShare24h": 40.1, "industryCount": 12, "topHoldings": [ { "ticker": "NVDA", "name": "NVIDIA Corporation", "marketCap": 5451313781934.43, "sectorWeight": 18.49, "priceChangePercentage1d": 0.2182 }, { "ticker": "AAPL", "name": "Apple Inc.", "marketCap": 5009416613731.49, "sectorWeight": 16.99, "priceChangePercentage1d": 1.533 }, { "ticker": "MSFT", "name": "Microsoft Corporation Common Stock", "marketCap": 3833594441460, "sectorWeight": 13, "priceChangePercentage1d": 3.663 } ], "updatedAt": "2026-09-25T19:59:00Z", "volumeAsOf": "2026-09-25T19:59:00Z", "rank": 1 } ] } } } }, "404": { "description": "Sector data not published yet" }, "500": { "description": "Invalid or missing API key (`{\"error\": \"API Key is wrong\"}`), or an internal server error" } } } }, "/equities/v1/sectors-overview": { "get": { "tags": ["Equities"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get market-wide sector overview", "description": "Returns totals across all tracked US companies, which the per-sector rows cannot carry: the market cap every sector `weight` is measured against, aggregate and median valuation ratios for the whole market, and the best, worst, and largest sector.\n\nThe constituents here are every tracked US company. Fields shared with `GET /equities/v1/sectors` mean the same thing.\n\nCovers US-listed companies. All monetary values are in USD.", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "marketCap": { "type": "number", "nullable": true, "description": "Total market cap of the constituents, in USD.", "example": 82964660714713.33 }, "marketCapChange1d": { "type": "number", "nullable": true, "description": "Change in total market cap over the latest session, in USD. Reconciles exactly with `priceChangePercentage1d`.", "example": 345803139721.38 }, "dollarVolume24h": { "type": "number", "nullable": true, "description": "Value traded in the latest session (shares traded × price, summed), in USD. Reads low while a session is still open; `volumeAsOf` says when it was taken.", "example": 582767711903.08 }, "revenueTTM": { "type": "number", "nullable": true, "description": "Total trailing twelve month revenue, in USD.", "example": 24757148479483 }, "earningsTTM": { "type": "number", "nullable": true, "description": "Total trailing twelve month earnings, in USD.", "example": 2642725287768 }, "ebitdaTTM": { "type": "number", "nullable": true, "description": "Total trailing twelve month EBITDA, in USD.", "example": 4436690488724 }, "enterpriseValue": { "type": "number", "nullable": true, "description": "Total enterprise value, in USD.", "example": 100074056247123.19 }, "employeeCount": { "type": "number", "nullable": true, "description": "Total employees across the constituents that report a headcount. `null` when none do.", "example": 45614558 }, "trailingPE": { "type": "number", "nullable": true, "description": "Aggregate price to earnings: total market cap / total TTM earnings. `null` when total earnings are zero or negative; use `earningsYield` then.", "example": 30.43 }, "earningsYield": { "type": "number", "nullable": true, "description": "100 × total TTM earnings / total market cap, in percent. Signed, so it stays defined when `trailingPE` is `null` for a loss-making group.", "example": 3.287 }, "priceToRevenue": { "type": "number", "nullable": true, "description": "Aggregate price to sales: total market cap / total TTM revenue.", "example": 3.247 }, "priceToBook": { "type": "number", "nullable": true, "description": "Aggregate price to book: total market cap / total shareholders' equity.", "example": 4.871 }, "enterpriseValueToEbitda": { "type": "number", "nullable": true, "description": "Aggregate EV/EBITDA: total enterprise value / total TTM EBITDA.", "example": 18.39 }, "dividendYield": { "type": "number", "nullable": true, "description": "100 × total TTM dividends / total market cap, in percent.", "example": 1.344 }, "holdersYield": { "type": "number", "nullable": true, "description": "100 × total TTM holders' revenue (dividends plus buybacks, net of share issuance) / total market cap, in percent.", "example": 2.915 }, "operatingProfitMarginTTM": { "type": "number", "nullable": true, "description": "Total TTM operating income / total TTM revenue, in percent. Weighted by revenue, not market cap.", "example": 13.77 }, "priceChangePercentage1d": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the latest session, in percent (`0.86` is +0.86%).", "example": 0.4196 }, "priceChangePercentage7d": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 7 days, in percent.", "example": 0.8979 }, "priceChangePercentage1m": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 30 days, in percent.", "example": 0.3504 }, "priceChangePercentage3m": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 3 calendar months, in percent.", "example": 3.812 }, "priceChangePercentage6m": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 6 calendar months, in percent.", "example": 20.51 }, "priceChangePercentageYtd": { "type": "number", "nullable": true, "description": "Cap-weighted price change since January 1, in percent.", "example": 12.33 }, "priceChangePercentage1y": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last year, in percent.", "example": 15 }, "companyCount": { "type": "integer", "description": "Number of constituents.", "example": 3196 }, "coverage": { "type": "object", "description": "Share of the constituents' market cap that supplied each metric's inputs, from 0 to 1, keyed by metric name. A ratio is served as `null` when its coverage is below 0.6, rather than as a figure computed over the wrong subset.", "additionalProperties": { "type": "number", "minimum": 0, "maximum": 1 }, "example": { "priceChangePercentage1d": 1, "priceChangePercentage7d": 1, "priceChangePercentage1m": 1, "priceChangePercentage3m": 0.9997, "priceChangePercentage6m": 0.9743, "priceChangePercentageYtd": 0.9732, "priceChangePercentage1y": 0.9718, "trailingPE": 0.9692, "earningsYield": 0.9692, "priceToRevenue": 0.969, "priceToBook": 0.9995, "enterpriseValueToEbitda": 0.8866, "dividendYield": 0.7692, "holdersYield": 0.8687, "operatingProfitMarginTTM": 0.8866 } }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true, "description": "Most recent quote time across the constituents.", "example": "2026-09-25T19:59:00Z" }, "volumeAsOf": { "type": "string", "format": "date-time", "nullable": true, "description": "When `dollarVolume24h` was taken.", "example": "2026-09-25T19:59:00Z" }, "medianTrailingPE": { "type": "number", "nullable": true, "description": "Median of the constituents' own P/E, over those with a positive one.", "example": 20.12 }, "medianPriceToRevenue": { "type": "number", "nullable": true, "description": "Median of the constituents' own price to sales, over those with a positive one.", "example": 2.656 }, "medianPriceToBook": { "type": "number", "nullable": true, "description": "Median of the constituents' own price to book, over those with a positive one.", "example": 2.226 }, "medianEnterpriseValueToEbitda": { "type": "number", "nullable": true, "description": "Median of the constituents' own EV/EBITDA, over those with a positive one.", "example": 12.91 }, "medianOperatingProfitMarginTTM": { "type": "number", "nullable": true, "description": "Median of the constituents' own TTM operating margin, in percent.", "example": 8.51 }, "medianDividendYield": { "type": "number", "nullable": true, "description": "Median of the constituents' own dividend yield, in percent.", "example": 2.318 }, "medianMarketCap": { "type": "number", "nullable": true, "description": "Median constituent market cap, in USD.", "example": 2372244950.07 }, "sectorCount": { "type": "integer", "description": "Number of sectors, not counting `Unknown`.", "example": 11 }, "industryCount": { "type": "integer", "description": "Number of distinct industries.", "example": 144 }, "bestSector1d": { "type": "object", "nullable": true, "description": "Sector with the highest `priceChangePercentage1d`. Never `Unknown`.", "properties": { "sector": { "type": "string", "description": "Sector name as the data vendor labels it (not GICS). Companies the vendor left unclassified roll up into `Unknown`.", "example": "Technology" }, "sectorSlug": { "type": "string", "description": "URL-safe sector id. Pass it as `sector` to the other equities endpoints.", "example": "technology" }, "priceChangePercentage1d": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the latest session, in percent.", "example": 0.861 }, "weight": { "type": "number", "nullable": true, "description": "Share of all tracked US equity market cap, in percent.", "example": 35.54 } } }, "worstSector1d": { "type": "object", "nullable": true, "description": "Sector with the lowest `priceChangePercentage1d`. Never `Unknown`.", "properties": { "sector": { "type": "string", "description": "Sector name as the data vendor labels it (not GICS). Companies the vendor left unclassified roll up into `Unknown`.", "example": "Energy" }, "sectorSlug": { "type": "string", "description": "URL-safe sector id. Pass it as `sector` to the other equities endpoints.", "example": "energy" }, "priceChangePercentage1d": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the latest session, in percent.", "example": -0.9536 }, "weight": { "type": "number", "nullable": true, "description": "Share of all tracked US equity market cap, in percent.", "example": 3.368 } } }, "largestSector": { "type": "object", "nullable": true, "description": "Sector with the largest market cap. Never `Unknown`.", "properties": { "sector": { "type": "string", "description": "Sector name as the data vendor labels it (not GICS). Companies the vendor left unclassified roll up into `Unknown`.", "example": "Technology" }, "sectorSlug": { "type": "string", "description": "URL-safe sector id. Pass it as `sector` to the other equities endpoints.", "example": "technology" }, "priceChangePercentage1d": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the latest session, in percent.", "example": 0.861 }, "weight": { "type": "number", "nullable": true, "description": "Share of all tracked US equity market cap, in percent.", "example": 35.54 } } } }, "example": { "marketCap": 82964660714713.33, "marketCapChange1d": 345803139721.38, "dollarVolume24h": 582767711903.08, "revenueTTM": 24757148479483, "earningsTTM": 2642725287768, "ebitdaTTM": 4436690488724, "enterpriseValue": 100074056247123.19, "employeeCount": 45614558, "trailingPE": 30.43, "earningsYield": 3.287, "priceToRevenue": 3.247, "priceToBook": 4.871, "enterpriseValueToEbitda": 18.39, "dividendYield": 1.344, "holdersYield": 2.915, "operatingProfitMarginTTM": 13.77, "priceChangePercentage1d": 0.4196, "priceChangePercentage7d": 0.8979, "priceChangePercentage1m": 0.3504, "priceChangePercentage3m": 3.812, "priceChangePercentage6m": 20.51, "priceChangePercentageYtd": 12.33, "priceChangePercentage1y": 15, "companyCount": 3196, "coverage": { "priceChangePercentage1d": 1, "priceChangePercentage7d": 1, "priceChangePercentage1m": 1, "priceChangePercentage3m": 0.9997, "priceChangePercentage6m": 0.9743, "priceChangePercentageYtd": 0.9732, "priceChangePercentage1y": 0.9718, "trailingPE": 0.9692, "earningsYield": 0.9692, "priceToRevenue": 0.969, "priceToBook": 0.9995, "enterpriseValueToEbitda": 0.8866, "dividendYield": 0.7692, "holdersYield": 0.8687, "operatingProfitMarginTTM": 0.8866 }, "medianTrailingPE": 20.12, "medianPriceToRevenue": 2.656, "medianPriceToBook": 2.226, "medianEnterpriseValueToEbitda": 12.91, "medianOperatingProfitMarginTTM": 8.51, "medianDividendYield": 2.318, "medianMarketCap": 2372244950.07, "sectorCount": 11, "industryCount": 144, "bestSector1d": { "sector": "Technology", "sectorSlug": "technology", "priceChangePercentage1d": 0.861, "weight": 35.54 }, "worstSector1d": { "sector": "Energy", "sectorSlug": "energy", "priceChangePercentage1d": -0.9536, "weight": 3.368 }, "largestSector": { "sector": "Technology", "sectorSlug": "technology", "priceChangePercentage1d": 0.861, "weight": 35.54 }, "updatedAt": "2026-09-25T19:59:00Z", "volumeAsOf": "2026-09-25T19:59:00Z" } } } } }, "404": { "description": "Sector data not published yet" }, "500": { "description": "Invalid or missing API key (`{\"error\": \"API Key is wrong\"}`), or an internal server error" } } } }, "/equities/v1/sector": { "get": { "tags": ["Equities"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get details for one sector", "description": "Returns one sector in full: everything its `GET /equities/v1/sectors` row has, plus a short description, the ten largest holdings, aggregate and median valuation ratios side by side, and how concentrated the sector is.\n\nCovers US-listed companies. All monetary values are in USD.", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sector", "in": "query", "description": "Sector to return, as a slug (`technology`, `financial-services`) or as its label in any case (`Financial Services`). Valid values are the `sectorSlug`s returned by `GET /equities/v1/sectors`.", "required": true, "schema": { "type": "string", "example": "technology" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "sector": { "type": "string", "description": "Sector name as the data vendor labels it (not GICS). Companies the vendor left unclassified roll up into `Unknown`.", "example": "Technology" }, "sectorSlug": { "type": "string", "description": "URL-safe sector id. Pass it as `sector` to the other equities endpoints.", "example": "technology" }, "rank": { "type": "integer", "description": "Position by market cap, starting at 1.", "example": 1 }, "weight": { "type": "number", "nullable": true, "description": "Share of all tracked US equity market cap, in percent. Sums to 100 across sectors, `Unknown` included.", "example": 35.54 }, "dollarVolumeShare24h": { "type": "number", "nullable": true, "description": "Share of all tracked US value traded in the latest session, in percent.", "example": 40.1 }, "industryCount": { "type": "integer", "description": "Number of distinct industries in the sector.", "example": 12 }, "marketCap": { "type": "number", "nullable": true, "description": "Total market cap of the constituents, in USD.", "example": 29484487070530.91 }, "marketCapChange1d": { "type": "number", "nullable": true, "description": "Change in total market cap over the latest session, in USD. Reconciles exactly with `priceChangePercentage1d`.", "example": 251664986364.37 }, "dollarVolume24h": { "type": "number", "nullable": true, "description": "Value traded in the latest session (shares traded × price, summed), in USD. Reads low while a session is still open; `volumeAsOf` says when it was taken.", "example": 233706720783.08 }, "revenueTTM": { "type": "number", "nullable": true, "description": "Total trailing twelve month revenue, in USD.", "example": 3618619651351 }, "earningsTTM": { "type": "number", "nullable": true, "description": "Total trailing twelve month earnings, in USD.", "example": 729280268773 }, "ebitdaTTM": { "type": "number", "nullable": true, "description": "Total trailing twelve month EBITDA, in USD.", "example": 1159818834166 }, "enterpriseValue": { "type": "number", "nullable": true, "description": "Total enterprise value, in USD.", "example": 30012989630394.37 }, "employeeCount": { "type": "number", "nullable": true, "description": "Total employees across the constituents that report a headcount. `null` when none do.", "example": 6808759 }, "trailingPE": { "type": "number", "nullable": true, "description": "Aggregate price to earnings: total market cap / total TTM earnings. `null` when total earnings are zero or negative; use `earningsYield` then.", "example": 40.3 }, "earningsYield": { "type": "number", "nullable": true, "description": "100 × total TTM earnings / total market cap, in percent. Signed, so it stays defined when `trailingPE` is `null` for a loss-making group.", "example": 2.482 }, "priceToRevenue": { "type": "number", "nullable": true, "description": "Aggregate price to sales: total market cap / total TTM revenue.", "example": 8.121 }, "priceToBook": { "type": "number", "nullable": true, "description": "Aggregate price to book: total market cap / total shareholders' equity.", "example": 12.1 }, "enterpriseValueToEbitda": { "type": "number", "nullable": true, "description": "Aggregate EV/EBITDA: total enterprise value / total TTM EBITDA.", "example": 25.8 }, "dividendYield": { "type": "number", "nullable": true, "description": "100 × total TTM dividends / total market cap, in percent.", "example": 0.5053 }, "holdersYield": { "type": "number", "nullable": true, "description": "100 × total TTM holders' revenue (dividends plus buybacks, net of share issuance) / total market cap, in percent.", "example": 1.719 }, "operatingProfitMarginTTM": { "type": "number", "nullable": true, "description": "Total TTM operating income / total TTM revenue, in percent. Weighted by revenue, not market cap.", "example": 24.65 }, "priceChangePercentage1d": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the latest session, in percent (`0.86` is +0.86%).", "example": 0.861 }, "priceChangePercentage7d": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 7 days, in percent.", "example": 2.951 }, "priceChangePercentage1m": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 30 days, in percent.", "example": 6.681 }, "priceChangePercentage3m": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 3 calendar months, in percent.", "example": 11.65 }, "priceChangePercentage6m": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 6 calendar months, in percent.", "example": 45.56 }, "priceChangePercentageYtd": { "type": "number", "nullable": true, "description": "Cap-weighted price change since January 1, in percent.", "example": 29.18 }, "priceChangePercentage1y": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last year, in percent.", "example": 30.25 }, "companyCount": { "type": "integer", "description": "Number of constituents.", "example": 475 }, "coverage": { "type": "object", "description": "Share of the constituents' market cap that supplied each metric's inputs, from 0 to 1, keyed by metric name. A ratio is served as `null` when its coverage is below 0.6, rather than as a figure computed over the wrong subset.", "additionalProperties": { "type": "number", "minimum": 0, "maximum": 1 }, "example": { "priceChangePercentage1d": 1, "priceChangePercentage7d": 1, "priceChangePercentage1m": 1, "priceChangePercentage3m": 0.9998, "priceChangePercentage6m": 0.9979, "priceChangePercentageYtd": 0.9976, "priceChangePercentage1y": 0.9964, "trailingPE": 0.9967, "earningsYield": 0.9967, "priceToRevenue": 0.9967, "priceToBook": 1, "enterpriseValueToEbitda": 0.9967, "dividendYield": 0.8057, "holdersYield": 0.9594, "operatingProfitMarginTTM": 0.9967 } }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true, "description": "Most recent quote time across the constituents.", "example": "2026-09-25T19:59:00Z" }, "volumeAsOf": { "type": "string", "format": "date-time", "nullable": true, "description": "When `dollarVolume24h` was taken.", "example": "2026-09-25T19:59:00Z" }, "topHoldings": { "type": "array", "description": "The ten largest constituents by market cap.", "items": { "type": "object", "properties": { "ticker": { "type": "string", "example": "NVDA" }, "name": { "type": "string", "example": "NVIDIA Corporation" }, "marketCap": { "type": "number", "nullable": true, "description": "Market cap, in USD.", "example": 5451313781934.43 }, "sectorWeight": { "type": "number", "nullable": true, "description": "Share of this sector's market cap, in percent.", "example": 18.49 }, "priceChangePercentage1d": { "type": "number", "nullable": true, "description": "Price change over the latest session, in percent.", "example": 0.2182 } } } }, "description": { "type": "string", "description": "Short description of what the sector covers.", "example": "Semiconductors, software, hardware and IT services." }, "valuation": { "type": "object", "description": "The sector's aggregate ratios (same values as the top-level fields) next to the median of its constituents' own ratios. Compare aggregate with aggregate and median with median, for example against `GET /equities/v1/sectors-overview`.", "properties": { "trailingPE": { "type": "number", "nullable": true, "description": "Aggregate P/E.", "example": 40.3 }, "earningsYield": { "type": "number", "nullable": true, "description": "Aggregate earnings yield, in percent.", "example": 2.482 }, "priceToRevenue": { "type": "number", "nullable": true, "description": "Aggregate price to sales.", "example": 8.121 }, "priceToBook": { "type": "number", "nullable": true, "description": "Aggregate price to book.", "example": 12.1 }, "enterpriseValueToEbitda": { "type": "number", "nullable": true, "description": "Aggregate EV/EBITDA.", "example": 25.8 }, "operatingProfitMarginTTM": { "type": "number", "nullable": true, "description": "Revenue-weighted TTM operating margin, in percent.", "example": 24.65 }, "dividendYield": { "type": "number", "nullable": true, "description": "Aggregate dividend yield, in percent.", "example": 0.5053 }, "medianTrailingPE": { "type": "number", "nullable": true, "description": "Median of the constituents' own P/E, over those with a positive one.", "example": 32.53 }, "medianPriceToRevenue": { "type": "number", "nullable": true, "description": "Median of the constituents' own price to sales, over those with a positive one.", "example": 3.601 }, "medianPriceToBook": { "type": "number", "nullable": true, "description": "Median of the constituents' own price to book, over those with a positive one.", "example": 4.45 }, "medianEnterpriseValueToEbitda": { "type": "number", "nullable": true, "description": "Median of the constituents' own EV/EBITDA, over those with a positive one.", "example": 18.73 }, "medianOperatingProfitMarginTTM": { "type": "number", "nullable": true, "description": "Median of the constituents' own TTM operating margin, in percent.", "example": 6.05 }, "medianDividendYield": { "type": "number", "nullable": true, "description": "Median of the constituents' own dividend yield, in percent.", "example": 0.9544 } } }, "concentration": { "type": "object", "description": "How much of the sector's market cap sits in its largest constituents.", "properties": { "top10MarketCapShare": { "type": "number", "nullable": true, "description": "Share of the sector's market cap held by its ten largest constituents, in percent.", "example": 68.24 }, "hhi": { "type": "number", "nullable": true, "description": "Herfindahl-Hirschman index over the constituents' percentage shares of sector market cap, from 0 to 10,000. A single-company sector is 10,000 and ten equal constituents are 1,000.", "example": 889 }, "megaCapCount": { "type": "integer", "description": "Number of constituents with a market cap of at least `megaCapThreshold`.", "example": 24 }, "megaCapThreshold": { "type": "number", "description": "Market cap, in USD, from which a company counts as mega cap.", "example": 200000000000 }, "medianMarketCap": { "type": "number", "nullable": true, "description": "Median constituent market cap, in USD.", "example": 3171914000 } } } }, "example": { "sector": "Technology", "sectorSlug": "technology", "marketCap": 29484487070530.91, "marketCapChange1d": 251664986364.37, "dollarVolume24h": 233706720783.08, "revenueTTM": 3618619651351, "earningsTTM": 729280268773, "ebitdaTTM": 1159818834166, "enterpriseValue": 30012989630394.37, "employeeCount": 6808759, "trailingPE": 40.3, "earningsYield": 2.482, "priceToRevenue": 8.121, "priceToBook": 12.1, "enterpriseValueToEbitda": 25.8, "dividendYield": 0.5053, "holdersYield": 1.719, "operatingProfitMarginTTM": 24.65, "priceChangePercentage1d": 0.861, "priceChangePercentage7d": 2.951, "priceChangePercentage1m": 6.681, "priceChangePercentage3m": 11.65, "priceChangePercentage6m": 45.56, "priceChangePercentageYtd": 29.18, "priceChangePercentage1y": 30.25, "companyCount": 475, "coverage": { "priceChangePercentage1d": 1, "priceChangePercentage7d": 1, "priceChangePercentage1m": 1, "priceChangePercentage3m": 0.9998, "priceChangePercentage6m": 0.9979, "priceChangePercentageYtd": 0.9976, "priceChangePercentage1y": 0.9964, "trailingPE": 0.9967, "earningsYield": 0.9967, "priceToRevenue": 0.9967, "priceToBook": 1, "enterpriseValueToEbitda": 0.9967, "dividendYield": 0.8057, "holdersYield": 0.9594, "operatingProfitMarginTTM": 0.9967 }, "weight": 35.54, "dollarVolumeShare24h": 40.1, "industryCount": 12, "topHoldings": [ { "ticker": "NVDA", "name": "NVIDIA Corporation", "marketCap": 5451313781934.43, "sectorWeight": 18.49, "priceChangePercentage1d": 0.2182 }, { "ticker": "AAPL", "name": "Apple Inc.", "marketCap": 5009416613731.49, "sectorWeight": 16.99, "priceChangePercentage1d": 1.533 }, { "ticker": "MSFT", "name": "Microsoft Corporation Common Stock", "marketCap": 3833594441460, "sectorWeight": 13, "priceChangePercentage1d": 3.663 }, { "ticker": "AVGO", "name": "Broadcom Inc.", "marketCap": 1684314940000, "sectorWeight": 5.713, "priceChangePercentage1d": 0.6993 }, { "ticker": "MU", "name": "Micron Technology Inc.", "marketCap": 1222319653346.07, "sectorWeight": 4.146, "priceChangePercentage1d": 0.162 }, { "ticker": "AMD", "name": "Advanced Micro Devices Inc.", "marketCap": 1029188160000, "sectorWeight": 3.491, "priceChangePercentage1d": 0.2177 }, { "ticker": "INTC", "name": "Intel Corporation", "marketCap": 617829000000, "sectorWeight": 2.095, "priceChangePercentage1d": -3.446 }, { "ticker": "PLTR", "name": "Palantir Technologies Inc. Class A Common Stock", "marketCap": 455757473990, "sectorWeight": 1.546, "priceChangePercentage1d": -1.516 }, { "ticker": "CSCO", "name": "Cisco Systems, Inc.", "marketCap": 421038200000, "sectorWeight": 1.428, "priceChangePercentage1d": -0.2524 }, { "ticker": "ORCL", "name": "Oracle Corporation", "marketCap": 394848028800, "sectorWeight": 1.339, "priceChangePercentage1d": -1.749 } ], "updatedAt": "2026-09-25T19:59:00Z", "volumeAsOf": "2026-09-25T19:59:00Z", "rank": 1, "description": "Semiconductors, software, hardware and IT services.", "valuation": { "trailingPE": 40.3, "earningsYield": 2.482, "priceToRevenue": 8.121, "priceToBook": 12.1, "enterpriseValueToEbitda": 25.8, "operatingProfitMarginTTM": 24.65, "dividendYield": 0.5053, "medianTrailingPE": 32.53, "medianPriceToRevenue": 3.601, "medianPriceToBook": 4.45, "medianEnterpriseValueToEbitda": 18.73, "medianOperatingProfitMarginTTM": 6.05, "medianDividendYield": 0.9544 }, "concentration": { "top10MarketCapShare": 68.24, "hhi": 889, "megaCapCount": 24, "megaCapThreshold": 200000000000, "medianMarketCap": 3171914000 } } } } } }, "400": { "description": "Missing or unknown `sector` (`{\"error\": \"Unknown sector\"}`)" }, "500": { "description": "Invalid or missing API key (`{\"error\": \"API Key is wrong\"}`), or an internal server error" } } } }, "/equities/v1/industries": { "get": { "tags": ["Equities"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get industries", "description": "Returns one row per industry, sorted by market cap (largest first), with the same metrics as a `GET /equities/v1/sectors` row plus the parent sector. Filter to one sector with `sector`, or to one industry with `industry`.\n\nEach row carries two weights: `weight` is the share of all tracked US equity, and `sectorWeight` is the share of the parent sector. For Technology's industries, `sectorWeight` sums to 100 while `weight` sums to Technology's own weight in the market.\n\n`rank` counts within the selected sector when `sector` is set, and across all industries otherwise. Filtering by `industry` alone keeps each row's market-wide rank.\n\nThe same industry name can exist under two sectors, so `industry` alone can return more than one row.\n\nCovers US-listed companies. All monetary values are in USD.", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sector", "in": "query", "description": "Only return industries in this sector, as a slug (`technology`, `financial-services`) or as its label in any case (`Financial Services`). Valid values are the `sectorSlug`s returned by `GET /equities/v1/sectors`. An unknown value returns an empty list.", "required": false, "schema": { "type": "string", "example": "technology" } }, { "name": "industry", "in": "query", "description": "Only return this industry, as a slug (`semiconductors`) or as its label in any case (`Semiconductors`). An unknown value returns an empty list.", "required": false, "schema": { "type": "string", "example": "semiconductors" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "industry": { "type": "string", "description": "Industry name as the data vendor labels it.", "example": "Semiconductors" }, "industrySlug": { "type": "string", "description": "URL-safe industry id. Pass it as `industry` to filter.", "example": "semiconductors" }, "sector": { "type": "string", "description": "Sector name as the data vendor labels it (not GICS). Companies the vendor left unclassified roll up into `Unknown`.", "example": "Technology" }, "sectorSlug": { "type": "string", "description": "URL-safe sector id. Pass it as `sector` to the other equities endpoints.", "example": "technology" }, "rank": { "type": "integer", "description": "Position by market cap, starting at 1. See the note on ranking above.", "example": 1 }, "weight": { "type": "number", "nullable": true, "description": "Share of all tracked US equity market cap, in percent.", "example": 13.8 }, "sectorWeight": { "type": "number", "nullable": true, "description": "Share of the parent sector's market cap, in percent.", "example": 38.83 }, "dollarVolumeShare24h": { "type": "number", "nullable": true, "description": "Share of all tracked US value traded in the latest session, in percent.", "example": 15.74 }, "marketCap": { "type": "number", "nullable": true, "description": "Total market cap of the constituents, in USD.", "example": 11449062913733.04 }, "marketCapChange1d": { "type": "number", "nullable": true, "description": "Change in total market cap over the latest session, in USD. Reconciles exactly with `priceChangePercentage1d`.", "example": 45052557957.41 }, "dollarVolume24h": { "type": "number", "nullable": true, "description": "Value traded in the latest session (shares traded × price, summed), in USD. Reads low while a session is still open; `volumeAsOf` says when it was taken.", "example": 91746535047 }, "revenueTTM": { "type": "number", "nullable": true, "description": "Total trailing twelve month revenue, in USD.", "example": 676181976411 }, "earningsTTM": { "type": "number", "nullable": true, "description": "Total trailing twelve month earnings, in USD.", "example": 281424204118 }, "ebitdaTTM": { "type": "number", "nullable": true, "description": "Total trailing twelve month EBITDA, in USD.", "example": 390274528397 }, "enterpriseValue": { "type": "number", "nullable": true, "description": "Total enterprise value, in USD.", "example": 11425992099839.04 }, "employeeCount": { "type": "number", "nullable": true, "description": "Total employees across the constituents that report a headcount. `null` when none do.", "example": 527732 }, "trailingPE": { "type": "number", "nullable": true, "description": "Aggregate price to earnings: total market cap / total TTM earnings. `null` when total earnings are zero or negative; use `earningsYield` then.", "example": 40.51 }, "earningsYield": { "type": "number", "nullable": true, "description": "100 × total TTM earnings / total market cap, in percent. Signed, so it stays defined when `trailingPE` is `null` for a loss-making group.", "example": 2.469 }, "priceToRevenue": { "type": "number", "nullable": true, "description": "Aggregate price to sales: total market cap / total TTM revenue.", "example": 16.86 }, "priceToBook": { "type": "number", "nullable": true, "description": "Aggregate price to book: total market cap / total shareholders' equity.", "example": 15.31 }, "enterpriseValueToEbitda": { "type": "number", "nullable": true, "description": "Aggregate EV/EBITDA: total enterprise value / total TTM EBITDA.", "example": 29.17 }, "dividendYield": { "type": "number", "nullable": true, "description": "100 × total TTM dividends / total market cap, in percent.", "example": 0.2731 }, "holdersYield": { "type": "number", "nullable": true, "description": "100 × total TTM holders' revenue (dividends plus buybacks, net of share issuance) / total market cap, in percent.", "example": 0.9171 }, "operatingProfitMarginTTM": { "type": "number", "nullable": true, "description": "Total TTM operating income / total TTM revenue, in percent. Weighted by revenue, not market cap.", "example": 45.36 }, "priceChangePercentage1d": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the latest session, in percent (`0.86` is +0.86%).", "example": 0.3951 }, "priceChangePercentage7d": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 7 days, in percent.", "example": 3.745 }, "priceChangePercentage1m": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 30 days, in percent.", "example": 10.31 }, "priceChangePercentage3m": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 3 calendar months, in percent.", "example": 7.26 }, "priceChangePercentage6m": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last 6 calendar months, in percent.", "example": 55.79 }, "priceChangePercentageYtd": { "type": "number", "nullable": true, "description": "Cap-weighted price change since January 1, in percent.", "example": 44.12 }, "priceChangePercentage1y": { "type": "number", "nullable": true, "description": "Cap-weighted price change over the last year, in percent.", "example": 53.79 }, "companyCount": { "type": "integer", "description": "Number of constituents.", "example": 50 }, "coverage": { "type": "object", "description": "Share of the constituents' market cap that supplied each metric's inputs, from 0 to 1, keyed by metric name. A ratio is served as `null` when its coverage is below 0.6, rather than as a figure computed over the wrong subset.", "additionalProperties": { "type": "number", "minimum": 0, "maximum": 1 }, "example": { "priceChangePercentage1d": 1, "priceChangePercentage7d": 1, "priceChangePercentage1m": 1, "priceChangePercentage3m": 1, "priceChangePercentage6m": 0.9959, "priceChangePercentageYtd": 0.9959, "priceChangePercentage1y": 0.9958, "trailingPE": 0.9957, "earningsYield": 0.9957, "priceToRevenue": 0.9957, "priceToBook": 1, "enterpriseValueToEbitda": 0.9957, "dividendYield": 0.8788, "holdersYield": 0.9821, "operatingProfitMarginTTM": 0.9957 } }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true, "description": "Most recent quote time across the constituents.", "example": "2026-09-25T19:59:00Z" }, "volumeAsOf": { "type": "string", "format": "date-time", "nullable": true, "description": "When `dollarVolume24h` was taken.", "example": "2026-09-25T19:59:00Z" }, "topHoldings": { "type": "array", "description": "The three largest constituents by market cap.", "items": { "type": "object", "properties": { "ticker": { "type": "string", "example": "NVDA" }, "name": { "type": "string", "example": "NVIDIA Corporation" }, "marketCap": { "type": "number", "nullable": true, "description": "Market cap, in USD.", "example": 5451313781934.43 }, "sectorWeight": { "type": "number", "nullable": true, "description": "Share of this industry's market cap, in percent. The name matches the sector holdings.", "example": 47.61 }, "priceChangePercentage1d": { "type": "number", "nullable": true, "description": "Price change over the latest session, in percent.", "example": 0.2182 } } } } } }, "example": [ { "industry": "Semiconductors", "industrySlug": "semiconductors", "sector": "Technology", "sectorSlug": "technology", "marketCap": 11449062913733.04, "marketCapChange1d": 45052557957.41, "dollarVolume24h": 91746535047, "revenueTTM": 676181976411, "earningsTTM": 281424204118, "ebitdaTTM": 390274528397, "enterpriseValue": 11425992099839.04, "employeeCount": 527732, "trailingPE": 40.51, "earningsYield": 2.469, "priceToRevenue": 16.86, "priceToBook": 15.31, "enterpriseValueToEbitda": 29.17, "dividendYield": 0.2731, "holdersYield": 0.9171, "operatingProfitMarginTTM": 45.36, "priceChangePercentage1d": 0.3951, "priceChangePercentage7d": 3.745, "priceChangePercentage1m": 10.31, "priceChangePercentage3m": 7.26, "priceChangePercentage6m": 55.79, "priceChangePercentageYtd": 44.12, "priceChangePercentage1y": 53.79, "companyCount": 50, "coverage": { "priceChangePercentage1d": 1, "priceChangePercentage7d": 1, "priceChangePercentage1m": 1, "priceChangePercentage3m": 1, "priceChangePercentage6m": 0.9959, "priceChangePercentageYtd": 0.9959, "priceChangePercentage1y": 0.9958, "trailingPE": 0.9957, "earningsYield": 0.9957, "priceToRevenue": 0.9957, "priceToBook": 1, "enterpriseValueToEbitda": 0.9957, "dividendYield": 0.8788, "holdersYield": 0.9821, "operatingProfitMarginTTM": 0.9957 }, "weight": 13.8, "sectorWeight": 38.83, "dollarVolumeShare24h": 15.74, "topHoldings": [ { "ticker": "NVDA", "name": "NVIDIA Corporation", "marketCap": 5451313781934.43, "sectorWeight": 47.61, "priceChangePercentage1d": 0.2182 }, { "ticker": "AVGO", "name": "Broadcom Inc.", "marketCap": 1684314940000, "sectorWeight": 14.71, "priceChangePercentage1d": 0.6993 }, { "ticker": "MU", "name": "Micron Technology Inc.", "marketCap": 1222319653346.07, "sectorWeight": 10.68, "priceChangePercentage1d": 0.162 } ], "updatedAt": "2026-09-25T19:59:00Z", "volumeAsOf": "2026-09-25T19:59:00Z", "rank": 1 } ] } } } }, "500": { "description": "Invalid or missing API key (`{\"error\": \"API Key is wrong\"}`), or an internal server error" } } } }, "/equities/v1/earnings-calendar": { "get": { "tags": ["Equities"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get earnings calendar", "description": "Returns earnings report dates built from SEC EDGAR filings: past reports, plus the next four expected dates projected from each company's own filing history. Covers US-listed companies.\n\nThe same path serves two shapes:\n\n- **With `ticker`**: that company's full history plus its upcoming estimates.\n- **Without `ticker`**: the market-wide calendar over a rolling window from about 1 month back to about 13 months ahead. Use the `ticker` form for older history.\n\nRows are sorted by `report_date`, oldest first, so `limit` keeps the earliest matches. `?ticker=AAPL&status=estimated&limit=1` is Apple's next report.\n\nEvery row says what kind of date it is in `date_status`. A future date is `estimated`, with a `max_drift_days` range, and is not a confirmed schedule.\n\nCompany names are not included. Join on `ticker` against `GET /equities/v1/companies-list`.", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "ticker", "in": "query", "description": "Stock ticker symbol (case-insensitive). When set, returns that company's full calendar.", "required": false, "schema": { "type": "string", "example": "AAPL" } }, { "name": "from", "in": "query", "description": "Earliest `report_date` to include, as `YYYY-MM-DD` (inclusive).", "required": false, "schema": { "type": "string", "format": "date", "example": "2026-10-26" } }, { "name": "to", "in": "query", "description": "Latest `report_date` to include, as `YYYY-MM-DD` (inclusive).", "required": false, "schema": { "type": "string", "format": "date", "example": "2026-10-30" } }, { "name": "status", "in": "query", "description": "Only return rows with this `date_status` (case-insensitive). `confirmed` is accepted but nothing produces it yet, so it returns an empty list.", "required": false, "schema": { "type": "string", "enum": ["reported", "inferred", "confirmed", "estimated"], "example": "estimated" } }, { "name": "limit", "in": "query", "description": "Maximum rows to return, taken from the earliest `report_date`. Positive integer; values above 20000 are capped at 20000.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 20000, "default": 20000, "example": 1 } } ], "responses": { "200": { "description": "Successful operation", "headers": { "X-Total-Matches": { "description": "Rows matching the filters before `limit` was applied.", "schema": { "type": "integer", "example": 4 } }, "X-Result-Truncated": { "description": "`true` when `limit` cut the result short.", "schema": { "type": "string", "enum": ["true", "false"], "example": "true" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string", "example": "AAPL" }, "iso2_country_code": { "type": "string", "example": "US" }, "cik": { "type": "string", "description": "SEC CIK of the registrant that filed the row. Differs from the company's current CIK for rows inherited from a predecessor after a reorganisation.", "example": "320193" }, "event_key": { "type": "string", "description": "`-`, the row's identity. When the report arrives, its row replaces the estimate with the same key.", "example": "2026-Q3" }, "date_status": { "type": "string", "enum": ["reported", "inferred", "confirmed", "estimated"], "description": "`reported`: an earnings release (8-K Item 2.02) was filed. `inferred`: no release that quarter, so the date comes from the 10-Q or 10-K (filing-backed, but weaker). `estimated`: projected from the company's past cadence. `confirmed`: announced by the company; not produced yet.", "example": "reported" }, "report_date": { "type": "string", "format": "date", "description": "US Eastern date of the report, from the SEC acceptance timestamp rather than EDGAR's filing date.", "example": "2026-07-30" }, "report_time": { "type": "string", "enum": ["bmo", "dmt", "amc", "unknown"], "description": "`bmo`: before 09:30 ET. `dmt`: during market hours. `amc`: after 16:00 ET. `unknown`: no timestamp, as on estimates. Taken from the SEC acceptance time, not the newswire.", "example": "amc" }, "accepted_at": { "type": "string", "description": "Raw SEC acceptance timestamp, in UTC. Empty on estimates.", "example": "2026-07-30T20:30:28.000Z" }, "fiscal_year": { "type": "integer", "description": "Fiscal year the quarter belongs to, named for the calendar year it ends in.", "example": 2026 }, "fiscal_period": { "type": "string", "enum": ["Q1", "Q2", "Q3", "Q4"], "example": "Q3" }, "period_end": { "type": "string", "description": "Last day of the fiscal period the report covers. Empty for a release whose 10-Q has not been filed yet, and for estimates projected from one.", "example": "2026-06-27" }, "source": { "type": "string", "enum": ["8k_item_202", "periodic_filing", "cadence_model"], "description": "`8k_item_202`: an earnings release. `periodic_filing`: a 10-Q or 10-K, used when there was no release. `cadence_model`: an estimate.", "example": "8k_item_202" }, "source_form": { "type": "string", "description": "SEC form the date comes from, such as `8-K`, `10-Q` or `10-K`. Empty on estimates.", "example": "8-K" }, "accession_number": { "type": "string", "description": "SEC accession number of that filing. Empty on estimates.", "example": "0000320193-26-000018" }, "max_drift_days": { "type": "integer", "nullable": true, "description": "On estimates, how many days either side of `report_date` the real date may land. 96% of real dates fell inside this range when tested against past reports. Wider for small caps and short histories. `null` on filing-backed rows.", "example": 7 }, "first_published_at": { "type": "string", "description": "When this `event_key` was first published (`YYYY-MM-DD HH:MM:SS.sss`).", "example": "2026-09-21 12:47:28.451" }, "revision_count": { "type": "integer", "description": "How many times the filing-backed date has moved since it was first published.", "example": 0 }, "previous_report_date": { "type": "string", "description": "The `report_date` before the most recent move. Empty if it never moved.", "example": "" }, "inserted_at": { "type": "string", "description": "When this row was last written (`YYYY-MM-DD HH:MM:SS.sss`).", "example": "2026-09-27 03:15:57.342" } } }, "example": [ { "ticker": "AAPL", "iso2_country_code": "US", "cik": "320193", "event_key": "2026-Q3", "date_status": "reported", "report_date": "2026-07-30", "report_time": "amc", "accepted_at": "2026-07-30T20:30:28.000Z", "fiscal_year": 2026, "fiscal_period": "Q3", "period_end": "2026-06-27", "source": "8k_item_202", "source_form": "8-K", "accession_number": "0000320193-26-000018", "max_drift_days": null, "first_published_at": "2026-09-21 12:47:28.451", "revision_count": 0, "previous_report_date": "", "inserted_at": "2026-09-27 03:15:57.342" }, { "ticker": "AAPL", "iso2_country_code": "US", "cik": "320193", "event_key": "2026-Q4", "date_status": "estimated", "report_date": "2026-10-29", "report_time": "unknown", "accepted_at": "", "fiscal_year": 2026, "fiscal_period": "Q4", "period_end": "2026-09-26", "source": "cadence_model", "source_form": "", "accession_number": "", "max_drift_days": 7, "first_published_at": "2026-09-21 12:47:28.451", "revision_count": 0, "previous_report_date": "", "inserted_at": "2026-09-27 03:15:57.342" } ] } } } }, "400": { "description": "`limit` is not a positive integer (`{\"error\": \"Invalid limit\"}`)" }, "404": { "description": "`ticker` is not a tracked company (`{\"error\": \"Earnings calendar not found\"}`)" }, "500": { "description": "Invalid or missing API key (`{\"error\": \"API Key is wrong\"}`), or an internal server error" } } } }, "/pre-ipo/v1/companies-list": { "get": { "tags": ["Pre-IPO"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get list of all tracked pre-IPO companies", "description": "Returns every private company in the pre-IPO registry with its latest estimated valuation and derived funding metrics. Use this to discover valid `company` ids for the other pre-IPO endpoints. Companies come back in registry order, so the list is not sorted by valuation.", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "description": "Snapshot envelope. `data` holds one row per tracked company.", "properties": { "updatedAt": { "type": "string", "format": "date-time", "description": "When this snapshot was generated.", "example": "2026-08-26T08:58:51.554Z" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Company id. Pass this as the `company` query parameter on the other pre-IPO endpoints.", "example": "anthropic" }, "name": { "type": "string", "example": "Anthropic" }, "description": { "type": "string", "example": "Anthropic is an AI safety and research company founded by former OpenAI executives, including siblings Dario and Daniela Amodei." }, "website": { "type": "string", "example": "https://anthropic.com" }, "sector": { "type": "string", "example": "Artificial Intelligence" }, "latestEstimatedValuation": { "type": "number", "nullable": true, "description": "Most recent monthly secondary-market estimate, in USD. Falls back to the latest funding round post-money valuation when no marketplace lists the company.", "example": 1377871934500 }, "latestRaise": { "type": "number", "nullable": true, "description": "Amount raised in the most recent funding round, in USD.", "example": 3566564608 }, "latestFundingValuation": { "type": "number", "nullable": true, "description": "Post-money valuation of the most recent funding round, in USD.", "example": 964999970816 }, "latestFundingDate": { "type": "string", "nullable": true, "format": "date", "example": "2026-05-28" }, "lastValuationDate": { "type": "string", "nullable": true, "format": "date", "description": "Date of the most recent secondary mark behind `latestEstimatedValuation`.", "example": "2026-08-25" }, "totalRaised": { "type": "number", "nullable": true, "description": "Sum of all disclosed funding rounds, in USD.", "example": 52036464736 }, "valuationChange1YPercentage": { "type": "number", "nullable": true, "description": "Change in the secondary estimate against the same month a year earlier, in percent. `null` when the company has no secondary marks.", "example": 715.68 }, "premiumVsLatestFundingPercentage": { "type": "number", "nullable": true, "description": "Premium of the secondary estimate over the latest round post-money valuation, in percent. `null` when the company has no secondary marks.", "example": 42.78 } } } } } } } } }, "401": { "description": "Unauthorized" } } } }, "/pre-ipo/v1/valuations": { "get": { "tags": ["Pre-IPO"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get valuation history for a pre-IPO company", "description": "Returns one aggregated valuation point per calendar month, oldest first. Within a month every source's marks are averaged and then the source averages are averaged, so a source that reports daily does not outvote one that reports monthly. Points are rounded to the nearest 100 and dated `YYYY-MM-01`; months with no data are skipped, and the current month is month-to-date.", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "company", "in": "query", "description": "Company id from `GET /pre-ipo/v1/companies-list` (case-insensitive). The display `name` is not accepted.", "required": true, "schema": { "type": "string", "example": "anthropic" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "description": "Snapshot envelope. `data` holds the monthly valuation series, oldest first.", "properties": { "updatedAt": { "type": "string", "format": "date-time", "description": "When this snapshot was generated.", "example": "2026-08-26T08:58:51.554Z" }, "data": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "First day of the month the point covers.", "example": "2026-08-01" }, "estimatedValuation": { "type": "number", "description": "Aggregated valuation estimate for that month, in USD.", "example": 1377871934500 } } }, "example": [ { "date": "2026-06-01", "estimatedValuation": 1412295009600 }, { "date": "2026-07-01", "estimatedValuation": 1414523445700 }, { "date": "2026-08-01", "estimatedValuation": 1377871934500 } ] } } } } } }, "401": { "description": "Unauthorized" }, "502": { "description": "Unknown `company`, or no snapshot has been generated for it yet. The pre-IPO section is served as static files, so anything other than `200` means there is no such file." } } } }, "/pre-ipo/v1/raises": { "get": { "tags": ["Pre-IPO"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get funding rounds for a pre-IPO company", "description": "Returns disclosed funding rounds, oldest first. The same round is usually reported by several sources with different dates and amounts, so rounds are reconciled before being served: each cluster collapses to one canonical raise taking the earliest date, the median amount, the median valuation, and the highest-ranked series label.", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "company", "in": "query", "description": "Company id from `GET /pre-ipo/v1/companies-list` (case-insensitive). The display `name` is not accepted.", "required": true, "schema": { "type": "string", "example": "anthropic" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "description": "Snapshot envelope. `data` holds the reconciled funding rounds, oldest first.", "properties": { "updatedAt": { "type": "string", "format": "date-time", "description": "When this snapshot was generated.", "example": "2026-08-26T08:58:51.554Z" }, "data": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Date the round was announced.", "example": "2026-05-28" }, "amountRaised": { "type": "number", "description": "Amount raised in the round, in USD.", "example": 3566564608 }, "valuation": { "type": "number", "nullable": true, "description": "Post-money valuation of the round, in USD. `null` when no source disclosed one.", "example": 964999970816 }, "series": { "type": "string", "description": "Round label, for example `Series C` or `Series H-4`.", "example": "Series H-4" } } }, "example": [ { "date": "2025-09-02", "amountRaised": 420020512, "valuation": 183000006656, "series": "Series F-2" }, { "date": "2026-02-12", "amountRaised": 30600000000, "valuation": 380000000000, "series": "Series G" }, { "date": "2026-05-28", "amountRaised": 3566564608, "valuation": 964999970816, "series": "Series H-4" } ] } } } } } }, "401": { "description": "Unauthorized" }, "502": { "description": "Unknown `company`, or no snapshot has been generated for it yet. The pre-IPO section is served as static files, so anything other than `200` means there is no such file." } } } }, "/pre-ipo/v1/summary": { "get": { "tags": ["Pre-IPO"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get profile and latest valuation for a pre-IPO company", "description": "Returns the company profile together with its latest estimated valuation and its most recent funding round.", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "company", "in": "query", "description": "Company id from `GET /pre-ipo/v1/companies-list` (case-insensitive). The display `name` is not accepted.", "required": true, "schema": { "type": "string", "example": "anthropic" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "description": "Snapshot envelope. `data` holds the company profile.", "properties": { "updatedAt": { "type": "string", "format": "date-time", "description": "When this snapshot was generated.", "example": "2026-08-26T08:58:51.554Z" }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": "anthropic" }, "name": { "type": "string", "example": "Anthropic" }, "description": { "type": "string", "example": "Anthropic is an AI safety and research company founded by former OpenAI executives, including siblings Dario and Daniela Amodei." }, "summary": { "type": "string", "description": "Short-form company summary. Currently identical to `description`.", "example": "Anthropic is an AI safety and research company founded by former OpenAI executives, including siblings Dario and Daniela Amodei." }, "website": { "type": "string", "example": "https://anthropic.com" }, "sector": { "type": "string", "example": "Artificial Intelligence" }, "latestEstimatedValuation": { "type": "number", "nullable": true, "description": "Most recent monthly secondary-market estimate, in USD. Falls back to the latest funding round post-money valuation when no marketplace lists the company.", "example": 1377871934500 }, "lastValuationDate": { "type": "string", "nullable": true, "format": "date", "example": "2026-08-25" }, "latestRaise": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Date the round was announced.", "example": "2026-05-28" }, "amountRaised": { "type": "number", "description": "Amount raised in the round, in USD.", "example": 3566564608 }, "valuation": { "type": "number", "nullable": true, "description": "Post-money valuation of the round, in USD. `null` when no source disclosed one.", "example": 964999970816 }, "series": { "type": "string", "description": "Round label, for example `Series C` or `Series H-4`.", "example": "Series H-4" } }, "nullable": true, "description": "Most recent funding round, or `null` when no round is on record." } } } } } } } }, "401": { "description": "Unauthorized" }, "502": { "description": "Unknown `company`, or no snapshot has been generated for it yet. The pre-IPO section is served as static files, so anything other than `200` means there is no such file." } } } }, "/pre-ipo/v1/integrations": { "get": { "tags": ["Pre-IPO"], "x-api-plan-only": true, "x-api-beta": true, "summary": "Get tradeable markets for a pre-IPO company", "description": "Returns where the company can actually be traded right now: perpetual futures venues and tokenised-share issuers. A pre-IPO perp settles in stablecoins against the venue's reference price, so no shares change hands and the same company can trade at a slightly different price on every venue. This is a live snapshot refreshed hourly and no history is kept. Every company in the registry gets a response: one with no listings returns empty `perps` and `tokenIssuers` arrays rather than a miss.", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "company", "in": "query", "description": "Company id from `GET /pre-ipo/v1/companies-list` (case-insensitive). The display `name` is not accepted.", "required": true, "schema": { "type": "string", "example": "anthropic" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "description": "Snapshot envelope. `data` holds the live markets for the company.", "properties": { "updatedAt": { "type": "string", "format": "date-time", "description": "When this snapshot was generated.", "example": "2026-08-26T08:58:51.554Z" }, "data": { "type": "object", "properties": { "perps": { "type": "array", "description": "Perpetual futures markets tracking the company.", "items": { "type": "object", "properties": { "exchangeName": { "type": "string", "example": "Gate" }, "platformSlug": { "type": "string", "description": "DefiLlama slug for the venue.", "example": "gate" }, "defillamaContract": { "type": "string", "description": "DefiLlama market identifier, `{venue}:{pair}`.", "example": "gate:ANDURIL_USDT" }, "exchangeType": { "type": "string", "enum": ["CEX", "DEX"], "description": "Whether the venue is a centralised or an on-chain exchange.", "example": "CEX" }, "openInterest": { "type": "number", "nullable": true, "description": "Open interest, in USD.", "example": 53713.26 }, "volume": { "type": "number", "nullable": true, "description": "24 hour volume, in USD.", "example": 1889 }, "price": { "type": "number", "description": "Last traded price of the contract, in USD.", "example": 129.83 }, "annualizedFundingRate": { "type": "number", "nullable": true, "description": "Annualised funding rate, in percent, so `5.2` is 5.2% a year. Negative means shorts pay longs.", "example": 0 }, "tradeUrl": { "type": "string", "example": "https://www.gate.com/futures/USDT/ANDURIL_USDT" }, "estimatedValuation": { "type": "number", "nullable": true, "description": "Company valuation implied by this venue's price, in USD.", "example": 129830000000 } } } }, "tokenIssuers": { "type": "array", "description": "Tokenised exposure to the company's private shares.", "items": { "type": "object", "properties": { "issuerName": { "type": "string", "description": "The token issuer, not the private company.", "example": "PreStocks" }, "slug": { "type": "string", "nullable": true, "description": "DefiLlama RWA platform slug for the issuer, when it has one.", "example": "prestocks" }, "backing": { "type": "string", "enum": [ "Direct shares", "Trust-held SPV", "SPV interest", "Unsecured note", "Synthetic" ], "description": "What the token is a claim on, ordered from the most direct claim on the underlying shares to the least. `Direct shares` and `Trust-held SPV` are asset-backed and bankruptcy-remote, `SPV interest` is asset-backed but held one layer removed through a vehicle, and `Unsecured note` and `Synthetic` are not asset-backed at all.", "example": "SPV interest" }, "productUrl": { "type": "string", "example": "https://prestocks.com/anduril" }, "price": { "type": "number", "description": "Token price, in USD.", "example": 137.47 }, "marketCap": { "type": "number", "nullable": true, "description": "Market cap of the token, in USD. Only populated for issuers that publish one.", "example": 1406088.07 }, "estimatedValuation": { "type": "number", "nullable": true, "description": "Company valuation implied by the token price, in USD.", "example": 111741315858 } } } } }, "example": { "perps": [ { "exchangeName": "Gate", "platformSlug": "gate", "defillamaContract": "gate:ANDURIL_USDT", "exchangeType": "CEX", "openInterest": 53713.26, "volume": 1889, "price": 129.83, "annualizedFundingRate": 0, "tradeUrl": "https://www.gate.com/futures/USDT/ANDURIL_USDT", "estimatedValuation": 129830000000 } ], "tokenIssuers": [ { "issuerName": "PreStocks", "slug": "prestocks", "backing": "SPV interest", "productUrl": "https://prestocks.com/anduril", "price": 137.47, "marketCap": 1406088.07, "estimatedValuation": 111741315858 } ] } } } } } } }, "401": { "description": "Unauthorized" }, "502": { "description": "Unknown `company`, or no snapshot has been generated for it yet. The pre-IPO section is served as static files, so anything other than `200` means there is no such file." } } } }, "/rwa/current": { "get": { "tags": ["RWA"], "x-api-plan-only": true, "summary": "List all current RWA assets", "description": "Returns current Real World Asset rows with per-chain Onchain AUM (`onChainMcap`), Active AUM (`activeAum`) and DeFi Active TVL (`defiActiveTvl`) maps. `activeAum` replaces `activeMcap`, which still ships beside it as a deprecated duplicate and will be removed; read `activeAum`. `onChainMcap` keeps its name for now.", "responses": { "200": { "description": "Array of current RWA assets", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "ondo-usdy" }, "canonicalMarketId": { "type": "string", "nullable": true, "example": "ondo/usdy" }, "ticker": { "type": "string", "example": "USDY" }, "assetName": { "type": "string", "nullable": true, "example": "Ondo US Dollar Yield" }, "assetGroup": { "type": "string", "nullable": true, "example": "Treasuries" }, "primaryChain": { "type": "string", "nullable": true, "example": "Ethereum" }, "chain": { "type": "array", "nullable": true, "items": { "type": "string" }, "example": ["Ethereum", "Solana"] }, "category": { "type": "array", "nullable": true, "items": { "type": "string" }, "example": ["Treasuries"] }, "assetClass": { "type": "array", "nullable": true, "items": { "type": "string" }, "example": ["Fixed Income"] }, "type": { "type": "string", "nullable": true, "example": "Asset" }, "rwaClassification": { "type": "string", "nullable": true, "example": "Tokenized Asset" }, "accessModel": { "type": "string", "nullable": true, "example": "Permissioned" }, "issuer": { "type": "string", "nullable": true, "example": "Ondo Finance" }, "parentPlatform": { "type": "string", "nullable": true, "example": "Ondo Finance" }, "stablecoin": { "type": "boolean", "nullable": true, "example": false }, "governance": { "type": "boolean", "nullable": true, "example": false }, "onChainMcap": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "Ethereum": 125000000, "Solana": 45000000 }, "description": "Onchain AUM by chain: the USD value of all supply present onchain, whoever holds it." }, "activeAum": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "Ethereum": 125000000, "Solana": 45000000 }, "description": "Active AUM by chain: the portion of Onchain AUM held in user or protocol-controlled positions, with issuer, treasury and custodial wallets excluded. This is the number a protocol page shows as RWA Active AUM." }, "defiActiveTvl": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } }, "example": { "Ethereum": { "aave-v3": 1500000, "morpho": 850000 } }, "description": "DeFi Active TVL by chain and tracked protocol: the subset of Active AUM deployed in third-party DeFi protocols DefiLlama tracks." }, "price": { "type": "number", "nullable": true, "example": 1.04 }, "activeAumData": { "type": "boolean", "example": true }, "coingeckoId": { "type": "string", "nullable": true, "example": "ondo-us-dollar-yield" }, "logo": { "type": "string", "nullable": true, "example": "https://icons.llamao.fi/icons/protocols/ondo.jpg" } } } } } } } } } }, "/rwa/stats": { "get": { "tags": ["RWA"], "x-api-plan-only": true, "summary": "Get aggregate RWA stats by chain, category, platform, and asset group", "description": "Returns RWA aggregates. For the default per-chain table, read byChain[chain].base: assetIssuers.length, assetCount, activeAum, onChainMcap, and defiActiveTvl. Add stablecoinsOnly, governanceOnly, and stablecoinsAndGovernance when those buckets should be included. activeAum is Active AUM, onChainMcap is Onchain AUM and defiActiveTvl is DeFi Active TVL.", "responses": { "200": { "description": "Aggregate RWA stats", "content": { "application/json": { "schema": { "type": "object", "properties": { "totalOnChainMcap": { "type": "number", "example": 25000000000 }, "totalActiveMcap": { "type": "number", "example": 22000000000 }, "totalDefiActiveTvl": { "type": "number", "example": 800000000 }, "assetCount": { "type": "integer", "example": 320 }, "assetIssuers": { "type": "integer", "example": 120 }, "byChain": { "type": "object", "additionalProperties": { "type": "object", "properties": { "base": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } }, "description": "Default RWA bucket. The chain table uses this bucket unless stablecoins or governance assets are explicitly included." }, "stablecoinsOnly": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } } }, "governanceOnly": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } } }, "stablecoinsAndGovernance": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } } } } } }, "byCategory": { "type": "object", "additionalProperties": { "type": "object", "properties": { "base": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } }, "description": "Default RWA bucket. The chain table uses this bucket unless stablecoins or governance assets are explicitly included." }, "stablecoinsOnly": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } } }, "governanceOnly": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } } }, "stablecoinsAndGovernance": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } } } } } }, "byPlatform": { "type": "object", "additionalProperties": { "type": "object", "properties": { "base": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } }, "description": "Default RWA bucket. The chain table uses this bucket unless stablecoins or governance assets are explicitly included." }, "stablecoinsOnly": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } } }, "governanceOnly": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } } }, "stablecoinsAndGovernance": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } } } } } }, "byAssetGroup": { "type": "object", "additionalProperties": { "type": "object", "properties": { "base": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } }, "description": "Default RWA bucket. The chain table uses this bucket unless stablecoins or governance assets are explicitly included." }, "stablecoinsOnly": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } } }, "governanceOnly": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } } }, "stablecoinsAndGovernance": { "type": "object", "properties": { "onChainMcap": { "type": "number", "example": 125000000 }, "activeAum": { "type": "number", "example": 118000000 }, "defiActiveTvl": { "type": "number", "example": 2500000 }, "assetCount": { "type": "integer", "example": 42 }, "assetIssuers": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "BlackRock"] } } } } } } } } } } } } } }, "/rwa/list": { "get": { "tags": ["RWA"], "x-api-plan-only": true, "summary": "List RWA ids and filter values", "description": "Returns lightweight RWA lists used for discovery, search, and filters.", "responses": { "200": { "description": "RWA list metadata", "content": { "application/json": { "schema": { "type": "object", "properties": { "canonicalMarketIds": { "type": "array", "items": { "type": "string" }, "example": ["ondo/usdy", "blackrock/buidl"] }, "platforms": { "type": "array", "items": { "type": "string" }, "example": ["Ondo Finance", "Securitize"] }, "chains": { "type": "array", "items": { "type": "string" }, "example": ["Ethereum", "Solana"] }, "categories": { "type": "array", "items": { "type": "string" }, "example": ["Treasuries", "Private Credit"] }, "assetGroups": { "type": "array", "items": { "type": "string" }, "example": ["Treasuries"] }, "idMap": { "type": "object", "additionalProperties": { "type": "string" }, "example": { "ondo/usdy": "ondo-usdy" } } } } } } } } } }, "/rwa/chain/{chain}": { "get": { "tags": ["RWA"], "x-api-plan-only": true, "summary": "List current RWA assets on a chain", "description": "Returns current RWA assets that have Onchain AUM, Active AUM or DeFi Active TVL on the requested chain.", "parameters": [ { "name": "chain", "in": "path", "required": true, "description": "Chain display name, case-insensitive.", "schema": { "type": "string", "example": "Ethereum" } } ], "responses": { "200": { "description": "RWA assets for the chain", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "ondo-usdy" }, "canonicalMarketId": { "type": "string", "nullable": true, "example": "ondo/usdy" }, "ticker": { "type": "string", "example": "USDY" }, "assetName": { "type": "string", "nullable": true, "example": "Ondo US Dollar Yield" }, "assetGroup": { "type": "string", "nullable": true, "example": "Treasuries" }, "primaryChain": { "type": "string", "nullable": true, "example": "Ethereum" }, "chain": { "type": "array", "nullable": true, "items": { "type": "string" }, "example": ["Ethereum", "Solana"] }, "category": { "type": "array", "nullable": true, "items": { "type": "string" }, "example": ["Treasuries"] }, "assetClass": { "type": "array", "nullable": true, "items": { "type": "string" }, "example": ["Fixed Income"] }, "type": { "type": "string", "nullable": true, "example": "Asset" }, "rwaClassification": { "type": "string", "nullable": true, "example": "Tokenized Asset" }, "accessModel": { "type": "string", "nullable": true, "example": "Permissioned" }, "issuer": { "type": "string", "nullable": true, "example": "Ondo Finance" }, "parentPlatform": { "type": "string", "nullable": true, "example": "Ondo Finance" }, "stablecoin": { "type": "boolean", "nullable": true, "example": false }, "governance": { "type": "boolean", "nullable": true, "example": false }, "onChainMcap": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "Ethereum": 125000000, "Solana": 45000000 }, "description": "Onchain AUM by chain: the USD value of all supply present onchain, whoever holds it." }, "activeAum": { "type": "object", "additionalProperties": { "type": "number" }, "example": { "Ethereum": 125000000, "Solana": 45000000 }, "description": "Active AUM by chain: the portion of Onchain AUM held in user or protocol-controlled positions, with issuer, treasury and custodial wallets excluded. This is the number a protocol page shows as RWA Active AUM." }, "defiActiveTvl": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } }, "example": { "Ethereum": { "aave-v3": 1500000, "morpho": 850000 } }, "description": "DeFi Active TVL by chain and tracked protocol: the subset of Active AUM deployed in third-party DeFi protocols DefiLlama tracks." }, "price": { "type": "number", "nullable": true, "example": 1.04 }, "activeAumData": { "type": "boolean", "example": true }, "coingeckoId": { "type": "string", "nullable": true, "example": "ondo-us-dollar-yield" }, "logo": { "type": "string", "nullable": true, "example": "https://icons.llamao.fi/icons/protocols/ondo.jpg" } } } } } } } } } } } }, "/rwa/chart/chain/{chain}": { "get": { "tags": ["RWA"], "x-api-plan-only": true, "summary": "Get historical RWA chart data for a chain", "description": "Returns historical Onchain AUM, Active AUM and DeFi Active TVL totals for a chain.", "parameters": [ { "name": "chain", "in": "path", "required": true, "description": "Chain display name. The API normalizes it to the internal RWA slug.", "schema": { "type": "string", "example": "Ethereum" } } ], "responses": { "200": { "description": "Historical RWA chain chart", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "integer", "example": 1716163200 }, "onChainMcap": { "type": "number", "nullable": true, "example": 125000000 }, "activeAum": { "type": "number", "nullable": true, "example": 118000000 }, "defiActiveTvl": { "type": "number", "nullable": true, "example": 2500000 } } } } } } } } } }, "/rwa/chart/chain-breakdown": { "get": { "tags": ["RWA"], "x-api-plan-only": true, "summary": "Get historical RWA metric breakdown by chain", "description": "Returns time series rows with one column per chain for the selected RWA metric.", "parameters": [ { "name": "key", "in": "query", "required": false, "description": "Metric to break down by chain, defaults to `onChainMcap`. `onChainMcap` is Onchain AUM, `activeAum` is Active AUM and `defiActiveTvl` is DeFi Active TVL. The retired spelling `activeMcap` is still accepted here.", "schema": { "type": "string", "enum": ["onChainMcap", "activeAum", "defiActiveTvl"], "example": "activeAum" } }, { "name": "includeStablecoin", "in": "query", "required": false, "description": "Include stablecoin-token assets in the chart totals.", "schema": { "type": "boolean", "example": false } }, { "name": "includeGovernance", "in": "query", "required": false, "description": "Include governance-token assets in the chart totals.", "schema": { "type": "boolean", "example": false } } ], "responses": { "200": { "description": "Historical chain breakdown rows", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": ["timestamp"], "properties": { "timestamp": { "type": "integer", "example": 1716163200 } }, "additionalProperties": { "type": "number" }, "example": { "timestamp": 1716163200, "Ethereum": 125000000, "Solana": 45000000 } } } } } } } } } } }