> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blockworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/tabular-bridged-bitcoin-deployments.md)
>
> One page of rows with per-column filters, sorting and pagination.

> [card] [Batch Get Bridged Bitcoin Deployment timeseries](https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-deployment.md)
>
> Up to 10 series in one request, named by Bridged Bitcoin Deployment ID in `series`.

> [card] [Get Bridged Bitcoin Deployment timeseries](https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-deployment-by-id.md)
>
> 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/<id>?timeframe=7d&selections=priceUSD,circulatingSupplyUSD" \
  -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY"
```

See [Get Bridged Bitcoin Deployment timeseries](https://docs.blockworks.com/api-reference/data-api/bridged-bitcoin/timeseries-bridged-bitcoin-by-deployment-by-id.md) for the response and the errors.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.