# Get Chart Data Source: https://docs.blockworks.com/api-reference/charts/data api-reference/charts/openapi.json GET /v1/charts/{visualizationId}/data Returns the rows behind one Blockworks Chart by id, with search, column selection, sorting and paging over the rows. # List Charts Source: https://docs.blockworks.com/api-reference/charts/list api-reference/charts/openapi.json GET /v1/charts Returns one page of the Blockworks Charts your key can read, each with the chart id, its title, and the Blockworks Dashboards it appears on. # Agentic Payments Source: https://docs.blockworks.com/api-reference/data-api/agentic-payments/agentic-payments Daily payments made by agents (x402 through the Coinbase facilitator on Base and Solana, MPP on Tempo): payment and transaction counts, USD volume, unique payers and payees, payment size distribution and network fees. Each series is one chain, facilitator, standard and token. One row per agentic payment series, keyed by chain, facilitator, standard and token: the chain, facilitator, standard, token and mapped network. The id is the series key of the agentic-payments timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `agentic-payments`: primary key `id` | | Timeseries model | `agentic-payments`: intervals `1d`, series key `id` (Agentic Payment ID), every series available in one call | ## Endpoints > [card] [List Agentic Payments](/api-reference/data-api/agentic-payments/tabular-agentic-payments) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Agentic Payment timeseries](/api-reference/data-api/agentic-payments/timeseries-agentic-payments) > > Up to 10 series in one request, named by series key in `series`. > [card] [Get Agentic Payment timeseries](/api-reference/data-api/agentic-payments/timeseries-agentic-payments-by-id) > > One series over a time window, keyed by its Agentic Payment ID. ## Metrics 16 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `paymentCount` | | | | | | `transactionCount` | | | | | | `paymentVolumeUSD` | | | | | | `uniquePayers` | | | | | | `uniquePayees` | | | | | | `avgPaymentSizeUSD` | | | | | | `medianPaymentSizeUSD` | | | | | | `p95PaymentSizeUSD` | | | | | | `maxPaymentSizeUSD` | | | | | | `totalTransactionFeesUSD` | | | | | | `avgTransactionFeeUSD` | | | | | | `paymentCountUnder1C` | | | | | | `paymentCount1CTo10C` | | | | | | `paymentCount10CTo1` | | | | | | `paymentCount1To10` | | | | | | `paymentCount10Plus` | | | | | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `chain` | string | | | The short name of the chain (ethereum, base, solana). | | `facilitator` | string | | | The payment facilitator (coinbase for x402, tempo for MPP). | | `id` | string | | | The series key of the agentic-payments timeseries model, the chain, facilitator, standard and token address, joined with underscores. | | `name` | string | | | The display name of the series. | | `networkID` | string | | | The chain's networkID in the blockchains model; null when unmapped. | | `standard` | string | | | The agent payment standard (x402 or mpp). | | `tokenAddress` | string | | | The token contract address (the mint address on Solana). | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/agentic-payments/1d/?timeframe=7d&selections=paymentCount,transactionCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Agentic Payment timeseries](/api-reference/data-api/agentic-payments/timeseries-agentic-payments-by-id) for the response and the errors. # Agentic Payments Source: https://docs.blockworks.com/api-reference/data-api/agentic-payments/overview Machine-to-machine payment activity per chain, facilitator, standard and token. Each series carries payment and transaction counts, volume in USD, unique payers and payees, average, median, 95th percentile and maximum payment size, the fees paid to settle them, and how many payments fell in each size band from under a cent to ten dollars and over. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Agentic Payments](/api-reference/data-api/agentic-payments/agentic-payments) | Lending-protocols-dataset | [List rows](/api-reference/data-api/agentic-payments/tabular-agentic-payments) | [Batch](/api-reference/data-api/agentic-payments/timeseries-agentic-payments), [One series](/api-reference/data-api/agentic-payments/timeseries-agentic-payments-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/agentic-payments?pageSize=3&selections=id,name,chain,facilitator" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Agentic Payments](/api-reference/data-api/agentic-payments/tabular-agentic-payments) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Agentic Payments Source: https://docs.blockworks.com/api-reference/data-api/agentic-payments/tabular-agentic-payments api-reference/data-api/openapi.json GET /query/tabular/agentic-payments One row per agentic payment series, keyed by chain, facilitator, standard and token: the chain, facilitator, standard, token and mapped network. The id is the series key of the agentic-payments timeseries model. # Batch Get Agentic Payment timeseries Source: https://docs.blockworks.com/api-reference/data-api/agentic-payments/timeseries-agentic-payments api-reference/data-api/openapi.json GET /query/timeseries/agentic-payments/{granularity} Daily payments made by agents (x402 through the Coinbase facilitator on Base and Solana, MPP on Tempo): payment and transaction counts, USD volume, unique payers and payees, payment size distribution and network fees. Each series is one chain, facilitator, standard and token. # Get Agentic Payment timeseries Source: https://docs.blockworks.com/api-reference/data-api/agentic-payments/timeseries-agentic-payments-by-id api-reference/data-api/openapi.json GET /query/timeseries/agentic-payments/{granularity}/{id} Daily payments made by agents (x402 through the Coinbase facilitator on Base and Solana, MPP on Tempo): payment and transaction counts, USD volume, unique payers and payees, payment size distribution and network fees. Each series is one chain, facilitator, standard and token. # Asset Marketcap Source: https://docs.blockworks.com/api-reference/data-api/assets/asset-marketcap Market capitalization of an asset over time: circulating market cap, its dominance of the total crypto market and fully diluted valuation, in USD. Each series is one asset, keyed by its asset id. | | | | - | - | | Access | Assets-dataset | | Timeseries model | `asset-marketcap`: intervals `1h`, `1d`, `1w`, series key `id` (Asset ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-marketcap) > > Up to 10 series in one request, named by Asset ID in `series`. > [card] [Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-marketcap-by-id) > > One series over a time window, keyed by its Asset ID. ## Metrics 3 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `circulating-marketcap` | Circulating Marketcap | float64 | usd | The market capitalization of the asset, calculated using the circulating supply | | `circulating-marketcap-dominance` | Circulating Marketcap Dominance | float64 | percent | The market capitalization of the asset as a percentage of the total market capitalization of all crypto assets | | `fully-diluted-marketcap` | Fully Diluted Marketcap | float64 | usd | The market capitalization of the asset, calculated using the fully diluted supply. Commonly known as Fully Diluted Valuation (FDV). | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/asset-marketcap/1d/1e31218a-e44e-4285-820c-8282ee222035?timeframe=7d&selections=circulating-marketcap,circulating-marketcap-dominance" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-marketcap-by-id) for the response and the errors. # Asset Price Source: https://docs.blockworks.com/api-reference/data-api/assets/asset-price Volume-weighted average price candles for an asset: open, high, low, close and volume in USD. Each series is one asset, keyed by its asset id. The model for price charts, returns and backtests. | | | | - | - | | Access | Assets-dataset | | Timeseries model | `asset-price`: intervals `5m`, `1h`, `1d`, `1w`, series key `assetID` (Asset ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-price) > > Up to 10 series in one request, named by Asset ID in `series`. > [card] [Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-price-by-id) > > One series over a time window, keyed by its Asset ID. ## Metrics 5 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `open` | Open Price | float64 | usd | Price at the candle open. | | `high` | High Price | float64 | usd | High price during the candle. | | `low` | Low Price | float64 | usd | Low price during the candle. | | `close` | Close Price | float64 | usd | Price at the candle close. | | `volume` | Volume | float64 | | Total trade volume during the candle. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/asset-price/1d/1e31218a-e44e-4285-820c-8282ee222035?timeframe=7d&selections=close,volume" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-price-by-id) for the response and the errors. # Asset Sharpe Source: https://docs.blockworks.com/api-reference/data-api/assets/asset-sharpe Sharpe ratio of an asset over trailing 30-day, 90-day, one-year and three-year windows. Each series is one asset, keyed by its asset id. Compares risk-adjusted performance across assets. | | | | - | - | | Access | Assets-dataset | | Timeseries model | `asset-sharpe`: intervals `1d`, `1w`, series key `id` (Asset ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-sharpe) > > Up to 10 series in one request, named by Asset ID in `series`. > [card] [Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-sharpe-by-id) > > One series over a time window, keyed by its Asset ID. ## Metrics 4 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `sharpe-ratio-30d` | Sharpe Ratio 30D | float64 | | The Sharpe ratio of the asset over the last 30 days | | `sharpe-ratio-90d` | Sharpe Ratio 90D | float64 | | The Sharpe ratio of the asset over the last 90 days | | `sharpe-ratio-1y` | Sharpe Ratio 1Y | float64 | | The Sharpe ratio of the asset over the last year | | `sharpe-ratio-3y` | Sharpe Ratio 3Y | float64 | | The Sharpe ratio of the asset over the last 3 years | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/asset-sharpe/1d/1e31218a-e44e-4285-820c-8282ee222035?timeframe=7d&selections=sharpe-ratio-30d,sharpe-ratio-90d" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-sharpe-by-id) for the response and the errors. # Asset Supply Source: https://docs.blockworks.com/api-reference/data-api/assets/asset-supply Circulating and total token supply of an asset over time. Each series is one asset, keyed by its asset id. Tracks emissions and unlocks, or rebuilds market cap together with asset-price. | | | | - | - | | Access | Assets-dataset | | Timeseries model | `asset-supply`: intervals `1d`, `1w`, series key `id` (Asset ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-supply) > > Up to 10 series in one request, named by Asset ID in `series`. > [card] [Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-supply-by-id) > > One series over a time window, keyed by its Asset ID. ## Metrics 2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `circulating-supply` | Circulating Supply | float64 | | The number of tokens that exist, excluding those that are locked in contracts or otherwise not available for trading | | `total-supply` | Total Supply | float64 | | The total number of tokens that exist | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/asset-supply/1d/1e31218a-e44e-4285-820c-8282ee222035?timeframe=7d&selections=circulating-supply,total-supply" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-supply-by-id) for the response and the errors. # Asset Volatility Source: https://docs.blockworks.com/api-reference/data-api/assets/asset-volatility Realized volatility of an asset over trailing 30-day, 90-day, one-year and three-year windows. Each series is one asset, keyed by its asset id. Compares risk across assets. | | | | - | - | | Access | Assets-dataset | | Timeseries model | `asset-volatility`: intervals `1d`, `1w`, series key `id` (Asset ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-volatility) > > Up to 10 series in one request, named by Asset ID in `series`. > [card] [Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-volatility-by-id) > > One series over a time window, keyed by its Asset ID. ## Metrics 4 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `volatility-30d` | Volatility 30D | float64 | | The average daily price movement of the asset over the last 30 days | | `volatility-90d` | Volatility 90D | float64 | | The average daily price movement of the asset over the last 90 days | | `volatility-1y` | Volatility 1Y | float64 | | The average daily price movement of the asset over the last year | | `volatility-3y` | Volatility 3Y | float64 | | The average daily price movement of the asset over the last 3 years | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/asset-volatility/1d/1e31218a-e44e-4285-820c-8282ee222035?timeframe=7d&selections=volatility-30d,volatility-90d" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Asset timeseries](/api-reference/data-api/assets/timeseries-asset-volatility-by-id) for the response and the errors. # Assets Source: https://docs.blockworks.com/api-reference/data-api/assets/assets One row per crypto asset, keyed by assetID and also found by slug or ticker: name, symbol, logo, sector taxonomy, stablecoin and wrapped-asset flags, the primary project, onchain contracts, and circulating market cap with its rank. The assetID is the series key of the per-asset timeseries models. | | | | - | - | | Access | Assets-dataset | | Tabular model | `assets`: primary key `assetID`, identifiers `slug`, `prioritySymbol`, aliases `asset-entities` | ## Endpoints > [card] [List Assets](/api-reference/data-api/assets/tabular-assets) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Asset](/api-reference/data-api/assets/tabular-assets-by-id) > > One row by `assetID` or by `slug`, `prioritySymbol`. ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `assetID` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The unique identifier of the asset. (primary key) | | `assetSerialID` | int64 | `Eq`, `IsOneOf` | | The numeric serial identifier of the asset, used by market data services. | | `name` | string | `Eq`, `IsOneOf`, `Contains` | yes | The name of the asset. | | `slug` | string | `Eq`, `IsOneOf` | yes | The URL slug of the asset. (identifier 1) | | `symbol` | string | `Eq`, `IsOneOf`, `IsNotOneOf`, `Contains` | yes | The ticker symbol of the asset. Not unique: several assets may share a ticker. | | `prioritySymbol` | string | `Eq`, `IsOneOf` | | The canonical asset for a ticker, set only on the asset that owns it. Unique where present, so it is a safe single-row lookup key. (identifier 2) | | `logoURL` | string | | | The URL of the asset's logo. | | `sector` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The sector the asset belongs to. | | `sectorsV2` | array_string | `Includes`, `NotIncludes`, `IncludesAnyOf`, `NotIncludesAnyOf` | | The v2-taxonomy sectors the asset belongs to. | | `subSectorsV2` | array_string | `Includes`, `NotIncludes`, `IncludesAnyOf`, `NotIncludesAnyOf` | | The v2-taxonomy sub-sectors the asset belongs to. | | `isStablecoin` | bool | `Eq`, `NotEq` | | If true, the asset is tagged as a stablecoin. | | `isWrappedAsset` | bool | `Eq`, `NotEq` | | If true, the asset is tagged as a wrapped or synthetic asset. | | `coveredByIntel` | bool | `Eq`, `NotEq` | | If true, the asset is covered by Messari Intel. | | `primaryProjectID` | string | `Eq`, `IsOneOf` | | The unique identifier of the asset's primary project. | | `primaryProjectSlug` | string | `Eq`, `IsOneOf` | | The URL slug of the asset's primary project. Resolves an asset URL to its canonical project URL. | | `primaryProjectName` | string | | | The name of the asset's primary project. | | `primaryProjectTagline` | string | | | The one-line tagline of the asset's primary project. | | `primaryProjectOverview` | string | | | The markdown overview of the asset's primary project. | | `primaryProjectLogoURL` | string | | | The URL of the primary project's logo. | | `primaryProjectLinks` | array_object | | | The primary project's external links, each with link, name, and type. | | `platformContracts` | array_object | | | The asset's onchain contracts, each with platform, contractAddress, and the network's id, name, slug, and logo URL. | | `circulatingMarketcap` | float64 | `Gt`, `Gte`, `Lt`, `Lte` | yes | The circulating marketcap of the asset. Carried so search and filter results can be ranked by size. | | `circulatingMarketcapRank` | int32 | `Gt`, `Gte`, `Lt`, `Lte`, `IsOneOf` | default | The rank of the asset by circulating marketcap. Shares its definition with the assets-ranking model. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/assets?pageSize=3&selections=assetID,slug,prioritySymbol,name" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Assets](/api-reference/data-api/assets/tabular-assets) for the response and the errors. # Assets Source: https://docs.blockworks.com/api-reference/data-api/assets/overview The asset master table and the per-asset market series: price candles, market cap, supply, Sharpe ratio and realized volatility. Start with the Assets table to resolve a slug or ticker to an assetID; every timeseries model in this group is keyed by it. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Assets](/api-reference/data-api/assets/assets) | Assets-dataset | [List rows](/api-reference/data-api/assets/tabular-assets), [One row](/api-reference/data-api/assets/tabular-assets-by-id) | | | [Asset Marketcap](/api-reference/data-api/assets/asset-marketcap) | Assets-dataset | | [Batch](/api-reference/data-api/assets/timeseries-asset-marketcap), [One series](/api-reference/data-api/assets/timeseries-asset-marketcap-by-id) | | [Asset Price](/api-reference/data-api/assets/asset-price) | Assets-dataset | | [Batch](/api-reference/data-api/assets/timeseries-asset-price), [One series](/api-reference/data-api/assets/timeseries-asset-price-by-id) | | [Asset Sharpe](/api-reference/data-api/assets/asset-sharpe) | Assets-dataset | | [Batch](/api-reference/data-api/assets/timeseries-asset-sharpe), [One series](/api-reference/data-api/assets/timeseries-asset-sharpe-by-id) | | [Asset Supply](/api-reference/data-api/assets/asset-supply) | Assets-dataset | | [Batch](/api-reference/data-api/assets/timeseries-asset-supply), [One series](/api-reference/data-api/assets/timeseries-asset-supply-by-id) | | [Asset Volatility](/api-reference/data-api/assets/asset-volatility) | Assets-dataset | | [Batch](/api-reference/data-api/assets/timeseries-asset-volatility), [One series](/api-reference/data-api/assets/timeseries-asset-volatility-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/assets?pageSize=3&selections=assetID,slug,prioritySymbol,name" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Assets](/api-reference/data-api/assets/tabular-assets) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Assets Source: https://docs.blockworks.com/api-reference/data-api/assets/tabular-assets api-reference/data-api/openapi.json GET /query/tabular/assets One row per crypto asset, keyed by assetID and also found by slug or ticker: name, symbol, logo, sector taxonomy, stablecoin and wrapped-asset flags, the primary project, onchain contracts, and circulating market cap with its rank. The assetID is the series key of the per-asset timeseries models. # Get Asset Source: https://docs.blockworks.com/api-reference/data-api/assets/tabular-assets-by-id api-reference/data-api/openapi.json GET /query/tabular/assets/{assetID} One row per crypto asset, keyed by assetID and also found by slug or ticker: name, symbol, logo, sector taxonomy, stablecoin and wrapped-asset flags, the primary project, onchain contracts, and circulating market cap with its rank. The assetID is the series key of the per-asset timeseries models. # Batch Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/assets/timeseries-asset-marketcap api-reference/data-api/openapi.json GET /query/timeseries/asset-marketcap/{granularity} Market capitalization of an asset over time: circulating market cap, its dominance of the total crypto market and fully diluted valuation, in USD. Each series is one asset, keyed by its asset id. # Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/assets/timeseries-asset-marketcap-by-id api-reference/data-api/openapi.json GET /query/timeseries/asset-marketcap/{granularity}/{id} Market capitalization of an asset over time: circulating market cap, its dominance of the total crypto market and fully diluted valuation, in USD. Each series is one asset, keyed by its asset id. # Batch Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/assets/timeseries-asset-price api-reference/data-api/openapi.json GET /query/timeseries/asset-price/{granularity} Volume-weighted average price candles for an asset: open, high, low, close and volume in USD. Each series is one asset, keyed by its asset id. The model for price charts, returns and backtests. # Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/assets/timeseries-asset-price-by-id api-reference/data-api/openapi.json GET /query/timeseries/asset-price/{granularity}/{assetID} Volume-weighted average price candles for an asset: open, high, low, close and volume in USD. Each series is one asset, keyed by its asset id. The model for price charts, returns and backtests. # Batch Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/assets/timeseries-asset-sharpe api-reference/data-api/openapi.json GET /query/timeseries/asset-sharpe/{granularity} Sharpe ratio of an asset over trailing 30-day, 90-day, one-year and three-year windows. Each series is one asset, keyed by its asset id. Compares risk-adjusted performance across assets. # Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/assets/timeseries-asset-sharpe-by-id api-reference/data-api/openapi.json GET /query/timeseries/asset-sharpe/{granularity}/{id} Sharpe ratio of an asset over trailing 30-day, 90-day, one-year and three-year windows. Each series is one asset, keyed by its asset id. Compares risk-adjusted performance across assets. # Batch Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/assets/timeseries-asset-supply api-reference/data-api/openapi.json GET /query/timeseries/asset-supply/{granularity} Circulating and total token supply of an asset over time. Each series is one asset, keyed by its asset id. Tracks emissions and unlocks, or rebuilds market cap together with asset-price. # Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/assets/timeseries-asset-supply-by-id api-reference/data-api/openapi.json GET /query/timeseries/asset-supply/{granularity}/{id} Circulating and total token supply of an asset over time. Each series is one asset, keyed by its asset id. Tracks emissions and unlocks, or rebuilds market cap together with asset-price. # Batch Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/assets/timeseries-asset-volatility api-reference/data-api/openapi.json GET /query/timeseries/asset-volatility/{granularity} Realized volatility of an asset over trailing 30-day, 90-day, one-year and three-year windows. Each series is one asset, keyed by its asset id. Compares risk across assets. # Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/assets/timeseries-asset-volatility-by-id api-reference/data-api/openapi.json GET /query/timeseries/asset-volatility/{granularity}/{id} Realized volatility of an asset over trailing 30-day, 90-day, one-year and three-year windows. Each series is one asset, keyed by its asset id. Compares risk across assets. # Blockchains Source: https://docs.blockworks.com/api-reference/data-api/blockchains/blockchains Onchain metrics for a network: transactions, addresses, contract activity, fees, revenue, DEX and perp volume, TVL, stablecoin supply and flows, bridge and issuer flows, staking, real-world assets and developer activity. Each series is one network, keyed by its network id. Coverage differs by network, so pass selections for the metrics you need. HyperCore bridge and issuer flows include HyperEVM. One row per blockchain network, keyed by networkID and also found by slug: name, logo, ecosystem, layer-2 flag, whether it reports onchain metrics, external ids and the linked project with its primary asset. The networkID is the series key of the blockchains timeseries model. | | | | - | - | | Access | Blockchains-dataset | | Tabular model | `blockchains`: primary key `networkID`, identifiers `slug`, aliases `network-entities`, `networks` | | Timeseries model | `blockchains`: intervals `1d`, `1w`, series key `id` (Network ID), series must be named (up to 10 per call), aliases `network`, `networks` | ## Endpoints > [card] [List Blockchains](/api-reference/data-api/blockchains/tabular-blockchains) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Blockchain](/api-reference/data-api/blockchains/tabular-blockchains-by-id) > > One row by `networkID` or by `slug`. > [card] [Batch Get Blockchain timeseries](/api-reference/data-api/blockchains/timeseries-blockchains) > > Up to 10 series in one request, named by Network ID in `series`. > [card] [Get Blockchain timeseries](/api-reference/data-api/blockchains/timeseries-blockchains-by-id) > > One series over a time window, keyed by its Network ID. ## Metrics 121 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `successful-transactions` | Successful Transactions | int64 | | Number of initiated transactions successfully added to blockchain. | | `unsuccessful-transactions` | Unsuccessful Transactions | int64 | | Number of initiated transactions that failed to be added to blockchain. | | `new-addresses` | New Addresses | float64 | | Daily unique wallet addresses that are transacting for the first time. | | `returning-addresses` | Returning Addresses | float64 | | Daily unique wallet addresses that send a transaction in a day and have transacted prior to that day. | | `active-contracts` | Active Contracts | float64 | | Deprecated and always NULL: no source. Number of unique contracts called in the time span. | | `total-contract-calls` | Total Contract Calls | float64 | | Deprecated and always NULL: no source. Number of times contracts are called. | | `new-contracts-called` | New Contracts Called | float64 | | Deprecated and always NULL: no source. Number of unique contracts called for the first time. | | `returning-contracts-called` | Returning Contracts Called | float64 | | Deprecated and always NULL: no source. Daily number of unique contracts called that have also been called prior to that day. | | `unique-contract-callers` | Unique Contract Callers | float64 | | Deprecated and always NULL: no source. Daily number of unique addresses that call a contract. | | `dex-volume-usd` | DEX Volume (USD) | float64 | usd | Value of all tokens swapped across all decentralized exchanges (DEXs) on a network in USD. | | `dex-volume-dominance` | DEX Volume Dominance | float64 | percent | This network's share of global DEX volume on the same day, as a percentage. Sums to 100 across all networks per day. | | `options-volume` | Options Volume USD | float64 | usd | Deprecated and always NULL: no source. Options trading volume attributed to the network, in USD. | | `bridge-deposit-volume` | Bridge Deposit Volume USD | float64 | usd | Deprecated and always NULL: use bridge-inflow-usd. The old source counted assets that left the network here. | | `bridge-withdraw-volume` | Bridge Withdraw Volume USD | float64 | usd | Deprecated and always NULL: use bridge-outflow-usd. The old source counted assets that came onto the network here. | | `bridge-net-flow` | Bridge Net Flow USD | float64 | usd | Deprecated: use bridge-net-flow-usd (same value). | | `bridge-inflow-usd` | Bridge Inflow (USD) | float64 | usd | Value of bridge transfers that arrive on the network, in USD. | | `bridge-outflow-usd` | Bridge Outflow (USD) | float64 | usd | Value of bridge transfers that leave the network, in USD. | | `bridge-net-flow-usd` | Bridge Net Flow (USD) | float64 | usd | bridge-inflow-usd minus bridge-outflow-usd; positive = net inflow. | | `bridge-inflow-transfer-count` | Bridge Inflow Transfer Count | float64 | | Counted bridge transfers that arrive on the network, priced or not. A weekly value sums the days that have a value. On HyperCore, includes HyperEVM flows, so the HyperEVM network has no value. From Blockworks Research. | | `bridge-outflow-transfer-count` | Bridge Outflow Transfer Count | float64 | | Counted bridge transfers that leave the network, priced or not. A weekly value sums the days that have a value. On HyperCore, includes HyperEVM flows, so the HyperEVM network has no value. From Blockworks Research. | | `bridge-rebalance-net-flow-usd` | Bridge Rebalance Net Flow (USD) | float64 | usd | The part of bridge-net-flow-usd from solver or treasury rebalances, which repeat an earlier bridge transfer. | | `issuer-mint-usd` | Issuer Mint (USD) | float64 | usd | Fiat-backed and commodity tokens that issuers put into the market on the network, in USD. | | `issuer-redeem-usd` | Issuer Redeem (USD) | float64 | usd | Fiat-backed and commodity tokens that issuers take back from the market on the network, in USD. | | `issuer-net-issuance-usd` | Issuer Net Issuance (USD) | float64 | usd | issuer-mint-usd minus issuer-redeem-usd. | | `tokenized-equity-mint-usd` | Tokenized Equity Mint (USD) | float64 | usd | Tokenized equity tokens that issuers put into the market on the network, in USD. | | `tokenized-equity-redeem-usd` | Tokenized Equity Redeem (USD) | float64 | usd | Tokenized equity tokens that issuers take back from the market on the network, in USD. | | `tokenized-equity-net-issuance-usd` | Tokenized Equity Net Issuance (USD) | float64 | usd | tokenized-equity-mint-usd minus tokenized-equity-redeem-usd. | | `net-capital-flow-usd` | Net Capital Flow (USD) | float64 | usd | Net capital that enters the network, in USD: bridge net flow without rebalances, plus issuer net issuance and (from 2026-07-22) tokenized equity net issuance; positive = net inflow. | | `gas-spenders` | Gas Spenders | int64 | | Addresses that spent gas in the period. | | `total-stablecoin-circulating` | Stablecoin Market Cap | float64 | usd | Deprecated: same value as stablecoin-outstanding-supply-usd, which replaces it. | | `circulating-marketcap` | Circulating Marketcap | float64 | usd | Value of circulating supply of native token. | | `total-transactions` | Daily Transactions | float64 | | The number of successful and unsuccessful transactions in a day. | | `block-time-ms` | Block Time (ms) | float64 | | Average time taken to produce a block in milliseconds. | | `transactions-per-second` | Transactions Per Second | float64 | | Average transactions per second processed by the network. | | `active-addresses` | Daily Active Addresses | float64 | | The number of new and returning unique wallet addresses that send a transaction in a day. | | `new-contracts-deployed` | New Contracts Deployed | float64 | | The number of new contracts deployed in a day. | | `contract-deployers` | Contract Deployers | float64 | | Addresses that deployed a contract in the period. | | `fee-revenue` | Transaction Fees | float64 | usd | Deprecated. Legacy Blockworks fee totals can include MEV and fall back to vendor data. Use transaction-fees-usd for fees alone or real-economic-value-usd for fees plus MEV tips. | | `fee-median` | Median Transaction Fees | float64 | usd | Median fees paid for processing transactions. | | `rolling-7d-avg-transaction-fees` | Rolling 7D Average Transaction Fees | float64 | usd | 7 day rolling average of daily total transaction fees, from a vendor. Deprecated: use transaction-fees-\* or real-economic-value-\* and compute the 7 day average on the client. | | `average-fee-per-transaction` | Average Fee Per Transaction | float64 | usd | Value of daily Transaction Fees divided by number of Transactions. | | `fees-supply-side-usd` | Fees Supply Side (USD) | float64 | usd | Share of fees that goes to the service providers. Deprecated: Token Terminal data, with no replacement. | | `expenses-usd` | Expenses (USD) | float64 | usd | Total expenses of the network in USD. Deprecated: Token Terminal data, with no replacement. | | `transaction-fees-usd` | Transaction Fees (USD) | float64 | usd | Fees paid through the protocol's own fee mechanism, in USD: base, priority, blob and L1-data fees, and Solana vote fees. Excludes MEV and tips. From Blockworks Research. NULL for THORChain, and on days without a USD price (before price coverage starts, and on the newest day until its price lands). A weekly value sums only the days that have a value. | | `transaction-fees-native` | Transaction Fees (Native) | float64 | native-token | Fees paid through the protocol's own fee mechanism, in the native token: base, priority, blob and L1-data fees, and Solana vote fees. Excludes MEV and tips. From Blockworks Research. The native token is the token that pays gas, which is not always the primary asset. NULL for Bitcoin, Tempo and THORChain. A weekly value sums only the days that have a value. | | `mev-tips-usd` | MEV Tips (USD) | float64 | usd | Payments outside the protocol fee mechanism to get a transaction included or ordered, in USD (for example Solana Jito and landing-service tips, Ethereum MEV-boost payments, BNB, Sui, Polygon and Monad MEV payments, and historical Arbitrum Timeboost). 0 on a day that has a Blockworks Research value but no detected tips. From Blockworks Research. NULL for THORChain, and on days without a USD price (before price coverage starts, and on the newest day until its price lands). A weekly value sums only the days that have a value. | | `mev-tips-native` | MEV Tips (Native) | float64 | native-token | Payments outside the protocol fee mechanism to get a transaction included or ordered, in the native token (for example Solana Jito and landing-service tips, Ethereum MEV-boost payments, BNB, Sui, Polygon and Monad MEV payments, and historical Arbitrum Timeboost). 0 on a day that has a Blockworks Research value but no detected tips. From Blockworks Research. The native token is the token that pays gas, which is not always the primary asset. NULL for Bitcoin, Tempo and THORChain. A weekly value sums only the days that have a value. | | `real-economic-value-usd` | Real Economic Value (USD) | float64 | usd | Real economic value (REV) in USD: transaction fees plus MEV tips. It is not revenue. Blockworks Research only, with no Token Terminal fallback. NULL for THORChain, and on days without a USD price (before price coverage starts, and on the newest day until its price lands). A weekly value sums only the days that have a value. | | `real-economic-value-native` | Real Economic Value (Native) | float64 | native-token | Real economic value (REV) in the native token: transaction fees plus MEV tips. It is not revenue. Blockworks Research only, with no Token Terminal fallback. The native token is the token that pays gas, which is not always the primary asset. NULL for Bitcoin, Tempo and THORChain. A weekly value sums only the days that have a value. | | `stablecoin-outstanding-supply-usd` | Stablecoin Outstanding Supply (USD) | float64 | usd | Total stablecoin outstanding supply of the network in USD. | | `stablecoin-active-addresses` | Stablecoin Active Addresses | float64 | | Number of unique addresses that sent a stablecoin transfer. | | `stablecoin-total-addresses` | Stablecoin Total Addresses | float64 | | Number of unique addresses that sent or receive a stablecoin transfer. | | `stablecoin-transaction-volume-usd` | Stablecoin Transaction Volume (USD) | float64 | usd | Stablecoin transaction volume in USD, aggregated across all stablecoins. | | `stablecoin-transaction-count` | Stablecoin Transaction Count | float64 | | Total stablecoin transaction count, aggregated across all stablecoins. | | `stablecoin-avg-transaction-value-usd` | Stablecoin Avg Transaction Value (USD) | float64 | usd | Average stablecoin transaction value in USD. | | `tvl-usd` | TVL USD | float64 | usd | Total Value Locked in the network in USD. | | `tvl-dominance` | TVL Dominance | float64 | percent | This network's share of global TVL on the same day, as a percentage. Sums to 100 across all networks per day. | | `ecosystem-fees-usd` | Ecosystem Fees (USD) | float64 | usd | USD value of all fees generated by projects within the network's ecosystem. | | `code-commits` | Code Commits | float64 | | Number of code commits to the network's primary repository in the time period. | | `active-developers` | Active Developers | float64 | | Number of developers that have made at least one commit to the network's primary repository in the last 30 days. | | `ecosystem-code-commits` | Ecosystem Code Commits | float64 | | Number of code commits to projects in the network's ecosystem. | | `energy-stake-income-native` | Energy Stake Income (TRX) | float64 | native-token | Income from energy staking in native tokens. | | `energy-stake-income-usd` | Energy Stake Income USD | float64 | percent | Income from energy staking in USD. | | `fees-paid-to-l2-usd` | Fees Paid to L2 (USD) | float64 | usd | Fees paid to L2 sequencers or validators. | | `rent-paid-to-l1-usd` | Rent Paid to L1 (USD) | float64 | usd | Rent or fees paid to the L1 network for data availability and settlement. | | `gas-used` | Gas Used | float64 | | Total EVM gas used by transactions in the time period. NULL on networks without EVM gas. | | `trading-volume-usd` | Trading Volume (USD) | float64 | usd | Total trading volume across the network's ecosystem in USD. | | `borrowed-usd` | Borrowed (USD) | float64 | usd | Total amount borrowed across lending protocols on the network in USD. | | `borrowed-dominance` | Borrowed Dominance | float64 | percent | This network's share of global outstanding borrowed USD on the same day, as a percentage. Sums to 100 across all networks per day. | | `capital-deployed` | Capital Deployed (USD) | float64 | usd | Total capital deployed in the network's ecosystem in USD. | | `pf-circulating` | P/F Circulating | float64 | | Price-to-fees ratio based on circulating market cap. | | `ps-circulating` | P/S Circulating | float64 | | Price-to-sales ratio based on circulating market cap. | | `tvl-native` | TVL (Native) | float64 | native-token | Total Value Locked on the network denominated in the network's native asset (TVL USD divided by the native asset's daily VWAP price). | | `rwa-tvl-usd` | RWA TVL (USD) | float64 | usd | Total RWA TVL on this network in USD. | | `rwa-tokenholders` | RWA Tokenholders | float64 | | Total number of RWA tokenholders on this network. | | `rwa-project-count` | RWA Project Count | float64 | | Number of distinct RWA projects on this network. | | `rwa-asset-market-cap-usd` | RWA Asset Market Cap (USD) | float64 | usd | Total RWA asset market cap on this network in USD. | | `rwa-capital-deployed-usd` | RWA Capital Deployed (USD) | float64 | usd | Total RWA capital deployed on this network in USD. | | `rwa-outstanding-supply-usd` | RWA Outstanding Supply (USD) | float64 | usd | Total RWA outstanding supply on this network in USD. | | `total-staked-native` | Total Staked (Native) | float64 | native-token | Total native tokens staked on the network. Falls back to Avalanche primary-chain data where there is no coverage. | | `total-staked-usd` | Total Staked (USD) | float64 | | USD value of total stake on the network. | | `staking-rate-pct` | Staking Rate (%) | float64 | | Percentage (0-100) of native circulating supply staked. | | `validator-count` | Validator Count | float64 | | Number of validators on the network. | | `delegator-count` | Delegator Count | float64 | | Number of delegators on the network. | | `liquid-staked-native` | Liquid Staked (Native) | float64 | native-token | Native tokens staked via liquid staking protocols. | | `liquid-staked-usd` | Liquid Staked (USD) | float64 | | USD value of tokens staked via liquid staking protocols. | | `liquid-staking-rate-pct` | Liquid Staking Rate (%) | float64 | | Percentage (0-100) of staked native tokens that are liquid staked. | | `native-staked-native` | Native Staked (Native) | float64 | native-token | Native tokens staked directly, excluding liquid staking. | | `native-staked-usd` | Native Staked (USD) | float64 | | USD value of tokens staked directly, excluding liquid staking. | | `net-stake-flow-native` | Net Stake Flow (Native) | float64 | native-token | Net stake flow in native tokens over the period; negative values indicate net unstaking. | | `net-stake-flow-usd` | Net Stake Flow (USD) | float64 | | Net stake flow in USD over the period; negative values indicate net unstaking. | | `staking-apr-30d-pct` | Staking APR 30D (%) | float64 | | Trailing 30-day gross staking rewards divided by average stake, annualized without compounding, in percent. | | `staking-apy-30d-pct` | Staking APY 30D (%) | float64 | | Annualized staking yield with compounding, net of validator commission where reported, in percent. The window and source vary by chain. | | `real-staking-apy-30d-pct` | Real Staking APY 30D (%) | float64 | | Staking APY 30D minus Staking Inflation Rate 30D, in percent. | | `staking-inflation-rate-30d-pct` | Staking Inflation Rate 30D (%) | float64 | | Annualized native supply inflation, in percent: 30-day total supply growth net of burns, or the protocol inflation rate where one is published. | | `staking-rewards-native` | Staking Rewards (Native) | float64 | native-token | Staking rewards paid in native tokens over the period. | | `staking-rewards-usd` | Staking Rewards (USD) | float64 | | Staking rewards paid in USD over the period. | | `active-validator-count` | Active Validator Count | float64 | | Number of active validators on the network. | | `avg-validator-commission-rate` | Average Validator Commission Rate | float64 | | Average validator commission rate. | | `stake-weighted-commission-rate` | Stake-Weighted Commission Rate | float64 | | Stake-weighted validator commission rate. | | `spot-dex-trade-count` | Spot DEX Trade Count | float64 | | Daily spot DEX trade count on the network. | | `perp-dex-volume-usd` | Perp DEX Volume (USD) | float64 | | Daily perpetual DEX trading volume in USD. | | `perp-dex-open-interest-usd` | Perp DEX Open Interest (USD) | float64 | | Perpetual DEX open interest in USD. | | `perp-dex-trade-count` | Perp DEX Trade Count | float64 | | Daily perpetual DEX trade count on the network. | | `perp-dex-fees-usd` | Perp DEX Fees (USD) | float64 | | Daily perpetual DEX fees in USD. | | `perp-dex-revenue-usd` | Perp DEX Revenue (USD) | float64 | | Daily perpetual DEX revenue in USD. | | `lending-tvl-usd` | Lending TVL (USD) | float64 | | Lending-protocol TVL on the network (deposits minus borrows) in USD. | | `app-revenue-usd` | Application Revenue (USD) | float64 | | Daily application-level revenue on the network in USD. | | `stablecoin-count` | Stablecoin Count | float64 | | Distinct stablecoins present on the network that day. | | `stablecoin-usd-pegged-supply-usd` | Stablecoin USD-Pegged Supply (USD) | float64 | | Circulating supply of USD-pegged stablecoins on the network in USD. | | `stablecoin-non-usd-pegged-supply-usd` | Stablecoin Non-USD-Pegged Supply (USD) | float64 | | Circulating supply of stablecoins pegged to currencies other than the US dollar, in USD. | | `stablecoin-balance-protocol-owned-usd` | Stablecoin Balance - Protocol Owned (USD) | float64 | | Stablecoin supply held in issuer or protocol controlled addresses, in USD. | | `stablecoin-balance-bridge-usd` | Stablecoin Balance - Bridges (USD) | float64 | | Stablecoin supply held in bridge contracts, in USD. | | `stablecoin-balance-cex-usd` | Stablecoin Balance - CEXes (USD) | float64 | | Stablecoin supply held in centralized exchange addresses, in USD. | | `stablecoin-balance-perp-dex-usd` | Stablecoin Balance - Perp DEXes (USD) | float64 | | Stablecoin supply held in perpetual DEX contracts, in USD. | | `stablecoin-balance-spot-dex-usd` | Stablecoin Balance - Spot DEXes (USD) | float64 | | Stablecoin supply held in spot DEX contracts, in USD. | | `stablecoin-balance-lending-usd` | Stablecoin Balance - Lending (USD) | float64 | | Stablecoin supply held in lending protocol contracts, in USD. | | `stablecoin-balance-unknown-usd` | Stablecoin Balance - Unattributed (USD) | float64 | | Stablecoin supply not attributed to a known holder type, in USD. The balance breakdown decomposes the Blockworks supply figure and will not sum exactly to stablecoin-outstanding-supply-usd, which comes from a different Blockworks source. | | `stablecoin-holders` | Stablecoin Holders | float64 | | Addresses holding a stablecoin balance on the network. | | `stablecoin-transfer-senders` | Stablecoin Transfer Senders | float64 | | Distinct addresses sending stablecoins on the network. | | `stablecoin-transfer-receivers` | Stablecoin Transfer Receivers | float64 | | Distinct addresses receiving stablecoins on the network. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `networkID` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The unique identifier of the network. (primary key) | | `networkSerialID` | int64 | `Eq`, `IsOneOf` | | The numeric serial identifier of the network. | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The name of the network. | | `slug` | string | `Eq`, `IsOneOf` | yes | The URL slug of the network. (identifier 1) | | `logoURL` | string | | | The URL of the network's logo. | | `hasInternalMetrics` | bool | `Eq`, `NotEq` | | If true, the network has internal network metrics enabled. The network explorer's filter list is exactly the networks where this is true. | | `hasNetworkFundamentals` | bool | `Eq`, `NotEq` | | If true, the network has a network fundamentals page enabled. | | `isEthereumL2` | bool | `Eq`, `NotEq` | | If true, the network is an Ethereum layer 2. | | `ecosystemNetworkID` | string | `Eq`, `IsOneOf` | | The unique identifier of the network's primary ecosystem network, if it belongs to one. | | `ecosystemName` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The ecosystem the network belongs to (e.g. op_stack, cosmos_sdk, subnet, parachain). | | `defiLlamaChainName` | string | `Eq`, `IsOneOf` | | The network's DefiLlama chain name, used to join external TVL data. | | `coingeckoAssetPlatformID` | string | `Eq`, `IsOneOf` | | The network's CoinGecko asset-platform id, which identifies the platform an asset contract is deployed on. | | `linkProjectID` | string | `Eq`, `IsOneOf` | | The unique identifier of the project this network is linked to. | | `linkProjectSlug` | string | `Eq`, `IsOneOf` | | The URL slug of the project this network is linked to. | | `linkProjectName` | string | | | The name of the project this network is linked to. | | `linkProjectPrimaryAssetID` | string | `Eq`, `IsOneOf` | | The unique identifier of the linked project's primary asset. | | `linkProjectPrimaryAssetName` | string | | | The name of the linked project's primary asset. | | `linkProjectPrimaryAssetSlug` | string | `Eq`, `IsOneOf` | | The URL slug of the linked project's primary asset. | | `linkProjectPrimaryAssetSymbol` | string | `Eq`, `IsOneOf` | | The ticker symbol of the linked project's primary asset. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/blockchains/1d/b204e48e-9812-43e6-a00b-5fcfd40e04a2?timeframe=7d&selections=tvl-usd,revenue-usd" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Blockchain timeseries](/api-reference/data-api/blockchains/timeseries-blockchains-by-id) for the response and the errors. # Blockchains Source: https://docs.blockworks.com/api-reference/data-api/blockchains/overview The network master table and the onchain metrics of each network: transactions, addresses, fees, revenue, DEX and perp volume, TVL, stablecoin supply, bridge flows and staking. Resolve a network slug to its networkID with the table, then request the series. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Blockchains](/api-reference/data-api/blockchains/blockchains) | Blockchains-dataset | [List rows](/api-reference/data-api/blockchains/tabular-blockchains), [One row](/api-reference/data-api/blockchains/tabular-blockchains-by-id) | [Batch](/api-reference/data-api/blockchains/timeseries-blockchains), [One series](/api-reference/data-api/blockchains/timeseries-blockchains-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/blockchains?pageSize=3&selections=networkID,slug,name,networkSerialID" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Blockchains](/api-reference/data-api/blockchains/tabular-blockchains) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Blockchains Source: https://docs.blockworks.com/api-reference/data-api/blockchains/tabular-blockchains api-reference/data-api/openapi.json GET /query/tabular/blockchains One row per blockchain network, keyed by networkID and also found by slug: name, logo, ecosystem, layer-2 flag, whether it reports onchain metrics, external ids and the linked project with its primary asset. The networkID is the series key of the blockchains timeseries model. # Get Blockchain Source: https://docs.blockworks.com/api-reference/data-api/blockchains/tabular-blockchains-by-id api-reference/data-api/openapi.json GET /query/tabular/blockchains/{networkID} One row per blockchain network, keyed by networkID and also found by slug: name, logo, ecosystem, layer-2 flag, whether it reports onchain metrics, external ids and the linked project with its primary asset. The networkID is the series key of the blockchains timeseries model. # Batch Get Blockchain timeseries Source: https://docs.blockworks.com/api-reference/data-api/blockchains/timeseries-blockchains api-reference/data-api/openapi.json GET /query/timeseries/blockchains/{granularity} Onchain metrics for a network: transactions, addresses, contract activity, fees, revenue, DEX and perp volume, TVL, stablecoin supply and flows, bridge and issuer flows, staking, real-world assets and developer activity. Each series is one network, keyed by its network id. Coverage differs by network, so pass selections for the metrics you need. HyperCore bridge and issuer flows include HyperEVM. # Get Blockchain timeseries Source: https://docs.blockworks.com/api-reference/data-api/blockchains/timeseries-blockchains-by-id api-reference/data-api/openapi.json GET /query/timeseries/blockchains/{granularity}/{id} Onchain metrics for a network: transactions, addresses, contract activity, fees, revenue, DEX and perp volume, TVL, stablecoin supply and flows, bridge and issuer flows, staking, real-world assets and developer activity. Each series is one network, keyed by its network id. Coverage differs by network, so pass selections for the metrics you need. HyperCore bridge and issuer flows include HyperEVM. # Bridge Protocols Source: https://docs.blockworks.com/api-reference/data-api/bridge-protocols/bridge-protocols Onchain bridge volume and funded transfer legs for one bridge product. Each series is one product, keyed by its Blockworks Research bridge id; several products can share one project. Only blockchain-to-blockchain transfers count, so venue deposit rails (for example Aster) are not included. CCTP direct and unattributed transfers are one cctp product, and Circle Gateway is a separate product. Weeks start on Monday and months on the first day of the calendar month (UTC). Some periods have no data point, and a returned point can have zero transfer counts and zero volume. One row per bridge product that has had onchain transfers, keyed by its Blockworks Research bridge id: name, parent project and the residual flag. Several products can share one project. The id is the series key of the bridge-protocols timeseries model. | | | | - | - | | Access | Projects-dataset | | Tabular model | `bridge-protocols`: primary key `id` | | Timeseries model | `bridge-protocols`: intervals `1d`, `1w`, `1mo`, series key `id` (Bridge Protocol ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Bridge Protocols](/api-reference/data-api/bridge-protocols/tabular-bridge-protocols) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Bridge Protocol timeseries](/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols) > > Up to 10 series in one request, named by Bridge Protocol ID in `series`. > [card] [Get Bridge Protocol timeseries](/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-id) > > One series over a time window, keyed by its Bridge Protocol ID. ## Metrics 4 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `bridgeVolumeUSD` | Bridge Volume (USD) | float64 | usd | Transferred principal in USD, summed over the priced transfer legs only. Null when the period has transfers but none of them has a USD price. | | `bridgeTransferCount` | Bridge Transfer Count | int64 | count | Number of funded transfer legs, priced and unpriced. | | `bridgePricedTransferCount` | Bridge Priced Transfer Count | int64 | count | Number of funded transfer legs that have a USD price. | | `bridgeUnpricedTransferCount` | Bridge Unpriced Transfer Count | int64 | count | Number of funded transfer legs that have no USD price. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the bridge-protocols timeseries model, the Blockworks Research bridge product id (cctp, oft_other). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the bridge product. | | `slug` | string | `Eq`, `IsOneOf` | yes | The same value as id. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent project record; null for oft_other and for a bridge id that is not yet mapped. | | `projectSlug` | string | `Eq`, `IsOneOf` | | The slug of the parent project record; null for oft_other and for a bridge id that is not yet mapped. | | `isResidual` | bool | `Eq` | | True for oft_other, the OFT transfers that are not resolved to an application; null for a new bridge id that is not yet mapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/bridge-protocols/1d/?timeframe=7d&selections=bridgeVolumeUSD,bridgeTransferCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Bridge Protocol timeseries](/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-id) for the response and the errors. # Bridge Protocols by Network Source: https://docs.blockworks.com/api-reference/data-api/bridge-protocols/bridge-protocols-by-network The bridge-protocols flows split by the blockchain at each end of a transfer: inflow, outflow and net inflow in USD, and the funded transfer legs on each side. Each series is one bridge product on one blockchain, keyed by bridge id and blockchain. The network sides leave out venues and unknown endpoints, so they do not add up to the bridge-protocols volume. HyperCore and HyperEVM share the hyperliquid blockchain. Weeks start on Monday and months on the first day of the calendar month (UTC). Some periods have no data point, and a returned point can have zero transfer counts and zero inflow and outflow. One row per bridge product and blockchain pair that has had onchain transfers, keyed by bridge id and blockchain: name, bridge, blockchain, network record and parent project. The id is the series key of the bridge-protocols-by-network timeseries model. | | | | - | - | | Access | Projects-dataset | | Tabular model | `bridge-protocol-networks`: primary key `id` | | Timeseries model | `bridge-protocols-by-network`: intervals `1d`, `1w`, `1mo`, series key `id` (Bridge Protocol Network ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Bridge Protocol Networks](/api-reference/data-api/bridge-protocols/tabular-bridge-protocol-networks) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Bridge Protocol Network timeseries](/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-network) > > Up to 10 series in one request, named by Bridge Protocol Network ID in `series`. > [card] [Get Bridge Protocol Network timeseries](/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-network-by-id) > > One series over a time window, keyed by its Bridge Protocol Network ID. ## Metrics 9 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `bridgeProtocolInflowUSD` | Inflow (USD) | float64 | usd | Principal in USD that the bridge brought into the blockchain, summed over the priced transfer legs only. Null when the period has inflow transfers but none of them has a USD price. | | `bridgeProtocolOutflowUSD` | Outflow (USD) | float64 | usd | Principal in USD that the bridge took out of the blockchain, summed over the priced transfer legs only. Null when the period has outflow transfers but none of them has a USD price. | | `bridgeProtocolNetFlowUSD` | Net Flow (USD) | float64 | usd | Inflow minus outflow in USD; positive = net inflow. | | `bridgeProtocolInflowTransferCount` | Inflow Transfer Count | int64 | count | Number of funded incoming transfer legs, priced and unpriced. | | `bridgeProtocolOutflowTransferCount` | Outflow Transfer Count | int64 | count | Number of funded outgoing transfer legs, priced and unpriced. | | `bridgeProtocolInflowPricedTransferCount` | Inflow Priced Transfer Count | int64 | count | Number of funded incoming transfer legs that have a USD price. | | `bridgeProtocolOutflowPricedTransferCount` | Outflow Priced Transfer Count | int64 | count | Number of funded outgoing transfer legs that have a USD price. | | `bridgeProtocolInflowUnpricedTransferCount` | Inflow Unpriced Transfer Count | int64 | count | Number of funded incoming transfer legs that have no USD price. | | `bridgeProtocolOutflowUnpricedTransferCount` | Outflow Unpriced Transfer Count | int64 | count | Number of funded outgoing transfer legs that have no USD price. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the bridge-protocols-by-network timeseries model, the bridge id and the blockchain joined with a colon (cctp:ethereum). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The bridge display name followed by the Blockworks Research blockchain short name in parentheses (CCTP (ethereum)). | | `slug` | string | `Eq`, `IsOneOf` | yes | The same value as id. | | `bridgeID` | string | `Eq`, `IsOneOf` | yes | The bridge product id, the id in bridge-protocols (cctp). | | `bridgeName` | string | `Eq`, `IsOneOf` | | The display name of the bridge product. | | `chain` | string | `Eq`, `IsOneOf` | yes | The Blockworks Research short name of the blockchain (ethereum, hyperliquid). HyperCore and HyperEVM share hyperliquid. | | `networkID` | string | `Eq`, `IsOneOf` | | The identifier of the blockchain in the blockchains model; null when the blockchain has no network record. | | `networkSlug` | string | `Eq`, `IsOneOf` | | The slug of the blockchain in the blockchains model; null when the blockchain has no network record. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the bridge's parent project record; null for oft_other and for a bridge id that is not yet mapped. | | `projectSlug` | string | `Eq`, `IsOneOf` | | The slug of the bridge's parent project record; null for oft_other and for a bridge id that is not yet mapped. | | `isResidual` | bool | `Eq` | | True for oft_other, the OFT transfers that are not resolved to an application; null for a new bridge id that is not yet mapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/bridge-protocols-by-network/1d/?timeframe=7d&selections=bridgeProtocolInflowUSD,bridgeProtocolOutflowUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Bridge Protocol Network timeseries](/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-network-by-id) for the response and the errors. # Bridge Protocols Source: https://docs.blockworks.com/api-reference/data-api/bridge-protocols/overview Bridge Protocols: Bridge Protocols, Bridge Protocols by Network. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Bridge Protocols](/api-reference/data-api/bridge-protocols/bridge-protocols) | Projects-dataset | [List rows](/api-reference/data-api/bridge-protocols/tabular-bridge-protocols) | [Batch](/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols), [One series](/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-id) | | [Bridge Protocols by Network](/api-reference/data-api/bridge-protocols/bridge-protocols-by-network) | Projects-dataset | [List rows](/api-reference/data-api/bridge-protocols/tabular-bridge-protocol-networks) | [Batch](/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-network), [One series](/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-network-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/bridge-protocols?pageSize=3&selections=id,name,slug,projectID" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Bridge Protocols](/api-reference/data-api/bridge-protocols/tabular-bridge-protocols) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Bridge Protocol Networks Source: https://docs.blockworks.com/api-reference/data-api/bridge-protocols/tabular-bridge-protocol-networks api-reference/data-api/openapi.json GET /query/tabular/bridge-protocol-networks One row per bridge product and blockchain pair that has had onchain transfers, keyed by bridge id and blockchain: name, bridge, blockchain, network record and parent project. The id is the series key of the bridge-protocols-by-network timeseries model. # List Bridge Protocols Source: https://docs.blockworks.com/api-reference/data-api/bridge-protocols/tabular-bridge-protocols api-reference/data-api/openapi.json GET /query/tabular/bridge-protocols One row per bridge product that has had onchain transfers, keyed by its Blockworks Research bridge id: name, parent project and the residual flag. Several products can share one project. The id is the series key of the bridge-protocols timeseries model. # Batch Get Bridge Protocol timeseries Source: https://docs.blockworks.com/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols api-reference/data-api/openapi.json GET /query/timeseries/bridge-protocols/{granularity} Onchain bridge volume and funded transfer legs for one bridge product. Each series is one product, keyed by its Blockworks Research bridge id; several products can share one project. Only blockchain-to-blockchain transfers count, so venue deposit rails (for example Aster) are not included. CCTP direct and unattributed transfers are one cctp product, and Circle Gateway is a separate product. Weeks start on Monday and months on the first day of the calendar month (UTC). Some periods have no data point, and a returned point can have zero transfer counts and zero volume. # Get Bridge Protocol timeseries Source: https://docs.blockworks.com/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-id api-reference/data-api/openapi.json GET /query/timeseries/bridge-protocols/{granularity}/{id} Onchain bridge volume and funded transfer legs for one bridge product. Each series is one product, keyed by its Blockworks Research bridge id; several products can share one project. Only blockchain-to-blockchain transfers count, so venue deposit rails (for example Aster) are not included. CCTP direct and unattributed transfers are one cctp product, and Circle Gateway is a separate product. Weeks start on Monday and months on the first day of the calendar month (UTC). Some periods have no data point, and a returned point can have zero transfer counts and zero volume. # Batch Get Bridge Protocol Network timeseries Source: https://docs.blockworks.com/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-network api-reference/data-api/openapi.json GET /query/timeseries/bridge-protocols-by-network/{granularity} The bridge-protocols flows split by the blockchain at each end of a transfer: inflow, outflow and net inflow in USD, and the funded transfer legs on each side. Each series is one bridge product on one blockchain, keyed by bridge id and blockchain. The network sides leave out venues and unknown endpoints, so they do not add up to the bridge-protocols volume. HyperCore and HyperEVM share the hyperliquid blockchain. Weeks start on Monday and months on the first day of the calendar month (UTC). Some periods have no data point, and a returned point can have zero transfer counts and zero inflow and outflow. # Get Bridge Protocol Network timeseries Source: https://docs.blockworks.com/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-network-by-id api-reference/data-api/openapi.json GET /query/timeseries/bridge-protocols-by-network/{granularity}/{id} The bridge-protocols flows split by the blockchain at each end of a transfer: inflow, outflow and net inflow in USD, and the funded transfer legs on each side. Each series is one bridge product on one blockchain, keyed by bridge id and blockchain. The network sides leave out venues and unknown endpoints, so they do not add up to the bridge-protocols volume. HyperCore and HyperEVM share the hyperliquid blockchain. Weeks start on Monday and months on the first day of the calendar month (UTC). Some periods have no data point, and a returned point can have zero transfer counts and zero inflow and outflow. # Bridged Bitcoin by Chain Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/bridged-bitcoin-by-chain Bridged bitcoin (wrapped and bridged BTC tokens such as WBTC and cbBTC) metrics summed across all products on a chain: token addresses, products and issuers, circulating supply, mints and burns, where the supply sits (CEX, perp and spot DEX, wrapped, yield derivatives, managed, buybacks, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. One row per blockchain with bridged bitcoin activity, keyed by the short chain name: name, the chain's slug and its network id. The id is the series key of the bridged-bitcoin-by-chain timeseries model. | | | | - | - | | Access | Stablecoins-dataset | | Tabular model | `bridged-bitcoin-chains`: primary key `id` | | Timeseries model | `bridged-bitcoin-by-chain`: intervals `1d`, series key `id` (Chain ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Bridged Bitcoin Chains](/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-chains) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Bridged Bitcoin Chain timeseries](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-chain) > > Up to 10 series in one request, named by Chain ID in `series`. > [card] [Get Bridged Bitcoin Chain timeseries](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-chain-by-id) > > One series over a time window, keyed by its Chain ID. ## Metrics 37 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `tokenAddressCount` | Token Address Count | int64 | | Number of distinct token addresses. | | `productCount` | Product Count | int64 | | Number of distinct bridged bitcoin products. | | `issuerCount` | Issuer Count | int64 | | Number of distinct issuers. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Amount minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Amount burned in USD. | | `mintCount` | Mint Count | int64 | | Number of mints. | | `burnCount` | Burn Count | int64 | | Number of burns. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held on centralized exchanges in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held by perp DEXes in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held by spot DEXes in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held by wrapper contracts in USD. | | `balanceYieldDerivativesUSD` | Balance in Yield Derivatives (USD) | float64 | | Supply held by yield derivative protocols in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held by managed vaults in USD. | | `balanceBuybackUSD` | Balance in Buybacks (USD) | float64 | | Supply held by buyback contracts in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held by lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held by unlabeled holders in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Lending deposits in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Lending borrows in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Lending net flow in USD. | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Lending gross inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Lending gross outflow in USD. | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted lending supply APY. | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted lending borrow APY. | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Lending collateral seized in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Lending liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | int64 | | Number of lending liquidations. | | `holders` | Holders | int64 | | Holder count (summed across tokens). | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | int64 | | Number of spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | int64 | | Spot DEX traders (summed across tokens). | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | int64 | | Number of transfers. | | `transferUniqueSenders` | Transfer Unique Senders | int64 | | Unique transfer senders (summed across tokens). | | `transferUniqueReceivers` | Transfer Unique Receivers | int64 | | Unique transfer receivers (summed across tokens). | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the bridged-bitcoin-by-chain timeseries model, the short chain name. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the chain. | | `slug` | string | `Eq`, `IsOneOf` | yes | The chain's slug in the blockchains model; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/bridged-bitcoin-by-chain/1d/?timeframe=7d&selections=tokenAddressCount,productCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Bridged Bitcoin Chain timeseries](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-chain-by-id) for the response and the errors. # Bridged Bitcoin by Deployment Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/bridged-bitcoin-by-deployment Bridged bitcoin (wrapped and bridged BTC tokens such as WBTC and cbBTC) metrics for one token contract on one chain: price, circulating supply, mints and burns, where the supply sits (CEX, perp and spot DEX, wrapped, yield derivatives, managed, buybacks, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one deployment, keyed by chain and contract address; a bridged copy is its own deployment. Many series, so name the deployments you need. One row per bridged bitcoin deployment, one token contract on one chain, keyed by chain and contract address: symbol, token id, the token a bridged copy represents, issuer, the bridge it came through, the chain and the mapped network and issuer project records. The id is the series key of the bridged-bitcoin-by-deployment timeseries model. | | | | - | - | | Access | Stablecoins-dataset | | Tabular model | `bridged-bitcoin-deployments`: primary key `id` | | Timeseries model | `bridged-bitcoin-by-deployment`: intervals `1d`, series key `id` (Bridged Bitcoin Deployment ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Bridged Bitcoin Deployments](/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-deployments) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Bridged Bitcoin Deployment timeseries](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-deployment) > > Up to 10 series in one request, named by Bridged Bitcoin Deployment ID in `series`. > [card] [Get Bridged Bitcoin Deployment timeseries](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-deployment-by-id) > > One series over a time window, keyed by its Bridged Bitcoin Deployment ID. ## Metrics 35 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `priceUSD` | Price (USD) | float64 | | Token price in USD. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Amount minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Amount burned in USD. | | `mintCount` | Mint Count | int64 | | Number of mints. | | `burnCount` | Burn Count | int64 | | Number of burns. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held on centralized exchanges in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held by perp DEXes in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held by spot DEXes in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held by wrapper contracts in USD. | | `balanceYieldDerivativesUSD` | Balance in Yield Derivatives (USD) | float64 | | Supply held by yield derivative protocols in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held by managed vaults in USD. | | `balanceBuybackUSD` | Balance in Buybacks (USD) | float64 | | Supply held by buyback contracts in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held by lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held by unlabeled holders in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Lending deposits in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Lending borrows in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Lending net flow in USD. | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Lending gross inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Lending gross outflow in USD. | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted lending supply APY. | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted lending borrow APY. | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Lending collateral seized in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Lending liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | int64 | | Number of lending liquidations. | | `holders` | Holders | int64 | | Holder count (summed across tokens). | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | int64 | | Number of spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | int64 | | Spot DEX traders (summed across tokens). | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | int64 | | Number of transfers. | | `transferUniqueSenders` | Transfer Unique Senders | int64 | | Unique transfer senders (summed across tokens). | | `transferUniqueReceivers` | Transfer Unique Receivers | int64 | | Unique transfer receivers (summed across tokens). | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the bridged-bitcoin-by-deployment timeseries model, the chain and token address joined with an underscore. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The deployment's display name, the symbol and chain. | | `symbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `tokenID` | string | `Eq`, `IsOneOf` | | The token id of this contract, the series key of the bridged-bitcoin-by-product timeseries model. | | `referenceTokenID` | string | `Eq`, `IsOneOf` | | The token id of the product this contract represents, the underlying token for a bridged copy and otherwise its own token id. | | `underlyingTokenID` | string | `Eq`, `IsOneOf` | | The token id of the original token for a bridged copy (for example bitgo-wbtc), otherwise bitcoin. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain (ethereum, base, solana). | | `issuerID` | string | `Eq`, `IsOneOf` | | The identifier of the issuing company. | | `bridgeID` | string | `Eq`, `IsOneOf` | | The bridge the deployment was bridged through; null for a native deployment. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | | `networkSlug` | string | `Eq`, `IsOneOf` | | The chain's slug in the blockchains model; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the issuer's project record; null when unmapped. | | `projectSlug` | string | `Eq`, `IsOneOf` | | The slug of the issuer's project record; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/bridged-bitcoin-by-deployment/1d/?timeframe=7d&selections=priceUSD,circulatingSupplyUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Bridged Bitcoin Deployment timeseries](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-deployment-by-id) for the response and the errors. # Bridged Bitcoin by Issuer Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/bridged-bitcoin-by-issuer Bridged bitcoin (wrapped and bridged BTC tokens such as WBTC and cbBTC) metrics summed across an issuer's products and chains: chains and products, circulating supply, mints and burns, where the supply sits (CEX, perp and spot DEX, wrapped, yield derivatives, managed, buybacks, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its issuer id. One row per bridged bitcoin issuer, keyed by the issuer's short name: name, the issuer's project slug and project id. The id is the series key of the bridged-bitcoin-by-issuer timeseries model. | | | | - | - | | Access | Stablecoins-dataset | | Tabular model | `bridged-bitcoin-issuers`: primary key `id` | | Timeseries model | `bridged-bitcoin-by-issuer`: intervals `1d`, series key `id` (Issuer ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Bridged Bitcoin Issuers](/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-issuers) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Bridged Bitcoin Issuer timeseries](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-issuer) > > Up to 10 series in one request, named by Issuer ID in `series`. > [card] [Get Bridged Bitcoin Issuer timeseries](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-issuer-by-id) > > One series over a time window, keyed by its Issuer ID. ## Metrics 36 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `chainCount` | Chain Count | int64 | | Number of chains. | | `productCount` | Product Count | int64 | | Number of distinct bridged bitcoin products. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Amount minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Amount burned in USD. | | `mintCount` | Mint Count | int64 | | Number of mints. | | `burnCount` | Burn Count | int64 | | Number of burns. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held on centralized exchanges in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held by perp DEXes in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held by spot DEXes in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held by wrapper contracts in USD. | | `balanceYieldDerivativesUSD` | Balance in Yield Derivatives (USD) | float64 | | Supply held by yield derivative protocols in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held by managed vaults in USD. | | `balanceBuybackUSD` | Balance in Buybacks (USD) | float64 | | Supply held by buyback contracts in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held by lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held by unlabeled holders in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Lending deposits in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Lending borrows in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Lending net flow in USD. | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Lending gross inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Lending gross outflow in USD. | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted lending supply APY. | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted lending borrow APY. | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Lending collateral seized in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Lending liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | int64 | | Number of lending liquidations. | | `holders` | Holders | int64 | | Holder count (summed across tokens). | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | int64 | | Number of spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | int64 | | Spot DEX traders (summed across tokens). | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | int64 | | Number of transfers. | | `transferUniqueSenders` | Transfer Unique Senders | int64 | | Unique transfer senders (summed across tokens). | | `transferUniqueReceivers` | Transfer Unique Receivers | int64 | | Unique transfer receivers (summed across tokens). | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the bridged-bitcoin-by-issuer timeseries model, the issuer's short name. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the issuer. | | `slug` | string | `Eq`, `IsOneOf` | yes | The issuer's project slug, the slug used for the same company across the API; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the issuer's project record; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/bridged-bitcoin-by-issuer/1d/?timeframe=7d&selections=chainCount,productCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Bridged Bitcoin Issuer timeseries](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-issuer-by-id) for the response and the errors. # Bridged Bitcoin by Product Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/bridged-bitcoin-by-product Bridged bitcoin (wrapped and bridged BTC tokens such as WBTC and cbBTC) metrics for one product summed across its chains: chains and token addresses, circulating supply, mints and burns, where the supply sits (CEX, perp and spot DEX, wrapped, yield derivatives, managed, buybacks, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one product, keyed by its token id. One row per bridged bitcoin product, keyed by token id: name, symbol, the token it is a bridged copy of, its issuer and the issuer's project record. The id is the series key of the bridged-bitcoin-by-product timeseries model. | | | | - | - | | Access | Stablecoins-dataset | | Tabular model | `bridged-bitcoin-products`: primary key `id` | | Timeseries model | `bridged-bitcoin-by-product`: intervals `1d`, series key `id` (Token ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Bridged Bitcoin Products](/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-products) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Bridged Bitcoin Product timeseries](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-product) > > Up to 10 series in one request, named by Token ID in `series`. > [card] [Get Bridged Bitcoin Product timeseries](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-product-by-id) > > One series over a time window, keyed by its Token ID. ## Metrics 36 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `chainCount` | Chain Count | int64 | | Number of chains. | | `tokenAddressCount` | Token Address Count | int64 | | Number of distinct token addresses. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Amount minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Amount burned in USD. | | `mintCount` | Mint Count | int64 | | Number of mints. | | `burnCount` | Burn Count | int64 | | Number of burns. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held on centralized exchanges in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held by perp DEXes in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held by spot DEXes in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held by wrapper contracts in USD. | | `balanceYieldDerivativesUSD` | Balance in Yield Derivatives (USD) | float64 | | Supply held by yield derivative protocols in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held by managed vaults in USD. | | `balanceBuybackUSD` | Balance in Buybacks (USD) | float64 | | Supply held by buyback contracts in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held by lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held by unlabeled holders in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Lending deposits in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Lending borrows in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Lending net flow in USD. | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Lending gross inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Lending gross outflow in USD. | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted lending supply APY. | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted lending borrow APY. | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Lending collateral seized in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Lending liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | int64 | | Number of lending liquidations. | | `holders` | Holders | int64 | | Holder count (summed across tokens). | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | int64 | | Number of spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | int64 | | Spot DEX traders (summed across tokens). | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | int64 | | Number of transfers. | | `transferUniqueSenders` | Transfer Unique Senders | int64 | | Unique transfer senders (summed across tokens). | | `transferUniqueReceivers` | Transfer Unique Receivers | int64 | | Unique transfer receivers (summed across tokens). | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the bridged-bitcoin-by-product timeseries model, the token slug. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the token, its ticker symbol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The issuer's project slug; null when unmapped. | | `symbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `underlyingTokenID` | string | `Eq`, `IsOneOf` | | The token id of the original token for a bridged copy (for example bitgo-wbtc), otherwise bitcoin. | | `issuerID` | string | `Eq`, `IsOneOf` | | The identifier of the issuing company. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the issuer's project record; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/bridged-bitcoin-by-product/1d/?timeframe=7d&selections=chainCount,tokenAddressCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Bridged Bitcoin Product timeseries](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-product-by-id) for the response and the errors. # Bridged Bitcoin Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/overview Bridged Bitcoin: Bridged Bitcoin by Chain, Bridged Bitcoin by Deployment, Bridged Bitcoin by Issuer, Bridged Bitcoin by Product. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Bridged Bitcoin by Chain](/api-reference/data-api/bridged-bitcoin/bridged-bitcoin-by-chain) | Stablecoins-dataset | [List rows](/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-chains) | [Batch](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-chain), [One series](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-chain-by-id) | | [Bridged Bitcoin by Deployment](/api-reference/data-api/bridged-bitcoin/bridged-bitcoin-by-deployment) | Stablecoins-dataset | [List rows](/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-deployments) | [Batch](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-deployment), [One series](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-deployment-by-id) | | [Bridged Bitcoin by Issuer](/api-reference/data-api/bridged-bitcoin/bridged-bitcoin-by-issuer) | Stablecoins-dataset | [List rows](/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-issuers) | [Batch](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-issuer), [One series](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-issuer-by-id) | | [Bridged Bitcoin by Product](/api-reference/data-api/bridged-bitcoin/bridged-bitcoin-by-product) | Stablecoins-dataset | [List rows](/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-products) | [Batch](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-product), [One series](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-product-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/bridged-bitcoin-chains?pageSize=3&selections=id,name,slug,networkID" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Bridged Bitcoin Chains](/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-chains) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Bridged Bitcoin Chains Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-chains api-reference/data-api/openapi.json GET /query/tabular/bridged-bitcoin-chains One row per blockchain with bridged bitcoin activity, keyed by the short chain name: name, the chain's slug and its network id. The id is the series key of the bridged-bitcoin-by-chain timeseries model. # List Bridged Bitcoin Deployments Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-deployments api-reference/data-api/openapi.json GET /query/tabular/bridged-bitcoin-deployments One row per bridged bitcoin deployment, one token contract on one chain, keyed by chain and contract address: symbol, token id, the token a bridged copy represents, issuer, the bridge it came through, the chain and the mapped network and issuer project records. The id is the series key of the bridged-bitcoin-by-deployment timeseries model. # List Bridged Bitcoin Issuers Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-issuers api-reference/data-api/openapi.json GET /query/tabular/bridged-bitcoin-issuers One row per bridged bitcoin issuer, keyed by the issuer's short name: name, the issuer's project slug and project id. The id is the series key of the bridged-bitcoin-by-issuer timeseries model. # List Bridged Bitcoin Products Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-products api-reference/data-api/openapi.json GET /query/tabular/bridged-bitcoin-products One row per bridged bitcoin product, keyed by token id: name, symbol, the token it is a bridged copy of, its issuer and the issuer's project record. The id is the series key of the bridged-bitcoin-by-product timeseries model. # Batch Get Bridged Bitcoin Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-chain api-reference/data-api/openapi.json GET /query/timeseries/bridged-bitcoin-by-chain/{granularity} Bridged bitcoin (wrapped and bridged BTC tokens such as WBTC and cbBTC) metrics summed across all products on a chain: token addresses, products and issuers, circulating supply, mints and burns, where the supply sits (CEX, perp and spot DEX, wrapped, yield derivatives, managed, buybacks, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. # Get Bridged Bitcoin Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-chain-by-id api-reference/data-api/openapi.json GET /query/timeseries/bridged-bitcoin-by-chain/{granularity}/{id} Bridged bitcoin (wrapped and bridged BTC tokens such as WBTC and cbBTC) metrics summed across all products on a chain: token addresses, products and issuers, circulating supply, mints and burns, where the supply sits (CEX, perp and spot DEX, wrapped, yield derivatives, managed, buybacks, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. # Batch Get Bridged Bitcoin Deployment timeseries Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-deployment api-reference/data-api/openapi.json GET /query/timeseries/bridged-bitcoin-by-deployment/{granularity} Bridged bitcoin (wrapped and bridged BTC tokens such as WBTC and cbBTC) metrics for one token contract on one chain: price, circulating supply, mints and burns, where the supply sits (CEX, perp and spot DEX, wrapped, yield derivatives, managed, buybacks, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one deployment, keyed by chain and contract address; a bridged copy is its own deployment. Many series, so name the deployments you need. # Get Bridged Bitcoin Deployment timeseries Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-deployment-by-id api-reference/data-api/openapi.json GET /query/timeseries/bridged-bitcoin-by-deployment/{granularity}/{id} Bridged bitcoin (wrapped and bridged BTC tokens such as WBTC and cbBTC) metrics for one token contract on one chain: price, circulating supply, mints and burns, where the supply sits (CEX, perp and spot DEX, wrapped, yield derivatives, managed, buybacks, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one deployment, keyed by chain and contract address; a bridged copy is its own deployment. Many series, so name the deployments you need. # Batch Get Bridged Bitcoin Issuer timeseries Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-issuer api-reference/data-api/openapi.json GET /query/timeseries/bridged-bitcoin-by-issuer/{granularity} Bridged bitcoin (wrapped and bridged BTC tokens such as WBTC and cbBTC) metrics summed across an issuer's products and chains: chains and products, circulating supply, mints and burns, where the supply sits (CEX, perp and spot DEX, wrapped, yield derivatives, managed, buybacks, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its issuer id. # Get Bridged Bitcoin Issuer timeseries Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-issuer-by-id api-reference/data-api/openapi.json GET /query/timeseries/bridged-bitcoin-by-issuer/{granularity}/{id} Bridged bitcoin (wrapped and bridged BTC tokens such as WBTC and cbBTC) metrics summed across an issuer's products and chains: chains and products, circulating supply, mints and burns, where the supply sits (CEX, perp and spot DEX, wrapped, yield derivatives, managed, buybacks, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its issuer id. # Batch Get Bridged Bitcoin Product timeseries Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-product api-reference/data-api/openapi.json GET /query/timeseries/bridged-bitcoin-by-product/{granularity} Bridged bitcoin (wrapped and bridged BTC tokens such as WBTC and cbBTC) metrics for one product summed across its chains: chains and token addresses, circulating supply, mints and burns, where the supply sits (CEX, perp and spot DEX, wrapped, yield derivatives, managed, buybacks, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one product, keyed by its token id. # Get Bridged Bitcoin Product timeseries Source: https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-product-by-id api-reference/data-api/openapi.json GET /query/timeseries/bridged-bitcoin-by-product/{granularity}/{id} Bridged bitcoin (wrapped and bridged BTC tokens such as WBTC and cbBTC) metrics for one product summed across its chains: chains and token addresses, circulating supply, mints and burns, where the supply sits (CEX, perp and spot DEX, wrapped, yield derivatives, managed, buybacks, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one product, keyed by its token id. # CeFi Balances and Flows Source: https://docs.blockworks.com/api-reference/data-api/centralized-finance/cefi-balances-and-flows Daily token balance, in native units and USD, held by one centralized venue (an exchange, custodian, fund, miner or government) for one token on one chain. Each series is one venue token balance, keyed by chain, token address, venue and venue type. Many series per venue, so name the balances you need. One row per token held by a centralized venue on one chain, keyed by chain, token address, venue and venue type: the venue (an exchange, custodian, fund, miner or government), its type, the token and the chain. The id is the series key of the cefi-balances timeseries model. | | | | - | - | | Access | Exchanges-dataset | | Tabular model | `cefi-balances`: primary key `id` | | Timeseries model | `cefi-balances`: intervals `1d`, series key `id` (CeFi Balance ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List CeFi Balances and Flows](/api-reference/data-api/centralized-finance/tabular-cefi-balances) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get CeFi Balances and Flows timeseries](/api-reference/data-api/centralized-finance/timeseries-cefi-balances) > > Up to 10 series in one request, named by CeFi Balance ID in `series`. > [card] [Get CeFi Balances and Flows timeseries](/api-reference/data-api/centralized-finance/timeseries-cefi-balances-by-id) > > One series over a time window, keyed by its CeFi Balance ID. ## Metrics 8 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `balance` | Balance | float64 | | Token balance held by the venue, in native units. | | `balanceUSD` | Balance (USD) | float64 | | Token balance held by the venue in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the cefi-balances timeseries model, the chain, token address, venue id and venue type, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the balance, the venue and token. | | `chain` | string | `Eq`, `IsOneOf` | yes | The short name of the chain (ethereum, base, solana). | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana). | | `cefiID` | string | `Eq`, `IsOneOf` | yes | The centralized venue's identifier (binance, coinbase-prime, us-government). | | `cefiType` | string | `Eq`, `IsOneOf` | | The centralized venue's type (cex, custody, fund, miner, government). | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | | `networkSlug` | string | `Eq`, `IsOneOf` | | The chain's slug in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/cefi-balances/1d/?timeframe=7d&selections=balance,balanceUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get CeFi Balances and Flows timeseries](/api-reference/data-api/centralized-finance/timeseries-cefi-balances-by-id) for the response and the errors. # Centralized Finance Source: https://docs.blockworks.com/api-reference/data-api/centralized-finance/overview What centralized venues hold onchain and what moves in and out, per token per chain. A row names the venue -- an exchange, custodian, fund, miner or government -- its type, the token and the chain; the series carries the balance, deposits, withdrawals and net flow, in the token and in USD. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [CeFi Balances and Flows](/api-reference/data-api/centralized-finance/cefi-balances-and-flows) | Exchanges-dataset | [List rows](/api-reference/data-api/centralized-finance/tabular-cefi-balances) | [Batch](/api-reference/data-api/centralized-finance/timeseries-cefi-balances), [One series](/api-reference/data-api/centralized-finance/timeseries-cefi-balances-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/cefi-balances?pageSize=3&selections=id,name,chain,tokenAddress" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List CeFi Balances and Flows](/api-reference/data-api/centralized-finance/tabular-cefi-balances) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List CeFi Balances and Flows Source: https://docs.blockworks.com/api-reference/data-api/centralized-finance/tabular-cefi-balances api-reference/data-api/openapi.json GET /query/tabular/cefi-balances One row per token held by a centralized venue on one chain, keyed by chain, token address, venue and venue type: the venue (an exchange, custodian, fund, miner or government), its type, the token and the chain. The id is the series key of the cefi-balances timeseries model. # Batch Get CeFi Balances and Flows timeseries Source: https://docs.blockworks.com/api-reference/data-api/centralized-finance/timeseries-cefi-balances api-reference/data-api/openapi.json GET /query/timeseries/cefi-balances/{granularity} Daily token balance, in native units and USD, held by one centralized venue (an exchange, custodian, fund, miner or government) for one token on one chain. Each series is one venue token balance, keyed by chain, token address, venue and venue type. Many series per venue, so name the balances you need. # Get CeFi Balances and Flows timeseries Source: https://docs.blockworks.com/api-reference/data-api/centralized-finance/timeseries-cefi-balances-by-id api-reference/data-api/openapi.json GET /query/timeseries/cefi-balances/{granularity}/{id} Daily token balance, in native units and USD, held by one centralized venue (an exchange, custodian, fund, miner or government) for one token on one chain. Each series is one venue token balance, keyed by chain, token address, venue and venue type. Many series per venue, so name the balances you need. # CDP Market Balances Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/cdp-market-balances Balance, debt ceiling and flows in USD for one token in one collateralized debt position (CDP) market, split by balance type (deposit for posted collateral, borrow for minted debt) and subtype. Each series is one market token balance, keyed by protocol, product, chain, market, token, balance type and balance subtype. Sky MCD vaults so far. Many series per market, so name the balances you need. One row per CDP market balance, the finest grain of the CDP data, keyed by protocol, product, chain, market, token, balance type and balance subtype: the market and token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the cdp-market-balances timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `cdp-market-balances`: primary key `id` | | Timeseries model | `cdp-market-balances`: intervals `1d`, series key `id` (CDP Market Balance ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List CDP Market Balances](/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-balances) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get CDP Market Balance timeseries](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-balances) > > Up to 10 series in one request, named by CDP Market Balance ID in `series`. > [card] [Get CDP Market Balance timeseries](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-balances-by-id) > > One series over a time window, keyed by its CDP Market Balance ID. ## Metrics 7 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `balanceUSD` | Balance (USD) | float64 | | The balance in USD of the token for this market, balance type and subtype. | | `balanceCapUSD` | Balance Cap (USD) | float64 | | The balance cap (debt ceiling) in USD; null where the market has none. | | `balanceCapMaxUSD` | Maximum Balance Cap (USD) | float64 | | The maximum the balance cap can be raised to in USD; null where the market has none. | | `balanceCapGapUSD` | Balance Cap Gap (USD) | float64 | | The remaining room under the balance cap in USD. | | `grossInflowUSD` | Gross Inflow (USD) | float64 | | Gross inflow to the balance in USD. | | `grossOutflowUSD` | Gross Outflow (USD) | float64 | | Gross outflow from the balance in USD. | | `netFlowUSD` | Net Flow (USD) | float64 | | Net flow in USD, inflow minus outflow. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the cdp-market-balances timeseries model, the parent slug, product slug, chain, market key, token key, balance type and balance subtype, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the balance, the market name, token symbol and balance subtype (or type). | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name, for example sky. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol (sky-mcd-vaults). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the market lives on (ethereum, bnb, solana). | | `marketID` | string | `Eq`, `IsOneOf` | | The market or pool address; null when the protocol does not label markets. | | `marketName` | string | `Eq`, `IsOneOf`, `Contains` | | The market display name (for Sky, the vault ilk such as ETH-A). | | `marketType` | string | `Eq`, `IsOneOf` | | The market type where the protocol distinguishes one (for example vault, lp or lockstake); null otherwise. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `balanceType` | string | `Eq`, `IsOneOf` | | Whether the balance is a deposit (posted collateral) or a borrow (minted debt). | | `balanceSubtype` | string | `Eq`, `IsOneOf` | | The finer balance classification (for example collateral or borrow); null for protocols that do not distinguish one. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/cdp-market-balances/1d/?timeframe=7d&selections=balanceUSD,balanceCapUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get CDP Market Balance timeseries](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-balances-by-id) for the response and the errors. # CDP Market Financials Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/cdp-market-financials Daily interest (stability fees), liquidation penalties, flash loan fees, fees and revenue in USD for one token in one collateralized debt position (CDP) market. Each gross amount splits into the share paid on and the share the protocol keeps; fees sum the gross amounts and revenue the kept shares. Each series is one market token, keyed by protocol, product, chain, market and token. Sky MCD vaults so far. Many series per market, so name the series you need. One row per token in a CDP market, keyed by protocol, product, chain, market and token: the market and token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the cdp-market-financials timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `cdp-market-financials`: primary key `id` | | Timeseries model | `cdp-market-financials`: intervals `1d`, series key `id` (CDP Market Financial ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List CDP Market Tokens](/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-financials) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get CDP Market Financial timeseries](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-financials) > > Up to 10 series in one request, named by CDP Market Financial ID in `series`. > [card] [Get CDP Market Financial timeseries](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-financials-by-id) > > One series over a time window, keyed by its CDP Market Financial ID. ## Metrics 13 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `grossInterestUSD` | Gross Interest (USD) | float64 | | Interest (stability fees) paid by borrowers in USD. | | `netInterestUSD` | Net Interest (USD) | float64 | | Share of gross interest passed on to lenders in USD (0 for Sky). | | `treasuryInterestUSD` | Treasury Interest (USD) | float64 | | Share of gross interest kept by the protocol treasury in USD. | | `grossInterestAccruedUSD` | Gross Interest Accrued (USD) | float64 | | Gross interest accrued but not yet collected in USD. | | `treasuryInterestAccruedUSD` | Treasury Interest Accrued (USD) | float64 | | Treasury interest accrued but not yet collected in USD. | | `liquidationFeesGrossUSD` | Gross Liquidation Fees (USD) | float64 | | Liquidation penalty paid by liquidated borrowers in USD. | | `liquidationFeesNetUSD` | Net Liquidation Fees (USD) | float64 | | Share of the liquidation penalty paid on to keepers in USD. | | `liquidationFeeRevenueUSD` | Liquidation Fee Revenue (USD) | float64 | | Share of the liquidation penalty kept by the protocol in USD. | | `flashLoanFeesGrossUSD` | Gross Flash Loan Fees (USD) | float64 | | Flash loan fees paid in USD. | | `flashLoanFeesNetUSD` | Net Flash Loan Fees (USD) | float64 | | Share of flash loan fees paid on in USD. | | `flashLoanFeeRevenueUSD` | Flash Loan Fee Revenue (USD) | float64 | | Share of flash loan fees kept by the protocol in USD. | | `feesUSD` | Fees (USD) | float64 | | Total fees in USD, gross interest plus gross liquidation and flash loan fees. | | `revenueUSD` | Revenue (USD) | float64 | | Protocol revenue in USD, treasury interest plus liquidation and flash loan fee revenue. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the cdp-market-financials timeseries model, the parent slug, product slug, chain, market key and token key, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the market name and token symbol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name, for example sky. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol (sky-mcd-vaults). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the market lives on (ethereum, bnb, solana). | | `marketID` | string | `Eq`, `IsOneOf` | | The market or pool address; null when the protocol does not label markets. | | `marketName` | string | `Eq`, `IsOneOf`, `Contains` | | The market display name (for Sky, the vault ilk such as ETH-A). | | `marketType` | string | `Eq`, `IsOneOf` | | The market type where the protocol distinguishes one (for example vault, lp or lockstake); null otherwise. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/cdp-market-financials/1d/?timeframe=7d&selections=grossInterestUSD,netInterestUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get CDP Market Financial timeseries](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-financials-by-id) for the response and the errors. # CDP Market Interest Rates Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/cdp-market-interest-rates Daily borrow rates (stability fees) for one token in one collateralized debt position (CDP) market, as decimals (0.05 is 5%), weighted by the borrowed balance they apply to, with that weight in USD. Each series is one market token, keyed by protocol, product, chain, market and token. Sky MCD vaults so far. Many series per market, so name the series you need. One row per token in a CDP market with interest rates, keyed by protocol, product, chain, market and token: the market and token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the cdp-market-interest-rates timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `cdp-market-interest-rates`: primary key `id` | | Timeseries model | `cdp-market-interest-rates`: intervals `1d`, series key `id` (CDP Market Interest Rate ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List CDP Market Interest Rates](/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-interest-rates) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get CDP Market Interest Rate timeseries](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-interest-rates) > > Up to 10 series in one request, named by CDP Market Interest Rate ID in `series`. > [card] [Get CDP Market Interest Rate timeseries](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-interest-rates-by-id) > > One series over a time window, keyed by its CDP Market Interest Rate ID. ## Metrics 5 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `borrowAPR` | Borrow APR | float64 | | Borrow-weighted borrow (stability fee) APR, as a decimal. | | `borrowAPY` | Borrow APY | float64 | | Borrow-weighted borrow (stability fee) APY, as a decimal. | | `borrowAPRStdDev` | Borrow APR Standard Deviation | float64 | | Weighted standard deviation of the borrow APR over the day. | | `borrowAPYStdDev` | Borrow APY Standard Deviation | float64 | | Weighted standard deviation of the borrow APY over the day. | | `borrowedUSD` | Borrowed (USD) | float64 | | Borrows in USD, the weight behind the borrow rates. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the cdp-market-interest-rates timeseries model, the parent slug, product slug, chain, market key and token key, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the market name and token symbol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name, for example sky. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol (sky-mcd-vaults). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the market lives on (ethereum, bnb, solana). | | `marketID` | string | `Eq`, `IsOneOf` | | The market or pool address; null when the protocol does not label markets. | | `marketName` | string | `Eq`, `IsOneOf`, `Contains` | | The market display name (for Sky, the vault ilk such as ETH-A). | | `marketType` | string | `Eq`, `IsOneOf` | | The market type where the protocol distinguishes one (for example vault, lp or lockstake); null otherwise. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/cdp-market-interest-rates/1d/?timeframe=7d&selections=borrowAPR,borrowAPY" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get CDP Market Interest Rate timeseries](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-interest-rates-by-id) for the response and the errors. # CDP Market Liquidations Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/cdp-market-liquidations Daily liquidations for one collateral and debt token pair in one collateralized debt position (CDP) market: collateral seized, debt repaid, liquidation penalties and losses in USD and the liquidation count. Each series is one pair, keyed by protocol, product, chain, market, collateral token and debt token. Sky MCD vaults so far. Many series per market, so name the series you need. One row per collateral and debt token pair liquidated in a CDP market, keyed by protocol, product, chain, market, collateral token and debt token: the market and both tokens, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the cdp-market-liquidations timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `cdp-market-liquidations`: primary key `id` | | Timeseries model | `cdp-market-liquidations`: intervals `1d`, series key `id` (CDP Market Liquidation ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List CDP Market Liquidation Pairs](/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-liquidations) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get CDP Market Liquidation timeseries](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-liquidations) > > Up to 10 series in one request, named by CDP Market Liquidation ID in `series`. > [card] [Get CDP Market Liquidation timeseries](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-liquidations-by-id) > > One series over a time window, keyed by its CDP Market Liquidation ID. ## Metrics 7 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `collateralSeizedUSD` | Collateral Seized (USD) | float64 | | Collateral seized from liquidated borrowers in USD. | | `debtRepaidUSD` | Debt Repaid (USD) | float64 | | Debt repaid by liquidators in USD. | | `liquidationFeesGrossUSD` | Gross Liquidation Fees (USD) | float64 | | Liquidation penalty paid by liquidated borrowers in USD. | | `liquidationFeesNetUSD` | Net Liquidation Fees (USD) | float64 | | Share of the liquidation penalty paid on to keepers in USD. | | `liquidationFeeRevenueUSD` | Liquidation Fee Revenue (USD) | float64 | | Share of the liquidation penalty kept by the protocol in USD. | | `liquidationLossUSD` | Liquidation Loss (USD) | float64 | | Liquidation losses (bad debt) in USD. | | `liquidationCount` | Liquidation Count | float64 | | Number of liquidation events. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the cdp-market-liquidations timeseries model, the parent slug, product slug, chain, market key, collateral token key and debt token key, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the market name and the collateral and debt token symbols. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name, for example sky. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol (sky-mcd-vaults). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the market lives on (ethereum, bnb, solana). | | `marketID` | string | `Eq`, `IsOneOf` | | The market or pool address; null when the protocol does not label markets. | | `marketName` | string | `Eq`, `IsOneOf`, `Contains` | | The market display name (for Sky, the vault ilk such as ETH-A). | | `marketType` | string | `Eq`, `IsOneOf` | | The market type where the protocol distinguishes one (for example vault, lp or lockstake); null otherwise. | | `collateralTokenAddress` | string | `Eq`, `IsOneOf` | | The seized collateral token's contract address (the mint address on Solana); null when unlabeled. | | `collateralTokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The seized collateral token's ticker symbol. | | `debtTokenAddress` | string | `Eq`, `IsOneOf` | | The repaid debt token's contract address (the mint address on Solana); null when unlabeled. | | `debtTokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The repaid debt token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/cdp-market-liquidations/1d/?timeframe=7d&selections=collateralSeizedUSD,debtRepaidUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get CDP Market Liquidation timeseries](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-liquidations-by-id) for the response and the errors. # Collateralized Debt Positions (CDPs) Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/overview Collateralized Debt Positions (CDPs): CDP Market Balances, CDP Market Financials, CDP Market Interest Rates, CDP Market Liquidations. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [CDP Market Balances](/api-reference/data-api/collateralized-debt-positions-cdps/cdp-market-balances) | Lending-protocols-dataset | [List rows](/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-balances) | [Batch](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-balances), [One series](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-balances-by-id) | | [CDP Market Financials](/api-reference/data-api/collateralized-debt-positions-cdps/cdp-market-financials) | Lending-protocols-dataset | [List rows](/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-financials) | [Batch](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-financials), [One series](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-financials-by-id) | | [CDP Market Interest Rates](/api-reference/data-api/collateralized-debt-positions-cdps/cdp-market-interest-rates) | Lending-protocols-dataset | [List rows](/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-interest-rates) | [Batch](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-interest-rates), [One series](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-interest-rates-by-id) | | [CDP Market Liquidations](/api-reference/data-api/collateralized-debt-positions-cdps/cdp-market-liquidations) | Lending-protocols-dataset | [List rows](/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-liquidations) | [Batch](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-liquidations), [One series](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-liquidations-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/cdp-market-balances?pageSize=3&selections=id,name,slug,parentSlug" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List CDP Market Balances](/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-balances) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List CDP Market Balances Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-balances api-reference/data-api/openapi.json GET /query/tabular/cdp-market-balances One row per CDP market balance, the finest grain of the CDP data, keyed by protocol, product, chain, market, token, balance type and balance subtype: the market and token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the cdp-market-balances timeseries model. # List CDP Market Tokens Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-financials api-reference/data-api/openapi.json GET /query/tabular/cdp-market-financials One row per token in a CDP market, keyed by protocol, product, chain, market and token: the market and token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the cdp-market-financials timeseries model. # List CDP Market Interest Rates Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-interest-rates api-reference/data-api/openapi.json GET /query/tabular/cdp-market-interest-rates One row per token in a CDP market with interest rates, keyed by protocol, product, chain, market and token: the market and token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the cdp-market-interest-rates timeseries model. # List CDP Market Liquidation Pairs Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-liquidations api-reference/data-api/openapi.json GET /query/tabular/cdp-market-liquidations One row per collateral and debt token pair liquidated in a CDP market, keyed by protocol, product, chain, market, collateral token and debt token: the market and both tokens, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the cdp-market-liquidations timeseries model. # Batch Get CDP Market Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-balances api-reference/data-api/openapi.json GET /query/timeseries/cdp-market-balances/{granularity} Balance, debt ceiling and flows in USD for one token in one collateralized debt position (CDP) market, split by balance type (deposit for posted collateral, borrow for minted debt) and subtype. Each series is one market token balance, keyed by protocol, product, chain, market, token, balance type and balance subtype. Sky MCD vaults so far. Many series per market, so name the balances you need. # Get CDP Market Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-balances-by-id api-reference/data-api/openapi.json GET /query/timeseries/cdp-market-balances/{granularity}/{id} Balance, debt ceiling and flows in USD for one token in one collateralized debt position (CDP) market, split by balance type (deposit for posted collateral, borrow for minted debt) and subtype. Each series is one market token balance, keyed by protocol, product, chain, market, token, balance type and balance subtype. Sky MCD vaults so far. Many series per market, so name the balances you need. # Batch Get CDP Market Financial timeseries Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-financials api-reference/data-api/openapi.json GET /query/timeseries/cdp-market-financials/{granularity} Daily interest (stability fees), liquidation penalties, flash loan fees, fees and revenue in USD for one token in one collateralized debt position (CDP) market. Each gross amount splits into the share paid on and the share the protocol keeps; fees sum the gross amounts and revenue the kept shares. Each series is one market token, keyed by protocol, product, chain, market and token. Sky MCD vaults so far. Many series per market, so name the series you need. # Get CDP Market Financial timeseries Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-financials-by-id api-reference/data-api/openapi.json GET /query/timeseries/cdp-market-financials/{granularity}/{id} Daily interest (stability fees), liquidation penalties, flash loan fees, fees and revenue in USD for one token in one collateralized debt position (CDP) market. Each gross amount splits into the share paid on and the share the protocol keeps; fees sum the gross amounts and revenue the kept shares. Each series is one market token, keyed by protocol, product, chain, market and token. Sky MCD vaults so far. Many series per market, so name the series you need. # Batch Get CDP Market Interest Rate timeseries Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-interest-rates api-reference/data-api/openapi.json GET /query/timeseries/cdp-market-interest-rates/{granularity} Daily borrow rates (stability fees) for one token in one collateralized debt position (CDP) market, as decimals (0.05 is 5%), weighted by the borrowed balance they apply to, with that weight in USD. Each series is one market token, keyed by protocol, product, chain, market and token. Sky MCD vaults so far. Many series per market, so name the series you need. # Get CDP Market Interest Rate timeseries Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-interest-rates-by-id api-reference/data-api/openapi.json GET /query/timeseries/cdp-market-interest-rates/{granularity}/{id} Daily borrow rates (stability fees) for one token in one collateralized debt position (CDP) market, as decimals (0.05 is 5%), weighted by the borrowed balance they apply to, with that weight in USD. Each series is one market token, keyed by protocol, product, chain, market and token. Sky MCD vaults so far. Many series per market, so name the series you need. # Batch Get CDP Market Liquidation timeseries Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-liquidations api-reference/data-api/openapi.json GET /query/timeseries/cdp-market-liquidations/{granularity} Daily liquidations for one collateral and debt token pair in one collateralized debt position (CDP) market: collateral seized, debt repaid, liquidation penalties and losses in USD and the liquidation count. Each series is one pair, keyed by protocol, product, chain, market, collateral token and debt token. Sky MCD vaults so far. Many series per market, so name the series you need. # Get CDP Market Liquidation timeseries Source: https://docs.blockworks.com/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-liquidations-by-id api-reference/data-api/openapi.json GET /query/timeseries/cdp-market-liquidations/{granularity}/{id} Daily liquidations for one collateral and debt token pair in one collateralized debt position (CDP) market: collateral seized, debt repaid, liquidation penalties and losses in USD and the liquidation count. Each series is one pair, keyed by protocol, product, chain, market, collateral token and debt token. Sky MCD vaults so far. Many series per market, so name the series you need. # Derivatives Source: https://docs.blockworks.com/api-reference/data-api/derivatives/overview Perpetual futures contracts on centralized exchanges: the contract table and each contract's price, volume and open interest history. Look the contract up by exchange and symbol, then request its series. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Perpetual Market Funding Rates](/api-reference/data-api/derivatives/perpetual-market-funding-rates) | Derivatives-dataset | [List rows](/api-reference/data-api/derivatives/tabular-perpetual-market-funding-rates), [One row](/api-reference/data-api/derivatives/tabular-perpetual-market-funding-rates-by-id) | [Batch](/api-reference/data-api/derivatives/timeseries-perpetual-market-funding-rates), [One series](/api-reference/data-api/derivatives/timeseries-perpetual-market-funding-rates-by-id) | | [Perpetual Markets](/api-reference/data-api/derivatives/perpetual-markets) | Derivatives-dataset | [List rows](/api-reference/data-api/derivatives/tabular-perpetual-markets), [One row](/api-reference/data-api/derivatives/tabular-perpetual-markets-by-id) | [Batch](/api-reference/data-api/derivatives/timeseries-perpetual-markets), [One series](/api-reference/data-api/derivatives/timeseries-perpetual-markets-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/perpetual-market-funding-rates?pageSize=3&selections=perpetualMarketID,name,exchangeSlug,exchange" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Perpetual Market Funding Rates](/api-reference/data-api/derivatives/tabular-perpetual-market-funding-rates) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Perpetual Market Funding Rates Source: https://docs.blockworks.com/api-reference/data-api/derivatives/perpetual-market-funding-rates Settled funding rate for a perpetual futures contract, one point per settlement, across centralized exchanges and Hyperliquid. Each series is one contract, keyed by exchange and contract symbol, with the same id perpetual-markets uses for that contract. The rate is what one interval paid, as a fraction; it is neither annualized nor scaled to a common interval, so read it with intervalHours. One row per perpetual futures contract that reports a funding rate, across centralized exchanges and Hyperliquid, keyed by exchange and contract symbol: exchange, sub-venue, symbol, base asset and the contract's latest settlement interval. The id is the series key of the perpetual-market-funding-rates timeseries model, and matches the perpetual-markets id for the same contract. | | | | - | - | | Access | Derivatives-dataset | | Tabular model | `perpetual-market-funding-rates`: primary key `perpetualMarketID` | | Timeseries model | `perpetual-market-funding-rates`: intervals `1h`, series key `perpetualMarketID` (Perpetual Market ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Perpetual Market Funding Rates](/api-reference/data-api/derivatives/tabular-perpetual-market-funding-rates) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Perpetual Market Funding Rate](/api-reference/data-api/derivatives/tabular-perpetual-market-funding-rates-by-id) > > One row by `perpetualMarketID`. > [card] [Batch Get Perpetual Market Funding Rate timeseries](/api-reference/data-api/derivatives/timeseries-perpetual-market-funding-rates) > > Up to 10 series in one request, named by Perpetual Market ID in `series`. > [card] [Get Perpetual Market Funding Rate timeseries](/api-reference/data-api/derivatives/timeseries-perpetual-market-funding-rates-by-id) > > One series over a time window, keyed by its Perpetual Market ID. ## Metrics 2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `fundingRate` | Funding Rate | float64 | ratio | The funding rate settled for one interval, as a fraction (0.0001 is 0.01%). Positive means longs paid shorts. Not annualized and not scaled to a common interval. | | `intervalHours` | Interval Hours | int64 | | Hours between this settlement and the contract's neighbouring one (1, 2, 4, 8 or 24). Null where neither gap is one of those. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `perpetualMarketID` | string | `Eq`, `IsOneOf` | | The series key of the perpetual-market-funding-rates timeseries model, the exchange and contract symbol joined with an underscore (binance_BTCUSDT). The same id as perpetual-markets where that model covers the contract. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the market, the exchange name followed by the contract symbol. | | `exchangeSlug` | string | `Eq`, `IsOneOf` | yes | The exchange's slug, shared by every market on that exchange (gate-io, crypto-com). | | `exchange` | string | `Eq`, `IsOneOf` | yes | The exchange's short name as used in the id (binance, bybit, okx, hyperliquid). | | `exchangeSub` | string | `Eq`, `IsOneOf` | yes | The venue within the exchange, where one exchange hosts several: 'main' on every centralized venue and on core Hyperliquid, the HIP-3 builder code (xyz, para) on a builder market. | | `symbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The exchange-native contract symbol. | | `baseAsset` | string | `Eq`, `IsOneOf` | yes | The ticker of the asset the contract tracks, parsed from the contract symbol with contract-size prefixes such as 1000 and k removed (1000PEPEUSDT and kPEPE both read PEPE). Set on every contract. To identify the asset, use baseAssetID, which matches perpetual-markets. | | `baseAssetID` | string | `Eq`, `IsOneOf` | | The unique identifier of the asset the contract tracks, the same as perpetual-markets for the same contract. Null, along with the other resolved base asset columns, where perpetual-markets has no asset for the contract. | | `baseAssetName` | string | `Eq`, `IsOneOf`, `Contains` | yes | The name of the asset the contract tracks. | | `baseAssetSlug` | string | `Eq`, `IsOneOf` | yes | The URL slug of the asset the contract tracks. | | `baseAssetSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The ticker symbol of the asset the contract tracks, as the asset record holds it. It can differ in case and spelling from baseAsset. | | `baseAssetSerialID` | int64 | `Eq`, `IsOneOf` | | The numeric serial identifier of the base asset, used by market data services. Join on it to reach the spot markets for the same asset. | | `exchangeID` | string | `Eq`, `IsOneOf` | | The unique identifier of the exchange. | | `exchangeName` | string | `Eq`, `IsOneOf`, `Contains` | | The display name of the exchange. | | `exchangeSerialID` | int64 | `Eq`, `IsOneOf` | | The numeric serial identifier of the exchange, used by market data services. | | `intervalHours` | int64 | `Eq`, `IsOneOf` | | Hours between the contract's latest two settlements (1, 2, 4, 8 or 24). Null where neither neighbouring gap is one of those. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/perpetual-market-funding-rates/1h/?timeframe=7d&selections=fundingRate,intervalHours" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Perpetual Market Funding Rate timeseries](/api-reference/data-api/derivatives/timeseries-perpetual-market-funding-rates-by-id) for the response and the errors. # Perpetual Markets Source: https://docs.blockworks.com/api-reference/data-api/derivatives/perpetual-markets Price, volume and open interest for a perpetual futures contract on a centralized exchange: open, high, low, close, volume and end-of-day and average open interest. Each series is one contract, keyed by exchange and contract symbol. Dated futures are not included. One row per perpetual futures contract on a centralized exchange, keyed by exchange and contract symbol: exchange, symbol, base asset, quote and settle currency, contract type and margin type. The id is the series key of the perpetual-markets timeseries model; filter by base asset to find every venue listing an asset's perpetual. | | | | - | - | | Access | Derivatives-dataset | | Tabular model | `perpetual-markets`: primary key `id`, identifiers `slug`, aliases `futures-markets`, `futures-market-entities` | | Timeseries model | `perpetual-markets`: intervals `1d`, series key `id` (Perpetual Market ID), series must be named (up to 10 per call), aliases `futures-markets`, `futures-market` | ## Endpoints > [card] [List Perpetual Markets](/api-reference/data-api/derivatives/tabular-perpetual-markets) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Perpetual Market](/api-reference/data-api/derivatives/tabular-perpetual-markets-by-id) > > One row by `id` or by `slug`. > [card] [Batch Get Perpetual Market timeseries](/api-reference/data-api/derivatives/timeseries-perpetual-markets) > > Up to 10 series in one request, named by Perpetual Market ID in `series`. > [card] [Get Perpetual Market timeseries](/api-reference/data-api/derivatives/timeseries-perpetual-markets-by-id) > > One series over a time window, keyed by its Perpetual Market ID. ## Metrics 8 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `openPrice` | Open Price | float64 | usd | USD price at the candle open. | | `highPrice` | High Price | float64 | usd | High USD price during the candle. | | `lowPrice` | Low Price | float64 | usd | Low USD price during the candle. | | `closePrice` | Close Price | float64 | usd | USD price at the candle close. | | `closePricePerUnit` | Close Price Per Unit | float64 | usd | USD price at the candle close per unit of the base asset, with the contract multiplier divided out. Use this to compare contracts whose multipliers differ. | | `volumeUSD` | Volume (USD) | float64 | usd | Volume traded during the candle in USD. | | `openInterestUSD` | Open Interest (USD) | float64 | usd | Open interest in USD at the candle close. Null where the exchange reports no open interest, which is distinct from a genuine zero. | | `openInterestUSDAvg` | Open Interest Average (USD) | float64 | usd | Mean open interest in USD across the observations taken during the candle. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the perpetual-markets timeseries model, the exchange and contract symbol joined with an underscore (binance_BTCUSDT). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the market, the exchange name followed by the contract symbol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The exchange's slug, shared by every market on that exchange (gate-io, crypto-com). (identifier 1) | | `exchange` | string | `Eq`, `IsOneOf` | yes | The exchange's short name as used in the id (binance, bybit, okx). | | `exchangeSub` | string | `Eq`, `IsOneOf` | yes | The venue within the exchange, where one exchange hosts several: 'main' on every centralized venue and on core Hyperliquid, the HIP-3 builder code (hyna, xyz, para) on a builder market. Filter exchange=hyperliquid for all of Hyperliquid, then narrow with this. | | `symbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The exchange-native contract symbol. | | `symbolNormalized` | string | `Eq`, `IsOneOf`, `Contains` | | The normalized contract symbol, where the exchange provides one. | | `baseAssetID` | string | `Eq`, `IsOneOf` | | The unique identifier of the asset the contract tracks. Null, along with the other base asset columns, where the contract's ticker matches no asset. | | `baseAssetName` | string | `Eq`, `IsOneOf`, `Contains` | yes | The name of the asset the contract tracks. | | `baseAssetSlug` | string | `Eq`, `IsOneOf` | yes | The URL slug of the asset the contract tracks. | | `baseAssetSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The ticker symbol of the asset the contract tracks. | | `baseAssetSerialID` | int64 | `Eq`, `IsOneOf` | | The numeric serial identifier of the base asset, used by market data services. Join on it to reach the spot markets for the same asset. | | `quoteAssetSerialID` | int64 | `Eq`, `IsOneOf` | | The numeric serial identifier of the quote currency, used by market data services. | | `settleAssetSerialID` | int64 | `Eq`, `IsOneOf` | | The numeric serial identifier of the settlement currency, used by market data services. It is what distinguishes an exchange's linear and inverse perpetuals on the same pair. | | `exchangeSerialID` | int64 | `Eq`, `IsOneOf` | | The numeric serial identifier of the exchange, used by market data services. | | `quoteCurrency` | string | `Eq`, `IsOneOf` | yes | The currency the contract is quoted in. | | `settleCurrency` | string | `Eq`, `IsOneOf` | | The currency the contract settles in. | | `contractType` | string | `Eq`, `IsOneOf` | | The contract type as reported by the exchange (perpetual or tradfi_perpetual). | | `marginType` | string | `Eq`, `IsOneOf` | | The margin type of the contract, linear or inverse. | | `exchangeID` | string | `Eq`, `IsOneOf` | | The unique identifier of the exchange. | | `exchangeName` | string | `Eq`, `IsOneOf`, `Contains` | | The display name of the exchange. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/perpetual-markets/1d/backpack_0G_USDC_PERP?timeframe=7d&selections=openPrice,highPrice" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Perpetual Market timeseries](/api-reference/data-api/derivatives/timeseries-perpetual-markets-by-id) for the response and the errors. # List Perpetual Market Funding Rates Source: https://docs.blockworks.com/api-reference/data-api/derivatives/tabular-perpetual-market-funding-rates api-reference/data-api/openapi.json GET /query/tabular/perpetual-market-funding-rates One row per perpetual futures contract that reports a funding rate, across centralized exchanges and Hyperliquid, keyed by exchange and contract symbol: exchange, sub-venue, symbol, base asset and the contract's latest settlement interval. The id is the series key of the perpetual-market-funding-rates timeseries model, and matches the perpetual-markets id for the same contract. # Get Perpetual Market Funding Rate Source: https://docs.blockworks.com/api-reference/data-api/derivatives/tabular-perpetual-market-funding-rates-by-id api-reference/data-api/openapi.json GET /query/tabular/perpetual-market-funding-rates/{perpetualMarketID} One row per perpetual futures contract that reports a funding rate, across centralized exchanges and Hyperliquid, keyed by exchange and contract symbol: exchange, sub-venue, symbol, base asset and the contract's latest settlement interval. The id is the series key of the perpetual-market-funding-rates timeseries model, and matches the perpetual-markets id for the same contract. # List Perpetual Markets Source: https://docs.blockworks.com/api-reference/data-api/derivatives/tabular-perpetual-markets api-reference/data-api/openapi.json GET /query/tabular/perpetual-markets One row per perpetual futures contract on a centralized exchange, keyed by exchange and contract symbol: exchange, symbol, base asset, quote and settle currency, contract type and margin type. The id is the series key of the perpetual-markets timeseries model; filter by base asset to find every venue listing an asset's perpetual. # Get Perpetual Market Source: https://docs.blockworks.com/api-reference/data-api/derivatives/tabular-perpetual-markets-by-id api-reference/data-api/openapi.json GET /query/tabular/perpetual-markets/{id} One row per perpetual futures contract on a centralized exchange, keyed by exchange and contract symbol: exchange, symbol, base asset, quote and settle currency, contract type and margin type. The id is the series key of the perpetual-markets timeseries model; filter by base asset to find every venue listing an asset's perpetual. # Batch Get Perpetual Market Funding Rate timeseries Source: https://docs.blockworks.com/api-reference/data-api/derivatives/timeseries-perpetual-market-funding-rates api-reference/data-api/openapi.json GET /query/timeseries/perpetual-market-funding-rates/{granularity} Settled funding rate for a perpetual futures contract, one point per settlement, across centralized exchanges and Hyperliquid. Each series is one contract, keyed by exchange and contract symbol, with the same id perpetual-markets uses for that contract. The rate is what one interval paid, as a fraction; it is neither annualized nor scaled to a common interval, so read it with intervalHours. # Get Perpetual Market Funding Rate timeseries Source: https://docs.blockworks.com/api-reference/data-api/derivatives/timeseries-perpetual-market-funding-rates-by-id api-reference/data-api/openapi.json GET /query/timeseries/perpetual-market-funding-rates/{granularity}/{perpetualMarketID} Settled funding rate for a perpetual futures contract, one point per settlement, across centralized exchanges and Hyperliquid. Each series is one contract, keyed by exchange and contract symbol, with the same id perpetual-markets uses for that contract. The rate is what one interval paid, as a fraction; it is neither annualized nor scaled to a common interval, so read it with intervalHours. # Batch Get Perpetual Market timeseries Source: https://docs.blockworks.com/api-reference/data-api/derivatives/timeseries-perpetual-markets api-reference/data-api/openapi.json GET /query/timeseries/perpetual-markets/{granularity} Price, volume and open interest for a perpetual futures contract on a centralized exchange: open, high, low, close, volume and end-of-day and average open interest. Each series is one contract, keyed by exchange and contract symbol. Dated futures are not included. # Get Perpetual Market timeseries Source: https://docs.blockworks.com/api-reference/data-api/derivatives/timeseries-perpetual-markets-by-id api-reference/data-api/openapi.json GET /query/timeseries/perpetual-markets/{granularity}/{id} Price, volume and open interest for a perpetual futures contract on a centralized exchange: open, high, low, close, volume and end-of-day and average open interest. Each series is one contract, keyed by exchange and contract symbol. Dated futures are not included. # Dex Aggregator Volumes Source: https://docs.blockworks.com/api-reference/data-api/dex-aggregators/dex-aggregator-volumes Daily DEX volume in USD routed through one aggregator to one DEX version on one chain, split by pair category, with the number of DEX fills (hops). Each series is one chain, aggregator, DEX and DEX version. Many series per aggregator, so name the routes you need. One row per DEX aggregator route, keyed by chain, aggregator, DEX and DEX version: the aggregator and DEX with their mapped project records, and the chain. The id is the series key of the dex- aggregator-volumes timeseries model. | | | | - | - | | Access | Spot-dex-protocols-dataset | | Tabular model | `dex-aggregator-volumes`: primary key `id` | | Timeseries model | `dex-aggregator-volumes`: intervals `1d`, series key `id` (DEX Aggregator Volume ID), every series available in one call | ## Endpoints > [card] [List DEX Aggregator Volumes](/api-reference/data-api/dex-aggregators/tabular-dex-aggregator-volumes) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get DEX Aggregator Volume timeseries](/api-reference/data-api/dex-aggregators/timeseries-dex-aggregator-volumes) > > Up to 10 series in one request, named by series key in `series`. > [card] [Get DEX Aggregator Volume timeseries](/api-reference/data-api/dex-aggregators/timeseries-dex-aggregator-volumes-by-id) > > One series over a time window, keyed by its DEX Aggregator Volume ID. ## Metrics 11 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `volumeUSD` | | | | | | `dexHops` | | | | | | `blockchainTokenVolumeUSD` | | | | | | `stablecoinSwapVolumeUSD` | | | | | | `lstSwapVolumeUSD` | | | | | | `tokenizedAssetVolumeUSD` | | | | | | `projectTokenVolumeUSD` | | | | | | `memeVolumeUSD` | | | | | | `compositeVolumeUSD` | | | | | | `predictionMarketVolumeUSD` | | | | | | `otherVolumeUSD` | | | | | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `aggregatorID` | string | | | The aggregator the trade was routed through (cowswap, kyberswap, 0x, 1inch, jupiter). | | `chain` | string | | | The short name of the chain (ethereum, base, solana). | | `exchangeID` | string | | | The DEX the trade filled on. | | `exchangeProjectID` | string | | | The identifier of the DEX's project record; null when unmapped. | | `exchangeVersion` | string | | | The version of that DEX (v2, v3, clmm-v1, dlmm). | | `id` | string | | | The series key of the dex-aggregator-volumes timeseries model, the chain, aggregator, DEX and DEX version, joined with underscores. | | `name` | string | | | The display name of the series. | | `networkID` | string | | | The chain's networkID in the blockchains model; null when unmapped. | | `projectID` | string | | | The identifier of the aggregator's project record; null when unmapped. | | `slug` | string | | | The aggregator's project slug, the slug used for the same protocol across the API; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/dex-aggregator-volumes/1d/?timeframe=7d&selections=volumeUSD,dexHops" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get DEX Aggregator Volume timeseries](/api-reference/data-api/dex-aggregators/timeseries-dex-aggregator-volumes-by-id) for the response and the errors. # DEX Aggregators Source: https://docs.blockworks.com/api-reference/data-api/dex-aggregators/overview Volume routed through DEX aggregators, keyed by chain, aggregator, DEX and DEX version. Each series carries total volume in USD, the number of DEX hops, and the same volume split by what was traded: blockchain tokens, stablecoins, liquid staking tokens, tokenized assets, project tokens, memecoins, composites and prediction markets. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Dex Aggregator Volumes](/api-reference/data-api/dex-aggregators/dex-aggregator-volumes) | Spot-dex-protocols-dataset | [List rows](/api-reference/data-api/dex-aggregators/tabular-dex-aggregator-volumes) | [Batch](/api-reference/data-api/dex-aggregators/timeseries-dex-aggregator-volumes), [One series](/api-reference/data-api/dex-aggregators/timeseries-dex-aggregator-volumes-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/dex-aggregator-volumes?pageSize=3&selections=id,name,slug,chain" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List DEX Aggregator Volumes](/api-reference/data-api/dex-aggregators/tabular-dex-aggregator-volumes) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List DEX Aggregator Volumes Source: https://docs.blockworks.com/api-reference/data-api/dex-aggregators/tabular-dex-aggregator-volumes api-reference/data-api/openapi.json GET /query/tabular/dex-aggregator-volumes One row per DEX aggregator route, keyed by chain, aggregator, DEX and DEX version: the aggregator and DEX with their mapped project records, and the chain. The id is the series key of the dex- aggregator-volumes timeseries model. # Batch Get DEX Aggregator Volume timeseries Source: https://docs.blockworks.com/api-reference/data-api/dex-aggregators/timeseries-dex-aggregator-volumes api-reference/data-api/openapi.json GET /query/timeseries/dex-aggregator-volumes/{granularity} Daily DEX volume in USD routed through one aggregator to one DEX version on one chain, split by pair category, with the number of DEX fills (hops). Each series is one chain, aggregator, DEX and DEX version. Many series per aggregator, so name the routes you need. # Get DEX Aggregator Volume timeseries Source: https://docs.blockworks.com/api-reference/data-api/dex-aggregators/timeseries-dex-aggregator-volumes-by-id api-reference/data-api/openapi.json GET /query/timeseries/dex-aggregator-volumes/{granularity}/{id} Daily DEX volume in USD routed through one aggregator to one DEX version on one chain, split by pair category, with the number of DEX fills (hops). Each series is one chain, aggregator, DEX and DEX version. Many series per aggregator, so name the routes you need. # DAT Companies Source: https://docs.blockworks.com/api-reference/data-api/digital-asset-treasury-companies/dat-companies Capital-structure metrics for a publicly traded digital asset treasury company: share price and volume, shares outstanding, market cap, enterprise value, cash, debt, the net asset value of its crypto holdings and mNAV ratios. Each series is one company, keyed by its stock ticker. One row per digital asset treasury company, a listed company holding crypto on its balance sheet, keyed by stock ticker: name, project slug and project id. The ticker is the series key of the dat-companies timeseries model. | | | | - | - | | Access | Dat-companies-dataset | | Tabular model | `dat-companies`: primary key `id`, identifiers `slug` | | Timeseries model | `dat-companies`: intervals `1d`, series key `id` (DAT Company ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List DAT Companies](/api-reference/data-api/digital-asset-treasury-companies/tabular-dat-companies) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get DAT Company timeseries](/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies) > > Up to 10 series in one request, named by DAT Company ID in `series`. > [card] [Get DAT Company timeseries](/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies-by-id) > > One series over a time window, keyed by its DAT Company ID. ## Metrics 16 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `price` | Stock Price (USD) | float64 | | Latest stock price in USD. | | `volumeUSD` | Volume (USD) | float64 | | Dollar trading volume. | | `outstandingShares` | Outstanding Shares | float64 | | Shares currently issued and held by investors. | | `marketCap` | Market Cap (USD) | float64 | | Stock price times outstanding shares in USD. | | `enterpriseValue` | Enterprise Value (USD) | float64 | | Market cap plus debt minus cash in USD. | | `fullyDilutedShares` | Fully Diluted Shares | float64 | | All shares if options, warrants and convertibles are exercised. | | `fullyDilutedValuation` | Fully Diluted Valuation (USD) | float64 | | Stock price times fully diluted shares in USD. | | `fullyDilutedEnterpriseValue` | Fully Diluted Enterprise Value (USD) | float64 | | Enterprise value on a fully diluted share basis in USD. | | `cash` | Cash (USD) | float64 | | Cash and equivalents on the balance sheet in USD. | | `debt` | Debt (USD) | float64 | | Total debt on the balance sheet in USD. | | `preferredMarketCap` | Preferred Market Cap (USD) | float64 | | Market value of preferred stock in USD. | | `nav` | NAV (USD) | float64 | | Net asset value - crypto holdings at market value, net of liabilities, in USD. | | `outstandingMNAV` | Outstanding mNAV | float64 | | Market cap divided by NAV - premium or discount to crypto NAV on outstanding shares. | | `fullyDilutedMNAV` | Fully Diluted mNAV | float64 | | Fully diluted valuation divided by NAV. | | `outstandingEVMNAV` | Outstanding EV mNAV | float64 | | Enterprise value divided by NAV on outstanding shares. | | `fullyDilutedEVMNAV` | Fully Diluted EV mNAV | float64 | | Fully diluted enterprise value divided by NAV. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the dat-companies timeseries model, the company's stock ticker (MSTR). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the company, falling back to the ticker. | | `slug` | string | `Eq`, `IsOneOf` | yes | The company's project slug, the slug used for the same company across the API (micro-strategy). (identifier 1) | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the company's project record. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/dat-companies/1d/ASST?timeframe=7d&selections=price,volumeUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get DAT Company timeseries](/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies-by-id) for the response and the errors. # DAT Companies by Asset Source: https://docs.blockworks.com/api-reference/data-api/digital-asset-treasury-companies/dat-companies-by-asset Holdings of a digital asset treasury company in one crypto asset: units held, their USD value and units bought that day. Each series is one company and asset pair, keyed by ticker and asset symbol. One row per company and crypto asset held in a digital asset treasury, keyed by ticker and asset symbol: company ticker, asset symbol and the asset's native chain. The id is the series key of the dat-companies-by-asset timeseries model. | | | | - | - | | Access | Dat-companies-dataset | | Tabular model | `dat-company-assets`: primary key `id`, identifiers `slug` | | Timeseries model | `dat-companies-by-asset`: intervals `1d`, series key `id` (DAT Company Asset ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List DAT Company Assets](/api-reference/data-api/digital-asset-treasury-companies/tabular-dat-company-assets) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get DAT Company Asset timeseries](/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies-by-asset) > > Up to 10 series in one request, named by DAT Company Asset ID in `series`. > [card] [Get DAT Company Asset timeseries](/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies-by-asset-by-id) > > One series over a time window, keyed by its DAT Company Asset ID. ## Metrics 3 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `datAUMNative` | DAT AUM (Native) | float64 | | Company's holdings of this asset in native units. | | `datAUMUSD` | DAT AUM (USD) | float64 | | Company's holdings of this asset in USD. | | `datPurchasesNative` | DAT Purchases (Native) | float64 | | Units of this asset purchased that day. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the dat-companies-by-asset timeseries model, the company ticker and lowercase asset symbol joined with an underscore (MSTR_btc). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the company holding (company name plus asset symbol). | | `slug` | string | `Eq`, `IsOneOf` | yes | The company's project slug (micro-strategy). (identifier 1) | | `companyTicker` | string | `Eq`, `IsOneOf` | yes | The company's stock ticker, the id in dat-companies. | | `cryptoAsset` | string | `Eq`, `IsOneOf` | | The crypto asset symbol held by the company. | | `networkSlug` | string | `Eq`, `IsOneOf` | | The slug in the blockchains model of the held asset's native chain. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/dat-companies-by-asset/1d/ASST_btc?timeframe=7d&selections=datAUMNative,datAUMUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get DAT Company Asset timeseries](/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies-by-asset-by-id) for the response and the errors. # Digital Asset Treasury Companies Source: https://docs.blockworks.com/api-reference/data-api/digital-asset-treasury-companies/overview Digital Asset Treasury Companies: DAT Companies, DAT Companies by Asset. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [DAT Companies](/api-reference/data-api/digital-asset-treasury-companies/dat-companies) | Dat-companies-dataset | [List rows](/api-reference/data-api/digital-asset-treasury-companies/tabular-dat-companies) | [Batch](/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies), [One series](/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies-by-id) | | [DAT Companies by Asset](/api-reference/data-api/digital-asset-treasury-companies/dat-companies-by-asset) | Dat-companies-dataset | [List rows](/api-reference/data-api/digital-asset-treasury-companies/tabular-dat-company-assets) | [Batch](/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies-by-asset), [One series](/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies-by-asset-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/dat-companies?pageSize=3&selections=id,slug,name,projectID" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List DAT Companies](/api-reference/data-api/digital-asset-treasury-companies/tabular-dat-companies) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List DAT Companies Source: https://docs.blockworks.com/api-reference/data-api/digital-asset-treasury-companies/tabular-dat-companies api-reference/data-api/openapi.json GET /query/tabular/dat-companies One row per digital asset treasury company, a listed company holding crypto on its balance sheet, keyed by stock ticker: name, project slug and project id. The ticker is the series key of the dat-companies timeseries model. # List DAT Company Assets Source: https://docs.blockworks.com/api-reference/data-api/digital-asset-treasury-companies/tabular-dat-company-assets api-reference/data-api/openapi.json GET /query/tabular/dat-company-assets One row per company and crypto asset held in a digital asset treasury, keyed by ticker and asset symbol: company ticker, asset symbol and the asset's native chain. The id is the series key of the dat-companies-by-asset timeseries model. # Batch Get DAT Company timeseries Source: https://docs.blockworks.com/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies api-reference/data-api/openapi.json GET /query/timeseries/dat-companies/{granularity} Capital-structure metrics for a publicly traded digital asset treasury company: share price and volume, shares outstanding, market cap, enterprise value, cash, debt, the net asset value of its crypto holdings and mNAV ratios. Each series is one company, keyed by its stock ticker. # Batch Get DAT Company Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies-by-asset api-reference/data-api/openapi.json GET /query/timeseries/dat-companies-by-asset/{granularity} Holdings of a digital asset treasury company in one crypto asset: units held, their USD value and units bought that day. Each series is one company and asset pair, keyed by ticker and asset symbol. # Get DAT Company Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies-by-asset-by-id api-reference/data-api/openapi.json GET /query/timeseries/dat-companies-by-asset/{granularity}/{id} Holdings of a digital asset treasury company in one crypto asset: units held, their USD value and units bought that day. Each series is one company and asset pair, keyed by ticker and asset symbol. # Get DAT Company timeseries Source: https://docs.blockworks.com/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies-by-id api-reference/data-api/openapi.json GET /query/timeseries/dat-companies/{granularity}/{id} Capital-structure metrics for a publicly traded digital asset treasury company: share price and volume, shares outstanding, market cap, enterprise value, cash, debt, the net asset value of its crypto holdings and mNAV ratios. Each series is one company, keyed by its stock ticker. # Finding an id Source: https://docs.blockworks.com/api-reference/data-api/discovery/finding-an-id Which tabular model to query to get the series key a timeseries endpoint needs, and which identifiers each lookup accepts. Every timeseries endpoint identifies a series by a key in the path or in `series`. For entity-keyed models that key is the primary key of a row in a tabular model, usually a UUID such as `b204e48e-9812-43e6-a00b-5fcfd40e04a2`. Slugs and symbols are accepted by the tabular row endpoint but not by the timeseries path: a request such as `/query/timeseries/blockchains/1d/solana` returns `200` with an empty `points` array and no `entity`, not a `404`. Resolve the identifier first. **1. Look up the row** ```bash theme={null} curl "https://api.blockworks.com/query/tabular/blockchains/solana?selections=networkID,name" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` ```json theme={null} {"error": null, "data": {"networkID": "b204e48e-9812-43e6-a00b-5fcfd40e04a2", "name": "Solana"}, "metadata": {"matchedField": "slug"}} ``` **2. Put the primary key in the timeseries path** `/query/timeseries/blockchains/1d/b204e48e-9812-43e6-a00b-5fcfd40e04a2` ## Lookup table One row per lookup: the timeseries models that share a key, the path parameter that carries it, the request that resolves it, and the identifiers that request accepts. Generated from the catalog, so it is complete for every model in this reference. | Timeseries models | Series key | Look it up with | Identifiers accepted | | - | - | - | - | | [`agentic-payments`](/api-reference/data-api/agentic-payments/timeseries-agentic-payments-by-id) | `id` (Agentic Payment ID) | [`GET /query/tabular/agentic-payments`](/api-reference/data-api/agentic-payments/tabular-agentic-payments) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`asset-buybacks`](/api-reference/data-api/real-time-buybacks/timeseries-asset-buybacks-by-id), [`asset-investor-mentions`](/api-reference/data-api/mindshare-sentiment/timeseries-asset-investor-mentions-by-id), [`asset-marketcap`](/api-reference/data-api/assets/timeseries-asset-marketcap-by-id), [`asset-mindshare`](/api-reference/data-api/mindshare-sentiment/timeseries-asset-mindshare-by-id), [`asset-price`](/api-reference/data-api/assets/timeseries-asset-price-by-id), [`asset-sentiment`](/api-reference/data-api/mindshare-sentiment/timeseries-asset-sentiment-by-id), [`asset-sharpe`](/api-reference/data-api/assets/timeseries-asset-sharpe-by-id), [`asset-supply`](/api-reference/data-api/assets/timeseries-asset-supply-by-id), [`asset-volatility`](/api-reference/data-api/assets/timeseries-asset-volatility-by-id), [`token-unlocks`](/api-reference/data-api/token-unlocks/timeseries-token-unlocks-by-id) | `asset-id`, `assetID`, `id` (Asset ID) | [`GET /query/tabular/assets/bitcoin`](/api-reference/data-api/assets/tabular-assets-by-id) then read `assetID` | `slug`, `prioritySymbol` or the `assetID` itself | | [`blockchains`](/api-reference/data-api/blockchains/timeseries-blockchains-by-id) | `id` (Network ID) | [`GET /query/tabular/blockchains/solana`](/api-reference/data-api/blockchains/tabular-blockchains-by-id) then read `networkID` | `slug` or the `networkID` itself | | [`bridge-protocols-by-network`](/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-network-by-id) | `id` (Bridge Protocol Network ID) | [`GET /query/tabular/bridge-protocol-networks`](/api-reference/data-api/bridge-protocols/tabular-bridge-protocol-networks) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`bridge-protocols`](/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-id) | `id` (Bridge Protocol ID) | [`GET /query/tabular/bridge-protocols`](/api-reference/data-api/bridge-protocols/tabular-bridge-protocols) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`bridged-bitcoin-by-chain`](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-chain-by-id) | `id` (Chain ID) | [`GET /query/tabular/bridged-bitcoin-chains`](/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-chains) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`bridged-bitcoin-by-deployment`](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-deployment-by-id) | `id` (Bridged Bitcoin Deployment ID) | [`GET /query/tabular/bridged-bitcoin-deployments`](/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-deployments) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`bridged-bitcoin-by-issuer`](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-issuer-by-id) | `id` (Issuer ID) | [`GET /query/tabular/bridged-bitcoin-issuers`](/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-issuers) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`bridged-bitcoin-by-product`](/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-product-by-id) | `id` (Token ID) | [`GET /query/tabular/bridged-bitcoin-products`](/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-products) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`cdp-market-balances`](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-balances-by-id) | `id` (CDP Market Balance ID) | [`GET /query/tabular/cdp-market-balances`](/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-balances) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`cdp-market-financials`](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-financials-by-id) | `id` (CDP Market Financial ID) | [`GET /query/tabular/cdp-market-financials`](/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-financials) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`cdp-market-interest-rates`](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-interest-rates-by-id) | `id` (CDP Market Interest Rate ID) | [`GET /query/tabular/cdp-market-interest-rates`](/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-interest-rates) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`cdp-market-liquidations`](/api-reference/data-api/collateralized-debt-positions-cdps/timeseries-cdp-market-liquidations-by-id) | `id` (CDP Market Liquidation ID) | [`GET /query/tabular/cdp-market-liquidations`](/api-reference/data-api/collateralized-debt-positions-cdps/tabular-cdp-market-liquidations) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`cefi-balances`](/api-reference/data-api/centralized-finance/timeseries-cefi-balances-by-id) | `id` (CeFi Balance ID) | [`GET /query/tabular/cefi-balances`](/api-reference/data-api/centralized-finance/tabular-cefi-balances) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`dat-companies`](/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies-by-id) | `id` (DAT Company ID) | [`GET /query/tabular/dat-companies`](/api-reference/data-api/digital-asset-treasury-companies/tabular-dat-companies) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`dat-companies-by-asset`](/api-reference/data-api/digital-asset-treasury-companies/timeseries-dat-companies-by-asset-by-id) | `id` (DAT Company Asset ID) | [`GET /query/tabular/dat-company-assets`](/api-reference/data-api/digital-asset-treasury-companies/tabular-dat-company-assets) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`dex-aggregator-volumes`](/api-reference/data-api/dex-aggregators/timeseries-dex-aggregator-volumes-by-id) | `id` (DEX Aggregator Volume ID) | [`GET /query/tabular/dex-aggregator-volumes`](/api-reference/data-api/dex-aggregators/tabular-dex-aggregator-volumes) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`etf-assets`](/api-reference/data-api/etfs/timeseries-etf-assets-by-id) | `id` (Asset ID) | [`GET /query/tabular/etf-assets`](/api-reference/data-api/etfs/tabular-etf-assets) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`etf-providers`](/api-reference/data-api/etfs/timeseries-etf-providers-by-id) | `id` (Project ID) | [`GET /query/tabular/etf-providers`](/api-reference/data-api/etfs/tabular-etf-providers) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`institutional-allocator-balances`](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-balances-by-id) | `id` (Institutional Allocator Balance ID) | [`GET /query/tabular/institutional-allocator-balances`](/api-reference/data-api/institutional-allocators/tabular-institutional-allocator-balances) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`institutional-allocator-financials`](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-financials-by-id) | `id` (Institutional Allocator Financial ID) | [`GET /query/tabular/institutional-allocator-financials`](/api-reference/data-api/institutional-allocators/tabular-institutional-allocator-financials) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`institutional-allocator-performances`](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-performances-by-id) | `id` (Institutional Allocator Performance ID) | [`GET /query/tabular/institutional-allocator-performances`](/api-reference/data-api/institutional-allocators/tabular-institutional-allocator-performances) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`launchpads-by-chain`](/api-reference/data-api/launchpads/timeseries-launchpads-by-chain-by-id) | `id` (Chain ID) | [`GET /query/tabular/launchpad-chains`](/api-reference/data-api/launchpads/tabular-launchpad-chains) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`launchpads`](/api-reference/data-api/launchpads/timeseries-launchpads-by-id) | `id` (Launchpad ID) | [`GET /query/tabular/launchpads`](/api-reference/data-api/launchpads/tabular-launchpads) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`lending-market-balances`](/api-reference/data-api/lending-protocols/timeseries-lending-market-balances-by-id) | `id` (Lending Market Balance ID) | [`GET /query/tabular/lending-market-balances`](/api-reference/data-api/lending-protocols/tabular-lending-market-balances) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`lending-market-financials`](/api-reference/data-api/lending-protocols/timeseries-lending-market-financials-by-id) | `id` (Lending Market Financial ID) | [`GET /query/tabular/lending-market-financials`](/api-reference/data-api/lending-protocols/tabular-lending-market-financials) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`lending-market-flows`](/api-reference/data-api/lending-protocols/timeseries-lending-market-flows-by-id) | `id` (Lending Market Flow ID) | [`GET /query/tabular/lending-market-flows`](/api-reference/data-api/lending-protocols/tabular-lending-market-flows) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`lending-market-interest-rates`](/api-reference/data-api/lending-protocols/timeseries-lending-market-interest-rates-by-id) | `id` (Lending Market Interest Rate ID) | [`GET /query/tabular/lending-market-interest-rates`](/api-reference/data-api/lending-protocols/tabular-lending-market-interest-rates) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`lending-market-liquidations`](/api-reference/data-api/lending-protocols/timeseries-lending-market-liquidations-by-id) | `id` (Lending Market Liquidation ID) | [`GET /query/tabular/lending-market-liquidations`](/api-reference/data-api/lending-protocols/tabular-lending-market-liquidations) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`lending-protocols-by-product-market`](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product-market-by-id) | `id` (Protocol Product Chain Market ID) | [`GET /query/tabular/lending-protocol-product-markets`](/api-reference/data-api/lending-protocols/tabular-lending-protocol-product-markets) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`lending-protocols-by-product`](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product-by-id) | `id` (Protocol Product Chain ID) | [`GET /query/tabular/lending-protocol-products`](/api-reference/data-api/lending-protocols/tabular-lending-protocol-products) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`lending-protocols`](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-id) | `id` (Project ID) | [`GET /query/tabular/lending-protocols`](/api-reference/data-api/lending-protocols/tabular-lending-protocols) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`bqen`](/api-reference/data-api/markets/timeseries-bqen-by-id) | `id` (Market ID) | [`GET /query/tabular/markets/`](/api-reference/data-api/markets/tabular-markets-by-id) then read `marketID` | `marketID` only | | [`payment-card-accounts`](/api-reference/data-api/payment-cards/timeseries-payment-card-accounts-by-id) | `id` (Payment Card Account ID) | [`GET /query/tabular/payment-card-accounts`](/api-reference/data-api/payment-cards/tabular-payment-card-accounts) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`payment-card-balances`](/api-reference/data-api/payment-cards/timeseries-payment-card-balances-by-id) | `id` (Payment Card Balance ID) | [`GET /query/tabular/payment-card-balances`](/api-reference/data-api/payment-cards/tabular-payment-card-balances) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`payment-card-spending`](/api-reference/data-api/payment-cards/timeseries-payment-card-spending-by-id) | `id` (Payment Card Spending ID) | [`GET /query/tabular/payment-card-spending`](/api-reference/data-api/payment-cards/tabular-payment-card-spending) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`peg-stability-backings`](/api-reference/data-api/peg-stability/timeseries-peg-stability-backings-by-id) | `id` (Peg Stability Backing ID) | [`GET /query/tabular/peg-stability-backings`](/api-reference/data-api/peg-stability/tabular-peg-stability-backings) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`peg-stability-facilities`](/api-reference/data-api/peg-stability/timeseries-peg-stability-facilities-by-id) | `id` (Peg Stability Facility ID) | [`GET /query/tabular/peg-stability-facilities`](/api-reference/data-api/peg-stability/tabular-peg-stability-facilities) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`perp-dex-protocols`](/api-reference/data-api/perp-dex-protocols/timeseries-perp-dex-protocols-by-id) | `id` (Project ID) | [`GET /query/tabular/perp-dex-protocols`](/api-reference/data-api/perp-dex-protocols/tabular-perp-dex-protocols) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`perpetual-market-funding-rates`](/api-reference/data-api/derivatives/timeseries-perpetual-market-funding-rates-by-id) | `perpetualMarketID` (Perpetual Market ID) | [`GET /query/tabular/perpetual-market-funding-rates/`](/api-reference/data-api/derivatives/tabular-perpetual-market-funding-rates-by-id) then read `perpetualMarketID` | `perpetualMarketID` only | | [`perpetual-markets`](/api-reference/data-api/derivatives/timeseries-perpetual-markets-by-id) | `id` (Perpetual Market ID) | [`GET /query/tabular/perpetual-markets/`](/api-reference/data-api/derivatives/tabular-perpetual-markets-by-id) then read `id` | `slug` or the `id` itself | | [`privacy-flows`](/api-reference/data-api/privacy/timeseries-privacy-flows-by-id) | `id` (Privacy Flow ID) | [`GET /query/tabular/privacy-flows`](/api-reference/data-api/privacy/tabular-privacy-flows) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`project-expenses`](/api-reference/data-api/project-financials/timeseries-project-expenses-by-id) | `id` (Project Expense ID) | [`GET /query/tabular/project-expenses`](/api-reference/data-api/project-financials/tabular-project-expenses) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`project-income-statements`](/api-reference/data-api/project-financials/timeseries-project-income-statements-by-id) | `id` (Project Income Statement ID) | [`GET /query/tabular/project-income-statements`](/api-reference/data-api/project-financials/tabular-project-income-statements) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`project-revenue`](/api-reference/data-api/project-financials/timeseries-project-revenue-by-id) | `id` (Project Revenue ID) | [`GET /query/tabular/project-revenue`](/api-reference/data-api/project-financials/tabular-project-revenue) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`project-tokenholder-distributions`](/api-reference/data-api/project-financials/timeseries-project-tokenholder-distributions-by-id) | `id` (Project Tokenholder Distribution ID) | [`GET /query/tabular/project-tokenholder-distributions`](/api-reference/data-api/project-financials/tabular-project-tokenholder-distributions) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`project-tokens`](/api-reference/data-api/projects/timeseries-project-tokens-by-id) | `id` (Token ID) | [`GET /query/tabular/project-tokens/`](/api-reference/data-api/projects/tabular-project-tokens-by-id) then read `id` | `id` only | | [`project-users`](/api-reference/data-api/projects/timeseries-project-users-by-id) | `id` (Project User ID) | [`GET /query/tabular/project-users`](/api-reference/data-api/projects/tabular-project-users) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`rwa-by-category`](/api-reference/data-api/real-world-assets/timeseries-rwa-by-category-by-id) | `id` (RWA Category ID) | [`GET /query/tabular/rwa-categories`](/api-reference/data-api/real-world-assets/tabular-rwa-categories) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`rwa-by-chain`](/api-reference/data-api/real-world-assets/timeseries-rwa-by-chain-by-id) | `id` (RWA Chain ID) | [`GET /query/tabular/rwa-chains`](/api-reference/data-api/real-world-assets/tabular-rwa-chains) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`rwa-by-deployment`](/api-reference/data-api/real-world-assets/timeseries-rwa-by-deployment-by-id) | `id` (RWA Deployment ID) | [`GET /query/tabular/rwa-deployments`](/api-reference/data-api/real-world-assets/tabular-rwa-deployments) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`rwa-by-issuer`](/api-reference/data-api/real-world-assets/timeseries-rwa-by-issuer-by-id) | `id` (RWA Issuer ID) | [`GET /query/tabular/rwa-issuers`](/api-reference/data-api/real-world-assets/tabular-rwa-issuers) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`rwa-by-product`](/api-reference/data-api/real-world-assets/timeseries-rwa-by-product-by-id) | `id` (RWA Product ID) | [`GET /query/tabular/rwa-products`](/api-reference/data-api/real-world-assets/tabular-rwa-products) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`rwa-spot-dex-activity`](/api-reference/data-api/real-world-assets/timeseries-rwa-spot-dex-activity-by-id) | `id` (RWA Spot DEX Segment ID) | [`GET /query/tabular/rwa-spot-dex-segments`](/api-reference/data-api/real-world-assets/tabular-rwa-spot-dex-segments) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`savings-balances`](/api-reference/data-api/savings/timeseries-savings-balances-by-id) | `id` (Savings Balance ID) | [`GET /query/tabular/savings-balances`](/api-reference/data-api/savings/tabular-savings-balances) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`savings-financials`](/api-reference/data-api/savings/timeseries-savings-financials-by-id) | `id` (Savings Financial ID) | [`GET /query/tabular/savings-financials`](/api-reference/data-api/savings/tabular-savings-financials) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`savings-performances`](/api-reference/data-api/savings/timeseries-savings-performances-by-id) | `id` (Savings Performance ID) | [`GET /query/tabular/savings-performances`](/api-reference/data-api/savings/tabular-savings-performances) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`spot-dex-liquidity-balances`](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-liquidity-balances-by-id) | `id` (Spot DEX Liquidity Balance ID) | [`GET /query/tabular/spot-dex-liquidity-balances`](/api-reference/data-api/spot-dex-protocols/tabular-spot-dex-liquidity-balances) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`spot-dex-protocols-by-chain`](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols-by-chain-by-id) | `id` (Protocol Version Chain ID) | [`GET /query/tabular/spot-dex-protocol-chains`](/api-reference/data-api/spot-dex-protocols/tabular-spot-dex-protocol-chains) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`spot-dex-protocols`](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols-by-id) | `id` (Project ID) | [`GET /query/tabular/spot-dex-protocols`](/api-reference/data-api/spot-dex-protocols/tabular-spot-dex-protocols) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`stablecoins-by-chain`](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-chain-by-id) | `id` (Chain ID) | [`GET /query/tabular/stablecoin-chains`](/api-reference/data-api/stablecoins/tabular-stablecoin-chains) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`stablecoins-by-currency`](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-currency-by-id) | `id` (Currency) | [`GET /query/tabular/stablecoin-currencies`](/api-reference/data-api/stablecoins/tabular-stablecoin-currencies) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`stablecoins-by-deployment`](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-deployment-by-id) | `id` (Stablecoin Deployment ID) | [`GET /query/tabular/stablecoin-deployments`](/api-reference/data-api/stablecoins/tabular-stablecoin-deployments) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`stablecoin-fx`](/api-reference/data-api/stablecoins/timeseries-stablecoin-fx-by-id) | `id` (Currency Pair) | [`GET /query/tabular/stablecoin-fx-pairs`](/api-reference/data-api/stablecoins/tabular-stablecoin-fx-pairs) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`stablecoins-by-issuer`](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-issuer-by-id) | `id` (Issuer ID) | [`GET /query/tabular/stablecoin-issuers`](/api-reference/data-api/stablecoins/tabular-stablecoin-issuers) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`stablecoins-by-product`](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-product-by-id) | `id` (Token ID) | [`GET /query/tabular/stablecoin-products`](/api-reference/data-api/stablecoins/tabular-stablecoin-products) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`stablecoin-reserves`](/api-reference/data-api/stablecoins/timeseries-stablecoin-reserves-by-id) | `id` (Reserve ID) | [`GET /query/tabular/stablecoin-reserve-entities`](/api-reference/data-api/stablecoins/tabular-stablecoin-reserve-entities) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`tcg-platforms-by-chain`](/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-chain-by-id), [`tcg-platforms-by-deployment`](/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-deployment-by-id) | `id` (Platform Chain ID) | [`GET /query/tabular/tcg-platform-chains`](/api-reference/data-api/tcg-platforms/tabular-tcg-platform-chains) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`token-metrics`](/api-reference/data-api/tokens/timeseries-token-metrics-by-id) | `id` (Token Metric ID) | [`GET /query/tabular/token-metrics`](/api-reference/data-api/tokens/tabular-token-metrics) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`tokenized-commodities-by-commodity`](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-commodity-by-id) | `id` (Commodity ID) | [`GET /query/tabular/tokenized-commodities`](/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodities) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`tokenized-commodities-by-chain`](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-chain-by-id) | `id` (Chain ID) | [`GET /query/tabular/tokenized-commodity-chains`](/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodity-chains) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`tokenized-commodities-by-issuer`](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-issuer-by-id) | `id` (Issuer ID) | [`GET /query/tabular/tokenized-commodity-issuers`](/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodity-issuers) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`tokenized-commodities-by-product`](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-product-by-id) | `id` (Product ID) | [`GET /query/tabular/tokenized-commodity-products`](/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodity-products) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`tokenized-equities-by-equity`](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-equity-by-id) | `id` (Equity ID) | [`GET /query/tabular/tokenized-equities`](/api-reference/data-api/tokenized-equities/tabular-tokenized-equities) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`tokenized-equities-by-chain`](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-chain-by-id) | `id` (Chain ID) | [`GET /query/tabular/tokenized-equity-chains`](/api-reference/data-api/tokenized-equities/tabular-tokenized-equity-chains) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`tokenized-equities-by-issuer`](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-issuer-by-id) | `id` (Issuer ID) | [`GET /query/tabular/tokenized-equity-issuers`](/api-reference/data-api/tokenized-equities/tabular-tokenized-equity-issuers) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`tokenized-equities-by-product`](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-product-by-id) | `id` (Product ID) | [`GET /query/tabular/tokenized-equity-products`](/api-reference/data-api/tokenized-equities/tabular-tokenized-equity-products) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`vault-balances`](/api-reference/data-api/vaults/timeseries-vault-balances-by-id) | `id` (Vault Balance ID) | [`GET /query/tabular/vault-balances`](/api-reference/data-api/vaults/tabular-vault-balances) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`vaults-by-chain`](/api-reference/data-api/vaults/timeseries-vaults-by-chain-by-id) | `id` (Chain ID) | [`GET /query/tabular/vault-chains`](/api-reference/data-api/vaults/tabular-vault-chains) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`vault-curators`](/api-reference/data-api/vaults/timeseries-vault-curators-by-id) | `id` (Curator ID) | [`GET /query/tabular/vault-curators`](/api-reference/data-api/vaults/tabular-vault-curators) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`vault-financials`](/api-reference/data-api/vaults/timeseries-vault-financials-by-id) | `id` (Vault Financial ID) | [`GET /query/tabular/vault-financials`](/api-reference/data-api/vaults/tabular-vault-financials) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`vault-flows`](/api-reference/data-api/vaults/timeseries-vault-flows-by-id) | `id` (Vault Flow ID) | [`GET /query/tabular/vault-flows`](/api-reference/data-api/vaults/tabular-vault-flows) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`vault-performances`](/api-reference/data-api/vaults/timeseries-vault-performances-by-id) | `id` (Vault Performance ID) | [`GET /query/tabular/vault-performances`](/api-reference/data-api/vaults/tabular-vault-performances) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`vault-protocols`](/api-reference/data-api/vaults/timeseries-vault-protocols-by-id) | `id` (Project ID) | [`GET /query/tabular/vault-protocols`](/api-reference/data-api/vaults/tabular-vault-protocols) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`wholesale-credit-balances`](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-balances-by-id) | `id` (Wholesale Credit Balance ID) | [`GET /query/tabular/wholesale-credit-balances`](/api-reference/data-api/wholesale-credit/tabular-wholesale-credit-balances) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`wholesale-credit-financials`](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-financials-by-id) | `id` (Wholesale Credit Financial ID) | [`GET /query/tabular/wholesale-credit-financials`](/api-reference/data-api/wholesale-credit/tabular-wholesale-credit-financials) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`wholesale-credit-interest-rates`](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-interest-rates-by-id) | `id` (Wholesale Credit Interest Rate ID) | [`GET /query/tabular/wholesale-credit-interest-rates`](/api-reference/data-api/wholesale-credit/tabular-wholesale-credit-interest-rates) then read `id` of the row | `id` only (list endpoint, no row lookup) | | [`exchanges`](/api-reference/data-api/exchanges/timeseries-exchanges-by-id) | `id` (Exchange ID) | the `exchanges` table, not published in this reference | the id only | | [`project-mindshare`](/api-reference/data-api/mindshare-sentiment/timeseries-project-mindshare-by-id), [`projects`](/api-reference/data-api/projects/timeseries-projects-by-id) | `id`, `project-id` (Project ID) | the `projects` table, not published in this reference | the id only | | [`protocol-revenue-by-product`](/api-reference/data-api/project-financials/timeseries-protocol-revenue-by-product-by-id) | `id` (Protocol Product Chain ID) | the `protocol-revenue-products` table, not published in this reference | the id only | | [`protocol-revenue`](/api-reference/data-api/project-financials/timeseries-protocol-revenue-by-id) | `id` (Project ID) | the `protocol-revenues` table, not published in this reference | the id only | | [`trending-topics`](/api-reference/data-api/news/timeseries-trending-topics-by-id) | `trending-topic-id` (Topic ID) | the `topics-current` table, not published in this reference | the id only | | [`sector-asset-mindshare`](/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-mindshare-by-id), [`sector-asset-sentiment`](/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-sentiment-by-id), [`sector-fundraising`](/api-reference/data-api/fundraising/timeseries-sector-fundraising-by-id), [`sector-investor-mentions`](/api-reference/data-api/mindshare-sentiment/timeseries-sector-investor-mentions-by-id), [`sector-marketdata`](/api-reference/data-api/sector-market-data/timeseries-sector-marketdata-by-id) | `sector` (Sectors) | none needed: call the multi-series endpoint without `series` and read `series[].key` | plain names, for example `AI` | | [`asset-group-sentiment`](/api-reference/data-api/mindshare-sentiment/timeseries-asset-group-sentiment-by-id) | `asset-group-id` (Asset Group ID) | none available: keys must be known in advance | plain names | | [`exchange-country`](/api-reference/data-api/exchanges/timeseries-exchange-country-by-id) | `country` (Country) | none available: keys must be known in advance | plain names such as `United States`, `Japan` | | [`exchange-region`](/api-reference/data-api/exchanges/timeseries-exchange-region-by-id) | `region` (Region) | none available: keys must be known in advance | plain names such as `Asia`, `Europe` | | [`exchange-type`](/api-reference/data-api/exchanges/timeseries-exchange-type-by-id) | `exchange-type` (Exchange Type) | none available: keys must be known in advance | plain names such as `centralized`, `decentralized` | | [`sub-sector-asset-mindshare`](/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-mindshare-by-id) | `sub-sector` (Sub-Sectors) | none available: keys must be known in advance | plain names | | [`sub-sector-asset-sentiment`](/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-sentiment-by-id) | `sub-sector` (Sub-Sectors) | none available: keys must be known in advance | plain names | | [`sub-sector-marketdata`](/api-reference/data-api/sector-market-data/timeseries-sub-sector-marketdata-by-id) | `sub-sector` (Sub-Sectors) | none available: keys must be known in advance | plain names | ## Keys that are plain names Aggregate models (sectors, sub-sectors, exchange types, countries and regions) key their series by a display name rather than an id. Where the model allows it, call the multi-series endpoint without `series` and read `series[].key`; those values are the keys. Where `series` is required, the names must be known in advance; the ones the examples on this site use are listed above. > [card] [Timeseries catalog](/api-reference/data-api/discovery/timeseries-catalog) > > Which column is the series key of every model (`seriesKey: true`). > [card] [Tabular catalog](/api-reference/data-api/discovery/tabular-catalog) > > Which columns are `primaryKey` and `identifier` on every lookup model. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > How the two model kinds compose. > [card] [Responses](/getting-started/responses) > > What `entity` and `points` look like once you have the key. # Tabular catalog Source: https://docs.blockworks.com/api-reference/data-api/discovery/tabular-catalog api-reference/data-api/openapi.json GET /query/tabular/catalog Returns the catalog of tabular models and their columns. By default every model is listed; pass publicOnly=true to list only models published to the public API, or accessible=true to list only the models your key may query. # Timeseries catalog Source: https://docs.blockworks.com/api-reference/data-api/discovery/timeseries-catalog api-reference/data-api/openapi.json GET /query/timeseries/catalog Returns the catalog of timeseries models and their columns. By default every model is listed; pass publicOnly=true to list only models published to the public API, or accessible=true to list only the models your key may query. # ETF Assets Source: https://docs.blockworks.com/api-reference/data-api/etfs/etf-assets Crypto ETF metrics per underlying asset: assets under management, net flow and product count split by spot versus futures, region and strategy, plus traded volume. Each series is one underlying asset, keyed by its slug. Only the breakdowns an asset has are populated, so pass selections. One row per crypto asset underlying at least one exchange-traded product, keyed by asset name: name and, for chain-native assets, the chain's slug and network id. The id is the series key of the etf-assets timeseries model. | | | | - | - | | Access | Etfs-dataset | | Tabular model | `etf-assets`: primary key `id`, identifiers `slug` | | Timeseries model | `etf-assets`: intervals `1d`, series key `id` (Asset ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List ETF Assets](/api-reference/data-api/etfs/tabular-etf-assets) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get ETF Asset timeseries](/api-reference/data-api/etfs/timeseries-etf-assets) > > Up to 10 series in one request, named by Asset ID in `series`. > [card] [Get ETF Asset timeseries](/api-reference/data-api/etfs/timeseries-etf-assets-by-id) > > One series over a time window, keyed by its Asset ID. ## Metrics 25 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `type-spot-aum-usd` | Spot AUM (USD) | float64 | | Spot product AUM in USD. | | `type-spot-flow-usd` | Spot Flow (USD) | float64 | | Spot product daily net flow in USD. | | `type-spot-product-count` | Spot Product Count | float64 | | Number of spot products. | | `type-futures-aum-usd` | Futures AUM (USD) | float64 | | Futures product AUM in USD. | | `type-futures-flow-usd` | Futures Flow (USD) | float64 | | Futures product daily net flow in USD. | | `type-futures-product-count` | Futures Product Count | float64 | | Number of futures products. | | `type-spot-unitedstates-aum-usd` | US Spot AUM (USD) | float64 | | US spot product AUM in USD. | | `type-spot-unitedstates-flow-usd` | US Spot Flow (USD) | float64 | | US spot product daily net flow in USD. | | `type-spot-unitedstates-product-count` | US Spot Product Count | float64 | | Number of US spot products. | | `type-spot-europe-aum-usd` | Europe Spot AUM (USD) | float64 | | European spot product AUM in USD. | | `type-spot-europe-flow-usd` | Europe Spot Flow (USD) | float64 | | European spot product daily net flow in USD. | | `type-spot-europe-product-count` | Europe Spot Product Count | float64 | | Number of European spot products. | | `type-spot-apac-aum-usd` | APAC Spot AUM (USD) | float64 | | APAC spot product AUM in USD. | | `type-spot-apac-flow-usd` | APAC Spot Flow (USD) | float64 | | APAC spot product daily net flow in USD. | | `type-spot-apac-product-count` | APAC Spot Product Count | float64 | | Number of APAC spot products. | | `strategy-deltaone-aum-usd` | Delta-One AUM (USD) | float64 | | Delta-one strategy AUM in USD. | | `strategy-deltaone-flow-usd` | Delta-One Flow (USD) | float64 | | Delta-one strategy daily net flow in USD. | | `strategy-deltaone-product-count` | Delta-One Product Count | float64 | | Number of delta-one products. | | `strategy-leveraged-aum-usd` | Leveraged AUM (USD) | float64 | | Leveraged strategy AUM in USD. | | `strategy-leveraged-flow-usd` | Leveraged Flow (USD) | float64 | | Leveraged strategy daily net flow in USD. | | `strategy-leveraged-product-count` | Leveraged Product Count | float64 | | Number of leveraged products. | | `total-volume-usd` | Total Volume (USD) | float64 | | Total traded volume in USD. | | `volume-unitedstates-usd` | US Volume (USD) | float64 | | US traded volume in USD. | | `volume-europe-usd` | Europe Volume (USD) | float64 | | European traded volume in USD. | | `volume-apac-usd` | APAC Volume (USD) | float64 | | APAC traded volume in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the etf-assets timeseries model, the lowercase name of the underlying asset (bitcoin, ethereum, solana). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the asset, currently the same lowercase name as the id. | | `slug` | string | `Eq`, `IsOneOf` | yes | The slug in the blockchains model of the asset's own chain, for assets native to a chain; null otherwise. (identifier 1) | | `networkID` | string | `Eq`, `IsOneOf` | | The networkID in the blockchains model of the asset's own chain; null when the asset has no chain of its own. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/etf-assets/1d/aave?timeframe=7d&selections=type-spot-aum-usd,type-spot-flow-usd" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get ETF Asset timeseries](/api-reference/data-api/etfs/timeseries-etf-assets-by-id) for the response and the errors. # ETF Providers Source: https://docs.blockworks.com/api-reference/data-api/etfs/etf-providers Crypto ETF metrics per issuer: assets under management, daily and 30-day net flow, number of products, weighted expense ratio and the bitcoin and spot shares of AUM. Each series is one provider, keyed by its slug. One row per issuer of crypto exchange-traded products, keyed by the provider's short name: name, project slug and project id. The id is the series key of the etf-providers timeseries model. | | | | - | - | | Access | Etfs-dataset | | Tabular model | `etf-providers`: primary key `id`, identifiers `slug` | | Timeseries model | `etf-providers`: intervals `1d`, series key `id` (Project ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List ETF Providers](/api-reference/data-api/etfs/tabular-etf-providers) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get ETF Provider timeseries](/api-reference/data-api/etfs/timeseries-etf-providers) > > Up to 10 series in one request, named by Project ID in `series`. > [card] [Get ETF Provider timeseries](/api-reference/data-api/etfs/timeseries-etf-providers-by-id) > > One series over a time window, keyed by its Project ID. ## Metrics 8 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `aum-usd` | AUM (USD) | float64 | | Assets under management across the provider's crypto ETF products in USD. | | `flow-usd` | Flow (USD) | float64 | | Daily net flow across the provider's crypto ETF products in USD. | | `num-products` | Product Count | float64 | | Number of active products with positive AUM. | | `weighted-aum-expense-ratio` | Weighted Expense Ratio | float64 | | AUM-weighted average expense ratio. | | `bitcoin-aum-perc` | Bitcoin AUM Share | float64 | | Share of AUM in bitcoin products (0-1). | | `spot-aum-perc` | Spot AUM Share | float64 | | Share of AUM in delta-one (spot) products (0-1). | | `rolling-30d-flow-usd` | Rolling 30d Flow (USD) | float64 | | Rolling 30-day net flow in USD. | | `aum-30d-change-perc` | AUM 30d Change | float64 | | AUM change versus 30 days ago as a ratio. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the etf-providers timeseries model, the provider's short name (blackrock). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the provider. | | `slug` | string | `Eq`, `IsOneOf` | yes | The provider's project slug, the slug used for the same company across the API. (identifier 1) | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the provider's project record. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/etf-providers/1d/21shares?timeframe=7d&selections=aum-usd,flow-usd" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get ETF Provider timeseries](/api-reference/data-api/etfs/timeseries-etf-providers-by-id) for the response and the errors. # ETFs Source: https://docs.blockworks.com/api-reference/data-api/etfs/overview Crypto exchange-traded product metrics per underlying asset and per issuer: assets under management, net flows, product counts, expense ratios and traded volume. The two tables give the keys of the two series. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [ETF Assets](/api-reference/data-api/etfs/etf-assets) | Etfs-dataset | [List rows](/api-reference/data-api/etfs/tabular-etf-assets) | [Batch](/api-reference/data-api/etfs/timeseries-etf-assets), [One series](/api-reference/data-api/etfs/timeseries-etf-assets-by-id) | | [ETF Providers](/api-reference/data-api/etfs/etf-providers) | Etfs-dataset | [List rows](/api-reference/data-api/etfs/tabular-etf-providers) | [Batch](/api-reference/data-api/etfs/timeseries-etf-providers), [One series](/api-reference/data-api/etfs/timeseries-etf-providers-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/etf-assets?pageSize=3&selections=id,slug,name,networkID" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List ETF Assets](/api-reference/data-api/etfs/tabular-etf-assets) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List ETF Assets Source: https://docs.blockworks.com/api-reference/data-api/etfs/tabular-etf-assets api-reference/data-api/openapi.json GET /query/tabular/etf-assets One row per crypto asset underlying at least one exchange-traded product, keyed by asset name: name and, for chain-native assets, the chain's slug and network id. The id is the series key of the etf-assets timeseries model. # List ETF Providers Source: https://docs.blockworks.com/api-reference/data-api/etfs/tabular-etf-providers api-reference/data-api/openapi.json GET /query/tabular/etf-providers One row per issuer of crypto exchange-traded products, keyed by the provider's short name: name, project slug and project id. The id is the series key of the etf-providers timeseries model. # Batch Get ETF Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/etfs/timeseries-etf-assets api-reference/data-api/openapi.json GET /query/timeseries/etf-assets/{granularity} Crypto ETF metrics per underlying asset: assets under management, net flow and product count split by spot versus futures, region and strategy, plus traded volume. Each series is one underlying asset, keyed by its slug. Only the breakdowns an asset has are populated, so pass selections. # Get ETF Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/etfs/timeseries-etf-assets-by-id api-reference/data-api/openapi.json GET /query/timeseries/etf-assets/{granularity}/{id} Crypto ETF metrics per underlying asset: assets under management, net flow and product count split by spot versus futures, region and strategy, plus traded volume. Each series is one underlying asset, keyed by its slug. Only the breakdowns an asset has are populated, so pass selections. # Batch Get ETF Provider timeseries Source: https://docs.blockworks.com/api-reference/data-api/etfs/timeseries-etf-providers api-reference/data-api/openapi.json GET /query/timeseries/etf-providers/{granularity} Crypto ETF metrics per issuer: assets under management, daily and 30-day net flow, number of products, weighted expense ratio and the bitcoin and spot shares of AUM. Each series is one provider, keyed by its slug. # Get ETF Provider timeseries Source: https://docs.blockworks.com/api-reference/data-api/etfs/timeseries-etf-providers-by-id api-reference/data-api/openapi.json GET /query/timeseries/etf-providers/{granularity}/{id} Crypto ETF metrics per issuer: assets under management, daily and 30-day net flow, number of products, weighted expense ratio and the bitcoin and spot shares of AUM. Each series is one provider, keyed by its slug. # Exchange Country Source: https://docs.blockworks.com/api-reference/data-api/exchanges/exchange-country Trade volume in USD and trade count summed across the exchanges domiciled in each country. Each series is one country, keyed by its English name. | | | | - | - | | Access | Exchanges-dataset | | Timeseries model | `exchange-country`: intervals `1d`, `1h`, series key `country` (Country), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Country timeseries](/api-reference/data-api/exchanges/timeseries-exchange-country) > > Up to 10 series in one request, named by Country in `series`. > [card] [Get Country timeseries](/api-reference/data-api/exchanges/timeseries-exchange-country-by-id) > > One series over a time window, keyed by its Country. ## Metrics 2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `volume` | Volume | float64 | | The trade volume on the exchange in USD | | `trade-count` | Trade Count | float64 | | The number of trades on the exchange | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/exchange-country/1d/United%20States?timeframe=7d&selections=volume,trade-count" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Country timeseries](/api-reference/data-api/exchanges/timeseries-exchange-country-by-id) for the response and the errors. # Exchange Region Source: https://docs.blockworks.com/api-reference/data-api/exchanges/exchange-region Trade volume in USD and trade count summed across the exchanges in each region, with Decentralized for exchanges without a jurisdiction. Each series is one region, keyed by its name. | | | | - | - | | Access | Exchanges-dataset | | Timeseries model | `exchange-region`: intervals `1d`, `1h`, series key `region` (Region), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Region timeseries](/api-reference/data-api/exchanges/timeseries-exchange-region) > > Up to 10 series in one request, named by Region in `series`. > [card] [Get Region timeseries](/api-reference/data-api/exchanges/timeseries-exchange-region-by-id) > > One series over a time window, keyed by its Region. ## Metrics 2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `volume` | Volume | float64 | | The trade volume on the exchange in USD | | `trade-count` | Trade Count | float64 | | The number of trades on the exchange | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/exchange-region/1d/Asia?timeframe=7d&selections=volume,trade-count" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Region timeseries](/api-reference/data-api/exchanges/timeseries-exchange-region-by-id) for the response and the errors. # Exchange Type Source: https://docs.blockworks.com/api-reference/data-api/exchanges/exchange-type Trade volume in USD and trade count across all centralized and all decentralized exchanges. Two series, keyed centralized and decentralized; tracks the DEX share of trading. | | | | - | - | | Access | Exchanges-dataset | | Timeseries model | `exchange-type`: intervals `1d`, `1h`, series key `exchange-type` (Exchange Type), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Exchange Type timeseries](/api-reference/data-api/exchanges/timeseries-exchange-type) > > Up to 10 series in one request, named by Exchange Type in `series`. > [card] [Get Exchange Type timeseries](/api-reference/data-api/exchanges/timeseries-exchange-type-by-id) > > One series over a time window, keyed by its Exchange Type. ## Metrics 2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `volume` | Volume | float64 | | The trade volume on the exchange in USD | | `trade-count` | Trade Count | float64 | | The number of trades on the exchange | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/exchange-type/1d/centralized?timeframe=7d&selections=volume,trade-count" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Exchange Type timeseries](/api-reference/data-api/exchanges/timeseries-exchange-type-by-id) for the response and the errors. # Exchanges Source: https://docs.blockworks.com/api-reference/data-api/exchanges/exchanges Trade volume in USD and trade count on one exchange, centralized or decentralized. Each series is one exchange, keyed by its exchange id. | | | | - | - | | Access | Exchanges-dataset | | Timeseries model | `exchanges`: intervals `5m`, `1h`, `1d`, `1w`, series key `id` (Exchange ID), series must be named (up to 10 per call), aliases `exchange` | ## Endpoints > [card] [Batch Get Exchange timeseries](/api-reference/data-api/exchanges/timeseries-exchanges) > > Up to 10 series in one request, named by Exchange ID in `series`. > [card] [Get Exchange timeseries](/api-reference/data-api/exchanges/timeseries-exchanges-by-id) > > One series over a time window, keyed by its Exchange ID. ## Metrics 2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `trade-count` | Trade Count | float64 | | Trade count during the candle. | | `volume` | Volume | float64 | usd | Volume traded during candle. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/exchanges/1d/8be78914-8ee5-4af6-8388-f5cb41a6da6d?timeframe=7d&selections=trade-count,volume" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Exchange timeseries](/api-reference/data-api/exchanges/timeseries-exchanges-by-id) for the response and the errors. # Exchanges Source: https://docs.blockworks.com/api-reference/data-api/exchanges/overview Trade volume and trade count per exchange, and the same metrics summed by country, region and exchange type. The per-exchange series is keyed by exchange id; the aggregates are keyed by plain names such as a country, a region, or centralized and decentralized. ## Endpoints | Model | Access | Timeseries | | - | - | - | | [Exchanges](/api-reference/data-api/exchanges/exchanges) | Exchanges-dataset | [Batch](/api-reference/data-api/exchanges/timeseries-exchanges), [One series](/api-reference/data-api/exchanges/timeseries-exchanges-by-id) | | [Exchange Country](/api-reference/data-api/exchanges/exchange-country) | Exchanges-dataset | [Batch](/api-reference/data-api/exchanges/timeseries-exchange-country), [One series](/api-reference/data-api/exchanges/timeseries-exchange-country-by-id) | | [Exchange Region](/api-reference/data-api/exchanges/exchange-region) | Exchanges-dataset | [Batch](/api-reference/data-api/exchanges/timeseries-exchange-region), [One series](/api-reference/data-api/exchanges/timeseries-exchange-region-by-id) | | [Exchange Type](/api-reference/data-api/exchanges/exchange-type) | Exchanges-dataset | [Batch](/api-reference/data-api/exchanges/timeseries-exchange-type), [One series](/api-reference/data-api/exchanges/timeseries-exchange-type-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/exchanges/1d?series=8be78914-8ee5-4af6-8388-f5cb41a6da6d,d034aca8-c657-4fb0-9b8a-6a9e46148a10&timeframe=7d&selections=trade-count,volume" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Batch Get Exchange timeseries](/api-reference/data-api/exchanges/timeseries-exchanges) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Batch Get Country timeseries Source: https://docs.blockworks.com/api-reference/data-api/exchanges/timeseries-exchange-country api-reference/data-api/openapi.json GET /query/timeseries/exchange-country/{granularity} Trade volume in USD and trade count summed across the exchanges domiciled in each country. Each series is one country, keyed by its English name. # Get Country timeseries Source: https://docs.blockworks.com/api-reference/data-api/exchanges/timeseries-exchange-country-by-id api-reference/data-api/openapi.json GET /query/timeseries/exchange-country/{granularity}/{country} Trade volume in USD and trade count summed across the exchanges domiciled in each country. Each series is one country, keyed by its English name. # Batch Get Region timeseries Source: https://docs.blockworks.com/api-reference/data-api/exchanges/timeseries-exchange-region api-reference/data-api/openapi.json GET /query/timeseries/exchange-region/{granularity} Trade volume in USD and trade count summed across the exchanges in each region, with Decentralized for exchanges without a jurisdiction. Each series is one region, keyed by its name. # Get Region timeseries Source: https://docs.blockworks.com/api-reference/data-api/exchanges/timeseries-exchange-region-by-id api-reference/data-api/openapi.json GET /query/timeseries/exchange-region/{granularity}/{region} Trade volume in USD and trade count summed across the exchanges in each region, with Decentralized for exchanges without a jurisdiction. Each series is one region, keyed by its name. # Batch Get Exchange Type timeseries Source: https://docs.blockworks.com/api-reference/data-api/exchanges/timeseries-exchange-type api-reference/data-api/openapi.json GET /query/timeseries/exchange-type/{granularity} Trade volume in USD and trade count across all centralized and all decentralized exchanges. Two series, keyed centralized and decentralized; tracks the DEX share of trading. # Get Exchange Type timeseries Source: https://docs.blockworks.com/api-reference/data-api/exchanges/timeseries-exchange-type-by-id api-reference/data-api/openapi.json GET /query/timeseries/exchange-type/{granularity}/{exchange-type} Trade volume in USD and trade count across all centralized and all decentralized exchanges. Two series, keyed centralized and decentralized; tracks the DEX share of trading. # Batch Get Exchange timeseries Source: https://docs.blockworks.com/api-reference/data-api/exchanges/timeseries-exchanges api-reference/data-api/openapi.json GET /query/timeseries/exchanges/{granularity} Trade volume in USD and trade count on one exchange, centralized or decentralized. Each series is one exchange, keyed by its exchange id. # Get Exchange timeseries Source: https://docs.blockworks.com/api-reference/data-api/exchanges/timeseries-exchanges-by-id api-reference/data-api/openapi.json GET /query/timeseries/exchanges/{granularity}/{id} Trade volume in USD and trade count on one exchange, centralized or decentralized. Each series is one exchange, keyed by its exchange id. # Acquisition Deals Source: https://docs.blockworks.com/api-reference/data-api/fundraising/acquisition-deals One row per merger or acquisition in the crypto industry, keyed by acquisitionDealID: announcement and funding dates, transaction amount when disclosed, status, and the acquiring and acquired entities with their sectors, logos and announcement URLs. Filter by date, amount, status or entity; sorted by announcement date. | | | | - | - | | Access | Fundraising-dataset | | Tabular model | `acquisition-deals`: primary key `acquisitionDealID` | ## Endpoints > [card] [List Acquisition Deals](/api-reference/data-api/fundraising/tabular-acquisition-deals) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Acquisition Deal](/api-reference/data-api/fundraising/tabular-acquisition-deals-by-id) > > One row by `acquisitionDealID`. ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `acquisitionDealID` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The unique identifier of the acquisition deal. (primary key) | | `announcementDate` | time | `Gt`, `Gte`, `Lt`, `Lte` | default | The date the deal was announced. | | `fundingDate` | time | `Gt`, `Gte`, `Lt`, `Lte` | yes | The date the deal closed, when it differs from the announcement date. | | `transactionAmountUSD` | float64 | `Gt`, `Gte`, `Lt`, `Lte` | yes | The value of the transaction, in US dollars. Null when the amount was not disclosed. | | `status` | string | `Eq`, `NotEq`, `IsOneOf`, `IsNotOneOf` | yes | The status of the deal: announced, completed, or canceled. Values are lowercase. | | `acquiringEntityID` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The unique identifier of the project, organization, or governing body making the acquisition. | | `acquiringEntityType` | string | `Eq`, `IsOneOf` | | Whether the acquiring entity is a project, an organization, or a governing body. | | `acquiringEntityName` | string | `Eq`, `IsOneOf`, `Contains` | yes | The name of the acquiring entity. | | `acquiringEntitySlug` | string | `Eq`, `IsOneOf` | | The URL slug of the acquiring entity. | | `acquiringEntityLogoURL` | string | | | The URL of the acquiring entity's logo. | | `acquiringEntityIsActive` | bool | `Eq`, `NotEq` | | If true, the acquiring entity is still an active entity. | | `acquiredEntityID` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The unique identifier of the project, organization, or product being acquired. | | `acquiredEntityType` | string | `Eq`, `IsOneOf` | | Whether the acquired entity is a project, an organization, or a product. | | `acquiredEntityName` | string | `Eq`, `IsOneOf`, `Contains` | yes | The name of the acquired entity. | | `acquiredEntitySlug` | string | `Eq`, `IsOneOf` | | The URL slug of the acquired entity. | | `acquiredEntityLogoURL` | string | | | The URL of the acquired entity's logo. | | `acquiredEntityIsActive` | bool | `Eq`, `NotEq` | | If true, the acquired entity is still an active entity. | | `acquiredEntitySector` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The legacy sector classification of the acquired entity. | | `acquiredEntityCategory` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The legacy category classification of the acquired entity. | | `announcementURLs` | array_string | | | The URLs of the announcements covering the deal, primary announcement first. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/acquisition-deals?pageSize=3&selections=acquisitionDealID,announcementDate,fundingDate,transactionAmountUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Acquisition Deals](/api-reference/data-api/fundraising/tabular-acquisition-deals) for the response and the errors. # Fund Managers Source: https://docs.blockworks.com/api-reference/data-api/fundraising/fund-managers One row per fund and manager pair, keyed by fundManagerID: the fund with its announcement date and size, and the manager with its type, logo and investor id. Lists every fund a manager has raised or the firms behind a fund. | | | | - | - | | Access | Fundraising-dataset | | Tabular model | `fund-managers`: primary key `fundManagerID` | ## Endpoints > [card] [List Fund Managers](/api-reference/data-api/fundraising/tabular-fund-managers) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Fund Manager](/api-reference/data-api/fundraising/tabular-fund-managers-by-id) > > One row by `fundManagerID`. ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `fundManagerID` | string | `Eq`, `IsOneOf` | | The unique identifier of this manager's relation to this fund. (primary key) | | `fundID` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The unique identifier of the fund being managed. | | `fundName` | string | `Eq`, `IsOneOf`, `Contains` | yes | The name of the fund being managed. | | `fundAnnouncementDate` | time | `Gt`, `Gte`, `Lt`, `Lte` | default | The date the fund was announced. | | `fundRaisedAmountUSD` | float64 | `Gt`, `Gte`, `Lt`, `Lte` | yes | The amount the fund raised, in US dollars. | | `investorID` | string | `Eq`, `IsOneOf` | | The unique identifier of the investor record behind the manager. Use managerEntityID to join against the underlying organization, project, or person. | | `managerEntityID` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The unique identifier of the organization, project, or person that manages the fund. | | `managerEntityType` | string | `Eq`, `IsOneOf` | | Whether the manager is an organization, a project, a person, or a governing body. | | `managerName` | string | `Eq`, `IsOneOf`, `Contains` | yes | The name of the fund's manager. | | `managerLogoURL` | string | | | The URL of the manager's logo. | | `managerIsActive` | bool | `Eq`, `NotEq` | | If true, the manager is still an active entity. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/fund-managers?pageSize=3&selections=fundManagerID,fundID,fundName,fundAnnouncementDate" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Fund Managers](/api-reference/data-api/fundraising/tabular-fund-managers) for the response and the errors. # Funding Round Investors Source: https://docs.blockworks.com/api-reference/data-api/fundraising/funding-round-investors One row per investor participation in a funding round, keyed by fundingRoundInvestorID: the investor with its type and lead flag, the round with its date, type, stage and amount, and the funded entity with its sector. Lists everything one investor backed or every investor in one round. | | | | - | - | | Access | Fundraising-dataset | | Tabular model | `funding-round-investors`: primary key `fundingRoundInvestorID` | ## Endpoints > [card] [List Funding Round Investors](/api-reference/data-api/fundraising/tabular-funding-round-investors) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Funding Round Investor](/api-reference/data-api/fundraising/tabular-funding-round-investors-by-id) > > One row by `fundingRoundInvestorID`. ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `fundingRoundInvestorID` | string | `Eq`, `IsOneOf` | | The unique identifier of this investor's participation in this funding round. (primary key) | | `fundingRoundID` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The unique identifier of the funding round. | | `isLead` | bool | `Eq`, `NotEq` | | If true, this investor led the round. | | `investorID` | string | `Eq`, `IsOneOf` | | The unique identifier of the investor record. Use investorEntityID to join against the underlying organization, project, or person. | | `investorEntityID` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The unique identifier of the organization, project, or person that invested. | | `investorEntityType` | string | `Eq`, `IsOneOf` | | Whether the investor is an organization, a project, or a person. | | `investorName` | string | `Eq`, `IsOneOf`, `Contains` | yes | The name of the investor. | | `investorLogoURL` | string | | | The URL of the investor's logo. | | `investorIsActive` | bool | `Eq`, `NotEq` | | If true, the investor is still an active entity. | | `investorFoundedDate` | time | `Gt`, `Gte`, `Lt`, `Lte` | | The date the investor was founded. | | `investorTotalAmountRaisedUSD` | float64 | `Gt`, `Gte`, `Lt`, `Lte` | yes | The total the investor has raised across its own funding rounds, in US dollars. | | `announcementDate` | time | `Gt`, `Gte`, `Lt`, `Lte` | default | The date the funding round was announced. | | `type` | string | `Eq`, `NotEq`, `IsOneOf`, `IsNotOneOf` | | The type of the funding round, for example Seed, Series A, or Private Token Sale. | | `stage` | string | `Eq`, `NotEq`, `IsOneOf`, `IsNotOneOf` | | The broad stage the round belongs to: Seed, Early Stage, Late Stage, Public Equity Offering, Post Public Equity, or Miscellaneous. | | `raisedAmountUSD` | float64 | `Gt`, `Gte`, `Lt`, `Lte` | yes | The amount raised in the round, in US dollars. Null when the amount was not disclosed. | | `isTokenFunded` | bool | `Eq`, `NotEq` | | If true, the round was funded with tokens rather than equity. | | `fundedEntityID` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The unique identifier of the project or organization that received the funding. | | `fundedEntityType` | string | `Eq`, `IsOneOf` | | Whether the funded entity is a project or an organization. | | `fundedEntityName` | string | `Eq`, `IsOneOf`, `Contains` | yes | The name of the project or organization that received the funding. | | `fundedEntitySlug` | string | `Eq`, `IsOneOf` | | The URL slug of the project or organization that received the funding. | | `fundedEntitySector` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The legacy sector classification of the funded entity. | | `fundedEntityCategory` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The legacy category classification of the funded entity. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/funding-round-investors?pageSize=3&selections=fundingRoundInvestorID,fundingRoundID,isLead,investorID" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Funding Round Investors](/api-reference/data-api/fundraising/tabular-funding-round-investors) for the response and the errors. # Funding Rounds Source: https://docs.blockworks.com/api-reference/data-api/fundraising/funding-rounds One row per funding round raised by a crypto project or company, keyed by fundingRoundID: announcement date, type, stage, amount and valuation when disclosed, the funded entity with its sector and location, ecosystem networks, and the investors as arrays with lead investors marked. Filter by date, amount, type, stage, sector, country, entity or investor. | | | | - | - | | Access | Fundraising-dataset | | Tabular model | `funding-rounds`: primary key `fundingRoundID` | ## Endpoints > [card] [List Funding Rounds](/api-reference/data-api/fundraising/tabular-funding-rounds) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Funding Round](/api-reference/data-api/fundraising/tabular-funding-rounds-by-id) > > One row by `fundingRoundID`. ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `fundingRoundID` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The unique identifier of the funding round. (primary key) | | `announcementDate` | time | `Gt`, `Gte`, `Lt`, `Lte` | default | The date the funding round was announced. | | `fundingDate` | time | `Gt`, `Gte`, `Lt`, `Lte` | yes | The date the funding round closed, when it differs from the announcement date. | | `type` | string | `Eq`, `NotEq`, `IsOneOf`, `IsNotOneOf` | yes | The type of the funding round, for example Seed, Series A, or Private Token Sale. | | `stage` | string | `Eq`, `NotEq`, `IsOneOf`, `IsNotOneOf` | yes | The broad stage the round belongs to: Seed, Early Stage, Late Stage, Public Equity Offering, Post Public Equity, or Miscellaneous. | | `isTokenFunded` | bool | `Eq`, `NotEq` | | If true, the round was funded with tokens rather than equity. | | `cryptoNative` | bool | `Eq`, `NotEq` | | If true, the funded entity is a crypto-native business. | | `raisedAmountUSD` | float64 | `Gt`, `Gte`, `Lt`, `Lte` | yes | The amount raised in the round, in US dollars. Null when the amount was not disclosed. | | `postMoneyValuationUSD` | float64 | `Gt`, `Gte`, `Lt`, `Lte` | yes | The post-money valuation of the funded entity after the round, in US dollars. | | `hasNativeAsset` | bool | `Eq`, `NotEq` | | If true, the funded entity has a native asset. | | `fundedEntityID` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The unique identifier of the project or organization that received the funding. Null for the small number of rounds whose funded entity has since been archived. | | `fundedEntityType` | string | `Eq`, `IsOneOf` | | Whether the funded entity is a project or an organization. | | `fundedEntityName` | string | `Eq`, `IsOneOf`, `Contains` | yes | The name of the project or organization that received the funding. | | `fundedEntitySlug` | string | `Eq`, `IsOneOf` | | The URL slug of the project or organization that received the funding. | | `fundedEntityLogoURL` | string | | | The URL of the funded entity's logo. | | `fundedEntityDescription` | string | | | A short description of the funded entity. | | `fundedEntitySector` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The legacy sector classification of the funded entity. | | `fundedEntityCategory` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The legacy category classification of the funded entity. | | `fundedEntitySectorsV2` | array_string | `Includes`, `NotIncludes`, `IncludesAnyOf`, `NotIncludesAnyOf` | | The v2 sectors the funded entity belongs to. | | `fundedEntitySubSectorsV2` | array_string | `Includes`, `NotIncludes`, `IncludesAnyOf`, `NotIncludesAnyOf` | | The v2 sub-sectors the funded entity belongs to. | | `fundedEntityTagsV2` | array_string | `Includes`, `NotIncludes`, `IncludesAnyOf`, `NotIncludesAnyOf` | | The v2 tags applied to the funded entity. | | `fundedEntityCityName` | string | `Eq`, `IsOneOf` | | The city the funded entity is based in. | | `fundedEntityStateName` | string | `Eq`, `IsOneOf` | | The state or region the funded entity is based in. | | `fundedEntityCountryName` | string | `Eq`, `IsOneOf` | | The country the funded entity is based in. | | `fundedEntityCountryISO2` | string | `Eq`, `IsOneOf` | | The ISO 3166-1 alpha-2 code of the country the funded entity is based in. | | `fundedEntityTotalAmountRaisedUSD` | float64 | `Gt`, `Gte`, `Lt`, `Lte` | yes | The total raised by the funded entity across every round it has closed, in US dollars. | | `ecosystemNetworkIDs` | array_string | `Includes`, `IncludesAnyOf` | | The identifiers of the networks whose ecosystem the funded entity belongs to. | | `investorCount` | int64 | `Eq`, `Gt`, `Gte`, `Lt`, `Lte` | yes | The number of distinct investors that participated in the round. | | `investorEntityIDs` | array_string | `Includes`, `NotIncludes`, `IncludesAnyOf`, `NotIncludesAnyOf` | | The identifiers of every organization, project, or person that invested in the round. | | `investorNames` | array_string | `Includes`, `IncludesAnyOf` | | The names of every investor that participated in the round. | | `leadInvestorEntityIDs` | array_string | `Includes`, `IncludesAnyOf` | | The identifiers of the investors that led the round. | | `leadInvestorNames` | array_string | `Includes`, `IncludesAnyOf` | | The names of the investors that led the round. | | `investorOrganizationIDs` | array_string | `Includes`, `IncludesAnyOf` | | The identifiers of the organizations that invested in the round. | | `investorProjectIDs` | array_string | `Includes`, `IncludesAnyOf` | | The identifiers of the projects that invested in the round. | | `investorPersonIDs` | array_string | `Includes`, `IncludesAnyOf` | | The identifiers of the people that invested in the round. | | `announcementURLs` | array_string | | | The URLs of the announcements covering the round, primary announcement first. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/funding-rounds?pageSize=3&selections=fundingRoundID,announcementDate,fundingDate,type" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Funding Rounds](/api-reference/data-api/fundraising/tabular-funding-rounds) for the response and the errors. # Funds Source: https://docs.blockworks.com/api-reference/data-api/fundraising/funds One row per venture fund raised to invest in crypto, keyed by fundID: name, announcement and funding dates, size when disclosed, managers, limited partners and announcement URLs. Tracks fund formation and the funds a manager runs. | | | | - | - | | Access | Fundraising-dataset | | Tabular model | `funds`: primary key `fundID` | ## Endpoints > [card] [List Funds](/api-reference/data-api/fundraising/tabular-funds) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Fund](/api-reference/data-api/fundraising/tabular-funds-by-id) > > One row by `fundID`. ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `fundID` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The unique identifier of the fund. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | yes | The name of the fund. | | `announcementDate` | time | `Gt`, `Gte`, `Lt`, `Lte` | default | The date the fund was announced. | | `fundingDate` | time | `Gt`, `Gte`, `Lt`, `Lte` | yes | The date the fund closed, when it differs from the announcement date. | | `raisedAmountUSD` | float64 | `Gt`, `Gte`, `Lt`, `Lte` | yes | The amount the fund raised, in US dollars. Null when the amount was not disclosed. | | `cryptoNative` | bool | `Eq`, `NotEq` | | If true, the fund is crypto-native. | | `managerCount` | int64 | `Eq`, `Gt`, `Gte`, `Lt`, `Lte` | yes | The number of managers running the fund. | | `managerEntityIDs` | array_string | `Includes`, `NotIncludes`, `IncludesAnyOf`, `NotIncludesAnyOf` | | The identifiers of the organizations, projects, or people that manage the fund. | | `managerNames` | array_string | `Includes`, `IncludesAnyOf` | | The names of the fund's managers. | | `limitedPartnerEntityIDs` | array_string | `Includes`, `NotIncludes`, `IncludesAnyOf`, `NotIncludesAnyOf` | | The identifiers of the organizations, projects, or people invested in the fund as limited partners. | | `limitedPartnerNames` | array_string | `Includes`, `IncludesAnyOf` | | The names of the fund's limited partners. | | `announcementURLs` | array_string | | | The URLs of the announcements covering the fund, primary announcement first. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/funds?pageSize=3&selections=fundID,name,announcementDate,fundingDate" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Funds](/api-reference/data-api/fundraising/tabular-funds) for the response and the errors. # Fundraising Source: https://docs.blockworks.com/api-reference/data-api/fundraising/overview Fundraising: Sector Fundraising, Acquisition Deals, Fund Managers, Funding Round Investors, Funding Rounds, Funds. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Sector Fundraising](/api-reference/data-api/fundraising/sector-fundraising) | Fundraising-dataset | | [Batch](/api-reference/data-api/fundraising/timeseries-sector-fundraising), [One series](/api-reference/data-api/fundraising/timeseries-sector-fundraising-by-id) | | [Acquisition Deals](/api-reference/data-api/fundraising/acquisition-deals) | Fundraising-dataset | [List rows](/api-reference/data-api/fundraising/tabular-acquisition-deals), [One row](/api-reference/data-api/fundraising/tabular-acquisition-deals-by-id) | | | [Fund Managers](/api-reference/data-api/fundraising/fund-managers) | Fundraising-dataset | [List rows](/api-reference/data-api/fundraising/tabular-fund-managers), [One row](/api-reference/data-api/fundraising/tabular-fund-managers-by-id) | | | [Funding Round Investors](/api-reference/data-api/fundraising/funding-round-investors) | Fundraising-dataset | [List rows](/api-reference/data-api/fundraising/tabular-funding-round-investors), [One row](/api-reference/data-api/fundraising/tabular-funding-round-investors-by-id) | | | [Funding Rounds](/api-reference/data-api/fundraising/funding-rounds) | Fundraising-dataset | [List rows](/api-reference/data-api/fundraising/tabular-funding-rounds), [One row](/api-reference/data-api/fundraising/tabular-funding-rounds-by-id) | | | [Funds](/api-reference/data-api/fundraising/funds) | Fundraising-dataset | [List rows](/api-reference/data-api/fundraising/tabular-funds), [One row](/api-reference/data-api/fundraising/tabular-funds-by-id) | | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/acquisition-deals?pageSize=3&selections=acquisitionDealID,announcementDate,fundingDate,transactionAmountUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Acquisition Deals](/api-reference/data-api/fundraising/tabular-acquisition-deals) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Sector Fundraising Source: https://docs.blockworks.com/api-reference/data-api/fundraising/sector-fundraising Amount raised in USD and number of funding rounds announced per period, by sector. Each series is one sector, keyed by its name. A day without announced rounds has no point. | | | | - | - | | Access | Fundraising-dataset | | Timeseries model | `sector-fundraising`: intervals `1d`, `1n`, series key `sector` (Sectors), every series available in one call | ## Endpoints > [card] [Batch Get Sector timeseries](/api-reference/data-api/fundraising/timeseries-sector-fundraising) > > Every series in one request, or the named ones. > [card] [Get Sector timeseries](/api-reference/data-api/fundraising/timeseries-sector-fundraising-by-id) > > One series over a time window, keyed by its Sectors. ## Metrics 2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `raised-amount-usd` | Raised Amount (USD) | float64 | usd | Total amount raised in USD for all fundraising events in this sector on this day. | | `funding-round-count` | Funding Round Count | int32 | | Number of fundraising rounds in this sector on this day. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/sector-fundraising/1d/AI?timeframe=7d&selections=raised-amount-usd,funding-round-count" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Sector timeseries](/api-reference/data-api/fundraising/timeseries-sector-fundraising-by-id) for the response and the errors. # List Acquisition Deals Source: https://docs.blockworks.com/api-reference/data-api/fundraising/tabular-acquisition-deals api-reference/data-api/openapi.json GET /query/tabular/acquisition-deals One row per merger or acquisition in the crypto industry, keyed by acquisitionDealID: announcement and funding dates, transaction amount when disclosed, status, and the acquiring and acquired entities with their sectors, logos and announcement URLs. Filter by date, amount, status or entity; sorted by announcement date. # Get Acquisition Deal Source: https://docs.blockworks.com/api-reference/data-api/fundraising/tabular-acquisition-deals-by-id api-reference/data-api/openapi.json GET /query/tabular/acquisition-deals/{acquisitionDealID} One row per merger or acquisition in the crypto industry, keyed by acquisitionDealID: announcement and funding dates, transaction amount when disclosed, status, and the acquiring and acquired entities with their sectors, logos and announcement URLs. Filter by date, amount, status or entity; sorted by announcement date. # List Fund Managers Source: https://docs.blockworks.com/api-reference/data-api/fundraising/tabular-fund-managers api-reference/data-api/openapi.json GET /query/tabular/fund-managers One row per fund and manager pair, keyed by fundManagerID: the fund with its announcement date and size, and the manager with its type, logo and investor id. Lists every fund a manager has raised or the firms behind a fund. # Get Fund Manager Source: https://docs.blockworks.com/api-reference/data-api/fundraising/tabular-fund-managers-by-id api-reference/data-api/openapi.json GET /query/tabular/fund-managers/{fundManagerID} One row per fund and manager pair, keyed by fundManagerID: the fund with its announcement date and size, and the manager with its type, logo and investor id. Lists every fund a manager has raised or the firms behind a fund. # List Funding Round Investors Source: https://docs.blockworks.com/api-reference/data-api/fundraising/tabular-funding-round-investors api-reference/data-api/openapi.json GET /query/tabular/funding-round-investors One row per investor participation in a funding round, keyed by fundingRoundInvestorID: the investor with its type and lead flag, the round with its date, type, stage and amount, and the funded entity with its sector. Lists everything one investor backed or every investor in one round. # Get Funding Round Investor Source: https://docs.blockworks.com/api-reference/data-api/fundraising/tabular-funding-round-investors-by-id api-reference/data-api/openapi.json GET /query/tabular/funding-round-investors/{fundingRoundInvestorID} One row per investor participation in a funding round, keyed by fundingRoundInvestorID: the investor with its type and lead flag, the round with its date, type, stage and amount, and the funded entity with its sector. Lists everything one investor backed or every investor in one round. # List Funding Rounds Source: https://docs.blockworks.com/api-reference/data-api/fundraising/tabular-funding-rounds api-reference/data-api/openapi.json GET /query/tabular/funding-rounds One row per funding round raised by a crypto project or company, keyed by fundingRoundID: announcement date, type, stage, amount and valuation when disclosed, the funded entity with its sector and location, ecosystem networks, and the investors as arrays with lead investors marked. Filter by date, amount, type, stage, sector, country, entity or investor. # Get Funding Round Source: https://docs.blockworks.com/api-reference/data-api/fundraising/tabular-funding-rounds-by-id api-reference/data-api/openapi.json GET /query/tabular/funding-rounds/{fundingRoundID} One row per funding round raised by a crypto project or company, keyed by fundingRoundID: announcement date, type, stage, amount and valuation when disclosed, the funded entity with its sector and location, ecosystem networks, and the investors as arrays with lead investors marked. Filter by date, amount, type, stage, sector, country, entity or investor. # List Funds Source: https://docs.blockworks.com/api-reference/data-api/fundraising/tabular-funds api-reference/data-api/openapi.json GET /query/tabular/funds One row per venture fund raised to invest in crypto, keyed by fundID: name, announcement and funding dates, size when disclosed, managers, limited partners and announcement URLs. Tracks fund formation and the funds a manager runs. # Get Fund Source: https://docs.blockworks.com/api-reference/data-api/fundraising/tabular-funds-by-id api-reference/data-api/openapi.json GET /query/tabular/funds/{fundID} One row per venture fund raised to invest in crypto, keyed by fundID: name, announcement and funding dates, size when disclosed, managers, limited partners and announcement URLs. Tracks fund formation and the funds a manager runs. # Batch Get Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/fundraising/timeseries-sector-fundraising api-reference/data-api/openapi.json GET /query/timeseries/sector-fundraising/{granularity} Amount raised in USD and number of funding rounds announced per period, by sector. Each series is one sector, keyed by its name. A day without announced rounds has no point. # Get Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/fundraising/timeseries-sector-fundraising-by-id api-reference/data-api/openapi.json GET /query/timeseries/sector-fundraising/{granularity}/{sector} Amount raised in USD and number of funding rounds announced per period, by sector. Each series is one sector, keyed by its name. A day without announced rounds has no point. # Institutional Source: https://docs.blockworks.com/api-reference/data-api/institutional Regulated wrappers and listed companies that hold crypto: exchange-traded products by asset and issuer, and digital asset treasury companies with their holdings. > [card] [Digital Asset Treasury Companies](/api-reference/data-api/digital-asset-treasury-companies/overview) > > Digital Asset Treasury Companies: DAT Companies, DAT Companies by Asset. 2 models. > [card] [ETFs](/api-reference/data-api/etfs/overview) > > Crypto exchange-traded product metrics per underlying asset and per issuer: assets under management, net flows, product counts, expense ratios and traded volume. 2 models. # Institutional Allocator Balances Source: https://docs.blockworks.com/api-reference/data-api/institutional-allocators/institutional-allocator-balances Positions held by institutional allocators, capital deployed to venues and capital left idle, in USD, with gross and net flows. Each series is one position token, keyed by protocol, chain, allocator, balance type, position and token. Many series, so name the positions you need. One row per institutional allocator balance, keyed by protocol, chain, allocator, balance type, position and token: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the institutional-allocator-balances timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `institutional-allocator-balances`: primary key `id` | | Timeseries model | `institutional-allocator-balances`: intervals `1d`, series key `id` (Institutional Allocator Balance ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Institutional Allocator Balances](/api-reference/data-api/institutional-allocators/tabular-institutional-allocator-balances) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Institutional Allocator Balance timeseries](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-balances) > > Up to 10 series in one request, named by Institutional Allocator Balance ID in `series`. > [card] [Get Institutional Allocator Balance timeseries](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-balances-by-id) > > One series over a time window, keyed by its Institutional Allocator Balance ID. ## Metrics 4 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `balanceUSD` | Balance (USD) | float64 | | Balance in USD. | | `grossInflowUSD` | Gross Inflow (USD) | float64 | | Gross inflow to the balance in USD. | | `grossOutflowUSD` | Gross Outflow (USD) | float64 | | Gross outflow from the balance in USD, stored as a negative number. | | `netFlowUSD` | Net Flow (USD) | float64 | | Net flow (inflow plus outflow) in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the institutional-allocator-balances timeseries model, the parent slug, chain, allocator id, balance type, position id and token address, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the allocator name, position name, token symbol and balance type. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol. | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain (ethereum, base, solana). | | `allocatorID` | string | `Eq`, `IsOneOf` | | The institutional allocator's identifier. | | `balanceType` | string | `Eq`, `IsOneOf` | | The balance type as classified by Blockworks Research. | | `positionID` | string | `Eq`, `IsOneOf` | | The identifier of the allocator's position or funding line. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `allocatorName` | string | `Eq`, `IsOneOf`, `Contains` | | The institutional allocator's display name. | | `positionName` | string | `Eq`, `IsOneOf`, `Contains` | | The display name of the allocator's position. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/institutional-allocator-balances/1d/?timeframe=7d&selections=balanceUSD,grossInflowUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Institutional Allocator Balance timeseries](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-balances-by-id) for the response and the errors. # Institutional Allocator Financials Source: https://docs.blockworks.com/api-reference/data-api/institutional-allocators/institutional-allocator-financials Gross yield and incentives earned on each position an institutional allocator deploys to, and the funding cost paid on each funding line, in USD. Each series is one position or funding line token, keyed by protocol, chain, allocator, balance type, position, token and recognition basis (realized or accrued). One row per institutional allocator financial, keyed by protocol, chain, allocator, balance type, position, token and recognition basis: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the institutional-allocator-financials timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `institutional-allocator-financials`: primary key `id` | | Timeseries model | `institutional-allocator-financials`: intervals `1d`, series key `id` (Institutional Allocator Financial ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Institutional Allocator Financials](/api-reference/data-api/institutional-allocators/tabular-institutional-allocator-financials) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Institutional Allocator Financial timeseries](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-financials) > > Up to 10 series in one request, named by Institutional Allocator Financial ID in `series`. > [card] [Get Institutional Allocator Financial timeseries](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-financials-by-id) > > One series over a time window, keyed by its Institutional Allocator Financial ID. ## Metrics 3 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `grossYieldUSD` | Gross Yield (USD) | float64 | | Gross yield earned in USD. | | `incentivesUSD` | Incentives (USD) | float64 | | Incentives earned in USD. | | `fundingCostUSD` | Funding Cost (USD) | float64 | | Funding cost paid in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the institutional-allocator-financials timeseries model, the parent slug, chain, allocator id, balance type, position id, token address and recognition basis, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the allocator name, position id, token symbol and balance type. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol. | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain (ethereum, base, solana). | | `allocatorID` | string | `Eq`, `IsOneOf` | | The institutional allocator's identifier. | | `balanceType` | string | `Eq`, `IsOneOf` | | The balance type as classified by Blockworks Research. | | `positionID` | string | `Eq`, `IsOneOf` | | The identifier of the allocator's position or funding line. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `recognitionBasis` | string | `Eq`, `IsOneOf` | | How the amount is recognized, for example realized or accrued. | | `allocatorName` | string | `Eq`, `IsOneOf`, `Contains` | | The institutional allocator's display name. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/institutional-allocator-financials/1d/?timeframe=7d&selections=grossYieldUSD,incentivesUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Institutional Allocator Financial timeseries](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-financials-by-id) for the response and the errors. # Institutional Allocator Performances Source: https://docs.blockworks.com/api-reference/data-api/institutional-allocators/institutional-allocator-performances Balance-weighted supply rates on each position an institutional allocator deploys to, and borrow rates on each funding line it draws on, as APR and APY, with the balances used as weights. Each series is one position or funding line token, keyed by protocol, chain, allocator, balance type, position and token. One row per institutional allocator performance, keyed by protocol, chain, allocator, balance type, position and token: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the institutional-allocator-performances timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `institutional-allocator-performances`: primary key `id` | | Timeseries model | `institutional-allocator-performances`: intervals `1d`, series key `id` (Institutional Allocator Performance ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Institutional Allocator Performances](/api-reference/data-api/institutional-allocators/tabular-institutional-allocator-performances) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Institutional Allocator Performance timeseries](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-performances) > > Up to 10 series in one request, named by Institutional Allocator Performance ID in `series`. > [card] [Get Institutional Allocator Performance timeseries](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-performances-by-id) > > One series over a time window, keyed by its Institutional Allocator Performance ID. ## Metrics 6 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `weightedSupplyAPR` | Weighted Supply APR | float64 | | Balance-weighted supply APR, as a decimal. | | `weightedSupplyAPY` | Weighted Supply APY | float64 | | Balance-weighted supply APY, as a decimal. | | `weightedSupplyBalance` | Weighted Supply Balance | float64 | | Supply balance used as the rate weight, in native token units. | | `weightedBorrowAPR` | Weighted Borrow APR | float64 | | Balance-weighted borrow APR, as a decimal. | | `weightedBorrowAPY` | Weighted Borrow APY | float64 | | Balance-weighted borrow APY, as a decimal. | | `weightedBorrowBalance` | Weighted Borrow Balance | float64 | | Borrow balance used as the rate weight, in native token units. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the institutional-allocator-performances timeseries model, the parent slug, chain, allocator id, balance type, position id and token address, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the allocator name, position id, token symbol and balance type. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol. | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain (ethereum, base, solana). | | `allocatorID` | string | `Eq`, `IsOneOf` | | The institutional allocator's identifier. | | `balanceType` | string | `Eq`, `IsOneOf` | | The balance type as classified by Blockworks Research. | | `positionID` | string | `Eq`, `IsOneOf` | | The identifier of the allocator's position or funding line. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `allocatorName` | string | `Eq`, `IsOneOf`, `Contains` | | The institutional allocator's display name. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/institutional-allocator-performances/1d/?timeframe=7d&selections=weightedSupplyAPR,weightedSupplyAPY" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Institutional Allocator Performance timeseries](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-performances-by-id) for the response and the errors. # Institutional Allocators Source: https://docs.blockworks.com/api-reference/data-api/institutional-allocators/overview Institutional Allocators: Institutional Allocator Balances, Institutional Allocator Financials, Institutional Allocator Performances. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Institutional Allocator Balances](/api-reference/data-api/institutional-allocators/institutional-allocator-balances) | Lending-protocols-dataset | [List rows](/api-reference/data-api/institutional-allocators/tabular-institutional-allocator-balances) | [Batch](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-balances), [One series](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-balances-by-id) | | [Institutional Allocator Financials](/api-reference/data-api/institutional-allocators/institutional-allocator-financials) | Lending-protocols-dataset | [List rows](/api-reference/data-api/institutional-allocators/tabular-institutional-allocator-financials) | [Batch](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-financials), [One series](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-financials-by-id) | | [Institutional Allocator Performances](/api-reference/data-api/institutional-allocators/institutional-allocator-performances) | Lending-protocols-dataset | [List rows](/api-reference/data-api/institutional-allocators/tabular-institutional-allocator-performances) | [Batch](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-performances), [One series](/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-performances-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/institutional-allocator-balances?pageSize=3&selections=id,name,slug,parentSlug" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Institutional Allocator Balances](/api-reference/data-api/institutional-allocators/tabular-institutional-allocator-balances) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Institutional Allocator Balances Source: https://docs.blockworks.com/api-reference/data-api/institutional-allocators/tabular-institutional-allocator-balances api-reference/data-api/openapi.json GET /query/tabular/institutional-allocator-balances One row per institutional allocator balance, keyed by protocol, chain, allocator, balance type, position and token: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the institutional-allocator-balances timeseries model. # List Institutional Allocator Financials Source: https://docs.blockworks.com/api-reference/data-api/institutional-allocators/tabular-institutional-allocator-financials api-reference/data-api/openapi.json GET /query/tabular/institutional-allocator-financials One row per institutional allocator financial, keyed by protocol, chain, allocator, balance type, position, token and recognition basis: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the institutional-allocator-financials timeseries model. # List Institutional Allocator Performances Source: https://docs.blockworks.com/api-reference/data-api/institutional-allocators/tabular-institutional-allocator-performances api-reference/data-api/openapi.json GET /query/tabular/institutional-allocator-performances One row per institutional allocator performance, keyed by protocol, chain, allocator, balance type, position and token: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the institutional-allocator-performances timeseries model. # Batch Get Institutional Allocator Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-balances api-reference/data-api/openapi.json GET /query/timeseries/institutional-allocator-balances/{granularity} Positions held by institutional allocators, capital deployed to venues and capital left idle, in USD, with gross and net flows. Each series is one position token, keyed by protocol, chain, allocator, balance type, position and token. Many series, so name the positions you need. # Get Institutional Allocator Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-balances-by-id api-reference/data-api/openapi.json GET /query/timeseries/institutional-allocator-balances/{granularity}/{id} Positions held by institutional allocators, capital deployed to venues and capital left idle, in USD, with gross and net flows. Each series is one position token, keyed by protocol, chain, allocator, balance type, position and token. Many series, so name the positions you need. # Batch Get Institutional Allocator Financial timeseries Source: https://docs.blockworks.com/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-financials api-reference/data-api/openapi.json GET /query/timeseries/institutional-allocator-financials/{granularity} Gross yield and incentives earned on each position an institutional allocator deploys to, and the funding cost paid on each funding line, in USD. Each series is one position or funding line token, keyed by protocol, chain, allocator, balance type, position, token and recognition basis (realized or accrued). # Get Institutional Allocator Financial timeseries Source: https://docs.blockworks.com/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-financials-by-id api-reference/data-api/openapi.json GET /query/timeseries/institutional-allocator-financials/{granularity}/{id} Gross yield and incentives earned on each position an institutional allocator deploys to, and the funding cost paid on each funding line, in USD. Each series is one position or funding line token, keyed by protocol, chain, allocator, balance type, position, token and recognition basis (realized or accrued). # Batch Get Institutional Allocator Performance timeseries Source: https://docs.blockworks.com/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-performances api-reference/data-api/openapi.json GET /query/timeseries/institutional-allocator-performances/{granularity} Balance-weighted supply rates on each position an institutional allocator deploys to, and borrow rates on each funding line it draws on, as APR and APY, with the balances used as weights. Each series is one position or funding line token, keyed by protocol, chain, allocator, balance type, position and token. # Get Institutional Allocator Performance timeseries Source: https://docs.blockworks.com/api-reference/data-api/institutional-allocators/timeseries-institutional-allocator-performances-by-id api-reference/data-api/openapi.json GET /query/timeseries/institutional-allocator-performances/{granularity}/{id} Balance-weighted supply rates on each position an institutional allocator deploys to, and borrow rates on each funding line it draws on, as APR and APY, with the balances used as weights. Each series is one position or funding line token, keyed by protocol, chain, allocator, balance type, position and token. # Launchpads Source: https://docs.blockworks.com/api-reference/data-api/launchpads/launchpads Metrics for a token launchpad across all chains: tokens launched, volume and trades of its tokens, bonding-curve activity, creator fees, revenue and the market cap of its launched tokens. Each series is one launchpad, keyed by its id. One row per token launchpad, keyed by its short name: name, protocol slug and protocol id. The id is the series key of the launchpads timeseries model. | | | | - | - | | Access | Launchpads-dataset | | Tabular model | `launchpads`: primary key `id`, identifiers `slug` | | Timeseries model | `launchpads`: intervals `1d`, series key `id` (Launchpad ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Launchpads](/api-reference/data-api/launchpads/tabular-launchpads) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Launchpad timeseries](/api-reference/data-api/launchpads/timeseries-launchpads) > > Up to 10 series in one request, named by Launchpad ID in `series`. > [card] [Get Launchpad timeseries](/api-reference/data-api/launchpads/timeseries-launchpads-by-id) > > One series over a time window, keyed by its Launchpad ID. ## Metrics 12 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `tokensLaunched` | Tokens Launched | float64 | | Tokens launched on the launchpad. | | `volumeUSD` | Volume (USD) | float64 | | Total trading volume of launched tokens in USD. | | `tradeCount` | Trade Count | float64 | | Total trade count of launched tokens. | | `bondingCurveVolumeUSD` | Bonding Curve Volume (USD) | float64 | | Trading volume on the bonding curve in USD. | | `bondingCurveTradeCount` | Bonding Curve Trade Count | float64 | | Trade count on the bonding curve. | | `creatorFeesUSD` | Creator Fees (USD) | float64 | | Fees paid out to token creators in USD. | | `revenueUSD` | Revenue (USD) | float64 | | Launchpad revenue in USD. | | `marketcapUSD` | Marketcap (USD) | float64 | | Combined marketcap of tokens launched on the launchpad in USD. | | `tokensAbove1mMarketcap` | Tokens Above \$1M Marketcap | float64 | | Launched tokens with marketcap above \$1M. | | `tokensAbove10mMarketcap` | Tokens Above \$10M Marketcap | float64 | | Launched tokens with marketcap above \$10M. | | `largestTokenMarketcapUSD` | Largest Token Marketcap (USD) | float64 | | Marketcap of the largest launched token in USD. | | `largestTokenMarketcapShare` | Largest Token Marketcap Share | float64 | | Largest token's share of the combined launched-token marketcap (0-1). | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the launchpads timeseries model, the launchpad's short name (pumpfun). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the launchpad. | | `slug` | string | `Eq`, `IsOneOf` | yes | The launchpad's protocol slug, the slug used for the same launchpad across the API. (identifier 1) | | `protocolID` | string | `Eq`, `IsOneOf` | | The identifier of the launchpad's protocol record. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/launchpads/1d/americafun?timeframe=7d&selections=tokensLaunched,volumeUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Launchpad timeseries](/api-reference/data-api/launchpads/timeseries-launchpads-by-id) for the response and the errors. # Launchpads by Chain Source: https://docs.blockworks.com/api-reference/data-api/launchpads/launchpads-by-chain Token launchpad metrics summed across all launchpads on a blockchain: tokens launched, volume and trades of launched tokens, bonding-curve activity, creator fees, revenue and launched-token market cap. Each series is one chain, keyed by its chain slug. One row per blockchain with token launchpad activity, keyed by the short chain name: name, the chain's slug and its network id. The id is the series key of the launchpads-by-chain timeseries model. | | | | - | - | | Access | Launchpads-dataset | | Tabular model | `launchpad-chains`: primary key `id`, identifiers `slug` | | Timeseries model | `launchpads-by-chain`: intervals `1d`, series key `id` (Chain ID), every series available in one call | ## Endpoints > [card] [List Launchpad Chains](/api-reference/data-api/launchpads/tabular-launchpad-chains) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Chain timeseries](/api-reference/data-api/launchpads/timeseries-launchpads-by-chain) > > Every series in one request, or the named ones. > [card] [Get Chain timeseries](/api-reference/data-api/launchpads/timeseries-launchpads-by-chain-by-id) > > One series over a time window, keyed by its Chain ID. ## Metrics 12 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `tokensLaunched` | Tokens Launched | float64 | | Tokens launched on the chain's launchpads. | | `volumeUSD` | Volume (USD) | float64 | | Total trading volume of launched tokens in USD. | | `tradeCount` | Trade Count | float64 | | Total trade count of launched tokens. | | `bondingCurveVolumeUSD` | Bonding Curve Volume (USD) | float64 | | Trading volume on the bonding curve in USD. | | `bondingCurveTradeCount` | Bonding Curve Trade Count | float64 | | Trade count on the bonding curve. | | `creatorFeesUSD` | Creator Fees (USD) | float64 | | Fees paid out to token creators in USD. | | `revenueUSD` | Revenue (USD) | float64 | | Launchpad revenue in USD. | | `marketcapUSD` | Marketcap (USD) | float64 | | Combined marketcap of launched tokens in USD. | | `tokensAbove1mMarketcap` | Tokens Above \$1M Marketcap | float64 | | Launched tokens with marketcap above \$1M. | | `tokensAbove10mMarketcap` | Tokens Above \$10M Marketcap | float64 | | Launched tokens with marketcap above \$10M. | | `largestTokenMarketcapUSD` | Largest Token Marketcap (USD) | float64 | | Marketcap of the largest launched token in USD. | | `largestTokenMarketcapShare` | Largest Token Marketcap Share | float64 | | Largest token's share of the combined launched-token marketcap (0-1). | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the launchpads-by-chain timeseries model, the short chain name (bnb). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the chain. | | `slug` | string | `Eq`, `IsOneOf` | yes | The chain's slug in the blockchains model (binance-smart-chain). (identifier 1) | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/launchpads-by-chain/1d/bnb?timeframe=7d&selections=tokensLaunched,volumeUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Chain timeseries](/api-reference/data-api/launchpads/timeseries-launchpads-by-chain-by-id) for the response and the errors. # Launchpads Source: https://docs.blockworks.com/api-reference/data-api/launchpads/overview Token launchpad metrics per launchpad and per chain: tokens launched, volume and trades of launched tokens, bonding-curve activity, creator fees and revenue. Each series has its own lookup table. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Launchpads](/api-reference/data-api/launchpads/launchpads) | Launchpads-dataset | [List rows](/api-reference/data-api/launchpads/tabular-launchpads) | [Batch](/api-reference/data-api/launchpads/timeseries-launchpads), [One series](/api-reference/data-api/launchpads/timeseries-launchpads-by-id) | | [Launchpads by Chain](/api-reference/data-api/launchpads/launchpads-by-chain) | Launchpads-dataset | [List rows](/api-reference/data-api/launchpads/tabular-launchpad-chains) | [Batch](/api-reference/data-api/launchpads/timeseries-launchpads-by-chain), [One series](/api-reference/data-api/launchpads/timeseries-launchpads-by-chain-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/launchpads?pageSize=3&selections=id,slug,name,protocolID" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Launchpads](/api-reference/data-api/launchpads/tabular-launchpads) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Launchpad Chains Source: https://docs.blockworks.com/api-reference/data-api/launchpads/tabular-launchpad-chains api-reference/data-api/openapi.json GET /query/tabular/launchpad-chains One row per blockchain with token launchpad activity, keyed by the short chain name: name, the chain's slug and its network id. The id is the series key of the launchpads-by-chain timeseries model. # List Launchpads Source: https://docs.blockworks.com/api-reference/data-api/launchpads/tabular-launchpads api-reference/data-api/openapi.json GET /query/tabular/launchpads One row per token launchpad, keyed by its short name: name, protocol slug and protocol id. The id is the series key of the launchpads timeseries model. # Batch Get Launchpad timeseries Source: https://docs.blockworks.com/api-reference/data-api/launchpads/timeseries-launchpads api-reference/data-api/openapi.json GET /query/timeseries/launchpads/{granularity} Metrics for a token launchpad across all chains: tokens launched, volume and trades of its tokens, bonding-curve activity, creator fees, revenue and the market cap of its launched tokens. Each series is one launchpad, keyed by its id. # Batch Get Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/launchpads/timeseries-launchpads-by-chain api-reference/data-api/openapi.json GET /query/timeseries/launchpads-by-chain/{granularity} Token launchpad metrics summed across all launchpads on a blockchain: tokens launched, volume and trades of launched tokens, bonding-curve activity, creator fees, revenue and launched-token market cap. Each series is one chain, keyed by its chain slug. # Get Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/launchpads/timeseries-launchpads-by-chain-by-id api-reference/data-api/openapi.json GET /query/timeseries/launchpads-by-chain/{granularity}/{id} Token launchpad metrics summed across all launchpads on a blockchain: tokens launched, volume and trades of launched tokens, bonding-curve activity, creator fees, revenue and launched-token market cap. Each series is one chain, keyed by its chain slug. # Get Launchpad timeseries Source: https://docs.blockworks.com/api-reference/data-api/launchpads/timeseries-launchpads-by-id api-reference/data-api/openapi.json GET /query/timeseries/launchpads/{granularity}/{id} Metrics for a token launchpad across all chains: tokens launched, volume and trades of its tokens, bonding-curve activity, creator fees, revenue and the market cap of its launched tokens. Each series is one launchpad, keyed by its id. # Lending Market Balances Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/lending-market-balances Balance in USD for one token in one lending market, split by balance type (deposit or borrow) and subtype (supply, collateral, variable or fixed borrow). Each series is one market token balance, keyed by protocol, product, chain, market, token, balance type and balance subtype. Finer than lending-protocols-by-product-market, with many series per market, so name the balances you need. One row per lending market balance, the finest grain of the lending data, keyed by protocol, product, chain, market, token, balance type and balance subtype: the market and token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the lending-market-balances timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `lending-market-balances`: primary key `id` | | Timeseries model | `lending-market-balances`: intervals `1d`, series key `id` (Lending Market Balance ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Lending Market Balances](/api-reference/data-api/lending-protocols/tabular-lending-market-balances) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Lending Market Balance timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-balances) > > Up to 10 series in one request, named by Lending Market Balance ID in `series`. > [card] [Get Lending Market Balance timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-balances-by-id) > > One series over a time window, keyed by its Lending Market Balance ID. ## Metrics 1 metric. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `balanceUSD` | Balance (USD) | float64 | | The balance in USD of the token for this market, balance type and subtype. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the lending-market-balances timeseries model, the parent slug, product slug, chain, market key, token key, balance type and balance subtype, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the balance, the market name, token symbol and balance subtype (or type). | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name, the id in lending-protocols (aave). | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol (aave-v3). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the market lives on (ethereum, bnb, solana). | | `marketID` | string | `Eq`, `IsOneOf` | | The market or pool address; null when the protocol does not label markets. | | `marketName` | string | `Eq`, `IsOneOf`, `Contains` | | The market display name. | | `marketType` | string | `Eq`, `IsOneOf` | | The market type where the protocol distinguishes one (for example core, pooled or credit_vault); null otherwise. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `balanceType` | string | `Eq`, `IsOneOf` | | Whether the balance is a deposit or a borrow. | | `balanceSubtype` | string | `Eq`, `IsOneOf` | | The finer balance classification (for example supply, collateral, variable_borrow or fixed_borrow); null for protocols that do not distinguish one. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/lending-market-balances/1d/?timeframe=7d&selections=balanceUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Lending Market Balance timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-balances-by-id) for the response and the errors. # Lending Market Financials Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/lending-market-financials Daily interest, net interest income, fees and revenue in USD for one token in one lending market. Each series is one market token, keyed by protocol, product, chain, market and token. Fee components a protocol does not report are null. Many series per market, so name the series you need. One row per token in a lending market, keyed by protocol, product, chain, market and token: the market and token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the lending-market-financials timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `lending-market-financials`: primary key `id` | | Timeseries model | `lending-market-financials`: intervals `1d`, series key `id` (Lending Market Financial ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Lending Market Tokens](/api-reference/data-api/lending-protocols/tabular-lending-market-financials) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Lending Market Financial timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-financials) > > Up to 10 series in one request, named by Lending Market Financial ID in `series`. > [card] [Get Lending Market Financial timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-financials-by-id) > > One series over a time window, keyed by its Lending Market Financial ID. ## Metrics 7 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `interestUSD` | Interest (USD) | float64 | | Interest paid by borrowers in USD. | | `netInterestIncomeUSD` | Net Interest Income (USD) | float64 | | Net interest income in USD, the interest kept by the protocol. | | `flashLoanFeesUSD` | Flash Loan Fees (USD) | float64 | | Flash loan fees in USD; null where the protocol does not report them. | | `liquidationFeesUSD` | Liquidation Fees (USD) | float64 | | Liquidation fees in USD; null where the protocol does not report them. | | `royaltiesUSD` | Royalties (USD) | float64 | | Royalty fees in USD; null where the protocol does not report them. | | `feesUSD` | Fees (USD) | float64 | | Total fees in USD, interest plus flash loan, liquidation and royalty fees. | | `revenueUSD` | Revenue (USD) | float64 | | Revenue in USD, net interest income plus flash loan, liquidation and royalty fees. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the lending-market-financials timeseries model, the parent slug, product slug, chain, market key and token key, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the market name and token symbol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name, the id in lending-protocols (aave). | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol (aave-v3). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the market lives on (ethereum, bnb, solana). | | `marketID` | string | `Eq`, `IsOneOf` | | The market or pool address; null when the protocol does not label markets. | | `marketName` | string | `Eq`, `IsOneOf`, `Contains` | | The market display name. | | `marketType` | string | `Eq`, `IsOneOf` | | The market type where the protocol distinguishes one (for example core, pooled or credit_vault); null otherwise. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/lending-market-financials/1d/?timeframe=7d&selections=interestUSD,netInterestIncomeUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Lending Market Financial timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-financials-by-id) for the response and the errors. # Lending Market Flows Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/lending-market-flows Daily net, gross inflow and gross outflow in USD for one token in one lending market, split by balance type (deposit or borrow) and subtype. Each series is keyed like lending-market-balances, by protocol, product, chain, market, token, balance type and balance subtype. Many series per market, so name the series you need. One row per lending market flow, keyed by protocol, product, chain, market, token, balance type and balance subtype: the market and token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the lending-market-flows timeseries model, and the same key as lending-market-balances. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `lending-market-flows`: primary key `id` | | Timeseries model | `lending-market-flows`: intervals `1d`, series key `id` (Lending Market Flow ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Lending Market Flows](/api-reference/data-api/lending-protocols/tabular-lending-market-flows) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Lending Market Flow timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-flows) > > Up to 10 series in one request, named by Lending Market Flow ID in `series`. > [card] [Get Lending Market Flow timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-flows-by-id) > > One series over a time window, keyed by its Lending Market Flow ID. ## Metrics 3 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `netFlowUSD` | Net Flow (USD) | float64 | | Net flow in USD, gross inflow plus gross outflow. | | `grossInflowUSD` | Gross Inflow (USD) | float64 | | Gross inflow in USD. | | `grossOutflowUSD` | Gross Outflow (USD) | float64 | | Gross outflow in USD (negative). | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the lending-market-flows timeseries model, the parent slug, product slug, chain, market key, token key, balance type and balance subtype, joined with underscores; identical to the lending-market-balances id. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the flow, the market name, token symbol and balance subtype (or type). | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name, the id in lending-protocols (aave). | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol (aave-v3). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the market lives on (ethereum, bnb, solana). | | `marketID` | string | `Eq`, `IsOneOf` | | The market or pool address; null when the protocol does not label markets. | | `marketName` | string | `Eq`, `IsOneOf`, `Contains` | | The market display name. | | `marketType` | string | `Eq`, `IsOneOf` | | The market type where the protocol distinguishes one (for example core, pooled or credit_vault); null otherwise. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `balanceType` | string | `Eq`, `IsOneOf` | | Whether the flow is into deposits or borrows. | | `balanceSubtype` | string | `Eq`, `IsOneOf` | | The finer balance classification (for example supply, collateral, variable_borrow or fixed_borrow); null for protocols that do not distinguish one. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/lending-market-flows/1d/?timeframe=7d&selections=netFlowUSD,grossInflowUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Lending Market Flow timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-flows-by-id) for the response and the errors. # Lending Market Interest Rates Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/lending-market-interest-rates Daily supply and borrow rates for one token in one lending market, as decimals (0.05 is 5%), weighted by the supply and borrow balances they apply to, with those weights in USD. Each series is one market token, keyed by protocol, product, chain, market and token. Many series per market, so name the series you need. One row per token in a lending market with interest rates, keyed by protocol, product, chain, market and token: the market and token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the lending-market-interest-rates timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `lending-market-interest-rates`: primary key `id` | | Timeseries model | `lending-market-interest-rates`: intervals `1d`, series key `id` (Lending Market Interest Rate ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Lending Market Interest Rates](/api-reference/data-api/lending-protocols/tabular-lending-market-interest-rates) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Lending Market Interest Rate timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-interest-rates) > > Up to 10 series in one request, named by Lending Market Interest Rate ID in `series`. > [card] [Get Lending Market Interest Rate timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-interest-rates-by-id) > > One series over a time window, keyed by its Lending Market Interest Rate ID. ## Metrics 8 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `borrowAPR` | Borrow APR | float64 | | Borrow-weighted borrow APR, as a decimal. | | `supplyAPR` | Supply APR | float64 | | Supply-weighted supply APR, as a decimal. | | `borrowAPY` | Borrow APY | float64 | | Borrow-weighted borrow APY, as a decimal. | | `supplyAPY` | Supply APY | float64 | | Supply-weighted supply APY, as a decimal. | | `borrowAPYStdDev` | Borrow APY Standard Deviation | float64 | | Weighted standard deviation of the borrow APY over the day. | | `supplyAPYStdDev` | Supply APY Standard Deviation | float64 | | Weighted standard deviation of the supply APY over the day. | | `borrowedUSD` | Borrowed (USD) | float64 | | Borrows in USD, the weight behind the borrow rates. | | `suppliedUSD` | Supplied (USD) | float64 | | Supply in USD, the weight behind the supply rates. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the lending-market-interest-rates timeseries model, the parent slug, product slug, chain, market key and token key, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the market name and token symbol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name, the id in lending-protocols (aave). | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol (aave-v3). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the market lives on (ethereum, bnb, solana). | | `marketID` | string | `Eq`, `IsOneOf` | | The market or pool address; null when the protocol does not label markets. | | `marketName` | string | `Eq`, `IsOneOf`, `Contains` | | The market display name. | | `marketType` | string | `Eq`, `IsOneOf` | | The market type where the protocol distinguishes one (for example core, pooled or credit_vault); null otherwise. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/lending-market-interest-rates/1d/?timeframe=7d&selections=borrowAPR,supplyAPR" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Lending Market Interest Rate timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-interest-rates-by-id) for the response and the errors. # Lending Market Liquidations Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/lending-market-liquidations Daily liquidations for one collateral and debt token pair in one lending market: collateral seized, debt repaid, losses and fees in USD and the liquidation count. Each series is one pair, keyed by protocol, product, chain, market, collateral token and debt token. Many series per market, so name the series you need. One row per collateral and debt token pair liquidated in a lending market, keyed by protocol, product, chain, market, collateral token and debt token: the market and both tokens, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the lending-market-liquidations timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `lending-market-liquidations`: primary key `id` | | Timeseries model | `lending-market-liquidations`: intervals `1d`, series key `id` (Lending Market Liquidation ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Lending Market Liquidation Pairs](/api-reference/data-api/lending-protocols/tabular-lending-market-liquidations) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Lending Market Liquidation timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-liquidations) > > Up to 10 series in one request, named by Lending Market Liquidation ID in `series`. > [card] [Get Lending Market Liquidation timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-liquidations-by-id) > > One series over a time window, keyed by its Lending Market Liquidation ID. ## Metrics 5 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `collateralSeizedUSD` | Collateral Seized (USD) | float64 | | Collateral seized from liquidated borrowers in USD. | | `debtSeizedUSD` | Debt Seized (USD) | float64 | | Debt repaid by liquidators in USD. | | `liquidationLossUSD` | Liquidation Loss (USD) | float64 | | Liquidation losses (bad debt) in USD. | | `liquidationFeesUSD` | Liquidation Fees (USD) | float64 | | Liquidation fees in USD. | | `liquidationCount` | Liquidation Count | float64 | | Number of liquidation events. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the lending-market-liquidations timeseries model, the parent slug, product slug, chain, market key, collateral token key and debt token key, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the market name and the collateral and debt token symbols. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name, the id in lending-protocols (aave). | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol (aave-v3). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the market lives on (ethereum, bnb, solana). | | `marketID` | string | `Eq`, `IsOneOf` | | The market or pool address; null when the protocol does not label markets. | | `marketName` | string | `Eq`, `IsOneOf`, `Contains` | | The market display name. | | `marketType` | string | `Eq`, `IsOneOf` | | The market type where the protocol distinguishes one (for example core, pooled or credit_vault); null otherwise. | | `collateralTokenAddress` | string | `Eq`, `IsOneOf` | | The seized collateral token's contract address (the mint address on Solana); null when unlabeled. | | `collateralTokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The seized collateral token's ticker symbol. | | `debtTokenAddress` | string | `Eq`, `IsOneOf` | | The repaid debt token's contract address (the mint address on Solana); null when unlabeled. | | `debtTokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The repaid debt token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/lending-market-liquidations/1d/?timeframe=7d&selections=collateralSeizedUSD,debtSeizedUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Lending Market Liquidation timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-market-liquidations-by-id) for the response and the errors. # Lending Protocols Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/lending-protocols Lending metrics for a protocol, summed across its products and chains: deposits, outstanding borrows, TVL, interest paid, net interest income, flash-loan, liquidation and royalty fees, and total fees and revenue, in USD. Each series is one protocol, keyed by its slug. One row per lending protocol, keyed by its short name: name, project slug and project id. The id is the series key of the lending-protocols timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `lending-protocols`: primary key `id`, identifiers `slug` | | Timeseries model | `lending-protocols`: intervals `1d`, series key `id` (Project ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Lending Protocols](/api-reference/data-api/lending-protocols/tabular-lending-protocols) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Lending Protocol timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-protocols) > > Up to 10 series in one request, named by Project ID in `series`. > [card] [Get Lending Protocol timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-id) > > One series over a time window, keyed by its Project ID. ## Metrics 10 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `deposits-usd` | Deposits (USD) | float64 | | Total deposits (supply and collateral) in USD across the protocol's lending markets. | | `borrowed-usd` | Borrowed (USD) | float64 | | Total outstanding borrows in USD across the protocol's lending markets. | | `tvl-usd` | TVL (USD) | float64 | | TVL in USD, deposits minus borrows. | | `interest-usd` | Interest (USD) | float64 | | Daily interest paid by borrowers in USD. | | `net-interest-income-usd` | Net Interest Income (USD) | float64 | | Daily net interest income in USD, the interest kept by the protocol. | | `flash-loan-fees-usd` | Flash Loan Fees (USD) | float64 | | Daily flash loan fees in USD. | | `liquidation-fees-usd` | Liquidation Fees (USD) | float64 | | Daily liquidation fees in USD. | | `royalties-usd` | Royalties (USD) | float64 | | Daily royalty fees in USD. | | `fees-usd` | Fees (USD) | float64 | | Daily total fees in USD, interest plus flash loan, liquidation and royalty fees. | | `revenue-usd` | Revenue (USD) | float64 | | Daily revenue in USD, net interest income plus flash loan, liquidation and royalty fees. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the lending-protocols timeseries model, the protocol's short name (aave). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the protocol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The protocol's project slug, the slug used for the same protocol across the API. (identifier 1) | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the protocol's project record. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/lending-protocols/1d/aave?timeframe=7d&selections=deposits-usd,borrowed-usd" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Lending Protocol timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-id) for the response and the errors. # Lending Protocols by Product Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/lending-protocols-by-product The lending-protocols metrics broken down by product (version) and blockchain: deposits, borrows, TVL, interest, fees and revenue in USD. Each series is one product on one chain, keyed by protocol, product and chain. One row per lending product deployment, one protocol version on one blockchain, keyed by protocol, product and chain: name, parent protocol, product, chain and the mapped protocol record. The id is the series key of the lending-protocols-by-product timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `lending-protocol-products`: primary key `id`, identifiers `slug` | | Timeseries model | `lending-protocols-by-product`: intervals `1d`, series key `id` (Protocol Product Chain ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Lending Protocol Products](/api-reference/data-api/lending-protocols/tabular-lending-protocol-products) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Lending Protocol Product timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product) > > Up to 10 series in one request, named by Protocol Product Chain ID in `series`. > [card] [Get Lending Protocol Product timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product-by-id) > > One series over a time window, keyed by its Protocol Product Chain ID. ## Metrics 10 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `deposits-usd` | Deposits (USD) | float64 | | Total deposits (supply and collateral) in USD across the product's markets. | | `borrowed-usd` | Borrowed (USD) | float64 | | Total outstanding borrows in USD across the product's markets. | | `tvl-usd` | TVL (USD) | float64 | | TVL in USD, deposits minus borrows. | | `interest-usd` | Interest (USD) | float64 | | Daily interest paid by borrowers in USD. | | `net-interest-income-usd` | Net Interest Income (USD) | float64 | | Daily net interest income in USD, the interest kept by the protocol. | | `flash-loan-fees-usd` | Flash Loan Fees (USD) | float64 | | Daily flash loan fees in USD. | | `liquidation-fees-usd` | Liquidation Fees (USD) | float64 | | Daily liquidation fees in USD. | | `royalties-usd` | Royalties (USD) | float64 | | Daily royalty fees in USD. | | `fees-usd` | Fees (USD) | float64 | | Daily total fees in USD, interest plus flash loan, liquidation and royalty fees. | | `revenue-usd` | Revenue (USD) | float64 | | Daily revenue in USD, net interest income plus flash loan, liquidation and royalty fees. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the lending-protocols-by-product timeseries model, the parent protocol, product and chain joined with underscores (aave_aave-v3_arbitrum). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the product, for example aave-v3 or the name of a single pool. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. (identifier 1) | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name, the id in lending-protocols (aave). | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol (aave-v3). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the product runs on (ethereum, arbitrum, solana). | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/lending-protocols-by-product/1d/aave_aave-v2_avalanche_c?timeframe=7d&selections=deposits-usd,borrowed-usd" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Lending Protocol Product timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product-by-id) for the response and the errors. # Lending Protocols by Product Market Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/lending-protocols-by-product-market Deposits, outstanding borrows and TVL in USD for one lending market within a protocol product on one chain. Each series is one market, keyed by protocol, product, chain and market key. The finest grain of the lending data, with thousands of series, so name the markets you need. One row per lending market, the finest grain of the lending data, keyed by protocol, product, chain and market key: market name and type, the parent protocol and product, chain and the mapped protocol record. The id is the series key of the lending-protocols-by-product-market timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `lending-protocol-product-markets`: primary key `id`, identifiers `slug` | | Timeseries model | `lending-protocols-by-product-market`: intervals `1d`, series key `id` (Protocol Product Chain Market ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Lending Protocol Product Markets](/api-reference/data-api/lending-protocols/tabular-lending-protocol-product-markets) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Lending Market timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product-market) > > Up to 10 series in one request, named by Protocol Product Chain Market ID in `series`. > [card] [Get Lending Market timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product-market-by-id) > > One series over a time window, keyed by its Protocol Product Chain Market ID. ## Metrics 3 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `deposits-usd` | Deposits (USD) | float64 | | Total deposits (supply and collateral) in USD across the market's tokens. | | `borrowed-usd` | Borrowed (USD) | float64 | | Total outstanding borrows in USD across the market's tokens. | | `tvl-usd` | TVL (USD) | float64 | | TVL in USD, deposits minus borrows. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the lending-protocols-by-product-market timeseries model, the product id followed by the market key, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the market (market name when present, else the market key). | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. (identifier 1) | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name, the id in lending-protocols (aave). | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol (aave-v3). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the market lives on (ethereum, bnb, solana). | | `marketName` | string | `Eq`, `IsOneOf`, `Contains` | | The market display name. | | `marketType` | string | `Eq`, `IsOneOf` | | The market type where the protocol distinguishes one (for example core, pooled or credit_vault); null otherwise. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/lending-protocols-by-product-market/1d/aave_aave-v2_avalanche_c_0x4f01aed16d97e3ab5ab2b501154dc9bb0f1a5a2c?timeframe=7d&selections=deposits-usd,borrowed-usd" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Lending Market timeseries](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product-market-by-id) for the response and the errors. # Lending Protocols Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/overview Lending metrics at three grains: per protocol, per product deployment on one chain, and per market within a product. Each grain has a lookup table for its keys and a timeseries model for deposits, borrows, TVL, interest, fees and revenue. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Lending Protocols](/api-reference/data-api/lending-protocols/lending-protocols) | Lending-protocols-dataset | [List rows](/api-reference/data-api/lending-protocols/tabular-lending-protocols) | [Batch](/api-reference/data-api/lending-protocols/timeseries-lending-protocols), [One series](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-id) | | [Lending Market Balances](/api-reference/data-api/lending-protocols/lending-market-balances) | Lending-protocols-dataset | [List rows](/api-reference/data-api/lending-protocols/tabular-lending-market-balances) | [Batch](/api-reference/data-api/lending-protocols/timeseries-lending-market-balances), [One series](/api-reference/data-api/lending-protocols/timeseries-lending-market-balances-by-id) | | [Lending Market Financials](/api-reference/data-api/lending-protocols/lending-market-financials) | Lending-protocols-dataset | [List rows](/api-reference/data-api/lending-protocols/tabular-lending-market-financials) | [Batch](/api-reference/data-api/lending-protocols/timeseries-lending-market-financials), [One series](/api-reference/data-api/lending-protocols/timeseries-lending-market-financials-by-id) | | [Lending Market Flows](/api-reference/data-api/lending-protocols/lending-market-flows) | Lending-protocols-dataset | [List rows](/api-reference/data-api/lending-protocols/tabular-lending-market-flows) | [Batch](/api-reference/data-api/lending-protocols/timeseries-lending-market-flows), [One series](/api-reference/data-api/lending-protocols/timeseries-lending-market-flows-by-id) | | [Lending Market Interest Rates](/api-reference/data-api/lending-protocols/lending-market-interest-rates) | Lending-protocols-dataset | [List rows](/api-reference/data-api/lending-protocols/tabular-lending-market-interest-rates) | [Batch](/api-reference/data-api/lending-protocols/timeseries-lending-market-interest-rates), [One series](/api-reference/data-api/lending-protocols/timeseries-lending-market-interest-rates-by-id) | | [Lending Market Liquidations](/api-reference/data-api/lending-protocols/lending-market-liquidations) | Lending-protocols-dataset | [List rows](/api-reference/data-api/lending-protocols/tabular-lending-market-liquidations) | [Batch](/api-reference/data-api/lending-protocols/timeseries-lending-market-liquidations), [One series](/api-reference/data-api/lending-protocols/timeseries-lending-market-liquidations-by-id) | | [Lending Protocols by Product](/api-reference/data-api/lending-protocols/lending-protocols-by-product) | Lending-protocols-dataset | [List rows](/api-reference/data-api/lending-protocols/tabular-lending-protocol-products) | [Batch](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product), [One series](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product-by-id) | | [Lending Protocols by Product Market](/api-reference/data-api/lending-protocols/lending-protocols-by-product-market) | Lending-protocols-dataset | [List rows](/api-reference/data-api/lending-protocols/tabular-lending-protocol-product-markets) | [Batch](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product-market), [One series](/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product-market-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/lending-protocols?pageSize=3&selections=id,slug,name,projectID" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Lending Protocols](/api-reference/data-api/lending-protocols/tabular-lending-protocols) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Lending Market Balances Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/tabular-lending-market-balances api-reference/data-api/openapi.json GET /query/tabular/lending-market-balances One row per lending market balance, the finest grain of the lending data, keyed by protocol, product, chain, market, token, balance type and balance subtype: the market and token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the lending-market-balances timeseries model. # List Lending Market Tokens Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/tabular-lending-market-financials api-reference/data-api/openapi.json GET /query/tabular/lending-market-financials One row per token in a lending market, keyed by protocol, product, chain, market and token: the market and token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the lending-market-financials timeseries model. # List Lending Market Flows Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/tabular-lending-market-flows api-reference/data-api/openapi.json GET /query/tabular/lending-market-flows One row per lending market flow, keyed by protocol, product, chain, market, token, balance type and balance subtype: the market and token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the lending-market-flows timeseries model, and the same key as lending-market-balances. # List Lending Market Interest Rates Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/tabular-lending-market-interest-rates api-reference/data-api/openapi.json GET /query/tabular/lending-market-interest-rates One row per token in a lending market with interest rates, keyed by protocol, product, chain, market and token: the market and token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the lending-market-interest-rates timeseries model. # List Lending Market Liquidation Pairs Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/tabular-lending-market-liquidations api-reference/data-api/openapi.json GET /query/tabular/lending-market-liquidations One row per collateral and debt token pair liquidated in a lending market, keyed by protocol, product, chain, market, collateral token and debt token: the market and both tokens, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the lending-market-liquidations timeseries model. # List Lending Protocol Product Markets Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/tabular-lending-protocol-product-markets api-reference/data-api/openapi.json GET /query/tabular/lending-protocol-product-markets One row per lending market, the finest grain of the lending data, keyed by protocol, product, chain and market key: market name and type, the parent protocol and product, chain and the mapped protocol record. The id is the series key of the lending-protocols-by-product-market timeseries model. # List Lending Protocol Products Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/tabular-lending-protocol-products api-reference/data-api/openapi.json GET /query/tabular/lending-protocol-products One row per lending product deployment, one protocol version on one blockchain, keyed by protocol, product and chain: name, parent protocol, product, chain and the mapped protocol record. The id is the series key of the lending-protocols-by-product timeseries model. # List Lending Protocols Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/tabular-lending-protocols api-reference/data-api/openapi.json GET /query/tabular/lending-protocols One row per lending protocol, keyed by its short name: name, project slug and project id. The id is the series key of the lending-protocols timeseries model. # Batch Get Lending Market Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-market-balances api-reference/data-api/openapi.json GET /query/timeseries/lending-market-balances/{granularity} Balance in USD for one token in one lending market, split by balance type (deposit or borrow) and subtype (supply, collateral, variable or fixed borrow). Each series is one market token balance, keyed by protocol, product, chain, market, token, balance type and balance subtype. Finer than lending-protocols-by-product-market, with many series per market, so name the balances you need. # Get Lending Market Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-market-balances-by-id api-reference/data-api/openapi.json GET /query/timeseries/lending-market-balances/{granularity}/{id} Balance in USD for one token in one lending market, split by balance type (deposit or borrow) and subtype (supply, collateral, variable or fixed borrow). Each series is one market token balance, keyed by protocol, product, chain, market, token, balance type and balance subtype. Finer than lending-protocols-by-product-market, with many series per market, so name the balances you need. # Batch Get Lending Market Financial timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-market-financials api-reference/data-api/openapi.json GET /query/timeseries/lending-market-financials/{granularity} Daily interest, net interest income, fees and revenue in USD for one token in one lending market. Each series is one market token, keyed by protocol, product, chain, market and token. Fee components a protocol does not report are null. Many series per market, so name the series you need. # Get Lending Market Financial timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-market-financials-by-id api-reference/data-api/openapi.json GET /query/timeseries/lending-market-financials/{granularity}/{id} Daily interest, net interest income, fees and revenue in USD for one token in one lending market. Each series is one market token, keyed by protocol, product, chain, market and token. Fee components a protocol does not report are null. Many series per market, so name the series you need. # Batch Get Lending Market Flow timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-market-flows api-reference/data-api/openapi.json GET /query/timeseries/lending-market-flows/{granularity} Daily net, gross inflow and gross outflow in USD for one token in one lending market, split by balance type (deposit or borrow) and subtype. Each series is keyed like lending-market-balances, by protocol, product, chain, market, token, balance type and balance subtype. Many series per market, so name the series you need. # Get Lending Market Flow timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-market-flows-by-id api-reference/data-api/openapi.json GET /query/timeseries/lending-market-flows/{granularity}/{id} Daily net, gross inflow and gross outflow in USD for one token in one lending market, split by balance type (deposit or borrow) and subtype. Each series is keyed like lending-market-balances, by protocol, product, chain, market, token, balance type and balance subtype. Many series per market, so name the series you need. # Batch Get Lending Market Interest Rate timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-market-interest-rates api-reference/data-api/openapi.json GET /query/timeseries/lending-market-interest-rates/{granularity} Daily supply and borrow rates for one token in one lending market, as decimals (0.05 is 5%), weighted by the supply and borrow balances they apply to, with those weights in USD. Each series is one market token, keyed by protocol, product, chain, market and token. Many series per market, so name the series you need. # Get Lending Market Interest Rate timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-market-interest-rates-by-id api-reference/data-api/openapi.json GET /query/timeseries/lending-market-interest-rates/{granularity}/{id} Daily supply and borrow rates for one token in one lending market, as decimals (0.05 is 5%), weighted by the supply and borrow balances they apply to, with those weights in USD. Each series is one market token, keyed by protocol, product, chain, market and token. Many series per market, so name the series you need. # Batch Get Lending Market Liquidation timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-market-liquidations api-reference/data-api/openapi.json GET /query/timeseries/lending-market-liquidations/{granularity} Daily liquidations for one collateral and debt token pair in one lending market: collateral seized, debt repaid, losses and fees in USD and the liquidation count. Each series is one pair, keyed by protocol, product, chain, market, collateral token and debt token. Many series per market, so name the series you need. # Get Lending Market Liquidation timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-market-liquidations-by-id api-reference/data-api/openapi.json GET /query/timeseries/lending-market-liquidations/{granularity}/{id} Daily liquidations for one collateral and debt token pair in one lending market: collateral seized, debt repaid, losses and fees in USD and the liquidation count. Each series is one pair, keyed by protocol, product, chain, market, collateral token and debt token. Many series per market, so name the series you need. # Batch Get Lending Protocol timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-protocols api-reference/data-api/openapi.json GET /query/timeseries/lending-protocols/{granularity} Lending metrics for a protocol, summed across its products and chains: deposits, outstanding borrows, TVL, interest paid, net interest income, flash-loan, liquidation and royalty fees, and total fees and revenue, in USD. Each series is one protocol, keyed by its slug. # Get Lending Protocol timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-id api-reference/data-api/openapi.json GET /query/timeseries/lending-protocols/{granularity}/{id} Lending metrics for a protocol, summed across its products and chains: deposits, outstanding borrows, TVL, interest paid, net interest income, flash-loan, liquidation and royalty fees, and total fees and revenue, in USD. Each series is one protocol, keyed by its slug. # Batch Get Lending Protocol Product timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product api-reference/data-api/openapi.json GET /query/timeseries/lending-protocols-by-product/{granularity} The lending-protocols metrics broken down by product (version) and blockchain: deposits, borrows, TVL, interest, fees and revenue in USD. Each series is one product on one chain, keyed by protocol, product and chain. # Get Lending Protocol Product timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product-by-id api-reference/data-api/openapi.json GET /query/timeseries/lending-protocols-by-product/{granularity}/{id} The lending-protocols metrics broken down by product (version) and blockchain: deposits, borrows, TVL, interest, fees and revenue in USD. Each series is one product on one chain, keyed by protocol, product and chain. # Batch Get Lending Market timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product-market api-reference/data-api/openapi.json GET /query/timeseries/lending-protocols-by-product-market/{granularity} Deposits, outstanding borrows and TVL in USD for one lending market within a protocol product on one chain. Each series is one market, keyed by protocol, product, chain and market key. The finest grain of the lending data, with thousands of series, so name the markets you need. # Get Lending Market timeseries Source: https://docs.blockworks.com/api-reference/data-api/lending-protocols/timeseries-lending-protocols-by-product-market-by-id api-reference/data-api/openapi.json GET /query/timeseries/lending-protocols-by-product-market/{granularity}/{id} Deposits, outstanding borrows and TVL in USD for one lending market within a protocol product on one chain. Each series is one market, keyed by protocol, product, chain and market key. The finest grain of the lending data, with thousands of series, so name the markets you need. # Market Data Source: https://docs.blockworks.com/api-reference/data-api/market-data Prices, market caps, supply, volumes and derivatives across assets, trading pairs, exchanges and sectors. The Assets table is the usual entry point: the per-asset series are keyed by its assetID. > [card] [Assets](/api-reference/data-api/assets/overview) > > The asset master table and the per-asset market series: price candles, market cap, supply, Sharpe ratio and realized volatility. 6 models. > [card] [Markets](/api-reference/data-api/markets/overview) > > Price and volume candles for one trading pair on one exchange, in USD and in the raw quote currency. 1 model. > [card] [Exchanges](/api-reference/data-api/exchanges/overview) > > Trade volume and trade count per exchange, and the same metrics summed by country, region and exchange type. 4 models. > [card] [Derivatives](/api-reference/data-api/derivatives/overview) > > Perpetual futures contracts on centralized exchanges: the contract table and each contract's price, volume and open interest history. 2 models. > [card] [Sector Market Data](/api-reference/data-api/sector-market-data/overview) > > Sector Market Data: Sector Marketdata, Sub-Sector Marketdata. 2 models. # Market (BQEN) Source: https://docs.blockworks.com/api-reference/data-api/markets/market-bqen Price and volume candles for a trading pair on one exchange: open, high, low, close and volume, in USD and in the raw quote currency. Each series is one market, keyed by its market id. Every trading pair with its base asset, quote asset, exchange and network, plus trailing 24-hour price and volume. The id is the series key of the bqen and markets timeseries models, so this is where you find the market whose candles you want: filter by base asset, quote asset or exchange. | | | | - | - | | Access | Markets-dataset | | Tabular model | `markets`: primary key `marketID` | | Timeseries model | `bqen`: intervals `5m`, `1h`, `1d`, `1w`, series key `id` (Market ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Markets](/api-reference/data-api/markets/tabular-markets) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Market](/api-reference/data-api/markets/tabular-markets-by-id) > > One row by `marketID`. > [card] [Batch Get Market timeseries](/api-reference/data-api/markets/timeseries-bqen) > > Up to 10 series in one request, named by Market ID in `series`. > [card] [Get Market timeseries](/api-reference/data-api/markets/timeseries-bqen-by-id) > > One series over a time window, keyed by its Market ID. ## Metrics 10 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `open-price` | Open Price | float64 | usd | USD price at the candle open. | | `open-price-raw` | Open Price Raw | float64 | usd | Raw price at the candle open. | | `high-price` | High Price | float64 | usd | High USD price during the candle. | | `high-price-raw` | High Price Raw | float64 | usd | Raw high price during the candle. | | `low-price` | Low Price | float64 | usd | Low USD price during the candle. | | `low-price-raw` | Low Price Raw | float64 | usd | Raw low price during the candle. | | `close-price` | Close Price | float64 | usd | USD price at the candle close. | | `close-price-raw` | Close Price Raw | float64 | usd | Raw price at the candle close. | | `volume` | Volume | float64 | usd | Volume traded during candle. | | `volume-raw` | Volume Raw | float64 | usd | Raw volume traded during candle. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `marketID` | string | `Eq`, `IsOneOf` | | The unique identifier of the market, and the series key of the bqen and markets timeseries models. It joins the serial identifiers of the base asset, quote asset and exchange, and adds the network on an onchain market. 6057-140-68 is BTC/USDT on Binance; 6071-6083-84-9 is WETH/USDC on Uniswap v3 on Ethereum. (primary key) | | `baseAssetID` | string | `Eq`, `IsOneOf` | | The unique identifier of the market's base asset. | | `baseAssetName` | string | | | The name of the market's base asset. | | `baseAssetSlug` | string | `Eq`, `IsOneOf` | | The URL slug of the market's base asset. | | `baseAssetSymbol` | string | | | The ticker symbol of the market's base asset. | | `baseAssetSector` | string | | | The sector of the market's base asset. | | `quoteAssetID` | string | `Eq`, `IsOneOf` | | The unique identifier of the market's quote asset. | | `quoteAssetName` | string | | | The name of the market's quote asset. | | `quoteAssetSlug` | string | `Eq`, `IsOneOf` | | The URL slug of the market's quote asset. | | `quoteAssetSymbol` | string | | | The ticker symbol of the market's quote asset. | | `quoteAssetSector` | string | | | The sector of the market's quote asset. | | `exchangeID` | string | `Eq`, `IsOneOf` | | The unique identifier of the exchange the market trades on. | | `exchangeName` | string | | | The name of the exchange the market trades on. | | `exchangeSlug` | string | `Eq`, `IsOneOf` | | The URL slug of the exchange the market trades on. | | `networkID` | string | | | The unique identifier of the network the market settles on. Absent for markets that are not onchain. | | `networkName` | string | | | The name of the network the market settles on. | | `networkSlug` | string | | | The URL slug of the network the market settles on. | | `sectors` | array_string | | | The sectors covering the market's assets. | | `firstTradeAt` | time | | yes | When the market's first trade was recorded. | | `lastTradeAt` | time | `Gt`, `Gte` | yes | When the market's most recent trade was recorded. Filtering on this selects markets active since a given time. | | `isNewMarket` | bool | | | If true, the market was listed recently enough to count as new. | | `isRecentlyListed` | bool | | | If true, the market's asset was listed recently. | | `liveness` | string | `Eq`, `IsOneOf` | | Trading state of the market. One of live, low-volume, or inactive. The public API renders low-volume as stale. | | `latestPrice24hOpen` | float64 | | yes | Opening price over the trailing 24 hours, in USD. | | `latestPrice24hHigh` | float64 | | yes | Highest price over the trailing 24 hours, in USD. | | `latestPrice24hLow` | float64 | | yes | Lowest price over the trailing 24 hours, in USD. | | `latestPrice24hClose` | float64 | | yes | Closing price over the trailing 24 hours, in USD. | | `premiumDiscount` | float64 | | yes | The market's price relative to the reference price of its base asset. | | `exchangeVolumePercentage24h` | float64 | | yes | Share of the exchange's trailing 24-hour volume this market accounts for. | | `volume24hUSD` | float64 | `Gt`, `Gte`, `Lt`, `Lte` | default | Traded volume over the trailing 24 hours, in USD. | | `tradeCount24h` | int64 | | yes | Number of trades over the trailing 24 hours. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/bqen/1d/100-140-110?timeframe=7d&selections=close-price,volume" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Market timeseries](/api-reference/data-api/markets/timeseries-bqen-by-id) for the response and the errors. # Markets Source: https://docs.blockworks.com/api-reference/data-api/markets/overview Price and volume candles for one trading pair on one exchange, in USD and in the raw quote currency. Use it when the venue matters; for one price per asset across venues use Asset Price. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Market (BQEN)](/api-reference/data-api/markets/market-bqen) | Markets-dataset | [List rows](/api-reference/data-api/markets/tabular-markets), [One row](/api-reference/data-api/markets/tabular-markets-by-id) | [Batch](/api-reference/data-api/markets/timeseries-bqen), [One series](/api-reference/data-api/markets/timeseries-bqen-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/markets?pageSize=3&selections=marketID,baseAssetID,baseAssetName,baseAssetSlug" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Markets](/api-reference/data-api/markets/tabular-markets) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Markets Source: https://docs.blockworks.com/api-reference/data-api/markets/tabular-markets api-reference/data-api/openapi.json GET /query/tabular/markets Every trading pair with its base asset, quote asset, exchange and network, plus trailing 24-hour price and volume. The id is the series key of the bqen and markets timeseries models, so this is where you find the market whose candles you want: filter by base asset, quote asset or exchange. # Get Market Source: https://docs.blockworks.com/api-reference/data-api/markets/tabular-markets-by-id api-reference/data-api/openapi.json GET /query/tabular/markets/{marketID} Every trading pair with its base asset, quote asset, exchange and network, plus trailing 24-hour price and volume. The id is the series key of the bqen and markets timeseries models, so this is where you find the market whose candles you want: filter by base asset, quote asset or exchange. # Batch Get Market timeseries Source: https://docs.blockworks.com/api-reference/data-api/markets/timeseries-bqen api-reference/data-api/openapi.json GET /query/timeseries/bqen/{granularity} Price and volume candles for a trading pair on one exchange: open, high, low, close and volume, in USD and in the raw quote currency. Each series is one market, keyed by its market id. # Get Market timeseries Source: https://docs.blockworks.com/api-reference/data-api/markets/timeseries-bqen-by-id api-reference/data-api/openapi.json GET /query/timeseries/bqen/{granularity}/{id} Price and volume candles for a trading pair on one exchange: open, high, low, close and volume, in USD and in the raw quote currency. Each series is one market, keyed by its market id. # Asset Group Sentiment Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/asset-group-sentiment Sentiment score for a basket of assets. Each series is one asset group, keyed by its asset group id. Compares social sentiment across groups of assets rather than one asset at a time. | | | | - | - | | Access | Mindshare-and-sentiment-dataset | | Timeseries model | `asset-group-sentiment`: intervals `1h`, `6h`, `1d`, series key `asset-group-id` (Asset Group ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Asset Group timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-asset-group-sentiment) > > Up to 10 series in one request, named by Asset Group ID in `series`. > [card] [Get Asset Group timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-asset-group-sentiment-by-id) > > One series over a time window, keyed by its Asset Group ID. ## Metrics 1 metric. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `score` | Score | float64 | | The asset sentiment score of the asset group. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/asset-group-sentiment/1d/?timeframe=7d&selections=score" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Asset Group timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-asset-group-sentiment-by-id) for the response and the errors. # Asset Investor Mentions Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/asset-investor-mentions Counts of tracked investor accounts mentioning an asset: distinct investors, mentions and the asset's share of all investor mentions. Each series is one asset, keyed by its asset id. Shows which assets investors are talking about. | | | | - | - | | Access | Mindshare-and-sentiment-dataset | | Timeseries model | `asset-investor-mentions`: intervals `1d`, series key `asset-id` (Asset ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Asset timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-asset-investor-mentions) > > Up to 10 series in one request, named by Asset ID in `series`. > [card] [Get Asset timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-asset-investor-mentions-by-id) > > One series over a time window, keyed by its Asset ID. ## Metrics 3 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `unique-investors-count` | Unique Investors Count | int32 | | The number of unique investors mentioning this asset on a given interval. | | `mentions-count` | Mentions Count | int32 | | The total number of mentions for this asset on a given interval. | | `mentions-percentage` | Mentions Percentage | float64 | percent | The percentage of total investor mentions for this asset on a given interval. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/asset-investor-mentions/1d/1e31218a-e44e-4285-820c-8282ee222035?timeframe=7d&selections=unique-investors-count,mentions-count" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Asset timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-asset-investor-mentions-by-id) for the response and the errors. # Asset Mindshare Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/asset-mindshare Social mindshare of an asset: its share of attention across tracked assets, the underlying score, rank, rolling averages and unique authors. Each series is one asset, keyed by its asset id. | | | | - | - | | Access | Mindshare-and-sentiment-dataset | | Timeseries model | `asset-mindshare`: intervals `1h`, `6h`, `1d`, series key `asset-id` (Asset ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Asset timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-asset-mindshare) > > Up to 10 series in one request, named by Asset ID in `series`. > [card] [Get Asset timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-asset-mindshare-by-id) > > One series over a time window, keyed by its Asset ID. ## Metrics 7 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `percentage` | Percentage | float64 | | The percentage of the total mindshare score for this asset on a given interval. | | `score` | Score | float64 | | The total mindshare score for the asset on a given interval. | | `rank` | Rank | int64 | | Mindshare rank of the asset among all assets. | | `percentage-rolling-7d` | Percentage Rolling 7D | float64 | | The sum of the normalized mindshare score for this asset over the last 7 days. | | `percentage-rolling-avg-7d` | Percentage Rolling Avg 7D | float64 | percent | The average of the mindshare percentage for this asset over the last 7 days. | | `percentage-rolling-avg-24h` | Percentage Rolling Avg 24H | float64 | percent | The average of the mindshare percentage for this asset over the last 24 hours. | | `unique-authors-mentioning` | Unique Authors Mentioning | int64 | | The total number of unique authors mentioning this asset on a given interval. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/asset-mindshare/1d/1e31218a-e44e-4285-820c-8282ee222035?timeframe=7d&selections=percentage,score" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Asset timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-asset-mindshare-by-id) for the response and the errors. # Asset Sentiment Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/asset-sentiment Social sentiment for an asset, a score from -1 to 1 derived from posts on X, with the number of posts counted. Each series is one asset, keyed by its asset id. | | | | - | - | | Access | Mindshare-and-sentiment-dataset | | Timeseries model | `asset-sentiment`: intervals `1h`, `6h`, `1d`, series key `asset-id` (Asset ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Asset timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-asset-sentiment) > > Up to 10 series in one request, named by Asset ID in `series`. > [card] [Get Asset timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-asset-sentiment-by-id) > > One series over a time window, keyed by its Asset ID. ## Metrics 2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `sentiment-score` | Sentiment Score | float64 | | The sentiment score for the asset. The score ranges from -1.0 (extremely negative) to 1.0 (extremely positive). | | `tweet-volume` | Tweet Volume | int32 | | The number of tweets for the asset. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/asset-sentiment/1d/1e31218a-e44e-4285-820c-8282ee222035?timeframe=7d&selections=sentiment-score,tweet-volume" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Asset timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-asset-sentiment-by-id) for the response and the errors. # Mindshare & Sentiment Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/overview Mindshare & Sentiment: Asset Group Sentiment, Asset Investor Mentions, Asset Mindshare, Asset Sentiment, Project Mindshare, Sector Asset Mindshare, Sector Asset Sentiment, Sector Investor Mentions, Sub-Sector Asset Mindshare, Sub-Sector Asset Sentiment. ## Endpoints | Model | Access | Timeseries | | - | - | - | | [Asset Group Sentiment](/api-reference/data-api/mindshare-sentiment/asset-group-sentiment) | Mindshare-and-sentiment-dataset | [Batch](/api-reference/data-api/mindshare-sentiment/timeseries-asset-group-sentiment), [One series](/api-reference/data-api/mindshare-sentiment/timeseries-asset-group-sentiment-by-id) | | [Asset Investor Mentions](/api-reference/data-api/mindshare-sentiment/asset-investor-mentions) | Mindshare-and-sentiment-dataset | [Batch](/api-reference/data-api/mindshare-sentiment/timeseries-asset-investor-mentions), [One series](/api-reference/data-api/mindshare-sentiment/timeseries-asset-investor-mentions-by-id) | | [Asset Mindshare](/api-reference/data-api/mindshare-sentiment/asset-mindshare) | Mindshare-and-sentiment-dataset | [Batch](/api-reference/data-api/mindshare-sentiment/timeseries-asset-mindshare), [One series](/api-reference/data-api/mindshare-sentiment/timeseries-asset-mindshare-by-id) | | [Asset Sentiment](/api-reference/data-api/mindshare-sentiment/asset-sentiment) | Mindshare-and-sentiment-dataset | [Batch](/api-reference/data-api/mindshare-sentiment/timeseries-asset-sentiment), [One series](/api-reference/data-api/mindshare-sentiment/timeseries-asset-sentiment-by-id) | | [Project Mindshare](/api-reference/data-api/mindshare-sentiment/project-mindshare) | Mindshare-and-sentiment-dataset | [Batch](/api-reference/data-api/mindshare-sentiment/timeseries-project-mindshare), [One series](/api-reference/data-api/mindshare-sentiment/timeseries-project-mindshare-by-id) | | [Sector Asset Mindshare](/api-reference/data-api/mindshare-sentiment/sector-asset-mindshare) | Mindshare-and-sentiment-dataset | [Batch](/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-mindshare), [One series](/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-mindshare-by-id) | | [Sector Asset Sentiment](/api-reference/data-api/mindshare-sentiment/sector-asset-sentiment) | Mindshare-and-sentiment-dataset | [Batch](/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-sentiment), [One series](/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-sentiment-by-id) | | [Sector Investor Mentions](/api-reference/data-api/mindshare-sentiment/sector-investor-mentions) | Mindshare-and-sentiment-dataset | [Batch](/api-reference/data-api/mindshare-sentiment/timeseries-sector-investor-mentions), [One series](/api-reference/data-api/mindshare-sentiment/timeseries-sector-investor-mentions-by-id) | | [Sub-Sector Asset Mindshare](/api-reference/data-api/mindshare-sentiment/sub-sector-asset-mindshare) | Mindshare-and-sentiment-dataset | [Batch](/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-mindshare), [One series](/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-mindshare-by-id) | | [Sub-Sector Asset Sentiment](/api-reference/data-api/mindshare-sentiment/sub-sector-asset-sentiment) | Mindshare-and-sentiment-dataset | [Batch](/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-sentiment), [One series](/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-sentiment-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/asset-group-sentiment/1d?series=%3Casset-group-id%3E,%3Casset-group-id%3E&timeframe=7d&selections=score" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Batch Get Asset Group timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-asset-group-sentiment) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Project Mindshare Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/project-mindshare Social mindshare of a project: its normalized share of attention among all projects and its rank. Each series is one project, keyed by its project id. Tracks attention to protocols and companies rather than tokens. | | | | - | - | | Access | Mindshare-and-sentiment-dataset | | Timeseries model | `project-mindshare`: intervals `1d`, series key `project-id` (Project ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Project timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-project-mindshare) > > Up to 10 series in one request, named by Project ID in `series`. > [card] [Get Project timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-project-mindshare-by-id) > > One series over a time window, keyed by its Project ID. ## Metrics 2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `score` | Score | float64 | | The mindshare score for the project. | | `rank` | Rank | int64 | | Mindshare rank of the project among all projects. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/project-mindshare/1d/8434fad0-37fa-4332-bfcf-240e4aaf3af4?timeframe=7d&selections=score,rank" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Project timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-project-mindshare-by-id) for the response and the errors. # Sector Asset Mindshare Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/sector-asset-mindshare Social mindshare aggregated over the assets in a sector: total score, share of mindshare across sectors and rank. Each series is one sector, keyed by its name. | | | | - | - | | Access | Mindshare-and-sentiment-dataset | | Timeseries model | `sector-asset-mindshare`: intervals `1h`, `6h`, `1d`, series key `sector` (Sectors), every series available in one call | ## Endpoints > [card] [Batch Get Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-mindshare) > > Every series in one request, or the named ones. > [card] [Get Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-mindshare-by-id) > > One series over a time window, keyed by its Sectors. ## Metrics 3 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `score` | Score | float64 | | Total asset mindshare score of the sector. | | `percentage` | Percentage | float64 | percent | Percentage of the sector's asset mindshare among all sectors. | | `rank` | Rank | int32 | | Rank of the sector's asset mindshare among all sectors. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/sector-asset-mindshare/1d/AI?timeframe=7d&selections=score,percentage" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-mindshare-by-id) for the response and the errors. # Sector Asset Sentiment Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/sector-asset-sentiment Social sentiment score aggregated over the assets in a sector. Each series is one sector, keyed by its name. | | | | - | - | | Access | Mindshare-and-sentiment-dataset | | Timeseries model | `sector-asset-sentiment`: intervals `1h`, `6h`, `1d`, series key `sector` (Sectors), every series available in one call | ## Endpoints > [card] [Batch Get Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-sentiment) > > Every series in one request, or the named ones. > [card] [Get Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-sentiment-by-id) > > One series over a time window, keyed by its Sectors. ## Metrics 1 metric. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `score` | Score | float64 | | The asset sentiment score of the sector. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/sector-asset-sentiment/1d/AI?timeframe=7d&selections=score" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-sentiment-by-id) for the response and the errors. # Sector Investor Mentions Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/sector-investor-mentions Counts of tracked investor accounts mentioning assets in a sector: distinct investors, mentions and the sector's share of all investor mentions. Each series is one sector, keyed by its name. | | | | - | - | | Access | Mindshare-and-sentiment-dataset | | Timeseries model | `sector-investor-mentions`: intervals `1d`, series key `sector` (Sectors), every series available in one call | ## Endpoints > [card] [Batch Get Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sector-investor-mentions) > > Every series in one request, or the named ones. > [card] [Get Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sector-investor-mentions-by-id) > > One series over a time window, keyed by its Sectors. ## Metrics 3 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `unique-investors-count` | Unique Investors Count | int32 | | The number of unique investors mentioning assets in this sector on a given interval. | | `mentions-count` | Mentions Count | int32 | | The total number of mentions for assets in this sector on a given interval. | | `mentions-percentage` | Mentions Percentage | float64 | percent | The percentage of total investor mentions for assets in this sector on a given interval. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/sector-investor-mentions/1d/AI?timeframe=7d&selections=unique-investors-count,mentions-count" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sector-investor-mentions-by-id) for the response and the errors. # Sub-Sector Asset Mindshare Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/sub-sector-asset-mindshare Social mindshare aggregated over the assets in a sub-sector: total score, share of mindshare across sub-sectors and rank. Each series is one sub-sector, keyed by its name. | | | | - | - | | Access | Mindshare-and-sentiment-dataset | | Timeseries model | `sub-sector-asset-mindshare`: intervals `1h`, `6h`, `1d`, series key `sub-sector` (Sub-Sectors), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Sub-Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-mindshare) > > Up to 10 series in one request, named by Sub-Sectors in `series`. > [card] [Get Sub-Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-mindshare-by-id) > > One series over a time window, keyed by its Sub-Sectors. ## Metrics 3 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `score` | Score | float64 | | Total asset mindshare score of the sub-sector. | | `percentage` | Percentage | float64 | percent | Percentage of the sub-sector's asset mindshare among all sub-sectors. | | `rank` | Rank | int32 | | Rank of the sub-sector's asset mindshare among all sub-sectors. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/sub-sector-asset-mindshare/1d/AAA%20Games?timeframe=7d&selections=score,percentage" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Sub-Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-mindshare-by-id) for the response and the errors. # Sub-Sector Asset Sentiment Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/sub-sector-asset-sentiment Social sentiment score aggregated over the assets in a sub-sector. Each series is one sub-sector, keyed by its name. | | | | - | - | | Access | Mindshare-and-sentiment-dataset | | Timeseries model | `sub-sector-asset-sentiment`: intervals `1h`, `6h`, `1d`, series key `sub-sector` (Sub-Sectors), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Sub-Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-sentiment) > > Up to 10 series in one request, named by Sub-Sectors in `series`. > [card] [Get Sub-Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-sentiment-by-id) > > One series over a time window, keyed by its Sub-Sectors. ## Metrics 1 metric. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `score` | Score | float64 | | The asset sentiment score of the sub-sector. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/sub-sector-asset-sentiment/1d/AI%20Agents?timeframe=7d&selections=score" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Sub-Sector timeseries](/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-sentiment-by-id) for the response and the errors. # Batch Get Asset Group timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-asset-group-sentiment api-reference/data-api/openapi.json GET /query/timeseries/asset-group-sentiment/{granularity} Sentiment score for a basket of assets. Each series is one asset group, keyed by its asset group id. Compares social sentiment across groups of assets rather than one asset at a time. # Get Asset Group timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-asset-group-sentiment-by-id api-reference/data-api/openapi.json GET /query/timeseries/asset-group-sentiment/{granularity}/{asset-group-id} Sentiment score for a basket of assets. Each series is one asset group, keyed by its asset group id. Compares social sentiment across groups of assets rather than one asset at a time. # Batch Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-asset-investor-mentions api-reference/data-api/openapi.json GET /query/timeseries/asset-investor-mentions/{granularity} Counts of tracked investor accounts mentioning an asset: distinct investors, mentions and the asset's share of all investor mentions. Each series is one asset, keyed by its asset id. Shows which assets investors are talking about. # Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-asset-investor-mentions-by-id api-reference/data-api/openapi.json GET /query/timeseries/asset-investor-mentions/{granularity}/{asset-id} Counts of tracked investor accounts mentioning an asset: distinct investors, mentions and the asset's share of all investor mentions. Each series is one asset, keyed by its asset id. Shows which assets investors are talking about. # Batch Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-asset-mindshare api-reference/data-api/openapi.json GET /query/timeseries/asset-mindshare/{granularity} Social mindshare of an asset: its share of attention across tracked assets, the underlying score, rank, rolling averages and unique authors. Each series is one asset, keyed by its asset id. # Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-asset-mindshare-by-id api-reference/data-api/openapi.json GET /query/timeseries/asset-mindshare/{granularity}/{asset-id} Social mindshare of an asset: its share of attention across tracked assets, the underlying score, rank, rolling averages and unique authors. Each series is one asset, keyed by its asset id. # Batch Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-asset-sentiment api-reference/data-api/openapi.json GET /query/timeseries/asset-sentiment/{granularity} Social sentiment for an asset, a score from -1 to 1 derived from posts on X, with the number of posts counted. Each series is one asset, keyed by its asset id. # Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-asset-sentiment-by-id api-reference/data-api/openapi.json GET /query/timeseries/asset-sentiment/{granularity}/{asset-id} Social sentiment for an asset, a score from -1 to 1 derived from posts on X, with the number of posts counted. Each series is one asset, keyed by its asset id. # Batch Get Project timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-project-mindshare api-reference/data-api/openapi.json GET /query/timeseries/project-mindshare/{granularity} Social mindshare of a project: its normalized share of attention among all projects and its rank. Each series is one project, keyed by its project id. Tracks attention to protocols and companies rather than tokens. # Get Project timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-project-mindshare-by-id api-reference/data-api/openapi.json GET /query/timeseries/project-mindshare/{granularity}/{project-id} Social mindshare of a project: its normalized share of attention among all projects and its rank. Each series is one project, keyed by its project id. Tracks attention to protocols and companies rather than tokens. # Batch Get Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-mindshare api-reference/data-api/openapi.json GET /query/timeseries/sector-asset-mindshare/{granularity} Social mindshare aggregated over the assets in a sector: total score, share of mindshare across sectors and rank. Each series is one sector, keyed by its name. # Get Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-mindshare-by-id api-reference/data-api/openapi.json GET /query/timeseries/sector-asset-mindshare/{granularity}/{sector} Social mindshare aggregated over the assets in a sector: total score, share of mindshare across sectors and rank. Each series is one sector, keyed by its name. # Batch Get Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-sentiment api-reference/data-api/openapi.json GET /query/timeseries/sector-asset-sentiment/{granularity} Social sentiment score aggregated over the assets in a sector. Each series is one sector, keyed by its name. # Get Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-sector-asset-sentiment-by-id api-reference/data-api/openapi.json GET /query/timeseries/sector-asset-sentiment/{granularity}/{sector} Social sentiment score aggregated over the assets in a sector. Each series is one sector, keyed by its name. # Batch Get Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-sector-investor-mentions api-reference/data-api/openapi.json GET /query/timeseries/sector-investor-mentions/{granularity} Counts of tracked investor accounts mentioning assets in a sector: distinct investors, mentions and the sector's share of all investor mentions. Each series is one sector, keyed by its name. # Get Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-sector-investor-mentions-by-id api-reference/data-api/openapi.json GET /query/timeseries/sector-investor-mentions/{granularity}/{sector} Counts of tracked investor accounts mentioning assets in a sector: distinct investors, mentions and the sector's share of all investor mentions. Each series is one sector, keyed by its name. # Batch Get Sub-Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-mindshare api-reference/data-api/openapi.json GET /query/timeseries/sub-sector-asset-mindshare/{granularity} Social mindshare aggregated over the assets in a sub-sector: total score, share of mindshare across sub-sectors and rank. Each series is one sub-sector, keyed by its name. # Get Sub-Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-mindshare-by-id api-reference/data-api/openapi.json GET /query/timeseries/sub-sector-asset-mindshare/{granularity}/{sub-sector} Social mindshare aggregated over the assets in a sub-sector: total score, share of mindshare across sub-sectors and rank. Each series is one sub-sector, keyed by its name. # Batch Get Sub-Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-sentiment api-reference/data-api/openapi.json GET /query/timeseries/sub-sector-asset-sentiment/{granularity} Social sentiment score aggregated over the assets in a sub-sector. Each series is one sub-sector, keyed by its name. # Get Sub-Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/mindshare-sentiment/timeseries-sub-sector-asset-sentiment-by-id api-reference/data-api/openapi.json GET /query/timeseries/sub-sector-asset-sentiment/{granularity}/{sub-sector} Social sentiment score aggregated over the assets in a sub-sector. Each series is one sub-sector, keyed by its name. # News Feed Source: https://docs.blockworks.com/api-reference/data-api/news/news-feed One row per news item aggregated from crypto media, keyed by documentID: title, URL, summary, image, publish time, source with its type, video, recommended and price-analysis flags, and the assets mentioned. Filter by date, source, flag or asset; sort by feedDate descending for newest first. | | | | - | - | | Access | News-dataset | | Tabular model | `news-feed`: primary key `documentID` | ## Endpoints > [card] [List News Items](/api-reference/data-api/news/tabular-news-feed) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get News Item](/api-reference/data-api/news/tabular-news-feed-by-id) > > One row by `documentID`. ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `documentID` | string | `Eq`, `IsOneOf` | | The unique identifier of the news document. (primary key) | | `title` | string | | | Title of the news article. | | `url` | string | | | URL of the news article. | | `summary` | string | | | Summary of the news article. | | `feedDate` | time | `Eq`, `Gt`, `Gte`, `Lt`, `Lte` | default | The publish date of the news article, used to order the feed. | | `publishTimeMillis` | int64 | `Gt`, `Gte`, `Lt`, `Lte` | yes | The publish time of the news article in epoch milliseconds. | | `sourceID` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The unique identifier of the news source. | | `sourceName` | string | `Eq`, `IsOneOf` | | Name of the news source. | | `sourceType` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | Type of the news source (e.g. NEWS, BLOG, FORUM, YOUTUBE_VIDEO). | | `isVideo` | bool | `Eq`, `NotEq` | | If true, the news document is a video. | | `isRecommended` | bool | `Eq`, `NotEq` | | If true, the news article is recommended. | | `isPriceAnalysis` | bool | `Eq`, `NotEq` | | If true, the news article is a price analysis. | | `ogImageURL` | string | | | URL of the Open Graph image for the news article. | | `assetIDs` | array_string | `Includes`, `NotIncludes`, `IncludesAnyOf`, `NotIncludesAnyOf` | | Asset IDs referenced by the news article. Used to filter the feed by asset. | | `assets` | array_object | | | Assets referenced by the news article, including id, slug, name, and symbol. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/news-feed?pageSize=3&selections=documentID,title,url,summary" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List News Items](/api-reference/data-api/news/tabular-news-feed) for the response and the errors. # News Source: https://docs.blockworks.com/api-reference/data-api/news/overview News: Topics, News Feed. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Topics](/api-reference/data-api/news/topics) | News-dataset | | [Batch](/api-reference/data-api/news/timeseries-trending-topics), [One series](/api-reference/data-api/news/timeseries-trending-topics-by-id) | | [News Feed](/api-reference/data-api/news/news-feed) | News-dataset | [List rows](/api-reference/data-api/news/tabular-news-feed), [One row](/api-reference/data-api/news/tabular-news-feed-by-id) | | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/news-feed?pageSize=3&selections=documentID,title,url,summary" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List News Items](/api-reference/data-api/news/tabular-news-feed) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List News Items Source: https://docs.blockworks.com/api-reference/data-api/news/tabular-news-feed api-reference/data-api/openapi.json GET /query/tabular/news-feed One row per news item aggregated from crypto media, keyed by documentID: title, URL, summary, image, publish time, source with its type, video, recommended and price-analysis flags, and the assets mentioned. Filter by date, source, flag or asset; sort by feedDate descending for newest first. # Get News Item Source: https://docs.blockworks.com/api-reference/data-api/news/tabular-news-feed-by-id api-reference/data-api/openapi.json GET /query/tabular/news-feed/{documentID} One row per news item aggregated from crypto media, keyed by documentID: title, URL, summary, image, publish time, source with its type, video, recommended and price-analysis flags, and the assets mentioned. Filter by date, source, flag or asset; sort by feedDate descending for newest first. # Batch Get Topic timeseries Source: https://docs.blockworks.com/api-reference/data-api/news/timeseries-trending-topics api-reference/data-api/openapi.json GET /query/timeseries/trending-topics/{granularity} A topic trending on X: title, summary, trending and popularity scores, sentiment, document count, classes, top documents and the assets mentioned. Each series is one topic, keyed by its topic id. # Get Topic timeseries Source: https://docs.blockworks.com/api-reference/data-api/news/timeseries-trending-topics-by-id api-reference/data-api/openapi.json GET /query/timeseries/trending-topics/{granularity}/{trending-topic-id} A topic trending on X: title, summary, trending and popularity scores, sentiment, document count, classes, top documents and the assets mentioned. Each series is one topic, keyed by its topic id. # Topics Source: https://docs.blockworks.com/api-reference/data-api/news/topics A topic trending on X: title, summary, trending and popularity scores, sentiment, document count, classes, top documents and the assets mentioned. Each series is one topic, keyed by its topic id. | | | | - | - | | Access | News-dataset | | Timeseries model | `trending-topics`: intervals `1d`, series key `trending-topic-id` (Topic ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Topic timeseries](/api-reference/data-api/news/timeseries-trending-topics) > > Up to 10 series in one request, named by Topic ID in `series`. > [card] [Get Topic timeseries](/api-reference/data-api/news/timeseries-trending-topics-by-id) > > One series over a time window, keyed by its Topic ID. ## Metrics 12 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `title` | Title | string | | The title of the topic. | | `summary` | Summary | string | | The summary of the topic. | | `content` | Content | string | | The content of the topic. | | `trending-score` | Trending Score | float64 | | The trending score of the topic. | | `popularity-score` | Popularity Score | float64 | | The popularity score of the topic. | | `average-document-timestamp` | Average Document Timestamp | time | | The average timestamp of the documents in the topic. | | `sentiment-score` | Sentiment Score | float64 | | The sentiment score of the topic. | | `document-count` | Document Count | int64 | | The number of documents in the topic. | | `classes` | Classes | array_string | | The classes the topic is categorized under. | | `top-documents` | Top Documents | array_object | | The most relevant documents within the topic, each with its type and URL. | | `asset-ids` | Asset IDs | array_string | | The unique identifiers of the assets mentioned in the topic. | | `assets` | Assets | array_object | | The assets mentioned in the topic, each with its id, slug, name and symbol. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/trending-topics/1d/?timeframe=7d&selections=title,summary" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Topic timeseries](/api-reference/data-api/news/timeseries-trending-topics-by-id) for the response and the errors. # Onchain Fundamentals Source: https://docs.blockworks.com/api-reference/data-api/onchain-fundamentals Protocol and network fundamentals, grouped by the sector each protocol competes in: projects, assets, credit, asset management, trading, payments, infrastructure and consumer. Blockchains sits on its own, above the sectors, as the network master table every other category keys back to. Within a sector each category pairs lookup tables with timeseries models keyed by the ids those tables carry, so the shape of a query is the same whichever sector it is asked of. > [card] [Blockchains](/api-reference/data-api/blockchains/overview) > > The network master table and the onchain metrics of each network: transactions, addresses, fees, revenue, DEX and perp volume, TVL, stablecoin supply, bridge flows and staking. 1 model. ## Projects > [card] [Projects](/api-reference/data-api/projects/overview) > > Projects: Projects. 3 models. > [card] [Project Financials](/api-reference/data-api/project-financials/overview) > > A project's revenue, expenses and income statement in USD, at the project level and broken down by product version, blockchain and line item. 6 models. > [card] [Real-time Buybacks](/api-reference/data-api/real-time-buybacks/overview) > > Tokens a project buys back and burns, summed over rolling 5-minute, 1-hour and 24-hour windows, in USD and in the token. 1 model. ## Assets > [card] [Tokens](/api-reference/data-api/tokens/overview) > > The token classification table and the per-deployment token series. 2 models. > [card] [Stablecoins](/api-reference/data-api/stablecoins/overview) > > Stablecoin supply, mints and burns, and where the supply sits, at four grains: token, issuer, peg currency and chain. 7 models. > [card] [Real World Assets](/api-reference/data-api/real-world-assets/overview) > > Real World Assets: RWA Spot DEX Activity. 6 models. > [card] [Tokenized Equities](/api-reference/data-api/tokenized-equities/overview) > > Tokenized stock metrics at four grains: per product (one issuer's token for one equity), per issuer, per underlying equity and per chain. 4 models. > [card] [Tokenized Commodities](/api-reference/data-api/tokenized-commodities/overview) > > Tokenized commodity metrics (onchain gold, silver, oil and others) at four grains: per product, per issuer, per underlying commodity and per chain. 4 models. > [card] [Bridged Bitcoin](/api-reference/data-api/bridged-bitcoin/overview) > > Bridged Bitcoin: Bridged Bitcoin by Chain, Bridged Bitcoin by Deployment, Bridged Bitcoin by Issuer, Bridged Bitcoin by Product. 4 models. ## Credit > [card] [Lending Protocols](/api-reference/data-api/lending-protocols/overview) > > Lending metrics at three grains: per protocol, per product deployment on one chain, and per market within a product. 8 models. > [card] [Collateralized Debt Positions (CDPs)](/api-reference/data-api/collateralized-debt-positions-cdps/overview) > > Collateralized Debt Positions (CDPs): CDP Market Balances, CDP Market Financials, CDP Market Interest Rates, CDP Market Liquidations. 4 models. > [card] [Wholesale Credit](/api-reference/data-api/wholesale-credit/overview) > > Wholesale Credit: Wholesale Credit Balances, Wholesale Credit Financials, Wholesale Credit Interest Rates. 3 models. > [card] [Peg Stability](/api-reference/data-api/peg-stability/overview) > > What holds a pegged token at its peg, at two grains: the facility that issues the token, and each token backing that facility. 2 models. ## Asset Management > [card] [Savings](/api-reference/data-api/savings/overview) > > Savings: Savings Balances, Savings Financials, Savings Performances. 3 models. > [card] [Institutional Allocators](/api-reference/data-api/institutional-allocators/overview) > > Institutional Allocators: Institutional Allocator Balances, Institutional Allocator Financials, Institutional Allocator Performances. 3 models. > [card] [Vaults](/api-reference/data-api/vaults/overview) > > Onchain vault metrics per protocol, per curator and per chain: assets under management, active vaults, gross yield, net yield paid to depositors and fees. 7 models. ## Trading > [card] [Spot DEX Protocols](/api-reference/data-api/spot-dex-protocols/overview) > > Spot DEX Protocols: Spot DEX Protocols, Spot DEX Protocols by Chain. 3 models. > [card] [Perp DEX Protocols](/api-reference/data-api/perp-dex-protocols/overview) > > Perp DEX Protocols: Perp DEX Protocols. 1 model. > [card] [DEX Aggregators](/api-reference/data-api/dex-aggregators/overview) > > Volume routed through DEX aggregators, keyed by chain, aggregator, DEX and DEX version. 1 model. ## Payments > [card] [Payment Cards](/api-reference/data-api/payment-cards/overview) > > Payment Cards: Payment Card Accounts, Payment Card Balances, Payment Card Spending. 3 models. > [card] [Agentic Payments](/api-reference/data-api/agentic-payments/overview) > > Machine-to-machine payment activity per chain, facilitator, standard and token. 1 model. ## Infrastructure > [card] [Bridge Protocols](/api-reference/data-api/bridge-protocols/overview) > > Bridge Protocols: Bridge Protocols, Bridge Protocols by Network. 2 models. > [card] [Centralized Finance](/api-reference/data-api/centralized-finance/overview) > > What centralized venues hold onchain and what moves in and out, per token per chain. 1 model. > [card] [Privacy](/api-reference/data-api/privacy/overview) > > Privacy: Privacy Flows and Balances. 1 model. ## Consumer > [card] [Launchpads](/api-reference/data-api/launchpads/overview) > > Token launchpad metrics per launchpad and per chain: tokens launched, volume and trades of launched tokens, bonding-curve activity, creator fees and revenue. 2 models. > [card] [TCG Platforms](/api-reference/data-api/tcg-platforms/overview) > > Trading card and collectibles platform metrics per platform on one blockchain: revenue and expenses, gross merchandise value, marketplace volume, sales and buyers. 3 models. # Payment Cards Source: https://docs.blockworks.com/api-reference/data-api/payment-cards/overview Payment Cards: Payment Card Accounts, Payment Card Balances, Payment Card Spending. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Payment Card Accounts](/api-reference/data-api/payment-cards/payment-card-accounts) | Lending-protocols-dataset | [List rows](/api-reference/data-api/payment-cards/tabular-payment-card-accounts) | [Batch](/api-reference/data-api/payment-cards/timeseries-payment-card-accounts), [One series](/api-reference/data-api/payment-cards/timeseries-payment-card-accounts-by-id) | | [Payment Card Balances](/api-reference/data-api/payment-cards/payment-card-balances) | Lending-protocols-dataset | [List rows](/api-reference/data-api/payment-cards/tabular-payment-card-balances) | [Batch](/api-reference/data-api/payment-cards/timeseries-payment-card-balances), [One series](/api-reference/data-api/payment-cards/timeseries-payment-card-balances-by-id) | | [Payment Card Spending](/api-reference/data-api/payment-cards/payment-card-spending) | Lending-protocols-dataset | [List rows](/api-reference/data-api/payment-cards/tabular-payment-card-spending) | [Batch](/api-reference/data-api/payment-cards/timeseries-payment-card-spending), [One series](/api-reference/data-api/payment-cards/timeseries-payment-card-spending-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/payment-card-accounts?pageSize=3&selections=id,name,slug,parentSlug" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Payment Card Accounts](/api-reference/data-api/payment-cards/tabular-payment-card-accounts) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Payment Card Accounts Source: https://docs.blockworks.com/api-reference/data-api/payment-cards/payment-card-accounts Activity of crypto card programs on each chain: accounts created, activated and active, spenders (daily, 7-day and 30-day, new and returning), spend in USD split by new, returning and top spenders, refunds, cashback, deposits and withdrawals, holders by balance size, balances held and 7-day and 30-day spender churn. Each series is one card program on one chain. One row per payment card account, keyed by protocol, chain and card program: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the payment-card-accounts timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `payment-card-accounts`: primary key `id` | | Timeseries model | `payment-card-accounts`: intervals `1d`, series key `id` (Payment Card Account ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Payment Card Accounts](/api-reference/data-api/payment-cards/tabular-payment-card-accounts) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Payment Card Account timeseries](/api-reference/data-api/payment-cards/timeseries-payment-card-accounts) > > Up to 10 series in one request, named by Payment Card Account ID in `series`. > [card] [Get Payment Card Account timeseries](/api-reference/data-api/payment-cards/timeseries-payment-card-accounts-by-id) > > One series over a time window, keyed by its Payment Card Account ID. ## Metrics 36 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `accountsCreated` | Accounts Created | float64 | | Card accounts created that day. | | `activeAccounts` | Active Accounts | float64 | | Card accounts active that day. | | `accountsActivated` | Accounts Activated | float64 | | Card accounts activated that day. | | `uniqueSpenders` | Unique Spenders | float64 | | Distinct accounts that spent that day. | | `newSpenders` | New Spenders | float64 | | Accounts whose first spend was that day. | | `uniqueSpenders7D` | Unique Spenders (7D) | float64 | | Distinct spenders over the 7 days ending that day. | | `uniqueSpenders30D` | Unique Spenders (30D) | float64 | | Distinct spenders over the 30 days ending that day. | | `activeAccounts7D` | Active Accounts (7D) | float64 | | Distinct active accounts over the 7 days ending that day. | | `activeAccounts30D` | Active Accounts (30D) | float64 | | Distinct active accounts over the 30 days ending that day. | | `spendUSD` | Spend (USD) | float64 | | Card spend in USD. | | `spendNewUSD` | New Spender Spend (USD) | float64 | | Spend by new spenders in USD. | | `spendReturningUSD` | Returning Spender Spend (USD) | float64 | | Spend by returning spenders in USD. | | `medianSpendUSD` | Median Spend (USD) | float64 | | Median spend in USD. | | `spendTop1PctUSD` | Top 1% Spend (USD) | float64 | | Spend of the top 1% of spenders that day in USD. | | `spendTop10PctUSD` | Top 10% Spend (USD) | float64 | | Spend of the top 10% of spenders that day in USD (includes the top 1%). | | `spendTop1Pct7DUSD` | Top 1% Spend (7D, USD) | float64 | | Spend of the top 1% of spenders over 7 days in USD. | | `spendTop10Pct7DUSD` | Top 10% Spend (7D, USD) | float64 | | Spend of the top 10% of spenders over 7 days in USD. | | `spendTop1Pct30DUSD` | Top 1% Spend (30D, USD) | float64 | | Spend of the top 1% of spenders over 30 days in USD. | | `spendTop10Pct30DUSD` | Top 10% Spend (30D, USD) | float64 | | Spend of the top 10% of spenders over 30 days in USD. | | `refundUSD` | Refunds (USD) | float64 | | Refunds in USD. | | `cashbackUSD` | Cashback (USD) | float64 | | Cashback paid in USD. | | `depositUSD` | Deposits (USD) | float64 | | Deposits into card accounts in USD. | | `withdrawalUSD` | Withdrawals (USD) | float64 | | Withdrawals from card accounts in USD. | | `holders` | Holders | float64 | | Accounts holding \$1 or more. | | `holdersOver100USD` | Holders (\$100+) | float64 | | Accounts holding \$100 or more across tokens. | | `holdersOver1kUSD` | Holders (\$1k+) | float64 | | Accounts holding \$1,000 or more across tokens. | | `holdersOver10kUSD` | Holders (\$10k+) | float64 | | Accounts holding \$10,000 or more across tokens. | | `totalBalanceUSD` | Total Balance (USD) | float64 | | Balance held in card accounts in USD (holder subtypes only). | | `avgBalanceUSD` | Average Balance (USD) | float64 | | Average balance per holder in USD. | | `medianBalanceUSD` | Median Balance (USD) | float64 | | Median balance per holder in USD. | | `returningSpenders7D` | Returning Spenders (7D) | float64 | | Spenders in the 7-day window whose first spend came before it. | | `returningSpenders30D` | Returning Spenders (30D) | float64 | | Spenders in the 30-day window whose first spend came before it. | | `priorSpenders7D` | Prior Spenders (7D) | float64 | | Unique spenders over the 7 days ending 7 days earlier. | | `priorSpenders30D` | Prior Spenders (30D) | float64 | | Unique spenders over the 30 days ending 30 days earlier. | | `netChurn7D` | Net Churn (7D) | float64 | | One minus returning spenders over prior spenders for the 7-day window, as a decimal. | | `netChurn30D` | Net Churn (30D) | float64 | | One minus returning spenders over prior spenders for the 30-day window, as a decimal. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the payment-card-accounts timeseries model, the parent slug, chain and program id, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the card program. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol. | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain (ethereum, base, solana). | | `programID` | string | `Eq`, `IsOneOf` | | The card program's identifier. | | `programName` | string | `Eq`, `IsOneOf`, `Contains` | | The card program's display name (for example ether.fi Cash). | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/payment-card-accounts/1d/?timeframe=7d&selections=accountsCreated,activeAccounts" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Payment Card Account timeseries](/api-reference/data-api/payment-cards/timeseries-payment-card-accounts-by-id) for the response and the errors. # Payment Card Balances Source: https://docs.blockworks.com/api-reference/data-api/payment-cards/payment-card-balances End-of-day balances held in crypto card accounts, in USD, with holder counts and the average and median balance per holder. Each series is one card program token balance, keyed by protocol, chain, card program, token and where the balance sits (card account, lending, locked or linked account). Flow fields are null until the source carries flows by token. One row per payment card balance, keyed by protocol, chain, card program, token and balance subtype: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the payment-card-balances timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `payment-card-balances`: primary key `id` | | Timeseries model | `payment-card-balances`: intervals `1d`, series key `id` (Payment Card Balance ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Payment Card Balances](/api-reference/data-api/payment-cards/tabular-payment-card-balances) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Payment Card Balance timeseries](/api-reference/data-api/payment-cards/timeseries-payment-card-balances) > > Up to 10 series in one request, named by Payment Card Balance ID in `series`. > [card] [Get Payment Card Balance timeseries](/api-reference/data-api/payment-cards/timeseries-payment-card-balances-by-id) > > One series over a time window, keyed by its Payment Card Balance ID. ## Metrics 7 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `balanceUSD` | Balance (USD) | float64 | | Balance in USD. | | `grossInflowUSD` | Gross Inflow (USD) | float64 | | Gross inflow in USD (NULL until bwr carries flows by token). | | `grossOutflowUSD` | Gross Outflow (USD) | float64 | | Gross outflow in USD (NULL until bwr carries flows by token). | | `netFlowUSD` | Net Flow (USD) | float64 | | Net flow in USD (NULL until bwr carries flows by token). | | `holders` | Holders | float64 | | Accounts holding \$1 or more. | | `avgBalanceUSD` | Average Balance (USD) | float64 | | Average balance per holder in USD. | | `medianBalanceUSD` | Median Balance (USD) | float64 | | Median balance per holder in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the payment-card-balances timeseries model, the parent slug, chain, program id, token address and balance subtype, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the balance, the card program name, token symbol and balance subtype. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol. | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain (ethereum, base, solana). | | `programID` | string | `Eq`, `IsOneOf` | | The card program's identifier. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `balanceSubtype` | string | `Eq`, `IsOneOf` | | Where the balance sits (card_account, lending, locked or linked_account). | | `programName` | string | `Eq`, `IsOneOf`, `Contains` | | The card program's display name (for example ether.fi Cash). | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/payment-card-balances/1d/?timeframe=7d&selections=balanceUSD,grossInflowUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Payment Card Balance timeseries](/api-reference/data-api/payment-cards/timeseries-payment-card-balances-by-id) for the response and the errors. # Payment Card Spending Source: https://docs.blockworks.com/api-reference/data-api/payment-cards/payment-card-spending Crypto card spend, refunds and cashback per card program, chain and token: spend count and spend in USD split into credit and debit, spenders, median spend, and spend and count by transaction size bracket. Each series is one card program token, keyed by protocol, chain, card program and token. One row per payment card spending, keyed by protocol, chain, card program and token: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the payment-card-spending timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `payment-card-spending`: primary key `id` | | Timeseries model | `payment-card-spending`: intervals `1d`, series key `id` (Payment Card Spending ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Payment Card Spending](/api-reference/data-api/payment-cards/tabular-payment-card-spending) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Payment Card Spending timeseries](/api-reference/data-api/payment-cards/timeseries-payment-card-spending) > > Up to 10 series in one request, named by Payment Card Spending ID in `series`. > [card] [Get Payment Card Spending timeseries](/api-reference/data-api/payment-cards/timeseries-payment-card-spending-by-id) > > One series over a time window, keyed by its Payment Card Spending ID. ## Metrics 29 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `spendCount` | Spend Count | float64 | | Spend count, in the program settlement unit. | | `spendCountCredit` | Credit Spend Count | float64 | | Credit spend count. | | `spendCountDebit` | Debit Spend Count | float64 | | Debit spend count. | | `spendUSD` | Spend (USD) | float64 | | Card spend in USD. | | `spendCreditUSD` | Credit Spend (USD) | float64 | | Credit card spend in USD. | | `spendDebitUSD` | Debit Spend (USD) | float64 | | Debit card spend in USD. | | `refundCount` | Refund Count | float64 | | Refund count. | | `refundUSD` | Refunds (USD) | float64 | | Refunds in USD. | | `cashbackUSD` | Cashback (USD) | float64 | | Cashback paid in USD. | | `spenders` | Spenders | float64 | | Distinct spenders. | | `medianSpendUSD` | Median Spend (USD) | float64 | | Median spend in USD. | | `spend0To10USD` | Spend $0 to $10 (USD) | float64 | | Spend in USD in the $0 to $10 bracket. | | `spend10To25USD` | Spend $10 to $25 (USD) | float64 | | Spend in USD in the $10 to $25 bracket. | | `spend25To50USD` | Spend $25 to $50 (USD) | float64 | | Spend in USD in the $25 to $50 bracket. | | `spend50To100USD` | Spend $50 to $100 (USD) | float64 | | Spend in USD in the $50 to $100 bracket. | | `spend100To250USD` | Spend $100 to $250 (USD) | float64 | | Spend in USD in the $100 to $250 bracket. | | `spend250To500USD` | Spend $250 to $500 (USD) | float64 | | Spend in USD in the $250 to $500 bracket. | | `spend500To1000USD` | Spend $500 to $1,000 (USD) | float64 | | Spend in USD in the $500 to $1,000 bracket. | | `spend1000To5000USD` | Spend $1,000 to $5,000 (USD) | float64 | | Spend in USD in the $1,000 to $5,000 bracket. | | `spend5000PlusUSD` | Spend \$5,000 and Over (USD) | float64 | | Spend in USD in the \$5,000 and over bracket. | | `spendCount0To10` | Spend Count $0 to $10 | float64 | | Spend count in the $0 to $10 bracket. | | `spendCount10To25` | Spend Count $10 to $25 | float64 | | Spend count in the $10 to $25 bracket. | | `spendCount25To50` | Spend Count $25 to $50 | float64 | | Spend count in the $25 to $50 bracket. | | `spendCount50To100` | Spend Count $50 to $100 | float64 | | Spend count in the $50 to $100 bracket. | | `spendCount100To250` | Spend Count $100 to $250 | float64 | | Spend count in the $100 to $250 bracket. | | `spendCount250To500` | Spend Count $250 to $500 | float64 | | Spend count in the $250 to $500 bracket. | | `spendCount500To1000` | Spend Count $500 to $1,000 | float64 | | Spend count in the $500 to $1,000 bracket. | | `spendCount1000To5000` | Spend Count $1,000 to $5,000 | float64 | | Spend count in the $1,000 to $5,000 bracket. | | `spendCount5000Plus` | Spend Count \$5,000 and Over | float64 | | Spend count in the \$5,000 and over bracket. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the payment-card-spending timeseries model, the parent slug, chain, program id and token address, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the card program name and token symbol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol. | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain (ethereum, base, solana). | | `programID` | string | `Eq`, `IsOneOf` | | The card program's identifier. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `programName` | string | `Eq`, `IsOneOf`, `Contains` | | The card program's display name (for example ether.fi Cash). | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/payment-card-spending/1d/?timeframe=7d&selections=spendCount,spendCountCredit" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Payment Card Spending timeseries](/api-reference/data-api/payment-cards/timeseries-payment-card-spending-by-id) for the response and the errors. # List Payment Card Accounts Source: https://docs.blockworks.com/api-reference/data-api/payment-cards/tabular-payment-card-accounts api-reference/data-api/openapi.json GET /query/tabular/payment-card-accounts One row per payment card account, keyed by protocol, chain and card program: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the payment-card-accounts timeseries model. # List Payment Card Balances Source: https://docs.blockworks.com/api-reference/data-api/payment-cards/tabular-payment-card-balances api-reference/data-api/openapi.json GET /query/tabular/payment-card-balances One row per payment card balance, keyed by protocol, chain, card program, token and balance subtype: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the payment-card-balances timeseries model. # List Payment Card Spending Source: https://docs.blockworks.com/api-reference/data-api/payment-cards/tabular-payment-card-spending api-reference/data-api/openapi.json GET /query/tabular/payment-card-spending One row per payment card spending, keyed by protocol, chain, card program and token: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the payment-card-spending timeseries model. # Batch Get Payment Card Account timeseries Source: https://docs.blockworks.com/api-reference/data-api/payment-cards/timeseries-payment-card-accounts api-reference/data-api/openapi.json GET /query/timeseries/payment-card-accounts/{granularity} Activity of crypto card programs on each chain: accounts created, activated and active, spenders (daily, 7-day and 30-day, new and returning), spend in USD split by new, returning and top spenders, refunds, cashback, deposits and withdrawals, holders by balance size, balances held and 7-day and 30-day spender churn. Each series is one card program on one chain. # Get Payment Card Account timeseries Source: https://docs.blockworks.com/api-reference/data-api/payment-cards/timeseries-payment-card-accounts-by-id api-reference/data-api/openapi.json GET /query/timeseries/payment-card-accounts/{granularity}/{id} Activity of crypto card programs on each chain: accounts created, activated and active, spenders (daily, 7-day and 30-day, new and returning), spend in USD split by new, returning and top spenders, refunds, cashback, deposits and withdrawals, holders by balance size, balances held and 7-day and 30-day spender churn. Each series is one card program on one chain. # Batch Get Payment Card Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/payment-cards/timeseries-payment-card-balances api-reference/data-api/openapi.json GET /query/timeseries/payment-card-balances/{granularity} End-of-day balances held in crypto card accounts, in USD, with holder counts and the average and median balance per holder. Each series is one card program token balance, keyed by protocol, chain, card program, token and where the balance sits (card account, lending, locked or linked account). Flow fields are null until the source carries flows by token. # Get Payment Card Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/payment-cards/timeseries-payment-card-balances-by-id api-reference/data-api/openapi.json GET /query/timeseries/payment-card-balances/{granularity}/{id} End-of-day balances held in crypto card accounts, in USD, with holder counts and the average and median balance per holder. Each series is one card program token balance, keyed by protocol, chain, card program, token and where the balance sits (card account, lending, locked or linked account). Flow fields are null until the source carries flows by token. # Batch Get Payment Card Spending timeseries Source: https://docs.blockworks.com/api-reference/data-api/payment-cards/timeseries-payment-card-spending api-reference/data-api/openapi.json GET /query/timeseries/payment-card-spending/{granularity} Crypto card spend, refunds and cashback per card program, chain and token: spend count and spend in USD split into credit and debit, spenders, median spend, and spend and count by transaction size bracket. Each series is one card program token, keyed by protocol, chain, card program and token. # Get Payment Card Spending timeseries Source: https://docs.blockworks.com/api-reference/data-api/payment-cards/timeseries-payment-card-spending-by-id api-reference/data-api/openapi.json GET /query/timeseries/payment-card-spending/{granularity}/{id} Crypto card spend, refunds and cashback per card program, chain and token: spend count and spend in USD split into credit and debit, spenders, median spend, and spend and count by transaction size bracket. Each series is one card program token, keyed by protocol, chain, card program and token. # Peg Stability Source: https://docs.blockworks.com/api-reference/data-api/peg-stability/overview What holds a pegged token at its peg, at two grains: the facility that issues the token, and each token backing that facility. Facility series carry the amount issued, the premint buffer, the issuance cap, mints, redemptions and net issuance; backing series carry what each backing token is worth. Both are keyed by protocol, chain and facility. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Peg Stability Backings](/api-reference/data-api/peg-stability/peg-stability-backings) | Stablecoins-dataset | [List rows](/api-reference/data-api/peg-stability/tabular-peg-stability-backings) | [Batch](/api-reference/data-api/peg-stability/timeseries-peg-stability-backings), [One series](/api-reference/data-api/peg-stability/timeseries-peg-stability-backings-by-id) | | [Peg Stability Facilities](/api-reference/data-api/peg-stability/peg-stability-facilities) | Stablecoins-dataset | [List rows](/api-reference/data-api/peg-stability/tabular-peg-stability-facilities) | [Batch](/api-reference/data-api/peg-stability/timeseries-peg-stability-facilities), [One series](/api-reference/data-api/peg-stability/timeseries-peg-stability-facilities-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/peg-stability-backings?pageSize=3&selections=id,name,slug,parentSlug" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Peg Stability Backings](/api-reference/data-api/peg-stability/tabular-peg-stability-backings) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Peg Stability Backings Source: https://docs.blockworks.com/api-reference/data-api/peg-stability/peg-stability-backings Daily backing in USD held by one peg stability facility in one backing token (USDC, USDT and other stablecoins, or the RWA an ilk holds). Each series is one facility backing token, keyed by protocol, chain, facility and token. One row per peg stability facility backing token, keyed by protocol, chain, facility and token: the parent protocol and product, chain, facility, token and the mapped protocol, project and network records. The id is the series key of the peg-stability-backings timeseries model. | | | | - | - | | Access | Stablecoins-dataset | | Tabular model | `peg-stability-backings`: primary key `id` | | Timeseries model | `peg-stability-backings`: intervals `1d`, series key `id` (Peg Stability Backing ID), every series available in one call | ## Endpoints > [card] [List Peg Stability Backings](/api-reference/data-api/peg-stability/tabular-peg-stability-backings) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Peg Stability Backing timeseries](/api-reference/data-api/peg-stability/timeseries-peg-stability-backings) > > Up to 10 series in one request, named by series key in `series`. > [card] [Get Peg Stability Backing timeseries](/api-reference/data-api/peg-stability/timeseries-peg-stability-backings-by-id) > > One series over a time window, keyed by its Peg Stability Backing ID. ## Metrics 1 metric. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `backingUSD` | | | | | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `chain` | string | | | The short name of the chain (ethereum, base, solana). | | `facilityID` | string | | | The facility's identifier within its protocol (a Maker-style ilk for Sky and USDD, the PegKeeper address for Curve). | | `facilityName` | string | | | The facility's display name. | | `id` | string | | | The series key of the peg-stability-backings timeseries model, the parent slug, chain, facility id and token address, joined with underscores. | | `name` | string | | | The display name of the series, the facility name and backing token symbol. | | `networkID` | string | | | The chain's networkID in the blockchains model; null when unmapped. | | `parentSlug` | string | | | The parent protocol's short name. | | `productSlug` | string | | | The product or version within the parent protocol. | | `projectID` | string | | | The identifier of the parent protocol's project record; null when unmapped. | | `protocolName` | string | | | The name of the protocol record mapped to the product; null when unmapped. | | `protocolSlug` | string | | | The slug of the protocol record mapped to the product; null when unmapped. | | `slug` | string | | | The parent protocol's project slug, the slug used for the same protocol across the API; null when unmapped. | | `tokenAddress` | string | | | The token contract address (the mint address on Solana); null when unlabeled. | | `tokenSymbol` | string | | | The token's ticker symbol. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/peg-stability-backings/1d/?timeframe=7d&selections=backingUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Peg Stability Backing timeseries](/api-reference/data-api/peg-stability/timeseries-peg-stability-backings-by-id) for the response and the errors. # Peg Stability Facilities Source: https://docs.blockworks.com/api-reference/data-api/peg-stability/peg-stability-facilities Daily state of one peg stability facility (PSMs, RWA reserve ilks, crvUSD PegKeepers) in USD of the pegged token it issues: amount issued, premint buffer, issuance cap, and the day's mints, redemptions and net issuance. Each series is one facility, keyed by protocol, chain and facility. One row per peg stability facility, keyed by protocol, chain and facility: the parent protocol and product, chain, facility, pegged token and the mapped protocol, project and network records. The id is the series key of the peg-stability-facilities timeseries model. | | | | - | - | | Access | Stablecoins-dataset | | Tabular model | `peg-stability-facilities`: primary key `id` | | Timeseries model | `peg-stability-facilities`: intervals `1d`, series key `id` (Peg Stability Facility ID), every series available in one call | ## Endpoints > [card] [List Peg Stability Facilities](/api-reference/data-api/peg-stability/tabular-peg-stability-facilities) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Peg Stability Facility timeseries](/api-reference/data-api/peg-stability/timeseries-peg-stability-facilities) > > Up to 10 series in one request, named by series key in `series`. > [card] [Get Peg Stability Facility timeseries](/api-reference/data-api/peg-stability/timeseries-peg-stability-facilities-by-id) > > One series over a time window, keyed by its Peg Stability Facility ID. ## Metrics 6 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `issuedUSD` | | | | | | `premintBufferUSD` | | | | | | `issuanceCapUSD` | | | | | | `mintedUSD` | | | | | | `redeemedUSD` | | | | | | `netIssuanceUSD` | | | | | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `chain` | string | | | The short name of the chain (ethereum, base, solana). | | `facilityID` | string | | | The facility's identifier within its protocol (a Maker-style ilk for Sky and USDD, the PegKeeper address for Curve). | | `facilityName` | string | | | The facility's display name. | | `id` | string | | | The series key of the peg-stability-facilities timeseries model, the parent slug, chain and facility id, joined with underscores. | | `name` | string | | | The display name of the series, the facility name. | | `networkID` | string | | | The chain's networkID in the blockchains model; null when unmapped. | | `parentSlug` | string | | | The parent protocol's short name. | | `productSlug` | string | | | The product or version within the parent protocol. | | `projectID` | string | | | The identifier of the parent protocol's project record; null when unmapped. | | `protocolName` | string | | | The name of the protocol record mapped to the product; null when unmapped. | | `protocolSlug` | string | | | The slug of the protocol record mapped to the product; null when unmapped. | | `slug` | string | | | The parent protocol's project slug, the slug used for the same protocol across the API; null when unmapped. | | `tokenSymbol` | string | | | The token's ticker symbol. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/peg-stability-facilities/1d/?timeframe=7d&selections=issuedUSD,premintBufferUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Peg Stability Facility timeseries](/api-reference/data-api/peg-stability/timeseries-peg-stability-facilities-by-id) for the response and the errors. # List Peg Stability Backings Source: https://docs.blockworks.com/api-reference/data-api/peg-stability/tabular-peg-stability-backings api-reference/data-api/openapi.json GET /query/tabular/peg-stability-backings One row per peg stability facility backing token, keyed by protocol, chain, facility and token: the parent protocol and product, chain, facility, token and the mapped protocol, project and network records. The id is the series key of the peg-stability-backings timeseries model. # List Peg Stability Facilities Source: https://docs.blockworks.com/api-reference/data-api/peg-stability/tabular-peg-stability-facilities api-reference/data-api/openapi.json GET /query/tabular/peg-stability-facilities One row per peg stability facility, keyed by protocol, chain and facility: the parent protocol and product, chain, facility, pegged token and the mapped protocol, project and network records. The id is the series key of the peg-stability-facilities timeseries model. # Batch Get Peg Stability Backing timeseries Source: https://docs.blockworks.com/api-reference/data-api/peg-stability/timeseries-peg-stability-backings api-reference/data-api/openapi.json GET /query/timeseries/peg-stability-backings/{granularity} Daily backing in USD held by one peg stability facility in one backing token (USDC, USDT and other stablecoins, or the RWA an ilk holds). Each series is one facility backing token, keyed by protocol, chain, facility and token. # Get Peg Stability Backing timeseries Source: https://docs.blockworks.com/api-reference/data-api/peg-stability/timeseries-peg-stability-backings-by-id api-reference/data-api/openapi.json GET /query/timeseries/peg-stability-backings/{granularity}/{id} Daily backing in USD held by one peg stability facility in one backing token (USDC, USDT and other stablecoins, or the RWA an ilk holds). Each series is one facility backing token, keyed by protocol, chain, facility and token. # Batch Get Peg Stability Facility timeseries Source: https://docs.blockworks.com/api-reference/data-api/peg-stability/timeseries-peg-stability-facilities api-reference/data-api/openapi.json GET /query/timeseries/peg-stability-facilities/{granularity} Daily state of one peg stability facility (PSMs, RWA reserve ilks, crvUSD PegKeepers) in USD of the pegged token it issues: amount issued, premint buffer, issuance cap, and the day's mints, redemptions and net issuance. Each series is one facility, keyed by protocol, chain and facility. # Get Peg Stability Facility timeseries Source: https://docs.blockworks.com/api-reference/data-api/peg-stability/timeseries-peg-stability-facilities-by-id api-reference/data-api/openapi.json GET /query/timeseries/peg-stability-facilities/{granularity}/{id} Daily state of one peg stability facility (PSMs, RWA reserve ilks, crvUSD PegKeepers) in USD of the pegged token it issues: amount issued, premint buffer, issuance cap, and the day's mints, redemptions and net issuance. Each series is one facility, keyed by protocol, chain and facility. # Perp DEX Protocols Source: https://docs.blockworks.com/api-reference/data-api/perp-dex-protocols/overview Perp DEX Protocols: Perp DEX Protocols. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Perp DEX Protocols](/api-reference/data-api/perp-dex-protocols/perp-dex-protocols) | Perp-dex-protocols-dataset | [List rows](/api-reference/data-api/perp-dex-protocols/tabular-perp-dex-protocols) | [Batch](/api-reference/data-api/perp-dex-protocols/timeseries-perp-dex-protocols), [One series](/api-reference/data-api/perp-dex-protocols/timeseries-perp-dex-protocols-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/perp-dex-protocols?pageSize=3&selections=id,slug,name,projectID" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Perp DEX Protocols](/api-reference/data-api/perp-dex-protocols/tabular-perp-dex-protocols) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Perp DEX Protocols Source: https://docs.blockworks.com/api-reference/data-api/perp-dex-protocols/perp-dex-protocols Perpetual futures DEX metrics for a protocol: volume, open interest, trades, liquidations and active markets, with breakdowns by market category, core versus builder-deployed markets and major USD pairs. Each series is one protocol, keyed by its slug. Most protocols populate only part of the columns, so pass selections. One row per perpetual futures decentralized exchange, keyed by its short name: name, project slug and project id. The id is the series key of the perp-dex-protocols timeseries model. | | | | - | - | | Access | Perp-dex-protocols-dataset | | Tabular model | `perp-dex-protocols`: primary key `id`, identifiers `slug` | | Timeseries model | `perp-dex-protocols`: intervals `1d`, series key `id` (Project ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Perp DEX Protocols](/api-reference/data-api/perp-dex-protocols/tabular-perp-dex-protocols) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Perp DEX Protocol timeseries](/api-reference/data-api/perp-dex-protocols/timeseries-perp-dex-protocols) > > Up to 10 series in one request, named by Project ID in `series`. > [card] [Get Perp DEX Protocol timeseries](/api-reference/data-api/perp-dex-protocols/timeseries-perp-dex-protocols-by-id) > > One series over a time window, keyed by its Project ID. ## Metrics 96 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `volumeUSD` | Volume (USD) | float64 | | Total perp trading volume in USD. | | `openInterestUSD` | Open Interest (USD) | float64 | | Total open interest in USD. | | `tradeCount` | Trade Count | float64 | | Total trade count. | | `liquidationVolumeUSD` | Liquidation Volume (USD) | float64 | | Total liquidation volume in USD. | | `liquidationCount` | Liquidation Count | float64 | | Total liquidation count. | | `marketCount` | Market Count | float64 | | Number of markets with activity. | | `marketLevelVolumeUSD` | Market-Level Volume (USD) | float64 | | Perp trading volume in USD, aggregated from individual labeled markets. | | `marketLevelOpenInterestUSD` | Market-Level Open Interest (USD) | float64 | | Open interest in USD, aggregated from individual labeled markets. | | `marketLevelTradeCount` | Market-Level Trade Count | float64 | | Trade count, aggregated from individual labeled markets. | | `marketLevelLiquidationVolumeUSD` | Market-Level Liquidation Volume (USD) | float64 | | Liquidation volume in USD, aggregated from individual labeled markets. | | `marketLevelLiquidationCount` | Market-Level Liquidation Count | float64 | | Liquidation count, aggregated from individual labeled markets. | | `hip3VolumeUSD` | HIP-3 Volume (USD) | float64 | | HIP-3 (builder-deployed) market perp trading volume in USD. | | `hip3OpenInterestUSD` | HIP-3 Open Interest (USD) | float64 | | HIP-3 (builder-deployed) market open interest in USD. | | `hip3TradeCount` | HIP-3 Trade Count | float64 | | HIP-3 (builder-deployed) market trade count. | | `hip3LiquidationVolumeUSD` | HIP-3 Liquidation Volume (USD) | float64 | | HIP-3 (builder-deployed) market liquidation volume in USD. | | `hip3LiquidationCount` | HIP-3 Liquidation Count | float64 | | HIP-3 (builder-deployed) market liquidation count. | | `coreVolumeUSD` | Core Volume (USD) | float64 | | Core (non-HIP-3) market perp trading volume in USD. | | `coreOpenInterestUSD` | Core Open Interest (USD) | float64 | | Core (non-HIP-3) market open interest in USD. | | `coreTradeCount` | Core Trade Count | float64 | | Core (non-HIP-3) market trade count. | | `coreLiquidationVolumeUSD` | Core Liquidation Volume (USD) | float64 | | Core (non-HIP-3) market liquidation volume in USD. | | `coreLiquidationCount` | Core Liquidation Count | float64 | | Core (non-HIP-3) market liquidation count. | | `categoryBondVolumeUSD` | Bond Volume (USD) | float64 | | Bond-market perp trading volume in USD. | | `categoryCommodityVolumeUSD` | Commodity Volume (USD) | float64 | | Commodity-market perp trading volume in USD. | | `categoryCryptoVolumeUSD` | Crypto Volume (USD) | float64 | | Crypto-market perp trading volume in USD. | | `categoryFXVolumeUSD` | FX Volume (USD) | float64 | | FX-market perp trading volume in USD. | | `categoryIndexVolumeUSD` | Index Volume (USD) | float64 | | Index-market perp trading volume in USD. | | `categoryPreIPOVolumeUSD` | Pre-IPO Volume (USD) | float64 | | Pre-IPO-market perp trading volume in USD. | | `categoryStockVolumeUSD` | Stock Volume (USD) | float64 | | Stock-market perp trading volume in USD. | | `categoryRWAVolumeUSD` | RWA Volume (USD) | float64 | | RWA-market perp trading volume in USD. | | `categoryBondOpenInterestUSD` | Bond Open Interest (USD) | float64 | | Bond-market open interest in USD. | | `categoryCommodityOpenInterestUSD` | Commodity Open Interest (USD) | float64 | | Commodity-market open interest in USD. | | `categoryCryptoOpenInterestUSD` | Crypto Open Interest (USD) | float64 | | Crypto-market open interest in USD. | | `categoryFXOpenInterestUSD` | FX Open Interest (USD) | float64 | | FX-market open interest in USD. | | `categoryIndexOpenInterestUSD` | Index Open Interest (USD) | float64 | | Index-market open interest in USD. | | `categoryPreIPOOpenInterestUSD` | Pre-IPO Open Interest (USD) | float64 | | Pre-IPO-market open interest in USD. | | `categoryStockOpenInterestUSD` | Stock Open Interest (USD) | float64 | | Stock-market open interest in USD. | | `categoryRWAOpenInterestUSD` | RWA Open Interest (USD) | float64 | | RWA-market open interest in USD. | | `categoryBondTradeCount` | Bond Trade Count | float64 | | Bond-market trade count. | | `categoryCommodityTradeCount` | Commodity Trade Count | float64 | | Commodity-market trade count. | | `categoryCryptoTradeCount` | Crypto Trade Count | float64 | | Crypto-market trade count. | | `categoryFXTradeCount` | FX Trade Count | float64 | | FX-market trade count. | | `categoryIndexTradeCount` | Index Trade Count | float64 | | Index-market trade count. | | `categoryPreIPOTradeCount` | Pre-IPO Trade Count | float64 | | Pre-IPO-market trade count. | | `categoryStockTradeCount` | Stock Trade Count | float64 | | Stock-market trade count. | | `categoryRWATradeCount` | RWA Trade Count | float64 | | RWA-market trade count. | | `categoryBondLiquidationVolumeUSD` | Bond Liquidation Volume (USD) | float64 | | Bond-market liquidation volume in USD. | | `categoryCommodityLiquidationVolumeUSD` | Commodity Liquidation Volume (USD) | float64 | | Commodity-market liquidation volume in USD. | | `categoryCryptoLiquidationVolumeUSD` | Crypto Liquidation Volume (USD) | float64 | | Crypto-market liquidation volume in USD. | | `categoryFXLiquidationVolumeUSD` | FX Liquidation Volume (USD) | float64 | | FX-market liquidation volume in USD. | | `categoryIndexLiquidationVolumeUSD` | Index Liquidation Volume (USD) | float64 | | Index-market liquidation volume in USD. | | `categoryPreIPOLiquidationVolumeUSD` | Pre-IPO Liquidation Volume (USD) | float64 | | Pre-IPO-market liquidation volume in USD. | | `categoryStockLiquidationVolumeUSD` | Stock Liquidation Volume (USD) | float64 | | Stock-market liquidation volume in USD. | | `categoryRWALiquidationVolumeUSD` | RWA Liquidation Volume (USD) | float64 | | RWA-market liquidation volume in USD. | | `categoryBondLiquidationCount` | Bond Liquidation Count | float64 | | Bond-market liquidation count. | | `categoryCommodityLiquidationCount` | Commodity Liquidation Count | float64 | | Commodity-market liquidation count. | | `categoryCryptoLiquidationCount` | Crypto Liquidation Count | float64 | | Crypto-market liquidation count. | | `categoryFXLiquidationCount` | FX Liquidation Count | float64 | | FX-market liquidation count. | | `categoryIndexLiquidationCount` | Index Liquidation Count | float64 | | Index-market liquidation count. | | `categoryPreIPOLiquidationCount` | Pre-IPO Liquidation Count | float64 | | Pre-IPO-market liquidation count. | | `categoryStockLiquidationCount` | Stock Liquidation Count | float64 | | Stock-market liquidation count. | | `categoryRWALiquidationCount` | RWA Liquidation Count | float64 | | RWA-market liquidation count. | | `pairBitcoinUSDVolumeUSD` | BTC/USD Volume (USD) | float64 | | BTC/USD market perp trading volume in USD. | | `pairEthereumUSDVolumeUSD` | ETH/USD Volume (USD) | float64 | | ETH/USD market perp trading volume in USD. | | `pairSolanaUSDVolumeUSD` | SOL/USD Volume (USD) | float64 | | SOL/USD market perp trading volume in USD. | | `pairHyperliquidUSDVolumeUSD` | HYPE/USD Volume (USD) | float64 | | HYPE/USD market perp trading volume in USD. | | `pairBNBUSDVolumeUSD` | BNB/USD Volume (USD) | float64 | | BNB/USD market perp trading volume in USD. | | `pairXRPUSDVolumeUSD` | XRP/USD Volume (USD) | float64 | | XRP/USD market perp trading volume in USD. | | `pairAvalancheUSDVolumeUSD` | AVAX/USD Volume (USD) | float64 | | AVAX/USD market perp trading volume in USD. | | `pairBitcoinUSDOpenInterestUSD` | BTC/USD Open Interest (USD) | float64 | | BTC/USD market open interest in USD. | | `pairEthereumUSDOpenInterestUSD` | ETH/USD Open Interest (USD) | float64 | | ETH/USD market open interest in USD. | | `pairSolanaUSDOpenInterestUSD` | SOL/USD Open Interest (USD) | float64 | | SOL/USD market open interest in USD. | | `pairHyperliquidUSDOpenInterestUSD` | HYPE/USD Open Interest (USD) | float64 | | HYPE/USD market open interest in USD. | | `pairBNBUSDOpenInterestUSD` | BNB/USD Open Interest (USD) | float64 | | BNB/USD market open interest in USD. | | `pairXRPUSDOpenInterestUSD` | XRP/USD Open Interest (USD) | float64 | | XRP/USD market open interest in USD. | | `pairAvalancheUSDOpenInterestUSD` | AVAX/USD Open Interest (USD) | float64 | | AVAX/USD market open interest in USD. | | `pairBitcoinUSDTradeCount` | BTC/USD Trade Count | float64 | | BTC/USD market trade count. | | `pairEthereumUSDTradeCount` | ETH/USD Trade Count | float64 | | ETH/USD market trade count. | | `pairSolanaUSDTradeCount` | SOL/USD Trade Count | float64 | | SOL/USD market trade count. | | `pairHyperliquidUSDTradeCount` | HYPE/USD Trade Count | float64 | | HYPE/USD market trade count. | | `pairBNBUSDTradeCount` | BNB/USD Trade Count | float64 | | BNB/USD market trade count. | | `pairXRPUSDTradeCount` | XRP/USD Trade Count | float64 | | XRP/USD market trade count. | | `pairAvalancheUSDTradeCount` | AVAX/USD Trade Count | float64 | | AVAX/USD market trade count. | | `pairBitcoinUSDLiquidationVolumeUSD` | BTC/USD Liquidation Volume (USD) | float64 | | BTC/USD market liquidation volume in USD. | | `pairEthereumUSDLiquidationVolumeUSD` | ETH/USD Liquidation Volume (USD) | float64 | | ETH/USD market liquidation volume in USD. | | `pairSolanaUSDLiquidationVolumeUSD` | SOL/USD Liquidation Volume (USD) | float64 | | SOL/USD market liquidation volume in USD. | | `pairHyperliquidUSDLiquidationVolumeUSD` | HYPE/USD Liquidation Volume (USD) | float64 | | HYPE/USD market liquidation volume in USD. | | `pairBNBUSDLiquidationVolumeUSD` | BNB/USD Liquidation Volume (USD) | float64 | | BNB/USD market liquidation volume in USD. | | `pairXRPUSDLiquidationVolumeUSD` | XRP/USD Liquidation Volume (USD) | float64 | | XRP/USD market liquidation volume in USD. | | `pairAvalancheUSDLiquidationVolumeUSD` | AVAX/USD Liquidation Volume (USD) | float64 | | AVAX/USD market liquidation volume in USD. | | `pairBitcoinUSDLiquidationCount` | BTC/USD Liquidation Count | float64 | | BTC/USD market liquidation count. | | `pairEthereumUSDLiquidationCount` | ETH/USD Liquidation Count | float64 | | ETH/USD market liquidation count. | | `pairSolanaUSDLiquidationCount` | SOL/USD Liquidation Count | float64 | | SOL/USD market liquidation count. | | `pairHyperliquidUSDLiquidationCount` | HYPE/USD Liquidation Count | float64 | | HYPE/USD market liquidation count. | | `pairBNBUSDLiquidationCount` | BNB/USD Liquidation Count | float64 | | BNB/USD market liquidation count. | | `pairXRPUSDLiquidationCount` | XRP/USD Liquidation Count | float64 | | XRP/USD market liquidation count. | | `pairAvalancheUSDLiquidationCount` | AVAX/USD Liquidation Count | float64 | | AVAX/USD market liquidation count. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the perp-dex-protocols timeseries model, the protocol's short name (hyperliquid). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the protocol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The protocol's project slug, the slug used for the same protocol across the API. (identifier 1) | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the protocol's project record. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/perp-dex-protocols/1d/arcus?timeframe=7d&selections=volumeUSD,openInterestUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Perp DEX Protocol timeseries](/api-reference/data-api/perp-dex-protocols/timeseries-perp-dex-protocols-by-id) for the response and the errors. # List Perp DEX Protocols Source: https://docs.blockworks.com/api-reference/data-api/perp-dex-protocols/tabular-perp-dex-protocols api-reference/data-api/openapi.json GET /query/tabular/perp-dex-protocols One row per perpetual futures decentralized exchange, keyed by its short name: name, project slug and project id. The id is the series key of the perp-dex-protocols timeseries model. # Batch Get Perp DEX Protocol timeseries Source: https://docs.blockworks.com/api-reference/data-api/perp-dex-protocols/timeseries-perp-dex-protocols api-reference/data-api/openapi.json GET /query/timeseries/perp-dex-protocols/{granularity} Perpetual futures DEX metrics for a protocol: volume, open interest, trades, liquidations and active markets, with breakdowns by market category, core versus builder-deployed markets and major USD pairs. Each series is one protocol, keyed by its slug. Most protocols populate only part of the columns, so pass selections. # Get Perp DEX Protocol timeseries Source: https://docs.blockworks.com/api-reference/data-api/perp-dex-protocols/timeseries-perp-dex-protocols-by-id api-reference/data-api/openapi.json GET /query/timeseries/perp-dex-protocols/{granularity}/{id} Perpetual futures DEX metrics for a protocol: volume, open interest, trades, liquidations and active markets, with breakdowns by market category, core versus builder-deployed markets and major USD pairs. Each series is one protocol, keyed by its slug. Most protocols populate only part of the columns, so pass selections. # Privacy Source: https://docs.blockworks.com/api-reference/data-api/privacy/overview Privacy: Privacy Flows and Balances. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Privacy Flows and Balances](/api-reference/data-api/privacy/privacy-flows-and-balances) | Projects-dataset | [List rows](/api-reference/data-api/privacy/tabular-privacy-flows) | [Batch](/api-reference/data-api/privacy/timeseries-privacy-flows), [One series](/api-reference/data-api/privacy/timeseries-privacy-flows-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/privacy-flows?pageSize=3&selections=id,name,slug,chain" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Privacy Flows](/api-reference/data-api/privacy/tabular-privacy-flows) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Privacy Flows and Balances Source: https://docs.blockworks.com/api-reference/data-api/privacy/privacy-flows-and-balances Daily balance, deposits, withdrawals and net flow, in native units and USD, of one token in one privacy protocol (a shielded pool, mixer or privacy vault) on one chain, with deposit and withdrawal transfer counts. Each series is one protocol token, keyed by chain, token address and protocol. One row per token held by a privacy protocol (a shielded pool, mixer or privacy vault) on one chain, keyed by chain, token address and protocol: the protocol, the token, the chain and the mapped project and network records. The id is the series key of the privacy-flows timeseries model. | | | | - | - | | Access | Projects-dataset | | Tabular model | `privacy-flows`: primary key `id` | | Timeseries model | `privacy-flows`: intervals `1d`, series key `id` (Privacy Flow ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Privacy Flows](/api-reference/data-api/privacy/tabular-privacy-flows) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Privacy Flow timeseries](/api-reference/data-api/privacy/timeseries-privacy-flows) > > Up to 10 series in one request, named by Privacy Flow ID in `series`. > [card] [Get Privacy Flow timeseries](/api-reference/data-api/privacy/timeseries-privacy-flows-by-id) > > One series over a time window, keyed by its Privacy Flow ID. ## Metrics 10 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `balance` | Balance | float64 | | Token balance held by the protocol, in native units. | | `balanceUSD` | Balance (USD) | float64 | | Token balance held by the protocol in USD. | | `depositAmount` | Deposit Amount | float64 | | Tokens deposited into the protocol, in native units. | | `depositAmountUSD` | Deposit Amount (USD) | float64 | | Tokens deposited into the protocol in USD. | | `depositTransferCount` | Deposit Transfer Count | float64 | | Number of deposit transfers. | | `withdrawalAmount` | Withdrawal Amount | float64 | | Tokens withdrawn from the protocol, in native units. | | `withdrawalAmountUSD` | Withdrawal Amount (USD) | float64 | | Tokens withdrawn from the protocol in USD. | | `withdrawalTransferCount` | Withdrawal Transfer Count | float64 | | Number of withdrawal transfers. | | `netFlow` | Net Flow | float64 | | Deposits less withdrawals, in native units. | | `netFlowUSD` | Net Flow (USD) | float64 | | Deposits less withdrawals in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the privacy-flows timeseries model, the chain, token address and privacy protocol id, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the protocol and token. | | `slug` | string | `Eq`, `IsOneOf` | yes | The project's slug, the slug used for the same project across the API. | | `chain` | string | `Eq`, `IsOneOf` | yes | The short name of the chain (ethereum, base, solana). | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address; native for the chain's own coin in Monero and Zcash shielded pools. | | `protocolID` | string | `Eq`, `IsOneOf` | yes | The privacy protocol's identifier (tornado-cash, railgun, sapling). | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | | `networkSlug` | string | `Eq`, `IsOneOf` | | The chain's slug in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/privacy-flows/1d/?timeframe=7d&selections=balance,balanceUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Privacy Flow timeseries](/api-reference/data-api/privacy/timeseries-privacy-flows-by-id) for the response and the errors. # List Privacy Flows Source: https://docs.blockworks.com/api-reference/data-api/privacy/tabular-privacy-flows api-reference/data-api/openapi.json GET /query/tabular/privacy-flows One row per token held by a privacy protocol (a shielded pool, mixer or privacy vault) on one chain, keyed by chain, token address and protocol: the protocol, the token, the chain and the mapped project and network records. The id is the series key of the privacy-flows timeseries model. # Batch Get Privacy Flow timeseries Source: https://docs.blockworks.com/api-reference/data-api/privacy/timeseries-privacy-flows api-reference/data-api/openapi.json GET /query/timeseries/privacy-flows/{granularity} Daily balance, deposits, withdrawals and net flow, in native units and USD, of one token in one privacy protocol (a shielded pool, mixer or privacy vault) on one chain, with deposit and withdrawal transfer counts. Each series is one protocol token, keyed by chain, token address and protocol. # Get Privacy Flow timeseries Source: https://docs.blockworks.com/api-reference/data-api/privacy/timeseries-privacy-flows-by-id api-reference/data-api/openapi.json GET /query/timeseries/privacy-flows/{granularity}/{id} Daily balance, deposits, withdrawals and net flow, in native units and USD, of one token in one privacy protocol (a shielded pool, mixer or privacy vault) on one chain, with deposit and withdrawal transfer counts. Each series is one protocol token, keyed by chain, token address and protocol. # Project Financials Source: https://docs.blockworks.com/api-reference/data-api/project-financials/overview A project's revenue, expenses and income statement in USD, at the project level and broken down by product version, blockchain and line item. The project-level revenue series answers how much a protocol earns; the by-product series shows which deployments earn it. Expenses split cost of revenue from operating expenses, and the income statement breaks both sides out line by line. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Project Income Statements](/api-reference/data-api/project-financials/project-income-statements) | Protocol-revenue-dataset | [List rows](/api-reference/data-api/project-financials/tabular-project-income-statements) | [Batch](/api-reference/data-api/project-financials/timeseries-project-income-statements), [One series](/api-reference/data-api/project-financials/timeseries-project-income-statements-by-id) | | [Project Revenue](/api-reference/data-api/project-financials/project-revenue) | Protocol-revenue-dataset | [List rows](/api-reference/data-api/project-financials/tabular-project-revenue) | [Batch](/api-reference/data-api/project-financials/timeseries-project-revenue), [One series](/api-reference/data-api/project-financials/timeseries-project-revenue-by-id) | | [Protocol Revenue](/api-reference/data-api/project-financials/protocol-revenue) | Protocol-revenue-dataset | | [Batch](/api-reference/data-api/project-financials/timeseries-protocol-revenue), [One series](/api-reference/data-api/project-financials/timeseries-protocol-revenue-by-id) | | [Protocol Revenue by Product](/api-reference/data-api/project-financials/protocol-revenue-by-product) | Protocol-revenue-dataset | | [Batch](/api-reference/data-api/project-financials/timeseries-protocol-revenue-by-product), [One series](/api-reference/data-api/project-financials/timeseries-protocol-revenue-by-product-by-id) | | [Project Expenses](/api-reference/data-api/project-financials/project-expenses) | Protocol-revenue-dataset | [List rows](/api-reference/data-api/project-financials/tabular-project-expenses) | [Batch](/api-reference/data-api/project-financials/timeseries-project-expenses), [One series](/api-reference/data-api/project-financials/timeseries-project-expenses-by-id) | | [Project Tokenholder Distributions](/api-reference/data-api/project-financials/project-tokenholder-distributions) | Protocol-revenue-dataset | [List rows](/api-reference/data-api/project-financials/tabular-project-tokenholder-distributions) | [Batch](/api-reference/data-api/project-financials/timeseries-project-tokenholder-distributions), [One series](/api-reference/data-api/project-financials/timeseries-project-tokenholder-distributions-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/project-income-statements?pageSize=3&selections=id,name,slug,parentSlug" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Project Income Statement Line Items](/api-reference/data-api/project-financials/tabular-project-income-statements) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Project Expenses Source: https://docs.blockworks.com/api-reference/data-api/project-financials/project-expenses Daily expenses in USD for one project, split into cost of revenue and operating expenses. Each series is one project, keyed by its project slug, or its parent protocol's short name when no project is mapped, and matching the project-revenue series key. One row per project with expense data, keyed by its project slug (or its parent protocol's short name when no project is mapped): name, slug, parent slug and project id. The id is the series key of the project-expenses timeseries model and matches the project-revenue id. | | | | - | - | | Access | Protocol-revenue-dataset | | Tabular model | `project-expenses`: primary key `id` | | Timeseries model | `project-expenses`: intervals `1d`, series key `id` (Project Expense ID), every series available in one call | ## Endpoints > [card] [List Project Expenses](/api-reference/data-api/project-financials/tabular-project-expenses) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Project Expense timeseries](/api-reference/data-api/project-financials/timeseries-project-expenses) > > Up to 10 series in one request, named by series key in `series`. > [card] [Get Project Expense timeseries](/api-reference/data-api/project-financials/timeseries-project-expenses-by-id) > > One series over a time window, keyed by its Project Expense ID. ## Metrics 3 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `costOfRevenueUSD` | | | | | | `operatingExpensesUSD` | | | | | | `totalExpensesUSD` | | | | | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | | | The series key of the project-expenses timeseries model, the project slug, or the parent protocol's short name when no project is mapped. | | `name` | string | | | The project's name. | | `parentSlug` | string | | | The parent protocol's short name (aave, morpho). | | `projectID` | string | | | The identifier of the project record; null when unmapped. | | `slug` | string | | | The project's slug, the slug used for the same project across the API. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/project-expenses/1d/?timeframe=7d&selections=costOfRevenueUSD,operatingExpensesUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Project Expense timeseries](/api-reference/data-api/project-financials/timeseries-project-expenses-by-id) for the response and the errors. # Project Income Statements Source: https://docs.blockworks.com/api-reference/data-api/project-financials/project-income-statements Daily income statement line items in USD for one project's product on one chain: revenue, contra revenue, cost of goods sold and operating expenses. Each series is one line item, keyed by parent protocol, product, chain, category and line item. Amounts are signed (revenue positive, contra revenue and expenses negative), so summing a project's series over a day gives its operating income. One row per project income statement line item, keyed by parent protocol, product, chain, category and line item: the statement section, category and line item, plus the mapped protocol, project and network records. The id is the series key of the project-income-statements timeseries model. | | | | - | - | | Access | Protocol-revenue-dataset | | Tabular model | `project-income-statements`: primary key `id` | | Timeseries model | `project-income-statements`: intervals `1d`, series key `id` (Project Income Statement ID), every series available in one call | ## Endpoints > [card] [List Project Income Statement Line Items](/api-reference/data-api/project-financials/tabular-project-income-statements) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Project Income Statement Line Item timeseries](/api-reference/data-api/project-financials/timeseries-project-income-statements) > > Up to 10 series in one request, named by series key in `series`. > [card] [Get Project Income Statement Line Item timeseries](/api-reference/data-api/project-financials/timeseries-project-income-statements-by-id) > > One series over a time window, keyed by its Project Income Statement ID. ## Metrics 1 metric. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `amountUSD` | | | | | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `category` | string | | | The line item's category, revenue, contra-revenue, cogs or operating-expenses. | | `chain` | string | | | The short name of the chain (ethereum, base, solana). | | `id` | string | | | The series key of the project-income-statements timeseries model, the parent slug, product slug, chain, category and line item, joined with underscores. | | `lineItem` | string | | | The revenue type for revenue rows, or the expense line item (for example l1-proving or operations). | | `name` | string | | | The display name of the series, the project name and line item followed by the product and chain. | | `networkID` | string | | | The chain's networkID in the blockchains model; null when unmapped. | | `parentSlug` | string | | | The parent protocol's short name. | | `productName` | string | | | The product's display name. | | `productSlug` | string | | | The product or version within the parent protocol. | | `projectID` | string | | | The identifier of the project record; null when unmapped. | | `protocolName` | string | | | The name of the protocol record mapped to the product; null when unmapped. | | `protocolSlug` | string | | | The slug of the protocol record mapped to the product; null when unmapped. | | `slug` | string | | | The project's slug, the slug used for the same project across the API. | | `statementSection` | string | | | The income statement section, revenue or expense. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/project-income-statements/1d/?timeframe=7d&selections=amountUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Project Income Statement Line Item timeseries](/api-reference/data-api/project-financials/timeseries-project-income-statements-by-id) for the response and the errors. # Project Revenue Source: https://docs.blockworks.com/api-reference/data-api/project-financials/project-revenue Daily gross, contra and net revenue in USD for one project. Each series is one project, keyed by its project slug, or its parent protocol's short name when no project is mapped, and matching the protocol-revenue series key. One row per project with revenue data, keyed by its project slug (or its parent protocol's short name when no project is mapped): name, slug, parent slug and project id. The id is the series key of the project-revenue timeseries model and matches the protocol-revenue id. | | | | - | - | | Access | Protocol-revenue-dataset | | Tabular model | `project-revenue`: primary key `id` | | Timeseries model | `project-revenue`: intervals `1d`, series key `id` (Project Revenue ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Projects](/api-reference/data-api/project-financials/tabular-project-revenue) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Project timeseries](/api-reference/data-api/project-financials/timeseries-project-revenue) > > Up to 10 series in one request, named by Project Revenue ID in `series`. > [card] [Get Project timeseries](/api-reference/data-api/project-financials/timeseries-project-revenue-by-id) > > One series over a time window, keyed by its Project Revenue ID. ## Metrics 3 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `grossRevenueUSD` | Gross Revenue (USD) | float64 | | Gross revenue in USD; negative on some days. | | `contraRevenueUSD` | Contra Revenue (USD) | float64 | | Contra revenue in USD, deducted from gross revenue to give net revenue. | | `netRevenueUSD` | Net Revenue (USD) | float64 | | Gross revenue minus modeled contra revenue, in USD. If gross is network Real Economic Value and contra revenue is zero, net equals that value before costs or revenue sharing. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the project-revenue timeseries model, the project slug, or the parent protocol's short name when no project is mapped. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The project's name. | | `slug` | string | `Eq`, `IsOneOf` | yes | The project's slug, the slug used for the same project across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name (aave, morpho). | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the project record; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/project-revenue/1d/?timeframe=7d&selections=grossRevenueUSD,contraRevenueUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Project timeseries](/api-reference/data-api/project-financials/timeseries-project-revenue-by-id) for the response and the errors. # Project Tokenholder Distributions Source: https://docs.blockworks.com/api-reference/data-api/project-financials/project-tokenholder-distributions Daily capital returned to token holders by one project, as token buybacks and dividends in USD. Each series is one project, keyed by its project slug, or its parent protocol's short name when no project is mapped, and matching the protocol-revenue series key. One row per project that returns capital to its token holders, keyed by its project slug (or its parent protocol's short name when no project is mapped): name, slug, parent slug and project id. The id is the series key of the project-tokenholder-distributions timeseries model. | | | | - | - | | Access | Protocol-revenue-dataset | | Tabular model | `project-tokenholder-distributions`: primary key `id` | | Timeseries model | `project-tokenholder-distributions`: intervals `1d`, series key `id` (Project Tokenholder Distribution ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Projects](/api-reference/data-api/project-financials/tabular-project-tokenholder-distributions) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Project timeseries](/api-reference/data-api/project-financials/timeseries-project-tokenholder-distributions) > > Up to 10 series in one request, named by Project Tokenholder Distribution ID in `series`. > [card] [Get Project timeseries](/api-reference/data-api/project-financials/timeseries-project-tokenholder-distributions-by-id) > > One series over a time window, keyed by its Project Tokenholder Distribution ID. ## Metrics 2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `buybacksUSD` | Buybacks (USD) | float64 | | Token buybacks in USD. | | `dividendsUSD` | Dividends (USD) | float64 | | Dividends paid to token holders in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the project-tokenholder-distributions timeseries model, the project slug, or the parent protocol's short name when no project is mapped. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The project's name. | | `slug` | string | `Eq`, `IsOneOf` | yes | The project's slug, the slug used for the same project across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name (aave, morpho). | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the project record; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/project-tokenholder-distributions/1d/?timeframe=7d&selections=buybacksUSD,dividendsUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Project timeseries](/api-reference/data-api/project-financials/timeseries-project-tokenholder-distributions-by-id) for the response and the errors. # Protocol Revenue Source: https://docs.blockworks.com/api-reference/data-api/project-financials/protocol-revenue Blockworks Research revenue line items in USD, summed across a project's products, chains and revenue types. Each series is keyed by project slug. | | | | - | - | | Access | Protocol-revenue-dataset | | Timeseries model | `protocol-revenue`: intervals `1d`, series key `id` (Project ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Protocol timeseries](/api-reference/data-api/project-financials/timeseries-protocol-revenue) > > Up to 10 series in one request, named by Project ID in `series`. > [card] [Get Protocol timeseries](/api-reference/data-api/project-financials/timeseries-protocol-revenue-by-id) > > One series over a time window, keyed by its Project ID. ## Metrics 1 metric. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `revenue-usd` | Revenue (USD) | float64 | | Daily revenue in USD for this project. Covers apps and networks. App rows contain modeled app revenue. Network rows may contain Real Economic Value (transaction fees plus MEV tips before costs or revenue sharing) or another measure, such as THORChain's swap-fee revenue. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/protocol-revenue/1d/1inch-network?timeframe=7d&selections=revenue-usd" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Protocol timeseries](/api-reference/data-api/project-financials/timeseries-protocol-revenue-by-id) for the response and the errors. # Protocol Revenue by Product Source: https://docs.blockworks.com/api-reference/data-api/project-financials/protocol-revenue-by-product Revenue in USD for one product (version) of a protocol on one blockchain. Each series is one product on one chain, keyed by protocol, product and chain. Shows which deployments generate a protocol's revenue. | | | | - | - | | Access | Protocol-revenue-dataset | | Timeseries model | `protocol-revenue-by-product`: intervals `1d`, series key `id` (Protocol Product Chain ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Protocol Product timeseries](/api-reference/data-api/project-financials/timeseries-protocol-revenue-by-product) > > Up to 10 series in one request, named by Protocol Product Chain ID in `series`. > [card] [Get Protocol Product timeseries](/api-reference/data-api/project-financials/timeseries-protocol-revenue-by-product-by-id) > > One series over a time window, keyed by its Protocol Product Chain ID. ## Metrics 1 metric. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `revenue-usd` | Revenue (USD) | float64 | | Daily revenue in USD for this product on a chain. Covers apps and networks. App rows contain modeled app revenue. Network rows may contain Real Economic Value (transaction fees plus MEV tips before costs or revenue sharing) or another measure, such as THORChain's swap-fee revenue. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/protocol-revenue-by-product/1d/aave_aave-v2_avalanche_c?timeframe=7d&selections=revenue-usd" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Protocol Product timeseries](/api-reference/data-api/project-financials/timeseries-protocol-revenue-by-product-by-id) for the response and the errors. # List Project Expenses Source: https://docs.blockworks.com/api-reference/data-api/project-financials/tabular-project-expenses api-reference/data-api/openapi.json GET /query/tabular/project-expenses One row per project with expense data, keyed by its project slug (or its parent protocol's short name when no project is mapped): name, slug, parent slug and project id. The id is the series key of the project-expenses timeseries model and matches the project-revenue id. # List Project Income Statement Line Items Source: https://docs.blockworks.com/api-reference/data-api/project-financials/tabular-project-income-statements api-reference/data-api/openapi.json GET /query/tabular/project-income-statements One row per project income statement line item, keyed by parent protocol, product, chain, category and line item: the statement section, category and line item, plus the mapped protocol, project and network records. The id is the series key of the project-income-statements timeseries model. # List Projects Source: https://docs.blockworks.com/api-reference/data-api/project-financials/tabular-project-revenue api-reference/data-api/openapi.json GET /query/tabular/project-revenue One row per project with revenue data, keyed by its project slug (or its parent protocol's short name when no project is mapped): name, slug, parent slug and project id. The id is the series key of the project-revenue timeseries model and matches the protocol-revenue id. # List Projects Source: https://docs.blockworks.com/api-reference/data-api/project-financials/tabular-project-tokenholder-distributions api-reference/data-api/openapi.json GET /query/tabular/project-tokenholder-distributions One row per project that returns capital to its token holders, keyed by its project slug (or its parent protocol's short name when no project is mapped): name, slug, parent slug and project id. The id is the series key of the project-tokenholder-distributions timeseries model. # Batch Get Project Expense timeseries Source: https://docs.blockworks.com/api-reference/data-api/project-financials/timeseries-project-expenses api-reference/data-api/openapi.json GET /query/timeseries/project-expenses/{granularity} Daily expenses in USD for one project, split into cost of revenue and operating expenses. Each series is one project, keyed by its project slug, or its parent protocol's short name when no project is mapped, and matching the project-revenue series key. # Get Project Expense timeseries Source: https://docs.blockworks.com/api-reference/data-api/project-financials/timeseries-project-expenses-by-id api-reference/data-api/openapi.json GET /query/timeseries/project-expenses/{granularity}/{id} Daily expenses in USD for one project, split into cost of revenue and operating expenses. Each series is one project, keyed by its project slug, or its parent protocol's short name when no project is mapped, and matching the project-revenue series key. # Batch Get Project Income Statement Line Item timeseries Source: https://docs.blockworks.com/api-reference/data-api/project-financials/timeseries-project-income-statements api-reference/data-api/openapi.json GET /query/timeseries/project-income-statements/{granularity} Daily income statement line items in USD for one project's product on one chain: revenue, contra revenue, cost of goods sold and operating expenses. Each series is one line item, keyed by parent protocol, product, chain, category and line item. Amounts are signed (revenue positive, contra revenue and expenses negative), so summing a project's series over a day gives its operating income. # Get Project Income Statement Line Item timeseries Source: https://docs.blockworks.com/api-reference/data-api/project-financials/timeseries-project-income-statements-by-id api-reference/data-api/openapi.json GET /query/timeseries/project-income-statements/{granularity}/{id} Daily income statement line items in USD for one project's product on one chain: revenue, contra revenue, cost of goods sold and operating expenses. Each series is one line item, keyed by parent protocol, product, chain, category and line item. Amounts are signed (revenue positive, contra revenue and expenses negative), so summing a project's series over a day gives its operating income. # Batch Get Project timeseries Source: https://docs.blockworks.com/api-reference/data-api/project-financials/timeseries-project-revenue api-reference/data-api/openapi.json GET /query/timeseries/project-revenue/{granularity} Daily gross, contra and net revenue in USD for one project. Each series is one project, keyed by its project slug, or its parent protocol's short name when no project is mapped, and matching the protocol-revenue series key. # Get Project timeseries Source: https://docs.blockworks.com/api-reference/data-api/project-financials/timeseries-project-revenue-by-id api-reference/data-api/openapi.json GET /query/timeseries/project-revenue/{granularity}/{id} Daily gross, contra and net revenue in USD for one project. Each series is one project, keyed by its project slug, or its parent protocol's short name when no project is mapped, and matching the protocol-revenue series key. # Batch Get Project timeseries Source: https://docs.blockworks.com/api-reference/data-api/project-financials/timeseries-project-tokenholder-distributions api-reference/data-api/openapi.json GET /query/timeseries/project-tokenholder-distributions/{granularity} Daily capital returned to token holders by one project, as token buybacks and dividends in USD. Each series is one project, keyed by its project slug, or its parent protocol's short name when no project is mapped, and matching the protocol-revenue series key. # Get Project timeseries Source: https://docs.blockworks.com/api-reference/data-api/project-financials/timeseries-project-tokenholder-distributions-by-id api-reference/data-api/openapi.json GET /query/timeseries/project-tokenholder-distributions/{granularity}/{id} Daily capital returned to token holders by one project, as token buybacks and dividends in USD. Each series is one project, keyed by its project slug, or its parent protocol's short name when no project is mapped, and matching the protocol-revenue series key. # Batch Get Protocol timeseries Source: https://docs.blockworks.com/api-reference/data-api/project-financials/timeseries-protocol-revenue api-reference/data-api/openapi.json GET /query/timeseries/protocol-revenue/{granularity} Blockworks Research revenue line items in USD, summed across a project's products, chains and revenue types. Each series is keyed by project slug. # Get Protocol timeseries Source: https://docs.blockworks.com/api-reference/data-api/project-financials/timeseries-protocol-revenue-by-id api-reference/data-api/openapi.json GET /query/timeseries/protocol-revenue/{granularity}/{id} Blockworks Research revenue line items in USD, summed across a project's products, chains and revenue types. Each series is keyed by project slug. # Batch Get Protocol Product timeseries Source: https://docs.blockworks.com/api-reference/data-api/project-financials/timeseries-protocol-revenue-by-product api-reference/data-api/openapi.json GET /query/timeseries/protocol-revenue-by-product/{granularity} Revenue in USD for one product (version) of a protocol on one blockchain. Each series is one product on one chain, keyed by protocol, product and chain. Shows which deployments generate a protocol's revenue. # Get Protocol Product timeseries Source: https://docs.blockworks.com/api-reference/data-api/project-financials/timeseries-protocol-revenue-by-product-by-id api-reference/data-api/openapi.json GET /query/timeseries/protocol-revenue-by-product/{granularity}/{id} Revenue in USD for one product (version) of a protocol on one blockchain. Each series is one product on one chain, keyed by protocol, product and chain. Shows which deployments generate a protocol's revenue. # Projects Source: https://docs.blockworks.com/api-reference/data-api/projects/overview Projects: Projects. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Projects](/api-reference/data-api/projects/projects) | Projects-dataset | | [Batch](/api-reference/data-api/projects/timeseries-projects), [One series](/api-reference/data-api/projects/timeseries-projects-by-id) | | [Project Tokens](/api-reference/data-api/projects/project-tokens) | Assets-dataset | [List rows](/api-reference/data-api/projects/tabular-project-tokens), [One row](/api-reference/data-api/projects/tabular-project-tokens-by-id) | [Batch](/api-reference/data-api/projects/timeseries-project-tokens), [One series](/api-reference/data-api/projects/timeseries-project-tokens-by-id) | | [Project Users](/api-reference/data-api/projects/project-users) | Projects-dataset | [List rows](/api-reference/data-api/projects/tabular-project-users) | [Batch](/api-reference/data-api/projects/timeseries-project-users), [One series](/api-reference/data-api/projects/timeseries-project-users-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/project-tokens?pageSize=3&selections=id,name,slug,chain" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Project Tokens](/api-reference/data-api/projects/tabular-project-tokens) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Project Tokens Source: https://docs.blockworks.com/api-reference/data-api/projects/project-tokens Daily metrics for one token contract on one chain: price, supply, mints and burns, where the supply sits by holder type in native units and USD, holders, lending deposits, borrows, flows, APYs and liquidations, spot DEX volume and transfers. Each series is one token deployment, keyed by chain and contract address. Fields are null where a token has no such activity, so pass selections. One row per token contract per chain with daily token metrics: chain and contract address, symbol, category, sector, subsector and issuer. The id is the series key of the project-tokens timeseries model and matches the id in tokens. | | | | - | - | | Access | Assets-dataset | | Tabular model | `project-tokens`: primary key `id` | | Timeseries model | `project-tokens`: intervals `1d`, series key `id` (Token ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Project Tokens](/api-reference/data-api/projects/tabular-project-tokens) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Project Token](/api-reference/data-api/projects/tabular-project-tokens-by-id) > > One row by `id`. > [card] [Batch Get Project Token timeseries](/api-reference/data-api/projects/timeseries-project-tokens) > > Up to 10 series in one request, named by Token ID in `series`. > [card] [Get Project Token timeseries](/api-reference/data-api/projects/timeseries-project-tokens-by-id) > > One series over a time window, keyed by its Token ID. ## Metrics 63 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `priceUSD` | Price (USD) | float64 | | Token price in USD. | | `supplyMax` | Max Supply | float64 | | Maximum token supply. | | `supplyTotal` | Total Supply | float64 | | Total token supply. | | `supplyIssued` | Issued Supply | float64 | | Issued token supply, total supply less unissued balances. | | `mintAmount` | Mint Amount | float64 | | Tokens minted, in native units. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Tokens minted in USD. | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnAmount` | Burn Amount | float64 | | Tokens burned, in native units. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Tokens burned in USD. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceUnissued` | Balance Unissued | float64 | | Supply held by unissued supply addresses, in native units. | | `balanceBridge` | Balance Bridge | float64 | | Supply held by bridge contracts, in native units. | | `balanceCeFi` | Balance CeFi | float64 | | Supply held by centralized finance wallets, in native units. | | `balanceSpotDEX` | Balance Spot DEX | float64 | | Supply held by spot DEX pools, in native units. | | `balancePerpDEX` | Balance Perp DEX | float64 | | Supply held by perpetual DEX contracts, in native units. | | `balancePayments` | Balance Payments | float64 | | Supply held by payment card addresses, in native units. | | `balancePrivacy` | Balance Privacy | float64 | | Supply held by privacy protocols, in native units. | | `balanceStaking` | Balance Staking | float64 | | Supply held by staking contracts, in native units. | | `balanceWrapped` | Balance Wrapped | float64 | | Supply held by wrapping contracts, in native units. | | `balanceManaged` | Balance Managed | float64 | | Supply held by vault managed wallets, in native units. | | `balanceCDP` | Balance CDP | float64 | | Supply held by CDP protocols, in native units. | | `balanceTreasuries` | Balance Treasuries | float64 | | Supply held by onchain treasuries, in native units. | | `balancePredictionMarket` | Balance Prediction Market | float64 | | Supply held by prediction markets, in native units. | | `balanceYieldDerivatives` | Balance Yield Derivatives | float64 | | Supply held by yield derivative protocols, in native units. | | `balanceBlacklist` | Balance Blacklist | float64 | | Supply held by blacklisted addresses, in native units. | | `balanceUnissuedUSD` | Balance Unissued (USD) | float64 | | Supply held by unissued supply addresses in USD. | | `balanceBridgeUSD` | Balance Bridge (USD) | float64 | | Supply held by bridge contracts in USD. | | `balanceCeFiUSD` | Balance CeFi (USD) | float64 | | Supply held by centralized finance wallets in USD. | | `balanceSpotDEXUSD` | Balance Spot DEX (USD) | float64 | | Supply held by spot DEX pools in USD. | | `balancePerpDEXUSD` | Balance Perp DEX (USD) | float64 | | Supply held by perpetual DEX contracts in USD. | | `balancePaymentsUSD` | Balance Payments (USD) | float64 | | Supply held by payments addresses in USD. | | `balancePrivacyUSD` | Balance Privacy (USD) | float64 | | Supply held by privacy protocols in USD. | | `balanceStakingUSD` | Balance Staking (USD) | float64 | | Supply held by staking contracts in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held by wrapping contracts in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held by managed wallets in USD. | | `balanceCDPUSD` | Balance CDP (USD) | float64 | | Supply held by CDP protocols in USD. | | `balanceTreasuriesUSD` | Balance Treasuries (USD) | float64 | | Supply held by treasuries in USD. | | `balancePredictionMarketUSD` | Balance Prediction Market (USD) | float64 | | Supply held by prediction markets in USD. | | `balanceYieldDerivativesUSD` | Balance Yield Derivatives (USD) | float64 | | Supply held by yield derivative protocols in USD. | | `balanceBlacklistUSD` | Balance Blacklist (USD) | float64 | | Supply held by blacklisted addresses in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held by unlabeled addresses in USD. | | `holders` | Holders | float64 | | Number of addresses holding the token. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed from lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Average lending supply APY, as a decimal. | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Average lending borrow APY, as a decimal. | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in lending liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Lending liquidation losses (bad debt) in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of lending liquidations. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Number of spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Number of unique spot DEX traders. | | `transferVolume` | Transfer Volume | float64 | | Transfer volume in native units, unfiltered. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD, unfiltered. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | | `transferMedianSize` | Transfer Median Size | float64 | | Median transfer size in native units. | | `transferCount` | Transfer Count | float64 | | Number of transfers. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the project-tokens timeseries model, the token's chain and contract address joined with an underscore; the same id as in tokens. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The token's display name, its symbol, falling back to its slug. | | `slug` | string | `Eq`, `IsOneOf` | yes | The token's identifier, shared by every chain's deployment of the same token (circle-usdc); null when unclassified, and not unique across chains. | | `chain` | string | `Eq`, `IsOneOf` | yes | The short name of the chain the token is deployed on (ethereum, base, solana). | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana). | | `symbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `category` | string | `Eq`, `IsOneOf` | | The token's category (for example stablecoins or blockchains). | | `sector` | string | `Eq`, `IsOneOf` | | The token's sector within its category (for example usd or l1). | | `subsector` | string | `Eq`, `IsOneOf` | | The token's subsector within its sector (for example fiat or bitcoin). | | `issuerID` | string | `Eq`, `IsOneOf` | | The identifier of the token's issuer (for example circle or tether); null when unclassified. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/project-tokens/1d/?timeframe=7d&selections=priceUSD,supplyMax" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Project Token timeseries](/api-reference/data-api/projects/timeseries-project-tokens-by-id) for the response and the errors. # Project Users Source: https://docs.blockworks.com/api-reference/data-api/projects/project-users Daily active users of one project's product on one chain, by the project's own definition of an active user. Each series is one product on one chain, keyed by parent protocol, product and chain. Active users is a distinct count, so it does not add up across products or chains. One row per project product on a chain with active user data, keyed by parent protocol, product and chain: the product and its type, chain, and the mapped protocol, project and network records. The id is the series key of the project-users timeseries model. | | | | - | - | | Access | Projects-dataset | | Tabular model | `project-users`: primary key `id` | | Timeseries model | `project-users`: intervals `1d`, series key `id` (Project User ID), every series available in one call | ## Endpoints > [card] [List Project Users](/api-reference/data-api/projects/tabular-project-users) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Project User timeseries](/api-reference/data-api/projects/timeseries-project-users) > > Up to 10 series in one request, named by series key in `series`. > [card] [Get Project User timeseries](/api-reference/data-api/projects/timeseries-project-users-by-id) > > One series over a time window, keyed by its Project User ID. ## Metrics 1 metric. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `activeUsers` | | | | | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `chain` | string | | | The short name of the chain (ethereum, base, solana). | | `id` | string | | | The series key of the project-users timeseries model, the parent slug, product slug and chain, joined with underscores. | | `name` | string | | | The display name of the series. | | `networkID` | string | | | The chain's networkID in the blockchains model; null when unmapped. | | `parentSlug` | string | | | The parent protocol's short name. | | `productName` | string | | | The product's display name. | | `productSlug` | string | | | The product or version within the parent protocol. | | `productType` | string | | | The product type, app, or blockchain for a chain's own line. | | `projectID` | string | | | The identifier of the project record; null when unmapped. | | `protocolName` | string | | | The name of the protocol record mapped to the product; null when unmapped. | | `protocolSlug` | string | | | The slug of the protocol record mapped to the product; null when unmapped. | | `slug` | string | | | The project's slug, the slug used for the same project across the API; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/project-users/1d/?timeframe=7d&selections=activeUsers" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Project User timeseries](/api-reference/data-api/projects/timeseries-project-users-by-id) for the response and the errors. # Projects Source: https://docs.blockworks.com/api-reference/data-api/projects/projects Fundamentals for a project on its primary ecosystem network: protocol revenue, TVL, primary asset market cap, stablecoin supply, DEX volume and mindshare. Each series is one project, keyed by its project id. Only the metrics that apply to a project are populated, so pass selections. | | | | - | - | | Access | Projects-dataset | | Timeseries model | `projects`: intervals `1d`, series key `id` (Project ID), series must be named (up to 10 per call), aliases `project` | ## Endpoints > [card] [Batch Get Project timeseries](/api-reference/data-api/projects/timeseries-projects) > > Up to 10 series in one request, named by Project ID in `series`. > [card] [Get Project timeseries](/api-reference/data-api/projects/timeseries-projects-by-id) > > One series over a time window, keyed by its Project ID. ## Metrics 9 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `primary-ecosystem-revenue-usd` | Primary Ecosystem Revenue USD | float64 | usd | Share of fees that goes to the protocol. | | `primary-ecosystem-revenue-usd-rolling-7d` | Primary Ecosystem Revenue USD Rolling 7D | float64 | usd | Rolling 7D average of share of fees that goes to the protocol. | | `primary-ecosystem-tvl-usd` | Primary Ecosystem TVL USD | float64 | usd | Average value of funds locked into the protocol's smart contracts. | | `primary-asset-circulating-marketcap-usd` | Primary Asset Circulating Marketcap USD | float64 | usd | Circulating marketcap of the primary asset of the project. | | `stablecoin-outstanding-supply-usd` | Stablecoin Outstanding Supply USD | float64 | usd | Outstanding supply of the stablecoin of the project. | | `dex-volume-usd` | DEX Volume USD | float64 | usd | Volume of the project on DEXs. | | `mindshare-score` | Mindshare Score | float64 | | The mindshare score for the project. | | `mindshare-score-rolling-7d` | Mindshare Score Rolling 7D | float64 | | Average rolling 7D mindshare score for the project. | | `mindshare-rank` | Mindshare Rank | int64 | | Mindshare rank of the project among all projects. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/projects/1d/8434fad0-37fa-4332-bfcf-240e4aaf3af4?timeframe=7d&selections=mindshare-score,mindshare-score-rolling-7d" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Project timeseries](/api-reference/data-api/projects/timeseries-projects-by-id) for the response and the errors. # List Project Tokens Source: https://docs.blockworks.com/api-reference/data-api/projects/tabular-project-tokens api-reference/data-api/openapi.json GET /query/tabular/project-tokens One row per token contract per chain with daily token metrics: chain and contract address, symbol, category, sector, subsector and issuer. The id is the series key of the project-tokens timeseries model and matches the id in tokens. # Get Project Token Source: https://docs.blockworks.com/api-reference/data-api/projects/tabular-project-tokens-by-id api-reference/data-api/openapi.json GET /query/tabular/project-tokens/{id} One row per token contract per chain with daily token metrics: chain and contract address, symbol, category, sector, subsector and issuer. The id is the series key of the project-tokens timeseries model and matches the id in tokens. # List Project Users Source: https://docs.blockworks.com/api-reference/data-api/projects/tabular-project-users api-reference/data-api/openapi.json GET /query/tabular/project-users One row per project product on a chain with active user data, keyed by parent protocol, product and chain: the product and its type, chain, and the mapped protocol, project and network records. The id is the series key of the project-users timeseries model. # Batch Get Project Token timeseries Source: https://docs.blockworks.com/api-reference/data-api/projects/timeseries-project-tokens api-reference/data-api/openapi.json GET /query/timeseries/project-tokens/{granularity} Daily metrics for one token contract on one chain: price, supply, mints and burns, where the supply sits by holder type in native units and USD, holders, lending deposits, borrows, flows, APYs and liquidations, spot DEX volume and transfers. Each series is one token deployment, keyed by chain and contract address. Fields are null where a token has no such activity, so pass selections. # Get Project Token timeseries Source: https://docs.blockworks.com/api-reference/data-api/projects/timeseries-project-tokens-by-id api-reference/data-api/openapi.json GET /query/timeseries/project-tokens/{granularity}/{id} Daily metrics for one token contract on one chain: price, supply, mints and burns, where the supply sits by holder type in native units and USD, holders, lending deposits, borrows, flows, APYs and liquidations, spot DEX volume and transfers. Each series is one token deployment, keyed by chain and contract address. Fields are null where a token has no such activity, so pass selections. # Batch Get Project User timeseries Source: https://docs.blockworks.com/api-reference/data-api/projects/timeseries-project-users api-reference/data-api/openapi.json GET /query/timeseries/project-users/{granularity} Daily active users of one project's product on one chain, by the project's own definition of an active user. Each series is one product on one chain, keyed by parent protocol, product and chain. Active users is a distinct count, so it does not add up across products or chains. # Get Project User timeseries Source: https://docs.blockworks.com/api-reference/data-api/projects/timeseries-project-users-by-id api-reference/data-api/openapi.json GET /query/timeseries/project-users/{granularity}/{id} Daily active users of one project's product on one chain, by the project's own definition of an active user. Each series is one product on one chain, keyed by parent protocol, product and chain. Active users is a distinct count, so it does not add up across products or chains. # Batch Get Project timeseries Source: https://docs.blockworks.com/api-reference/data-api/projects/timeseries-projects api-reference/data-api/openapi.json GET /query/timeseries/projects/{granularity} Fundamentals for a project on its primary ecosystem network: protocol revenue, TVL, primary asset market cap, stablecoin supply, DEX volume and mindshare. Each series is one project, keyed by its project id. Only the metrics that apply to a project are populated, so pass selections. # Get Project timeseries Source: https://docs.blockworks.com/api-reference/data-api/projects/timeseries-projects-by-id api-reference/data-api/openapi.json GET /query/timeseries/projects/{granularity}/{id} Fundamentals for a project on its primary ecosystem network: protocol revenue, TVL, primary asset market cap, stablecoin supply, DEX volume and mindshare. Each series is one project, keyed by its project id. Only the metrics that apply to a project are populated, so pass selections. # Asset Buybacks Source: https://docs.blockworks.com/api-reference/data-api/real-time-buybacks/asset-buybacks Tokens a project buys back and burns, summed over rolling 5-minute, 1-hour and 24-hour windows, in USD and in the token. Each series is one asset, keyed by its asset id. A point is published every 5 minutes and is final once published: time is the end of each window, and a point appears about 20 minutes after it, once every minute in its windows has settled. Each window carries a status: ok, empty when nothing was burned, partial when some minutes have no USD price, or stale when source data is missing and the values are null. | | | | - | - | | Access | Token-buybacks-dataset | | Timeseries model | `asset-buybacks`: intervals `5m`, series key `id` (Asset ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Asset timeseries](/api-reference/data-api/real-time-buybacks/timeseries-asset-buybacks) > > Up to 10 series in one request, named by Asset ID in `series`. > [card] [Get Asset timeseries](/api-reference/data-api/real-time-buybacks/timeseries-asset-buybacks-by-id) > > One series over a time window, keyed by its Asset ID. ## Metrics 10 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `seq` | Sequence | int64 | | Minutes since 1970-01-01 UTC at time. Increases by 5 from one point to the next. | | `buyback5mUSD` | Buyback 5m (USD) | float64 | usd | USD value of tokens bought back and burned in the 5 minutes before time. Null when status5m is stale. | | `buyback5mNative` | Buyback 5m (Native) | float64 | native-token | Tokens bought back and burned in the 5 minutes before time. Null when status5m is stale. | | `status5m` | Status 5m | string | | ok, empty (nothing burned), partial (some minutes have no USD price, so the USD value sums the priced minutes only) or stale (source data missing, values null). | | `buyback1hUSD` | Buyback 1h (USD) | float64 | usd | USD value of tokens bought back and burned in the hour before time. Null when status1h is stale. | | `buyback1hNative` | Buyback 1h (Native) | float64 | native-token | Tokens bought back and burned in the hour before time. Null when status1h is stale. | | `status1h` | Status 1h | string | | ok, empty (nothing burned), partial (some minutes have no USD price, so the USD value sums the priced minutes only) or stale (source data missing, values null). | | `buyback24hUSD` | Buyback 24h (USD) | float64 | usd | USD value of tokens bought back and burned in the 24 hours before time. Null when status24h is stale. | | `buyback24hNative` | Buyback 24h (Native) | float64 | native-token | Tokens bought back and burned in the 24 hours before time. Null when status24h is stale. | | `status24h` | Status 24h | string | | ok, empty (nothing burned), partial (some minutes have no USD price, so the USD value sums the priced minutes only) or stale (source data missing, values null). | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/asset-buybacks/5m/1e31218a-e44e-4285-820c-8282ee222035?timeframe=7d&selections=seq,buyback5mUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Asset timeseries](/api-reference/data-api/real-time-buybacks/timeseries-asset-buybacks-by-id) for the response and the errors. # Real-time Buybacks Source: https://docs.blockworks.com/api-reference/data-api/real-time-buybacks/overview Tokens a project buys back and burns, summed over rolling 5-minute, 1-hour and 24-hour windows, in USD and in the token. Each series is one asset, keyed by its asset id. A point is published every 5 minutes and is final once published, about 20 minutes after the window it closes, and each window carries a status saying whether its minutes all settled. ## Endpoints | Model | Access | Timeseries | | - | - | - | | [Asset Buybacks](/api-reference/data-api/real-time-buybacks/asset-buybacks) | Token-buybacks-dataset | [Batch](/api-reference/data-api/real-time-buybacks/timeseries-asset-buybacks), [One series](/api-reference/data-api/real-time-buybacks/timeseries-asset-buybacks-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/asset-buybacks/5m?series=1e31218a-e44e-4285-820c-8282ee222035,21c795f5-1bfd-40c3-858e-e9d7e820c6d0&timeframe=7d&selections=seq,buyback5mUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Batch Get Asset timeseries](/api-reference/data-api/real-time-buybacks/timeseries-asset-buybacks) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Batch Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/real-time-buybacks/timeseries-asset-buybacks api-reference/data-api/openapi.json GET /query/timeseries/asset-buybacks/{granularity} Tokens a project buys back and burns, summed over rolling 5-minute, 1-hour and 24-hour windows, in USD and in the token. Each series is one asset, keyed by its asset id. A point is published every 5 minutes and is final once published: time is the end of each window, and a point appears about 20 minutes after it, once every minute in its windows has settled. Each window carries a status: ok, empty when nothing was burned, partial when some minutes have no USD price, or stale when source data is missing and the values are null. # Get Asset timeseries Source: https://docs.blockworks.com/api-reference/data-api/real-time-buybacks/timeseries-asset-buybacks-by-id api-reference/data-api/openapi.json GET /query/timeseries/asset-buybacks/{granularity}/{id} Tokens a project buys back and burns, summed over rolling 5-minute, 1-hour and 24-hour windows, in USD and in the token. Each series is one asset, keyed by its asset id. A point is published every 5 minutes and is final once published: time is the end of each window, and a point appears about 20 minutes after it, once every minute in its windows has settled. Each window carries a status: ok, empty when nothing was burned, partial when some minutes have no USD price, or stale when source data is missing and the values are null. # Real World Assets Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/overview Real World Assets: RWA Spot DEX Activity. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [RWA Spot DEX Activity](/api-reference/data-api/real-world-assets/rwa-spot-dex-activity) | Real-world-assets-dataset | [List rows](/api-reference/data-api/real-world-assets/tabular-rwa-spot-dex-segments) | [Batch](/api-reference/data-api/real-world-assets/timeseries-rwa-spot-dex-activity), [One series](/api-reference/data-api/real-world-assets/timeseries-rwa-spot-dex-activity-by-id) | | [RWA by Category](/api-reference/data-api/real-world-assets/rwa-by-category) | Real-world-assets-dataset | [List rows](/api-reference/data-api/real-world-assets/tabular-rwa-categories) | [Batch](/api-reference/data-api/real-world-assets/timeseries-rwa-by-category), [One series](/api-reference/data-api/real-world-assets/timeseries-rwa-by-category-by-id) | | [RWA by Chain](/api-reference/data-api/real-world-assets/rwa-by-chain) | Real-world-assets-dataset | [List rows](/api-reference/data-api/real-world-assets/tabular-rwa-chains) | [Batch](/api-reference/data-api/real-world-assets/timeseries-rwa-by-chain), [One series](/api-reference/data-api/real-world-assets/timeseries-rwa-by-chain-by-id) | | [RWA by Deployment](/api-reference/data-api/real-world-assets/rwa-by-deployment) | Real-world-assets-dataset | [List rows](/api-reference/data-api/real-world-assets/tabular-rwa-deployments) | [Batch](/api-reference/data-api/real-world-assets/timeseries-rwa-by-deployment), [One series](/api-reference/data-api/real-world-assets/timeseries-rwa-by-deployment-by-id) | | [RWA by Issuer](/api-reference/data-api/real-world-assets/rwa-by-issuer) | Real-world-assets-dataset | [List rows](/api-reference/data-api/real-world-assets/tabular-rwa-issuers) | [Batch](/api-reference/data-api/real-world-assets/timeseries-rwa-by-issuer), [One series](/api-reference/data-api/real-world-assets/timeseries-rwa-by-issuer-by-id) | | [RWA by Product](/api-reference/data-api/real-world-assets/rwa-by-product) | Real-world-assets-dataset | [List rows](/api-reference/data-api/real-world-assets/tabular-rwa-products) | [Batch](/api-reference/data-api/real-world-assets/timeseries-rwa-by-product), [One series](/api-reference/data-api/real-world-assets/timeseries-rwa-by-product-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/rwa-spot-dex-segments?pageSize=3&selections=id,name,slug,chain" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List RWA Spot DEX Segments](/api-reference/data-api/real-world-assets/tabular-rwa-spot-dex-segments) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # RWA by Category Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/rwa-by-category Tokenized real-world-asset metrics summed across every token in one category: chain, deployment, product and issuer counts, supply, mints and burns, where the supply sits (CEX, DEX, wrapped, managed, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one category, keyed by its slug. Lending and DEX fields are null where a category has no such activity, so pass selections. One row per tokenized real-world-asset category (government-debt, commodities, equities, credit), keyed by the category slug: name and sector. The id is the series key of the rwa-by-category timeseries model. | | | | - | - | | Access | Real-world-assets-dataset | | Tabular model | `rwa-categories`: primary key `id` | | Timeseries model | `rwa-by-category`: intervals `1d`, series key `id` (RWA Category ID), every series available in one call | ## Endpoints > [card] [List RWA Categories](/api-reference/data-api/real-world-assets/tabular-rwa-categories) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get RWA Category timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-category) > > Every series in one request, or the named ones. > [card] [Get RWA Category timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-category-by-id) > > One series over a time window, keyed by its RWA Category ID. ## Metrics 38 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `chainCount` | Chain Count | float64 | | Number of chains the tokens are deployed on. | | `deploymentCount` | Deployment Count | float64 | | Number of token deployments, one per chain and contract address. | | `productCount` | Product Count | float64 | | Number of RWA products. | | `issuerCount` | Issuer Count | float64 | | Number of issuers. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD. | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held in wrapping contracts in USD. | | `balanceYieldDerivativesUSD` | Balance in Yield Derivatives (USD) | float64 | | Supply held in yield derivative protocols in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held in managed wallets in USD. | | `balanceBuybackUSD` | Balance in Buybacks (USD) | float64 | | Supply held in buyback wallets in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed from lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Average lending supply APY, as a decimal. | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Average lending borrow APY, as a decimal. | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in lending liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Lending liquidation losses (bad debt) in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of lending liquidations. | | `holders` | Holders | float64 | | Number of addresses holding the tokens. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Number of spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Number of unique spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Number of transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the rwa-by-category timeseries model, the category slug (government-debt). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The category's display name. | | `sector` | string | `Eq`, `IsOneOf` | | The RWA category, the token sector (government-debt, commodities, equities, credit). | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/rwa-by-category/1d/?timeframe=7d&selections=chainCount,deploymentCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get RWA Category timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-category-by-id) for the response and the errors. # RWA by Chain Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/rwa-by-chain Tokenized real-world-asset metrics summed across every token on one blockchain: deployment, product and issuer counts, supply split by category, supply, mints and burns, where the supply sits (CEX, DEX, wrapped, managed, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. Lending and DEX fields are null where a chain has no such activity, so pass selections. One row per blockchain with tokenized real-world-asset activity, keyed by the chain slug: name, chain and the mapped network record. The id is the series key of the rwa-by-chain timeseries model. | | | | - | - | | Access | Real-world-assets-dataset | | Tabular model | `rwa-chains`: primary key `id` | | Timeseries model | `rwa-by-chain`: intervals `1d`, series key `id` (RWA Chain ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List RWA Chains](/api-reference/data-api/real-world-assets/tabular-rwa-chains) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get RWA Chain timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-chain) > > Up to 10 series in one request, named by RWA Chain ID in `series`. > [card] [Get RWA Chain timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-chain-by-id) > > One series over a time window, keyed by its RWA Chain ID. ## Metrics 43 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `deploymentCount` | Deployment Count | float64 | | Number of token deployments, one per chain and contract address. | | `productCount` | Product Count | float64 | | Number of RWA products. | | `issuerCount` | Issuer Count | float64 | | Number of issuers. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `governmentDebtSupplyUSD` | Government Debt Supply (USD) | float64 | | Circulating supply of government-debt tokens in USD. | | `commoditiesSupplyUSD` | Commodities Supply (USD) | float64 | | Circulating supply of commodity tokens in USD. | | `equitiesSupplyUSD` | Equities Supply (USD) | float64 | | Circulating supply of equity tokens in USD. | | `creditSupplyUSD` | Credit Supply (USD) | float64 | | Circulating supply of credit tokens in USD. | | `strategiesSupplyUSD` | Strategies Supply (USD) | float64 | | Circulating supply of strategy tokens in USD. | | `otherSupplyUSD` | Other Supply (USD) | float64 | | Circulating supply of tokens in other RWA categories in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD. | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held in wrapping contracts in USD. | | `balanceYieldDerivativesUSD` | Balance in Yield Derivatives (USD) | float64 | | Supply held in yield derivative protocols in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held in managed wallets in USD. | | `balanceBuybackUSD` | Balance in Buybacks (USD) | float64 | | Supply held in buyback wallets in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed from lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Average lending supply APY, as a decimal. | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Average lending borrow APY, as a decimal. | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in lending liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Lending liquidation losses (bad debt) in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of lending liquidations. | | `holders` | Holders | float64 | | Number of addresses holding the tokens. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Number of spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Number of unique spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Number of transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the rwa-by-chain timeseries model, the chain slug (ethereum, avalanche-c). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The chain's display name. | | `chain` | string | `Eq`, `IsOneOf` | yes | The short name of the chain (ethereum, base, solana). | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | | `networkSlug` | string | `Eq`, `IsOneOf` | | The chain's slug in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/rwa-by-chain/1d/?timeframe=7d&selections=deploymentCount,productCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get RWA Chain timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-chain-by-id) for the response and the errors. # RWA by Deployment Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/rwa-by-deployment Tokenized real-world-asset metrics for one token contract on one chain: price, supply, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one deployment, keyed by chain and contract address. Many series, so name the deployments you need. One row per tokenized real-world-asset deployment, one token contract on one chain, keyed by chain and contract address: symbol, product, issuer, category and subcategory, the chain and the mapped network and issuer project records. The id is the series key of the rwa-by-deployment timeseries model. | | | | - | - | | Access | Real-world-assets-dataset | | Tabular model | `rwa-deployments`: primary key `id` | | Timeseries model | `rwa-by-deployment`: intervals `1d`, series key `id` (RWA Deployment ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List RWA Deployments](/api-reference/data-api/real-world-assets/tabular-rwa-deployments) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get RWA Deployment timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-deployment) > > Up to 10 series in one request, named by RWA Deployment ID in `series`. > [card] [Get RWA Deployment timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-deployment-by-id) > > One series over a time window, keyed by its RWA Deployment ID. ## Metrics 44 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `priceUSD` | Price (USD) | float64 | | Token price in USD. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD. | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceProtocolOwnedUSD` | Balance Protocol-Owned (USD) | float64 | | Supply held in protocol-owned wallets in USD. | | `balanceBridgeUSD` | Balance in Bridges (USD) | float64 | | Supply held in bridge contracts in USD. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held in wrapping contracts in USD. | | `balanceYieldDerivativesUSD` | Balance in Yield Derivatives (USD) | float64 | | Supply held in yield derivative protocols in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held in managed wallets in USD. | | `balanceCDPUSD` | Balance in CDPs (USD) | float64 | | Supply held in collateralized debt position (CDP) protocols in USD. | | `balanceBlacklistUSD` | Balance Blacklisted (USD) | float64 | | Supply held in blacklisted addresses in USD. | | `balancePredictionMarketUSD` | Balance in Prediction Markets (USD) | float64 | | Supply held in prediction-market contracts in USD. | | `balanceTreasuriesUSD` | Balance in Treasuries (USD) | float64 | | Supply held in treasury wallets in USD. | | `balancePrivacyUSD` | Balance in Privacy Protocols (USD) | float64 | | Supply held in privacy protocols in USD. | | `balancePaymentsUSD` | Balance in Payments (USD) | float64 | | Supply held in payment wallets in USD. | | `balanceStakingUSD` | Balance Staked (USD) | float64 | | Supply held in staking contracts in USD. | | `balanceBuybackUSD` | Balance in Buybacks (USD) | float64 | | Supply held in buyback wallets in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed from lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Average lending supply APY, as a decimal. | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Average lending borrow APY, as a decimal. | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in lending liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Lending liquidation losses (bad debt) in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of lending liquidations. | | `holders` | Holders | float64 | | Number of addresses holding the tokens. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Number of spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Number of unique spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Number of transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the rwa-by-deployment timeseries model, the chain and token address joined with an underscore. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The deployment's display name. | | `symbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `tokenSlug` | string | `Eq`, `IsOneOf` | | The product's token slug, shared by every chain's deployment of the same token. | | `referenceTokenSlug` | string | `Eq`, `IsOneOf` | | The token slug of the product this contract represents, the underlying token for a bridged or wrapped copy and otherwise its own token slug. | | `underlyingTokenSlug` | string | `Eq`, `IsOneOf` | | The token slug of the product a bridged or wrapped copy represents; null for a native deployment. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana). | | `chain` | string | `Eq`, `IsOneOf` | yes | The short name of the chain (ethereum, base, solana). | | `issuerID` | string | `Eq`, `IsOneOf` | | The identifier of the issuing company. | | `sector` | string | `Eq`, `IsOneOf` | | The RWA category, the token sector (government-debt, commodities, equities, credit). | | `subsector` | string | `Eq`, `IsOneOf` | | The RWA subcategory, the token subsector within its sector. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | | `networkSlug` | string | `Eq`, `IsOneOf` | | The chain's slug in the blockchains model; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the issuer's project record; null when unmapped. | | `projectSlug` | string | `Eq`, `IsOneOf` | | The slug of the issuer's project record; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/rwa-by-deployment/1d/?timeframe=7d&selections=priceUSD,circulatingSupplyUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get RWA Deployment timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-deployment-by-id) for the response and the errors. # RWA by Issuer Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/rwa-by-issuer Tokenized real-world-asset metrics summed across every token one issuer has issued: chain, product and category counts, supply split by category, supply, mints and burns, where the supply sits (CEX, DEX, wrapped, managed, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its slug. Lending and DEX fields are null where an issuer has no such activity, so pass selections. One row per tokenized real-world-asset issuer, keyed by the issuer slug: name, issuer id and the mapped project record. The id is the series key of the rwa-by-issuer timeseries model. | | | | - | - | | Access | Real-world-assets-dataset | | Tabular model | `rwa-issuers`: primary key `id` | | Timeseries model | `rwa-by-issuer`: intervals `1d`, series key `id` (RWA Issuer ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List RWA Issuers](/api-reference/data-api/real-world-assets/tabular-rwa-issuers) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get RWA Issuer timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-issuer) > > Up to 10 series in one request, named by RWA Issuer ID in `series`. > [card] [Get RWA Issuer timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-issuer-by-id) > > One series over a time window, keyed by its RWA Issuer ID. ## Metrics 43 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `chainCount` | Chain Count | float64 | | Number of chains the tokens are deployed on. | | `productCount` | Product Count | float64 | | Number of RWA products. | | `categoryCount` | Category Count | float64 | | Number of RWA categories. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `governmentDebtSupplyUSD` | Government Debt Supply (USD) | float64 | | Circulating supply of government-debt tokens in USD. | | `commoditiesSupplyUSD` | Commodities Supply (USD) | float64 | | Circulating supply of commodity tokens in USD. | | `equitiesSupplyUSD` | Equities Supply (USD) | float64 | | Circulating supply of equity tokens in USD. | | `creditSupplyUSD` | Credit Supply (USD) | float64 | | Circulating supply of credit tokens in USD. | | `strategiesSupplyUSD` | Strategies Supply (USD) | float64 | | Circulating supply of strategy tokens in USD. | | `otherSupplyUSD` | Other Supply (USD) | float64 | | Circulating supply of tokens in other RWA categories in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD. | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held in wrapping contracts in USD. | | `balanceYieldDerivativesUSD` | Balance in Yield Derivatives (USD) | float64 | | Supply held in yield derivative protocols in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held in managed wallets in USD. | | `balanceBuybackUSD` | Balance in Buybacks (USD) | float64 | | Supply held in buyback wallets in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed from lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Average lending supply APY, as a decimal. | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Average lending borrow APY, as a decimal. | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in lending liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Lending liquidation losses (bad debt) in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of lending liquidations. | | `holders` | Holders | float64 | | Number of addresses holding the tokens. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Number of spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Number of unique spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Number of transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the rwa-by-issuer timeseries model, the issuer slug. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The issuer's display name. | | `issuerID` | string | `Eq`, `IsOneOf` | | The identifier of the issuing company. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the issuer's project record; null when unmapped. | | `projectSlug` | string | `Eq`, `IsOneOf` | | The slug of the issuer's project record; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/rwa-by-issuer/1d/?timeframe=7d&selections=chainCount,productCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get RWA Issuer timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-issuer-by-id) for the response and the errors. # RWA by Product Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/rwa-by-product Tokenized real-world-asset metrics summed across every chain one product is deployed on: chain and deployment counts, supply, mints and burns, where the supply sits (CEX, DEX, wrapped, managed, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one product, keyed by its slugified token slug. Lending and DEX fields are null where a product has no such activity, so pass selections. One row per tokenized real-world-asset product, one token across all the chains it is deployed on, keyed by the slugified token slug: symbol, token slug, issuer, category and subcategory and the mapped issuer project record. The id is the series key of the rwa-by-product timeseries model. | | | | - | - | | Access | Real-world-assets-dataset | | Tabular model | `rwa-products`: primary key `id` | | Timeseries model | `rwa-by-product`: intervals `1d`, series key `id` (RWA Product ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List RWA Products](/api-reference/data-api/real-world-assets/tabular-rwa-products) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get RWA Product timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-product) > > Up to 10 series in one request, named by RWA Product ID in `series`. > [card] [Get RWA Product timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-product-by-id) > > One series over a time window, keyed by its RWA Product ID. ## Metrics 36 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `chainCount` | Chain Count | float64 | | Number of chains the tokens are deployed on. | | `deploymentCount` | Deployment Count | float64 | | Number of token deployments, one per chain and contract address. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD. | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held in wrapping contracts in USD. | | `balanceYieldDerivativesUSD` | Balance in Yield Derivatives (USD) | float64 | | Supply held in yield derivative protocols in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held in managed wallets in USD. | | `balanceBuybackUSD` | Balance in Buybacks (USD) | float64 | | Supply held in buyback wallets in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed from lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Average lending supply APY, as a decimal. | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Average lending borrow APY, as a decimal. | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in lending liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Lending liquidation losses (bad debt) in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of lending liquidations. | | `holders` | Holders | float64 | | Number of addresses holding the tokens. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Number of spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Number of unique spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Number of transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the rwa-by-product timeseries model, the slugified token slug (xstocks-abi-bex for xstocks-abi.bex). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The product's display name. | | `tokenSlug` | string | `Eq`, `IsOneOf` | | The product's token slug, shared by every chain's deployment of the same token. | | `symbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `issuerID` | string | `Eq`, `IsOneOf` | | The identifier of the issuing company. | | `sector` | string | `Eq`, `IsOneOf` | | The RWA category, the token sector (government-debt, commodities, equities, credit). | | `subsector` | string | `Eq`, `IsOneOf` | | The RWA subcategory, the token subsector within its sector. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the issuer's project record; null when unmapped. | | `projectSlug` | string | `Eq`, `IsOneOf` | | The slug of the issuer's project record; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/rwa-by-product/1d/?timeframe=7d&selections=chainCount,deploymentCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get RWA Product timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-by-product-by-id) for the response and the errors. # RWA Spot DEX Activity Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/rwa-spot-dex-activity Daily spot DEX trading of tokenized real-world assets. Each series is one RWA category and sub-category, from one issuer, traded through one pair type on one DEX deployment on one chain, keyed by those eight dimensions joined with underscores. One row per RWA spot DEX segment, one category and sub-category from one issuer traded through one pair type on one DEX deployment on one chain: name, project slug, and each of the eight dimensions as its own filterable column. The id is the series key of the rwa-spot-dex-activity timeseries model. | | | | - | - | | Access | Real-world-assets-dataset | | Tabular model | `rwa-spot-dex-segments`: primary key `id` | | Timeseries model | `rwa-spot-dex-activity`: intervals `1d`, series key `id` (RWA Spot DEX Segment ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List RWA Spot DEX Segments](/api-reference/data-api/real-world-assets/tabular-rwa-spot-dex-segments) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get RWA Spot DEX Segment timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-spot-dex-activity) > > Up to 10 series in one request, named by RWA Spot DEX Segment ID in `series`. > [card] [Get RWA Spot DEX Segment timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-spot-dex-activity-by-id) > > One series over a time window, keyed by its RWA Spot DEX Segment ID. ## Metrics 3 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `volumeUSD` | Total Spot Volume | float64 | | Total spot trading volume for RWA assets. | | `memecoinVolumeUSD` | Memecoin Spot Volume | float64 | | Total volume across pairs that have a memecoin token and an RWA token; zero on chains that report no memecoin pairing. | | `tradeCount` | Number of Trades | float64 | | Total number of trades. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the rwa-spot-dex-activity timeseries model, the eight dimensions joined with underscores (ethereum_uniswap_v3_concentrated-liquidity_false_government-debt_usd_ondo). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the segment, the issuer, category and sub-category followed by the venue and chain. | | `slug` | string | `Eq`, `IsOneOf` | yes | The venue's project slug; null for venues without a project record. Many segments share one venue, so this is not unique. | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the trading happened on (ethereum, solana, hyperliquid). | | `exchangeID` | string | `Eq`, `IsOneOf` | yes | The venue's short name (uniswap, curve, raydium). | | `exchangeVersion` | string | `Eq`, `IsOneOf` | | The version label of the deployment (v2, v3, regular). | | `exchangeType` | string | `Eq`, `IsOneOf` | | The exchange design (for example concentrated-liquidity, constant-product, rfq, orderbook or bonding-curve). | | `pairCorrelated` | string | `Eq`, `IsOneOf` | | Whether the pair is correlated, both sides tracking the same reference price (true, false). | | `category` | string | `Eq`, `IsOneOf` | | The RWA asset class (for example government-debt, commodity, equities, private-credit). | | `subCategory` | string | `Eq`, `IsOneOf` | | The sub-class within the category, such as the currency of a government-debt instrument (usd, mxn) or the ticker of an equity; unlabeled where bwr publishes none. | | `tokenIssuerID` | string | `Eq`, `IsOneOf` | yes | The short name of the issuer of the tokenized asset (ondo, backed); unlabeled where bwr publishes none. | | `networkSlug` | string | `Eq`, `IsOneOf` | | The chain's slug in the blockchains model (arbitrum-one); null for chains without a network record. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/rwa-spot-dex-activity/1d/?timeframe=7d&selections=volumeUSD,memecoinVolumeUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get RWA Spot DEX Segment timeseries](/api-reference/data-api/real-world-assets/timeseries-rwa-spot-dex-activity-by-id) for the response and the errors. # List RWA Categories Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/tabular-rwa-categories api-reference/data-api/openapi.json GET /query/tabular/rwa-categories One row per tokenized real-world-asset category (government-debt, commodities, equities, credit), keyed by the category slug: name and sector. The id is the series key of the rwa-by-category timeseries model. # List RWA Chains Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/tabular-rwa-chains api-reference/data-api/openapi.json GET /query/tabular/rwa-chains One row per blockchain with tokenized real-world-asset activity, keyed by the chain slug: name, chain and the mapped network record. The id is the series key of the rwa-by-chain timeseries model. # List RWA Deployments Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/tabular-rwa-deployments api-reference/data-api/openapi.json GET /query/tabular/rwa-deployments One row per tokenized real-world-asset deployment, one token contract on one chain, keyed by chain and contract address: symbol, product, issuer, category and subcategory, the chain and the mapped network and issuer project records. The id is the series key of the rwa-by-deployment timeseries model. # List RWA Issuers Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/tabular-rwa-issuers api-reference/data-api/openapi.json GET /query/tabular/rwa-issuers One row per tokenized real-world-asset issuer, keyed by the issuer slug: name, issuer id and the mapped project record. The id is the series key of the rwa-by-issuer timeseries model. # List RWA Products Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/tabular-rwa-products api-reference/data-api/openapi.json GET /query/tabular/rwa-products One row per tokenized real-world-asset product, one token across all the chains it is deployed on, keyed by the slugified token slug: symbol, token slug, issuer, category and subcategory and the mapped issuer project record. The id is the series key of the rwa-by-product timeseries model. # List RWA Spot DEX Segments Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/tabular-rwa-spot-dex-segments api-reference/data-api/openapi.json GET /query/tabular/rwa-spot-dex-segments One row per RWA spot DEX segment, one category and sub-category from one issuer traded through one pair type on one DEX deployment on one chain: name, project slug, and each of the eight dimensions as its own filterable column. The id is the series key of the rwa-spot-dex-activity timeseries model. # Batch Get RWA Category timeseries Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/timeseries-rwa-by-category api-reference/data-api/openapi.json GET /query/timeseries/rwa-by-category/{granularity} Tokenized real-world-asset metrics summed across every token in one category: chain, deployment, product and issuer counts, supply, mints and burns, where the supply sits (CEX, DEX, wrapped, managed, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one category, keyed by its slug. Lending and DEX fields are null where a category has no such activity, so pass selections. # Get RWA Category timeseries Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/timeseries-rwa-by-category-by-id api-reference/data-api/openapi.json GET /query/timeseries/rwa-by-category/{granularity}/{id} Tokenized real-world-asset metrics summed across every token in one category: chain, deployment, product and issuer counts, supply, mints and burns, where the supply sits (CEX, DEX, wrapped, managed, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one category, keyed by its slug. Lending and DEX fields are null where a category has no such activity, so pass selections. # Batch Get RWA Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/timeseries-rwa-by-chain api-reference/data-api/openapi.json GET /query/timeseries/rwa-by-chain/{granularity} Tokenized real-world-asset metrics summed across every token on one blockchain: deployment, product and issuer counts, supply split by category, supply, mints and burns, where the supply sits (CEX, DEX, wrapped, managed, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. Lending and DEX fields are null where a chain has no such activity, so pass selections. # Get RWA Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/timeseries-rwa-by-chain-by-id api-reference/data-api/openapi.json GET /query/timeseries/rwa-by-chain/{granularity}/{id} Tokenized real-world-asset metrics summed across every token on one blockchain: deployment, product and issuer counts, supply split by category, supply, mints and burns, where the supply sits (CEX, DEX, wrapped, managed, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. Lending and DEX fields are null where a chain has no such activity, so pass selections. # Batch Get RWA Deployment timeseries Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/timeseries-rwa-by-deployment api-reference/data-api/openapi.json GET /query/timeseries/rwa-by-deployment/{granularity} Tokenized real-world-asset metrics for one token contract on one chain: price, supply, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one deployment, keyed by chain and contract address. Many series, so name the deployments you need. # Get RWA Deployment timeseries Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/timeseries-rwa-by-deployment-by-id api-reference/data-api/openapi.json GET /query/timeseries/rwa-by-deployment/{granularity}/{id} Tokenized real-world-asset metrics for one token contract on one chain: price, supply, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one deployment, keyed by chain and contract address. Many series, so name the deployments you need. # Batch Get RWA Issuer timeseries Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/timeseries-rwa-by-issuer api-reference/data-api/openapi.json GET /query/timeseries/rwa-by-issuer/{granularity} Tokenized real-world-asset metrics summed across every token one issuer has issued: chain, product and category counts, supply split by category, supply, mints and burns, where the supply sits (CEX, DEX, wrapped, managed, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its slug. Lending and DEX fields are null where an issuer has no such activity, so pass selections. # Get RWA Issuer timeseries Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/timeseries-rwa-by-issuer-by-id api-reference/data-api/openapi.json GET /query/timeseries/rwa-by-issuer/{granularity}/{id} Tokenized real-world-asset metrics summed across every token one issuer has issued: chain, product and category counts, supply split by category, supply, mints and burns, where the supply sits (CEX, DEX, wrapped, managed, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its slug. Lending and DEX fields are null where an issuer has no such activity, so pass selections. # Batch Get RWA Product timeseries Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/timeseries-rwa-by-product api-reference/data-api/openapi.json GET /query/timeseries/rwa-by-product/{granularity} Tokenized real-world-asset metrics summed across every chain one product is deployed on: chain and deployment counts, supply, mints and burns, where the supply sits (CEX, DEX, wrapped, managed, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one product, keyed by its slugified token slug. Lending and DEX fields are null where a product has no such activity, so pass selections. # Get RWA Product timeseries Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/timeseries-rwa-by-product-by-id api-reference/data-api/openapi.json GET /query/timeseries/rwa-by-product/{granularity}/{id} Tokenized real-world-asset metrics summed across every chain one product is deployed on: chain and deployment counts, supply, mints and burns, where the supply sits (CEX, DEX, wrapped, managed, lending, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one product, keyed by its slugified token slug. Lending and DEX fields are null where a product has no such activity, so pass selections. # Batch Get RWA Spot DEX Segment timeseries Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/timeseries-rwa-spot-dex-activity api-reference/data-api/openapi.json GET /query/timeseries/rwa-spot-dex-activity/{granularity} Daily spot DEX trading of tokenized real-world assets. Each series is one RWA category and sub-category, from one issuer, traded through one pair type on one DEX deployment on one chain, keyed by those eight dimensions joined with underscores. # Get RWA Spot DEX Segment timeseries Source: https://docs.blockworks.com/api-reference/data-api/real-world-assets/timeseries-rwa-spot-dex-activity-by-id api-reference/data-api/openapi.json GET /query/timeseries/rwa-spot-dex-activity/{granularity}/{id} Daily spot DEX trading of tokenized real-world assets. Each series is one RWA category and sub-category, from one issuer, traded through one pair type on one DEX deployment on one chain, keyed by those eight dimensions joined with underscores. # Research Source: https://docs.blockworks.com/api-reference/data-api/research Research: Research Reports (Tabular). > [card] [Research Reports (Tabular)](/api-reference/data-api/research-reports-tabular/overview) > > Research Reports (Tabular): Research Reports. 1 model. # Research Reports (Tabular) Source: https://docs.blockworks.com/api-reference/data-api/research-reports-tabular/overview Research Reports (Tabular): Research Reports. ## Endpoints | Model | Access | Table | | - | - | - | | [Research Reports](/api-reference/data-api/research-reports-tabular/research-reports) | Research-reports-tabular-dataset | [List rows](/api-reference/data-api/research-reports-tabular/tabular-research-reports), [One row](/api-reference/data-api/research-reports-tabular/tabular-research-reports-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/research-reports?pageSize=3&selections=reportID,title,slug,hook" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Research Reports](/api-reference/data-api/research-reports-tabular/tabular-research-reports) for the response and the errors. ## Guides > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Research Reports Source: https://docs.blockworks.com/api-reference/data-api/research-reports-tabular/research-reports One row per published research report, keyed by reportID: title, slug, hook, summary, the full markdown body, publish and update times, reading time, subscription tier, and the authors, tags and assets it covers. Covers every kind of published content, so filter on reportType or category to narrow. | | | | - | - | | Access | Research-reports-tabular-dataset | | Tabular model | `research-reports`: primary key `reportID` | ## Endpoints > [card] [List Research Reports](/api-reference/data-api/research-reports-tabular/tabular-research-reports) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Research Report](/api-reference/data-api/research-reports-tabular/tabular-research-reports-by-id) > > One row by `reportID`. ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `reportID` | string | `Eq`, `IsOneOf` | | The unique identifier of the research report. (primary key) | | `title` | string | `Eq`, `IsOneOf`, `Contains` | yes | The title of the research report. | | `slug` | string | `Eq`, `IsOneOf`, `Contains` | | The URL slug of the research report. Slugs are not unique across reports, so use reportID to address a single one. | | `hook` | string | | | A one-line hook introducing the research report. | | `summary` | string | | | A short summary of the research report. | | `content` | string | | | The full body of the research report as markdown. Omit it from selections to page through reports without transferring the bodies. | | `publishDate` | time | `Eq`, `Gt`, `Gte`, `Lt`, `Lte` | default | When the research report was published. Reports embargoed for a future date are not returned until that date passes. | | `createdAt` | time | `Gt`, `Gte`, `Lt`, `Lte` | yes | When the research report was first created in the content system. | | `updatedAt` | time | `Gt`, `Gte`, `Lt`, `Lte` | yes | When the research report was last edited in the content system. Filter on it to pull only what changed since your last sync. | | `readingTimeInMinutes` | float64 | `Gt`, `Gte`, `Lt`, `Lte` | yes | The estimated time to read the research report, in minutes. | | `subscriptionTier` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The subscription tier the research report is published under (basic, pro, or enterprise). | | `reportType` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The kind of content the row is (e.g. research, enterprise_research, hub, summary, blog, podcast, strapi_article). | | `category` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The editorial category of the research report (e.g. Standard Reports, Deep Dives, Quarterly Reports, Recaps). Null for content that carries no category. | | `previewImageURL` | string | | | URL of the preview image for the research report. | | `assetIDs` | array_string | `Includes`, `NotIncludes`, `IncludesAnyOf`, `NotIncludesAnyOf` | | Asset IDs the research report covers. Use it to find every report written about an asset. | | `assets` | array_object | | | Assets the research report covers, including id, name, symbol and slug. Only published assets resolve, so a report may carry an assetID with no matching entry here. | | `authorNames` | array_string | `Includes`, `NotIncludes`, `IncludesAnyOf`, `NotIncludesAnyOf` | | Names of the research report's authors. Use it to filter by author. | | `authors` | array_object | | | Authors of the research report, including id, name, image and linkedinUrl. | | `tagNames` | array_string | `Includes`, `NotIncludes`, `IncludesAnyOf`, `NotIncludesAnyOf` | | Display names of the tags on the research report. Use it to filter by tag. | | `tags` | array_object | | | Tags on the research report, including id and name. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/research-reports?pageSize=3&selections=reportID,title,slug,hook" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Research Reports](/api-reference/data-api/research-reports-tabular/tabular-research-reports) for the response and the errors. # List Research Reports Source: https://docs.blockworks.com/api-reference/data-api/research-reports-tabular/tabular-research-reports api-reference/data-api/openapi.json GET /query/tabular/research-reports One row per published research report, keyed by reportID: title, slug, hook, summary, the full markdown body, publish and update times, reading time, subscription tier, and the authors, tags and assets it covers. Covers every kind of published content, so filter on reportType or category to narrow. # Get Research Report Source: https://docs.blockworks.com/api-reference/data-api/research-reports-tabular/tabular-research-reports-by-id api-reference/data-api/openapi.json GET /query/tabular/research-reports/{reportID} One row per published research report, keyed by reportID: title, slug, hook, summary, the full markdown body, publish and update times, reading time, subscription tier, and the authors, tags and assets it covers. Covers every kind of published content, so filter on reportType or category to narrow. # Savings Source: https://docs.blockworks.com/api-reference/data-api/savings/overview Savings: Savings Balances, Savings Financials, Savings Performances. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Savings Balances](/api-reference/data-api/savings/savings-balances) | Lending-protocols-dataset | [List rows](/api-reference/data-api/savings/tabular-savings-balances) | [Batch](/api-reference/data-api/savings/timeseries-savings-balances), [One series](/api-reference/data-api/savings/timeseries-savings-balances-by-id) | | [Savings Financials](/api-reference/data-api/savings/savings-financials) | Lending-protocols-dataset | [List rows](/api-reference/data-api/savings/tabular-savings-financials) | [Batch](/api-reference/data-api/savings/timeseries-savings-financials), [One series](/api-reference/data-api/savings/timeseries-savings-financials-by-id) | | [Savings Performances](/api-reference/data-api/savings/savings-performances) | Lending-protocols-dataset | [List rows](/api-reference/data-api/savings/tabular-savings-performances) | [Batch](/api-reference/data-api/savings/timeseries-savings-performances), [One series](/api-reference/data-api/savings/timeseries-savings-performances-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/savings-balances?pageSize=3&selections=id,name,slug,parentSlug" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Savings Balances](/api-reference/data-api/savings/tabular-savings-balances) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Savings Balances Source: https://docs.blockworks.com/api-reference/data-api/savings/savings-balances Deposits held in onchain savings products in USD, with the deposit cap, gross and net flows, share tokens outstanding and share price. Each series is one savings balance, keyed by protocol, chain, savings product, token, balance type and balance subtype. Many series, so name the balances you need. One row per savings balance, keyed by protocol, chain, savings product, token, balance type and balance subtype: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the savings-balances timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `savings-balances`: primary key `id` | | Timeseries model | `savings-balances`: intervals `1d`, series key `id` (Savings Balance ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Savings Balances](/api-reference/data-api/savings/tabular-savings-balances) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Savings Balance timeseries](/api-reference/data-api/savings/timeseries-savings-balances) > > Up to 10 series in one request, named by Savings Balance ID in `series`. > [card] [Get Savings Balance timeseries](/api-reference/data-api/savings/timeseries-savings-balances-by-id) > > One series over a time window, keyed by its Savings Balance ID. ## Metrics 7 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `balanceUSD` | Balance (USD) | float64 | | Balance in USD. | | `balanceCapUSD` | Balance Cap (USD) | float64 | | Balance cap in USD. | | `grossInflowUSD` | Gross Inflow (USD) | float64 | | Gross inflow to the balance in USD. | | `grossOutflowUSD` | Gross Outflow (USD) | float64 | | Gross outflow from the balance in USD, stored as a negative number. | | `netFlowUSD` | Net Flow (USD) | float64 | | Net flow (inflow plus outflow) in USD. | | `totalShares` | Total Shares | float64 | | Total share tokens outstanding. | | `sharePrice` | Share Price | float64 | | Share token price in the underlying token. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the savings-balances timeseries model, the parent slug, chain, savings id, token address, balance type and balance subtype, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the balance, the savings product name, token symbol and balance subtype (or type). | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol. | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain (ethereum, base, solana). | | `savingsID` | string | `Eq`, `IsOneOf` | | The savings product's identifier. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `balanceType` | string | `Eq`, `IsOneOf` | | The balance type as classified by Blockworks Research. | | `balanceSubtype` | string | `Eq`, `IsOneOf` | | The finer balance classification; null where none is distinguished. | | `savingsName` | string | `Eq`, `IsOneOf`, `Contains` | | The savings product's display name. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/savings-balances/1d/?timeframe=7d&selections=balanceUSD,balanceCapUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Savings Balance timeseries](/api-reference/data-api/savings/timeseries-savings-balances-by-id) for the response and the errors. # Savings Financials Source: https://docs.blockworks.com/api-reference/data-api/savings/savings-financials Net yield paid to depositors in each onchain savings product, in USD. Each series is one savings product token, keyed by protocol, chain, savings product and token. One row per savings financial, keyed by protocol, chain, savings product and token: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the savings-financials timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `savings-financials`: primary key `id` | | Timeseries model | `savings-financials`: intervals `1d`, series key `id` (Savings Financial ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Savings Financials](/api-reference/data-api/savings/tabular-savings-financials) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Savings Financial timeseries](/api-reference/data-api/savings/timeseries-savings-financials) > > Up to 10 series in one request, named by Savings Financial ID in `series`. > [card] [Get Savings Financial timeseries](/api-reference/data-api/savings/timeseries-savings-financials-by-id) > > One series over a time window, keyed by its Savings Financial ID. ## Metrics 1 metric. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `netYieldUSD` | Net Yield (USD) | float64 | | Net yield paid to depositors in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the savings-financials timeseries model, the parent slug, chain, savings id and token address, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the savings product name and token symbol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol. | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain (ethereum, base, solana). | | `savingsID` | string | `Eq`, `IsOneOf` | | The savings product's identifier. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `savingsName` | string | `Eq`, `IsOneOf`, `Contains` | | The savings product's display name. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/savings-financials/1d/?timeframe=7d&selections=netYieldUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Savings Financial timeseries](/api-reference/data-api/savings/timeseries-savings-financials-by-id) for the response and the errors. # Savings Performances Source: https://docs.blockworks.com/api-reference/data-api/savings/savings-performances Net yield paid to depositors in each onchain savings product, as APR and APY, with the balance it was paid on. Each series is one savings product token, keyed by protocol, chain, savings product and token. One row per savings performance, keyed by protocol, chain, savings product and token: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the savings-performances timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `savings-performances`: primary key `id` | | Timeseries model | `savings-performances`: intervals `1d`, series key `id` (Savings Performance ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Savings Performances](/api-reference/data-api/savings/tabular-savings-performances) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Savings Performance timeseries](/api-reference/data-api/savings/timeseries-savings-performances) > > Up to 10 series in one request, named by Savings Performance ID in `series`. > [card] [Get Savings Performance timeseries](/api-reference/data-api/savings/timeseries-savings-performances-by-id) > > One series over a time window, keyed by its Savings Performance ID. ## Metrics 3 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `netYieldAPR` | Net Yield APR | float64 | | Net yield paid to depositors, APR. | | `netYieldAPY` | Net Yield APY | float64 | | Net yield paid to depositors, APY. | | `balanceUSD` | Balance (USD) | float64 | | Balance in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the savings-performances timeseries model, the parent slug, chain, savings id and token address, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the savings product name and token symbol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol. | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain (ethereum, base, solana). | | `savingsID` | string | `Eq`, `IsOneOf` | | The savings product's identifier. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `savingsName` | string | `Eq`, `IsOneOf`, `Contains` | | The savings product's display name. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/savings-performances/1d/?timeframe=7d&selections=netYieldAPR,netYieldAPY" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Savings Performance timeseries](/api-reference/data-api/savings/timeseries-savings-performances-by-id) for the response and the errors. # List Savings Balances Source: https://docs.blockworks.com/api-reference/data-api/savings/tabular-savings-balances api-reference/data-api/openapi.json GET /query/tabular/savings-balances One row per savings balance, keyed by protocol, chain, savings product, token, balance type and balance subtype: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the savings-balances timeseries model. # List Savings Financials Source: https://docs.blockworks.com/api-reference/data-api/savings/tabular-savings-financials api-reference/data-api/openapi.json GET /query/tabular/savings-financials One row per savings financial, keyed by protocol, chain, savings product and token: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the savings-financials timeseries model. # List Savings Performances Source: https://docs.blockworks.com/api-reference/data-api/savings/tabular-savings-performances api-reference/data-api/openapi.json GET /query/tabular/savings-performances One row per savings performance, keyed by protocol, chain, savings product and token: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the savings-performances timeseries model. # Batch Get Savings Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/savings/timeseries-savings-balances api-reference/data-api/openapi.json GET /query/timeseries/savings-balances/{granularity} Deposits held in onchain savings products in USD, with the deposit cap, gross and net flows, share tokens outstanding and share price. Each series is one savings balance, keyed by protocol, chain, savings product, token, balance type and balance subtype. Many series, so name the balances you need. # Get Savings Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/savings/timeseries-savings-balances-by-id api-reference/data-api/openapi.json GET /query/timeseries/savings-balances/{granularity}/{id} Deposits held in onchain savings products in USD, with the deposit cap, gross and net flows, share tokens outstanding and share price. Each series is one savings balance, keyed by protocol, chain, savings product, token, balance type and balance subtype. Many series, so name the balances you need. # Batch Get Savings Financial timeseries Source: https://docs.blockworks.com/api-reference/data-api/savings/timeseries-savings-financials api-reference/data-api/openapi.json GET /query/timeseries/savings-financials/{granularity} Net yield paid to depositors in each onchain savings product, in USD. Each series is one savings product token, keyed by protocol, chain, savings product and token. # Get Savings Financial timeseries Source: https://docs.blockworks.com/api-reference/data-api/savings/timeseries-savings-financials-by-id api-reference/data-api/openapi.json GET /query/timeseries/savings-financials/{granularity}/{id} Net yield paid to depositors in each onchain savings product, in USD. Each series is one savings product token, keyed by protocol, chain, savings product and token. # Batch Get Savings Performance timeseries Source: https://docs.blockworks.com/api-reference/data-api/savings/timeseries-savings-performances api-reference/data-api/openapi.json GET /query/timeseries/savings-performances/{granularity} Net yield paid to depositors in each onchain savings product, as APR and APY, with the balance it was paid on. Each series is one savings product token, keyed by protocol, chain, savings product and token. # Get Savings Performance timeseries Source: https://docs.blockworks.com/api-reference/data-api/savings/timeseries-savings-performances-by-id api-reference/data-api/openapi.json GET /query/timeseries/savings-performances/{granularity}/{id} Net yield paid to depositors in each onchain savings product, as APR and APY, with the balance it was paid on. Each series is one savings product token, keyed by protocol, chain, savings product and token. # Sector Market Data Source: https://docs.blockworks.com/api-reference/data-api/sector-market-data/overview Sector Market Data: Sector Marketdata, Sub-Sector Marketdata. ## Endpoints | Model | Access | Timeseries | | - | - | - | | [Sector Marketdata](/api-reference/data-api/sector-market-data/sector-marketdata) | Sector-marketdata-dataset | [Batch](/api-reference/data-api/sector-market-data/timeseries-sector-marketdata), [One series](/api-reference/data-api/sector-market-data/timeseries-sector-marketdata-by-id) | | [Sub-Sector Marketdata](/api-reference/data-api/sector-market-data/sub-sector-marketdata) | Sector-marketdata-dataset | [Batch](/api-reference/data-api/sector-market-data/timeseries-sub-sector-marketdata), [One series](/api-reference/data-api/sector-market-data/timeseries-sub-sector-marketdata-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/sector-marketdata/1d?timeframe=7d&selections=circulating-marketcap,volume" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Batch Get Sector timeseries](/api-reference/data-api/sector-market-data/timeseries-sector-marketdata) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Sector Marketdata Source: https://docs.blockworks.com/api-reference/data-api/sector-market-data/sector-marketdata Circulating market capitalization and trading volume in USD summed over the assets in a sector. Each series is one sector, keyed by its name. | | | | - | - | | Access | Sector-marketdata-dataset | | Timeseries model | `sector-marketdata`: intervals `1d`, `1h`, series key `sector` (Sectors), every series available in one call | ## Endpoints > [card] [Batch Get Sector timeseries](/api-reference/data-api/sector-market-data/timeseries-sector-marketdata) > > Every series in one request, or the named ones. > [card] [Get Sector timeseries](/api-reference/data-api/sector-market-data/timeseries-sector-marketdata-by-id) > > One series over a time window, keyed by its Sectors. ## Metrics 2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `circulating-marketcap` | Circulating Marketcap | float64 | usd | The circulating marketcap of the sector. | | `volume` | Volume | float64 | usd | The volume of the sector during the time interval. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/sector-marketdata/1d/AI?timeframe=7d&selections=circulating-marketcap,volume" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Sector timeseries](/api-reference/data-api/sector-market-data/timeseries-sector-marketdata-by-id) for the response and the errors. # Sub-Sector Marketdata Source: https://docs.blockworks.com/api-reference/data-api/sector-market-data/sub-sector-marketdata Circulating market capitalization and trading volume in USD summed over the assets in a sub-sector. Each series is one sub-sector, keyed by its name. | | | | - | - | | Access | Sector-marketdata-dataset | | Timeseries model | `sub-sector-marketdata`: intervals `1d`, `1h`, series key `sub-sector` (Sub-Sectors), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Sub-Sector timeseries](/api-reference/data-api/sector-market-data/timeseries-sub-sector-marketdata) > > Up to 10 series in one request, named by Sub-Sectors in `series`. > [card] [Get Sub-Sector timeseries](/api-reference/data-api/sector-market-data/timeseries-sub-sector-marketdata-by-id) > > One series over a time window, keyed by its Sub-Sectors. ## Metrics 2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `circulating-marketcap` | Circulating Marketcap | float64 | usd | The circulating marketcap of the sub-sector. | | `volume` | Volume | float64 | usd | The volume of the sub-sector during the time interval. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/sub-sector-marketdata/1d/AAA%20Games?timeframe=7d&selections=circulating-marketcap,volume" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Sub-Sector timeseries](/api-reference/data-api/sector-market-data/timeseries-sub-sector-marketdata-by-id) for the response and the errors. # Batch Get Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/sector-market-data/timeseries-sector-marketdata api-reference/data-api/openapi.json GET /query/timeseries/sector-marketdata/{granularity} Circulating market capitalization and trading volume in USD summed over the assets in a sector. Each series is one sector, keyed by its name. # Get Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/sector-market-data/timeseries-sector-marketdata-by-id api-reference/data-api/openapi.json GET /query/timeseries/sector-marketdata/{granularity}/{sector} Circulating market capitalization and trading volume in USD summed over the assets in a sector. Each series is one sector, keyed by its name. # Batch Get Sub-Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/sector-market-data/timeseries-sub-sector-marketdata api-reference/data-api/openapi.json GET /query/timeseries/sub-sector-marketdata/{granularity} Circulating market capitalization and trading volume in USD summed over the assets in a sub-sector. Each series is one sub-sector, keyed by its name. # Get Sub-Sector timeseries Source: https://docs.blockworks.com/api-reference/data-api/sector-market-data/timeseries-sub-sector-marketdata-by-id api-reference/data-api/openapi.json GET /query/timeseries/sub-sector-marketdata/{granularity}/{sub-sector} Circulating market capitalization and trading volume in USD summed over the assets in a sub-sector. Each series is one sub-sector, keyed by its name. # Social & Mindshare Source: https://docs.blockworks.com/api-reference/data-api/social-mindshare Social & Mindshare: Mindshare & Sentiment. > [card] [Mindshare & Sentiment](/api-reference/data-api/mindshare-sentiment/overview) > > Mindshare & Sentiment: Asset Group Sentiment, Asset Investor Mentions, Asset Mindshare, Asset Sentiment, Project Mindshare, Sector Asset Mindshare, Sector Asset Sentiment, Sector Investor Mentions, Sub-Sector Asset Mindshare, Sub-Sector Asset Sentiment. 10 models. # Spot DEX Protocols Source: https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/overview Spot DEX Protocols: Spot DEX Protocols, Spot DEX Protocols by Chain. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Spot DEX Protocols](/api-reference/data-api/spot-dex-protocols/spot-dex-protocols) | Spot-dex-protocols-dataset | [List rows](/api-reference/data-api/spot-dex-protocols/tabular-spot-dex-protocols) | [Batch](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols), [One series](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols-by-id) | | [Spot DEX Liquidity Balances](/api-reference/data-api/spot-dex-protocols/spot-dex-liquidity-balances) | Spot-dex-protocols-dataset | [List rows](/api-reference/data-api/spot-dex-protocols/tabular-spot-dex-liquidity-balances) | [Batch](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-liquidity-balances), [One series](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-liquidity-balances-by-id) | | [Spot DEX Protocols by Chain](/api-reference/data-api/spot-dex-protocols/spot-dex-protocols-by-chain) | Spot-dex-protocols-dataset | [List rows](/api-reference/data-api/spot-dex-protocols/tabular-spot-dex-protocol-chains) | [Batch](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols-by-chain), [One series](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols-by-chain-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/spot-dex-protocols?pageSize=3&selections=id,slug,name,projectID" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Spot DEX Protocols](/api-reference/data-api/spot-dex-protocols/tabular-spot-dex-protocols) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Spot DEX Liquidity Balances Source: https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/spot-dex-liquidity-balances Daily token balance, in native units and USD, held as liquidity by one spot DEX deployment for one token on one chain. Each series is one deployment token balance, keyed by chain, exchange, version, design and token address. Many series per exchange, so name the balances you need. One row per token held as liquidity by one spot DEX deployment on one chain, keyed by chain, exchange, version, design and token address: the exchange, its version and design, the token, the chain and the mapped network record. The id is the series key of the spot-dex-liquidity-balances timeseries model. | | | | - | - | | Access | Spot-dex-protocols-dataset | | Tabular model | `spot-dex-liquidity-balances`: primary key `id` | | Timeseries model | `spot-dex-liquidity-balances`: intervals `1d`, series key `id` (Spot DEX Liquidity Balance ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Spot DEX Liquidity Balances](/api-reference/data-api/spot-dex-protocols/tabular-spot-dex-liquidity-balances) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Spot DEX Liquidity Balance timeseries](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-liquidity-balances) > > Up to 10 series in one request, named by Spot DEX Liquidity Balance ID in `series`. > [card] [Get Spot DEX Liquidity Balance timeseries](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-liquidity-balances-by-id) > > One series over a time window, keyed by its Spot DEX Liquidity Balance ID. ## Metrics 2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `balance` | Balance | float64 | | Token balance held as liquidity, in native units. | | `balanceUSD` | Balance (USD) | float64 | | Token balance held as liquidity in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the spot-dex-liquidity-balances timeseries model, the chain, exchange id, exchange version, exchange type and token address, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the balance, the exchange deployment and token. | | `slug` | string | `Eq`, `IsOneOf` | yes | The exchange's project slug, the slug used for the same project across the API; null when unmapped. | | `chain` | string | `Eq`, `IsOneOf` | yes | The short name of the chain (ethereum, base, solana). | | `exchangeID` | string | `Eq`, `IsOneOf` | yes | The exchange's identifier (uniswap, aerodrome, trader-joe). | | `exchangeVersion` | string | `Eq`, `IsOneOf` | | The exchange version or deployment (v3, slipstream, lb-2.1). | | `exchangeType` | string | `Eq`, `IsOneOf` | | The exchange design (concentrated-liquidity, constant-product, orderbook); unlabeled where unknown. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); unlabeled for the unclassified-token remainder. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | | `networkSlug` | string | `Eq`, `IsOneOf` | | The chain's slug in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/spot-dex-liquidity-balances/1d/?timeframe=7d&selections=balance,balanceUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Spot DEX Liquidity Balance timeseries](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-liquidity-balances-by-id) for the response and the errors. # Spot DEX Protocols Source: https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/spot-dex-protocols Spot DEX metrics for a protocol across its versions and chains: total and wash-adjusted volume, trade count, aggregator versus platform volume, volume by token category and in major pairs, and the memecoin share, and swap fees split between liquidity providers and the protocol. Each series is one protocol, keyed by its slug. Pair and category fields are null where a protocol has no such trading, so pass selections. One row per spot decentralized exchange protocol, counted once across its chains and versions, keyed by its short name: name, project slug and project id. The id is the series key of the spot-dex-protocols timeseries model. | | | | - | - | | Access | Spot-dex-protocols-dataset | | Tabular model | `spot-dex-protocols`: primary key `id`, identifiers `slug` | | Timeseries model | `spot-dex-protocols`: intervals `1d`, series key `id` (Project ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Spot DEX Protocols](/api-reference/data-api/spot-dex-protocols/tabular-spot-dex-protocols) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Spot DEX Protocol timeseries](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols) > > Up to 10 series in one request, named by Project ID in `series`. > [card] [Get Spot DEX Protocol timeseries](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols-by-id) > > One series over a time window, keyed by its Project ID. ## Metrics 30 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `volume-usd` | Volume (USD) | float64 | | Total spot trading volume in USD. | | `correlated-volume-usd` | Correlated Volume (USD) | float64 | | Volume between correlated assets (wash-adjusted view) in USD. | | `trade-count` | Trade Count | float64 | | Total trade count. | | `aggregator-volume-usd` | Aggregator Volume (USD) | float64 | | Volume routed through aggregators in USD. | | `platform-volume-usd` | Platform Volume (USD) | float64 | | Volume traded directly on the platform in USD. | | `aggregator-trade-count` | Aggregator Trade Count | float64 | | Trades routed through aggregators. | | `platform-trade-count` | Platform Trade Count | float64 | | Trades executed directly on the platform. | | `category-nativestablecoin-volume-usd` | Native Stablecoin Volume (USD) | float64 | | Volume in native stablecoin pairs in USD. | | `category-chaintoken-volume-usd` | Chain Token Volume (USD) | float64 | | Volume in chain token pairs in USD. | | `category-foreigntoken-volume-usd` | Foreign Token Volume (USD) | float64 | | Volume in foreign token pairs in USD. | | `category-stablecoinswaps-volume-usd` | Stablecoin Swaps Volume (USD) | float64 | | Volume in stablecoin-to-stablecoin swaps in USD. | | `category-lstswaps-volume-usd` | LST Swaps Volume (USD) | float64 | | Volume in liquid staking token swaps in USD. | | `category-composites-volume-usd` | Composites Volume (USD) | float64 | | Volume in composite token pairs in USD. | | `category-tokenizedassets-volume-usd` | Tokenized Assets Volume (USD) | float64 | | Volume in tokenized asset pairs in USD. | | `category-projecttokens-volume-usd` | Project Tokens Volume (USD) | float64 | | Volume in project token pairs in USD. | | `category-memes-volume-usd` | Memecoin Volume (USD) | float64 | | Volume in memecoin pairs in USD. | | `memecoin-volume-share` | Memecoin Volume Share | float64 | | Memecoin volume as a share of total volume (0-1). | | `pair-bitcoin-usd-volume-usd` | BTC/USD Volume (USD) | float64 | | BTC/USD pair volume in USD. | | `pair-ethereum-usd-volume-usd` | ETH/USD Volume (USD) | float64 | | ETH/USD pair volume in USD. | | `pair-solana-usd-volume-usd` | SOL/USD Volume (USD) | float64 | | SOL/USD pair volume in USD. | | `pair-avalanche-usd-volume-usd` | AVAX/USD Volume (USD) | float64 | | AVAX/USD pair volume in USD. | | `pair-bnb-usd-volume-usd` | BNB/USD Volume (USD) | float64 | | BNB/USD pair volume in USD. | | `pair-bitcoin-ethereum-volume-usd` | BTC/ETH Volume (USD) | float64 | | BTC/ETH pair volume in USD. | | `pair-bitcoin-solana-volume-usd` | BTC/SOL Volume (USD) | float64 | | BTC/SOL pair volume in USD. | | `pair-ethereum-solana-volume-usd` | ETH/SOL Volume (USD) | float64 | | ETH/SOL pair volume in USD. | | `pair-fx-volume-usd` | FX Volume (USD) | float64 | | FX pair volume in USD. | | `pair-eur-usd-volume-usd` | EUR/USD Volume (USD) | float64 | | EUR/USD pair volume in USD. | | `fees-usd` | Fees (USD) | float64 | | Swap fees charged at the pool in USD, supply-side fees plus protocol fees. | | `supply-side-fees-usd` | Supply-Side Fees (USD) | float64 | | Swap fees paid to liquidity providers in USD. | | `protocol-fees-usd` | Protocol Fees (USD) | float64 | | Swap fees kept by the protocol in USD (for example the Uniswap fee switch). | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the spot-dex-protocols timeseries model, the protocol's short name (uniswap). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the protocol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The protocol's project slug, the slug used for the same protocol across the API; null for venues without a project record. (identifier 1) | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the protocol's project record; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/spot-dex-protocols/1d/0x%20API?timeframe=7d&selections=volume-usd,correlated-volume-usd" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Spot DEX Protocol timeseries](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols-by-id) for the response and the errors. # Spot DEX Protocols by Chain Source: https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/spot-dex-protocols-by-chain The spot-dex-protocols volume, trade count, aggregator versus platform and token-category metrics and swap fees broken down by protocol version and blockchain. Each series is one version on one chain, keyed by protocol, version and chain. Category fields are null where a deployment has no such trading, so pass selections. One row per spot DEX deployment, one protocol version on one blockchain, keyed by protocol, version and chain: name, protocol, version, exchange type, chain and network slug. The id is the series key of the spot-dex-protocols-by-chain timeseries model. | | | | - | - | | Access | Spot-dex-protocols-dataset | | Tabular model | `spot-dex-protocol-chains`: primary key `id`, identifiers `slug` | | Timeseries model | `spot-dex-protocols-by-chain`: intervals `1d`, series key `id` (Protocol Version Chain ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Spot DEX Protocol Chains](/api-reference/data-api/spot-dex-protocols/tabular-spot-dex-protocol-chains) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Spot DEX Protocol Chain timeseries](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols-by-chain) > > Up to 10 series in one request, named by Protocol Version Chain ID in `series`. > [card] [Get Spot DEX Protocol Chain timeseries](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols-by-chain-by-id) > > One series over a time window, keyed by its Protocol Version Chain ID. ## Metrics 19 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `volume-usd` | Volume (USD) | float64 | | Total spot trading volume in USD. | | `correlated-volume-usd` | Correlated Volume (USD) | float64 | | Volume between correlated assets (wash-adjusted view) in USD. | | `trade-count` | Trade Count | float64 | | Total trade count. | | `aggregator-volume-usd` | Aggregator Volume (USD) | float64 | | Volume routed through aggregators in USD. | | `platform-volume-usd` | Platform Volume (USD) | float64 | | Volume traded directly on the platform in USD. | | `aggregator-trade-count` | Aggregator Trade Count | float64 | | Trades routed through aggregators. | | `platform-trade-count` | Platform Trade Count | float64 | | Trades executed directly on the platform. | | `category-nativestablecoin-volume-usd` | Native Stablecoin Volume (USD) | float64 | | Volume in native stablecoin pairs in USD. | | `category-chaintoken-volume-usd` | Chain Token Volume (USD) | float64 | | Volume in chain token pairs in USD. | | `category-foreigntoken-volume-usd` | Foreign Token Volume (USD) | float64 | | Volume in foreign token pairs in USD. | | `category-stablecoinswaps-volume-usd` | Stablecoin Swaps Volume (USD) | float64 | | Volume in stablecoin-to-stablecoin swaps in USD. | | `category-lstswaps-volume-usd` | LST Swaps Volume (USD) | float64 | | Volume in liquid staking token swaps in USD. | | `category-composites-volume-usd` | Composites Volume (USD) | float64 | | Volume in composite token pairs in USD. | | `category-tokenizedassets-volume-usd` | Tokenized Assets Volume (USD) | float64 | | Volume in tokenized asset pairs in USD. | | `category-projecttokens-volume-usd` | Project Tokens Volume (USD) | float64 | | Volume in project token pairs in USD. | | `category-memes-volume-usd` | Memecoin Volume (USD) | float64 | | Volume in memecoin pairs in USD. | | `fees-usd` | Fees (USD) | float64 | | Swap fees charged at the pool in USD, supply-side fees plus protocol fees. | | `supply-side-fees-usd` | Supply-Side Fees (USD) | float64 | | Swap fees paid to liquidity providers in USD. | | `protocol-fees-usd` | Protocol Fees (USD) | float64 | | Swap fees kept by the protocol in USD (for example the Uniswap fee switch). | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the spot-dex-protocols-by-chain timeseries model, the protocol, version and chain joined with underscores (uniswap_v3_arbitrum). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the deployment, the protocol's short name followed by its version (uniswap v3). | | `slug` | string | `Eq`, `IsOneOf` | yes | The protocol's project slug; null for venues without a project record. (identifier 1) | | `exchangeID` | string | `Eq`, `IsOneOf` | yes | The protocol's short name, the id in spot-dex-protocols (uniswap). | | `exchangeVersion` | string | `Eq`, `IsOneOf` | | The version label of the deployment (v2, v3, settler). | | `exchangeType` | string | `Eq`, `IsOneOf` | | The exchange design (for example concentrated-liquidity, constant-product, rfq, orderbook or bonding-curve). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the deployment runs on (ethereum, arbitrum, solana). | | `networkSlug` | string | `Eq`, `IsOneOf` | | The chain's slug in the blockchains model (arbitrum-one). | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/spot-dex-protocols-by-chain/1d/0x%20API_settler_arbitrum?timeframe=7d&selections=volume-usd,correlated-volume-usd" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Spot DEX Protocol Chain timeseries](/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols-by-chain-by-id) for the response and the errors. # List Spot DEX Liquidity Balances Source: https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/tabular-spot-dex-liquidity-balances api-reference/data-api/openapi.json GET /query/tabular/spot-dex-liquidity-balances One row per token held as liquidity by one spot DEX deployment on one chain, keyed by chain, exchange, version, design and token address: the exchange, its version and design, the token, the chain and the mapped network record. The id is the series key of the spot-dex-liquidity-balances timeseries model. # List Spot DEX Protocol Chains Source: https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/tabular-spot-dex-protocol-chains api-reference/data-api/openapi.json GET /query/tabular/spot-dex-protocol-chains One row per spot DEX deployment, one protocol version on one blockchain, keyed by protocol, version and chain: name, protocol, version, exchange type, chain and network slug. The id is the series key of the spot-dex-protocols-by-chain timeseries model. # List Spot DEX Protocols Source: https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/tabular-spot-dex-protocols api-reference/data-api/openapi.json GET /query/tabular/spot-dex-protocols One row per spot decentralized exchange protocol, counted once across its chains and versions, keyed by its short name: name, project slug and project id. The id is the series key of the spot-dex-protocols timeseries model. # Batch Get Spot DEX Liquidity Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-liquidity-balances api-reference/data-api/openapi.json GET /query/timeseries/spot-dex-liquidity-balances/{granularity} Daily token balance, in native units and USD, held as liquidity by one spot DEX deployment for one token on one chain. Each series is one deployment token balance, keyed by chain, exchange, version, design and token address. Many series per exchange, so name the balances you need. # Get Spot DEX Liquidity Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-liquidity-balances-by-id api-reference/data-api/openapi.json GET /query/timeseries/spot-dex-liquidity-balances/{granularity}/{id} Daily token balance, in native units and USD, held as liquidity by one spot DEX deployment for one token on one chain. Each series is one deployment token balance, keyed by chain, exchange, version, design and token address. Many series per exchange, so name the balances you need. # Batch Get Spot DEX Protocol timeseries Source: https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols api-reference/data-api/openapi.json GET /query/timeseries/spot-dex-protocols/{granularity} Spot DEX metrics for a protocol across its versions and chains: total and wash-adjusted volume, trade count, aggregator versus platform volume, volume by token category and in major pairs, and the memecoin share, and swap fees split between liquidity providers and the protocol. Each series is one protocol, keyed by its slug. Pair and category fields are null where a protocol has no such trading, so pass selections. # Batch Get Spot DEX Protocol Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols-by-chain api-reference/data-api/openapi.json GET /query/timeseries/spot-dex-protocols-by-chain/{granularity} The spot-dex-protocols volume, trade count, aggregator versus platform and token-category metrics and swap fees broken down by protocol version and blockchain. Each series is one version on one chain, keyed by protocol, version and chain. Category fields are null where a deployment has no such trading, so pass selections. # Get Spot DEX Protocol Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols-by-chain-by-id api-reference/data-api/openapi.json GET /query/timeseries/spot-dex-protocols-by-chain/{granularity}/{id} The spot-dex-protocols volume, trade count, aggregator versus platform and token-category metrics and swap fees broken down by protocol version and blockchain. Each series is one version on one chain, keyed by protocol, version and chain. Category fields are null where a deployment has no such trading, so pass selections. # Get Spot DEX Protocol timeseries Source: https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-protocols-by-id api-reference/data-api/openapi.json GET /query/timeseries/spot-dex-protocols/{granularity}/{id} Spot DEX metrics for a protocol across its versions and chains: total and wash-adjusted volume, trade count, aggregator versus platform volume, volume by token category and in major pairs, and the memecoin share, and swap fees split between liquidity providers and the protocol. Each series is one protocol, keyed by its slug. Pair and category fields are null where a protocol has no such trading, so pass selections. # Stablecoins Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/overview Stablecoin supply, mints and burns, and where the supply sits, at four grains: token, issuer, peg currency and chain. Two more models cover onchain FX between stablecoins and reserve attestations. Each series has a lookup table that gives its keys. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Stablecoin FX](/api-reference/data-api/stablecoins/stablecoin-fx) | Stablecoins-dataset | [List rows](/api-reference/data-api/stablecoins/tabular-stablecoin-fx-pairs) | [Batch](/api-reference/data-api/stablecoins/timeseries-stablecoin-fx), [One series](/api-reference/data-api/stablecoins/timeseries-stablecoin-fx-by-id) | | [Stablecoin Reserves](/api-reference/data-api/stablecoins/stablecoin-reserves) | Stablecoins-dataset | [List rows](/api-reference/data-api/stablecoins/tabular-stablecoin-reserve-entities) | [Batch](/api-reference/data-api/stablecoins/timeseries-stablecoin-reserves), [One series](/api-reference/data-api/stablecoins/timeseries-stablecoin-reserves-by-id) | | [Stablecoins by Chain](/api-reference/data-api/stablecoins/stablecoins-by-chain) | Stablecoins-dataset | [List rows](/api-reference/data-api/stablecoins/tabular-stablecoin-chains) | [Batch](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-chain), [One series](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-chain-by-id) | | [Stablecoins by Currency](/api-reference/data-api/stablecoins/stablecoins-by-currency) | Stablecoins-dataset | [List rows](/api-reference/data-api/stablecoins/tabular-stablecoin-currencies) | [Batch](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-currency), [One series](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-currency-by-id) | | [Stablecoins by Deployment](/api-reference/data-api/stablecoins/stablecoins-by-deployment) | Stablecoins-dataset | [List rows](/api-reference/data-api/stablecoins/tabular-stablecoin-deployments) | [Batch](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-deployment), [One series](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-deployment-by-id) | | [Stablecoins by Issuer](/api-reference/data-api/stablecoins/stablecoins-by-issuer) | Stablecoins-dataset | [List rows](/api-reference/data-api/stablecoins/tabular-stablecoin-issuers) | [Batch](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-issuer), [One series](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-issuer-by-id) | | [Stablecoins by Product](/api-reference/data-api/stablecoins/stablecoins-by-product) | Stablecoins-dataset | [List rows](/api-reference/data-api/stablecoins/tabular-stablecoin-products) | [Batch](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-product), [One series](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-product-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/stablecoin-fx-pairs?pageSize=3&selections=id,name,pairType,baseCurrency" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Stablecoin FX Pairs](/api-reference/data-api/stablecoins/tabular-stablecoin-fx-pairs) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Stablecoin FX Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/stablecoin-fx Onchain foreign-exchange activity between stablecoins for a currency pair: swap volume in USD, number of swaps, and the chains and DEXes the pair traded on. Cross-currency pairs capture stablecoin FX; same-currency pairs capture swaps between stablecoins of one currency. Each series is one pair, keyed by base and quote currency codes. One row per currency pair traded onchain between stablecoins, keyed by base and quote currency codes: display name, pair type (cross-currency or same-currency) and both currencies. The id is the series key of the stablecoin-fx timeseries model. | | | | - | - | | Access | Stablecoins-dataset | | Tabular model | `stablecoin-fx-pairs`: primary key `id` | | Timeseries model | `stablecoin-fx`: intervals `1d`, series key `id` (Currency Pair), series must be named (up to 10 per call) | ## Endpoints > [card] [List Stablecoin FX Pairs](/api-reference/data-api/stablecoins/tabular-stablecoin-fx-pairs) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Currency Pair timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoin-fx) > > Up to 10 series in one request, named by Currency Pair in `series`. > [card] [Get Currency Pair timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoin-fx-by-id) > > One series over a time window, keyed by its Currency Pair. ## Metrics 4 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `volumeUSD` | Volume (USD) | float64 | | DEX swap volume for the currency pair in USD. | | `tradeCount` | Trade Count | float64 | | Number of swaps for the currency pair. | | `chainCount` | Chain Count | float64 | | Number of blockchains the currency pair traded on that day. | | `exchangeCount` | Exchange Count | float64 | | Number of DEXes the currency pair traded on that day. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the stablecoin-fx timeseries model, the lowercase base and quote currency codes joined with a hyphen (eur-usd). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the currency pair (for example EUR/USD). | | `pairType` | string | `Eq`, `IsOneOf` | yes | fx for cross-currency trades, same-currency for stablecoin-to-stablecoin trades within one currency. | | `baseCurrency` | string | `Eq`, `IsOneOf` | yes | The base currency of the pair. | | `quoteCurrency` | string | `Eq`, `IsOneOf` | yes | The quote currency of the pair. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/stablecoin-fx/1d/ars-usd?timeframe=7d&selections=volumeUSD,tradeCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Currency Pair timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoin-fx-by-id) for the response and the errors. # Stablecoin Reserves Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/stablecoin-reserves Reserve attestations for a stablecoin: tokens in circulation, fair value of the reserves and the reserve ratio on each report date, with the reserve mix broken down by asset type (Treasuries, repo, cash, money market funds, precious metals, loans, crypto and more). Each series is one stablecoin, keyed by issuer and token, with one point per attestation rather than one per day. One row per stablecoin with reserve attestations, keyed by issuer and token: name, symbol, issuer, reserve currency, auditor and the latest report date. The id is the series key of the stablecoin-reserves timeseries model. | | | | - | - | | Access | Stablecoins-dataset | | Tabular model | `stablecoin-reserve-entities`: primary key `id` | | Timeseries model | `stablecoin-reserves`: intervals `1d`, series key `id` (Reserve ID), every series available in one call | ## Endpoints > [card] [List Stablecoin Reserves](/api-reference/data-api/stablecoins/tabular-stablecoin-reserve-entities) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Stablecoin Reserve timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoin-reserves) > > Every series in one request, or the named ones. > [card] [Get Stablecoin Reserve timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoin-reserves-by-id) > > One series over a time window, keyed by its Reserve ID. ## Metrics 17 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `circulation` | Circulation | float64 | | Tokens in circulation per the attestation. | | `circulationUSD` | Circulation (USD) | float64 | | Tokens in circulation per the attestation, in USD. | | `fairValueTotal` | Fair Value Total | float64 | | Fair value of reserve assets in the reserve currency. | | `fairValueTotalUSD` | Fair Value Total (USD) | float64 | | Fair value of reserve assets in USD. | | `reserveRatio` | Reserve Ratio | float64 | | Reserve assets divided by circulation. | | `mixTotalUSD` | Reserve Mix Total (USD) | float64 | | Total of the reserve-mix breakdown in USD. | | `usTreasurySecuritiesUSD` | US Treasury Securities (USD) | float64 | | Reserves held in US Treasury securities in USD. | | `repoUSD` | Repurchase Agreements (USD) | float64 | | Reserves held in repurchase agreements in USD. | | `cashAndDepositsUSD` | Cash and Deposits (USD) | float64 | | Reserves held as cash and bank deposits in USD. | | `moneyMarketFundsUSD` | Money Market Funds (USD) | float64 | | Reserves held in money market funds in USD. | | `preciousMetalsUSD` | Precious Metals (USD) | float64 | | Reserves held in precious metals in USD. | | `loansUSD` | Loans (USD) | float64 | | Reserves held as loans in USD. | | `cryptoUSD` | Crypto (USD) | float64 | | Reserves held in crypto assets in USD. | | `equitiesUSD` | Equities (USD) | float64 | | Reserves held in equities in USD. | | `corporateSecuritiesUSD` | Corporate Securities (USD) | float64 | | Reserves held in corporate securities in USD. | | `nonUSGovernmentSecuritiesUSD` | Non-US Government Securities (USD) | float64 | | Reserves held in non-US government securities in USD. | | `otherUSD` | Other (USD) | float64 | | Other reserve assets in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the stablecoin-reserves timeseries model, the issuer and token joined with a hyphen. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the stablecoin, its ticker symbol. | | `symbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The stablecoin's ticker symbol. | | `issuerID` | string | `Eq`, `IsOneOf` | | The attesting issuer's short name. | | `currency` | string | `Eq`, `IsOneOf` | | The reserve currency of the attestation. | | `auditor` | string | `Eq`, `IsOneOf`, `Contains` | | The attesting audit firm. | | `latestReportDate` | time | | yes | The most recent attestation's report date. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/stablecoin-reserves/1d/agora-ausd?timeframe=180d&selections=circulation,circulationUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Stablecoin Reserve timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoin-reserves-by-id) for the response and the errors. # Stablecoins by Chain Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/stablecoins-by-chain Stablecoin metrics summed across all issuers on a blockchain: stablecoin count, circulating supply split USD-pegged versus other currencies, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. Lending and DEX fields are null where a chain has no such activity, so pass selections. One row per blockchain with stablecoin activity, keyed by the short chain name: name, the chain's slug and its network id. The id is the series key of the stablecoins-by-chain timeseries model. | | | | - | - | | Access | Stablecoins-dataset | | Tabular model | `stablecoin-chains`: primary key `id`, identifiers `slug` | | Timeseries model | `stablecoins-by-chain`: intervals `1d`, series key `id` (Chain ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Stablecoin Chains](/api-reference/data-api/stablecoins/tabular-stablecoin-chains) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Chain timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-chain) > > Up to 10 series in one request, named by Chain ID in `series`. > [card] [Get Chain timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-chain-by-id) > > One series over a time window, keyed by its Chain ID. ## Metrics 46 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `stablecoinCount` | Stablecoin Count | float64 | | Distinct stablecoin token contracts on the chain. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `usdPeggedSupplyUSD` | USD-Pegged Supply (USD) | float64 | | Circulating supply of USD-pegged stablecoins in USD. | | `nonUSDPeggedSupplyUSD` | Non-USD-Pegged Supply (USD) | float64 | | Circulating supply of non-USD-pegged stablecoins in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD (negative). | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceProtocolOwnedUSD` | Balance Protocol-Owned (USD) | float64 | | Supply held in protocol-owned wallets in USD. | | `balanceBridgeUSD` | Balance in Bridges (USD) | float64 | | Supply held in bridge contracts in USD. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held in wrapping contracts in USD. | | `balanceYieldDerivativesUSD` | Balance in Yield Derivatives (USD) | float64 | | Supply held in yield derivative protocols in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held in managed vaults and strategies in USD. | | `balanceCDPUSD` | Balance in CDPs (USD) | float64 | | Supply held in collateralized debt position (CDP) protocols in USD. | | `balanceBlacklistUSD` | Balance Blacklisted (USD) | float64 | | Supply held in blacklisted addresses in USD. | | `balancePredictionMarketUSD` | Balance in Prediction Markets (USD) | float64 | | Supply held in prediction-market contracts in USD. | | `balanceTreasuriesUSD` | Balance in Treasuries (USD) | float64 | | Supply held in treasury wallets in USD. | | `balancePrivacyUSD` | Balance in Privacy Protocols (USD) | float64 | | Supply held in privacy protocols in USD. | | `balancePaymentsUSD` | Balance in Payments (USD) | float64 | | Supply held in payment wallets in USD. | | `balanceStakingUSD` | Balance Staked (USD) | float64 | | Supply held in staking contracts in USD. | | `balanceBuybackUSD` | Balance in Buybacks (USD) | float64 | | Supply held in buyback wallets in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed against in lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted average lending supply APY (0-1). | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted average lending borrow APY (0-1). | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of liquidations. | | `holders` | Holders | float64 | | Token holders. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the stablecoins-by-chain timeseries model, the short chain name. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the chain. | | `slug` | string | `Eq`, `IsOneOf` | yes | The chain's slug in the blockchains model. (identifier 1) | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/stablecoins-by-chain/1d/abstract?timeframe=7d&selections=stablecoinCount,circulatingSupplyUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Chain timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-chain-by-id) for the response and the errors. # Stablecoins by Currency Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/stablecoins-by-currency Stablecoin metrics summed across every stablecoin pegged to a currency: chains, issuers and stablecoins, circulating supply, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one peg currency, keyed by its ISO code. One row per currency with stablecoins pegged to it, keyed by its ISO code: name. The id is the series key of the stablecoins-by-currency timeseries model. | | | | - | - | | Access | Stablecoins-dataset | | Tabular model | `stablecoin-currencies`: primary key `id` | | Timeseries model | `stablecoins-by-currency`: intervals `1d`, series key `id` (Currency), series must be named (up to 10 per call) | ## Endpoints > [card] [List Currencies](/api-reference/data-api/stablecoins/tabular-stablecoin-currencies) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Currency timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-currency) > > Up to 10 series in one request, named by Currency in `series`. > [card] [Get Currency timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-currency-by-id) > > One series over a time window, keyed by its Currency. ## Metrics 46 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `chainCount` | Chain Count | float64 | | Distinct chains with stablecoins of this currency. | | `issuerCount` | Issuer Count | float64 | | Distinct issuers of this currency. | | `stablecoinCount` | Stablecoin Count | float64 | | Distinct stablecoin token contracts of this currency. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD (negative). | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceProtocolOwnedUSD` | Balance Protocol-Owned (USD) | float64 | | Supply held in protocol-owned wallets in USD. | | `balanceBridgeUSD` | Balance in Bridges (USD) | float64 | | Supply held in bridge contracts in USD. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held in wrapping contracts in USD. | | `balanceYieldDerivativesUSD` | Balance in Yield Derivatives (USD) | float64 | | Supply held in yield derivative protocols in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held in managed vaults and strategies in USD. | | `balanceCDPUSD` | Balance in CDPs (USD) | float64 | | Supply held in collateralized debt position (CDP) protocols in USD. | | `balanceBlacklistUSD` | Balance Blacklisted (USD) | float64 | | Supply held in blacklisted addresses in USD. | | `balancePredictionMarketUSD` | Balance in Prediction Markets (USD) | float64 | | Supply held in prediction-market contracts in USD. | | `balanceTreasuriesUSD` | Balance in Treasuries (USD) | float64 | | Supply held in treasury wallets in USD. | | `balancePrivacyUSD` | Balance in Privacy Protocols (USD) | float64 | | Supply held in privacy protocols in USD. | | `balancePaymentsUSD` | Balance in Payments (USD) | float64 | | Supply held in payment wallets in USD. | | `balanceStakingUSD` | Balance Staked (USD) | float64 | | Supply held in staking contracts in USD. | | `balanceBuybackUSD` | Balance in Buybacks (USD) | float64 | | Supply held in buyback wallets in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed against in lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted average lending supply APY (0-1). | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted average lending borrow APY (0-1). | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of liquidations. | | `holders` | Holders | float64 | | Token holders. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the stablecoins-by-currency timeseries model, the lowercase ISO 4217 code. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the currency, its code in uppercase. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/stablecoins-by-currency/1d/ars?timeframe=7d&selections=chainCount,issuerCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Currency timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-currency-by-id) for the response and the errors. # Stablecoins by Deployment Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/stablecoins-by-deployment Stablecoin metrics for one token contract on one chain: circulating supply, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one deployment, keyed by chain and contract address; a bridged copy is its own deployment. Many series, so name the deployments you need. One row per stablecoin deployment, one token contract on one chain, keyed by chain and contract address: symbol, token and product ids, the product a bridged copy represents, issuer, peg currency and sector, the chain and the mapped network and issuer project records. The id is the series key of the stablecoins-by-deployment timeseries model. | | | | - | - | | Access | Stablecoins-dataset | | Tabular model | `stablecoin-deployments`: primary key `id` | | Timeseries model | `stablecoins-by-deployment`: intervals `1d`, series key `id` (Stablecoin Deployment ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Stablecoin Deployments](/api-reference/data-api/stablecoins/tabular-stablecoin-deployments) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Stablecoin Deployment timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-deployment) > > Up to 10 series in one request, named by Stablecoin Deployment ID in `series`. > [card] [Get Stablecoin Deployment timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-deployment-by-id) > > One series over a time window, keyed by its Stablecoin Deployment ID. ## Metrics 43 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD (negative). | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceProtocolOwnedUSD` | Balance Protocol-Owned (USD) | float64 | | Supply held in protocol-owned wallets in USD. | | `balanceBridgeUSD` | Balance in Bridges (USD) | float64 | | Supply held in bridge contracts in USD. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held in wrapping contracts in USD. | | `balanceYieldDerivativesUSD` | Balance in Yield Derivatives (USD) | float64 | | Supply held in yield derivative protocols in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held in managed vaults and strategies in USD. | | `balanceCDPUSD` | Balance in CDPs (USD) | float64 | | Supply held in collateralized debt position (CDP) protocols in USD. | | `balanceBlacklistUSD` | Balance Blacklisted (USD) | float64 | | Supply held in blacklisted addresses in USD. | | `balancePredictionMarketUSD` | Balance in Prediction Markets (USD) | float64 | | Supply held in prediction-market contracts in USD. | | `balanceTreasuriesUSD` | Balance in Treasuries (USD) | float64 | | Supply held in treasury wallets in USD. | | `balancePrivacyUSD` | Balance in Privacy Protocols (USD) | float64 | | Supply held in privacy protocols in USD. | | `balancePaymentsUSD` | Balance in Payments (USD) | float64 | | Supply held in payment wallets in USD. | | `balanceStakingUSD` | Balance Staked (USD) | float64 | | Supply held in staking contracts in USD. | | `balanceBuybackUSD` | Balance in Buybacks (USD) | float64 | | Supply held in buyback wallets in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed against in lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted average lending supply APY (0-1). | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted average lending borrow APY (0-1). | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of liquidations. | | `holders` | Holders | float64 | | Token holders. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the stablecoins-by-deployment timeseries model, the chain and token address joined with an underscore. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The deployment's display name, the symbol and chain. | | `symbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `tokenID` | string | `Eq`, `IsOneOf` | | The token id of this contract, the series key of the stablecoins-by-product timeseries model. | | `productID` | string | `Eq`, `IsOneOf` | | The lowercase symbol, shared by token ids that label the same coin on different chains. | | `referenceTokenID` | string | `Eq`, `IsOneOf` | | The token id of the product this contract represents, the underlying token for a bridged copy (USDC.e resolves to USDC) and otherwise its own token id. | | `underlyingTokenID` | string | `Eq`, `IsOneOf` | | The token id of the product a bridged copy represents; null for a native deployment. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana). | | `chain` | string | `Eq`, `IsOneOf` | yes | The short name of the chain (ethereum, base, solana). | | `issuerID` | string | `Eq`, `IsOneOf` | | The identifier of the issuing company. | | `pegCurrency` | string | `Eq`, `IsOneOf` | | The currency the stablecoin is pegged to. | | `tokenSector` | string | `Eq`, `IsOneOf` | | The peg currency bucket the token is filed under. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | | `networkSlug` | string | `Eq`, `IsOneOf` | | The chain's slug in the blockchains model; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the issuer's project record; null when unmapped. | | `projectSlug` | string | `Eq`, `IsOneOf` | | The slug of the issuer's project record; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/stablecoins-by-deployment/1d/?timeframe=7d&selections=circulatingSupplyUSD,mintAmountUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Stablecoin Deployment timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-deployment-by-id) for the response and the errors. # Stablecoins by Issuer Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/stablecoins-by-issuer Stablecoin metrics for an issuer, summed across its stablecoins and chains: chains and stablecoins, circulating supply split USD-pegged versus other currencies, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its slug. Lending and DEX fields are null where an issuer's tokens see no such activity, so pass selections. One row per stablecoin issuer, keyed by its short name: name, project slug and project id where the issuer is a tracked project. The id is the series key of the stablecoins-by-issuer timeseries model. | | | | - | - | | Access | Stablecoins-dataset | | Tabular model | `stablecoin-issuers`: primary key `id`, identifiers `slug` | | Timeseries model | `stablecoins-by-issuer`: intervals `1d`, series key `id` (Issuer ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Stablecoin Issuers](/api-reference/data-api/stablecoins/tabular-stablecoin-issuers) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Stablecoin Issuer timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-issuer) > > Up to 10 series in one request, named by Issuer ID in `series`. > [card] [Get Stablecoin Issuer timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-issuer-by-id) > > One series over a time window, keyed by its Issuer ID. ## Metrics 47 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `chainCount` | Chain Count | float64 | | Distinct chains the issuer has deployed on. | | `stablecoinCount` | Stablecoin Count | float64 | | Stablecoin token contracts issued, counted per chain. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `usdPeggedSupplyUSD` | USD-Pegged Supply (USD) | float64 | | Circulating supply of USD-pegged stablecoins in USD. | | `nonUSDPeggedSupplyUSD` | Non-USD-Pegged Supply (USD) | float64 | | Circulating supply of non-USD-pegged stablecoins in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD (negative). | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceProtocolOwnedUSD` | Balance Protocol-Owned (USD) | float64 | | Supply held in protocol-owned wallets in USD. | | `balanceBridgeUSD` | Balance in Bridges (USD) | float64 | | Supply held in bridge contracts in USD. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held in wrapping contracts in USD. | | `balanceYieldDerivativesUSD` | Balance in Yield Derivatives (USD) | float64 | | Supply held in yield derivative protocols in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held in managed vaults and strategies in USD. | | `balanceCDPUSD` | Balance in CDPs (USD) | float64 | | Supply held in collateralized debt position (CDP) protocols in USD. | | `balanceBlacklistUSD` | Balance Blacklisted (USD) | float64 | | Supply held in blacklisted addresses in USD. | | `balancePredictionMarketUSD` | Balance in Prediction Markets (USD) | float64 | | Supply held in prediction-market contracts in USD. | | `balanceTreasuriesUSD` | Balance in Treasuries (USD) | float64 | | Supply held in treasury wallets in USD. | | `balancePrivacyUSD` | Balance in Privacy Protocols (USD) | float64 | | Supply held in privacy protocols in USD. | | `balancePaymentsUSD` | Balance in Payments (USD) | float64 | | Supply held in payment wallets in USD. | | `balanceStakingUSD` | Balance Staked (USD) | float64 | | Supply held in staking contracts in USD. | | `balanceBuybackUSD` | Balance in Buybacks (USD) | float64 | | Supply held in buyback wallets in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed against in lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted average lending supply APY (0-1). | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted average lending borrow APY (0-1). | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of liquidations. | | `holders` | Holders | float64 | | Token holders. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the stablecoins-by-issuer timeseries model, the issuer's short name. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the issuer. | | `slug` | string | `Eq`, `IsOneOf` | yes | The issuer's project slug, the slug used for the same company across the API. (identifier 1) | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the issuer's project record. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/stablecoins-by-issuer/1d/aave?timeframe=7d&selections=chainCount,stablecoinCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Stablecoin Issuer timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-issuer-by-id) for the response and the errors. # Stablecoins by Product Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/stablecoins-by-product Metrics for one stablecoin token summed across the chains it is deployed on: chains and contracts, circulating supply, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one token, keyed by its token id; the product id groups the token ids that label the same coin. Hundreds of series, so name the tokens you need. One row per stablecoin token, keyed by its token id: name, ticker symbol, the product id that groups token ids labelling the same coin, peg currency and sector. The id is the series key of the stablecoins-by-product timeseries model. | | | | - | - | | Access | Stablecoins-dataset | | Tabular model | `stablecoin-products`: primary key `id` | | Timeseries model | `stablecoins-by-product`: intervals `1d`, series key `id` (Token ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Stablecoins](/api-reference/data-api/stablecoins/tabular-stablecoin-products) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Stablecoin timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-product) > > Up to 10 series in one request, named by Token ID in `series`. > [card] [Get Stablecoin timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-product-by-id) > > One series over a time window, keyed by its Token ID. ## Metrics 45 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `chainCount` | Chain Count | float64 | | Distinct chains the token is deployed on. | | `tokenAddressCount` | Token Address Count | float64 | | Distinct token contract addresses across chains. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD (negative). | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceProtocolOwnedUSD` | Balance Protocol-Owned (USD) | float64 | | Supply held in protocol-owned wallets in USD. | | `balanceBridgeUSD` | Balance in Bridges (USD) | float64 | | Supply held in bridge contracts in USD. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceWrappedUSD` | Balance Wrapped (USD) | float64 | | Supply held in wrapping contracts in USD. | | `balanceYieldDerivativesUSD` | Balance in Yield Derivatives (USD) | float64 | | Supply held in yield derivative protocols in USD. | | `balanceManagedUSD` | Balance Managed (USD) | float64 | | Supply held in managed vaults and strategies in USD. | | `balanceCDPUSD` | Balance in CDPs (USD) | float64 | | Supply held in collateralized debt position (CDP) protocols in USD. | | `balanceBlacklistUSD` | Balance Blacklisted (USD) | float64 | | Supply held in blacklisted addresses in USD. | | `balancePredictionMarketUSD` | Balance in Prediction Markets (USD) | float64 | | Supply held in prediction-market contracts in USD. | | `balanceTreasuriesUSD` | Balance in Treasuries (USD) | float64 | | Supply held in treasury wallets in USD. | | `balancePrivacyUSD` | Balance in Privacy Protocols (USD) | float64 | | Supply held in privacy protocols in USD. | | `balancePaymentsUSD` | Balance in Payments (USD) | float64 | | Supply held in payment wallets in USD. | | `balanceStakingUSD` | Balance Staked (USD) | float64 | | Supply held in staking contracts in USD. | | `balanceBuybackUSD` | Balance in Buybacks (USD) | float64 | | Supply held in buyback wallets in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed against in lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted average lending supply APY (0-1). | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted average lending borrow APY (0-1). | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of liquidations. | | `holders` | Holders | float64 | | Token holders. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the stablecoins-by-product timeseries model, the token slug. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the token, its ticker symbol. | | `symbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `productID` | string | `Eq`, `IsOneOf` | | The lowercase symbol, shared by token ids that label the same coin on different chains. | | `pegCurrency` | string | `Eq`, `IsOneOf` | | The currency the stablecoin is pegged to. | | `tokenSector` | string | `Eq`, `IsOneOf` | | The peg currency bucket the token is filed under. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/stablecoins-by-product/1d/a7a5?timeframe=7d&selections=chainCount,tokenAddressCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Stablecoin timeseries](/api-reference/data-api/stablecoins/timeseries-stablecoins-by-product-by-id) for the response and the errors. # List Stablecoin Chains Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/tabular-stablecoin-chains api-reference/data-api/openapi.json GET /query/tabular/stablecoin-chains One row per blockchain with stablecoin activity, keyed by the short chain name: name, the chain's slug and its network id. The id is the series key of the stablecoins-by-chain timeseries model. # List Currencies Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/tabular-stablecoin-currencies api-reference/data-api/openapi.json GET /query/tabular/stablecoin-currencies One row per currency with stablecoins pegged to it, keyed by its ISO code: name. The id is the series key of the stablecoins-by-currency timeseries model. # List Stablecoin Deployments Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/tabular-stablecoin-deployments api-reference/data-api/openapi.json GET /query/tabular/stablecoin-deployments One row per stablecoin deployment, one token contract on one chain, keyed by chain and contract address: symbol, token and product ids, the product a bridged copy represents, issuer, peg currency and sector, the chain and the mapped network and issuer project records. The id is the series key of the stablecoins-by-deployment timeseries model. # List Stablecoin FX Pairs Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/tabular-stablecoin-fx-pairs api-reference/data-api/openapi.json GET /query/tabular/stablecoin-fx-pairs One row per currency pair traded onchain between stablecoins, keyed by base and quote currency codes: display name, pair type (cross-currency or same-currency) and both currencies. The id is the series key of the stablecoin-fx timeseries model. # List Stablecoin Issuers Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/tabular-stablecoin-issuers api-reference/data-api/openapi.json GET /query/tabular/stablecoin-issuers One row per stablecoin issuer, keyed by its short name: name, project slug and project id where the issuer is a tracked project. The id is the series key of the stablecoins-by-issuer timeseries model. # List Stablecoins Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/tabular-stablecoin-products api-reference/data-api/openapi.json GET /query/tabular/stablecoin-products One row per stablecoin token, keyed by its token id: name, ticker symbol, the product id that groups token ids labelling the same coin, peg currency and sector. The id is the series key of the stablecoins-by-product timeseries model. # List Stablecoin Reserves Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/tabular-stablecoin-reserve-entities api-reference/data-api/openapi.json GET /query/tabular/stablecoin-reserve-entities One row per stablecoin with reserve attestations, keyed by issuer and token: name, symbol, issuer, reserve currency, auditor and the latest report date. The id is the series key of the stablecoin-reserves timeseries model. # Batch Get Currency Pair timeseries Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/timeseries-stablecoin-fx api-reference/data-api/openapi.json GET /query/timeseries/stablecoin-fx/{granularity} Onchain foreign-exchange activity between stablecoins for a currency pair: swap volume in USD, number of swaps, and the chains and DEXes the pair traded on. Cross-currency pairs capture stablecoin FX; same-currency pairs capture swaps between stablecoins of one currency. Each series is one pair, keyed by base and quote currency codes. # Get Currency Pair timeseries Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/timeseries-stablecoin-fx-by-id api-reference/data-api/openapi.json GET /query/timeseries/stablecoin-fx/{granularity}/{id} Onchain foreign-exchange activity between stablecoins for a currency pair: swap volume in USD, number of swaps, and the chains and DEXes the pair traded on. Cross-currency pairs capture stablecoin FX; same-currency pairs capture swaps between stablecoins of one currency. Each series is one pair, keyed by base and quote currency codes. # Batch Get Stablecoin Reserve timeseries Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/timeseries-stablecoin-reserves api-reference/data-api/openapi.json GET /query/timeseries/stablecoin-reserves/{granularity} Reserve attestations for a stablecoin: tokens in circulation, fair value of the reserves and the reserve ratio on each report date, with the reserve mix broken down by asset type (Treasuries, repo, cash, money market funds, precious metals, loans, crypto and more). Each series is one stablecoin, keyed by issuer and token, with one point per attestation rather than one per day. # Get Stablecoin Reserve timeseries Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/timeseries-stablecoin-reserves-by-id api-reference/data-api/openapi.json GET /query/timeseries/stablecoin-reserves/{granularity}/{id} Reserve attestations for a stablecoin: tokens in circulation, fair value of the reserves and the reserve ratio on each report date, with the reserve mix broken down by asset type (Treasuries, repo, cash, money market funds, precious metals, loans, crypto and more). Each series is one stablecoin, keyed by issuer and token, with one point per attestation rather than one per day. # Batch Get Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/timeseries-stablecoins-by-chain api-reference/data-api/openapi.json GET /query/timeseries/stablecoins-by-chain/{granularity} Stablecoin metrics summed across all issuers on a blockchain: stablecoin count, circulating supply split USD-pegged versus other currencies, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. Lending and DEX fields are null where a chain has no such activity, so pass selections. # Get Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/timeseries-stablecoins-by-chain-by-id api-reference/data-api/openapi.json GET /query/timeseries/stablecoins-by-chain/{granularity}/{id} Stablecoin metrics summed across all issuers on a blockchain: stablecoin count, circulating supply split USD-pegged versus other currencies, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. Lending and DEX fields are null where a chain has no such activity, so pass selections. # Batch Get Currency timeseries Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/timeseries-stablecoins-by-currency api-reference/data-api/openapi.json GET /query/timeseries/stablecoins-by-currency/{granularity} Stablecoin metrics summed across every stablecoin pegged to a currency: chains, issuers and stablecoins, circulating supply, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one peg currency, keyed by its ISO code. # Get Currency timeseries Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/timeseries-stablecoins-by-currency-by-id api-reference/data-api/openapi.json GET /query/timeseries/stablecoins-by-currency/{granularity}/{id} Stablecoin metrics summed across every stablecoin pegged to a currency: chains, issuers and stablecoins, circulating supply, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one peg currency, keyed by its ISO code. # Batch Get Stablecoin Deployment timeseries Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/timeseries-stablecoins-by-deployment api-reference/data-api/openapi.json GET /query/timeseries/stablecoins-by-deployment/{granularity} Stablecoin metrics for one token contract on one chain: circulating supply, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one deployment, keyed by chain and contract address; a bridged copy is its own deployment. Many series, so name the deployments you need. # Get Stablecoin Deployment timeseries Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/timeseries-stablecoins-by-deployment-by-id api-reference/data-api/openapi.json GET /query/timeseries/stablecoins-by-deployment/{granularity}/{id} Stablecoin metrics for one token contract on one chain: circulating supply, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows, flows, APYs and liquidations, holders, spot DEX volume and transfers. Each series is one deployment, keyed by chain and contract address; a bridged copy is its own deployment. Many series, so name the deployments you need. # Batch Get Stablecoin Issuer timeseries Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/timeseries-stablecoins-by-issuer api-reference/data-api/openapi.json GET /query/timeseries/stablecoins-by-issuer/{granularity} Stablecoin metrics for an issuer, summed across its stablecoins and chains: chains and stablecoins, circulating supply split USD-pegged versus other currencies, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its slug. Lending and DEX fields are null where an issuer's tokens see no such activity, so pass selections. # Get Stablecoin Issuer timeseries Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/timeseries-stablecoins-by-issuer-by-id api-reference/data-api/openapi.json GET /query/timeseries/stablecoins-by-issuer/{granularity}/{id} Stablecoin metrics for an issuer, summed across its stablecoins and chains: chains and stablecoins, circulating supply split USD-pegged versus other currencies, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its slug. Lending and DEX fields are null where an issuer's tokens see no such activity, so pass selections. # Batch Get Stablecoin timeseries Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/timeseries-stablecoins-by-product api-reference/data-api/openapi.json GET /query/timeseries/stablecoins-by-product/{granularity} Metrics for one stablecoin token summed across the chains it is deployed on: chains and contracts, circulating supply, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one token, keyed by its token id; the product id groups the token ids that label the same coin. Hundreds of series, so name the tokens you need. # Get Stablecoin timeseries Source: https://docs.blockworks.com/api-reference/data-api/stablecoins/timeseries-stablecoins-by-product-by-id api-reference/data-api/openapi.json GET /query/timeseries/stablecoins-by-product/{granularity}/{id} Metrics for one stablecoin token summed across the chains it is deployed on: chains and contracts, circulating supply, mints and burns, where the supply sits (protocol-owned, bridges, CEX, DEX, wrapped, managed, lending, CDPs, staking, treasuries and other labeled holders, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one token, keyed by its token id; the product id groups the token ids that label the same coin. Hundreds of series, so name the tokens you need. # TCG Platforms Source: https://docs.blockworks.com/api-reference/data-api/tcg-platforms/overview Trading card and collectibles platform metrics per platform on one blockchain: revenue and expenses, gross merchandise value, marketplace volume, sales and buyers. The platform-chain table gives the keys. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [TCG Platforms by Chain](/api-reference/data-api/tcg-platforms/tcg-platforms-by-chain) | Tcg-platforms-dataset | | [Batch](/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-chain), [One series](/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-chain-by-id) | | [TCG Platforms by Deployment](/api-reference/data-api/tcg-platforms/tcg-platforms-by-deployment) | Tcg-platforms-dataset | | [Batch](/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-deployment), [One series](/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-deployment-by-id) | | [TCG Platform Chains](/api-reference/data-api/tcg-platforms/tcg-platform-chains) | Tcg-platforms-dataset | [List rows](/api-reference/data-api/tcg-platforms/tabular-tcg-platform-chains) | | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/tcg-platform-chains?pageSize=3&selections=id,name,slug,platform" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List TCG Platform Chains](/api-reference/data-api/tcg-platforms/tabular-tcg-platform-chains) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List TCG Platform Chains Source: https://docs.blockworks.com/api-reference/data-api/tcg-platforms/tabular-tcg-platform-chains api-reference/data-api/openapi.json GET /query/tabular/tcg-platform-chains One row per trading card and collectibles platform on one blockchain, keyed by platform and chain: name, platform, chain, project slug and network slug. The id is the series key of the tcg-platforms-by-chain and tcg-platforms-by-deployment timeseries models. # TCG Platform Chains Source: https://docs.blockworks.com/api-reference/data-api/tcg-platforms/tcg-platform-chains One row per trading card and collectibles platform on one blockchain, keyed by platform and chain: name, platform, chain, project slug and network slug. The id is the series key of the tcg-platforms-by-chain and tcg-platforms-by-deployment timeseries models. | | | | - | - | | Access | Tcg-platforms-dataset | | Tabular model | `tcg-platform-chains`: primary key `id` | ## Endpoints > [card] [List TCG Platform Chains](/api-reference/data-api/tcg-platforms/tabular-tcg-platform-chains) > > One page of rows with per-column filters, sorting and pagination. ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the tcg-platforms-by-chain and tcg-platforms-by-deployment timeseries models, the platform and chain joined with an underscore (courtyard_polygon). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the platform-chain pair (for example courtyard (polygon)). | | `slug` | string | `Eq`, `IsOneOf` | yes | The platform's project slug; null until the platform is mapped to a project record. | | `platform` | string | `Eq`, `IsOneOf` | yes | Blockworks Research platform slug (for example courtyard, collector-crypt). | | `chain` | string | `Eq`, `IsOneOf` | yes | The short name of the chain the platform operates on (solana, base, polygon). | | `networkSlug` | string | `Eq`, `IsOneOf` | yes | The chain's slug in the blockchains model; null until mapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/tcg-platform-chains?pageSize=3&selections=id,name,slug,platform" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List TCG Platform Chains](/api-reference/data-api/tcg-platforms/tabular-tcg-platform-chains) for the response and the errors. # TCG Platforms by Chain Source: https://docs.blockworks.com/api-reference/data-api/tcg-platforms/tcg-platforms-by-chain Metrics for a trading-card and collectibles platform on one blockchain: revenue and expenses, gross merchandise value, marketplace volume, sales, buyers, gacha pack openings, credit-card spend and daily active users. Each series is one platform on one chain, keyed by platform and chain. | | | | - | - | | Access | Tcg-platforms-dataset | | Timeseries model | `tcg-platforms-by-chain`: intervals `1d`, series key `id` (Platform Chain ID), every series available in one call | ## Endpoints > [card] [Batch Get TCG Platform Chain timeseries](/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-chain) > > Every series in one request, or the named ones. > [card] [Get TCG Platform Chain timeseries](/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-chain-by-id) > > One series over a time window, keyed by its Platform Chain ID. ## Metrics 21 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `grossRevenueUSD` | Gross Revenue (USD) | float64 | | Gross platform revenue in USD. | | `netRevenueUSD` | Net Revenue (USD) | float64 | | Net platform revenue in USD. | | `miscRevenueUSD` | Misc Revenue (USD) | float64 | | Miscellaneous revenue in USD. | | `buybackExpenseUSD` | Buyback Expense (USD) | float64 | | Card buyback expense in USD. | | `referralExpenseUSD` | Referral Expense (USD) | float64 | | Referral expense in USD. | | `gmvUSD` | GMV (USD) | float64 | | Gross merchandise value in USD. | | `volumeInclBuybackUSD` | Volume incl. Buybacks (USD) | float64 | | Volume including platform buybacks in USD. | | `gachaSpendUSD` | Gacha Spend (USD) | float64 | | Net gacha (pack-opening) spend in USD. | | `creditcardSpendUSD` | Credit Card Spend (USD) | float64 | | Credit-card spend in USD. | | `dauNew` | New DAU | float64 | | New daily active users. | | `dauRecurring` | Recurring DAU | float64 | | Recurring daily active users. | | `dauTotal` | Total DAU | float64 | | Total daily active users. | | `marketplaceVolumeUSD` | Marketplace Volume (USD) | float64 | | Secondary-marketplace volume in USD. | | `organicVolumeUSD` | Organic Volume (USD) | float64 | | Marketplace volume excluding buybacks in USD. | | `buybackVolumeUSD` | Buyback Volume (USD) | float64 | | Marketplace buyback volume in USD. | | `salesCount` | Sales Count | float64 | | Marketplace sales count. | | `uniqueBuyers` | Unique Buyers | float64 | | Unique marketplace buyers. | | `topSaleUSD` | Top Sale (USD) | float64 | | Largest single sale of the day in USD. | | `marketplaceFeesUSD` | Marketplace Fees (USD) | float64 | | Marketplace fees in USD. | | `packsOpened` | Packs Opened | float64 | | Gacha packs opened, summed across tiers. | | `gachaSpendGrossUSD` | Gross Gacha Spend (USD) | float64 | | Gross gacha spend, summed across tiers, in USD. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/tcg-platforms-by-chain/1d/beezie_base?timeframe=7d&selections=grossRevenueUSD,netRevenueUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get TCG Platform Chain timeseries](/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-chain-by-id) for the response and the errors. # TCG Platforms by Deployment Source: https://docs.blockworks.com/api-reference/data-api/tcg-platforms/tcg-platforms-by-deployment Daily financials for a trading-card and collectibles platform on one blockchain: gross and net revenue, margins, expenses, gross merchandise value, gacha spend, daily active users, revenue per user, credit-card adoption, share of the chain's stablecoin transfers, and card costs and gross profit. Each series is one platform on one chain, keyed by platform and chain. | | | | - | - | | Access | Tcg-platforms-dataset | | Timeseries model | `tcg-platforms-by-deployment`: intervals `1d`, series key `id` (Platform Chain ID), every series available in one call | ## Endpoints > [card] [Batch Get TCG Platform Chain timeseries](/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-deployment) > > Every series in one request, or the named ones. > [card] [Get TCG Platform Chain timeseries](/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-deployment-by-id) > > One series over a time window, keyed by its Platform Chain ID. ## Metrics 21 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `grossRevenueUSD` | Gross Revenue | float64 | | Total revenue earned by the platform in USD before contra revenue (card/item buybacks). | | `netRevenueUSD` | Net Revenue | float64 | | Revenue retained by the platform in USD after card buybacks. | | `netRevenueMargin` | Net Revenue Margin | float64 | | Net revenue / gross revenue. | | `miscRevenueUSD` | Misc Revenue | float64 | | Named miscellaneous revenue drivers, a sub-component already inside gross revenue (not added on top). Phygitals: lucky draw + pack-party entries + redemption. Collector Crypt: partnership + redemption + eBay sniper. 0 for Beezie and Courtyard. | | `buybackExpenseUSD` | Buyback Expense | float64 | | USD spent by the platform buying back cards/items from users. | | `referralExpenseUSD` | Referral Expense | float64 | | USD paid out to referrers. | | `gmvUSD` | GMV | float64 | | Gross merchandise value: total USD value of goods sold on the platform. | | `volumeInclBuybackUSD` | Total Volume (incl. Buybacks) | float64 | | GMV plus gacha buyback volume in USD. | | `gachaSpendUSD` | Gacha Spend | float64 | | USD spent by users on gacha packs, summed across pack types. | | `dauNew` | New Daily Active Users | float64 | | Distinct addresses active for the first time that day. Not summable across days. | | `dauRecurring` | Recurring Daily Active Users | float64 | | Distinct returning addresses active that day. Not summable across days. | | `dauTotal` | Daily Active Users | float64 | | Distinct addresses active that day (new + recurring). Not summable across days. | | `arpuUSD` | ARPU (Net) | float64 | | Net revenue that day / that day's daily active users. | | `grossARPUUSD` | ARPU (Gross) | float64 | | Gross revenue that day / that day's daily active users. | | `creditcardAdoptionRate` | Credit Card Adoption Rate | float64 | | Share of gacha spend paid by credit card (credit card spend / gacha spend). | | `stablecoinTransferPct` | Gacha Spend Share of Stablecoin Transfers | float64 | | Gacha spend / the chain's stablecoin transfer volume (ratio, 6 dp). | | `volumeStablecoinTransferPct` | Volume Share of Stablecoin Transfers | float64 | | Total volume (GMV + buybacks) / the chain's stablecoin transfer volume (ratio, 6 dp). | | `cogsUSD` | Cost of Goods Sold | float64 | | USD cost of the cards sold. | | `secondaryRepurchaseCostUSD` | Secondary Repurchase Cost | float64 | | USD spent repurchasing cards on secondary markets. | | `grossProfitUSD` | Gross Profit | float64 | | Gross revenue minus card costs (COGS and secondary repurchases). | | `grossProfitMargin` | Gross Profit Margin | float64 | | Gross profit / gross revenue. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/tcg-platforms-by-deployment/1d/?timeframe=7d&selections=grossRevenueUSD,netRevenueUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get TCG Platform Chain timeseries](/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-deployment-by-id) for the response and the errors. # Batch Get TCG Platform Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-chain api-reference/data-api/openapi.json GET /query/timeseries/tcg-platforms-by-chain/{granularity} Metrics for a trading-card and collectibles platform on one blockchain: revenue and expenses, gross merchandise value, marketplace volume, sales, buyers, gacha pack openings, credit-card spend and daily active users. Each series is one platform on one chain, keyed by platform and chain. # Get TCG Platform Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-chain-by-id api-reference/data-api/openapi.json GET /query/timeseries/tcg-platforms-by-chain/{granularity}/{id} Metrics for a trading-card and collectibles platform on one blockchain: revenue and expenses, gross merchandise value, marketplace volume, sales, buyers, gacha pack openings, credit-card spend and daily active users. Each series is one platform on one chain, keyed by platform and chain. # Batch Get TCG Platform Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-deployment api-reference/data-api/openapi.json GET /query/timeseries/tcg-platforms-by-deployment/{granularity} Daily financials for a trading-card and collectibles platform on one blockchain: gross and net revenue, margins, expenses, gross merchandise value, gacha spend, daily active users, revenue per user, credit-card adoption, share of the chain's stablecoin transfers, and card costs and gross profit. Each series is one platform on one chain, keyed by platform and chain. # Get TCG Platform Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/tcg-platforms/timeseries-tcg-platforms-by-deployment-by-id api-reference/data-api/openapi.json GET /query/timeseries/tcg-platforms-by-deployment/{granularity}/{id} Daily financials for a trading-card and collectibles platform on one blockchain: gross and net revenue, margins, expenses, gross merchandise value, gacha spend, daily active users, revenue per user, credit-card adoption, share of the chain's stablecoin transfers, and card costs and gross profit. Each series is one platform on one chain, keyed by platform and chain. # Token Transparency Framework Source: https://docs.blockworks.com/api-reference/data-api/token-transparency-framework Token Transparency Framework: Token Transparency. > [card] [Token Transparency](/api-reference/data-api/token-transparency/overview) > > Token Transparency: Token Transparency Filing Questions, Token Transparency Filing Schemas, Token Transparency Filings, Token Transparency Projects. 4 models. # Token Transparency Source: https://docs.blockworks.com/api-reference/data-api/token-transparency/overview Token Transparency: Token Transparency Filing Questions, Token Transparency Filing Schemas, Token Transparency Filings, Token Transparency Projects. ## Endpoints | Model | Access | Table | | - | - | - | | [Token Transparency Filing Questions](/api-reference/data-api/token-transparency/token-transparency-filing-questions) | Token-transparency-dataset | [List rows](/api-reference/data-api/token-transparency/tabular-token-transparency-filing-questions), [One row](/api-reference/data-api/token-transparency/tabular-token-transparency-filing-questions-by-id) | | [Token Transparency Filing Schemas](/api-reference/data-api/token-transparency/token-transparency-filing-schemas) | Token-transparency-dataset | [List rows](/api-reference/data-api/token-transparency/tabular-token-transparency-filing-schemas), [One row](/api-reference/data-api/token-transparency/tabular-token-transparency-filing-schemas-by-id) | | [Token Transparency Filings](/api-reference/data-api/token-transparency/token-transparency-filings) | Token-transparency-dataset | [List rows](/api-reference/data-api/token-transparency/tabular-token-transparency-filings), [One row](/api-reference/data-api/token-transparency/tabular-token-transparency-filings-by-id) | | [Token Transparency Projects](/api-reference/data-api/token-transparency/token-transparency-projects) | Token-transparency-dataset | [List rows](/api-reference/data-api/token-transparency/tabular-token-transparency-projects), [One row](/api-reference/data-api/token-transparency/tabular-token-transparency-projects-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/token-transparency-filing-questions?pageSize=3&selections=id,filingID,questionID,schemaID" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Token Transparency Filing Questions](/api-reference/data-api/token-transparency/tabular-token-transparency-filing-questions) for the response and the errors. ## Guides > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Token Transparency Filing Questions Source: https://docs.blockworks.com/api-reference/data-api/token-transparency/tabular-token-transparency-filing-questions api-reference/data-api/openapi.json GET /query/tabular/token-transparency-filing-questions One row per question in a published Token Transparency Framework filing, keyed by filing and question id: section, question label, answer type and mode, the answer as submitted, the reviewer's label and whether it counts as a gap. Filter by filingID to get one filing's answers in schema order. # Get Token Transparency Filing Question Source: https://docs.blockworks.com/api-reference/data-api/token-transparency/tabular-token-transparency-filing-questions-by-id api-reference/data-api/openapi.json GET /query/tabular/token-transparency-filing-questions/{id} One row per question in a published Token Transparency Framework filing, keyed by filing and question id: section, question label, answer type and mode, the answer as submitted, the reviewer's label and whether it counts as a gap. Filter by filingID to get one filing's answers in schema order. # List Token Transparency Filing Schemas Source: https://docs.blockworks.com/api-reference/data-api/token-transparency/tabular-token-transparency-filing-schemas api-reference/data-api/openapi.json GET /query/tabular/token-transparency-filing-schemas One row per version of a Token Transparency Framework question set, keyed by schemaID: filing type, version, question count and the ordered sections with every question's label, answer type, configuration and filer instructions. # Get Token Transparency Filing Schema Source: https://docs.blockworks.com/api-reference/data-api/token-transparency/tabular-token-transparency-filing-schemas-by-id api-reference/data-api/openapi.json GET /query/tabular/token-transparency-filing-schemas/{schemaID} One row per version of a Token Transparency Framework question set, keyed by schemaID: filing type, version, question count and the ordered sections with every question's label, answer type, configuration and filer instructions. # List Token Transparency Filings Source: https://docs.blockworks.com/api-reference/data-api/token-transparency/tabular-token-transparency-filings api-reference/data-api/openapi.json GET /query/tabular/token-transparency-filings One row per published Token Transparency Framework filing, keyed by filingID: project and its launch platform, filing type and version, schema, publish and filing dates, provenance, question and gap counts with a completion label, latest and superseded flags, status and the filing's page URL. Filter by project, ticker, type, status or date. # Get Token Transparency Filing Source: https://docs.blockworks.com/api-reference/data-api/token-transparency/tabular-token-transparency-filings-by-id api-reference/data-api/openapi.json GET /query/tabular/token-transparency-filings/{filingID} One row per published Token Transparency Framework filing, keyed by filingID: project and its launch platform, filing type and version, schema, publish and filing dates, provenance, question and gap counts with a completion label, latest and superseded flags, status and the filing's page URL. Filter by project, ticker, type, status or date. # List Token Transparency Projects Source: https://docs.blockworks.com/api-reference/data-api/token-transparency/tabular-token-transparency-projects api-reference/data-api/openapi.json GET /query/tabular/token-transparency-projects One row per project with at least one published Token Transparency Framework filing, keyed by project slug: name, ticker, launch platform, the mapped project record and filing count. Lists which projects have filed and resolves a ticker to a project. # Get Token Transparency Project Source: https://docs.blockworks.com/api-reference/data-api/token-transparency/tabular-token-transparency-projects-by-id api-reference/data-api/openapi.json GET /query/tabular/token-transparency-projects/{id} One row per project with at least one published Token Transparency Framework filing, keyed by project slug: name, ticker, launch platform, the mapped project record and filing count. Lists which projects have filed and resolves a ticker to a project. # Token Transparency Filing Questions Source: https://docs.blockworks.com/api-reference/data-api/token-transparency/token-transparency-filing-questions One row per question in a published Token Transparency Framework filing, keyed by filing and question id: section, question label, answer type and mode, the answer as submitted, the reviewer's label and whether it counts as a gap. Filter by filingID to get one filing's answers in schema order. | | | | - | - | | Access | Token-transparency-dataset | | Tabular model | `token-transparency-filing-questions`: primary key `id` | ## Endpoints > [card] [List Token Transparency Filing Questions](/api-reference/data-api/token-transparency/tabular-token-transparency-filing-questions) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Token Transparency Filing Question](/api-reference/data-api/token-transparency/tabular-token-transparency-filing-questions-by-id) > > One row by `id`. ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The unique identifier of the filing question, formed from the filing id and the question id. (primary key) | | `filingID` | string | `Eq`, `IsOneOf` | | The filing the answer belongs to. | | `questionID` | string | `Eq`, `IsOneOf` | | The question id within the filing schema (e.g. q1). | | `schemaID` | string | `Eq`, `IsOneOf` | | The identifier of the filing schema the question belongs to. | | `sectionIndex` | int32 | | default | Zero-based position of the question's section in the schema. | | `sectionName` | string | `Eq`, `IsOneOf` | | The name of the schema section the question belongs to. | | `questionIndex` | int32 | | yes | Zero-based position of the question within its section. | | `questionLabel` | string | | | The question as shown to the filer. | | `answerType` | string | `Eq`, `IsOneOf` | | The answer type of the question: text or table. | | `answerMode` | string | `Eq`, `IsOneOf` | | The layout of the answer: single, fielded, open, grid, or sectioned. | | `answer` | object | | | The submitted answer object; its shape follows the answer type and mode, and all text values are markdown. Null when the question was not answered. | | `label` | string | `Eq`, `IsOneOf` | | The reviewer's label for the answer: complete, partially_complete, or incomplete; null when unlabelled. | | `gap` | bool | `Eq` | | True when the question counts as a gap in the filing's completion. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/token-transparency-filing-questions?pageSize=3&selections=id,filingID,questionID,schemaID" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Token Transparency Filing Questions](/api-reference/data-api/token-transparency/tabular-token-transparency-filing-questions) for the response and the errors. # Token Transparency Filing Schemas Source: https://docs.blockworks.com/api-reference/data-api/token-transparency/token-transparency-filing-schemas One row per version of a Token Transparency Framework question set, keyed by schemaID: filing type, version, question count and the ordered sections with every question's label, answer type, configuration and filer instructions. | | | | - | - | | Access | Token-transparency-dataset | | Tabular model | `token-transparency-filing-schemas`: primary key `schemaID` | ## Endpoints > [card] [List Token Transparency Filing Schemas](/api-reference/data-api/token-transparency/tabular-token-transparency-filing-schemas) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Token Transparency Filing Schema](/api-reference/data-api/token-transparency/tabular-token-transparency-filing-schemas-by-id) > > One row by `schemaID`. ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `schemaID` | string | `Eq`, `IsOneOf` | | The unique identifier of the filing schema. (primary key) | | `versionID` | string | `Eq`, `IsOneOf` | default | The schema version label (e.g. 2.0). | | `filingType` | string | `Eq`, `IsOneOf` | yes | The filing type the schema applies to (e.g. B1, B2). | | `sections` | array_object | | | The schema's sections in order, each with its name and questions: id, label, answer type, configuration and instructions. | | `questionCount` | int32 | | | Number of questions across all sections. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/token-transparency-filing-schemas?pageSize=3&selections=schemaID,versionID,filingType,sections" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Token Transparency Filing Schemas](/api-reference/data-api/token-transparency/tabular-token-transparency-filing-schemas) for the response and the errors. # Token Transparency Filings Source: https://docs.blockworks.com/api-reference/data-api/token-transparency/token-transparency-filings One row per published Token Transparency Framework filing, keyed by filingID: project and its launch platform, filing type and version, schema, publish and filing dates, provenance, question and gap counts with a completion label, latest and superseded flags, status and the filing's page URL. Filter by project, ticker, type, status or date. | | | | - | - | | Access | Token-transparency-dataset | | Tabular model | `token-transparency-filings`: primary key `filingID` | ## Endpoints > [card] [List Token Transparency Filings](/api-reference/data-api/token-transparency/tabular-token-transparency-filings) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Token Transparency Filing](/api-reference/data-api/token-transparency/tabular-token-transparency-filings-by-id) > > One row by `filingID`. ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `filingID` | string | `Eq`, `IsOneOf` | | The unique identifier of the filing. (primary key) | | `bwProjectID` | int64 | `Eq`, `IsOneOf` | | The Blockworks research project id the filing belongs to. | | `bwProjectSlug` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | yes | The Blockworks research project slug, used to group filings by project and in the filing's static URL. | | `protocolName` | string | `Eq`, `IsOneOf`, `Contains` | yes | The display name of the project's protocol. | | `protocolTicker` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The asset ticker of the project's protocol; null when the project has no asset. | | `launchOriginTitle` | string | | | The title of the platform the project launched through, for example MetaDAO; null when the project has no launch platform. | | `launchOriginSlug` | string | | | The Blockworks research project slug of the launch platform; null when the project has no launch platform. | | `launchOriginImageURL` | string | | | The logo URL of the launch platform; null when the platform has no logo or the project has no launch platform. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the mapped project record, when the research project is mapped to one. | | `projectSlug` | string | `Eq`, `IsOneOf` | | The project's slug elsewhere in the API, when the research project is mapped to a project record. | | `projectName` | string | | | The name of the mapped project record, when the research project is mapped to one. | | `filingType` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | yes | The filing type (e.g. B1, B2). | | `filingVersion` | string | `Eq`, `IsOneOf` | | The version of the filing schema the filing was answered against (e.g. 2.0). | | `schemaID` | string | `Eq`, `IsOneOf` | | The identifier of the filing schema, joinable to the Token Transparency Filing Schemas model. | | `submissionRound` | int32 | | | The submission round that was published. | | `provenance` | string | `Eq`, `IsOneOf` | | Who compiled the filing: issuer-filed, blockworks-compiled or contributor-filed. | | `publishAt` | time | `Gt`, `Gte`, `Lt`, `Lte` | default | When the filing was published, in UTC. | | `dateFiled` | time | `Eq`, `Gt`, `Gte`, `Lt`, `Lte` | yes | The UTC date the filing was published. | | `questionCount` | int32 | | | Number of questions in the filing's schema. | | `gapCount` | int32 | `Eq`, `Gt`, `Gte`, `Lt`, `Lte` | yes | Number of questions with a gap: unanswered, unscored, or scored below complete. | | `completionLabel` | string | `Eq`, `IsOneOf` | | Completion label derived from the gap count: complete, or partial with the number of gaps. | | `filingTypeRank` | int32 | `Eq`, `Lte` | | Rank of the filing among the project's filings of the same type, newest first; 1 is the latest. | | `isSuperseded` | bool | `Eq` | | True when a newer filing of the same type exists for the project. | | `isLatestForType` | bool | `Eq` | | True for the newest filing of each type per project; filter on it to get one filing per type. | | `filingStatus` | string | `Eq`, `IsOneOf` | | current, or stale when the filing is superseded or past its staleness deadline. | | `stalenessTTLMonths` | int32 | | | Months after the filing date before the filing goes stale, for filing types governed by a time-to-live rule. | | `stalenessNextDeadline` | time | | | The next recurring deadline after the filing date, for filing types governed by deadline rules; the filing goes stale once it passes. | | `staticURL` | string | | | The public URL of the filing on blockworks.com. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/token-transparency-filings?pageSize=3&selections=filingID,bwProjectID,bwProjectSlug,protocolName" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Token Transparency Filings](/api-reference/data-api/token-transparency/tabular-token-transparency-filings) for the response and the errors. # Token Transparency Projects Source: https://docs.blockworks.com/api-reference/data-api/token-transparency/token-transparency-projects One row per project with at least one published Token Transparency Framework filing, keyed by project slug: name, ticker, launch platform, the mapped project record and filing count. Lists which projects have filed and resolves a ticker to a project. | | | | - | - | | Access | Token-transparency-dataset | | Tabular model | `token-transparency-projects`: primary key `id` | ## Endpoints > [card] [List Token Transparency Projects](/api-reference/data-api/token-transparency/tabular-token-transparency-projects) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Token Transparency Project](/api-reference/data-api/token-transparency/tabular-token-transparency-projects-by-id) > > One row by `id`. ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | yes | The Blockworks research project slug, the public identity of the project. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the project's protocol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The project's slug elsewhere in the API, when the research project is mapped to a project record. | | `protocolTicker` | string | `Eq`, `IsOneOf`, `IsNotOneOf` | | The asset ticker of the project's protocol; null when the project has no asset. | | `launchOriginTitle` | string | | | The title of the platform the project launched through, for example MetaDAO; null when the project has no launch platform. | | `launchOriginSlug` | string | | | The Blockworks research project slug of the launch platform; null when the project has no launch platform. | | `launchOriginImageURL` | string | | | The logo URL of the launch platform; null when the platform has no logo or the project has no launch platform. | | `bwProjectID` | int64 | `Eq`, `IsOneOf` | | The Blockworks research project id. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the mapped project record, when mapped. | | `projectName` | string | | | The name of the mapped project record, when mapped. | | `filingCount` | int32 | | yes | Number of published filings for the project. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/token-transparency-projects?pageSize=3&selections=id,name,slug,protocolTicker" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Token Transparency Projects](/api-reference/data-api/token-transparency/tabular-token-transparency-projects) for the response and the errors. # Token Unlocks Source: https://docs.blockworks.com/api-reference/data-api/token-unlocks/overview Token Unlocks: Token Unlocks. ## Endpoints | Model | Access | Timeseries | | - | - | - | | [Token Unlocks](/api-reference/data-api/token-unlocks/token-unlocks) | Token-unlocks | [Batch](/api-reference/data-api/token-unlocks/timeseries-token-unlocks), [One series](/api-reference/data-api/token-unlocks/timeseries-token-unlocks-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/token-unlocks/1d?series=1e31218a-e44e-4285-820c-8282ee222035,21c795f5-1bfd-40c3-858e-e9d7e820c6d0&timeframe=7d&selections=unlock-amount,unlock-amount-usd" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Batch Get Token Unlock timeseries](/api-reference/data-api/token-unlocks/timeseries-token-unlocks) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # Batch Get Token Unlock timeseries Source: https://docs.blockworks.com/api-reference/data-api/token-unlocks/timeseries-token-unlocks api-reference/data-api/openapi.json GET /query/timeseries/token-unlocks/{granularity} Daily token unlock schedule of an asset, past and future. Each series is one asset, keyed by its asset id. Points run ahead of today to the end of the vesting schedule, so the series answers when the next unlock is and how much unlocks in the next N days. Each point gives the amount unlocked that day in tokens and USD, the cumulative and remaining unlock amounts, the share of the schedule completed, and that day's unlock as a share of circulating supply. # Get Token Unlock timeseries Source: https://docs.blockworks.com/api-reference/data-api/token-unlocks/timeseries-token-unlocks-by-id api-reference/data-api/openapi.json GET /query/timeseries/token-unlocks/{granularity}/{id} Daily token unlock schedule of an asset, past and future. Each series is one asset, keyed by its asset id. Points run ahead of today to the end of the vesting schedule, so the series answers when the next unlock is and how much unlocks in the next N days. Each point gives the amount unlocked that day in tokens and USD, the cumulative and remaining unlock amounts, the share of the schedule completed, and that day's unlock as a share of circulating supply. # Token Unlocks Source: https://docs.blockworks.com/api-reference/data-api/token-unlocks/token-unlocks Daily token unlock schedule of an asset, past and future. Each series is one asset, keyed by its asset id. Points run ahead of today to the end of the vesting schedule, so the series answers when the next unlock is and how much unlocks in the next N days. Each point gives the amount unlocked that day in tokens and USD, the cumulative and remaining unlock amounts, the share of the schedule completed, and that day's unlock as a share of circulating supply. | | | | - | - | | Access | Token-unlocks | | Timeseries model | `token-unlocks`: intervals `1d`, series key `id` (Asset ID), series must be named (up to 10 per call) | ## Endpoints > [card] [Batch Get Token Unlock timeseries](/api-reference/data-api/token-unlocks/timeseries-token-unlocks) > > Up to 10 series in one request, named by Asset ID in `series`. > [card] [Get Token Unlock timeseries](/api-reference/data-api/token-unlocks/timeseries-token-unlocks-by-id) > > One series over a time window, keyed by its Asset ID. ## Metrics 8 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `unlock-amount` | Unlock Amount | float64 | | The amount of the asset unlocked on this day, in native tokens | | `unlock-amount-usd` | Unlock Amount (USD) | float64 | usd | The amount of the asset unlocked on this day, in USD | | `cumulative-unlock-amount` | Cumulative Unlock Amount | float64 | | The total amount of the asset unlocked up to and including this day, in native tokens | | `cumulative-unlock-amount-usd` | Cumulative Unlock Amount (USD) | float64 | usd | The total amount of the asset unlocked up to and including this day, in USD | | `remaining-unlock-amount` | Remaining Unlock Amount | int64 | | The amount of the asset still to unlock after this day, in native tokens | | `remaining-unlock-amount-usd` | Remaining Unlock Amount (USD) | float64 | usd | The amount of the asset still to unlock after this day, in USD | | `pct-of-unlocks-completed` | Percentage of Unlocks Completed | float64 | percent | The percentage (0-100) of the asset's full unlock schedule unlocked up to and including this day | | `pct-of-circulating-supply-unlocked` | Percentage of Circulating Supply Unlocked | float64 | percent | The amount unlocked on this day as a percentage (0-100) of the asset's circulating supply | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/token-unlocks/1d/1e31218a-e44e-4285-820c-8282ee222035?timeframe=7d&selections=unlock-amount,unlock-amount-usd" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Token Unlock timeseries](/api-reference/data-api/token-unlocks/timeseries-token-unlocks-by-id) for the response and the errors. # Tokenized Commodities Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/overview Tokenized commodity metrics (onchain gold, silver, oil and others) at four grains: per product, per issuer, per underlying commodity and per chain. Each grain has a lookup table for its keys and a timeseries model for supply, mints, burns and price. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Tokenized Commodities by Chain](/api-reference/data-api/tokenized-commodities/tokenized-commodities-by-chain) | Tokenized-commodities-dataset | [List rows](/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodity-chains) | [Batch](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-chain), [One series](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-chain-by-id) | | [Tokenized Commodities by Commodity](/api-reference/data-api/tokenized-commodities/tokenized-commodities-by-commodity) | Tokenized-commodities-dataset | [List rows](/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodities) | [Batch](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-commodity), [One series](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-commodity-by-id) | | [Tokenized Commodities by Issuer](/api-reference/data-api/tokenized-commodities/tokenized-commodities-by-issuer) | Tokenized-commodities-dataset | [List rows](/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodity-issuers) | [Batch](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-issuer), [One series](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-issuer-by-id) | | [Tokenized Commodities by Product](/api-reference/data-api/tokenized-commodities/tokenized-commodities-by-product) | Tokenized-commodities-dataset | [List rows](/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodity-products) | [Batch](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-product), [One series](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-product-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/tokenized-commodity-chains?pageSize=3&selections=id,slug,name,networkID" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Tokenized Commodity Chains](/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodity-chains) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Commodities Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodities api-reference/data-api/openapi.json GET /query/tabular/tokenized-commodities One row per commodity with tokenized products, keyed by its commodity id: name. The id is the series key of the tokenized-commodities-by-commodity timeseries model. # List Tokenized Commodity Chains Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodity-chains api-reference/data-api/openapi.json GET /query/tabular/tokenized-commodity-chains One row per blockchain with tokenized commodity activity, keyed by the short chain name: name, the chain's slug and its network id. The id is the series key of the tokenized-commodities-by-chain timeseries model. # List Tokenized Commodity Issuers Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodity-issuers api-reference/data-api/openapi.json GET /query/tabular/tokenized-commodity-issuers One row per tokenized commodity issuer, the company that mints and redeems the tokens, keyed by its short name: name, project slug and project id where the issuer is a tracked project. The id is the series key of the tokenized-commodities-by-issuer timeseries model. # List Tokenized Commodity Products Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodity-products api-reference/data-api/openapi.json GET /query/tabular/tokenized-commodity-products One row per tokenized commodity product, one issuer's token for one underlying commodity, keyed by its token id: name, ticker symbol and the underlying commodity id. The id is the series key of the tokenized-commodities-by-product timeseries model. # Batch Get Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-chain api-reference/data-api/openapi.json GET /query/timeseries/tokenized-commodities-by-chain/{granularity} Tokenized commodity (on-chain gold, silver, oil...) metrics summed across all issuers on a blockchain: tokens, issuers and underlying commodities, circulating supply, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. Lending and DEX fields are null where a chain has no such activity, so pass selections. # Get Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-chain-by-id api-reference/data-api/openapi.json GET /query/timeseries/tokenized-commodities-by-chain/{granularity}/{id} Tokenized commodity (on-chain gold, silver, oil...) metrics summed across all issuers on a blockchain: tokens, issuers and underlying commodities, circulating supply, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. Lending and DEX fields are null where a chain has no such activity, so pass selections. # Batch Get Commodity timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-commodity api-reference/data-api/openapi.json GET /query/timeseries/tokenized-commodities-by-commodity/{granularity} Metrics for one underlying commodity summed across every issuer and chain tokenizing it: chains, issuers and contracts, tokenized supply, average token price, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), holders, spot DEX volume and transfers. Each series is one commodity, keyed by its commodity id. # Get Commodity timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-commodity-by-id api-reference/data-api/openapi.json GET /query/timeseries/tokenized-commodities-by-commodity/{granularity}/{id} Metrics for one underlying commodity summed across every issuer and chain tokenizing it: chains, issuers and contracts, tokenized supply, average token price, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), holders, spot DEX volume and transfers. Each series is one commodity, keyed by its commodity id. # Batch Get Tokenized Commodity Issuer timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-issuer api-reference/data-api/openapi.json GET /query/timeseries/tokenized-commodities-by-issuer/{granularity} Tokenized commodity metrics for an issuer, summed across its products and chains: chains, tokens and underlying commodities, circulating supply, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its slug. Lending and DEX fields are null where an issuer's tokens see no such activity, so pass selections. # Get Tokenized Commodity Issuer timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-issuer-by-id api-reference/data-api/openapi.json GET /query/timeseries/tokenized-commodities-by-issuer/{granularity}/{id} Tokenized commodity metrics for an issuer, summed across its products and chains: chains, tokens and underlying commodities, circulating supply, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its slug. Lending and DEX fields are null where an issuer's tokens see no such activity, so pass selections. # Batch Get Tokenized Commodity Product timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-product api-reference/data-api/openapi.json GET /query/timeseries/tokenized-commodities-by-product/{granularity} Metrics for one tokenized commodity product, an issuer's token for one underlying commodity, summed across the chains it is deployed on: chains and contracts, circulating supply, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one product, keyed by its token id. # Get Tokenized Commodity Product timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-product-by-id api-reference/data-api/openapi.json GET /query/timeseries/tokenized-commodities-by-product/{granularity}/{id} Metrics for one tokenized commodity product, an issuer's token for one underlying commodity, summed across the chains it is deployed on: chains and contracts, circulating supply, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one product, keyed by its token id. # Tokenized Commodities by Chain Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/tokenized-commodities-by-chain Tokenized commodity (on-chain gold, silver, oil...) metrics summed across all issuers on a blockchain: tokens, issuers and underlying commodities, circulating supply, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. Lending and DEX fields are null where a chain has no such activity, so pass selections. One row per blockchain with tokenized commodity activity, keyed by the short chain name: name, the chain's slug and its network id. The id is the series key of the tokenized-commodities-by-chain timeseries model. | | | | - | - | | Access | Tokenized-commodities-dataset | | Tabular model | `tokenized-commodity-chains`: primary key `id`, identifiers `slug` | | Timeseries model | `tokenized-commodities-by-chain`: intervals `1d`, series key `id` (Chain ID), every series available in one call | ## Endpoints > [card] [List Tokenized Commodity Chains](/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodity-chains) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Chain timeseries](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-chain) > > Every series in one request, or the named ones. > [card] [Get Chain timeseries](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-chain-by-id) > > One series over a time window, keyed by its Chain ID. ## Metrics 33 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `tokenizedCommodityCount` | Tokenized Commodity Count | float64 | | Distinct tokenized-commodity token contracts on the chain. | | `issuerCount` | Issuer Count | float64 | | Distinct issuers on the chain. | | `uniqueCommodityCount` | Unique Commodity Count | float64 | | Distinct underlying commodities on the chain. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD (negative). | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed against in lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted average lending supply APY (0-1). | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted average lending borrow APY (0-1). | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of liquidations. | | `holders` | Holders | float64 | | Token holders. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the tokenized-commodities-by-chain timeseries model, the short chain name. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the chain. | | `slug` | string | `Eq`, `IsOneOf` | yes | The chain's slug in the blockchains model. (identifier 1) | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/tokenized-commodities-by-chain/1d/arbitrum?timeframe=7d&selections=tokenizedCommodityCount,issuerCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Chain timeseries](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-chain-by-id) for the response and the errors. # Tokenized Commodities by Commodity Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/tokenized-commodities-by-commodity Metrics for one underlying commodity summed across every issuer and chain tokenizing it: chains, issuers and contracts, tokenized supply, average token price, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), holders, spot DEX volume and transfers. Each series is one commodity, keyed by its commodity id. One row per commodity with tokenized products, keyed by its commodity id: name. The id is the series key of the tokenized-commodities-by-commodity timeseries model. | | | | - | - | | Access | Tokenized-commodities-dataset | | Tabular model | `tokenized-commodities`: primary key `id` | | Timeseries model | `tokenized-commodities-by-commodity`: intervals `1d`, series key `id` (Commodity ID), every series available in one call | ## Endpoints > [card] [List Commodities](/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodities) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Commodity timeseries](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-commodity) > > Every series in one request, or the named ones. > [card] [Get Commodity timeseries](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-commodity-by-id) > > One series over a time window, keyed by its Commodity ID. ## Metrics 20 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `chainCount` | Chain Count | float64 | | Distinct chains the commodity is tokenized on. | | `issuerCount` | Issuer Count | float64 | | Distinct issuers tokenizing the commodity. | | `tokenAddressCount` | Token Address Count | float64 | | Distinct token contract addresses across chains. | | `tokenizedSupplyUSD` | Tokenized Supply (USD) | float64 | | Tokenized supply in USD across every issuer and chain. | | `averagePriceUSD` | Average Price (USD) | float64 | | Average token price in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD (negative). | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `holders` | Holders | float64 | | Token holders. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Transfers. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the tokenized-commodities-by-commodity timeseries model, the commodity id. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the commodity, its id in uppercase. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/tokenized-commodities-by-commodity/1d/emld?timeframe=7d&selections=chainCount,issuerCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Commodity timeseries](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-commodity-by-id) for the response and the errors. # Tokenized Commodities by Issuer Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/tokenized-commodities-by-issuer Tokenized commodity metrics for an issuer, summed across its products and chains: chains, tokens and underlying commodities, circulating supply, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its slug. Lending and DEX fields are null where an issuer's tokens see no such activity, so pass selections. One row per tokenized commodity issuer, the company that mints and redeems the tokens, keyed by its short name: name, project slug and project id where the issuer is a tracked project. The id is the series key of the tokenized-commodities-by-issuer timeseries model. | | | | - | - | | Access | Tokenized-commodities-dataset | | Tabular model | `tokenized-commodity-issuers`: primary key `id`, identifiers `slug` | | Timeseries model | `tokenized-commodities-by-issuer`: intervals `1d`, series key `id` (Issuer ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Tokenized Commodity Issuers](/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodity-issuers) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Tokenized Commodity Issuer timeseries](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-issuer) > > Up to 10 series in one request, named by Issuer ID in `series`. > [card] [Get Tokenized Commodity Issuer timeseries](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-issuer-by-id) > > One series over a time window, keyed by its Issuer ID. ## Metrics 33 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `chainCount` | Chain Count | float64 | | Distinct chains the issuer has deployed on. | | `tokenizedCommodityCount` | Tokenized Commodity Count | float64 | | Tokenized-commodity token contracts issued, counted per chain. | | `uniqueCommodityCount` | Unique Commodity Count | float64 | | Distinct underlying commodities issued. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD (negative). | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed against in lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted average lending supply APY (0-1). | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted average lending borrow APY (0-1). | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of liquidations. | | `holders` | Holders | float64 | | Token holders. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the tokenized-commodities-by-issuer timeseries model, the issuer's short name. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the issuer. | | `slug` | string | `Eq`, `IsOneOf` | yes | The issuer's project slug, the slug used for the same company across the API. (identifier 1) | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the issuer's project record. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/tokenized-commodities-by-issuer/1d/agros?timeframe=7d&selections=chainCount,tokenizedCommodityCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Tokenized Commodity Issuer timeseries](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-issuer-by-id) for the response and the errors. # Tokenized Commodities by Product Source: https://docs.blockworks.com/api-reference/data-api/tokenized-commodities/tokenized-commodities-by-product Metrics for one tokenized commodity product, an issuer's token for one underlying commodity, summed across the chains it is deployed on: chains and contracts, circulating supply, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one product, keyed by its token id. One row per tokenized commodity product, one issuer's token for one underlying commodity, keyed by its token id: name, ticker symbol and the underlying commodity id. The id is the series key of the tokenized-commodities-by-product timeseries model. | | | | - | - | | Access | Tokenized-commodities-dataset | | Tabular model | `tokenized-commodity-products`: primary key `id` | | Timeseries model | `tokenized-commodities-by-product`: intervals `1d`, series key `id` (Product ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Tokenized Commodity Products](/api-reference/data-api/tokenized-commodities/tabular-tokenized-commodity-products) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Tokenized Commodity Product timeseries](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-product) > > Up to 10 series in one request, named by Product ID in `series`. > [card] [Get Tokenized Commodity Product timeseries](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-product-by-id) > > One series over a time window, keyed by its Product ID. ## Metrics 32 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `chainCount` | Chain Count | float64 | | Distinct chains the product is deployed on. | | `tokenAddressCount` | Token Address Count | float64 | | Distinct token contract addresses across chains. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD (negative). | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed against in lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted average lending supply APY (0-1). | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted average lending borrow APY (0-1). | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of liquidations. | | `holders` | Holders | float64 | | Token holders. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the tokenized-commodities-by-product timeseries model, the issuer's short name followed by the token symbol. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the product, its ticker symbol. | | `symbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `commodityID` | string | `Eq`, `IsOneOf` | | The underlying commodity, the series key of the tokenized-commodities-by-commodity timeseries model. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/tokenized-commodities-by-product/1d/agros?timeframe=7d&selections=chainCount,tokenAddressCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Tokenized Commodity Product timeseries](/api-reference/data-api/tokenized-commodities/timeseries-tokenized-commodities-by-product-by-id) for the response and the errors. # Tokenized Equities Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/overview Tokenized stock metrics at four grains: per product (one issuer's token for one equity), per issuer, per underlying equity and per chain. Each grain has a lookup table for its keys and a timeseries model for supply, mints, burns and where the supply sits. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Tokenized Equities by Chain](/api-reference/data-api/tokenized-equities/tokenized-equities-by-chain) | Tokenized-equities-dataset | [List rows](/api-reference/data-api/tokenized-equities/tabular-tokenized-equity-chains) | [Batch](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-chain), [One series](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-chain-by-id) | | [Tokenized Equities by Equity](/api-reference/data-api/tokenized-equities/tokenized-equities-by-equity) | Tokenized-equities-dataset | [List rows](/api-reference/data-api/tokenized-equities/tabular-tokenized-equities) | [Batch](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-equity), [One series](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-equity-by-id) | | [Tokenized Equities by Issuer](/api-reference/data-api/tokenized-equities/tokenized-equities-by-issuer) | Tokenized-equities-dataset | [List rows](/api-reference/data-api/tokenized-equities/tabular-tokenized-equity-issuers) | [Batch](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-issuer), [One series](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-issuer-by-id) | | [Tokenized Equities by Product](/api-reference/data-api/tokenized-equities/tokenized-equities-by-product) | Tokenized-equities-dataset | [List rows](/api-reference/data-api/tokenized-equities/tabular-tokenized-equity-products) | [Batch](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-product), [One series](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-product-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/tokenized-equity-chains?pageSize=3&selections=id,slug,name,networkID" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Tokenized Equity Chains](/api-reference/data-api/tokenized-equities/tabular-tokenized-equity-chains) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Equities Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/tabular-tokenized-equities api-reference/data-api/openapi.json GET /query/tabular/tokenized-equities One row per underlying stock with tokenized products, keyed by its ticker: name. The id is the series key of the tokenized-equities-by-equity timeseries model. # List Tokenized Equity Chains Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/tabular-tokenized-equity-chains api-reference/data-api/openapi.json GET /query/tabular/tokenized-equity-chains One row per blockchain with tokenized stock activity, keyed by the short chain name: name, the chain's slug and its network id. The id is the series key of the tokenized-equities-by-chain timeseries model. # List Tokenized Equity Issuers Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/tabular-tokenized-equity-issuers api-reference/data-api/openapi.json GET /query/tabular/tokenized-equity-issuers One row per tokenized stock issuer, the company that mints and redeems the tokens, keyed by its short name: name, project slug and project id where the issuer is a tracked project. The id is the series key of the tokenized-equities-by-issuer timeseries model. # List Tokenized Equity Products Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/tabular-tokenized-equity-products api-reference/data-api/openapi.json GET /query/tabular/tokenized-equity-products One row per tokenized stock product, one issuer's token for one underlying equity, keyed by issuer and symbol: name, ticker symbol and whether the underlying is a public or private company. The id is the series key of the tokenized-equities-by-product timeseries model. # Batch Get Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-chain api-reference/data-api/openapi.json GET /query/timeseries/tokenized-equities-by-chain/{granularity} Tokenized stock metrics summed across all issuers on a blockchain: tokens, issuers and underlying equities, circulating supply split public versus private, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. Lending and DEX fields are null where a chain has no such activity, so pass selections. # Get Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-chain-by-id api-reference/data-api/openapi.json GET /query/timeseries/tokenized-equities-by-chain/{granularity}/{id} Tokenized stock metrics summed across all issuers on a blockchain: tokens, issuers and underlying equities, circulating supply split public versus private, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. Lending and DEX fields are null where a chain has no such activity, so pass selections. # Batch Get Equity timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-equity api-reference/data-api/openapi.json GET /query/timeseries/tokenized-equities-by-equity/{granularity} Metrics for one underlying stock summed across every issuer and chain tokenizing it: chains, issuers and contracts, tokenized supply, the underlying's close price and traded volume, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), holders, spot DEX volume and transfers. Each series is one stock, keyed by its ticker. The widest tokenized-equity grain, with over a thousand series, so name the stocks you need. # Get Equity timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-equity-by-id api-reference/data-api/openapi.json GET /query/timeseries/tokenized-equities-by-equity/{granularity}/{id} Metrics for one underlying stock summed across every issuer and chain tokenizing it: chains, issuers and contracts, tokenized supply, the underlying's close price and traded volume, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), holders, spot DEX volume and transfers. Each series is one stock, keyed by its ticker. The widest tokenized-equity grain, with over a thousand series, so name the stocks you need. # Batch Get Tokenized Equity Issuer timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-issuer api-reference/data-api/openapi.json GET /query/timeseries/tokenized-equities-by-issuer/{granularity} Tokenized stock metrics for an issuer, summed across its products and chains: chains, tokens and underlying equities, circulating supply split public versus private, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its slug. Lending and DEX fields are null where an issuer's tokens see no such activity, so pass selections. # Get Tokenized Equity Issuer timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-issuer-by-id api-reference/data-api/openapi.json GET /query/timeseries/tokenized-equities-by-issuer/{granularity}/{id} Tokenized stock metrics for an issuer, summed across its products and chains: chains, tokens and underlying equities, circulating supply split public versus private, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its slug. Lending and DEX fields are null where an issuer's tokens see no such activity, so pass selections. # Batch Get Tokenized Equity Product timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-product api-reference/data-api/openapi.json GET /query/timeseries/tokenized-equities-by-product/{granularity} Metrics for one tokenized stock, an issuer's token for one underlying equity, summed across the chains it is deployed on: chains and contracts, circulating supply, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one product, keyed by issuer and symbol. Thousands of series, so name the products you need. # Get Tokenized Equity Product timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-product-by-id api-reference/data-api/openapi.json GET /query/timeseries/tokenized-equities-by-product/{granularity}/{id} Metrics for one tokenized stock, an issuer's token for one underlying equity, summed across the chains it is deployed on: chains and contracts, circulating supply, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one product, keyed by issuer and symbol. Thousands of series, so name the products you need. # Tokenized Equities by Chain Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/tokenized-equities-by-chain Tokenized stock metrics summed across all issuers on a blockchain: tokens, issuers and underlying equities, circulating supply split public versus private, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one chain, keyed by its chain slug. Lending and DEX fields are null where a chain has no such activity, so pass selections. One row per blockchain with tokenized stock activity, keyed by the short chain name: name, the chain's slug and its network id. The id is the series key of the tokenized-equities-by-chain timeseries model. | | | | - | - | | Access | Tokenized-equities-dataset | | Tabular model | `tokenized-equity-chains`: primary key `id`, identifiers `slug` | | Timeseries model | `tokenized-equities-by-chain`: intervals `1d`, series key `id` (Chain ID), every series available in one call | ## Endpoints > [card] [List Tokenized Equity Chains](/api-reference/data-api/tokenized-equities/tabular-tokenized-equity-chains) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Chain timeseries](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-chain) > > Every series in one request, or the named ones. > [card] [Get Chain timeseries](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-chain-by-id) > > One series over a time window, keyed by its Chain ID. ## Metrics 35 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `tokenizedEquityCount` | Tokenized Equity Count | float64 | | Distinct tokenized-equity token contracts on the chain. | | `issuerCount` | Issuer Count | float64 | | Distinct issuers on the chain. | | `uniqueEquityCount` | Unique Equity Count | float64 | | Distinct underlying equities on the chain. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply of tokenized equities in USD. | | `publicEquitySupplyUSD` | Public Equity Supply (USD) | float64 | | Circulating supply of tokenized public equities in USD. | | `privateEquitySupplyUSD` | Private Equity Supply (USD) | float64 | | Circulating supply of tokenized private-company equities in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD (negative). | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed against in lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted average lending supply APY (0-1). | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted average lending borrow APY (0-1). | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of liquidations. | | `holders` | Holders | float64 | | Token holders. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the tokenized-equities-by-chain timeseries model, the short chain name. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the chain. | | `slug` | string | `Eq`, `IsOneOf` | yes | The chain's slug in the blockchains model. (identifier 1) | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/tokenized-equities-by-chain/1d/arbitrum?timeframe=7d&selections=tokenizedEquityCount,issuerCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Chain timeseries](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-chain-by-id) for the response and the errors. # Tokenized Equities by Equity Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/tokenized-equities-by-equity Metrics for one underlying stock summed across every issuer and chain tokenizing it: chains, issuers and contracts, tokenized supply, the underlying's close price and traded volume, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), holders, spot DEX volume and transfers. Each series is one stock, keyed by its ticker. The widest tokenized-equity grain, with over a thousand series, so name the stocks you need. One row per underlying stock with tokenized products, keyed by its ticker: name. The id is the series key of the tokenized-equities-by-equity timeseries model. | | | | - | - | | Access | Tokenized-equities-dataset | | Tabular model | `tokenized-equities`: primary key `id` | | Timeseries model | `tokenized-equities-by-equity`: intervals `1d`, series key `id` (Equity ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Equities](/api-reference/data-api/tokenized-equities/tabular-tokenized-equities) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Equity timeseries](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-equity) > > Up to 10 series in one request, named by Equity ID in `series`. > [card] [Get Equity timeseries](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-equity-by-id) > > One series over a time window, keyed by its Equity ID. ## Metrics 21 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `chainCount` | Chain Count | float64 | | Distinct chains the stock is tokenized on. | | `issuerCount` | Issuer Count | float64 | | Distinct issuers tokenizing the stock. | | `tokenAddressCount` | Token Address Count | float64 | | Distinct token contract addresses across chains. | | `tokenizedSupplyUSD` | Tokenized Supply (USD) | float64 | | Tokenized supply in USD across every issuer and chain. | | `underlyingPriceUSD` | Underlying Price (USD) | float64 | | Closing price of the underlying stock in USD. | | `underlyingVolume` | Underlying Volume | float64 | | Traded volume of the underlying stock, in shares. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD (negative). | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `holders` | Holders | float64 | | Token holders. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Transfers. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the tokenized-equities-by-equity timeseries model, the stock ticker in lowercase. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the stock, its ticker in uppercase. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/tokenized-equities-by-equity/1d/a?timeframe=7d&selections=chainCount,issuerCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Equity timeseries](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-equity-by-id) for the response and the errors. # Tokenized Equities by Issuer Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/tokenized-equities-by-issuer Tokenized stock metrics for an issuer, summed across its products and chains: chains, tokens and underlying equities, circulating supply split public versus private, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one issuer, keyed by its slug. Lending and DEX fields are null where an issuer's tokens see no such activity, so pass selections. One row per tokenized stock issuer, the company that mints and redeems the tokens, keyed by its short name: name, project slug and project id where the issuer is a tracked project. The id is the series key of the tokenized-equities-by-issuer timeseries model. | | | | - | - | | Access | Tokenized-equities-dataset | | Tabular model | `tokenized-equity-issuers`: primary key `id`, identifiers `slug` | | Timeseries model | `tokenized-equities-by-issuer`: intervals `1d`, series key `id` (Issuer ID), every series available in one call | ## Endpoints > [card] [List Tokenized Equity Issuers](/api-reference/data-api/tokenized-equities/tabular-tokenized-equity-issuers) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Tokenized Equity Issuer timeseries](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-issuer) > > Every series in one request, or the named ones. > [card] [Get Tokenized Equity Issuer timeseries](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-issuer-by-id) > > One series over a time window, keyed by its Issuer ID. ## Metrics 35 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `chainCount` | Chain Count | float64 | | Distinct chains the issuer has deployed on. | | `tokenizedEquityCount` | Tokenized Equity Count | float64 | | Tokenized-equity token contracts issued, counted per chain. | | `uniqueEquityCount` | Unique Equity Count | float64 | | Distinct underlying equities issued. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply of tokenized equities in USD. | | `publicEquitySupplyUSD` | Public Equity Supply (USD) | float64 | | Circulating supply of tokenized public equities in USD. | | `privateEquitySupplyUSD` | Private Equity Supply (USD) | float64 | | Circulating supply of tokenized private-company equities in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD (negative). | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed against in lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted average lending supply APY (0-1). | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted average lending borrow APY (0-1). | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of liquidations. | | `holders` | Holders | float64 | | Token holders. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the tokenized-equities-by-issuer timeseries model, the issuer's short name. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the issuer. | | `slug` | string | `Eq`, `IsOneOf` | yes | The issuer's project slug, the slug used for the same company across the API. (identifier 1) | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the issuer's project record. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/tokenized-equities-by-issuer/1d/anchored?timeframe=7d&selections=chainCount,tokenizedEquityCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Tokenized Equity Issuer timeseries](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-issuer-by-id) for the response and the errors. # Tokenized Equities by Product Source: https://docs.blockworks.com/api-reference/data-api/tokenized-equities/tokenized-equities-by-product Metrics for one tokenized stock, an issuer's token for one underlying equity, summed across the chains it is deployed on: chains and contracts, circulating supply, mints and burns, where the supply sits (CEX, DEX, lending, unlabeled wallets), lending deposits, borrows and APYs, holders, spot DEX volume and transfers. Each series is one product, keyed by issuer and symbol. Thousands of series, so name the products you need. One row per tokenized stock product, one issuer's token for one underlying equity, keyed by issuer and symbol: name, ticker symbol and whether the underlying is a public or private company. The id is the series key of the tokenized-equities-by-product timeseries model. | | | | - | - | | Access | Tokenized-equities-dataset | | Tabular model | `tokenized-equity-products`: primary key `id` | | Timeseries model | `tokenized-equities-by-product`: intervals `1d`, series key `id` (Product ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Tokenized Equity Products](/api-reference/data-api/tokenized-equities/tabular-tokenized-equity-products) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Tokenized Equity Product timeseries](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-product) > > Up to 10 series in one request, named by Product ID in `series`. > [card] [Get Tokenized Equity Product timeseries](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-product-by-id) > > One series over a time window, keyed by its Product ID. ## Metrics 32 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `chainCount` | Chain Count | float64 | | Distinct chains the product is deployed on. | | `tokenAddressCount` | Token Address Count | float64 | | Distinct token contract addresses across chains. | | `circulatingSupplyUSD` | Circulating Supply (USD) | float64 | | Circulating supply of tokenized equities in USD. | | `mintAmountUSD` | Mint Amount (USD) | float64 | | Value minted in USD. | | `burnAmountUSD` | Burn Amount (USD) | float64 | | Value burned in USD (negative). | | `mintCount` | Mint Count | float64 | | Number of mint events. | | `burnCount` | Burn Count | float64 | | Number of burn events. | | `balanceCEXUSD` | Balance on CEXes (USD) | float64 | | Supply held in centralized-exchange wallets in USD. | | `balancePerpDEXUSD` | Balance on Perp DEXes (USD) | float64 | | Supply held in perpetual-DEX contracts in USD. | | `balanceSpotDEXUSD` | Balance on Spot DEXes (USD) | float64 | | Supply held in spot-DEX pools in USD. | | `balanceLendingUSD` | Balance in Lending (USD) | float64 | | Supply held in lending protocols in USD. | | `balanceUnknownUSD` | Balance Unknown (USD) | float64 | | Supply held in unlabeled wallets in USD. | | `lendingDepositsUSD` | Lending Deposits (USD) | float64 | | Deposited in lending protocols in USD. | | `lendingBorrowedUSD` | Lending Borrowed (USD) | float64 | | Borrowed against in lending protocols in USD. | | `lendingNetFlowUSD` | Lending Net Flow (USD) | float64 | | Net lending flow in USD (gross inflow plus gross outflow). | | `lendingGrossInflowUSD` | Lending Gross Inflow (USD) | float64 | | Gross lending inflow in USD. | | `lendingGrossOutflowUSD` | Lending Gross Outflow (USD) | float64 | | Gross lending outflow in USD (negative). | | `lendingSupplyAPY` | Lending Supply APY | float64 | | Deposit-weighted average lending supply APY (0-1). | | `lendingBorrowAPY` | Lending Borrow APY | float64 | | Borrow-weighted average lending borrow APY (0-1). | | `lendingCollateralSeizedUSD` | Lending Collateral Seized (USD) | float64 | | Collateral seized in liquidations in USD. | | `lendingLiquidationLossUSD` | Lending Liquidation Loss (USD) | float64 | | Liquidation losses in USD. | | `lendingLiquidationCount` | Lending Liquidation Count | float64 | | Number of liquidations. | | `holders` | Holders | float64 | | Token holders. | | `spotDEXBuyVolumeUSD` | Spot DEX Buy Volume (USD) | float64 | | Spot DEX buy volume in USD. | | `spotDEXSellVolumeUSD` | Spot DEX Sell Volume (USD) | float64 | | Spot DEX sell volume in USD. | | `spotDEXVolumeUSD` | Spot DEX Volume (USD) | float64 | | Spot DEX volume in USD. | | `spotDEXTradeCount` | Spot DEX Trade Count | float64 | | Spot DEX trades. | | `spotDEXTraders` | Spot DEX Traders | float64 | | Spot DEX traders. | | `transferVolumeUSD` | Transfer Volume (USD) | float64 | | Transfer volume in USD. | | `transferCount` | Transfer Count | float64 | | Transfers. | | `transferUniqueSenders` | Transfer Unique Senders | float64 | | Distinct sending addresses. | | `transferUniqueReceivers` | Transfer Unique Receivers | float64 | | Distinct receiving addresses. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the tokenized-equities-by-product timeseries model, the issuer's short name followed by the token symbol. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the product, its ticker symbol. | | `symbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `subsector` | string | `Eq`, `IsOneOf` | | Whether the underlying is a public or private company (public, private); empty where unclassified. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/tokenized-equities-by-product/1d/anchored-aaapl?timeframe=7d&selections=chainCount,tokenAddressCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Tokenized Equity Product timeseries](/api-reference/data-api/tokenized-equities/timeseries-tokenized-equities-by-product-by-id) for the response and the errors. # Tokens Source: https://docs.blockworks.com/api-reference/data-api/tokens/overview The token classification table and the per-deployment token series. Token Labels names every token contract on every chain with its category, sector, subsector and issuer; Token Metrics carries price, total, issued, circulating and adjusted supply, mints and burns, and the balance held in each venue type -- bridges, CEXes, spot and perp DEXes, CDPs, staking, treasuries and the rest. Both are keyed by chain and contract address, and share an id. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Token Metrics](/api-reference/data-api/tokens/token-metrics) | Assets-dataset | [List rows](/api-reference/data-api/tokens/tabular-token-metrics) | [Batch](/api-reference/data-api/tokens/timeseries-token-metrics), [One series](/api-reference/data-api/tokens/timeseries-token-metrics-by-id) | | [Token Labels](/api-reference/data-api/tokens/token-labels) | Assets-dataset | [List rows](/api-reference/data-api/tokens/tabular-token-labels), [One row](/api-reference/data-api/tokens/tabular-token-labels-by-id) | | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/token-metrics?pageSize=3&selections=id,name,slug,chain" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Token Metrics](/api-reference/data-api/tokens/tabular-token-metrics) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Tokens Source: https://docs.blockworks.com/api-reference/data-api/tokens/tabular-token-labels api-reference/data-api/openapi.json GET /query/tabular/token-labels One row per token contract per chain from the Blockworks Research token classification: chain and contract address, symbol, category, sector and subsector, the issuer, and for bridged or wrapped tokens the token and asset they represent. Deployments of one token on several chains share a slug. # Get Token Source: https://docs.blockworks.com/api-reference/data-api/tokens/tabular-token-labels-by-id api-reference/data-api/openapi.json GET /query/tabular/token-labels/{id} One row per token contract per chain from the Blockworks Research token classification: chain and contract address, symbol, category, sector and subsector, the issuer, and for bridged or wrapped tokens the token and asset they represent. Deployments of one token on several chains share a slug. # List Token Metrics Source: https://docs.blockworks.com/api-reference/data-api/tokens/tabular-token-metrics api-reference/data-api/openapi.json GET /query/tabular/token-metrics One row per token deployment with token metrics, keyed by chain and contract address: symbol, slug, category, sector and subsector, issuer and network. The id is the series key of the token-metrics timeseries model and matches the token-labels id. # Batch Get Token Metric timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokens/timeseries-token-metrics api-reference/data-api/openapi.json GET /query/timeseries/token-metrics/{granularity} Daily metrics for one token contract on one chain: price, supply, mints and burns, supply held by each holder type, holders by balance size, lending, spot DEX trading and transfer activity. Each series is one token deployment, keyed by chain and contract address, and matching the token-labels id. Many series per token, so name the deployments you need. # Get Token Metric timeseries Source: https://docs.blockworks.com/api-reference/data-api/tokens/timeseries-token-metrics-by-id api-reference/data-api/openapi.json GET /query/timeseries/token-metrics/{granularity}/{id} Daily metrics for one token contract on one chain: price, supply, mints and burns, supply held by each holder type, holders by balance size, lending, spot DEX trading and transfer activity. Each series is one token deployment, keyed by chain and contract address, and matching the token-labels id. Many series per token, so name the deployments you need. # Token Labels Source: https://docs.blockworks.com/api-reference/data-api/tokens/token-labels One row per token contract per chain from the Blockworks Research token classification: chain and contract address, symbol, category, sector and subsector, the issuer, and for bridged or wrapped tokens the token and asset they represent. Deployments of one token on several chains share a slug. | | | | - | - | | Access | Assets-dataset | | Tabular model | `token-labels`: primary key `id`, aliases `tokens` | ## Endpoints > [card] [List Tokens](/api-reference/data-api/tokens/tabular-token-labels) > > One page of rows with per-column filters, sorting and pagination. > [card] [Get Token](/api-reference/data-api/tokens/tabular-token-labels-by-id) > > One row by `id`. ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `bridgeID` | string | | | The bridge a bridged token was issued through (for example stargate or layerzero); null otherwise. | | `category` | string | | | The token's category (for example stablecoins or blockchains). | | `chain` | string | | | The short name of the chain the token is deployed on (ethereum, base, solana). | | `id` | string | | | The token's chain and contract address, joined with an underscore (ethereum_0xa0b8...eb48). | | `issuerID` | string | | | The identifier of the token's issuer (for example circle or tether); null when unclassified. | | `launchpadID` | string | | | The launchpad the token was launched on; null otherwise. | | `name` | string | | | The token's display name, its symbol, falling back to its slug. | | `networkID` | string | | | The chain's networkID in the blockchains model; null when unmapped. | | `networkSlug` | string | | | The chain's slug in the blockchains model; null when unmapped. | | `sector` | string | | | The token's sector within its category (for example usd or l1). | | `slug` | string | | | The token's identifier, shared by every chain's deployment of the same token (circle-usdc); null when unclassified, and not unique across chains. | | `subsector` | string | | | The token's subsector within its sector (for example fiat or bitcoin). | | `symbol` | string | | | The token's ticker symbol. | | `tokenAddress` | string | | | The token contract address (the mint address on Solana). | | `tokenVersion` | string | | | The token standard or version (for example erc20). | | `underlyingAssetID` | string | | | The asset the token tracks (for example usd or bitcoin); null when unclassified. | | `underlyingTokenSlug` | string | | | The slug of the token a bridged or wrapped token represents; null otherwise. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/token-labels?pageSize=3&selections=id,name,slug,chain" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Tokens](/api-reference/data-api/tokens/tabular-token-labels) for the response and the errors. # Token Metrics Source: https://docs.blockworks.com/api-reference/data-api/tokens/token-metrics Daily metrics for one token contract on one chain: price, supply, mints and burns, supply held by each holder type, holders by balance size, lending, spot DEX trading and transfer activity. Each series is one token deployment, keyed by chain and contract address, and matching the token-labels id. Many series per token, so name the deployments you need. One row per token deployment with token metrics, keyed by chain and contract address: symbol, slug, category, sector and subsector, issuer and network. The id is the series key of the token-metrics timeseries model and matches the token-labels id. | | | | - | - | | Access | Assets-dataset | | Tabular model | `token-metrics`: primary key `id` | | Timeseries model | `token-metrics`: intervals `1d`, series key `id` (Token Metric ID), every series available in one call | ## Endpoints > [card] [List Token Metrics](/api-reference/data-api/tokens/tabular-token-metrics) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Token Metric timeseries](/api-reference/data-api/tokens/timeseries-token-metrics) > > Up to 10 series in one request, named by series key in `series`. > [card] [Get Token Metric timeseries](/api-reference/data-api/tokens/timeseries-token-metrics-by-id) > > One series over a time window, keyed by its Token Metric ID. ## Metrics 111 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `priceUSD` | | | | | | `supplyTotal` | | | | | | `supplyIssued` | | | | | | `supplyIssuedUSD` | | | | | | `supplyCirculating` | | | | | | `supplyCirculatingUSD` | | | | | | `supplyAdjusted` | | | | | | `supplyAdjustedUSD` | | | | | | `mintAmount` | | | | | | `burnAmount` | | | | | | `mintAmountUSD` | | | | | | `burnAmountUSD` | | | | | | `mintCount` | | | | | | `burnCount` | | | | | | `balanceProtocolOwned` | | | | | | `balanceBridge` | | | | | | `balanceCEX` | | | | | | `balancePerpDEX` | | | | | | `balanceSpotDEX` | | | | | | `balancePayments` | | | | | | `balancePrivacy` | | | | | | `balanceStaking` | | | | | | `balanceCDP` | | | | | | `balanceTreasuries` | | | | | | `balancePredictionMarket` | | | | | | `balanceYieldDerivatives` | | | | | | `balanceManaged` | | | | | | `balanceWrapped` | | | | | | `balanceBlacklist` | | | | | | `balanceBuyback` | | | | | | `balanceLending` | | | | | | `balanceProtocolOwnedUSD` | | | | | | `balanceBridgeUSD` | | | | | | `balanceCEXUSD` | | | | | | `balancePerpDEXUSD` | | | | | | `balanceSpotDEXUSD` | | | | | | `balancePaymentsUSD` | | | | | | `balancePrivacyUSD` | | | | | | `balanceStakingUSD` | | | | | | `balanceCDPUSD` | | | | | | `balanceTreasuriesUSD` | | | | | | `balancePredictionMarketUSD` | | | | | | `balanceYieldDerivativesUSD` | | | | | | `balanceManagedUSD` | | | | | | `balanceWrappedUSD` | | | | | | `balanceBuybackUSD` | | | | | | `balanceLendingUSD` | | | | | | `balanceBlacklistUSD` | | | | | | `balanceUnknownUSD` | | | | | | `balanceUnknown` | | | | | | `holdersTotal` | | | | | | `holders0To1` | | | | | | `holders1To10` | | | | | | `holders10To100` | | | | | | `holders100To1K` | | | | | | `holders1KTo10K` | | | | | | `holders10KPlus` | | | | | | `lendingDepositUSD` | | | | | | `lendingBorrowUSD` | | | | | | `lendingNetFlowUSD` | | | | | | `lendingGrossInflowUSD` | | | | | | `lendingGrossOutflowUSD` | | | | | | `lendingAvgSupplyAPY` | | | | | | `lendingAvgBorrowAPY` | | | | | | `lendingCollateralSeizedUSD` | | | | | | `lendingLiquidationLossUSD` | | | | | | `lendingLiquidationCount` | | | | | | `spotDEXBuyVolumeUSD` | | | | | | `spotDEXSellVolumeUSD` | | | | | | `spotDEXCorrelatedVolumeUSD` | | | | | | `spotDEXVolumeUSD` | | | | | | `spotDEXTradeCount` | | | | | | `spotDEXTraders` | | | | | | `marketsUniqueSpotDEX` | | | | | | `spotDEXLiquidityAddVolume` | | | | | | `spotDEXLiquidityBurnVolume` | | | | | | `spotDEXLiquidityAddCount` | | | | | | `spotDEXLiquidityBurnCount` | | | | | | `transferVolumeRaw` | | | | | | `transferVolumeRawUSD` | | | | | | `transferSendersUnique` | | | | | | `transferReceiversUnique` | | | | | | `transferSizeMedian` | | | | | | `transferCount` | | | | | | `transferSizeMedianUSD` | | | | | | `transferCount0To1` | | | | | | `transferCount1To10` | | | | | | `transferCount10To100` | | | | | | `transferCount100To1K` | | | | | | `transferCount1KTo10K` | | | | | | `transferCount10KTo100K` | | | | | | `transferCount100KTo1M` | | | | | | `transferCount1MPlus` | | | | | | `transferVolume0To1` | | | | | | `transferVolume1To10` | | | | | | `transferVolume10To100` | | | | | | `transferVolume100To1K` | | | | | | `transferVolume1KTo10K` | | | | | | `transferVolume10KTo100K` | | | | | | `transferVolume100KTo1M` | | | | | | `transferVolume1MPlus` | | | | | | `transferVolumeBridge` | | | | | | `transferVolumeBridgeUSD` | | | | | | `transferVolumeCEXFlow` | | | | | | `transferVolumeCEXFlowUSD` | | | | | | `transferVolumeCEXIntra` | | | | | | `transferVolumeCEXIntraUSD` | | | | | | `transferVolumePrivacy` | | | | | | `transferVolumePrivacyUSD` | | | | | | `transferVolumeFlashloan` | | | | | | `transferVolumeFlashloanUSD` | | | | | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `category` | string | | | The token's category classification. | | `chain` | string | | | The short name of the chain the token is deployed on (ethereum, base, solana). | | `id` | string | | | The series key of the token-metrics timeseries model, the token's chain and contract address joined with an underscore. | | `issuerID` | string | | | The identifier of the token's issuer (for example circle or tether); null when unclassified. | | `name` | string | | | The display name of the series, the token's symbol followed by its chain. | | `networkID` | string | | | The chain's networkID in the blockchains model; null when unmapped. | | `sector` | string | | | The token's sector classification. | | `slug` | string | | | The token's identifier, shared by every chain's deployment of the same token (circle-usdc); null when unclassified, and not unique across chains. | | `subsector` | string | | | The token's subsector classification. | | `symbol` | string | | | The token's ticker symbol. | | `tokenAddress` | string | | | The token contract address (the mint address on Solana). | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/token-metrics/1d/?timeframe=7d&selections=priceUSD,supplyTotal" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Token Metric timeseries](/api-reference/data-api/tokens/timeseries-token-metrics-by-id) for the response and the errors. # Vaults Source: https://docs.blockworks.com/api-reference/data-api/vaults/overview Onchain vault metrics per protocol, per curator and per chain: assets under management, active vaults, gross yield, net yield paid to depositors and fees. Each of the three series has its own lookup table. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Vault Balances](/api-reference/data-api/vaults/vault-balances) | Vaults-dataset | [List rows](/api-reference/data-api/vaults/tabular-vault-balances) | [Batch](/api-reference/data-api/vaults/timeseries-vault-balances), [One series](/api-reference/data-api/vaults/timeseries-vault-balances-by-id) | | [Vault Curators](/api-reference/data-api/vaults/vault-curators) | Vaults-dataset | [List rows](/api-reference/data-api/vaults/tabular-vault-curators) | [Batch](/api-reference/data-api/vaults/timeseries-vault-curators), [One series](/api-reference/data-api/vaults/timeseries-vault-curators-by-id) | | [Vault Financials](/api-reference/data-api/vaults/vault-financials) | Vaults-dataset | [List rows](/api-reference/data-api/vaults/tabular-vault-financials) | [Batch](/api-reference/data-api/vaults/timeseries-vault-financials), [One series](/api-reference/data-api/vaults/timeseries-vault-financials-by-id) | | [Vault Flows](/api-reference/data-api/vaults/vault-flows) | Vaults-dataset | [List rows](/api-reference/data-api/vaults/tabular-vault-flows) | [Batch](/api-reference/data-api/vaults/timeseries-vault-flows), [One series](/api-reference/data-api/vaults/timeseries-vault-flows-by-id) | | [Vault Performances](/api-reference/data-api/vaults/vault-performances) | Vaults-dataset | [List rows](/api-reference/data-api/vaults/tabular-vault-performances) | [Batch](/api-reference/data-api/vaults/timeseries-vault-performances), [One series](/api-reference/data-api/vaults/timeseries-vault-performances-by-id) | | [Vault Protocols](/api-reference/data-api/vaults/vault-protocols) | Vaults-dataset | [List rows](/api-reference/data-api/vaults/tabular-vault-protocols) | [Batch](/api-reference/data-api/vaults/timeseries-vault-protocols), [One series](/api-reference/data-api/vaults/timeseries-vault-protocols-by-id) | | [Vaults by Chain](/api-reference/data-api/vaults/vaults-by-chain) | Vaults-dataset | [List rows](/api-reference/data-api/vaults/tabular-vault-chains) | [Batch](/api-reference/data-api/vaults/timeseries-vaults-by-chain), [One series](/api-reference/data-api/vaults/timeseries-vaults-by-chain-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/vault-balances?pageSize=3&selections=id,name,slug,parentSlug" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Vault Balances](/api-reference/data-api/vaults/tabular-vault-balances) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Vault Balances Source: https://docs.blockworks.com/api-reference/data-api/vaults/tabular-vault-balances api-reference/data-api/openapi.json GET /query/tabular/vault-balances One row per token in a vault, keyed by protocol, product, chain, vault and token: the vault, its curator and classification, the token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the vault-balances timeseries model. # List Vault Chains Source: https://docs.blockworks.com/api-reference/data-api/vaults/tabular-vault-chains api-reference/data-api/openapi.json GET /query/tabular/vault-chains One row per blockchain with vault activity, keyed by the short chain name: name, the chain's slug and its network id. The id is the series key of the vaults-by-chain timeseries model. # List Vault Curators Source: https://docs.blockworks.com/api-reference/data-api/vaults/tabular-vault-curators api-reference/data-api/openapi.json GET /query/tabular/vault-curators One row per vault curator, the team that designs and manages vault strategies, keyed by its short name: name, project slug and project id where the curator is a tracked project. The id is the series key of the vault-curators timeseries model. # List Vault Financials Source: https://docs.blockworks.com/api-reference/data-api/vaults/tabular-vault-financials api-reference/data-api/openapi.json GET /query/tabular/vault-financials One row per token in a vault with financials, keyed by protocol, product, chain, vault and token: the vault, its curator and classification, the token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the vault-financials timeseries model. # List Vault Flows Source: https://docs.blockworks.com/api-reference/data-api/vaults/tabular-vault-flows api-reference/data-api/openapi.json GET /query/tabular/vault-flows One row per vault flow, keyed by protocol, product, chain, vault, token, balance type and balance subtype: the vault, its curator, the token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the vault-flows timeseries model. # List Vault Performances Source: https://docs.blockworks.com/api-reference/data-api/vaults/tabular-vault-performances api-reference/data-api/openapi.json GET /query/tabular/vault-performances One row per token in a vault with performance data, keyed by protocol, product, chain, vault and token: the vault, its curator and classification, the token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the vault- performances timeseries model. # List Vault Protocols Source: https://docs.blockworks.com/api-reference/data-api/vaults/tabular-vault-protocols api-reference/data-api/openapi.json GET /query/tabular/vault-protocols One row per vault protocol, keyed by its short name: name, project slug and project id. The id is the series key of the vault-protocols timeseries model. # Batch Get Vault Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-balances api-reference/data-api/openapi.json GET /query/timeseries/vault-balances/{granularity} Daily balance, in native units of the vault asset and in USD, for one token in one vault. Each series is one vault token, keyed by protocol, product, chain, vault and token. Many series per protocol, so name the vaults you need. # Get Vault Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-balances-by-id api-reference/data-api/openapi.json GET /query/timeseries/vault-balances/{granularity}/{id} Daily balance, in native units of the vault asset and in USD, for one token in one vault. Each series is one vault token, keyed by protocol, product, chain, vault and token. Many series per protocol, so name the vaults you need. # Batch Get Vault Curator timeseries Source: https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-curators api-reference/data-api/openapi.json GET /query/timeseries/vault-curators/{granularity} Metrics for a vault curator across all chains and vault protocols: assets under management, active vaults, gross yield, net yield paid to depositors and fees, in USD. Each series is one curator, keyed by its slug. # Get Vault Curator timeseries Source: https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-curators-by-id api-reference/data-api/openapi.json GET /query/timeseries/vault-curators/{granularity}/{id} Metrics for a vault curator across all chains and vault protocols: assets under management, active vaults, gross yield, net yield paid to depositors and fees, in USD. Each series is one curator, keyed by its slug. # Batch Get Vault Financial timeseries Source: https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-financials api-reference/data-api/openapi.json GET /query/timeseries/vault-financials/{granularity} Daily gross and net yield and performance, management and platform fees in USD for one token in one vault, with shares outstanding and share price. Each series is one vault token, keyed by protocol, product, chain, vault and token. Many series per protocol, so name the vaults you need. # Get Vault Financial timeseries Source: https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-financials-by-id api-reference/data-api/openapi.json GET /query/timeseries/vault-financials/{granularity}/{id} Daily gross and net yield and performance, management and platform fees in USD for one token in one vault, with shares outstanding and share price. Each series is one vault token, keyed by protocol, product, chain, vault and token. Many series per protocol, so name the vaults you need. # Batch Get Vault Flow timeseries Source: https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-flows api-reference/data-api/openapi.json GET /query/timeseries/vault-flows/{granularity} Daily gross inflow, gross outflow and net flow, in native units and USD, for one token in one vault, split by balance subtype (vault asset or base asset). Each series is keyed by protocol, product, chain, vault, token, balance type and balance subtype. Many series per protocol, so name the vaults you need. # Get Vault Flow timeseries Source: https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-flows-by-id api-reference/data-api/openapi.json GET /query/timeseries/vault-flows/{granularity}/{id} Daily gross inflow, gross outflow and net flow, in native units and USD, for one token in one vault, split by balance subtype (vault asset or base asset). Each series is keyed by protocol, product, chain, vault, token, balance type and balance subtype. Many series per protocol, so name the vaults you need. # Batch Get Vault Performance timeseries Source: https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-performances api-reference/data-api/openapi.json GET /query/timeseries/vault-performances/{granularity} Daily balance in USD, gross, net and curator yield as APR and APY, and performance, management and platform fee rates for one token in one vault. Rates are decimals (0.05 is 5%). Each series is one vault token, keyed by protocol, product, chain, vault and token. Many series per protocol, so name the vaults you need. # Get Vault Performance timeseries Source: https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-performances-by-id api-reference/data-api/openapi.json GET /query/timeseries/vault-performances/{granularity}/{id} Daily balance in USD, gross, net and curator yield as APR and APY, and performance, management and platform fee rates for one token in one vault. Rates are decimals (0.05 is 5%). Each series is one vault token, keyed by protocol, product, chain, vault and token. Many series per protocol, so name the vaults you need. # Batch Get Vault Protocol timeseries Source: https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-protocols api-reference/data-api/openapi.json GET /query/timeseries/vault-protocols/{granularity} Metrics for a vault protocol across all chains: assets under management, active vaults, distinct curators, gross yield, net yield paid to depositors and fees, in USD. Each series is one protocol, keyed by its slug. # Get Vault Protocol timeseries Source: https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-protocols-by-id api-reference/data-api/openapi.json GET /query/timeseries/vault-protocols/{granularity}/{id} Metrics for a vault protocol across all chains: assets under management, active vaults, distinct curators, gross yield, net yield paid to depositors and fees, in USD. Each series is one protocol, keyed by its slug. # Batch Get Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vaults-by-chain api-reference/data-api/openapi.json GET /query/timeseries/vaults-by-chain/{granularity} Vault metrics summed across all vault protocols on a blockchain: assets under management, active vaults, curators, gross yield, net yield and fees, in USD. Each series is one chain, keyed by its chain slug. # Get Chain timeseries Source: https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vaults-by-chain-by-id api-reference/data-api/openapi.json GET /query/timeseries/vaults-by-chain/{granularity}/{id} Vault metrics summed across all vault protocols on a blockchain: assets under management, active vaults, curators, gross yield, net yield and fees, in USD. Each series is one chain, keyed by its chain slug. # Vault Balances Source: https://docs.blockworks.com/api-reference/data-api/vaults/vault-balances Daily balance, in native units of the vault asset and in USD, for one token in one vault. Each series is one vault token, keyed by protocol, product, chain, vault and token. Many series per protocol, so name the vaults you need. One row per token in a vault, keyed by protocol, product, chain, vault and token: the vault, its curator and classification, the token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the vault-balances timeseries model. | | | | - | - | | Access | Vaults-dataset | | Tabular model | `vault-balances`: primary key `id` | | Timeseries model | `vault-balances`: intervals `1d`, series key `id` (Vault Balance ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Vault Balances](/api-reference/data-api/vaults/tabular-vault-balances) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Vault Balance timeseries](/api-reference/data-api/vaults/timeseries-vault-balances) > > Up to 10 series in one request, named by Vault Balance ID in `series`. > [card] [Get Vault Balance timeseries](/api-reference/data-api/vaults/timeseries-vault-balances-by-id) > > One series over a time window, keyed by its Vault Balance ID. ## Metrics 2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `balance` | Balance | float64 | | Vault balance in native units of the vault asset. | | `balanceUSD` | Balance (USD) | float64 | | Vault balance in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the vault-balances timeseries model, the parent slug, product slug, chain, vault key and token key, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the vault name and token symbol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The project's slug, the slug used for the same project across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name (aave, morpho). | | `productSlug` | string | `Eq`, `IsOneOf` | | The product within the parent protocol (morpho-vault). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the vault lives on (ethereum, base, solana). | | `vaultID` | string | `Eq`, `IsOneOf` | | The vault contract or program address; null when the protocol does not label vaults. | | `vaultName` | string | `Eq`, `IsOneOf`, `Contains` | | The vault display name. | | `vaultType` | string | `Eq`, `IsOneOf` | | The vault type. | | `vaultVersion` | string | `Eq`, `IsOneOf` | | The vault version. | | `vaultStrategy` | string | `Eq`, `IsOneOf` | | The vault strategy. | | `vaultCategory` | string | `Eq`, `IsOneOf` | | The vault category. | | `vaultSubcategory` | string | `Eq`, `IsOneOf` | | The vault subcategory within its category. | | `curator` | string | `Eq`, `IsOneOf`, `Contains` | | The curator's display name (Steakhouse Financial, Gauntlet); Unknown when unattributed. | | `curatorSlug` | string | `Eq`, `IsOneOf` | | The curator's slug, the id in vault-curators (steakhouse-financial, unknown). | | `curatorProjectID` | string | `Eq`, `IsOneOf` | | The identifier of the curator's project record; null when unmapped. | | `curatorProjectSlug` | string | `Eq`, `IsOneOf` | | The slug of the curator's project record; null when unmapped. | | `institutionalPartner` | string | `Eq`, `IsOneOf` | | The institutional partner the vault is run for; null otherwise. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The vault asset's contract address (the mint address on Solana); null when unlabeled. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The vault asset's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/vault-balances/1d/?timeframe=7d&selections=balance,balanceUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Vault Balance timeseries](/api-reference/data-api/vaults/timeseries-vault-balances-by-id) for the response and the errors. # Vault Curators Source: https://docs.blockworks.com/api-reference/data-api/vaults/vault-curators Metrics for a vault curator across all chains and vault protocols: assets under management, active vaults, gross yield, net yield paid to depositors and fees, in USD. Each series is one curator, keyed by its slug. One row per vault curator, the team that designs and manages vault strategies, keyed by its short name: name, project slug and project id where the curator is a tracked project. The id is the series key of the vault-curators timeseries model. | | | | - | - | | Access | Vaults-dataset | | Tabular model | `vault-curators`: primary key `id`, identifiers `slug` | | Timeseries model | `vault-curators`: intervals `1d`, series key `id` (Curator ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Vault Curators](/api-reference/data-api/vaults/tabular-vault-curators) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Vault Curator timeseries](/api-reference/data-api/vaults/timeseries-vault-curators) > > Up to 10 series in one request, named by Curator ID in `series`. > [card] [Get Vault Curator timeseries](/api-reference/data-api/vaults/timeseries-vault-curators-by-id) > > One series over a time window, keyed by its Curator ID. ## Metrics 5 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `aumUSD` | AUM (USD) | float64 | | Total assets under management in vaults in USD. | | `vaultCount` | Vault Count | float64 | | Number of active vaults. | | `grossYieldUSD` | Gross Yield (USD) | float64 | | Yield generated by vaults before fees in USD. | | `netYieldUSD` | Net Yield (USD) | float64 | | Yield paid to depositors net of fees in USD. | | `feesUSD` | Fees (USD) | float64 | | Fees taken by vaults and curators in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the vault-curators timeseries model, the curator's short name (gauntlet). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the curator. | | `slug` | string | `Eq`, `IsOneOf` | yes | The curator's project slug, when the curator is also a tracked project; null otherwise. (identifier 1) | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the curator's project record; null when the curator is not a tracked project. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/vault-curators/1d/9summits?timeframe=7d&selections=aumUSD,vaultCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Vault Curator timeseries](/api-reference/data-api/vaults/timeseries-vault-curators-by-id) for the response and the errors. # Vault Financials Source: https://docs.blockworks.com/api-reference/data-api/vaults/vault-financials Daily gross and net yield and performance, management and platform fees in USD for one token in one vault, with shares outstanding and share price. Each series is one vault token, keyed by protocol, product, chain, vault and token. Many series per protocol, so name the vaults you need. One row per token in a vault with financials, keyed by protocol, product, chain, vault and token: the vault, its curator and classification, the token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the vault-financials timeseries model. | | | | - | - | | Access | Vaults-dataset | | Tabular model | `vault-financials`: primary key `id` | | Timeseries model | `vault-financials`: intervals `1d`, series key `id` (Vault Financial ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Vault Financials](/api-reference/data-api/vaults/tabular-vault-financials) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Vault Financial timeseries](/api-reference/data-api/vaults/timeseries-vault-financials) > > Up to 10 series in one request, named by Vault Financial ID in `series`. > [card] [Get Vault Financial timeseries](/api-reference/data-api/vaults/timeseries-vault-financials-by-id) > > One series over a time window, keyed by its Vault Financial ID. ## Metrics 9 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `grossYieldUSD` | Gross Yield (USD) | float64 | | Gross yield earned by the vault in USD. | | `netYieldUSD` | Net Yield (USD) | float64 | | Yield to depositors after fees in USD. | | `performanceFeesUSD` | Performance Fees (USD) | float64 | | Performance fees in USD. | | `managementFeesUSD` | Management Fees (USD) | float64 | | Management fees in USD. | | `platformFeesUSD` | Platform Fees (USD) | float64 | | Platform fees in USD. | | `feesUSD` | Fees (USD) | float64 | | Total fees in USD. | | `totalShares` | Total Shares | float64 | | Vault shares outstanding. | | `sharePrice` | Share Price | float64 | | Share price in units of the vault asset. | | `sharePriceUSD` | Share Price (USD) | float64 | | Share price in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the vault-financials timeseries model, the parent slug, product slug, chain, vault key and token key, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the vault name and token symbol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The project's slug, the slug used for the same project across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name (aave, morpho). | | `productSlug` | string | `Eq`, `IsOneOf` | | The product within the parent protocol (morpho-vault). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the vault lives on (ethereum, base, solana). | | `vaultID` | string | `Eq`, `IsOneOf` | | The vault contract or program address; null when the protocol does not label vaults. | | `vaultName` | string | `Eq`, `IsOneOf`, `Contains` | | The vault display name. | | `vaultType` | string | `Eq`, `IsOneOf` | | The vault type. | | `vaultVersion` | string | `Eq`, `IsOneOf` | | The vault version. | | `vaultStrategy` | string | `Eq`, `IsOneOf` | | The vault strategy. | | `vaultCategory` | string | `Eq`, `IsOneOf` | | The vault category. | | `vaultSubcategory` | string | `Eq`, `IsOneOf` | | The vault subcategory within its category. | | `curator` | string | `Eq`, `IsOneOf`, `Contains` | | The curator's display name (Steakhouse Financial, Gauntlet); Unknown when unattributed. | | `curatorSlug` | string | `Eq`, `IsOneOf` | | The curator's slug, the id in vault-curators (steakhouse-financial, unknown). | | `curatorProjectID` | string | `Eq`, `IsOneOf` | | The identifier of the curator's project record; null when unmapped. | | `curatorProjectSlug` | string | `Eq`, `IsOneOf` | | The slug of the curator's project record; null when unmapped. | | `institutionalPartner` | string | `Eq`, `IsOneOf` | | The institutional partner the vault is run for; null otherwise. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The vault asset's contract address (the mint address on Solana); null when unlabeled. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The vault asset's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/vault-financials/1d/?timeframe=7d&selections=grossYieldUSD,netYieldUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Vault Financial timeseries](/api-reference/data-api/vaults/timeseries-vault-financials-by-id) for the response and the errors. # Vault Flows Source: https://docs.blockworks.com/api-reference/data-api/vaults/vault-flows Daily gross inflow, gross outflow and net flow, in native units and USD, for one token in one vault, split by balance subtype (vault asset or base asset). Each series is keyed by protocol, product, chain, vault, token, balance type and balance subtype. Many series per protocol, so name the vaults you need. One row per vault flow, keyed by protocol, product, chain, vault, token, balance type and balance subtype: the vault, its curator, the token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the vault-flows timeseries model. | | | | - | - | | Access | Vaults-dataset | | Tabular model | `vault-flows`: primary key `id` | | Timeseries model | `vault-flows`: intervals `1d`, series key `id` (Vault Flow ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Vault Flows](/api-reference/data-api/vaults/tabular-vault-flows) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Vault Flow timeseries](/api-reference/data-api/vaults/timeseries-vault-flows) > > Up to 10 series in one request, named by Vault Flow ID in `series`. > [card] [Get Vault Flow timeseries](/api-reference/data-api/vaults/timeseries-vault-flows-by-id) > > One series over a time window, keyed by its Vault Flow ID. ## Metrics 6 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `grossInflow` | Gross Inflow | float64 | | Gross inflow, in native units. | | `grossOutflow` | Gross Outflow | float64 | | Gross outflow, in native units. | | `netFlow` | Net Flow | float64 | | Net flow, in native units. | | `grossInflowUSD` | Gross Inflow (USD) | float64 | | Gross inflow in USD. | | `grossOutflowUSD` | Gross Outflow (USD) | float64 | | Gross outflow in USD. | | `netFlowUSD` | Net Flow (USD) | float64 | | Net flow in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the vault-flows timeseries model, the parent slug, product slug, chain, vault key, token key, balance type and balance subtype, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the flow, the vault name, token symbol and balance subtype. | | `slug` | string | `Eq`, `IsOneOf` | yes | The project's slug, the slug used for the same project across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name (aave, morpho). | | `productSlug` | string | `Eq`, `IsOneOf` | | The product within the parent protocol (morpho-vault). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the vault lives on (ethereum, base, solana). | | `vaultID` | string | `Eq`, `IsOneOf` | | The vault contract or program address; null when the protocol does not label vaults. | | `vaultName` | string | `Eq`, `IsOneOf`, `Contains` | | The vault display name. | | `vaultType` | string | `Eq`, `IsOneOf` | | The vault type. | | `vaultVersion` | string | `Eq`, `IsOneOf` | | The vault version. | | `vaultStrategy` | string | `Eq`, `IsOneOf` | | The vault strategy. | | `curator` | string | `Eq`, `IsOneOf`, `Contains` | | The curator's display name (Steakhouse Financial, Gauntlet); Unknown when unattributed. | | `curatorSlug` | string | `Eq`, `IsOneOf` | | The curator's slug, the id in vault-curators (steakhouse-financial, unknown). | | `curatorProjectID` | string | `Eq`, `IsOneOf` | | The identifier of the curator's project record; null when unmapped. | | `curatorProjectSlug` | string | `Eq`, `IsOneOf` | | The slug of the curator's project record; null when unmapped. | | `institutionalPartner` | string | `Eq`, `IsOneOf` | | The institutional partner the vault is run for; null otherwise. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The vault asset's contract address (the mint address on Solana); null when unlabeled. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The vault asset's ticker symbol. | | `balanceType` | string | `Eq`, `IsOneOf` | | The balance type the flow is into (deposit). | | `balanceSubtype` | string | `Eq`, `IsOneOf` | | The asset the flow is measured in (vault_asset or base_asset). | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/vault-flows/1d/?timeframe=7d&selections=grossInflow,grossOutflow" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Vault Flow timeseries](/api-reference/data-api/vaults/timeseries-vault-flows-by-id) for the response and the errors. # Vault Performances Source: https://docs.blockworks.com/api-reference/data-api/vaults/vault-performances Daily balance in USD, gross, net and curator yield as APR and APY, and performance, management and platform fee rates for one token in one vault. Rates are decimals (0.05 is 5%). Each series is one vault token, keyed by protocol, product, chain, vault and token. Many series per protocol, so name the vaults you need. One row per token in a vault with performance data, keyed by protocol, product, chain, vault and token: the vault, its curator and classification, the token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the vault- performances timeseries model. | | | | - | - | | Access | Vaults-dataset | | Tabular model | `vault-performances`: primary key `id` | | Timeseries model | `vault-performances`: intervals `1d`, series key `id` (Vault Performance ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Vault Performances](/api-reference/data-api/vaults/tabular-vault-performances) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Vault Performance timeseries](/api-reference/data-api/vaults/timeseries-vault-performances) > > Up to 10 series in one request, named by Vault Performance ID in `series`. > [card] [Get Vault Performance timeseries](/api-reference/data-api/vaults/timeseries-vault-performances-by-id) > > One series over a time window, keyed by its Vault Performance ID. ## Metrics 11 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `balanceUSD` | Balance (USD) | float64 | | Vault balance in USD. | | `grossYieldAPR` | Gross Yield APR | float64 | | Gross yield APR, as a decimal. | | `netYieldAPR` | Net Yield APR | float64 | | Net yield APR after fees, as a decimal. | | `curatorYieldAPR` | Curator Yield APR | float64 | | Curator yield APR, as a decimal. | | `grossYieldAPY` | Gross Yield APY | float64 | | Gross yield APY, as a decimal. | | `netYieldAPY` | Net Yield APY | float64 | | Net yield APY after fees, as a decimal. | | `curatorYieldAPY` | Curator Yield APY | float64 | | Curator yield APY, as a decimal. | | `performanceFeeRate` | Performance Fee Rate | float64 | | Performance fee rate, as a fraction (0.1 is 10%). | | `managementFeeRate` | Management Fee Rate | float64 | | Management fee rate, as a fraction. | | `platformFeeRate` | Platform Fee Rate | float64 | | Platform fee rate, as a fraction. | | `totalFeeRate` | Total Fee Rate | float64 | | Total fee rate, as a fraction. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the vault-performances timeseries model, the parent slug, product slug, chain, vault key and token key, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the vault name and token symbol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The project's slug, the slug used for the same project across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name (aave, morpho). | | `productSlug` | string | `Eq`, `IsOneOf` | | The product within the parent protocol (morpho-vault). | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the vault lives on (ethereum, base, solana). | | `vaultID` | string | `Eq`, `IsOneOf` | | The vault contract or program address; null when the protocol does not label vaults. | | `vaultName` | string | `Eq`, `IsOneOf`, `Contains` | | The vault display name. | | `vaultType` | string | `Eq`, `IsOneOf` | | The vault type. | | `vaultVersion` | string | `Eq`, `IsOneOf` | | The vault version. | | `vaultStrategy` | string | `Eq`, `IsOneOf` | | The vault strategy. | | `vaultCategory` | string | `Eq`, `IsOneOf` | | The vault category. | | `vaultSubcategory` | string | `Eq`, `IsOneOf` | | The vault subcategory within its category. | | `curator` | string | `Eq`, `IsOneOf`, `Contains` | | The curator's display name (Steakhouse Financial, Gauntlet); Unknown when unattributed. | | `curatorSlug` | string | `Eq`, `IsOneOf` | | The curator's slug, the id in vault-curators (steakhouse-financial, unknown). | | `curatorProjectID` | string | `Eq`, `IsOneOf` | | The identifier of the curator's project record; null when unmapped. | | `curatorProjectSlug` | string | `Eq`, `IsOneOf` | | The slug of the curator's project record; null when unmapped. | | `institutionalPartner` | string | `Eq`, `IsOneOf` | | The institutional partner the vault is run for; null otherwise. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The vault asset's contract address (the mint address on Solana); null when unlabeled. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The vault asset's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/vault-performances/1d/?timeframe=7d&selections=balanceUSD,grossYieldAPR" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Vault Performance timeseries](/api-reference/data-api/vaults/timeseries-vault-performances-by-id) for the response and the errors. # Vault Protocols Source: https://docs.blockworks.com/api-reference/data-api/vaults/vault-protocols Metrics for a vault protocol across all chains: assets under management, active vaults, distinct curators, gross yield, net yield paid to depositors and fees, in USD. Each series is one protocol, keyed by its slug. One row per vault protocol, keyed by its short name: name, project slug and project id. The id is the series key of the vault-protocols timeseries model. | | | | - | - | | Access | Vaults-dataset | | Tabular model | `vault-protocols`: primary key `id`, identifiers `slug` | | Timeseries model | `vault-protocols`: intervals `1d`, series key `id` (Project ID), every series available in one call | ## Endpoints > [card] [List Vault Protocols](/api-reference/data-api/vaults/tabular-vault-protocols) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Vault Protocol timeseries](/api-reference/data-api/vaults/timeseries-vault-protocols) > > Every series in one request, or the named ones. > [card] [Get Vault Protocol timeseries](/api-reference/data-api/vaults/timeseries-vault-protocols-by-id) > > One series over a time window, keyed by its Project ID. ## Metrics 6 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `aumUSD` | AUM (USD) | float64 | | Total assets under management in vaults in USD. | | `vaultCount` | Vault Count | float64 | | Number of active vaults. | | `curatorCount` | Curator Count | float64 | | Number of distinct vault curators. | | `grossYieldUSD` | Gross Yield (USD) | float64 | | Yield generated by vaults before fees in USD. | | `netYieldUSD` | Net Yield (USD) | float64 | | Yield paid to depositors net of fees in USD. | | `feesUSD` | Fees (USD) | float64 | | Fees taken by vaults and curators in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the vault-protocols timeseries model, the protocol's short name (morpho). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the protocol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The protocol's project slug, the slug used for the same protocol across the API. (identifier 1) | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the protocol's project record. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/vault-protocols/1d/euler?timeframe=7d&selections=aumUSD,vaultCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Vault Protocol timeseries](/api-reference/data-api/vaults/timeseries-vault-protocols-by-id) for the response and the errors. # Vaults by Chain Source: https://docs.blockworks.com/api-reference/data-api/vaults/vaults-by-chain Vault metrics summed across all vault protocols on a blockchain: assets under management, active vaults, curators, gross yield, net yield and fees, in USD. Each series is one chain, keyed by its chain slug. One row per blockchain with vault activity, keyed by the short chain name: name, the chain's slug and its network id. The id is the series key of the vaults-by-chain timeseries model. | | | | - | - | | Access | Vaults-dataset | | Tabular model | `vault-chains`: primary key `id`, identifiers `slug` | | Timeseries model | `vaults-by-chain`: intervals `1d`, series key `id` (Chain ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Vault Chains](/api-reference/data-api/vaults/tabular-vault-chains) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Chain timeseries](/api-reference/data-api/vaults/timeseries-vaults-by-chain) > > Up to 10 series in one request, named by Chain ID in `series`. > [card] [Get Chain timeseries](/api-reference/data-api/vaults/timeseries-vaults-by-chain-by-id) > > One series over a time window, keyed by its Chain ID. ## Metrics 6 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `aumUSD` | AUM (USD) | float64 | | Total assets under management in vaults in USD. | | `vaultCount` | Vault Count | float64 | | Number of active vaults. | | `curatorCount` | Curator Count | float64 | | Number of distinct vault curators. | | `grossYieldUSD` | Gross Yield (USD) | float64 | | Yield generated by vaults before fees in USD. | | `netYieldUSD` | Net Yield (USD) | float64 | | Yield paid to depositors net of fees in USD. | | `feesUSD` | Fees (USD) | float64 | | Fees taken by vaults and curators in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the vaults-by-chain timeseries model, the short chain name (arbitrum). (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the chain. | | `slug` | string | `Eq`, `IsOneOf` | yes | The chain's slug in the blockchains model (arbitrum-one). (identifier 1) | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/vaults-by-chain/1d/arbitrum?timeframe=7d&selections=aumUSD,vaultCount" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Chain timeseries](/api-reference/data-api/vaults/timeseries-vaults-by-chain-by-id) for the response and the errors. # Wholesale Credit Source: https://docs.blockworks.com/api-reference/data-api/wholesale-credit/overview Wholesale Credit: Wholesale Credit Balances, Wholesale Credit Financials, Wholesale Credit Interest Rates. ## Endpoints | Model | Access | Table | Timeseries | | - | - | - | - | | [Wholesale Credit Balances](/api-reference/data-api/wholesale-credit/wholesale-credit-balances) | Lending-protocols-dataset | [List rows](/api-reference/data-api/wholesale-credit/tabular-wholesale-credit-balances) | [Batch](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-balances), [One series](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-balances-by-id) | | [Wholesale Credit Financials](/api-reference/data-api/wholesale-credit/wholesale-credit-financials) | Lending-protocols-dataset | [List rows](/api-reference/data-api/wholesale-credit/tabular-wholesale-credit-financials) | [Batch](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-financials), [One series](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-financials-by-id) | | [Wholesale Credit Interest Rates](/api-reference/data-api/wholesale-credit/wholesale-credit-interest-rates) | Lending-protocols-dataset | [List rows](/api-reference/data-api/wholesale-credit/tabular-wholesale-credit-interest-rates) | [Batch](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-interest-rates), [One series](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-interest-rates-by-id) | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/wholesale-credit-balances?pageSize=3&selections=id,name,slug,parentSlug" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [List Wholesale Credit Balances](/api-reference/data-api/wholesale-credit/tabular-wholesale-credit-balances) for the response and the errors. ## Guides > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Every series key, the table it comes from and the identifiers that resolve to it. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [card] [Filtering and pagination](/getting-started/filtering-pagination) > > Filter suffixes, sorting, column selection and paging. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. # List Wholesale Credit Balances Source: https://docs.blockworks.com/api-reference/data-api/wholesale-credit/tabular-wholesale-credit-balances api-reference/data-api/openapi.json GET /query/tabular/wholesale-credit-balances One row per wholesale credit balance, keyed by protocol, chain, credit line, token, balance type and balance subtype: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the wholesale-credit-balances timeseries model. # List Wholesale Credit Financials Source: https://docs.blockworks.com/api-reference/data-api/wholesale-credit/tabular-wholesale-credit-financials api-reference/data-api/openapi.json GET /query/tabular/wholesale-credit-financials One row per wholesale credit financial, keyed by protocol, chain, credit line, token and recognition basis: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the wholesale-credit-financials timeseries model. # List Wholesale Credit Interest Rates Source: https://docs.blockworks.com/api-reference/data-api/wholesale-credit/tabular-wholesale-credit-interest-rates api-reference/data-api/openapi.json GET /query/tabular/wholesale-credit-interest-rates One row per wholesale credit interest rate, keyed by protocol, chain, credit line and token: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the wholesale-credit-interest-rates timeseries model. # Batch Get Wholesale Credit Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-balances api-reference/data-api/openapi.json GET /query/timeseries/wholesale-credit-balances/{granularity} Balances of wholesale credit lines extended to institutional borrowers, in USD, with the cap, the remaining room under it and gross and net flows. Each series is one credit line balance, keyed by protocol, chain, credit line, token, balance type and balance subtype. # Get Wholesale Credit Balance timeseries Source: https://docs.blockworks.com/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-balances-by-id api-reference/data-api/openapi.json GET /query/timeseries/wholesale-credit-balances/{granularity}/{id} Balances of wholesale credit lines extended to institutional borrowers, in USD, with the cap, the remaining room under it and gross and net flows. Each series is one credit line balance, keyed by protocol, chain, credit line, token, balance type and balance subtype. # Batch Get Wholesale Credit Financial timeseries Source: https://docs.blockworks.com/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-financials api-reference/data-api/openapi.json GET /query/timeseries/wholesale-credit-financials/{granularity} Interest paid and accrued by borrowers and credit losses on each wholesale credit line, in USD. Each series is one credit line token, keyed by protocol, chain, credit line, token and recognition basis (realized or accrued). # Get Wholesale Credit Financial timeseries Source: https://docs.blockworks.com/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-financials-by-id api-reference/data-api/openapi.json GET /query/timeseries/wholesale-credit-financials/{granularity}/{id} Interest paid and accrued by borrowers and credit losses on each wholesale credit line, in USD. Each series is one credit line token, keyed by protocol, chain, credit line, token and recognition basis (realized or accrued). # Batch Get Wholesale Credit Interest Rate timeseries Source: https://docs.blockworks.com/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-interest-rates api-reference/data-api/openapi.json GET /query/timeseries/wholesale-credit-interest-rates/{granularity} Balance-weighted borrow rate on each wholesale credit line, as APR and APY with their standard deviations, and the borrowed balance in USD used as the weight. Each series is one credit line token, keyed by protocol, chain, credit line and token. # Get Wholesale Credit Interest Rate timeseries Source: https://docs.blockworks.com/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-interest-rates-by-id api-reference/data-api/openapi.json GET /query/timeseries/wholesale-credit-interest-rates/{granularity}/{id} Balance-weighted borrow rate on each wholesale credit line, as APR and APY with their standard deviations, and the borrowed balance in USD used as the weight. Each series is one credit line token, keyed by protocol, chain, credit line and token. # Wholesale Credit Balances Source: https://docs.blockworks.com/api-reference/data-api/wholesale-credit/wholesale-credit-balances Balances of wholesale credit lines extended to institutional borrowers, in USD, with the cap, the remaining room under it and gross and net flows. Each series is one credit line balance, keyed by protocol, chain, credit line, token, balance type and balance subtype. One row per wholesale credit balance, keyed by protocol, chain, credit line, token, balance type and balance subtype: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the wholesale-credit-balances timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `wholesale-credit-balances`: primary key `id` | | Timeseries model | `wholesale-credit-balances`: intervals `1d`, series key `id` (Wholesale Credit Balance ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Wholesale Credit Balances](/api-reference/data-api/wholesale-credit/tabular-wholesale-credit-balances) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Wholesale Credit Balance timeseries](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-balances) > > Up to 10 series in one request, named by Wholesale Credit Balance ID in `series`. > [card] [Get Wholesale Credit Balance timeseries](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-balances-by-id) > > One series over a time window, keyed by its Wholesale Credit Balance ID. ## Metrics 7 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `balanceUSD` | Balance (USD) | float64 | | Balance in USD. | | `balanceCapUSD` | Balance Cap (USD) | float64 | | Balance cap in USD. | | `balanceCapMaxUSD` | Maximum Balance Cap (USD) | float64 | | Maximum balance cap in USD. | | `balanceCapGapUSD` | Balance Cap Gap (USD) | float64 | | Remaining room under the balance cap in USD. | | `grossInflowUSD` | Gross Inflow (USD) | float64 | | Gross inflow to the balance in USD. | | `grossOutflowUSD` | Gross Outflow (USD) | float64 | | Gross outflow from the balance in USD, stored as a negative number. | | `netFlowUSD` | Net Flow (USD) | float64 | | Net flow (inflow plus outflow) in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the wholesale-credit-balances timeseries model, the parent slug, chain, credit line id, token address, balance type and balance subtype, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the balance, the credit line name, token symbol and balance subtype (or type). | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol. | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain (ethereum, base, solana). | | `creditLineID` | string | `Eq`, `IsOneOf` | | The wholesale credit line's identifier. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `balanceType` | string | `Eq`, `IsOneOf` | | The balance type as classified by Blockworks Research. | | `balanceSubtype` | string | `Eq`, `IsOneOf` | | The finer balance classification; null where none is distinguished. | | `creditLineName` | string | `Eq`, `IsOneOf`, `Contains` | | The wholesale credit line's display name. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/wholesale-credit-balances/1d/?timeframe=7d&selections=balanceUSD,balanceCapUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Wholesale Credit Balance timeseries](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-balances-by-id) for the response and the errors. # Wholesale Credit Financials Source: https://docs.blockworks.com/api-reference/data-api/wholesale-credit/wholesale-credit-financials Interest paid and accrued by borrowers and credit losses on each wholesale credit line, in USD. Each series is one credit line token, keyed by protocol, chain, credit line, token and recognition basis (realized or accrued). One row per wholesale credit financial, keyed by protocol, chain, credit line, token and recognition basis: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the wholesale-credit-financials timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `wholesale-credit-financials`: primary key `id` | | Timeseries model | `wholesale-credit-financials`: intervals `1d`, series key `id` (Wholesale Credit Financial ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Wholesale Credit Financials](/api-reference/data-api/wholesale-credit/tabular-wholesale-credit-financials) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Wholesale Credit Financial timeseries](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-financials) > > Up to 10 series in one request, named by Wholesale Credit Financial ID in `series`. > [card] [Get Wholesale Credit Financial timeseries](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-financials-by-id) > > One series over a time window, keyed by its Wholesale Credit Financial ID. ## Metrics 3 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `grossInterestUSD` | Gross Interest (USD) | float64 | | Gross interest paid by the borrower in USD. | | `creditLossUSD` | Credit Loss (USD) | float64 | | Credit losses in USD. | | `grossInterestAccruedUSD` | Gross Interest Accrued (USD) | float64 | | Gross interest accrued in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the wholesale-credit-financials timeseries model, the parent slug, chain, credit line id, token address and recognition basis, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the credit line name, token symbol and recognition basis. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol. | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain (ethereum, base, solana). | | `creditLineID` | string | `Eq`, `IsOneOf` | | The wholesale credit line's identifier. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `recognitionBasis` | string | `Eq`, `IsOneOf` | | How the amount is recognized, for example realized or accrued. | | `creditLineName` | string | `Eq`, `IsOneOf`, `Contains` | | The wholesale credit line's display name. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/wholesale-credit-financials/1d/?timeframe=7d&selections=grossInterestUSD,creditLossUSD" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Wholesale Credit Financial timeseries](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-financials-by-id) for the response and the errors. # Wholesale Credit Interest Rates Source: https://docs.blockworks.com/api-reference/data-api/wholesale-credit/wholesale-credit-interest-rates Balance-weighted borrow rate on each wholesale credit line, as APR and APY with their standard deviations, and the borrowed balance in USD used as the weight. Each series is one credit line token, keyed by protocol, chain, credit line and token. One row per wholesale credit interest rate, keyed by protocol, chain, credit line and token: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the wholesale-credit-interest-rates timeseries model. | | | | - | - | | Access | Lending-protocols-dataset | | Tabular model | `wholesale-credit-interest-rates`: primary key `id` | | Timeseries model | `wholesale-credit-interest-rates`: intervals `1d`, series key `id` (Wholesale Credit Interest Rate ID), series must be named (up to 10 per call) | ## Endpoints > [card] [List Wholesale Credit Interest Rates](/api-reference/data-api/wholesale-credit/tabular-wholesale-credit-interest-rates) > > One page of rows with per-column filters, sorting and pagination. > [card] [Batch Get Wholesale Credit Interest Rate timeseries](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-interest-rates) > > Up to 10 series in one request, named by Wholesale Credit Interest Rate ID in `series`. > [card] [Get Wholesale Credit Interest Rate timeseries](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-interest-rates-by-id) > > One series over a time window, keyed by its Wholesale Credit Interest Rate ID. ## Metrics 5 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order. | Field | Name | Type | Unit | Description | | - | - | - | - | - | | `weightedBorrowAPR` | Weighted Borrow APR | float64 | | Balance-weighted borrow APR, as a decimal. | | `weightedBorrowAPY` | Weighted Borrow APY | float64 | | Balance-weighted borrow APY, as a decimal. | | `weightedBorrowAPRStdDev` | Weighted Borrow APR Standard Deviation | float64 | | Balance-weighted standard deviation of the borrow APR. | | `weightedBorrowAPYStdDev` | Weighted Borrow APY Standard Deviation | float64 | | Balance-weighted standard deviation of the borrow APY. | | `weightedBorrowUSD` | Weighted Borrow (USD) | float64 | | Borrow balance used as the rate weight in USD. | ## Columns Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes). | Field | Type | Filters | Sort | Description | | - | - | - | - | - | | `id` | string | `Eq`, `IsOneOf` | | The series key of the wholesale-credit-interest-rates timeseries model, the parent slug, chain, credit line id and token address, joined with underscores. (primary key) | | `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the credit line name and token symbol. | | `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. | | `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name. | | `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol. | | `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain (ethereum, base, solana). | | `creditLineID` | string | `Eq`, `IsOneOf` | | The wholesale credit line's identifier. | | `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. | | `creditLineName` | string | `Eq`, `IsOneOf`, `Contains` | | The wholesale credit line's display name. | | `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token's ticker symbol. | | `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. | | `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. | | `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. | | `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. | ## Example ```bash curl theme={null} curl "https://api.blockworks.com/query/timeseries/wholesale-credit-interest-rates/1d/?timeframe=7d&selections=weightedBorrowAPR,weightedBorrowAPY" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` See [Get Wholesale Credit Interest Rate timeseries](/api-reference/data-api/wholesale-credit/timeseries-wholesale-credit-interest-rates-by-id) for the response and the errors. # Submit Feedback Source: https://docs.blockworks.com/api-reference/feedback/submit api-reference/feedback/openapi.json POST /feedback Report a bug or gap you hit while using Blockworks data: an error, an empty or surprising result, missing data, unclear docs, or a workaround you had to invent. Send one request per distinct issue, after you have resolved it or given up, so the report can say what you tried and any workaround that worked. Agents connected to the [MCP server](/mcp/overview) send the same report with the [`submit_feedback`](/mcp/tools/feedback) tool; both land in the same place. A useful report carries: * **The exact request.** The URL with its query string, or the tool arguments, in `request`. * **What you expected** and what came back instead, in `message`. * **Request IDs.** Data API and Monitoring responses carry an `X-Request-ID` header, and MCP tool errors from the API include `(request ID ...)`. Quote the IDs of the responses involved; they are how Blockworks finds the request in its logs. Submissions are stored by Blockworks and attributed to the account behind your API key, so leave out personal or sensitive data. They are free and do not count against usage. Each user can send up to 60 an hour. ```bash theme={null} curl -X POST 'https://api.blockworks.com/feedback' \ --header "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: 3f1c2a9e-report-1' \ --data '{ "category": "data_quality", "message": "asset-marketcap returned no rows for bitcoin on 2026-10-18. Expected one row per day. Request ID 6047f3ac-edd5-4a29-adbb-f451dc1afe2d.", "endpoint": "GET /query/timeseries/asset-marketcap/1d", "request": "GET https://api.blockworks.com/query/timeseries/asset-marketcap/1d?series=bitcoin&start=2026-10-18&end=2026-10-18" }' ``` > [!NOTE] > > If a request times out or returns `503`, resend it with the same `Idempotency-Key`. Copies that share a key count > as one submission. # List Categories Source: https://docs.blockworks.com/api-reference/monitoring/get-v2-categories api-reference/monitoring/openapi.json GET /monitoring/v2/categories Retrieve the full intel taxonomy: top-level categories and their nested subcategories. # List Developments Source: https://docs.blockworks.com/api-reference/monitoring/get-v2-developments api-reference/monitoring/openapi.json GET /monitoring/v2/developments Paginated list of developments with filtering by asset, category, subcategory, importance, and time range. # Get Development Source: https://docs.blockworks.com/api-reference/monitoring/get-v2-developments-developmentId api-reference/monitoring/openapi.json GET /monitoring/v2/developments/{developmentId} Retrieve a single development by ID, including its taxonomy tags, resolved assets, and parent event reference. # List Events Source: https://docs.blockworks.com/api-reference/monitoring/get-v2-events api-reference/monitoring/openapi.json GET /monitoring/v2/events Paginated list of events. Events group related developments over time and share the developments filter surface. # Get Event Source: https://docs.blockworks.com/api-reference/monitoring/get-v2-events-eventId api-reference/monitoring/openapi.json GET /monitoring/v2/events/{eventId} Retrieve a single event by ID, along with the developments nested under it. # List Monitoring Views Source: https://docs.blockworks.com/api-reference/monitoring/get-v2-monitoring-views api-reference/monitoring/openapi.json GET /monitoring/v2/monitoring-views Paginated list of the monitoring views the caller can read, including personal and team-shared views. # All Matched Developments Source: https://docs.blockworks.com/api-reference/monitoring/get-v2-monitoring-views-all-developments api-reference/monitoring/openapi.json GET /monitoring/v2/monitoring-views/all/developments Deduplicated union of developments matching any monitoring view the caller can access. # All Matched Events Source: https://docs.blockworks.com/api-reference/monitoring/get-v2-monitoring-views-all-events api-reference/monitoring/openapi.json GET /monitoring/v2/monitoring-views/all/events Deduplicated union of events matching any monitoring view the caller can access. # Get Monitoring View Source: https://docs.blockworks.com/api-reference/monitoring/get-v2-monitoring-views-monitoringViewId api-reference/monitoring/openapi.json GET /monitoring/v2/monitoring-views/{monitoringViewId} Retrieve a monitoring view definition and its aggregate stats by UUID or slug-with-id-prefix. # Developments Matched by a View Source: https://docs.blockworks.com/api-reference/monitoring/get-v2-monitoring-views-monitoringViewId-developments api-reference/monitoring/openapi.json GET /monitoring/v2/monitoring-views/{monitoringViewId}/developments Paginated developments matching a saved monitoring view's predicates, with optional free-text search. # Events Matched by a View Source: https://docs.blockworks.com/api-reference/monitoring/get-v2-monitoring-views-monitoringViewId-events api-reference/monitoring/openapi.json GET /monitoring/v2/monitoring-views/{monitoringViewId}/events Paginated events matching a saved monitoring view's predicates, with optional free-text search. # Overview Source: https://docs.blockworks.com/api-reference/monitoring/overview Programmatic access to AI-surfaced, analyst-verified events across 1,000+ assets and 700+ sources. The Blockworks Monitoring API replaces keyword alerts and manual checks with agents that continuously read, evaluate, and escalate the events that matter. Every event is reviewed by an intel analyst before it reaches your pipeline, so you get speed and accuracy rather than a firehose. ## What you get * **Agentic coverage, not keyword rules.** Agents understand context, severity, and relevance. They distinguish a \$50M unlock from a blog post that mentions one. * **1,000+ assets, including long-tail.** Bitcoin through small-cap DeFi. Standardized coverage so you catch sector spillovers, not just the majors. * **700+ sources ingested continuously.** Onchain data, governance, filings, news, and social, all monitored in real time. * **Analyst-verified.** Agents flag developing signals instantly; analysts verify before anything is marked `verified: true`. * **Structured output.** Events, developments, a categorized taxonomy, and resolved assets, ready to feed dashboards, risk systems, on-call rotations, or custom workflows. ## Base URL and authentication All Monitoring endpoints live under `/monitoring/v2` on the shared Blockworks API host, `https://api.blockworks.com`, and every request requires an API key in the `X-Blockworks-API-Key` header. The [Quickstart](/api-reference/monitoring/quickstart) walks through getting a key and making a first request; [Authentication](/getting-started/authentication) covers access tiers and key handling. ## Core concepts > [card] Development > > The atomic unit of coverage: a single dated, verified occurrence. > [card] Event > > A logical grouping of related developments over time. > [card] Monitoring View > > A saved filter over the stream, either deterministic or prompt-based. **Development.** The atomic unit of coverage: a single dated, verified occurrence (for example, "Binance.US lists TRX"). Tagged with category, subcategory, importance, resolved assets (each marked `primary` or `secondary`), and a nested `event` reference pointing at the parent event. Every endpoint that returns developments uses the same shape. **Event.** A logical grouping of related developments over time, such as a multi-stage hack together with its subsequent disclosures, responses, and post-mortems. Carries its own `slug`, `createdAt` / `updatedAt`, and aggregate `developmentCount` / `documentCount`. **Monitoring View.** A saved filter over the stream. `simple` views are deterministic predicates (assets, categories, importance). `agentic` views are prompt-based; the prompt is stored on the view itself and matched items come back in the canonical Development shape. ## Summaries Developments and events both expose a `summary` field, but they behave differently: * **Development summaries.** For verified developments (`verified: true`), the summary is human-curated by the intel analyst team and reflects the most up-to-date information at the time of verification. Treat it as authoritative. * **Event summaries.** Rolled up across the event's child developments, so they update as new developments land. Expect some latency between a fresh development being added and the event-level summary catching up. If you need the latest narrative, read the most recent development under the event rather than the event summary. ## Filter semantics Most list endpoints share a filtering surface, and the failure modes are worth knowing before you build against them: * `assetIds` accepts UUIDs or slugs. Unresolved tokens are **silently dropped**; if none of the supplied tokens resolve, you get an empty page rather than an error. * `intelCategories`, `intelSubcategories`, `assetSectors`, `assetSubsectors`, and `assetEcosystemNetworkIds` are comma-separated and follow the same silent-drop rule. * `eventIds` is the exception: unresolvable tokens return `400`. * Results are ordered most-recent-first and paginated. > [!NOTE] > > Because unresolved filter tokens are dropped silently, an empty result set can mean either > "nothing matched" or "your filter tokens were invalid". Validate asset and taxonomy tokens > against [List Categories](/api-reference/monitoring/get-v2-categories) and the asset > endpoints when a query unexpectedly returns nothing. ## Use cases * **Risk and response.** Feed verified `security_and_hacks` developments for your portfolio assets straight into your on-call rotation. * **Portfolio intelligence.** Save a monitoring view scoped to the assets you hold, including long-tail, and pull `minimumImportance=medium` developments on a cron. * **Research automation.** Pull agentic views that surface developments matching a natural-language thesis, such as "stablecoin peg stress" or "L2 sequencer outages". * **Client-facing alerting.** Power customer-facing event timelines and notifications in your own product without running your own monitoring stack. * **Governance and ops dashboards.** Filter for `governance=true` developments across the assets your DAO or treasury cares about. ## Push delivery Monitoring views can push matched developments to an endpoint you control instead of, or in addition to, polling. See [Webhooks](/api-reference/monitoring/webhooks) for the payload format, HMAC signature verification, and retry behavior. # Quickstart Source: https://docs.blockworks.com/api-reference/monitoring/quickstart Get an API key, pull your first verified developments, and subscribe to the ones that matter. This page gets you a key and a first Monitoring response, then points you at push delivery. The key is the same one that authenticates every Blockworks product, so if you already have one you can skip the first step. **1. Get an API key** Create a key at [app.blockworks.com/account/api](https://app.blockworks.com/account/api). Keys are shown once at creation. Store yours in a secret manager or environment variable, and never commit it or send it from a browser. ```bash theme={null} export BLOCKWORKS_API_KEY="your-api-key" ``` **2. Pull the latest developments** All Monitoring endpoints live under `/monitoring/v2` on the shared Blockworks API host, and every one of them requires the `X-Blockworks-API-Key` header. Here we fetch the three most recent verified developments. ```bash curl theme={null} curl "https://api.blockworks.com/monitoring/v2/developments?limit=3&verified=true" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` ```python Python theme={null} import os import requests response = requests.get( "https://api.blockworks.com/monitoring/v2/developments", params={"limit": 3, "verified": "true"}, headers={"X-Blockworks-API-Key": os.environ["BLOCKWORKS_API_KEY"]}, timeout=30, ) response.raise_for_status() payload = response.json() for development in payload["data"]: assets = ", ".join(a["symbol"] for a in development["assets"]) print(development["importance"], assets, development["title"]) ``` ```javascript JavaScript theme={null} const url = new URL("https://api.blockworks.com/monitoring/v2/developments"); url.searchParams.set("limit", "3"); url.searchParams.set("verified", "true"); const response = await fetch(url, { headers: { "X-Blockworks-API-Key": process.env.BLOCKWORKS_API_KEY }, }); if (!response.ok) throw new Error(`Request failed: ${response.status}`); const { data } = await response.json(); for (const development of data) { const assets = development.assets.map((a) => a.symbol).join(", "); console.log(development.importance, assets, development.title); } ``` Narrow the stream with `assetIds` (UUIDs or slugs), `intelCategories`, `minimumImportance`, `start` and `end`, or free-text `search`. Every parameter is listed on [List Developments](/api-reference/monitoring/get-v2-developments). **3. Read the response** Monitoring responses use the same envelope as every Blockworks API: `error` is `null` on success and a string on failure, `data` carries the payload, and list endpoints add a `metadata` object with paging totals. Each item is a **development**, the atomic unit of coverage: one dated, verified occurrence, tagged with its taxonomy, importance, resolved assets, and the parent **event** it belongs to. ```json Response (trimmed to one development and its key fields) theme={null} { "error": null, "data": [ { "id": "3c8ad9eb-6ab8-4233-a06d-5c0c09e9506c", "title": "BTC e-mode Deprecation on SparkLend", "summary": "Phoenix Labs has shared a notice advising SparkLend users borrowing cbBTC through BTC e-mode to close their positions before Jun. 7, 2026 to avoid potential liquidations.", "verified": true, "intelCategories": ["protocol_management"], "intelSubcategories": ["discontinuation"], "importance": "low", "actionable": false, "governance": false, "startedAt": "2026-04-20T18:03:26Z", "assets": [ { "name": "Coinbase Wrapped BTC", "slug": "coinbase-wrapped-btc", "symbol": "CBBTC", "class": "primary" }, { "name": "Spark", "slug": "spark-sky-protocol", "symbol": "SPK", "class": "primary" } ], "event": { "slug": "btc-e-mode-deprecation-on-sparklend-cf1d1d", "title": "BTC e-mode Deprecation on SparkLend", "developmentCount": 1 } } ], "metadata": { "limit": 3, "page": 1, "totalRows": 83302, "totalPages": 27768 } } ``` > [!NOTE] > > Unresolved filter tokens are dropped silently, so an empty `data` array can mean > "nothing matched" or "that asset slug does not exist". See > [Filter semantics](/api-reference/monitoring/overview#filter-semantics). **4. Subscribe instead of polling** A **monitoring view** is a saved filter over the stream. Create one in the [Intel app](https://app.blockworks.com), then either poll it or have matches pushed to you: > [card] [Poll a view](/api-reference/monitoring/get-v2-monitoring-views-monitoringViewId-developments) > > Page through the developments a saved view has matched. > [card] [Webhooks](/api-reference/monitoring/webhooks) > > Receive matches as signed HTTP POSTs, with HMAC verification and retries. Access tiers, the legacy header, and key handling are covered in [Authentication](/getting-started/authentication). # Telegram Alerts Source: https://docs.blockworks.com/api-reference/monitoring/telegram Deliver monitoring alerts into a Telegram direct message or group chat: connecting the bot, connection states, and troubleshooting. Telegram alerts deliver matched developments straight into a Telegram chat, with no email, Slack, or webhook infrastructure to run. Alerts can be sent two ways: * **Direct Message.** The Blockworks alert bot messages you directly. * **Group.** The Blockworks alert bot posts into a Telegram group you choose, so a whole team sees each alert. Connecting Telegram is a one-time setup per monitoring view. You pick a destination, open a single-use link that hands off to Telegram, complete a short confirmation there, then verify the connection back in the app. > [!NOTE] > > Each Telegram connection is tied to a single monitoring view. To send alerts from several views > into the same chat, connect each view to that chat individually. > [!WARNING] > > Group size is limited. Only groups smaller than **10** members can receive alerts. ## Connecting Telegram Telegram delivery is configured in the [Intel app](https://app.blockworks.com), not through the API: when you create or edit a monitoring view, the **Alerts & Access** step is where you enable Telegram, alongside email, Slack, and [webhook](/api-reference/monitoring/webhooks) delivery. The **Real-Time / Daily / Weekly** control at the top of **Alert Delivery** sets how often alerts are sent. **1. Turn on the Telegram toggle** On the view's **Alerts & Access** step, switch the **Telegram** toggle on. A **Select Connection Type** row appears with two buttons: **Group** and **Direct Message**. ![Telegram toggle enabled showing the Group and Direct Message buttons](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/monitoring/telegram-toggle-on.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=138d12063d35b9e8709c8cc1628dbef9) **2. Choose Group or Direct Message** Pick where alerts should go. The choice generates a one-time Telegram deep link unique to this view and reveals a **Click to Connect Telegram** button. ![Select Connection Type buttons with the Click to Connect Telegram button](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/monitoring/telegram-select-connection-type.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=c2321a060bd739ecc1f664a2cd46d744) > [!NOTE] > > The deep link is single-use and expires after a short window. If you do not finish the > connection in time, the status shows an error; select **Cancel** and start over to generate a > fresh link. **3. Open the link in Telegram** Select **Click to Connect Telegram**. A popup opens Telegram, using the desktop or mobile app if it is installed and Telegram Web otherwise, with the Blockworks alert bot (`@messari_alert_bot`) ready to be messaged directly or added to a group. ![Telegram deep link popup opening the Blockworks alert bot](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/monitoring/deep-link.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=ea72bab0987fd34ffb2453e29c563d7b) **4. Complete setup inside Telegram** What you do next depends on the destination you picked. > [tab] Direct Message > > The bot chat opens with a **START BOT** button. Select it (this sends `/start`) and the bot > replies to confirm the chat is connected. > > ![Telegram direct message with the alert bot confirming the chat is connected](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/monitoring/dm-start.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=6269831d4d2473995ff16dab078a777e) > [tab] Group > > Telegram opens an **Add to Group** picker. Search for your group and select it. > > ![Telegram Add to Group dialog selecting a group to add the alert bot to](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/monitoring/add-to-group.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=39da8c00a7c5040c42a25277207cba80) > > On the **Add Bot** screen that follows, leave **Admin Rights** switched on and select > **Add Bot as Admin**. > > ![Telegram Add Bot dialog with Admin Rights enabled and the Add Bot as Admin button](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/monitoring/add-as-admin.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=cd1b16bdeff0458c1d97710404950e13) > > The bot posts in the group once it joins. If it still needs admin rights, its message spells > out how to grant them: open the group's settings, tap **Administrators** then **Add Admin**, > select the bot, and enable **Post Messages**. > > ![Telegram group chat with the alert bot asking for the Post Messages permission](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/monitoring/group-admin-connected.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=775f5c25529855219fddf58c71f15af4) > > > [!WARNING] > > > > Admin rights with the **Post Messages** permission are required for groups. A bot that > > joins as a regular member stays pending and cannot deliver alerts. **5. Verify the connection** Back in the app, select **Check Connection**. The status line reports where things stand, so use it to tell whether Telegram is fully wired up or still waiting on a step. ![Connection status line showing a waiting state with the Check Connection and Cancel actions](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/monitoring/waiting.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=a5807d9c31b8e8122bfcbf6bc33a4427) Confirmation from Telegram can take a moment to register, so if the status has not moved, wait a couple of seconds and select **Check Connection** again. See [Connection status](#connection-status) for what each state means. ![Connection status line showing the connected state after verifying](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/monitoring/connected.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=68a460c4bcdd580d29e2b647e62fce17) **6. Save the view** Once the status reads **Connected**, save the monitoring view. Telegram delivery is now active, and matching alerts for this view go to the chat you connected. ## Connection status | Status | What it means | | - | - | | `Waiting for the bot to be added...` | Direct Message chosen, but the chat with the bot has not been started yet. | | `Waiting for group Admin rights...` | Group chosen and the bot was added, but it has not been granted Admin rights. | | `Waiting for the bot to be added and granted Admin rights...` | Group chosen, but nothing has been done in Telegram yet. | | `Connected · Direct Message - ` | Alerts will be sent to you as a direct message. | | `Connected · Group - ` | Alerts will be posted to the named group. | While a connection is pending, the app also prompts you to select **Check Connection** when you are done on the Telegram side. Nothing is delivered until the status reads **Connected**. ## Managing an existing connection **Cancel before connecting.** At any point before the connection completes, select **Cancel** to back out and choose a different destination, for example switching from Direct Message to a Group. Cancelling discards the pending deep link. **Rebinding a connected view.** Opening a view that is already connected shows a read-only **Connected** row with the current destination and a **Start over** option. Choosing **Start over** rebinds the view to a different chat. The existing connection keeps delivering until the new one succeeds, so no alerts are missed during the switch. ![Connected row with a Start over option to rebind the view to a different chat](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/monitoring/start-over.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=4d948383f10704ce7454411c421a8c7c) > [!NOTE] > > **Start over** replaces the destination for this view only. Other views connected to the same chat > are unaffected. ## Troubleshooting > [accordion] The status shows an error, or the link no longer works > > The deep link is single-use and valid for a limited time. Select **Cancel**, pick the destination > again, and use the fresh **Click to Connect Telegram** link right away. > [accordion] The bot is in the group but the status stays pending > > The bot joined as a regular member. Open the group's settings, tap **Administrators** then > **Add Admin**, select the bot, enable **Post Messages**, and select **Check Connection** again. > [accordion] The status does not update after finishing in Telegram > > Confirmation can take a few seconds to propagate. Wait, then select **Check Connection** again. > The status only advances when the app can see the completed handoff. > [accordion] Alerts are not arriving in a group > > Check the group size. Only groups smaller than 10 members can receive alerts. Also confirm the > view was saved after the status read **Connected**: the connection is not persisted until the > view is saved. > [accordion] A second view needs to alert the same chat > > Connections are per view. Open the other monitoring view and run the same setup against the same > chat. Connecting a second view does not disturb the first. # Create Watchlist Source: https://docs.blockworks.com/api-reference/monitoring/watchlists/create api-reference/monitoring/watchlists-openapi.json POST /user-management/v1/watchlists Creates a new watchlist from a title and a list of asset UUIDs. # Delete Watchlist Source: https://docs.blockworks.com/api-reference/monitoring/watchlists/delete api-reference/monitoring/watchlists-openapi.json DELETE /user-management/v1/watchlists/{id} Permanently deletes a watchlist by ID. The deletion cannot be undone. # Get Watchlist Details Source: https://docs.blockworks.com/api-reference/monitoring/watchlists/get api-reference/monitoring/watchlists-openapi.json GET /user-management/v1/watchlists/{id} Returns the full details of a single watchlist by ID, including its metadata and every asset ID it contains. # Get Watchlists Source: https://docs.blockworks.com/api-reference/monitoring/watchlists/list api-reference/monitoring/watchlists-openapi.json GET /user-management/v1/watchlists Returns every watchlist available to the authenticated account, each with its metadata and the asset IDs it contains. # Watchlists API Source: https://docs.blockworks.com/api-reference/monitoring/watchlists/overview Create and manage named sets of assets tied to your account, then reuse them to scope queries across the Blockworks API. A watchlist is a named set of assets tied to your account. Group the assets you actually care about once, then reuse that grouping to drive dashboards, alerts, portfolio views, or any client that needs a stable list of assets rather than an ad hoc query. Watchlists are the read/write exception in an otherwise read-only surface. Everything else on the Blockworks API answers questions about the market; these endpoints let you create, update, and delete state that belongs to your account. ## Base URL and authentication Watchlist endpoints live under `/user-management/v1` on the shared Blockworks API host: ``` https://api.blockworks.com/user-management/v1/watchlists ``` Every request requires an API key in the `X-Blockworks-API-Key` header. See [Authentication](/getting-started/authentication) for details and for where to get a key. ```bash theme={null} curl "https://api.blockworks.com/user-management/v1/watchlists" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` Responses use the standard envelope: ```json theme={null} { "error": null, "data": { } } ``` ## Shape of a watchlist Each watchlist carries an `id`, a `title`, the `assetIds` it contains, and `createdAt` / `updatedAt` timestamps. Assets are referenced by UUID, not by slug or symbol, so resolve the identifiers you need from [Asset Entities](/api-reference/data-api/assets/tabular-assets) before writing. ```json theme={null} { "id": "8C25A83A", "title": "Layer 1 Protocols", "assetIds": [ "1e31218a-e44e-4285-820c-8282ee222035", "21c795f5-1bfd-40c3-858e-e9d7e820c6d0" ], "createdAt": "2024-07-12T18:22:38.311119Z", "updatedAt": "2025-12-11T19:14:00.915569Z" } ``` ## Two ways to change assets There are two write paths for the asset list, and picking the wrong one is the easiest mistake to make: * [Update Watchlist](/api-reference/monitoring/watchlists/update) replaces the whole `assetIds` array when you send one. Omit the field to leave assets untouched; send an empty array to clear them. * [Update Watchlist Assets](/api-reference/monitoring/watchlists/update-assets) adds or removes specific assets and leaves the rest of the list alone. ## Use cases * Track a portfolio or mandate as a named list instead of hardcoding asset IDs in your client. * Let your users build their own asset groupings and sync them across your surfaces. * Organize assets by sector, theme, or coverage responsibility, then scope reports to a list. * Keep a stable set of assets to poll on a schedule as coverage changes. # Update Watchlist Source: https://docs.blockworks.com/api-reference/monitoring/watchlists/update api-reference/monitoring/watchlists-openapi.json PATCH /user-management/v1/watchlists/{id} Updates a watchlist's title, and optionally replaces its entire asset list. # Update Watchlist Assets Source: https://docs.blockworks.com/api-reference/monitoring/watchlists/update-assets api-reference/monitoring/watchlists-openapi.json PATCH /user-management/v1/watchlists/{id}/assets Adds or removes specific assets in a watchlist without replacing the full asset list. # Webhooks Source: https://docs.blockworks.com/api-reference/monitoring/webhooks Receive monitoring alerts as signed HTTP POST requests: payload format, signature verification, and retry behavior. Webhooks deliver monitoring alerts as HTTP `POST` requests to an endpoint you control, instead of (or in addition to) email or Slack. This makes it easy to pipe alerts into a custom dashboard, trigger downstream automation, or store them in your own database. When a development matches one of your monitoring views, the matched event is serialized as JSON and POSTed to your configured URL. Each request can be signed with an HMAC signature so you can verify its authenticity. ## Setting up a webhook Webhooks are configured in the [Intel app](https://app.blockworks.com), not through the API: when you create or edit a monitoring view, its alert settings are where you enable webhook delivery and set the URL and secret. Webhook delivery is enabled per monitoring view by creating or updating an alert policy with a `webhook_url`. Optionally include a `webhook_secret` to enable HMAC signature verification. * `webhook_url` (required when `delivery_types` contains `webhook`): the HTTP(S) endpoint to POST to. * `webhook_secret` (optional): a shared secret used to compute the HMAC signature. Set one so your endpoint can verify request authenticity. If omitted, the `X-Webhook-Signature` header is not included. > [!NOTE] > > Webhooks are only delivered for the `immediately` cadence. A policy with `daily` or `weekly` > cadence will not dispatch to webhook endpoints even if `webhook` is listed in > `delivery_types` and a `webhook_url` is set. ## Request format Each webhook is delivered as an HTTP `POST` with the following headers: | Header | Value | | - | - | | `Content-Type` | `application/json` | | `User-Agent` | `MessariCNS/1.0` | | `X-Webhook-Signature` | HMAC signature (only present when `webhook_secret` is set). See [Verifying signatures](#verifying-signatures) | The request body is a JSON envelope. Optional fields that aren't set are **omitted entirely** from the JSON rather than sent as `null`. The example below shows a fully populated payload: ```json theme={null} { "id": "918be734-813f-4c00-91df-9bb5664a5120", "type": "monitoring_event", "timestamp": "2026-04-10T11:29:06.987283Z", "data": { "view": { "id": "f4fbb8a3-aa3f-4be3-9130-01a023f40b1e", "name": "Bitcoin Core Releases" }, "event": { "id": "07aeb98e-b5cb-4756-ba18-44b6c0fd2f7f", "title": "Bitcoin Core 31.0 RC Release Testing" }, "assets": [ { "id": "1e31218a-e44e-4285-820c-8282ee222035", "name": "Bitcoin", "logo_url": "https://assets.example.com/bitcoin.png" } ], "latest_development": { "id": "456001d9-ae84-4371-b99e-36d050e96a53", "title": "Bitcoin Core Release Candidate Version 31.0rc1 Testing Available", "summary": "A new release candidate of Bitcoin Core, version 31.0rc1, is now available for testing...", "category": ["launches_and_releases"], "subcategory": ["software_release"], "importance": "medium", "actionable": false, "created_at": "2026-03-17T16:10:25Z", "started_at": "2026-03-17T16:10:25Z", "ended_at": "2026-03-17T16:10:25Z" } } } ``` ### Envelope fields | Field | Type | Description | | - | - | - | | `id` | string (UUID) | Delivery event ID. The same `id` is reused across retries of a single delivery and across deliveries of the same event to multiple policies. Use it as an idempotency key. | | `type` | string | The payload type. For monitoring alerts this is always `monitoring_event`. | | `timestamp` | string (RFC 3339) | When the event was created. | | `data` | object | The event payload. See below. | ### Data fields | Field | Type | Required | Description | | - | - | - | - | | `view` | object | yes | The monitoring view that matched (`id`, `name`). | | `event` | object | yes | The event the development belongs to (`id`, `title`). | | `assets` | array | optional | Assets extracted from the development (`id`, `name`, `logo_url`). Omitted when empty. | | `latest_development` | object | yes | The development that triggered the alert. See fields below. | #### `latest_development` fields | Field | Type | Required | Description | | - | - | - | - | | `id` | string (UUID) | yes | Development ID. | | `title` | string | yes | Development title. | | `summary` | string | yes | Development summary (Markdown). | | `category` | array of string | optional | Category taxonomy tags. Omitted when empty. | | `subcategory` | array of string | optional | Subcategory taxonomy tags. Omitted when empty. | | `importance` | string | optional | One of `low`, `medium`, `high`. Omitted when the development hasn't been classified. | | `actionable` | bool | yes | Whether the development is marked actionable. Always present. | | `created_at` | string (RFC 3339) | yes | When the development started. Same value as `started_at`, included for compatibility. | | `started_at` | string (RFC 3339) | yes | When the development started. | | `ended_at` | string (RFC 3339) | optional | When the development ended. Omitted for ongoing developments. | ## Verifying signatures When you provide a `webhook_secret`, every delivery includes an `X-Webhook-Signature` header. Verify it on every incoming request to confirm the webhook is authentic and untampered. ### Header format ``` X-Webhook-Signature: t=,v1= ``` * `t`: the Unix timestamp (seconds) at which the signature was generated * `v1`: the HMAC-SHA256 signature as a hex string ### Computing the expected signature The signed payload is the concatenation of the timestamp, a literal `.`, and the raw request body: ``` signed_payload = "{timestamp}.{raw_body}" expected_sig = HMAC_SHA256(webhook_secret, signed_payload) ``` Compare your computed `expected_sig` against the `v1` value from the header using a constant-time comparison. If they match, the request is authentic. ### Rejecting stale signatures A valid HMAC alone is not enough. Without a freshness check, an attacker who captures a legitimate webhook could replay it indefinitely. Reject any request whose `t` timestamp is more than a small tolerance away from your server's current time. A tolerance of **5 minutes** comfortably covers network delay, clock skew, and the retry window described in [Retries](#retries). The helpers below combine both checks: they parse the header defensively (returning `false` on any missing or malformed component), enforce the timestamp tolerance, and then compare the HMAC in constant time. ```javascript Node.js theme={null} const crypto = require("crypto"); const SIGNATURE_TOLERANCE_SECONDS = 5 * 60; function verifyWebhookSignature(rawBody, header, secret) { if (!header) return false; const parts = {}; for (const part of header.split(",")) { const [k, v] = part.split("="); if (k && v) parts[k.trim()] = v.trim(); } const timestamp = parts.t; const provided = parts.v1; if (!timestamp || !provided || !/^[a-f0-9]{64}$/i.test(provided)) { return false; } const age = Math.abs(Math.floor(Date.now() / 1000) - Number(timestamp)); if (!Number.isFinite(age) || age > SIGNATURE_TOLERANCE_SECONDS) { return false; } const signedPayload = `${timestamp}.${rawBody}`; const expected = crypto .createHmac("sha256", secret) .update(signedPayload) .digest("hex"); return crypto.timingSafeEqual( Buffer.from(expected, "hex"), Buffer.from(provided, "hex"), ); } ``` ```python Python theme={null} import hmac import hashlib import re import time SIGNATURE_TOLERANCE_SECONDS = 5 * 60 _HEX64 = re.compile(r"^[a-f0-9]{64}$", re.IGNORECASE) def verify_webhook_signature(raw_body: bytes, header: str, secret: str) -> bool: if not header: return False parts = {} for part in header.split(","): key, _, value = part.partition("=") if key and value: parts[key.strip()] = value.strip() timestamp = parts.get("t") provided = parts.get("v1") if not timestamp or not provided or not _HEX64.match(provided): return False try: age = abs(int(time.time()) - int(timestamp)) except ValueError: return False if age > SIGNATURE_TOLERANCE_SECONDS: return False signed_payload = f"{timestamp}.".encode() + raw_body expected = hmac.new( secret.encode(), signed_payload, hashlib.sha256, ).hexdigest() return hmac.compare_digest(expected, provided) ``` > [!TIP] > > Always verify against the **raw** request body bytes. If your framework re-serializes the > JSON before you receive it, the bytes will not match what was signed and verification will > fail. ## Responding to webhooks Your endpoint should return an HTTP `2xx` status code to acknowledge successful receipt. The HTTP client has a **30-second** transport timeout, and each delivery attempt has a **1-minute** overall timeout. Slow or non-`2xx` responses may trigger retries. | Status code | Treated as | | - | - | | `2xx` | Success | | `429` | Retryable (rate limit) | | `4xx` (other) | Non-retryable failure | | `5xx` | Retryable failure | | network error / timeout | Retryable failure | Return `200 OK` quickly after durably queuing the alert for processing on your side, rather than doing heavy work synchronously. ## Retries When a delivery fails with a retryable status code, network error, or timeout, it is automatically retried with exponential backoff: * **Maximum attempts**: 5 * **Initial interval**: 1 second * **Backoff coefficient**: 2x * **Maximum interval**: 5 minutes Non-retryable `4xx` responses (excluding `429`) are not retried. If your endpoint returns `400 Bad Request`, the delivery is permanently marked as failed. ## Best practices * **Always set a `webhook_secret`** and verify the `X-Webhook-Signature` header on every request, including the timestamp freshness check that prevents replay attacks. * **Use HTTPS** for your webhook URL. Plain HTTP endpoints are accepted but strongly discouraged. * **Make your handler idempotent.** Retries reuse the same envelope `id`; use it as an idempotency key to avoid double-processing the same event. * **Respond quickly.** Return `2xx` as soon as you have durably queued the event; do downstream processing asynchronously. * **Treat the body as authoritative.** Do not trust query strings or other unsigned inputs. ## Example: creating tickets in Linear This walkthrough builds a webhook handler that receives a monitoring alert, verifies its signature, acknowledges receipt, and creates a Linear issue in the background. The same scaffolding works for any downstream destination: swap the Linear call for Slack, an on-call tool, an internal API, or a queue. The handler does five things in order: **1. Capture the raw body** Signatures are computed over raw bytes, not re-serialized JSON. **2. Verify the signature** Check the `X-Webhook-Signature` header before doing anything else. **3. Acknowledge immediately** Return `200 OK` so the sender isn't waiting on Linear's response. **4. Hand off to a background worker** Process the envelope asynchronously. **5. Map and post** Translate the alert into a Linear `issueCreate` mutation. ### The server Instead of running a server, you can also use no-code tools such as [Zapier](https://zapier.com/) or [n8n](https://n8n.io/) to receive and transform these requests. ```javascript Node.js (Express) theme={null} const express = require("express"); const app = express(); const SECRET = process.env.MONITORING_WEBHOOK_SECRET; // Capture the raw body so signature verification matches exactly what was signed app.post( "/webhooks/monitoring", express.raw({ type: "application/json" }), (req, res) => { const signature = req.header("X-Webhook-Signature") ?? ""; if (!verifyWebhookSignature(req.body, signature, SECRET)) { return res.status(401).send("invalid signature"); } const envelope = JSON.parse(req.body.toString("utf8")); // Ack immediately, then process in the background res.status(200).send("ok"); setImmediate(() => forwardToLinear(envelope).catch(console.error)); } ); app.listen(3000); ``` ```python Python (Flask) theme={null} import os import threading from flask import Flask, request app = Flask(__name__) SECRET = os.environ["MONITORING_WEBHOOK_SECRET"] @app.post("/webhooks/monitoring") def handle(): raw_body = request.get_data() # raw bytes, not request.json signature = request.headers.get("X-Webhook-Signature", "") if not verify_webhook_signature(raw_body, signature, SECRET): return "invalid signature", 401 envelope = request.get_json() # Ack immediately, then process in the background threading.Thread( target=forward_to_linear, args=(envelope,), daemon=True ).start() return "ok", 200 ``` `verifyWebhookSignature` and `verify_webhook_signature` are the helpers from [Verifying signatures](#verifying-signatures) above. ### Transforming and posting to Linear Linear exposes a [GraphQL API](https://linear.app/developers/graphql#creating-and-editing-issues); new issues are created with the `issueCreate` mutation. The transform takes a `monitoring_event` envelope and produces an `IssueCreateInput`, mapping the development title to the issue title, building a Markdown description from the view, asset list, and development summary, and translating `importance` to Linear's priority enum. Two pieces of config are needed: a Linear API key for the `Authorization` header, and the target team ID. ```javascript Node.js theme={null} const LINEAR_API_KEY = process.env.LINEAR_API_KEY; const LINEAR_TEAM_ID = process.env.LINEAR_TEAM_ID; // Linear priority enum: 0 none, 1 urgent, 2 high, 3 medium, 4 low const PRIORITY = { high: 2, medium: 3, low: 4 }; async function forwardToLinear(envelope) { if (envelope.type !== "monitoring_event") return; const { view, latest_development: dev, assets = [] } = envelope.data; const assetList = assets.map((a) => a.name).join(", ") || "none"; const input = { teamId: LINEAR_TEAM_ID, title: `[${view.name}] ${dev.title}`, description: [ `**View:** ${view.name}`, `**Assets:** ${assetList}`, `**Detected:** ${dev.created_at}`, "", dev.summary, ].join("\n"), priority: PRIORITY[dev.importance] ?? 0, }; const res = await fetch("https://api.linear.app/graphql", { method: "POST", headers: { "Content-Type": "application/json", Authorization: LINEAR_API_KEY, }, body: JSON.stringify({ query: `mutation($input: IssueCreateInput!) { issueCreate(input: $input) { success issue { identifier url } } }`, variables: { input }, }), }); if (!res.ok) throw new Error(`Linear ${res.status}: ${await res.text()}`); } ``` ```python Python theme={null} import os import requests LINEAR_API_KEY = os.environ["LINEAR_API_KEY"] LINEAR_TEAM_ID = os.environ["LINEAR_TEAM_ID"] # Linear priority enum: 0 none, 1 urgent, 2 high, 3 medium, 4 low PRIORITY = {"high": 2, "medium": 3, "low": 4} def forward_to_linear(envelope): if envelope.get("type") != "monitoring_event": return data = envelope["data"] view = data["view"] dev = data["latest_development"] assets = data.get("assets", []) asset_list = ", ".join(a["name"] for a in assets) or "none" description = "\n".join([ f"**View:** {view['name']}", f"**Assets:** {asset_list}", f"**Detected:** {dev['created_at']}", "", dev["summary"], ]) input_ = { "teamId": LINEAR_TEAM_ID, "title": f"[{view['name']}] {dev['title']}", "description": description, "priority": PRIORITY.get(dev.get("importance"), 0), } res = requests.post( "https://api.linear.app/graphql", headers={ "Content-Type": "application/json", "Authorization": LINEAR_API_KEY, }, json={ "query": """ mutation($input: IssueCreateInput!) { issueCreate(input: $input) { success issue { identifier url } } } """, "variables": {"input": input_}, }, timeout=10, ) res.raise_for_status() ``` > [!NOTE] > > Linear personal API keys are passed directly in the `Authorization` header (no `Bearer ` > prefix). OAuth access tokens use `Authorization: Bearer `. > [!TIP] > > Because failed deliveries are retried, the same envelope can arrive more than once. To avoid > duplicate Linear issues, dedupe on `envelope.id`: store seen IDs in a short-TTL cache, or > include the ID in the issue description and search before creating. # Get Allocations Source: https://docs.blockworks.com/api-reference/token-unlocks/get-v1-allocations api-reference/token-unlocks/openapi.json GET /token-unlocks/v1/allocations Allocation totals for an asset, broken down by recipient, with the analyst notes and citations behind each tranche. # List Covered Assets Source: https://docs.blockworks.com/api-reference/token-unlocks/get-v1-assets api-reference/token-unlocks/openapi.json GET /token-unlocks/v1/assets Every asset with token unlock coverage, filterable by category, sector, tags, or asset UUID. # Get Unlock Events Source: https://docs.blockworks.com/api-reference/token-unlocks/get-v1-assets-assetId-events api-reference/token-unlocks/openapi.json GET /token-unlocks/v1/assets/{assetId}/events The dated points where an asset's unlock schedule changes: cliffs and linear rate changes, past and projected. # Get Unlocks Timeseries Source: https://docs.blockworks.com/api-reference/token-unlocks/get-v1-assets-assetId-unlocks api-reference/token-unlocks/openapi.json GET /token-unlocks/v1/assets/{assetId}/unlocks Tokens unlocked per interval, in total and per recipient. The flow view of a vesting schedule. # Get Vesting Schedule Source: https://docs.blockworks.com/api-reference/token-unlocks/get-v1-assets-assetId-vesting-schedule api-reference/token-unlocks/openapi.json GET /token-unlocks/v1/assets/{assetId}/vesting-schedule Daily cumulative unlock state: how much has vested, how much remains, and what share of the allocation is complete. # Overview Source: https://docs.blockworks.com/api-reference/token-unlocks/overview Analyst-modeled token unlock schedules: who holds what, when it vests, and how much supply lands in any given week. The Blockworks Token Unlocks API exposes the vesting schedules behind circulating supply. Every covered asset is modeled by hand from the project's own disclosures: the allocation is split into recipient buckets (team, investors, foundation, community), each bucket is given a release schedule, and each tranche carries the analyst's description, assumptions, and sources. You get the schedule as data rather than as a chart. ## What you get * **Allocation breakdowns, with citations.** Every tranche records what the recipient was allocated, how much has unlocked, and the sources the model was built from, so a number can be traced back to a filing or a disclosure. * **Cliffs and linear vesting, separated.** Unlock events distinguish a discrete tranche landing on a date from a change in the daily vesting rate, so "the next big unlock" is a query rather than an eyeball estimate. * **Flow and stock, as two series.** Per-interval unlock amounts for supply pressure, and daily cumulative vesting state for progress against the full allocation. * **Projected forward.** Schedules run past today. Future dated windows are valid on every timeseries endpoint. * **Joins to the rest of the platform.** Assets carry the same UUIDs and slugs as the Data API and Monitoring, so unlock data lines up with price, supply, and events without a mapping table. ## Base URL and authentication All Token Unlocks endpoints live under `/token-unlocks/v1` on the shared Blockworks API host, `https://api.blockworks.com`, and every request requires an API key in the `X-Blockworks-API-Key` header. The [Examples](#examples) below make a first request; [Authentication](/getting-started/authentication) covers access tiers and key handling. ## Core concepts > [card] Allocation > > A recipient bucket and its share of total supply. > [card] Unlock event > > A dated cliff, or a change in the daily vesting rate. > [card] Snapshot > > One point in a series, either per interval or per day. **Allocation.** A named recipient bucket (`Team`, `Community Reserve`, `Coinlist Auction Sale`) with a total allocation, the amount unlocked to date, and the amount still locked, in both native units and USD. Each tranche also carries a `description`, the `assumptions` the analyst applied, and `sources`. The recipient name is the join key across every Token Unlocks endpoint. **Unlock event.** A date on which the schedule changes. A `cliff` releases a discrete tranche on that date. A `dailyLinearRateChange` changes how much vests per day from that date forward. An event carries one or the other, and the other field is `null`. Filter with `unlockType` to get just one kind. **Snapshot.** A point in one of the two timeseries. Unlock snapshots are **flow**: each one reports what unlocked during that interval and nothing before it. Vesting schedule snapshots are **stock**: each one reports cumulative unlocked, remaining, and percent complete as of that day. Both come in a total series plus a per-recipient breakdown that sums to it. ## Choosing an endpoint | You want | Endpoint | | - | - | | The list of assets with unlock coverage | [List Covered Assets](/api-reference/token-unlocks/get-v1-assets) | | Who holds what, and how much has unlocked | [Get Allocations](/api-reference/token-unlocks/get-v1-allocations) | | The next cliff, or every dated schedule change | [Get Unlock Events](/api-reference/token-unlocks/get-v1-assets-assetId-events) | | Supply hitting the market per week or month | [Get Unlocks Timeseries](/api-reference/token-unlocks/get-v1-assets-assetId-unlocks) | | Percent vested over time, per recipient | [Get Vesting Schedule](/api-reference/token-unlocks/get-v1-assets-assetId-vesting-schedule) | The two timeseries answer different questions from the same underlying model. If you are sizing sell pressure in a window, use the unlocks timeseries. If you are tracking how far through its schedule an allocation is, use the vesting schedule. ## Examples Every example reads the key from `BLOCKWORKS_API_KEY`. If you do not have one yet, the [Data API quickstart](/getting-started/quickstart) covers creating and storing it. ### Find an asset with coverage Start with the list of covered assets, narrowed to a category. The examples sort before printing because the result set is unordered, and they fall back to an empty list because an empty result is `"data": null` (see [Coverage and filtering](#coverage-and-filtering)). ```bash curl theme={null} curl "https://api.blockworks.com/token-unlocks/v1/assets?category=Networks" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` ```python Python theme={null} import os import requests response = requests.get( "https://api.blockworks.com/token-unlocks/v1/assets", params={"category": "Networks"}, headers={"X-Blockworks-API-Key": os.environ["BLOCKWORKS_API_KEY"]}, timeout=30, ) response.raise_for_status() assets = response.json()["data"] or [] for asset in sorted(assets, key=lambda a: a["symbol"]): print(asset["symbol"], asset["slug"], asset["projectedEndDate"]) ``` ```javascript JavaScript theme={null} const url = new URL("https://api.blockworks.com/token-unlocks/v1/assets"); url.searchParams.set("category", "Networks"); const response = await fetch(url, { headers: { "X-Blockworks-API-Key": process.env.BLOCKWORKS_API_KEY }, }); if (!response.ok) throw new Error(`Request failed: ${response.status}`); const { data } = await response.json(); for (const asset of (data ?? []).sort((a, b) => a.symbol.localeCompare(b.symbol))) { console.log(asset.symbol, asset.slug, asset.projectedEndDate); } ``` ### Find the next cliff Unlock events are the dated points where a schedule changes. Filter to `CLIFF` and a forward window to get the discrete releases ahead. ```bash curl theme={null} curl "https://api.blockworks.com/token-unlocks/v1/assets/solana/events?unlockType=CLIFF&startTime=2026-01-01T00:00:00Z&endTime=2027-01-01T00:00:00Z" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` ```python Python theme={null} import os import requests response = requests.get( "https://api.blockworks.com/token-unlocks/v1/assets/solana/events", params={ "unlockType": "CLIFF", "startTime": "2026-01-01T00:00:00Z", "endTime": "2027-01-01T00:00:00Z", }, headers={"X-Blockworks-API-Key": os.environ["BLOCKWORKS_API_KEY"]}, timeout=30, ) response.raise_for_status() events = (response.json()["data"] or {}).get("unlockEvents", []) for event in events[:5]: cliff = event["cliff"] recipients = ", ".join(a["allocationRecipient"] for a in cliff["allocations"]) print(f"{event['timestamp']} {cliff['amountNative']:,.0f} native to {recipients}") ``` Each event carries either a `cliff` or a `dailyLinearRateChange`, and the other field is `null`. Both shapes report `amountNative`, `amountUSD`, `percentOfTotalAllocation`, and a per-recipient `allocations` breakdown. Drop `unlockType` to get both kinds in one call. ### Chart supply pressure The unlocks timeseries buckets released tokens by interval. `interval` is required and takes `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, or `YEARLY`. ```bash curl theme={null} curl "https://api.blockworks.com/token-unlocks/v1/assets/solana/unlocks?interval=MONTHLY&startTime=2026-01-01T00:00:00Z&endTime=2026-07-01T00:00:00Z" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` ```python Python theme={null} import os import requests response = requests.get( "https://api.blockworks.com/token-unlocks/v1/assets/solana/unlocks", params={ "interval": "MONTHLY", "startTime": "2026-01-01T00:00:00Z", "endTime": "2026-07-01T00:00:00Z", }, headers={"X-Blockworks-API-Key": os.environ["BLOCKWORKS_API_KEY"]}, timeout=30, ) response.raise_for_status() data = response.json()["data"] for snapshot in data["totalSnapshots"]: print(snapshot["timestamp"], round(snapshot["unlockedInPeriodUSD"])) # The same series, split by who receives the tokens. for allocation in data["allocations"]: released = sum(s["unlockedInPeriodNative"] for s in allocation["dailySnapshots"]) print(allocation["allocationRecipient"], round(released)) ``` These snapshots are flow: each one covers its own interval and carries no running total. For cumulative state (how much has vested, how much remains, percent complete per day), use [Get Vesting Schedule](/api-reference/token-unlocks/get-v1-assets-assetId-vesting-schedule) instead. The per-recipient arrays are named `dailySnapshots` on both endpoints, even when you requested a coarser interval. ## Identifiers The four per-asset endpoints take `assetId` and accept either a slug (`solana`) or the asset UUID. The `assetIDs` filter on [List Covered Assets](/api-reference/token-unlocks/get-v1-assets) is the exception: it accepts UUIDs only, and slugs match nothing rather than returning an error. Resolve slugs through the list endpoint before filtering by id. ## Response shape Token Unlocks uses the same envelope as every Blockworks API: `error` is `null` on success and a string on failure, and `data` carries the payload. There is no `metadata` block on these endpoints. > [!NOTE] > > An empty result is `"data": null`, not an empty array, and it still comes back with a `200`. > A filter that matches nothing and an asset with no unlock coverage both look like this, so > check for `null` before iterating. ## Coverage and filtering * **Filters combine as AND across parameters, OR within one.** `category=Networks,Financial Services` returns both categories; adding `sector=Lending` narrows that set rather than widening it. * **`page` and `limit` are accepted but not currently applied.** List Covered Assets returns the full matching set on every call. Do not build paging logic against them. * **Results are unordered.** Two identical calls return the same assets in a different order. Sort client-side when ordering matters. * **`tags` can be `null`** on an asset rather than an empty list, and `category` and `sector` can be empty strings for assets that have not been classified. * **Read `otherInfo` before trusting a schedule as complete.** It is `null` for most assets, but when it is set it records an analyst caveat, such as a project that has only published its schedule through a given year. The unlock data for those allocations is partial by construction. * **`projectedEndDate` equal to `genesisDate`** means the allocation unlocked at genesis rather than meaning the data is missing. ## Use cases * **Supply pressure models.** Pull the unlocks timeseries at `WEEKLY` or `MONTHLY` for the assets you cover and rank upcoming windows by unlocked value. * **Unlock calendars.** Query events with `unlockType=CLIFF` and a forward `endTime` to build a dated calendar of discrete releases. * **Holder concentration.** Combine allocation breakdowns with the vesting schedule to see which recipients are still locked and for how long. * **Diligence.** Surface the `description`, `assumptions`, and `sources` on a tranche next to the numbers, so a reader can audit where a figure came from. * **Event correlation.** Join unlock dates to [Monitoring](/api-reference/monitoring/overview) developments on the same asset UUID to study what happened around a release. # Overview Source: https://docs.blockworks.com/datashare/overview Blockworks datasets delivered natively into your own data warehouse: SQL access at warehouse scale, no ETL. A Blockworks Datashare delivers the same warehouse-modeled datasets that back the [Data API](/getting-started/data-api) directly into your own data warehouse. You query them as if they were your own tables: no pipeline to build, no data to copy, and no rows to page through. Snowflake is available today, through Snowflake Secure Data Sharing. > [card] [Snowflake](/datashare/snowflake/getting-access) > > Mount the Blockworks share in your Snowflake account and query it with ordinary SQL. ## Why a datashare > [card] No ETL > > Data is shared in place. You point your warehouse at the share and query it. Nothing > is copied into your account and nothing needs syncing. > [card] Full SQL > > Joins, window functions, aggregations, and CTEs against the full dataset, on your own > compute. > [card] Joins with your data > > Combine Blockworks datasets with your own tables in a single query: positions, > customers, internal metrics. > [card] Your governance > > Access is controlled through your own roles and grants, and queries run under your > account's existing policies. ## Datashare or Data API? Both surface the same underlying data. The right choice is about access pattern, not content. | | Data API | Datashare | | - | - | - | | **Interface** | REST over HTTPS | SQL in your warehouse | | **Best for** | Applications, dashboards, agents, per-request lookups | Analytics, research, backtests, bulk work | | **Shape of work** | Filtered, paginated reads | Arbitrary queries over full history | | **Joins to your data** | In your application | In the warehouse | | **Compute** | Ours | Yours | | **Latency** | Millisecond responses, edge-cacheable | Warehouse query time | > [!NOTE] > > These are complementary. A common pattern is research and model development against the > datashare, then serving the resulting product from the Data API. Reach for a Datashare when you want to scan or aggregate more data than a REST endpoint should reasonably return, when your analysis is fundamentally a SQL problem, or when the answer requires joining Blockworks data to data of your own. Reach for the [Data API](/getting-started/data-api) when you are serving a request in an application, when you need low latency, or when a warehouse is not part of your stack. ## Where the data comes from Blockworks datasets are modeled in a Snowflake warehouse and version-controlled with dbt by the Blockworks data team. That warehouse is the single source of truth: the Data API serves a fast mirror of these models, and a datashare exposes them natively. Both reflect the same modeling and the same definitions. ## Other platforms Snowflake is the platform we deliver today. If you work in Databricks, BigQuery, or another warehouse, tell us. Delivery to additional platforms is arranged case by case, and knowing what you need shapes what we build next. > [card] [Contact Blockworks](https://blockworks.com/contact) > > Get in touch at [blockworks.com/contact](https://blockworks.com/contact) to discuss > datashare access or a platform we do not yet list. # Getting Access Source: https://docs.blockworks.com/datashare/snowflake/getting-access Request the Blockworks Snowflake Datashare and mount it in your Snowflake account. Access to the Blockworks Snowflake Datashare is arranged with our team. Once the share is granted, mounting it in your account takes a few minutes and two SQL statements. ## 1. Request access > [card] [Contact Blockworks](https://blockworks.com/contact) > > Get in touch at [blockworks.com/contact](https://blockworks.com/contact) to discuss datashare > access. To speed things along, have the following ready: | Detail | Why it is needed | | - | - | | Your Snowflake **account identifier** | In the form `.`. The share is granted to this account specifically. | | Your **cloud provider and region** | AWS, Azure, or GCP, and the region, for example `AWS us-east-1`. Determines how the share reaches you. | | The **datasets** you need | Access is scoped to the datasets covered by your agreement. | > [!NOTE] > > Find your account identifier by running `SELECT CURRENT_ORGANIZATION_NAME(), CURRENT_ACCOUNT_NAME();` > in Snowflake, or by reading it from the account selector in Snowsight. > [!WARNING] > > Snowflake Secure Data Sharing is direct only between accounts in the same cloud provider and > region. If your account is in a different region, tell us up front. Cross-region delivery is > arranged differently, and knowing early avoids a false start. ## 2. Find the share Once we have granted the share to your account, it appears in your Snowflake account under **Data Products**, then **Private Sharing**, in Snowsight, listed as a share awaiting setup. To confirm it from SQL, use a role with the `ACCOUNTADMIN` role (or a role with the `IMPORT SHARE` privilege): ```sql theme={null} USE ROLE ACCOUNTADMIN; SHOW SHARES; ``` The Blockworks share appears as an **inbound** share. Note its fully qualified name, the `.` value in the output. You will use it in the next step. ## 3. Create a database from the share Mounting the share creates a read-only database in your account. Nothing is copied; the database is a live view onto the shared data. ```sql theme={null} USE ROLE ACCOUNTADMIN; CREATE DATABASE BLOCKWORKS FROM SHARE .; ``` > [!NOTE] > > `BLOCKWORKS` here is the local database name in **your** account, so pick whatever fits your > naming conventions. `.` is the value from `SHOW SHARES`. ## 4. Grant access to your roles A database created from a share is read-only, and its privileges are granted as a unit with `IMPORTED PRIVILEGES`. ```sql theme={null} GRANT IMPORTED PRIVILEGES ON DATABASE BLOCKWORKS TO ROLE ANALYST; ``` Repeat for each role that needs access. Grant to the narrowest set of roles that need the data. ## 5. Verify ```sql theme={null} USE ROLE ANALYST; SHOW SCHEMAS IN DATABASE BLOCKWORKS; ``` If you see the shared schemas, you are connected. Head to [Querying in Snowflake](/datashare/snowflake/querying) to explore what is in them. ## Troubleshooting > [accordion] The share does not appear in SHOW SHARES > > Confirm you are running as `ACCOUNTADMIN`, and that the account identifier you gave us matches > the account you are checking, since organizations often have several. If it still does not appear, > come back to us with the exact identifier you ran `SHOW SHARES` in. > [accordion] CREATE DATABASE FROM SHARE fails > > This usually means the executing role lacks the `IMPORT SHARE` privilege, or the share name is > not fully qualified. It must include the provider account prefix, exactly as `SHOW SHARES` > reports it. > [accordion] A user can see the database but not the data > > Their role needs `IMPORTED PRIVILEGES` on the shared database. Ordinary object-level grants do > not apply to shared databases. > [accordion] Nothing works and the accounts are in different regions > > Direct shares do not cross cloud regions. Contact us so we can arrange delivery for your region. > [!NOTE] > > These are the standard Snowflake consumer steps for a direct share. If your organization has its > own conventions for mounting shares (a dedicated provisioning role, a naming standard, an > infrastructure-as-code workflow), follow those. The only Blockworks-specific inputs are the share > name and the account identifier you give us. # Querying the Share Source: https://docs.blockworks.com/datashare/snowflake/querying Discover the schemas and views in the Blockworks Snowflake Datashare and query them with ordinary SQL. Once the share is mounted as a database in your account, it behaves like any other read-only database: ordinary SQL, your warehouses, your roles. > [!NOTE] > > This page uses `BLOCKWORKS` as the local database name and clearly marked placeholder schema and > view names. Substitute the names you actually see from the discovery queries below, which are the > authoritative source for what your share contains. ## Discover what you have The share is self-describing. Start at the top and work down. **1. List the schemas** ```sql theme={null} SHOW SCHEMAS IN DATABASE BLOCKWORKS; ``` **2. List the views in a schema** ```sql theme={null} SHOW VIEWS IN SCHEMA BLOCKWORKS.; ``` **3. Inspect a view's columns** ```sql theme={null} DESCRIBE VIEW BLOCKWORKS..; ``` `INFORMATION_SCHEMA` works too, and is easier to filter and join: ```sql theme={null} -- Every object in the share, with its schema and type. SELECT table_schema, table_name, table_type, comment FROM BLOCKWORKS.INFORMATION_SCHEMA.TABLES ORDER BY table_schema, table_name; ``` ```sql theme={null} -- Every column on a single object, in order. SELECT column_name, data_type, is_nullable, comment FROM BLOCKWORKS.INFORMATION_SCHEMA.COLUMNS WHERE table_schema = '' AND table_name = '' ORDER BY ordinal_position; ``` ```sql theme={null} -- Find every object whose name mentions a concept you care about. SELECT table_schema, table_name FROM BLOCKWORKS.INFORMATION_SCHEMA.TABLES WHERE table_name ILIKE '%price%'; ``` > [!NOTE] > > Column and object comments carry the same descriptions as the Data API catalog where they are > populated. Read them before guessing at a column's meaning. ## Set your session ```sql theme={null} USE ROLE ANALYST; USE WAREHOUSE ANALYTICS_WH; USE DATABASE BLOCKWORKS; ``` Queries against the share run on **your** warehouse. Size it to the work: a small warehouse is fine for lookups and recent windows; scans across long histories will want more. ## Query patterns The examples below use placeholder names in angle brackets. They illustrate shape, not schema. ### A point-in-time lookup ```sql theme={null} SELECT * FROM BLOCKWORKS.. WHERE symbol = 'BTC'; ``` ### A time-bounded series Timeseries-shaped objects carry a time column and a series key. Always bound the time range, because predicate pruning on the time column is what keeps these queries cheap. ```sql theme={null} SELECT , FROM BLOCKWORKS.. WHERE = '' AND >= DATEADD(day, -90, CURRENT_TIMESTAMP()) ORDER BY ; ``` ### An aggregation over a window ```sql theme={null} SELECT DATE_TRUNC('month', ) AS month, AVG() AS avg_value, MAX() AS max_value FROM BLOCKWORKS.. WHERE >= DATEADD(year, -1, CURRENT_TIMESTAMP()) GROUP BY 1 ORDER BY 1; ``` ### A period-over-period change ```sql theme={null} SELECT , , LAG() OVER (ORDER BY ) AS previous_value, / NULLIF(LAG() OVER (ORDER BY ), 0) - 1 AS pct_change FROM BLOCKWORKS.. WHERE = '' AND >= DATEADD(year, -1, CURRENT_TIMESTAMP()) ORDER BY ; ``` ### Joining entity metadata onto a series Entity-shaped objects hold identity and metadata; timeseries-shaped objects hold history keyed by the same identifier. Joining them is the most common pattern in the share. ```sql theme={null} SELECT e.name, e.symbol, t., t. FROM BLOCKWORKS.. AS t JOIN BLOCKWORKS.. AS e ON e. = t. WHERE t. >= DATEADD(day, -30, CURRENT_TIMESTAMP()); ``` ### Joining to your own tables This is the reason to use the share rather than the API. Blockworks data and your data are in the same warehouse, so they join like any other two tables. ```sql theme={null} SELECT p.position_id, p.quantity, m., p.quantity * m. AS position_value FROM MY_DB.PORTFOLIO.POSITIONS AS p JOIN BLOCKWORKS.. AS e ON e.symbol = p.symbol JOIN BLOCKWORKS.. AS m ON m. = e.; ``` ## Working efficiently > [card] Bound the time column > > Always constrain the time column on timeseries objects. An unbounded scan of full history is the > single most common cause of a surprising bill. > [card] Project only what you need > > Select the columns you use rather than `SELECT *`. Columnar storage means narrow queries are > genuinely cheaper. > [card] Materialize repeated work > > If several dashboards hit the same aggregate, build a table in your own database from the share > and refresh it on a schedule. > [card] Explore with LIMIT > > When you first meet an object, look at it with a `LIMIT` before writing the real query. Snowflake > still scans, so keep the predicate on. ## Things to know * **The share is read-only.** You cannot write to it, add indexes, or alter its objects. Build derived tables in your own database. * **Data updates in place.** The provider refreshes the underlying models; you see the new data on your next query, with nothing to re-import. * **Objects may be added over time.** Re-run the discovery queries periodically rather than assuming a fixed inventory. * **Definitions match the API.** Metrics are modeled once and surfaced two ways, so a number in the share and the same number from the [Data API](/getting-started/data-api) are the same number. ## Getting help If you cannot find a dataset you expect to have, or a query is behaving unexpectedly, get in touch at [blockworks.com/contact](https://blockworks.com/contact). # Authentication Source: https://docs.blockworks.com/getting-started/authentication Authenticate every Blockworks API request with an API key sent in the X-Blockworks-API-Key header. Blockworks authenticates requests with an API key sent in a request header. There is no OAuth flow, no token exchange, and no session state. Every request carries the key. One key covers every product. The same key authenticates the [Data API](/getting-started/data-api), [Monitoring](/api-reference/monitoring/overview), and the [MCP Server](/mcp/overview). Datashare access is granted to your warehouse account rather than by key. See [Datashares](/datashare/overview). ## Get an API key Create and manage keys at [app.blockworks.com/account/api](https://app.blockworks.com/account/api). Keys are shown once at creation, so store yours in a secret manager or environment variable. ## Using your key Pass the key in the `X-Blockworks-API-Key` header on every request to `https://api.blockworks.com`: ```bash theme={null} curl 'https://api.blockworks.com/query/ping' \ --header "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` For a full first request in curl, Python, and JavaScript, see the [Data API quickstart](/getting-started/quickstart) or the [Monitoring quickstart](/api-reference/monitoring/quickstart). > [!NOTE] > > The header name is `X-Blockworks-API-Key`. Header names are case-insensitive, so > `x-blockworks-api-key` works identically. The legacy `x-messari-api-key` header is still > accepted for existing integrations; new code should send `X-Blockworks-API-Key`. ## Access tiers Not every dataset requires the same level of access. Each model in the catalog declares an access tier, and the API enforces it per request: | Tier | Who can query it | Without the required access | | - | - | - | | `public` | Anyone, including unauthenticated requests. | never refused (an invalid key is still `403 Forbidden`) | | `unpaid` | Any request that carries a valid API key, on any plan. | `401 this model requires authentication` | | `paid` | A valid key on a paid plan (Lite, Pro or Enterprise). | `401` without a key, `403 this model requires a paid subscription` with a free-plan key | | `permissive` | A valid key holding the model's specific permission (`access.permissionSlug`). | `401` without a key, `403` otherwise | Models restricted to internal users do not appear in the public catalog or in this reference. Paid is the default tier of the reference, so reference pages only call out the exceptions (public models and models that need a specific permission). You can read the tier of any model from `access.tier` in the [catalog endpoints](/getting-started/concepts/catalog). See [Errors](/getting-started/errors) for the exact messages. ## Rate limits Each account gets one allowance, shared by every endpoint it calls. The allowance depends on your plan: | Plan | Allowance | | - | - | | No key or Free | 200 requests per minute | | Lite, Pro and Enterprise | 600 requests per minute | | Trial | 25 requests per hour | Every response reports where you stand in the current window: | Header | Meaning | | - | - | | `X-RateLimit-Limit` | Requests allowed in the window. | | `X-RateLimit-Remaining` | Requests left in the window. | | `X-RateLimit-Reset` | When the window ends and the allowance refills, as a Unix timestamp in seconds. | A request over the limit gets `429 Too Many Requests` with a `Retry-After` header giving the whole number of seconds to wait before the next request will succeed: ```http theme={null} HTTP/1.1 429 Too Many Requests Retry-After: 30 Content-Type: application/json { "error": "Too Many Requests", "data": null } ``` Wait for `Retry-After` before you retry, and send one request at a time while you wait. > [!WARNING] > > **Keep your key secret.** Never commit it to version control, embed it in a client-side bundle, or > paste it into a shared document or support ticket. Requests made with your key count against your > account. ## Handling keys safely > [card] Server-side only > > Call the API from your backend. A key shipped to a browser or mobile app is a public key. > [card] Environment variables > > Load the key from the environment or a secrets manager rather than hardcoding it. > [card] Rotate regularly > > Regenerate your key periodically, and immediately if you suspect it has leaked. ## Verify your setup `/query/ping` is a lightweight endpoint for confirming your client is wired up correctly. The request above returns: ```json theme={null} { "error": null, "data": { "message": "pong" } } ``` # The Data Catalog Source: https://docs.blockworks.com/getting-started/concepts/catalog The Blockworks API describes itself. Two catalog endpoints enumerate every model, column, filter, and granularity, which is ideal for building dynamic UIs and AI agents. The API is catalog-driven. Every model, column, filter operator, sort option, and granularity is declared in a source-controlled data catalog, and that catalog is exposed over the API itself. You never have to hardcode a field list or guess which filters a column supports. You can ask. > [card] [Tabular catalog](#tabular-catalog) > > `GET /query/tabular/catalog` > [card] [Timeseries catalog](#timeseries-catalog) > > `GET /query/timeseries/catalog` Neither endpoint needs an API key. Pass `publicOnly=true` to list only the models published in this reference; without it, internal models your key may not be able to query are listed too. ## Tabular catalog ```bash theme={null} curl 'https://api.blockworks.com/query/tabular/catalog?publicOnly=true' ``` `data.models` is an array of tabular models. Trimmed to one model and three of its columns: ```json theme={null} { "error": null, "data": { "models": [ { "name": "Assets", "slug": "assets", "description": "Identity and relation fields for every crypto asset : id, slug, symbol, name, logo, primary project, and onchain platform contracts. Lookup and search surface for assets.", "access": { "tier": "public" }, "columns": [ { "name": "Asset ID", "field": "assetID", "description": "The unique identifier of the asset.", "type": "string", "primaryKey": true, "sortable": false, "defaultSort": false, "filters": [ "Eq", "IsOneOf", "IsNotOneOf" ] }, { "name": "Slug", "field": "slug", "description": "The URL slug of the asset.", "type": "string", "primaryKey": false, "identifier": 1, "sortable": true, "defaultSort": false, "filters": [ "Eq", "IsOneOf" ] }, { "name": "Circulating Marketcap", "field": "circulatingMarketcap", "description": "The circulating marketcap of the asset. Carried so search and filter results can be ranked by size.", "type": "float64", "primaryKey": false, "sortable": true, "defaultSort": false, "filters": [ "Gt", "Gte", "Lt", "Lte" ] } ] } ] } } ``` ### Model fields | Field | Description | | - | - | | `name` | Human-readable model name. | | `slug` | URL segment: `/query/tabular/{slug}`. A few models also answer to aliases (`asset-entities` for `assets`, `network-entities` and `networks` for `blockchains`); the catalog lists the canonical slug only. | | `description` | What the model contains. | | `access` | `tier` (`public`, `unpaid`, `paid`, `permissive`, `internal`) and, for `permissive`, a `permissionSlug`. | | `columns` | Every public column on the model. | ### Column fields | Field | Description | | - | - | | `name` | Human-readable column name. | | `field` | Public field name: the key in the response, the value for `selections` and `sortBy`, and the base of every filter parameter. | | `description` | What the column holds. | | `type` | Data type, e.g. `string`, `float64`, `int64`, `bool`, `time`, or an array type. | | `unit` | Denomination where meaningful: `usd`, `btc`, `sats`, `eth`, `gwei`, `native-token`, `percent`, `count`, `ratio`. | | `primaryKey` | Whether this column identifies the row for `/query/tabular/{model}/{id}`. Its values are also the series keys of the timeseries models keyed by this table. | | `identifier` | Priority of an alternative identifier the row endpoint also matches on, `1` first (for `assets`: `slug`, then `prioritySymbol`). Absent when the column is not an identifier. | | `sortable` | Whether the column may be used as `sortBy`. | | `defaultSort` | Whether this is the model's default sort column. | | `filters` | The filter operators enabled on this column, spelled exactly as they are appended to `field` to form a query parameter. | ### Filters are query-parameter suffixes A column with `"field": "circulatingMarketcap"` and `"filters": ["Gt", "Gte", "Lt", "Lte"]` is filtered with `?circulatingMarketcapGte=1000000000`; one with `"field": "slug"` and `"filters": ["Eq", "IsOneOf"]` with `?slugEq=bitcoin` or `?slugIsOneOf=bitcoin,ethereum`. There is no translation step: the catalog value is the suffix. The full operator list, with the value each one takes, is on [Filtering & pagination](/getting-started/filtering-pagination). ## Timeseries catalog ```bash theme={null} curl 'https://api.blockworks.com/query/timeseries/catalog?publicOnly=true' ``` Trimmed to one model and three of its columns: ```json theme={null} { "error": null, "data": { "models": [ { "name": "Asset Price", "slug": "asset-price", "description": "Volume-weighted average price and volume for an asset over time.", "access": { "tier": "public" }, "intervals": [ "5m", "1h", "1d", "1w" ], "allowAllSeries": false, "columns": [ { "name": "Time", "field": "time", "description": "Timestamp of the data point.", "type": "time", "time": true, "seriesKey": false }, { "name": "Asset ID", "field": "assetID", "description": "The unique identifier of the asset.", "type": "string", "time": false, "seriesKey": true }, { "name": "Close Price", "field": "close", "description": "Price at the candle close.", "type": "float64", "unit": "usd", "time": false, "seriesKey": false } ] } ] } } ``` Timeseries models add three fields on top of the shared ones: | Field | Description | | - | - | | `intervals` | The granularities this model supports, which are the valid values for the `{granularity}` path segment. | | `allowAllSeries` | Whether the multi-series endpoint may be called without `?series=`. When `false`, you must name the series you want. | | `columns[].time` | `true` for the model's time column, the leading value of every point. | | `columns[].seriesKey` | `true` for the column that identifies a series. Its values are the keys you pass to `?series=` or in the series-key path. For entity-keyed models they are the primary keys of a tabular model; see [Finding an id](/api-reference/data-api/discovery/finding-an-id). | ## Built for agents The catalog is the reason an AI agent can use this API without a hand-written integration. Two requests give it the complete, current surface area: every dataset, every field, every legal filter, every granularity, including access tiers, so it knows what it can reach before it tries. **1. Discover** Fetch both catalogs. You now have every model slug and its description. **2. Select** Match the user's question to a model. `access.tier` tells you whether the key can query it. **3. Construct** Build the request from the columns: `field` names for `selections` and `sortBy`, `field` plus one of its `filters` values for each query parameter, `intervals` for the granularity path segment, and the `primaryKey` of the lookup table for a series key. **4. Interpret** For timeseries, use the response's `point_schema` to label the point arrays; for tabular, the `unit` on each column tells you how to format the number. > [!NOTE] > > Catalog fields change as models are added and columns are exposed. Fetch the catalog rather than > pinning a snapshot, and treat unknown fields as forward-compatible additions. ### Example: find every model with an hourly granularity ```bash theme={null} curl -s 'https://api.blockworks.com/query/timeseries/catalog?publicOnly=true' \ | jq -r '.data.models[] | select(.intervals | index("1h")) | "\(.slug)\t\(.name)"' ``` ### Example: list the sortable columns on a tabular model ```bash theme={null} curl -s 'https://api.blockworks.com/query/tabular/catalog?publicOnly=true' \ | jq -r '.data.models[] | select(.slug=="assets") | .columns[] | select(.sortable) | .field' ``` > [card] [Tabular catalog reference](/api-reference/data-api/discovery/tabular-catalog) > > The endpoint page, with the full response shape. > [card] [Timeseries catalog reference](/api-reference/data-api/discovery/timeseries-catalog) > > The endpoint page, with the full response shape. > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Which lookup table gives the series key of each timeseries model. # Granularity & Time Ranges Source: https://docs.blockworks.com/getting-started/concepts/granularity Pick a granularity in the path and a time window with timeframe or start/end. Every timeseries endpoint accepts the same time-selection parameters. Every timeseries request answers two questions: at what resolution, and over what window. The **granularity** is a path segment; the **time window** is a query parameter. ``` GET /query/timeseries/{model}/{granularity}?timeframe=30d └ resolution └ window ``` ## Granularity Granularity is part of the URL path, not a query parameter: ``` GET /query/timeseries/asset-price/1d/1e31218a-e44e-4285-820c-8282ee222035 GET /query/timeseries/asset-price/1h/1e31218a-e44e-4285-820c-8282ee222035 ``` | Token | Interval | | - | - | | `5m` | 5 minutes | | `1h` | 1 hour | | `6h` | 6 hours | | `1d` | 1 day | | `1w` | 1 week | | `1n` | 1 calendar month | > [!WARNING] > > **Each model supports only a subset of these.** `1d` is the most widely available; some models add > `1w` or `1h`, and only a handful go down to `5m`. Requesting a granularity a model does not offer > returns `404`. Read the supported set from the model's `intervals` array in the [timeseries catalog](/getting-started/concepts/catalog), or from the `granularity` path parameter's enum on the endpoint's reference page. ```bash theme={null} curl -s 'https://api.blockworks.com/query/timeseries/catalog' \ --header 'X-Blockworks-API-Key: YOUR_API_KEY' \ | jq '.data.models[] | select(.slug=="asset-price") | .intervals' ``` ```json theme={null} ["5m", "1h", "1d", "1w"] ``` > [!NOTE] > > `1n` is a legacy token for a calendar month, carried over from earlier API versions and still used > by a few monthly models (fundraising, for example). Where it appears in a model's `intervals`, it > is the correct value to put in the path. ## Time windows There are two mutually exclusive ways to select a window: `timeframe`, or `start`/`end`. > [!WARNING] > > Combining them returns `400` with `cannot combine timeframe with start/end`. Pick one style per > request. If you supply neither, the window is unbounded below and ends at the current time: you get everything the API retains for that series. A window may span at most 9000 points of the requested granularity, so omitting it works at `1d` and coarser but returns `400` at fine granularities such as `1h`, where the full history is wider than that. `bounds=true` is exempt from the cap. ### `timeframe` A single expressive token. Windows anchored to "now" end at the current time. | Form | Examples | Resolves to | | - | - | - | | To-date | `ytd`, `htd`, `qtd`, `mtd`, `dtd` | From the start of the calendar year, half, quarter, month, or day up to now | | Relative | `30d`, `12h`, `3w`, `90m` | From that duration ago up to now | | Calendar day | `2026-07-13` | That whole day | | Calendar month | `2026-07` | That whole month | | Calendar year | `2026` | That whole year | | RFC3339 instant | `2026-07-13T00:00:00Z` | From that instant up to now | | Unix seconds | `1783843200` | From that instant up to now | Relative windows accept the units `m` (minutes), `h` (hours), `d` (days), and `w` (weeks), written as a count followed by the unit. Tokens are case-insensitive: `YTD` and `30D` work. > [!WARNING] > > **There is no year or month unit.** `1y` and `1M` return `400` with `unrecognized timeframe "1y"`. > For the last year use `365d` or `52w`; for the calendar year to date use `ytd`; for a whole past > year or month use the calendar forms `2025` or `2025-06`; for anything else use `start`/`end`. In full, `timeframe` accepts exactly these forms: | Form | Pattern | | - | - | | To-date | `ytd`, `htd`, `qtd`, `mtd`, `dtd` | | Relative | `m`, `h`, `d`, `w` (a positive integer and one unit) | | Calendar day | `YYYY-MM-DD` | | Calendar month | `YYYY-MM` | | Calendar year | `YYYY` between 1970 and 3000 | | Instant to now | an RFC3339 timestamp, or any other integer read as unix seconds | ```bash theme={null} # Year to date, daily curl -G 'https://api.blockworks.com/query/timeseries/asset-price/1d/1e31218a-e44e-4285-820c-8282ee222035' \ --header 'X-Blockworks-API-Key: YOUR_API_KEY' \ --data-urlencode 'timeframe=ytd' # The last 12 hours, hourly curl -G 'https://api.blockworks.com/query/timeseries/asset-price/1h/1e31218a-e44e-4285-820c-8282ee222035' \ --header 'X-Blockworks-API-Key: YOUR_API_KEY' \ --data-urlencode 'timeframe=12h' ``` > [!NOTE] > > A bare number is read as a calendar year when it falls between 1970 and 3000, and as a unix > timestamp otherwise. If you mean a specific instant inside that range, use RFC3339 or `start`. ### `start` and `end` For explicit windows. Each accepts RFC3339, unix seconds, or `YYYY-MM-DD`. Both are optional: an omitted `start` leaves the window unbounded below, and an omitted `end` defaults to now. ```bash theme={null} curl -G 'https://api.blockworks.com/query/timeseries/asset-price/1d/1e31218a-e44e-4285-820c-8282ee222035' \ --header 'X-Blockworks-API-Key: YOUR_API_KEY' \ --data-urlencode 'start=2026-01-01' \ --data-urlencode 'end=2026-06-30' ``` A `start` later than `end` returns `400`. > [!NOTE] > > Windows are half-open: `[start, end)`. A calendar expansion such as `timeframe=2026-07-13` runs > from that midnight up to, but not including, the next, so adjacent windows never double-count a > bucket. ## `bounds` Set `bounds=true` to return only the **first and last** point of the resolved window instead of every point in it. This is the efficient way to compute a change over a period without transferring the whole series. ```bash theme={null} curl -G 'https://api.blockworks.com/query/timeseries/asset-price/1d/1e31218a-e44e-4285-820c-8282ee222035' \ --header 'X-Blockworks-API-Key: YOUR_API_KEY' \ --data-urlencode 'timeframe=ytd' \ --data-urlencode 'bounds=true' ``` ## Timestamps in the response Every point begins with a **unix timestamp in seconds**, in UTC. The values that follow are the metrics in `point_schema` order. See [Responses](/getting-started/responses#reading-points). ## Choosing a granularity > [card] Match the window > > A year of `5m` data is a very large response. Use `1d` for long windows and reserve fine > granularities for short ones. > [card] Check what exists > > Read `intervals` from the catalog before hardcoding a granularity, because the supported set > differs per model. For long windows at fine granularity, request `acceptFormat=csv` or `acceptFormat=jsonl` to receive the data as a downloadable file rather than a single JSON document. See [Filtering & pagination](/getting-started/filtering-pagination#response-formats). # Tabular vs Timeseries Source: https://docs.blockworks.com/getting-started/concepts/tabular-vs-timeseries The Blockworks API serves two model kinds. Learn the URL shapes, response shapes, and when to reach for each. Every dataset in the Blockworks API is one of two **model kinds**. The kind determines the URL shape, the query parameters, and the response structure, but within a kind, every model behaves identically. Learn one tabular endpoint and you have learned them all. | | Tabular | Timeseries | | - | - | - | | **Answers** | "What is true right now?" | "How did this change over time?" | | **Shape** | Rows with a primary key | Points along a time axis, grouped into series | | **URL** | `/query/tabular/{model}` | `/query/timeseries/{model}/{granularity}` | | **Narrowing** | Filter operators, sorting, pagination | Time window, granularity, series selection | | **Payload** | Array of row objects | `point_schema` plus compact point arrays | ## URL shapes ``` Tabular GET /query/tabular/catalog catalog of every tabular model GET /query/tabular/{model} many rows: filter, sort, paginate GET /query/tabular/{model}/{id} one row by identifier Timeseries GET /query/timeseries/catalog catalog of every timeseries model GET /query/timeseries/{model}/{granularity} many series over a time window GET /query/timeseries/{model}/{granularity}/{key} one series over a time window ``` Concretely: ``` GET /query/tabular/assets?symbolIsOneOf=BTC,ETH GET /query/tabular/assets/bitcoin GET /query/timeseries/asset-price/1d?series=1e31218a-e44e-4285-820c-8282ee222035&timeframe=30d GET /query/timeseries/asset-price/1d/1e31218a-e44e-4285-820c-8282ee222035?timeframe=30d ``` ## How they relate ```mermaid theme={null} flowchart TD C["Catalog endpoints
/query/tabular/catalog
/query/timeseries/catalog"] C --> T["Tabular models"] C --> S["Timeseries models"] T --> TL["List endpoint
filter · sort · paginate
data: array of rows"] T --> TI["Single-row endpoint
lookup by primary key
or alternative identifier
data: one row"] S --> SA["Multi-series endpoint
series · timeframe
data: point_schema + series"] S --> SK["Single-series endpoint
timeframe
data: point_schema + points"] TI -. "the row id becomes a series key" .-> SK ``` ## Tabular models A tabular model is a result set with a primary key: one row per entity, holding its current state. Asset identity and metadata, exchange directories, current market metrics, ETF holdings. **List endpoint.** `GET /query/tabular/{model}` returns an array of rows. Narrow it with filter operators, order it with `sortBy`/`sortDirection`, and walk it with `page`/`pageSize`. See [Filtering & pagination](/getting-started/filtering-pagination). ```bash theme={null} curl -G 'https://api.blockworks.com/query/tabular/assets' \ --header 'X-Blockworks-API-Key: YOUR_API_KEY' \ --data-urlencode 'circulatingMarketcapGte=1000000000' \ --data-urlencode 'sortBy=circulatingMarketcap' \ --data-urlencode 'sortDirection=desc' ``` **Single-row endpoint.** `GET /query/tabular/{model}/{id}` returns exactly one row. Many models accept alternative identifiers as well as the primary key (for assets, a slug or a symbol also resolves), and `metadata.matchedField` reports which field the value matched on. ```bash theme={null} curl 'https://api.blockworks.com/query/tabular/assets/bitcoin' \ --header 'X-Blockworks-API-Key: YOUR_API_KEY' ``` ## Timeseries models A timeseries model has a time column, a series key, and one or more metric columns. Every request picks a **granularity** in the path and a **time window** in the query string. See [Granularity & time ranges](/getting-started/concepts/granularity). ### Series keys The series key is the value that names one series: the `{seriesKey}` path segment, or one entry of `?series=`. For entity-keyed models (assets, blockchains, protocols, ETFs) it is the **primary key of a row in the matching tabular model**, usually a UUID such as `1e31218a-e44e-4285-820c-8282ee222035` for Bitcoin. The tabular row endpoint accepts a slug or a symbol and tells you the primary key; the timeseries path does not resolve them. > [!WARNING] > > `GET /query/timeseries/asset-price/1d/bitcoin` returns `200` with `"points": []` and no > `entity`, not `404`. An empty series almost always means a slug or symbol was used where the > `assetID` or `networkID` belongs. Resolve the identifier first with `/query/tabular/assets/bitcoin` > or `/query/tabular/blockchains/solana`. Aggregate models (sectors, sub-sectors, exchange regions) key their series by a plain name such as `AI` or `Asia` instead. [Finding an id](/api-reference/data-api/discovery/finding-an-id) lists the lookup table and accepted identifiers for every timeseries model. **Single-series endpoint.** `GET /query/timeseries/{model}/{granularity}/{seriesKey}` returns one series. This is the common case: one asset's price history, one protocol's revenue. ```bash theme={null} curl -G 'https://api.blockworks.com/query/timeseries/asset-price/1d/1e31218a-e44e-4285-820c-8282ee222035' \ --header 'X-Blockworks-API-Key: YOUR_API_KEY' \ --data-urlencode 'timeframe=30d' ``` **Multi-series endpoint.** `GET /query/timeseries/{model}/{granularity}` returns several series in one response. Name them with `?series=`, a comma-separated list of up to 10 series keys. ```bash theme={null} curl -G 'https://api.blockworks.com/query/timeseries/asset-price/1d' \ --header 'X-Blockworks-API-Key: YOUR_API_KEY' \ --data-urlencode 'series=1e31218a-e44e-4285-820c-8282ee222035,21c795f5-1bfd-40c3-858e-e9d7e820c6d0' \ --data-urlencode 'timeframe=ytd' ``` > [!NOTE] > > For models with a small number of series (sector aggregates, ETF providers, lending protocols), > omitting `?series=` returns **every** series at once. Models with high series cardinality (most > asset-keyed models) do not support that: omitting `?series=` returns `404` with a message telling > you to name the series. The catalog's `allowAllSeries` flag tells you which is which. ## Choosing between them > [card] Reach for tabular > > You want a screener, a leaderboard, a directory, or the current value of a metric across many > entities. You want to filter, sort, and paginate. > [card] Reach for timeseries > > You want a chart, a trend, a return calculation, or a backtest. You know which entities you care > about and you need history for them. The two kinds compose. A common pattern is to use a tabular model to *find* the entities you care about, then feed their identifiers into a timeseries model as series keys: **1. Find the entities** `GET /query/tabular/assets?circulatingMarketcapGte=1000000000&selections=assetID,symbol` **2. Pull their history** `GET /query/timeseries/asset-price/1d?series=&timeframe=ytd` ## Shared conventions Both kinds share the same envelope, the same `selections` parameter, the same `acceptFormat` options (`json`, `csv`, `jsonl`), and the same error semantics. See [Responses](/getting-started/responses) and [Errors](/getting-started/errors). # Overview Source: https://docs.blockworks.com/getting-started/data-api The Blockworks Data API is a single, standardized REST interface to onchain data, market coverage, and research-grade metrics. The Data API is a single, standardized REST interface to the data behind Intel: onchain activity, market and asset coverage, protocol and sector fundamentals, and the curated metrics our analysts use in production. Every endpoint is read-only, served from `https://api.blockworks.com`, authenticated with one API key, and returns the same `{ "error": ..., "data": ... }` envelope, so a client written against one product area works against all of them. Endpoints come in two model kinds. **Tabular** models are row-shaped: entities, rankings, and current metrics you filter, sort, and page through. **Timeseries** models are history-shaped: a metric over time for a given entity, at a granularity you choose in the path. > [card] [Quickstart](/getting-started/quickstart) > > Get a key and make your first authenticated request in under five minutes. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. > [card] [Filtering & pagination](/getting-started/filtering-pagination) > > Filter operator suffixes, sorting, column selection, paging, and response formats. > [card] [The data catalog](/getting-started/concepts/catalog) > > The API describes itself: enumerate every model, column, filter, and granularity. > [card] [Finding an id](/api-reference/data-api/discovery/finding-an-id) > > Which lookup table gives the series key each timeseries endpoint needs. > [card] [Reference](/api-reference/data-api/market-data) > > Every model with its columns, metrics, examples and errors, grouped by subject. Start with Market Data. ## Request shape Tabular endpoints live under `/query/tabular/`, optionally with an entity identifier. Timeseries endpoints live under `/query/timeseries//`. ```bash theme={null} # Tabular: the first page of asset entities. curl 'https://api.blockworks.com/query/tabular/assets?pageSize=5' \ --header 'X-Blockworks-API-Key: YOUR_API_KEY' ``` Every request carries the key in the `X-Blockworks-API-Key` header. See [Authentication](/getting-started/authentication). The `` segment is the model's catalog slug. A few older slugs keep working as aliases and resolve to the same endpoint: `asset-entities` for `assets`, `network-entities` and `networks` for the tabular `blockchains` model, `network` and `networks` for the timeseries one. The reference documents the canonical slug only. ## What you can build * **Dashboards and terminals**: asset, protocol, and sector screens backed by research-grade metrics rather than scraped aggregates. * **Quant and research pipelines**: reproducible timeseries pulls with explicit granularity and point-in-time semantics. * **Enrichment services**: resolve symbols, slugs, and identifiers to canonical entities before joining Blockworks metrics onto your own records. ## Next steps > [card] [Responses](/getting-started/responses) > > The envelope, the tabular row shape, and the timeseries series shape. > [card] [Errors](/getting-started/errors) > > Status codes, the error envelope, and how to resolve common failures. > [card] [Granularity](/getting-started/concepts/granularity) > > Choosing an interval and bounding a time window. > [!NOTE] > > Need more than a REST endpoint should reasonably return? The same models are available > natively in your warehouse through [Datashares](/datashare/overview). # Errors Source: https://docs.blockworks.com/getting-started/errors HTTP status codes returned by the Blockworks API, the error envelope, every error message the Data API sends, and how to resolve each one. The Blockworks API uses conventional HTTP status codes. In general: * `2xx`: the request succeeded. * `4xx`: the request failed because of something in the request (a bad parameter, a missing key, a model you cannot access). * `5xx`: something went wrong on our side. These are rare. ## The error envelope Errors use the same envelope as successful responses. On failure, `error` holds a human-readable message and `data` is `null`. ```json theme={null} { "error": "unknown query parameter \"marketCap\"", "data": null } ``` > [!NOTE] > > Check `error` before reading `data`. A non-`null` `error` always accompanies a non-2xx status code. > Branch on the status code, and treat the message as a hint for humans: the wording can change. ## Status codes | Code | Status | Meaning | | - | - | - | | `200` | OK | The request succeeded. This includes a timeseries request whose key matched no series: it returns `200` with an empty `points` array, never `404`. | | `400` | Bad Request | The request was malformed: an unrecognized query parameter, an invalid filter or window value, too many series, or an unsupported `acceptFormat`. | | `401` | Unauthorized | The model requires authentication and no API key was provided. | | `403` | Forbidden | Either the key is not valid (`Forbidden`), or it is valid but lacks access to this model: it needs a paid plan, a specific permission, or internal access. | | `404` | Not Found | The model slug or granularity does not exist, a tabular row identifier matched nothing, or the multi-series endpoint was called without `series` on a model that requires it. | | `500` | Internal Server Error | Something failed on our side. These are rare, so please report them. | | `504` | Gateway Timeout | The request took longer than expected to process. Retry, ideally with a narrower time window or page size. | ## Every error message The full set of messages the Data API sends, with the request that triggers each one. | Status | `error` | Trigger | | - | - | - | | `400` | `unknown query parameter "granularity"` | Any query parameter the endpoint does not declare, including a filter without its operator suffix (`?name=` instead of `?nameEq=`) or a parameter that belongs in the path. | | `400` | `unrecognized timeframe "1y"` | A `timeframe` outside the grammar. `1y` and `1M` are the usual culprits: use `365d`, `52w`, `ytd`, or a calendar year such as `2025`. | | `400` | `cannot combine timeframe with start/end` | Both window styles in one request. | | `400` | `invalid start: expected RFC3339, unix seconds, or YYYY-MM-DD, got "yesterday"` | `start` or `end` in another format. | | `400` | `start 2026-02-01 00:00:00 +0000 UTC is after end 2026-01-01 00:00:00 +0000 UTC` | A window that ends before it starts. | | `400` | `invalid bounds "yes": must be true or false` | `bounds` is a boolean. | | `400` | `invalid acceptFormat "xml": expected one of json, csv, jsonl` | An unsupported output format. | | `400` | `unknown selection field "tvl"` | A `selections` value that is not a column or metric `field` of the model. | | `400` | `too many series requested: 11 exceeds the maximum of 10` | More than 10 keys in `series`. | | `400` | `requested time window spans 191127 1h points, exceeding the maximum of 9000 per request; narrow it with ?timeframe or ?start/?end` | A window wider than 9000 points at the requested granularity, including an omitted window at a fine granularity. `bounds=true` is exempt. | | `400` | `duplicate series key "b204e48e-..."` | The same key twice in `series` (compared case-insensitively). | | `400` | `no series keys specified in the series parameter` | `series=` present but empty. | | `400` | `filter "circulatingMarketcapGte": invalid float64 value "1b": ...` | A filter value that does not parse as the column's type. | | `400` | `pageSize 5000 exceeds maximum of 1000` | `pageSize` above 1000. | | `400` | `unknown sortBy field "nope"` | `sortBy` names a column that is not sortable. | | `401` | `this model requires authentication` | A gated model without an API key. | | `403` | `Forbidden` | An API key that is not valid. This message comes from the gateway, not the API. | | `403` | `this model requires a paid subscription` | A valid key on a plan that does not include the model. | | `404` | `no timeseries model "network" with granularity "1h"` | An unknown timeseries slug, or a granularity the model does not support. The same message covers both today; an upcoming release splits it into `no timeseries model "..."` and `model "..." does not support granularity "..." (supported: ...)`. | | `404` | `the all-series endpoint is not available for model "blockchains"; request specific series via ?series or a series-key path` | The multi-series endpoint without `series` on a model whose catalog entry has `allowAllSeries: false`. | | `404` | `tabular model "nope" not found` | An unknown tabular slug. | | `404` | `no row found matching "not-a-chain"` | A row identifier that matched neither the primary key nor an identifier column. | ## Common errors ### Unknown query parameter (400) The API rejects any query parameter it does not recognize rather than silently ignoring it. This is deliberate: a typo in a filter name would otherwise return unfiltered data. ```json theme={null} { "error": "unknown query parameter \"marketCap\"", "data": null } ``` Filters always carry an explicit operator suffix: `marketCapGte`, not `marketCap`. There is no bare-field form. Check the model's supported filters in the [catalog](/getting-started/concepts/catalog) or on the endpoint's reference page. ### Invalid filter value (400) The value must parse as the column's type. ```json theme={null} { "error": "filter \"circulatingMarketcapGte\": invalid float64 value \"1b\": ...", "data": null } ``` Dates accept RFC3339, unix seconds, or `YYYY-MM-DD`. ### Invalid time window (400) `timeframe` and `start`/`end` are mutually exclusive, and each has its own accepted formats. ```json theme={null} { "error": "cannot combine timeframe with start/end", "data": null } ``` ```json theme={null} { "error": "unrecognized timeframe \"1y\"", "data": null } ``` There is no year or month unit in relative windows. Use `365d`, `52w`, `ytd`, or a calendar period such as `2025` or `2025-06`. See [Granularity & time ranges](/getting-started/concepts/granularity) for the full grammar. ### Too many series (400) A single `?series=` request may name at most 10 series keys, and may not repeat one. ```json theme={null} { "error": "too many series requested: 11 exceeds the maximum of 10", "data": null } ``` ### Authentication required (401) The model is gated and the request carried no API key. ```json theme={null} { "error": "this model requires authentication", "data": null } ``` Confirm the `X-Blockworks-API-Key` header is present and the key is current. See [Authentication](/getting-started/authentication). ### Invalid key (403) The key itself was rejected. The body is the gateway's, not the API's envelope message. ```json theme={null} { "error": "Forbidden", "data": null } ``` Check for a copy-paste error or a rotated key. A public model still returns `403` when the key sent with the request is invalid, so remove a stale key rather than leaving it in place. ### Insufficient access (403) Your key is valid, but the model is above your access tier. ```json theme={null} { "error": "this model requires a paid subscription", "data": null } ``` Read `access.tier` for the model from the [catalog](/getting-started/concepts/catalog) to see what it requires. If you believe you should have access, contact support. ### Not found (404) Returned for an unknown model slug, an unsupported granularity for that model, or a tabular row identifier with no matching row. ```json theme={null} { "error": "no timeseries model \"asset-price\" with granularity \"1n\"", "data": null } ``` Some timeseries models have too many series to return at once. For those, the all-series endpoint is unavailable and you must name the series you want: ```json theme={null} { "error": "the all-series endpoint is not available for model \"asset-price\"; request specific series via ?series or a series-key path", "data": null } ``` The catalog's `allowAllSeries` flag tells you which models support the all-series form. > [!WARNING] > > A timeseries request never returns `404` for an unknown series key. It returns `200` with > `"points": []` and no `entity`. If a series comes back empty, check that the key is the lookup > table's primary key (a UUID for assets and networks), not a slug or a symbol. See > [Finding an id](/api-reference/data-api/discovery/finding-an-id). ### Server errors (500) These indicate a problem on our side. We monitor for them, but reports help. Include the `X-Request-Id` response header from the failing call when you contact support; it lets us find the exact request. # Filtering & Pagination Source: https://docs.blockworks.com/getting-started/filtering-pagination Filter operator suffixes, sorting, pagination, column selections, and response formats: the query conventions shared by every Blockworks API endpoint. Every tabular endpoint accepts the same shape of query parameters. Filters, sorting, pagination, and column selection are derived from the data catalog, so once you know the convention it applies to every model. ## Filter operators A filter is a query parameter named ``. The field name is the model's public field (as it appears in the response), and the operator is one of the suffixes below. ``` GET /query/tabular/assets?circulatingMarketcapGte=1000000000&symbolIsOneOf=BTC,ETH ``` > [!WARNING] > > There is no bare-field form, and `?symbol=BTC` is rejected. Always include the operator suffix > (`?symbolEq=BTC`). Any query parameter the endpoint does not recognize returns `400`, so a typo > fails loudly instead of silently returning unfiltered data. ### Operator suffixes | Suffix | Meaning | Example | | - | - | - | | `Eq` | Equals | `?symbolEq=BTC` | | `NotEq` | Does not equal | `?isStablecoinNotEq=true` | | `Gt` | Greater than | `?circulatingMarketcapGt=1000000000` | | `Gte` | Greater than or equal to | `?circulatingMarketcapGte=1000000000` | | `Lt` | Less than | `?circulatingMarketcapRankLt=100` | | `Lte` | Less than or equal to | `?circulatingMarketcapRankLte=100` | | `IsOneOf` | Value is in the list | `?symbolIsOneOf=BTC,ETH,SOL` | | `IsNotOneOf` | Value is not in the list | `?sectorIsNotOneOf=Stablecoins` | | `Contains` | Case-insensitive substring match | `?nameContains=bit` | | `Includes` | Array column contains this element | `?sectorsV2Includes=DeFi` | | `NotIncludes` | Array column does not contain this element | `?sectorsV2NotIncludes=DeFi` | | `IncludesAnyOf` | Array column contains at least one of these | `?sectorsV2IncludesAnyOf=DeFi,Layer1` | | `NotIncludesAnyOf` | Array column contains none of these | `?sectorsV2NotIncludesAnyOf=DeFi,Layer1` | Multi-value operators (`IsOneOf`, `IsNotOneOf`, `IncludesAnyOf`, `NotIncludesAnyOf`) take a comma-separated list, and may also be repeated: `?symbolIsOneOf=BTC&symbolIsOneOf=ETH` is equivalent to `?symbolIsOneOf=BTC,ETH`. ### Which operators a column supports Not every column exposes every operator. The available set is constrained by the column's type and declared per column in the catalog: | Column type | Available operators | | - | - | | String | `Eq`, `NotEq`, `IsOneOf`, `IsNotOneOf`, `Contains` | | Numeric and time | `Eq`, `NotEq`, `Gt`, `Gte`, `Lt`, `Lte`, `IsOneOf`, `IsNotOneOf` | | Boolean | `Eq`, `NotEq` | | Array | `Includes`, `NotIncludes`, `IncludesAnyOf`, `NotIncludesAnyOf` | The [catalog endpoints](/getting-started/concepts/catalog) list the exact operators enabled for each column, and each endpoint's reference page documents its full parameter list. ### Combining filters Multiple filters combine with AND. ``` GET /query/tabular/assets ?circulatingMarketcapGte=1000000000 &circulatingMarketcapLte=5000000000 §orIsOneOf=DeFi,Smart%20Contract%20Platform ``` ### Date and time values Any filter on a time column accepts three formats: * RFC3339: `2026-07-13T00:00:00Z` * Unix seconds: `1783843200` * `YYYY-MM-DD`: `2026-07-13` ## Sorting | Parameter | Description | | - | - | | `sortBy` | Field to sort by. Restricted to the model's sortable columns; defaults to the model's default sort column. | | `sortDirection` | `asc` (default) or `desc`. | ``` GET /query/tabular/assets?sortBy=circulatingMarketcap&sortDirection=desc ``` ## Pagination | Parameter | Description | | - | - | | `page` | 1-based page number. | | `pageSize` | Rows per page. Defaults to `100`, maximum `1000`. | ``` GET /query/tabular/assets?page=3&pageSize=250 ``` The response's `metadata` reports the totals for the full filtered result set, so you can size your loop before you start: ```json theme={null} { "metadata": { "totalRows": 1482, "totalPages": 6 } } ``` > [!NOTE] > > `totalRows` and `totalPages` describe the whole filtered set, not the current page. Pair them with > `pageSize` to know how many requests a full extract will take, or switch to CSV, which returns > the page in a single downloadable file. ## Selecting columns `selections` takes a comma-separated list of field names and limits the response to those columns. It defaults to every field on the model, and it is supported on every endpoint, including the single-row endpoint. An unknown field name returns `400` with `unknown selection field "..."`. ``` GET /query/tabular/assets?selections=assetID,name,symbol GET /query/tabular/assets/bitcoin?selections=assetID,name,symbol ``` On timeseries endpoints, `selections` names the **metric** fields to return. A point always leads with its timestamp, and the remaining values are described by `point_schema`, so read the schema rather than assuming positions. ``` GET /query/timeseries/asset-price/1d/1e31218a-e44e-4285-820c-8282ee222035?selections=close,volume ``` ## Response formats Every endpoint that returns array-like data supports three encodings. Set them with the `acceptFormat` query parameter, or with a standard `Accept` header. | `acceptFormat` | `Accept` header | Content type | | - | - | - | | `json` (default) | `application/json` | `application/json` | | `csv` | `text/csv` | `text/csv; charset=utf-8` | | `jsonl` | `application/x-ndjson` | `application/x-ndjson` | `acceptFormat` takes precedence over the `Accept` header when both are present. > [!NOTE] > > `csv` and `jsonl` return the rows as a **downloadable file**: the response carries a > `Content-Disposition: attachment` header and is not wrapped in the `error`/`data` envelope. Use > them for extracts and spreadsheet workflows; use JSON for application code. ```bash CSV theme={null} curl 'https://api.blockworks.com/query/tabular/assets?pageSize=1000&acceptFormat=csv' \ --header 'X-Blockworks-API-Key: YOUR_API_KEY' \ --output assets.csv ``` ```bash JSONL theme={null} curl 'https://api.blockworks.com/query/tabular/assets?pageSize=1000' \ --header 'X-Blockworks-API-Key: YOUR_API_KEY' \ --header 'Accept: application/x-ndjson' \ --output assets.jsonl ``` ## Full example ```bash theme={null} curl -G 'https://api.blockworks.com/query/tabular/assets' \ --header 'X-Blockworks-API-Key: YOUR_API_KEY' \ --data-urlencode 'circulatingMarketcapGte=1000000000' \ --data-urlencode 'sortBy=circulatingMarketcap' \ --data-urlencode 'sortDirection=desc' \ --data-urlencode 'selections=assetID,name,symbol,circulatingMarketcap' \ --data-urlencode 'page=1' \ --data-urlencode 'pageSize=50' ``` # Quickstart Source: https://docs.blockworks.com/getting-started/quickstart Get an API key and make your first Blockworks Data API request in under five minutes. This page gets you a key and a first Data API response. The key is the same one that authenticates every Blockworks product, so you only do the first step once. **1. Get an API key** Create a key at [app.blockworks.com/account/api](https://app.blockworks.com/account/api). Keys are shown once at creation. Store yours in a secret manager or environment variable, and never commit it or send it from a browser. ```bash theme={null} export BLOCKWORKS_API_KEY="your-api-key" ``` **2. Make your first request** Every request authenticates with the `X-Blockworks-API-Key` header. Here we page through the `assets` tabular model, which is the lookup surface for every asset we cover (the model is public, so this request also works without a key). ```bash curl theme={null} curl "https://api.blockworks.com/query/tabular/assets?pageSize=5" \ -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY" ``` ```python Python theme={null} import os import requests response = requests.get( "https://api.blockworks.com/query/tabular/assets", params={"pageSize": 5}, headers={"X-Blockworks-API-Key": os.environ["BLOCKWORKS_API_KEY"]}, timeout=30, ) response.raise_for_status() payload = response.json() for asset in payload["data"]: print(asset["prioritySymbol"], asset["name"]) ``` ```javascript JavaScript theme={null} const url = new URL("https://api.blockworks.com/query/tabular/assets"); url.searchParams.set("pageSize", "5"); const response = await fetch(url, { headers: { "X-Blockworks-API-Key": process.env.BLOCKWORKS_API_KEY }, }); if (!response.ok) throw new Error(`Request failed: ${response.status}`); const { data } = await response.json(); for (const asset of data) { console.log(asset.prioritySymbol, asset.name); } ``` **3. Read the response envelope** Every Blockworks API response uses the same envelope: `error` is `null` on success and a string on failure, and `data` carries the payload. Tabular models add a `metadata` object with pagination totals for the full filtered result set. ```json Response (trimmed to one row and four of its fields) theme={null} { "error": null, "data": [ { "assetID": "1e31218a-e44e-4285-820c-8282ee222035", "slug": "bitcoin", "prioritySymbol": "BTC", "name": "Bitcoin" } ], "metadata": { "totalRows": 47838, "totalPages": 15946 } } ``` Because `error` is always present, a single client-side check covers every endpoint, so you never need per-product error handling. > [!NOTE] > > Request a different page with `page`, and change the page size with `pageSize`. > Tabular endpoints also serve `application/x-ndjson` and `text/csv` via the > `Accept` header when you are pulling larger result sets. **4. Go deeper** > [card] [Filtering & pagination](/getting-started/filtering-pagination) > > Filter operator suffixes, sorting, column selection, paging, and response formats. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > The two model kinds, their URL shapes, and when to reach for each. Access tiers, the legacy header, caching, and key handling are covered in [Authentication](/getting-started/authentication). # Responses Source: https://docs.blockworks.com/getting-started/responses Every Blockworks API response uses the same error/data envelope. Learn the tabular row shape and the timeseries point_schema/series shape. Every endpoint returns the same JSON envelope, so a single response handler works across the whole API. ```json theme={null} { "error": null, "data": {} } ``` | Field | Type | Description | | - | - | - | | `error` | string or `null` | `null` on success. On failure, a human-readable message describing what went wrong. Check this first. | | `data` | varies | The payload. Its shape depends on the endpoint: an array of rows, a single row, or a timeseries object. | | `metadata` | object | Only on the two tabular data endpoints: pagination totals on the list endpoint, the matched field on the row endpoint. Timeseries responses and the catalogs have no `metadata` key. | > [!NOTE] > > Always branch on `error` before reading `data`. On an error response, `data` is `null`. The one exception is the [Charts endpoints](/api-reference/charts/list), which return a `{ "page": ..., "total": ..., "data": ... }` page object and report errors with `statusCode` and `message`. ## Tabular responses ### List endpoints `GET /query/tabular/{model}` returns `data` as an **array of row objects**. Each key is the model's public field name; the set of fields comes from the catalog (and from `selections`, if you passed it). `metadata` carries the totals for the whole filtered result set, not just the current page. ```json theme={null} // GET /query/tabular/assets?slugIsOneOf=bitcoin,ethereum&selections=assetID,slug,prioritySymbol,name { "error": null, "data": [ { "assetID": "1e31218a-e44e-4285-820c-8282ee222035", "slug": "bitcoin", "prioritySymbol": "BTC", "name": "Bitcoin" }, { "assetID": "21c795f5-1bfd-40c3-858e-e9d7e820c6d0", "slug": "ethereum", "prioritySymbol": "ETH", "name": "Ethereum" } ], "metadata": { "totalRows": 2, "totalPages": 1 } } ``` | Metadata field | Type | Description | | - | - | - | | `totalRows` | integer | Rows matching the filters, across all pages. | | `totalPages` | integer | Pages at the current `pageSize`. | ### Single-row endpoints `GET /query/tabular/{model}/{id}` returns `data` as a **single row object**. Its `metadata` reports which public field the lookup value matched on. Many models accept alternative identifiers (a slug or a symbol) in addition to the primary key. ```json theme={null} // GET /query/tabular/assets/bitcoin?selections=assetID,slug,prioritySymbol,name { "error": null, "data": { "assetID": "1e31218a-e44e-4285-820c-8282ee222035", "slug": "bitcoin", "prioritySymbol": "BTC", "name": "Bitcoin" }, "metadata": { "matchedField": "slug" } } ``` ## Timeseries responses Timeseries responses are column-oriented: a `point_schema` describes the values, and each point is a compact array rather than a repeated object. This keeps large windows small on the wire. ### Multi-series endpoints `GET /query/timeseries/{model}/{granularity}` returns `data` with `point_schema` and a `series` array. ```json theme={null} // GET /query/timeseries/asset-price/1d?series=1e31218a-e44e-4285-820c-8282ee222035,21c795f5-1bfd-40c3-858e-e9d7e820c6d0&timeframe=7d&selections=close,volume (trimmed to two points per series) { "error": null, "data": { "point_schema": [ { "name": "Time", "field": "time", "description": "Timestamp of the data point.", "type": "time", "time": true }, { "name": "Close Price", "field": "close", "description": "Price at the candle close.", "type": "float64", "unit": "usd", "time": false }, { "name": "Volume", "field": "volume", "description": "Total trade volume during the candle.", "type": "float64", "time": false } ], "series": [ { "key": "1e31218a-e44e-4285-820c-8282ee222035", "entity": { "name": "Bitcoin", "slug": "bitcoin", "symbol": "BTC" }, "points": [ [ 1788998400, 76547.51051673751, 15639703479.254776 ], [ 1789084800, 77193.79460653824, 18539958201.35965 ] ] }, { "key": "21c795f5-1bfd-40c3-858e-e9d7e820c6d0", "entity": { "name": "Ethereum", "slug": "ethereum", "symbol": "ETH" }, "points": [ [ 1788998400, 2436.9544850136367, 8606487184.975586 ], [ 1789084800, 2515.2085560418855, 13665738383.303394 ] ] } ] } } ``` ### Single-series endpoints `GET /query/timeseries/{model}/{granularity}/{seriesKey}` flattens the same structure: `key`, `entity`, `point_schema`, and `points` sit directly on `data`, with no `series` array and no `metadata`. ```json theme={null} // GET /query/timeseries/asset-price/1d/1e31218a-e44e-4285-820c-8282ee222035?timeframe=7d&selections=close,volume (trimmed to two points) { "error": null, "data": { "point_schema": [ { "name": "Time", "field": "time", "description": "Timestamp of the data point.", "type": "time", "time": true }, { "name": "Close Price", "field": "close", "description": "Price at the candle close.", "type": "float64", "unit": "usd", "time": false }, { "name": "Volume", "field": "volume", "description": "Total trade volume during the candle.", "type": "float64", "time": false } ], "key": "1e31218a-e44e-4285-820c-8282ee222035", "entity": { "name": "Bitcoin", "slug": "bitcoin", "symbol": "BTC" }, "points": [ [ 1788998400, 76547.51051673751, 15639703479.254776 ], [ 1789084800, 77193.79460653824, 18539958201.35965 ] ] } } ``` ### Reading points > [!WARNING] > > A point is an array, not an object. The first element is always a **unix timestamp in seconds**; > the values that follow are the metrics in `point_schema` order. Never assume a fixed column > order. Read `point_schema` and index by it. Individual values may be `null` where the underlying data has a gap. ```javascript theme={null} const { point_schema, series } = data; // Skip the leading timestamp entry when mapping metric fields to point indexes. const fields = point_schema.map((column) => column.field); for (const { key, points } of series) { for (const point of points) { const row = { time: new Date(point[0] * 1000) }; fields.slice(1).forEach((field, i) => { row[field] = point[i + 1]; }); console.log(key, row); } } ``` ### point_schema fields | Field | Description | | - | - | | `name` | Human-readable column name. | | `field` | Machine-readable field name; matches the values accepted by `selections`. | | `description` | What the metric measures. | | `type` | Data type, e.g. `time`, `float64`, `int64`. | | `time` | `true` for the leading timestamp column. | | `unit` | What the value is denominated in: `usd`, `btc`, `sats`, `eth`, `gwei`, `native-token`, `percent`, `count`, or `ratio`. Absent for a plain number. | The `entity` object describes what the series key stands for. For asset-keyed models, that is the asset's `name`, `slug`, and `symbol`. Any of these may be `null`. > [!WARNING] > > A series key that matches nothing is not an error. `GET /query/timeseries/blockchains/1d/solana` > returns `200` with `"points": []` and no `entity`, because the key must be the network's > `networkID`, not its slug. See [Finding an id](/api-reference/data-api/discovery/finding-an-id). ## Alternative formats Every data endpoint can return CSV or newline-delimited JSON instead of the envelope. See [Filtering & pagination](/getting-started/filtering-pagination#response-formats). ## Response headers | Header | Description | | - | - | | `Cache-Control` | Derived from the model's freshness, with `stale-while-revalidate`. Gated models are marked `private` so they are never cached at the edge. | | `Cache-Status` | `query-engine-cache; hit` or `query-engine-cache; miss`, reporting whether the query cache served the response. | | `X-Request-Id` | Unique identifier for the request. Include it when contacting support about a specific call. | # Blockworks Docs Source: https://docs.blockworks.com/introduction One account and one API key for institutional-grade crypto data, delivered as a REST API, an event feed, an MCP server, warehouse Datashares, and plugins. Onchain activity, market and asset coverage, protocol and sector fundamentals, and the events moving them, all from one set of warehouse models. Pick the surface that fits how you work: a number is the same number wherever you get it. ![Blockworks warehouse models delivered through five surfaces: Data API, Monitoring, MCP Server, Datashares, and Plugins.](https://mintcdn.com/blockworksdocs/-ENWwrZfsdTblfGI/images/overview/surfaces-light.svg?fit=max\&auto=format\&n=-ENWwrZfsdTblfGI\&q=85\&s=c92f6609b51133e45d8a900108fb9422) ## Products > [card] [Data API](/getting-started/data-api) > > Query assets, protocols, networks, exchanges, and stablecoins: tabular models for > entity and metric lookups, timeseries models for history. > [card] [Monitoring](/api-reference/monitoring/overview) > > Track governance proposals, unlocks, exploits, and funding across the assets and > protocols you cover, by poll or webhook. > [card] [Token Unlocks](/api-reference/token-unlocks/overview) > > Vesting schedules as data: allocations by recipient, dated cliffs, and how much supply > unlocks in any window. > [card] [MCP Server](/mcp/overview) > > Connect Claude, ChatGPT, Cursor, or any MCP-capable agent to Blockworks data with no > retrieval layer of your own. > [card] [Datashares](/datashare/overview) > > The same datasets natively in your warehouse for full-scale SQL, joins against your > own tables, and BI workloads. > [card] [Plugins](/spreadsheets/overview) > > Plugins > Blockworks data inside the tools you already use: Google Sheets and Excel today, with > plugins for ChatGPT and Claude next. > [card] [Data API quickstart](/getting-started/quickstart) > > 5 minutes > Get a key and make your first request. One key covers every product. ## Choosing a surface | What you want | Use | | - | - | | Serve data inside an application, at low latency | [Data API](/getting-started/data-api) | | React to something happening, rather than poll for state | [Monitoring](/api-reference/monitoring/overview) | | Know when locked supply hits the market, and who holds it | [Token Unlocks](/api-reference/token-unlocks/overview) | | Let an agent answer questions against the data | [MCP Server](/mcp/overview) | | Run arbitrary SQL, or join Blockworks data to your own | [Datashares](/datashare/overview) | | Work inside a spreadsheet or an AI assistant | [Plugins](/spreadsheets/overview) | ## What you can build * **Dashboards and terminals**: asset, protocol, and sector screens backed by research-grade metrics rather than scraped aggregates. * **Quant and research pipelines**: reproducible timeseries pulls with explicit granularity and point-in-time semantics, or the full dataset via a Datashare. * **Risk and coverage monitoring**: programmatic alerting on unlocks, governance votes, and security events for the entities you hold or track. * **Agentic workflows**: let an LLM answer questions against live Blockworks data over MCP, without writing a client. * **Supply and unlock analysis**: model vesting schedules and upcoming cliffs across the assets you cover, per recipient and per interval. > [!NOTE] > > One key covers every product. Create and manage keys from > [app.blockworks.com/account/api](https://app.blockworks.com/account/api). # Client Setup Source: https://docs.blockworks.com/mcp/clients Connect Claude, Claude Code, Claude Desktop, Cursor, ChatGPT, or any other MCP client to the Blockworks MCP server. Every client connects to the same hosted endpoint and authenticates through the same browser OAuth flow. Only the place you paste the URL changes. > [card] MCP server URL > > ``` > https://mcp.blockworks.com/mcp > ``` > [tab] Claude > > Add Blockworks as a custom connector in Claude on the web or in the desktop app. > > **1. Open connector settings** > > Go to [claude.ai/settings/connectors](https://claude.ai/settings/connectors). > > **2. Add a custom connector** > > Click **Add custom connector**. > > **3. Enter the server URL** > > Use `https://mcp.blockworks.com/mcp`. > > **4. Connect and authenticate** > > Click **Connect**, then enter your Blockworks API key when the OAuth window prompts you. > > Blockworks then appears in the connectors list for your chats. Enable it in a conversation to let Claude call > its tools. > [tab] Claude Code > > Add the server with one command: > > ```bash theme={null} > claude mcp add --transport http blockworks https://mcp.blockworks.com/mcp > ``` > > By default this registers the server for your user across projects. Add `--scope project` to write it into the > project's `.mcp.json` so your teammates pick it up too. > > Equivalent JSON, if you prefer to edit the config directly: > > ```json .mcp.json theme={null} > { > "mcpServers": { > "blockworks": { > "type": "http", > "url": "https://mcp.blockworks.com/mcp" > } > } > } > ``` > > Then, inside Claude Code: > > * Run `/mcp` to see the server and start the browser OAuth flow if it has not run yet. > > * Confirm the server shows as connected and its tools are listed. > > > [!TIP] > > > > `claude mcp list` shows every configured server and its connection state, which is useful for confirming > > the entry landed in the scope you expected. > [tab] Claude Desktop > > Claude Desktop connects to hosted servers through the same custom connector mechanism as claude.ai. > > **1. Open settings** > > In Claude Desktop, open **Settings** and go to **Connectors**. > > **2. Add a custom connector** > > Click **Add custom connector** and enter `https://mcp.blockworks.com/mcp`. > > **3. Authenticate** > > Click **Connect** and enter your Blockworks API key in the browser window that opens. > > > [!NOTE] > > > > Custom connectors are the supported path for remote servers. The `claude_desktop_config.json` file is for > > local `stdio` servers and is not the right place for a hosted HTTP endpoint. > [tab] Cursor > > Add Blockworks to your Cursor MCP configuration: `~/.cursor/mcp.json` for every project, or `.cursor/mcp.json` > inside a single project: > > ```json .cursor/mcp.json theme={null} > { > "mcpServers": { > "blockworks": { > "url": "https://mcp.blockworks.com/mcp" > } > } > } > ``` > > Reload Cursor, open **Settings** and then **MCP**, and confirm the server is listed. Click through the OAuth prompt and > enter your Blockworks API key when asked. > [tab] ChatGPT > > > [!TIP] > > > > The easiest way to connect ChatGPT is the [Blockworks plugin](/mcp/plugins/chatgpt) in the > > ChatGPT plugin directory: one click to install, then authorize with your API key. The > > steps below are for creating the connection by hand. > > ChatGPT also reaches remote MCP servers through developer-mode connectors. > > **1. Open connector settings** > > Go to [chatgpt.com/admin/ca#available](https://chatgpt.com/admin/ca#available). > > **2. Enable developer mode** > > Turn on developer mode so custom connectors can be created. > > **3. Create the connector** > > Click **Create**. > > **4. Enter the server URL** > > Use `https://mcp.blockworks.com/mcp`. > > **5. Leave authentication as OAuth** > > Do not switch to another authentication type, because the server uses OAuth. > > **6. Create and authenticate** > > Click **Create**, then enter your Blockworks API key when prompted. > > > [!NOTE] > > > > Developer-mode connectors may be restricted by your workspace administrator. If the option is missing, ask > > your ChatGPT workspace admin to enable it. > [tab] Other clients > > Any MCP client that supports remote servers can connect with: > > * **URL**: `https://mcp.blockworks.com/mcp` > * **Transport**: HTTP > * **Authentication**: OAuth 2.0, handled by the client > > Most clients use the same config shape: > > ```json theme={null} > { > "mcpServers": { > "blockworks": { > "type": "http", > "url": "https://mcp.blockworks.com/mcp" > } > } > } > ``` > > Some clients omit `type` and infer the transport from the URL. If yours rejects the field, drop it and keep > `url`. > > > [!WARNING] > > > > Clients that only support local `stdio` servers cannot connect to a hosted URL directly. You need a client > > with remote server and OAuth 2.0 support. ## Verify the connection Whichever client you used, confirm the tools actually loaded before you rely on an answer: ```text theme={null} What Blockworks tools do you have available? ``` If the assistant lists Blockworks tools, you are connected. If it lists none, or answers from general knowledge instead of calling a tool, work through [Troubleshooting](/mcp/troubleshooting). # Overview Source: https://docs.blockworks.com/mcp/overview A fully hosted Model Context Protocol server that connects AI assistants, agent frameworks, and your own products to Blockworks onchain data and crypto intelligence. Blockworks MCP is a fully hosted [Model Context Protocol](https://modelcontextprotocol.io) server. It gives AI assistants and agents (Claude, Claude Code, Cursor, ChatGPT, or anything else that speaks MCP) direct access to Blockworks market data, onchain metrics, and crypto research. Unlike MCP servers that ship as a local package, there is nothing to install or run. You add one URL to your client and authenticate in the browser with your Blockworks API key. If you use ChatGPT, you do not even need the URL: install the [Blockworks plugin](/mcp/plugins/chatgpt) from the ChatGPT plugin directory and authorize it with your API key. It is also the recommended way to build a product on Blockworks data, not just to equip an assistant you use yourself. See [Building on MCP](#building-on-mcp) below. > [card] MCP server URL > > ``` > https://mcp.blockworks.com/mcp > ``` ## Key benefits > [card] Zero installation > > No npm, no npx, no local dependencies or runtime to keep alive. Add a URL to your MCP client and you are done. > [card] OAuth with your API key > > Browser-based OAuth using your Blockworks API key. Your key is never pasted into a config file on disk. > [card] Always up to date > > Hosted infrastructure, so every client picks up new datasets and capabilities without an upgrade step. > [card] Works with any MCP client > > Any client that supports remote MCP servers over HTTP with OAuth 2.0 can connect to the same URL. ## What your assistant can reach The server exposes Blockworks data as tools your assistant calls on demand. It decides which data to pull from a natural-language question, then returns structured results it can reason over. > [card] Market data > > Prices, volumes, and market caps across tens of thousands of assets. > [card] Onchain metrics > > TVL, active addresses, fees, revenue, and transaction activity for major networks and protocols. > [card] Timeseries > > Historical and current metric series with configurable ranges and granularities across a large dataset catalog. > [card] Fundraising > > Funding rounds, M\&A activity, investors, and company valuations. > [card] Token unlocks > > Vesting schedules, allocation breakdowns, and upcoming unlock events. > [card] News and research > > Aggregated news plus Blockworks research reports, diligence, and quarterly reviews. ## The tools The tools include one that retrieves documents, two catalog-and-read pairs over the Blockworks data models, and one that reports problems. | Tool | Purpose | | - | - | | `search_documents` | Search research, news, and curated sources for relevant documents | | `tabular_catalog` | List the tabular models, or describe one in full: columns, filters, sort options | | `tabular_data` | Read rows from one tabular model, filtered, sorted, and paginated | | `timeseries_catalog` | List the timeseries models, or describe one in full: metrics and granularities | | `timeseries_data` | Read points from one timeseries model over a time window | | `submit_feedback` | Report a bug or gap hit while using Blockworks data | The dataset tools are catalog-driven: the catalog call returns the exact model slug, field names, and operators, and the read call accepts nothing that does not match it. That is the same [discover-then-query](/getting-started/concepts/catalog) model the REST API uses, over the same models. > [card] [Tools reference](/mcp/tools/overview) > > What each tool does, how they compose, and example phrasing for each. > [!NOTE] > > The catalogs list only the models Blockworks publishes to the public API, and which of those your assistant can > actually read depends on what your API key is entitled to. ## How it works 1. You add `https://mcp.blockworks.com/mcp` to your MCP client. 2. The client discovers that the server requires authentication and opens a browser window. 3. You authenticate with your Blockworks API key. The client stores the resulting OAuth credentials, not the key. 4. Your assistant lists the available tools and can start answering questions with Blockworks data. ## Building on MCP MCP is not only for chat windows on your own machine. The same hosted server is the recommended way to build a chat experience or an agent product over crypto data: your backend connects to `https://mcp.blockworks.com/mcp` as an MCP client and hands the Blockworks tools to whatever model you are running. Anything that speaks MCP server-side can do this, including the Anthropic and OpenAI SDKs, the Vercel AI SDK, and agent frameworks such as LangChain. Each has its own way of registering a remote MCP server, so follow that framework's documentation for the wiring; the Blockworks side is the same URL and the same tools described on this page. What stays yours in this setup: * **The model.** Pick any provider and any model, and change it without changing your data layer. * **The prompts and the orchestration.** System prompts, tool-choice policy, retries, multi-step planning, and anything else in your agent loop. * **The product surface.** Streaming, UI, session state, and how you render tool results and sources. Blockworks supplies the data layer: document search, dataset queries, and the timeseries catalog and lookups listed above. ## Requirements * A Blockworks API key from [app.blockworks.com/account/api](https://app.blockworks.com/account/api). * An MCP client that supports **remote** servers over HTTP with OAuth 2.0. Clients that only support local `stdio` servers cannot connect directly. * Outbound network access to `https://mcp.blockworks.com`. ## Next steps > [card] [Quickstart](/mcp/quickstart) > > Connect a client and run your first prompt. > [card] [Client setup](/mcp/clients) > > Step-by-step configuration for each MCP client. > [card] [What to ask](/mcp/prompts) > > Example prompts that play to the server's strengths. # ChatGPT Source: https://docs.blockworks.com/mcp/plugins/chatgpt Install the Blockworks plugin for ChatGPT and ask questions against Blockworks market, onchain, and research data without leaving the chat. The Blockworks plugin for ChatGPT brings market data, fundamentals, research, news, signals, events, and fundraising data into your ChatGPT conversations. Install it from the ChatGPT plugin directory, authorize it once with your Blockworks API key, and ChatGPT can pull Blockworks data whenever a question calls for it. The plugin is the Blockworks MCP server packaged for ChatGPT's plugin directory. It answers from the same datasets and the same [tools](/mcp/tools/overview) as any other MCP client, but there is no server URL to paste and no developer mode to enable. If you would rather create the connection by hand, see the ChatGPT tab in [Client setup](/mcp/clients). ## What you need * A ChatGPT account with access to plugins. * A Blockworks API key. Generate or view yours at [app.blockworks.com/account/api](https://app.blockworks.com/account/api). ## Installation **1. Find the plugin** In ChatGPT, open the plugin directory (the **Plugins** button below the composer, or **Plugins** in settings) and search for **Blockworks**. ![Searching the ChatGPT plugin directory for Blockworks](https://mintcdn.com/blockworksdocs/aThYhUyT6Aci79lx/images/mcp/chatgpt-search.png?fit=max\&auto=format\&n=aThYhUyT6Aci79lx\&q=85\&s=fecc89cef0038221ce8840aeded85c20) **2. Install it** Open the listing and click **Install plugin**. ![The Blockworks plugin listing with the Install plugin button](https://mintcdn.com/blockworksdocs/ecN3mgnll8dMWTWd/images/mcp/chatgpt-install.webp?fit=max\&auto=format\&n=ecN3mgnll8dMWTWd\&q=85\&s=220b3ead3f6ab9c4fe1c855effb52621) **3. Authorize with your API key** ChatGPT opens a Blockworks authorization page. Paste your API key and click **Authorize**. The key is sent to Blockworks only, and ChatGPT stores the resulting credentials so you do not have to repeat this step. ![The Connect to Blockworks page asking for an API key](https://mintcdn.com/blockworksdocs/ecN3mgnll8dMWTWd/images/mcp/chatgpt-authorize.png?fit=max\&auto=format\&n=ecN3mgnll8dMWTWd\&q=85\&s=fe59a6f6c7ab8df1d3ed9fca6e2dce25) **4. Confirm it is connected** Back in ChatGPT the listing shows **Blockworks plugin installed**, with a **Try in chat** button and a few example prompts to start from. ![The plugin listing after installation, showing example prompts](https://mintcdn.com/blockworksdocs/ecN3mgnll8dMWTWd/images/mcp/chatgpt-installed.webp?fit=max\&auto=format\&n=ecN3mgnll8dMWTWd\&q=85\&s=087e56dda2680d565d50a8496275e63a) ## Using the plugin Once installed, ChatGPT calls the plugin on its own when a question needs Blockworks data. To make sure a request goes to Blockworks, type `@` in the composer and pick **Blockworks** from the list, then write your question. ![Selecting the Blockworks plugin with an @ mention in the composer](https://mintcdn.com/blockworksdocs/ecN3mgnll8dMWTWd/images/mcp/chatgpt-mention.png?fit=max\&auto=format\&n=ecN3mgnll8dMWTWd\&q=85\&s=f9e6892c602b3bae3c6947af4eaaac42) Ask the kind of question you would ask an analyst. ChatGPT works out which datasets to query, fetches the series, and does the arithmetic: ![A ChatGPT answer comparing Ethereum and Solana activity in a table](https://mintcdn.com/blockworksdocs/aThYhUyT6Aci79lx/images/mcp/chatgpt-result.png?fit=max\&auto=format\&n=aThYhUyT6Aci79lx\&q=85\&s=72a30cba2d396868247e47fb6e17dd23) Prompts that work well: * Compare Ethereum and Solana on daily active addresses, fees, and transaction counts over the last 90 days. Put it in a table. * What are the most important developments for Ethereum in the past week? Summarize with sources. * What is Solana's fully diluted valuation compared to its circulating market cap? For more prompt patterns, and how to steer the assistant toward the right dataset, see [Prompt guide](/mcp/prompts). ## Access to data Which datasets the plugin can query is determined by your organization's API permissions. If ChatGPT reports that a metric or dataset is unavailable, check the APIs enabled for your key at [app.blockworks.com/account/api](https://app.blockworks.com/account/api). ## Troubleshooting * **Authorization failed or expired.** Remove the Blockworks plugin in ChatGPT, then install it again and enter your key. Reinstalling is what clears the stored credentials. * **ChatGPT answers without using the plugin.** Add an `@Blockworks` mention to the prompt, or name the metric and entity explicitly. * **Your workspace does not show the plugin.** Plugin installs can be restricted by a ChatGPT workspace administrator. Ask your admin to allow it, or connect through a developer-mode connector as described in [Client setup](/mcp/clients). Anything that applies to the MCP server also applies here, so the [MCP troubleshooting](/mcp/troubleshooting) page covers the rest. # What to Ask Source: https://docs.blockworks.com/mcp/prompts Example prompts for an assistant connected to the Blockworks MCP server, grouped by use case. Once the server is connected, you talk to your assistant normally, and it decides which Blockworks tools to call. The prompts below are patterns that work well, grouped by what you are trying to do. Swap in the assets, protocols, and timeframes you care about. If you want to know which tool a given prompt is likely to reach for (document search, the tabular pair, or the timeseries pair), see the [tools reference](/mcp/tools/overview). ## Market data lookups Point lookups where you want a current number, not a narrative. ```text theme={null} What is Bitcoin's current price and 24h trading volume? ``` ```text theme={null} Show me the top 10 assets by market cap, with 7-day price change for each. ``` ```text theme={null} What is Solana's fully diluted valuation compared to its circulating market cap? ``` ## Protocol and network research Questions that need context assembled from several data sources. ```text theme={null} Give me an overview of Uniswap: what it does, who is behind it, and how its usage has trended over the past year. ``` ```text theme={null} What is Aave's TVL today, and how has it changed over the last 6 months? ``` ```text theme={null} Who invested in Arbitrum, and at what valuations? ``` ```text theme={null} When is the next ARB token unlock, and how large is it relative to circulating supply? ``` ## Screening and comparison Ask for a set rather than a single fact, and say what to rank on. ```text theme={null} Compare Ethereum and Solana on daily active addresses, fees, and transaction counts over the last 90 days. Put it in a table. ``` ```text theme={null} Which layer-1 networks grew fees the most quarter over quarter? Show the top five with the percentage change. ``` ```text theme={null} List DeFi protocols with more than $1B in TVL, sorted by 30-day TVL change. ``` ## Monitoring and news Catch-up prompts and recurring checks. ```text theme={null} What are the most important developments for Ethereum in the past week? Summarize with sources. ``` ```text theme={null} Summarize crypto fundraising activity this month: rounds, sizes, and the most active investors. ``` ```text theme={null} Build me a Monday morning briefing on my watchlist (BTC, ETH, SOL, and ARB) covering price action, onchain activity, and any notable news. ``` ## Getting better answers > [!TIP] > > For complex or multi-part questions, ask several focused questions instead of one loaded one. Single-topic > requests usually come back with more depth and fewer gaps. Quantitative questions work best when you state: * **The metric**: "TVL", "market cap", "24h trading volume", "daily active addresses". * **The entity**: the asset, protocol, or network by name. * **The timeframe**: "last 30 days", "YTD", "since the merge". * **The baseline**, if you are comparing: "vs last month", "vs Ethereum". A few habits that pay off: * **Ask for the shape of the output.** "As a table", "as a bulleted summary", "with the raw numbers" all work. * **Ask what is available first.** "What Blockworks datasets cover DeFi protocols?" makes the assistant read the catalog, which tells you what is queryable before you write a more specific prompt. * **Name concrete dates for time-sensitive questions.** "The week of March 10" retrieves a sharper set of documents than "latest". * **Give research questions time.** Dataset reads come back quickly, but a document search runs an agent over the corpus and can take a while; a slow answer is usually still on its way. * **Ask it to cite what it pulled.** Requesting the source or the underlying figures makes it easy to spot when an answer came from the model's own knowledge instead of from Blockworks data. * **Follow up rather than restart.** The assistant keeps the earlier results in context, so "now break that out by chain" is cheaper and more accurate than a fresh, longer prompt. # MCP Quickstart Source: https://docs.blockworks.com/mcp/quickstart Connect an AI assistant to the Blockworks MCP server and run your first prompt in a few minutes. This page takes you from nothing to an assistant answering questions with Blockworks data. Setup is the same for every client: one URL, one browser sign-in. **1. Get an API key** Sign in at [app.blockworks.com/account/api](https://app.blockworks.com/account/api) and copy an API key. You need the key only once, during the OAuth step below. It is not stored in any config file on your machine. **2. Add the server to your client** Point your MCP client at the hosted server URL: ``` https://mcp.blockworks.com/mcp ``` In Claude Code, that is a single command: ```bash theme={null} claude mcp add --transport http blockworks https://mcp.blockworks.com/mcp ``` Every other client is a settings screen or a small JSON block. See [Client setup](/mcp/clients) for the exact steps for Claude, Claude Desktop, Cursor, ChatGPT, and generic MCP clients. **3. Authenticate in the browser** The first time your client connects, it detects that the server requires authentication and opens a browser window. Enter your Blockworks API key there to complete the OAuth flow. Your client stores the resulting OAuth credentials and reuses them on later connections, so you only do this once per client. > [!NOTE] > > If no browser window appears, check that popups are not blocked and that your client supports remote MCP > servers with OAuth 2.0. See [Troubleshooting](/mcp/troubleshooting). **4. Confirm the tools are loaded** Ask your assistant: ```text theme={null} What Blockworks tools do you have available? ``` It should list the Blockworks tools it can call. The [tools reference](/mcp/tools/overview) has the current list and what each one does. If the list is empty, the connection or the OAuth step did not complete. Reconnect the server and try again. **5. Run your first prompt** Try a lookup that clearly needs live data: ```text theme={null} What is Bitcoin's current price and 24h trading volume? ``` Then something with more shape to it: ```text theme={null} Compare Ethereum and Solana daily active addresses over the last 90 days, and summarize what changed. ``` Your assistant should call a Blockworks tool and answer from the returned data rather than from memory. ## Where to go next > [card] [Client setup](/mcp/clients) > > Per-client configuration, including JSON config formats. > [card] [What to ask](/mcp/prompts) > > Prompt patterns that get the best results. > [card] [Troubleshooting](/mcp/troubleshooting) > > Auth loops, invalid keys, and stale credentials. # Tabular Datasets Source: https://docs.blockworks.com/mcp/tools/datasets tabular_catalog and tabular_data browse the row-and-column models, then read rows with filters, sorting, and pagination. Two tools cover tabular data, and they are meant to be used in order: the assistant discovers what exists, then reads it. | Tool | Purpose | | - | - | | `tabular_catalog` | List the tabular models, or describe one in full: every column, its type, and the filters it accepts | | `tabular_data` | Read rows from one model, filtered, sorted, and paginated | Tabular models are row-and-column datasets (assets, exchanges, funding rounds, funds, ETF holdings) that answer *what is true right now*. For metrics observed over time, use the [timeseries tools](/mcp/tools/timeseries); for questions whose answer is written down rather than computed, start with [`search_documents`](/mcp/tools/search). These tools are a thin layer over the REST [Data API](/getting-started/concepts/catalog): the same models, the same field names, the same filter operators. Anything documented for [filtering and pagination](/getting-started/filtering-pagination) applies here too. ## The workflow **1. The assistant discovers what is queryable** `tabular_catalog` with no arguments returns one compact entry per model: `slug`, `name`, `description`, `access`, and `columnCount`. Passing `search` narrows that list by a case-insensitive substring match on the name, slug, and description. Passing a `model` slug instead returns that one model in full, including every column: | Field | What it is | | - | - | | `name`, `field` | The display name and the exact field name to use in `tabular_data` | | `description` | What the column holds | | `type`, `unit` | The column's data type and unit, where it has one | | `primaryKey` | Whether the column identifies the row | | `sortable`, `defaultSort` | Whether it can be sorted on, and whether it is the model's default sort | | `filters` | The exact operators this column accepts | You can trigger this step explicitly: ```text theme={null} What Blockworks tabular datasets are available for funding rounds? ``` ```text theme={null} Which columns can I filter on in the assets ranking dataset? ``` **2. The assistant reads the rows** With a model identified, `tabular_data` reads it. Its arguments map onto the catalog exactly: | Argument | What it does | | - | - | | `model` | The model slug, exactly as the catalog returns it. Required | | `selections` | Which column fields to return. Omit for every column | | `filters` | Conditions of the form `{field, operator, values}`, combined with AND | | `sortBy`, `sortDirection` | A sortable column field, and `asc` (default) or `desc` | | `page`, `pageSize` | 1-based page number, and rows per page: 25 by default, 200 at most | ```text theme={null} Show me the top 10 assets by market cap. ``` ```text theme={null} List DeFi protocols with more than $1B in TVL, sorted by 30-day TVL change. ``` ```text theme={null} Which funding rounds closed above $50M this year, and who led them? ``` ## Filters A filter is an object of the form `{field, operator, values}`, and multiple filters combine with AND. A column only accepts the operators its catalog entry lists: | Operator | Meaning | | - | - | | `Eq`, `NotEq` | Equals, does not equal | | `Gt`, `Gte`, `Lt`, `Lte` | Numeric and time comparisons | | `IsOneOf`, `IsNotOneOf` | Value is, or is not, in the list | | `Contains` | Case-insensitive substring match | | `Includes`, `NotIncludes` | An array column contains, or does not contain, this element | | `IncludesAnyOf`, `NotIncludesAnyOf` | An array column contains at least one of these, or none of them | Values are written as strings and coerced to the column's type. Filters on a time column accept `YYYY-MM-DD`, RFC3339, or unix seconds. The full operator reference, including which operators each column type supports, is on [Filtering & Pagination](/getting-started/filtering-pagination). ## What comes back `tabular_data` returns one page of rows plus the totals for the whole filtered set: | Field | What it is | | - | - | | `model` | The model that was read | | `rows` | The page of rows, as objects keyed by field name | | `totalRows`, `totalPages` | The size of the whole filtered set, not of this page | | `page`, `pageSize` | The page that was returned, and how many rows it holds | Because `totalRows` describes the whole filtered set, it is how you tell a complete answer from a first page. If a result looks short, check it before concluding the data is thin. > [!NOTE] > > The MCP tools cap a read more tightly than the REST API does, because every row returned is spent from the > assistant's context window: 25 rows by default and 200 at most, against the REST API's 100 and 1000. A larger > `pageSize` is clamped to 200 rather than rejected. To answer a question about a large model, filter and sort > rather than paging through it. ## Best practices * **Name the entity precisely.** "Uniswap v4" and "Uniswap" resolve to different rows. * **Say what to rank on.** "Sorted by 30-day TVL change" removes a guess that a bare "top protocols" leaves open. * **State the filter you mean.** "Above \$1B in TVL" becomes a server-side filter; "the big ones" does not. * **Ask what is available first** when you are scoping work: "what tabular datasets cover DeFi protocols?" tells you what is queryable before you commit to a specific prompt. > [!TIP] > > Tabular models are also where series keys come from. If you want a metric over time for a named asset, the > assistant reads the identifier out of the matching tabular model first, then hands it to > [`timeseries_data`](/mcp/tools/timeseries) as a series key. ## When to use something else * The answer is written down rather than computed. Use [`search_documents`](/mcp/tools/search). * You want a metric over time at a stated granularity. Use the [timeseries tools](/mcp/tools/timeseries). > [!NOTE] > > `tabular_catalog` lists only the models Blockworks publishes to the public API. Within that list, reading a model > still depends on your key's entitlements, so "that data is not available" may be an entitlements boundary rather > than a gap in coverage. # Feedback Source: https://docs.blockworks.com/mcp/tools/feedback submit_feedback lets your assistant report a bug or gap it hit while using Blockworks data, with the request it made and the request IDs involved. `submit_feedback` is the one tool that writes. When your assistant hits an error, an empty or surprising result, missing data, or unclear docs, or has to invent a workaround, it can report it to Blockworks with this tool. Every other tool's errors end with a pointer to it: ```text theme={null} Error: tabular model "asset-marketcaps" not found (request ID b720c036-b584-4596-92fb-bacdb79e09ba) If this result looks wrong or incomplete, report it with submit_feedback. ``` The tool sends the same report as the REST [Submit Feedback](/api-reference/feedback/submit) endpoint, and both land in the same place. ## When it is called Once per distinct issue, after the assistant has resolved it or given up, so the report can say what it tried and any workaround that worked. You can also ask for it directly: "Report that to Blockworks." ## Arguments | Argument | Required | What it is | | - | - | - | | `category` | Yes | `bug` (something failed or returned wrong results), `data_quality` (data that is missing, stale, or wrong), or `feature_request` (data or a capability that was needed and not found) | | `message` | Yes | What happened, what was expected, what was tried, and any workaround. Up to 4,000 characters | | `tool` | No | The tool the report is about, such as `tabular_data` | | `endpoint` | No | The REST endpoint the report is about, if any | | `request` | No | The exact request: the tool arguments as JSON, or the URL. Up to 2 KB | | `agent` | No | The agent or client sending the report | Text over a limit is cut rather than rejected. ## What comes back | Field | What it is | | - | - | | `feedback_id` | The submission's ID. Quote it if you follow up | | `truncated` | `true` when a field was longer than its limit and was cut | ## What is stored The report is attributed to your account, whether you connected with an API key or by signing in, so leave out personal or sensitive data from the conversation. Submissions are free and do not count against usage. Each user can send up to 60 an hour; past that, the tool returns a `RATE_LIMITED` error and the rest can wait. # Tools Reference Source: https://docs.blockworks.com/mcp/tools/overview Every tool the Blockworks MCP server exposes, what each one is for, and which to reach for first. The MCP server's tools include one that retrieves documents, two catalog-and-read pairs over the Blockworks data models, a set that reads the monitoring feed, and one that reports problems. Your assistant picks between them on its own, but knowing what they do tells you how to phrase a request, and explains why one question comes back in seconds while another takes minutes. ## All tools | Tool | Purpose | | - | - | | [`search_documents`](/mcp/tools/search) | Search research, news, and curated sources for documents relevant to a question | | [`tabular_catalog`](/mcp/tools/datasets) | List the tabular models, or describe one in full: columns, filters, sort options | | [`tabular_data`](/mcp/tools/datasets) | Read rows from one tabular model, filtered, sorted, and paginated | | [`timeseries_catalog`](/mcp/tools/timeseries) | List the timeseries models, or describe one in full: metrics, granularities, series rules | | [`timeseries_data`](/mcp/tools/timeseries) | Read points from one timeseries model over a time window | | [`submit_feedback`](/mcp/tools/feedback) | Report a bug or gap hit while using Blockworks data | | `monitoring_categories` | List the monitoring taxonomy: the category slugs the other monitoring tools filter on | | `monitoring_developments` | Read developments, either ad hoc or as one monitoring view's matched set | | `monitoring_events` | Read events, either ad hoc or as one monitoring view's matched set | | `monitoring_views` | List the saved monitoring views, or read one by id | | `watchlist_assets` | Read one watchlist and the assets on it, each resolved to its name, slug and ticker symbol | | `watchlists` | List this user's watchlists: the named sets of assets they keep on Messari | > [!NOTE] > > Whatever your client lists is authoritative. If a name here does not match what you see, use the one your client > shows and let us know. ## Discover, then read The four dataset tools are two pairs, and each pair is meant to be used in order. A catalog call returns the exact model slug, the exact field names, and the operators or granularities that model accepts; the read call then rejects anything that does not match the catalog exactly. That is the same discover-then-query model the REST [Data API](/getting-started/concepts/catalog) uses, backed by the same catalog. ```mermaid theme={null} flowchart LR Q["Your question"] --> S["search_documents"] Q --> TC["tabular_catalog"] Q --> SC["timeseries_catalog"] TC --> TD["tabular_data"] SC --> SD["timeseries_data"] TD -. "row id becomes a series key" .-> SD ``` In practice you rarely drive the two steps separately. You ask the question and the assistant runs the catalog lookup first on its own. Asking the discovery question explicitly is useful when you want to know what is available before committing to an analysis. ## By category > [card] [Document search](/mcp/tools/search) > > `search_documents` searches research, news, and curated sources, returning documents with their content, > links, and publication dates. > [card] [Tabular datasets](/mcp/tools/datasets) > > `tabular_catalog` and `tabular_data` browse the row-and-column models, then read rows with filters, sorting, > and pagination. > [card] [Timeseries](/mcp/tools/timeseries) > > `timeseries_catalog` and `timeseries_data` find a metric series, then pull its points at a granularity over a > window. > [card] [Feedback](/mcp/tools/feedback) > > `submit_feedback` reports a bug or gap to Blockworks, with the request and request IDs involved. ## Where to start * **Qualitative and research questions: `search_documents`.** What a protocol does, what changed in a launch, how an event played out, what has been published on a theme. The answer comes back as documents the assistant can read and cite. * **Anything true right now: the tabular pair.** A price, a ranking, a TVL figure, a funding round, an unlock schedule. `tabular_catalog` resolves the model and its columns, then `tabular_data` returns the matching rows. * **Anything that changes over time: the timeseries pair.** A named metric, at a specific granularity, over an exact window. `timeseries_catalog` tells the assistant what exists and `timeseries_data` fetches the points. * **When something goes wrong: `submit_feedback`.** Every other tool's errors end with a pointer to it, so the assistant can report an error, a surprising result, or missing data with the request that caused it. The split between the two pairs is the same one the REST API draws; see [Tabular vs Timeseries](/getting-started/concepts/tabular-vs-timeseries) for the full model. > [!NOTE] > > The catalogs list only the models Blockworks publishes to the public API. Within that list, which models you can > actually read follows your API key's entitlements, so a listed model can still return an access error. ## Next steps > [card] [What to ask](/mcp/prompts) > > Prompt patterns grouped by use case. > [card] [Troubleshooting](/mcp/troubleshooting) > > Missing tools, auth loops, and empty results. # Document Search Source: https://docs.blockworks.com/mcp/tools/search search_documents finds research, news, and curated source documents relevant to a question, with the content and citations attached. `search_documents` is the qualitative tool. Your assistant hands it a question in plain language, and it searches research, news, and curated sources for the documents relevant to that question, then returns the documents themselves. **It retrieves; it does not write the answer.** Your assistant reads the documents and answers from them. That is why a result is a document set rather than a paragraph, and why you can always ask which document a claim rests on. Reach for it when the answer is written down somewhere rather than sitting in a table: what a protocol does, what changed in a launch, how an event played out, what has been published on a theme. ## What comes back `sources` holds the retrieved documents. Each one carries: | Field | What it is | | - | - | | `domain` | Where the document came from. Values include `research`, `news`, `external_news`, `diligence`, `governance`, `twitter`, and `video_transcript`, among others | | `title` | The document title | | `url` | A link back to the original | | `content` | The document text your assistant reads and quotes from | | `published_at` | When it was published, on the domains that carry a date | `error` is set only when a run finds no usable document, and explains why. Because `url` and `published_at` travel with every document, you can ask your assistant to cite what it used and verify an answer is grounded in a real source rather than in the model's own knowledge. ## Example queries Phrase these to your assistant directly, and it decides to call the tool. ### Concepts and protocols ```text theme={null} What is EigenLayer restaking? ``` ```text theme={null} Explain Uniswap v4's new features. ``` ### News and events ```text theme={null} Latest news about Ethereum. ``` ```text theme={null} What happened with FTX? ``` ### Market and sector coverage ```text theme={null} Recent DeFi funding rounds this month. ``` The last two work, but they are exactly the phrasings the Tip below improves on. Swapping "latest" and "this month" for the dates you actually mean narrows the document set considerably. ## Best practices > [!TIP] > > The corpus spans years, and the search reads the time window out of your wording. Name concrete dates whenever the > question is time-sensitive: "in August 2026" or "since 2026-08-01", not "latest" or "recently". A query with no > date returns the best matches from the whole corpus, most of which will be old. * **Ask one thing at a time.** Several focused searches usually beat one loaded question. * **Name the entity precisely.** "Uniswap v4" and "Uniswap" pull different documents. * **Ask for sources.** Requesting the URLs makes it obvious which documents an answer rests on. ## When to use something else * You want a number that is true right now, such as a price, a ranking, or a TVL figure. Use the [tabular tools](/mcp/tools/datasets). * You want a numeric series at a stated granularity over an exact window. Use the [timeseries tools](/mcp/tools/timeseries). > [!NOTE] > > Which sources your key can reach follows its entitlements. If a search comes back thin, the material may sit > outside what your key covers rather than outside the platform. More prompt patterns, grouped by use case, are on [What to ask](/mcp/prompts). # Timeseries Source: https://docs.blockworks.com/mcp/tools/timeseries timeseries_catalog and timeseries_data let you discover what metric series exist, then pull the exact data points at the granularity and window you want. Two tools cover timeseries, and like the tabular pair they are meant to be used in order: the assistant discovers what exists, then reads it. | Tool | Purpose | | - | - | | `timeseries_catalog` | List the timeseries models, or describe one in full: metrics, granularities, and series rules | | `timeseries_data` | Read points from one model, for chosen series, at a granularity, over a window | Timeseries models are metrics observed over time (prices, supply, revenue, volumes, mindshare) split into named series, usually one per asset, protocol, exchange, or sector. Reach for these when you want the actual numbers rather than a single current figure; for *what is true right now*, the [tabular tools](/mcp/tools/datasets) are the shorter path, and for qualitative questions start with [`search_documents`](/mcp/tools/search). This is the same discover-then-query model the REST [Data API](/getting-started/concepts/catalog) uses, backed by the same catalog. ## The workflow **1. The assistant discovers what is queryable** `timeseries_catalog` with no arguments returns one compact entry per model: `slug`, `name`, `description`, `access`, `metricCount`, the `intervals` it supports, and `allowAllSeries`. Passing `search` narrows the list by a case-insensitive substring match on name, slug, and description. Passing a `model` slug returns that model in full, including every metric column with its `field`, `type`, `unit`, and whether it is the leading time column or the series key. Two fields decide how the read is shaped: * **`intervals`** are the granularities the model supports, such as `1h`, `1d`, `1w`. * **`allowAllSeries`** says whether the model can return every series at once. When it is false, the assistant must name the series keys it wants. You can trigger this step explicitly: ```text theme={null} What Blockworks timeseries datasets are available for DeFi protocols? ``` ```text theme={null} Which granularities does the asset price dataset support? ``` **2. The assistant reads the points** With a model identified, `timeseries_data` reads it: | Argument | What it does | | - | - | | `model` | The model slug, exactly as the catalog returns it. Required | | `granularity` | One of the model's intervals. Defaults to `1d` | | `series` | The series keys to read, at most 10. Omit only on models with `allowAllSeries` | | `selections` | Which metric fields each point carries. Omit for every metric | | `timeframe` | A relative or calendar window. Defaults to `90d` | | `start`, `end` | An explicit window instead of `timeframe`. Never both | | `bounds` | Return only the first and last point of the window for each series | ```text theme={null} What is Bitcoin's daily price over the last 90 days? ``` ```text theme={null} Show me Ethereum's weekly active addresses for the past year. ``` ```text theme={null} Compare daily trading volumes for Bitcoin and Solana this quarter. ``` In practice you rarely drive the two steps separately. You ask the second kind of question and the assistant runs the catalog lookup first on its own. Asking the discovery question explicitly is useful when you want to know what is available before committing to an analysis. ## Series keys Series keys are the model's own identifiers, and they are usually opaque ids rather than tickers or names. To turn a name or a symbol into a series key, the assistant reads the matching tabular model with [`tabular_data`](/mcp/tools/datasets) and takes the identifier from the matching row. You do not have to ask for that step; naming the asset precisely is what makes it resolve cleanly. ## Granularity and time ranges A request always settles two things: the resolution of the series and the window it covers. Coarser granularities cover longer histories in fewer points; finer ones give you intraday shape at the cost of volume. If an assistant returns a series at a resolution you did not want, say so explicitly ("hourly, not daily") and it will re-query. Choose the window with either `timeframe` or `start`/`end`, never both: * **Relative**: `30d`, `12h`, `4w`, or `ytd`, `qtd`, `mtd`, `dtd`. * **Calendar**: a bare year (`2026`), a month (`2026-06`), or a day (`2026-06-01`) selects that whole period. * **Explicit**: `start` is inclusive, `end` is exclusive, and both accept `YYYY-MM-DD`, RFC3339, or unix seconds. `end` defaults to now. With none of them, the window defaults to **the last 90 days**, so an unqualified question does not pull a model's whole history. The same resolution and window model is documented in full for the REST API on [Granularity and time ranges](/getting-started/concepts/granularity). ## What comes back | Field | What it is | | - | - | | `model`, `granularity` | The model read, and the resolution it was read at | | `point_schema` | What each position of a point array means, in order | | `series` | One entry per series: its `key`, the `entity` it identifies where the model maps one, and its `points` | | `totalPoints` | How many points the call returned across all series | Points are positional arrays rather than objects: position 0 is a unix timestamp in seconds, and the remaining positions follow `point_schema` in order. That is why `point_schema` has to be read before any point is interpreted, and it is the same compact shape the REST API returns. > [!NOTE] > > One call returns at most **10 series** and **5000 points**, and a read that exceeds either is rejected rather > than truncated, so a partial series is never passed off as a complete one. If that happens, shorten the > timeframe, use a coarser granularity, name fewer series, select fewer metrics, or set `bounds` to get only the > window's first and last point. > [!TIP] > > `bounds` is the cheap way to compute a change over a period. "How much did X move this quarter?" needs two > points, not ninety. ## Getting better results * **Name the entity precisely.** "Ethereum" and "Ethereum L2s" resolve to different series. * **State the granularity when it matters.** "Daily", "hourly", "weekly" removes a guess. * **Give an explicit window.** "Last 90 days" or "since January" beats "recently". * **Ask for fewer metrics** on a wide model. Naming the metric you want keeps the read under the point cap. * **Ask for the underlying points** when you want to verify. "Include the raw values" makes it obvious the answer came from the series rather than the model's own knowledge. > [!NOTE] > > `timeseries_catalog` lists only the models Blockworks publishes to the public API, and reading one still depends > on your key's entitlements. An assistant's "that dataset is not available" may be an entitlements boundary rather > than a gap in coverage. # Troubleshooting Source: https://docs.blockworks.com/mcp/troubleshooting Fixes for authentication loops, invalid API keys, stale OAuth credentials, and connection problems with the Blockworks MCP server. Most MCP problems are one of three things: the client cannot open the OAuth flow, the API key is not valid for the key entry step, or the client is holding on to credentials from an earlier connection. Work through the section that matches your symptom. ## Authentication > [accordion] The OAuth window never opens > > * Confirm your client supports **remote** MCP servers with OAuth 2.0. Clients limited to local `stdio` servers > cannot complete this flow. > * Check that popups are not blocked in your default browser. > * Restart the MCP client and reconnect. Some clients only attempt the flow at startup or on the first tool > call. > * If your client has an explicit authenticate action (in Claude Code, `/mcp`), trigger the flow from there > rather than waiting for it to start on its own. > [accordion] You are stuck in a loop, re-authenticating over and over > > This usually means the client is not persisting the credentials it receives. > > * Complete the browser flow and wait for it to redirect back before switching windows or closing the tab. > * Make sure only one instance of the client is running. A second instance can overwrite the stored credentials > of the first. > * Remove the server from your client, restart the client, then add > `https://mcp.blockworks.com/mcp` again and re-authenticate from a clean state. > [accordion] Your API key is rejected > > * Verify the key at [app.blockworks.com/account/api](https://app.blockworks.com/account/api), and confirm it > is active and has not been rotated or revoked. > * Copy the key fresh from the account page. Truncated keys and trailing whitespace are the most common cause. > * Confirm the key has access to the data you are trying to reach. Every key sees the same tools, but the > models those tools can read follow the key's entitlements, so a valid key can still hit an access error on a > specific dataset. > [accordion] It worked before and suddenly stopped > > Clients cache OAuth credentials, and those can go stale, most often after you rotate or revoke the API key > they were issued against. > > Remove and re-add the server so the client discards the cached credentials and runs a fresh flow: > > ```bash theme={null} > # Claude Code > claude mcp remove blockworks > claude mcp add --transport http blockworks https://mcp.blockworks.com/mcp > ``` > > In connector-based clients (Claude, Claude Desktop, ChatGPT), delete the Blockworks connector, restart the > client, then add it again. In Cursor, remove the entry from `mcp.json`, restart, and re-add it. > > > [!WARNING] > > > > Restarting the client alone is often not enough, because the stored credentials survive a restart. Removing > > the server entry is what clears them. ## Connection > [accordion] The server is unreachable > > * Check that `https://mcp.blockworks.com` is reachable from your network. Corporate VPNs and egress proxies > frequently block unfamiliar hosts. > * Confirm the URL is exactly `https://mcp.blockworks.com/mcp`, including the `/mcp` path. > * Retry in a few minutes in case of a transient outage. > [accordion] No Blockworks tools appear in the assistant > > * Ask directly: `What Blockworks tools do you have available?` An empty answer means the server connected > without completing authentication, or did not connect at all. > * Check your client's server list for the connection state (`claude mcp list` in Claude Code, the MCP or > connectors settings pane elsewhere). > * In clients where connectors are enabled per conversation, make sure Blockworks is toggled on for the chat you > are in, then start a new conversation so the tool list is refreshed. ## Results > [accordion] Empty or unexpected answers > > * Rephrase more specifically by naming the metric, the entity, and the timeframe. See > [What to ask](/mcp/prompts). > * Break a multi-part question into several focused ones. > * Confirm the data you want is covered. Asking "what Blockworks datasets cover this?" first makes the > assistant read the catalog and tells you what is queryable under your key. > [accordion] The assistant answers without calling a tool > > Models sometimes answer from their own knowledge, which will be stale for anything market-related. Ask it > explicitly to use the Blockworks tools, and request the underlying figures so it is obvious where the answer > came from. ## Reporting a problem When a tool returns an error, an empty or surprising result, or data that looks wrong, ask the assistant to report it with [`submit_feedback`](/mcp/tools/feedback). Every tool error ends with a pointer to that tool, and an error from the API carries its request ID, so the report reaches Blockworks with the request that caused it. Outside the MCP server, send the same report to the [Submit Feedback](/api-reference/feedback/submit) endpoint. ## Getting help * **API keys**: [app.blockworks.com/account/api](https://app.blockworks.com/account/api) * **Documentation**: [docs.blockworks.com](https://docs.blockworks.com) * **Still stuck**: reach out to your Blockworks account team with your client name and version, the step that fails, and anything your client logs during the connection attempt. # Microsoft Excel Source: https://docs.blockworks.com/spreadsheets/excel Install the Messari by Blockworks add-in for Microsoft Excel and pull Blockworks data into your workbook with native formulas or the Formula Builder. The Messari by Blockworks add-in for Microsoft Excel pulls Blockworks market, onchain, and social data directly into your workbook, either with native formulas or through the built-in Formula Builder. The add-in is listed in the Microsoft Marketplace and in the Excel ribbon under the **Messari** name, and its formulas carry the `messari_` prefix. You can use it to: * Pull latest or historical metrics * Build dashboards and models * Compare assets, networks, exchanges, and sectors ## Installation ### Microsoft Marketplace Install the add-in from the Microsoft Marketplace: [marketplace.microsoft.com/en-us/product/WA200010088](https://marketplace.microsoft.com/en-us/product/WA200010088). ![Messari by Blockworks listing in the Microsoft Marketplace](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/spreadsheets/excel-listing.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=b2755a50b3f682a003dbc8fe6e8f1b57) ### Sideloading on Excel for Web **1. Download the manifest** Download the **Messari** manifest file. **2. Open a workbook** Open Excel for Web, then open an existing workbook or create a new one. **3. Upload the manifest** Select **Add-ins** from the toolbar, choose **Advanced**, then **Upload custom add-in**, and upload the manifest file. Once installed, the add-in appears in the task bar. Click it to open the sidebar. ### Sideloading on Excel for Mac **1. Open the wef folder** Open Finder and press `Cmd + Shift + G`, then navigate to: ``` ~/Library/Containers/com.microsoft.Excel/Data/Documents/wef ``` If the `wef` folder does not exist, create it. **2. Add the manifest** Copy or move the manifest file into that folder. **3. Restart Excel** Restart Excel and open a new workbook. **4. Enable the add-in** Go to **Add-ins**, find **Messari Data** under **Developer Add-ins**, and click it to enable the Formula Builder. ## Launch the add-in On the **Home** menu, go to **Messari** > **Show Taskpane**. ![Launching the add-in taskpane from the Home menu](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/spreadsheets/excel-1.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=117422d0eae3a3814122a90b4977feca) ### Authentication After selecting **Get Started**, you are prompted to authenticate with your API key. Generate or view your key at [app.blockworks.com/account/api](https://app.blockworks.com/account/api). Once you have it, click **Sign in** and enter the key. Each user must authenticate individually. In shared spreadsheets, formulas only run for authenticated users. ![Sign In](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/spreadsheets/excel-2.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=f5fd930762f9959358de341e6b551994) ![Enter API Key](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/spreadsheets/excel-3.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=c3c219e0dd710ce0ec18ff90b662b83f) ## Using the Formula Builder The Formula Builder is the easiest way to get started and to discover what data is available. **1. Select an entity** Choose what you want to analyze: * Assets * Assets on a specific network * Projects * Projects on a specific network * Networks * Exchanges * Exchanges on Networks * Sectors * Sub-Sectors * Markets Use search to find the entity quickly. **2. Select a metric** After selecting an entity, choose a metric such as market cap, volume, price, TVL, revenue, or mindshare. > [!NOTE] > > If no metrics appear after selecting an entity, there may be no data coverage for > that entity and metric combination, or the metric may not be included in your API > access. **3. Select a time period** Choose how the data comes back: latest, a specific date, the last 7, 14, or 30 days, or a custom date range. **4. Insert or copy the formula** Click **Insert Formula** to drop the formula into the selected cell. You can also copy it and paste it into any cell manually. ## Formula syntax You can always write formulas directly without the builder. ### `=messari_point` Returns the value for a specific date. **Syntax** ``` =messari_point("metric", "entity", "date") ``` **Examples** ``` =messari_point("mcap", "ethereum", "2025-01-01") ``` Ethereum market cap on Jan 1, 2025 ``` =messari_point("market.volume", "coinbase:BTC/USDT", "2025-01-01") ``` Coinbase BTC/USDT volume on Jan 1, 2025 ``` =messari_point("sector.mcap", "DeFi", "2025-01-01") ``` DeFi sector market cap on Jan 1, 2025 ### `=messari_latest_point` Returns the most recent daily value. **Syntax** ``` =messari_latest_point("metric", "entity") ``` **Examples** ``` =messari_latest_point("volume", "ethereum") ``` Latest daily volume for Ethereum ``` =messari_latest_point("asset.circulating.supply", "solana") ``` Latest daily circulating supply for Solana ### `=messari_series` Returns a time series over a date range. **Syntax** ``` =messari_series( "metric","entity", "startDate","endDate",includeHeaders,includeDateCol) ``` `includeHeaders` and `includeDateCol` are optional parameters. **Examples** ``` =messari_series( "exchange.volume", "binance","2025-01-01","2025-01-30", true,true) ``` ``` =messari_series( "asset.revenue", "chainlink", "2025-01-01","2025-01-30", true, true) ``` ## Access to metrics Which metrics you can pull is determined by your organization's API permissions. Datasets such as onchain metrics, mindshare, and sentiment require the corresponding API access. Review the APIs and permissions available to you at [app.blockworks.com/account/api](https://app.blockworks.com/account/api). If a metric does not appear in the Formula Builder, it is likely not included in your current access. # Google Sheets Source: https://docs.blockworks.com/spreadsheets/google-sheets Install the Messari by Blockworks add-on for Google Sheets and pull Blockworks data into your spreadsheet with native formulas or the Formula Builder. The Messari by Blockworks add-on for Google Sheets pulls Blockworks market, onchain, and social data directly into your spreadsheet, either with native formulas or through the built-in Formula Builder. The add-on is listed in the Google Workspace Marketplace and in the Sheets **Extensions** menu under the **Messari** name, and its formulas carry the `messari_` prefix. You can use it to: * Pull latest or historical metrics * Build dashboards and models * Compare assets, networks, exchanges, and sectors ## Installation Install the add-on from the Google Workspace Marketplace: [workspace.google.com/marketplace/app/messari](https://workspace.google.com/marketplace/app/messari/393080319856?flow_type=2). ![Messari by Blockworks listing in the Google Workspace Marketplace](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/spreadsheets/gsheet-1.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=09f08b5952656197c7f4d2e99e51515f) ## Launch the add-on In the toolbar, go to **Extensions** > **Messari** > **Open Sidebar**. ![Opening the add-on sidebar from the Extensions menu](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/spreadsheets/gsheet-launch.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=2ec2de1b81d88b5cbb9b03a4a8fdbfe5) ### Authentication After selecting **Get Started**, you are prompted to authenticate with your API key. Generate or view your key at [app.blockworks.com/account/api](https://app.blockworks.com/account/api). Once you have it, click **Sign in** and enter the key. Each user must authenticate individually. In shared spreadsheets, formulas only run for authenticated users. ![Get Started](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/spreadsheets/gsheet-3.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=0623e48fb20ed968b164a3491e0ea756) ![Sign In](https://mintcdn.com/blockworksdocs/vDpnGk-ikoW5GBXD/images/spreadsheets/gsheet-4.png?fit=max\&auto=format\&n=vDpnGk-ikoW5GBXD\&q=85\&s=5c7fbbc07906992792117c98a24c168b) ## Using the Formula Builder The Formula Builder is the easiest way to get started and to discover what data is available. **1. Select an entity** Choose what you want to analyze: * Assets * Assets on a specific network * Projects * Projects on a specific network * Networks * Exchanges * Exchanges on Networks * Sectors * Sub-Sectors * Markets Use search to find the entity quickly. **2. Select a metric** After selecting an entity, choose a metric such as market cap, volume, price, TVL, revenue, or mindshare. > [!NOTE] > > If no metrics appear after selecting an entity, there may be no data coverage for > that entity and metric combination, or the metric may not be included in your API > access. **3. Select a time period** Choose how the data comes back: latest, a specific date, the last 7, 14, or 30 days, or a custom date range. **4. Insert or copy the formula** Click **Insert Formula** to drop the formula into the selected cell. You can also copy it and paste it into any cell manually. ## Formula syntax You can always write formulas directly without the builder. ### `=messari_point` Returns the value for a specific date. **Syntax** ``` =messari_point("metric", "entity", "date") ``` **Examples** ``` =messari_point("mcap", "ethereum", "2025-01-01") ``` Ethereum market cap on Jan 1, 2025 ``` =messari_point("market.volume", "coinbase:BTC/USDT", "2025-01-01") ``` Coinbase BTC/USDT volume on Jan 1, 2025 ``` =messari_point("sector.mcap", "DeFi", "2025-01-01") ``` DeFi sector market cap on Jan 1, 2025 ### `=messari_latest_point` Returns the most recent daily value. **Syntax** ``` =messari_latest_point("metric", "entity") ``` **Examples** ``` =messari_latest_point("volume", "ethereum") ``` Latest daily volume for Ethereum ``` =messari_latest_point("asset.circulating.supply", "solana") ``` Latest daily circulating supply for Solana ### `=messari_series` Returns a time series over a date range. **Syntax** ``` =messari_series( "metric","entity", "startDate","endDate",includeHeaders,includeDateCol) ``` `includeHeaders` and `includeDateCol` are optional parameters. **Examples** ``` =messari_series( "exchange.volume", "binance","2025-01-01","2025-01-30", true,true) ``` ``` =messari_series( "asset.revenue", "chainlink", "2025-01-01","2025-01-30", true, true) ``` ## Access to metrics Which metrics you can pull is determined by your organization's API permissions. Datasets such as onchain metrics, mindshare, and sentiment require the corresponding API access. Review the APIs and permissions available to you at [app.blockworks.com/account/api](https://app.blockworks.com/account/api). If a metric does not appear in the Formula Builder, it is likely not included in your current access. # Overview Source: https://docs.blockworks.com/spreadsheets/overview Blockworks plugins put Blockworks data inside the tools you already use: spreadsheet plugins for Google Sheets and Excel, with AI assistant plugins documented alongside the MCP Server. Plugins bring Blockworks data into the tools you already work in, with no code and no client to maintain. Each plugin signs in with your Blockworks API key and reads from the same warehouse models as the [Data API](/getting-started/data-api), so a number in a spreadsheet cell or an assistant's answer is the same number the API returns. ## Spreadsheet plugins Write a formula, get a number or a full time series back, and let the sheet recalculate. Use them to pull latest or historical metrics, build dashboards and models, and compare assets, networks, exchanges, and sectors side by side. Both plugins are published as **Messari by Blockworks**, so that is the name to look for in the Google Workspace and Microsoft marketplaces. > [card] [Google Sheets](/spreadsheets/google-sheets) > > Install the add-on from the Google Workspace Marketplace and open the sidebar from the > Extensions menu. > [card] [Microsoft Excel](/spreadsheets/excel) > > Install the add-in from the Microsoft Marketplace, or sideload it on Excel for Web and > Excel for Mac. ## AI assistant plugins Plugins for AI assistants such as ChatGPT run on the hosted MCP server and are documented in the [MCP Server](/mcp/overview) tab, next to the client setup for Claude, Cursor, and other MCP clients. > [card] [ChatGPT plugin](/mcp/plugins/chatgpt) > > Install from the ChatGPT plugin directory and authorize with your API key. > [card] [MCP Server](/mcp/overview) > > One URL that connects any MCP-capable assistant or agent to Blockworks data. ## What you need An API key. Generate one at [app.blockworks.com/account/api](https://app.blockworks.com/account/api), then sign in from the plugin. The same key works across every plugin and the rest of the Blockworks API. See [Authentication](/getting-started/authentication) for how keys work elsewhere. Each user authenticates individually. In a shared spreadsheet, formulas only calculate for people who have signed in with their own key. ## Under the hood Every plugin calls the Blockworks Data API. If you want to know how a metric is defined, which entities are available, or how a time series is bucketed, the API docs are the reference: > [card] [Data API](/getting-started/data-api) > > Endpoints, parameters, and the datasets behind every plugin. > [card] [Tabular vs timeseries](/getting-started/concepts/tabular-vs-timeseries) > > How point-in-time values and historical series differ in the underlying data.