> ## 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.

# List 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.



## OpenAPI

````yaml api-reference/data-api/openapi.json GET /query/tabular/bridged-bitcoin-deployments
openapi: 3.0.0
info:
  description: >-
    The Blockworks Data API is a unified, read-only REST interface to
    Blockworks' warehouse-modeled crypto dataset, powered by Messari's research
    and data infrastructure. It serves two kinds of models: tabular models,
    which return current, filterable, sortable rows for entities such as assets,
    networks, protocols, exchanges, stablecoins, and ETFs; and timeseries
    models, which return historical metric series at a chosen granularity for
    one or many entities. Every endpoint shares the same query grammar (column
    projection, per-column filters, sorting, and pagination) and returns the
    standard `{ "error": ..., "data": ... }` envelope. Authenticate by sending
    your API key in the `X-Blockworks-API-Key` header.
  title: Blockworks Data API
  version: 0.1.0
servers:
  - description: Blockworks API
    url: https://api.blockworks.com
security:
  - apiKey: []
tags:
  - description: >-
      Models documented under Agentic Payments: Agentic Payments (table),
      Agentic Payments (timeseries).
    name: Agentic Payments
  - description: >-
      Models documented under Assets: Assets (table), Asset Marketcap
      (timeseries), Asset Price (timeseries), Asset Sharpe (timeseries), Asset
      Supply (timeseries), Asset Volatility (timeseries).
    name: Assets
  - description: >-
      Models documented under Blockchains: Blockchains (table), Blockchains
      (timeseries).
    name: Blockchains
  - description: >-
      Models documented under Bridge Protocols: Bridge Protocol Networks
      (table), Bridge Protocols (table), Bridge Protocols (timeseries), Bridge
      Protocols by Network (timeseries).
    name: Bridge Protocols
  - description: >-
      Models documented under Bridged Bitcoin: Bridged Bitcoin Chains (table),
      Bridged Bitcoin Deployments (table), Bridged Bitcoin Issuers (table),
      Bridged Bitcoin Products (table), Bridged Bitcoin by Chain (timeseries),
      Bridged Bitcoin by Deployment (timeseries), Bridged Bitcoin by Issuer
      (timeseries), Bridged Bitcoin by Product (timeseries).
    name: Bridged Bitcoin
  - description: >-
      Models documented under Centralized Finance: CeFi Balances and Flows
      (table), CeFi Balances and Flows (timeseries).
    name: Centralized Finance
  - description: >-
      Models documented under Collateralized Debt Positions (CDPs): CDP Market
      Balances (table), CDP Market Financials (table), CDP Market Interest Rates
      (table), CDP Market Liquidations (table), CDP Market Balances
      (timeseries), CDP Market Financials (timeseries), CDP Market Interest
      Rates (timeseries), CDP Market Liquidations (timeseries).
    name: Collateralized Debt Positions (CDPs)
  - description: >-
      Models documented under DEX Aggregators: DEX Aggregator Volumes (table),
      DEX Aggregator Volumes (timeseries).
    name: DEX Aggregators
  - description: >-
      Models documented under Derivatives: Perpetual Market Funding Rates
      (table), Perpetual Markets (table), Perpetual Market Funding Rates
      (timeseries), Perpetual Markets (timeseries).
    name: Derivatives
  - description: >-
      Models documented under Digital Asset Treasury Companies: DAT Companies
      (table), DAT Company Assets (table), DAT Companies (timeseries), DAT
      Companies by Asset (timeseries).
    name: Digital Asset Treasury Companies
  - description: >-
      Models documented under ETFs: ETF Assets (table), ETF Providers (table),
      ETF Assets (timeseries), ETF Providers (timeseries).
    name: ETFs
  - description: >-
      Models documented under Exchanges: Exchange Country (timeseries), Exchange
      Region (timeseries), Exchange Type (timeseries), Exchanges (timeseries).
    name: Exchanges
  - description: >-
      Models documented under Fundraising: Acquisition Deals (table), Fund
      Managers (table), Funding Round Investors (table), Funding Rounds (table),
      Funds (table), Sector Fundraising (timeseries).
    name: Fundraising
  - description: >-
      Models documented under Institutional Allocators: Institutional Allocator
      Balances (table), Institutional Allocator Financials (table),
      Institutional Allocator Performances (table), Institutional Allocator
      Balances (timeseries), Institutional Allocator Financials (timeseries),
      Institutional Allocator Performances (timeseries).
    name: Institutional Allocators
  - description: >-
      Models documented under Launchpads: Launchpad Chains (table), Launchpads
      (table), Launchpads (timeseries), Launchpads by Chain (timeseries).
    name: Launchpads
  - description: >-
      Models documented under Lending Protocols: Lending Market Balances
      (table), Lending Market Financials (table), Lending Market Flows (table),
      Lending Market Interest Rates (table), Lending Market Liquidations
      (table), Lending Protocol Product Markets (table), Lending Protocol
      Products (table), Lending Protocols (table), Lending Market Balances
      (timeseries), Lending Market Financials (timeseries), Lending Market Flows
      (timeseries), Lending Market Interest Rates (timeseries), Lending Market
      Liquidations (timeseries), Lending Protocols (timeseries), Lending
      Protocols by Product (timeseries), Lending Protocols by Product Market
      (timeseries).
    name: Lending Protocols
  - description: >-
      Models documented under Markets: Markets (table), Market (BQEN)
      (timeseries).
    name: Markets
  - description: >-
      Models documented under Mindshare & Sentiment: Asset Group Sentiment
      (timeseries), Asset Investor Mentions (timeseries), Asset Mindshare
      (timeseries), Asset Sentiment (timeseries), Project Mindshare
      (timeseries), Sector Asset Mindshare (timeseries), Sector Asset Sentiment
      (timeseries), Sector Investor Mentions (timeseries), Sub-Sector Asset
      Mindshare (timeseries), Sub-Sector Asset Sentiment (timeseries).
    name: Mindshare & Sentiment
  - description: 'Models documented under News: News Feed (table), Topics (timeseries).'
    name: News
  - description: >-
      Models documented under Payment Cards: Payment Card Accounts (table),
      Payment Card Balances (table), Payment Card Spending (table), Payment Card
      Accounts (timeseries), Payment Card Balances (timeseries), Payment Card
      Spending (timeseries).
    name: Payment Cards
  - description: >-
      Models documented under Peg Stability: Peg Stability Backings (table), Peg
      Stability Facilities (table), Peg Stability Backings (timeseries), Peg
      Stability Facilities (timeseries).
    name: Peg Stability
  - description: >-
      Models documented under Perp DEX Protocols: Perp DEX Protocols (table),
      Perp DEX Protocols (timeseries).
    name: Perp DEX Protocols
  - description: >-
      Models documented under Privacy: Privacy Flows and Balances (table),
      Privacy Flows and Balances (timeseries).
    name: Privacy
  - description: >-
      Models documented under Project Financials: Project Expenses (table),
      Project Income Statements (table), Project Revenue (table), Project
      Tokenholder Distributions (table), Project Expenses (timeseries), Project
      Income Statements (timeseries), Project Revenue (timeseries), Project
      Tokenholder Distributions (timeseries), Protocol Revenue (timeseries),
      Protocol Revenue by Product (timeseries).
    name: Project Financials
  - description: >-
      Models documented under Projects: Project Tokens (table), Project Users
      (table), Project Tokens (timeseries), Project Users (timeseries), Projects
      (timeseries).
    name: Projects
  - description: >-
      Models documented under Real World Assets: RWA Categories (table), RWA
      Chains (table), RWA Deployments (table), RWA Issuers (table), RWA Products
      (table), RWA Spot DEX Segments (table), RWA by Category (timeseries), RWA
      by Chain (timeseries), RWA by Deployment (timeseries), RWA by Issuer
      (timeseries), RWA by Product (timeseries), RWA Spot DEX Activity
      (timeseries).
    name: Real World Assets
  - description: >-
      Models documented under Research Reports (Tabular): Research Reports
      (table).
    name: Research Reports (Tabular)
  - description: >-
      Models documented under Savings: Savings Balances (table), Savings
      Financials (table), Savings Performances (table), Savings Balances
      (timeseries), Savings Financials (timeseries), Savings Performances
      (timeseries).
    name: Savings
  - description: >-
      Models documented under Sector Market Data: Sector Marketdata
      (timeseries), Sub-Sector Marketdata (timeseries).
    name: Sector Market Data
  - description: >-
      Models documented under Spot DEX Protocols: Spot DEX Liquidity Balances
      (table), Spot DEX Protocol Chains (table), Spot DEX Protocols (table),
      Spot DEX Liquidity Balances (timeseries), Spot DEX Protocols (timeseries),
      Spot DEX Protocols by Chain (timeseries).
    name: Spot DEX Protocols
  - description: >-
      Models documented under Stablecoins: Stablecoin Chains (table), Stablecoin
      Currencies (table), Stablecoin Deployments (table), Stablecoin FX Pairs
      (table), Stablecoin Issuers (table), Stablecoin Products (table),
      Stablecoin Reserve Entities (table), Stablecoin FX (timeseries),
      Stablecoin Reserves (timeseries), Stablecoins by Chain (timeseries),
      Stablecoins by Currency (timeseries), Stablecoins by Deployment
      (timeseries), Stablecoins by Issuer (timeseries), Stablecoins by Product
      (timeseries).
    name: Stablecoins
  - description: >-
      Models documented under TCG Platforms: TCG Platform Chains (table), TCG
      Platforms by Chain (timeseries), TCG Platforms by Deployment (timeseries).
    name: TCG Platforms
  - description: >-
      Discovery of the tabular models: one row per entity, with per-column
      filters, sorting and pagination.
    name: Tabular
  - description: >-
      Discovery of the timeseries models: one series per entity, as points at
      the granularities each model declares.
    name: Timeseries
  - description: 'Models documented under Real-time Buybacks: Asset Buybacks (timeseries).'
    name: Real-time Buybacks
  - description: >-
      Models documented under Token Transparency: Token Transparency Filing
      Questions (table), Token Transparency Filing Schemas (table), Token
      Transparency Filings (table), Token Transparency Projects (table).
    name: Token Transparency
  - description: 'Models documented under Token Unlocks: Token Unlocks (timeseries).'
    name: Token Unlocks
  - description: >-
      Models documented under Tokenized Commodities: Tokenized Commodities
      (table), Tokenized Commodity Chains (table), Tokenized Commodity Issuers
      (table), Tokenized Commodity Products (table), Tokenized Commodities by
      Chain (timeseries), Tokenized Commodities by Commodity (timeseries),
      Tokenized Commodities by Issuer (timeseries), Tokenized Commodities by
      Product (timeseries).
    name: Tokenized Commodities
  - description: >-
      Models documented under Tokenized Equities: Tokenized Equities (table),
      Tokenized Equity Chains (table), Tokenized Equity Issuers (table),
      Tokenized Equity Products (table), Tokenized Equities by Chain
      (timeseries), Tokenized Equities by Equity (timeseries), Tokenized
      Equities by Issuer (timeseries), Tokenized Equities by Product
      (timeseries).
    name: Tokenized Equities
  - description: >-
      Models documented under Tokens: Token Labels (table), Token Metrics
      (table), Token Metrics (timeseries).
    name: Tokens
  - description: >-
      Models documented under Vaults: Vault Balances (table), Vault Chains
      (table), Vault Curators (table), Vault Financials (table), Vault Flows
      (table), Vault Performances (table), Vault Protocols (table), Vault
      Balances (timeseries), Vault Curators (timeseries), Vault Financials
      (timeseries), Vault Flows (timeseries), Vault Performances (timeseries),
      Vault Protocols (timeseries), Vaults by Chain (timeseries).
    name: Vaults
  - description: >-
      Models documented under Wholesale Credit: Wholesale Credit Balances
      (table), Wholesale Credit Financials (table), Wholesale Credit Interest
      Rates (table), Wholesale Credit Balances (timeseries), Wholesale Credit
      Financials (timeseries), Wholesale Credit Interest Rates (timeseries).
    name: Wholesale Credit
paths:
  /query/tabular/bridged-bitcoin-deployments:
    get:
      tags:
        - Bridged Bitcoin
      summary: List Bridged Bitcoin Deployments
      description: >-
        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.
      operationId: getTabular_bridged_bitcoin_deployments
      parameters:
        - description: Bridged Bitcoin Deployment ID equals.
          in: query
          name: idEq
          schema:
            type: string
        - description: Bridged Bitcoin Deployment ID is one of (comma-separated).
          in: query
          name: idIsOneOf
          schema:
            items:
              type: string
            type: array
        - description: Name equals.
          in: query
          name: nameEq
          schema:
            type: string
        - description: Name is one of (comma-separated).
          in: query
          name: nameIsOneOf
          schema:
            items:
              type: string
            type: array
        - description: Name contains (case-insensitive substring).
          in: query
          name: nameContains
          schema:
            type: string
        - description: Symbol equals.
          in: query
          name: symbolEq
          schema:
            type: string
        - description: Symbol is one of (comma-separated).
          in: query
          name: symbolIsOneOf
          schema:
            items:
              type: string
            type: array
        - description: Symbol contains (case-insensitive substring).
          in: query
          name: symbolContains
          schema:
            type: string
        - description: Token ID equals.
          in: query
          name: tokenIDEq
          schema:
            type: string
        - description: Token ID is one of (comma-separated).
          in: query
          name: tokenIDIsOneOf
          schema:
            items:
              type: string
            type: array
        - description: Reference Token ID equals.
          in: query
          name: referenceTokenIDEq
          schema:
            type: string
        - description: Reference Token ID is one of (comma-separated).
          in: query
          name: referenceTokenIDIsOneOf
          schema:
            items:
              type: string
            type: array
        - description: Underlying Token ID equals.
          in: query
          name: underlyingTokenIDEq
          schema:
            type: string
        - description: Underlying Token ID is one of (comma-separated).
          in: query
          name: underlyingTokenIDIsOneOf
          schema:
            items:
              type: string
            type: array
        - description: Token Address equals.
          in: query
          name: tokenAddressEq
          schema:
            type: string
        - description: Token Address is one of (comma-separated).
          in: query
          name: tokenAddressIsOneOf
          schema:
            items:
              type: string
            type: array
        - description: Chain equals.
          in: query
          name: chainEq
          schema:
            type: string
        - description: Chain is one of (comma-separated).
          in: query
          name: chainIsOneOf
          schema:
            items:
              type: string
            type: array
        - description: Issuer ID equals.
          in: query
          name: issuerIDEq
          schema:
            type: string
        - description: Issuer ID is one of (comma-separated).
          in: query
          name: issuerIDIsOneOf
          schema:
            items:
              type: string
            type: array
        - description: Bridge ID equals.
          in: query
          name: bridgeIDEq
          schema:
            type: string
        - description: Bridge ID is one of (comma-separated).
          in: query
          name: bridgeIDIsOneOf
          schema:
            items:
              type: string
            type: array
        - description: Network ID equals.
          in: query
          name: networkIDEq
          schema:
            type: string
        - description: Network ID is one of (comma-separated).
          in: query
          name: networkIDIsOneOf
          schema:
            items:
              type: string
            type: array
        - description: Network Slug equals.
          in: query
          name: networkSlugEq
          schema:
            type: string
        - description: Network Slug is one of (comma-separated).
          in: query
          name: networkSlugIsOneOf
          schema:
            items:
              type: string
            type: array
        - description: Project ID equals.
          in: query
          name: projectIDEq
          schema:
            type: string
        - description: Project ID is one of (comma-separated).
          in: query
          name: projectIDIsOneOf
          schema:
            items:
              type: string
            type: array
        - description: Project Slug equals.
          in: query
          name: projectSlugEq
          schema:
            type: string
        - description: Project Slug is one of (comma-separated).
          in: query
          name: projectSlugIsOneOf
          schema:
            items:
              type: string
            type: array
        - description: Field to sort by; defaults to the model's default sort column.
          in: query
          name: sortBy
          schema:
            default: name
            enum:
              - name
              - symbol
            type: string
        - description: Sort direction.
          in: query
          name: sortDirection
          schema:
            default: asc
            enum:
              - asc
              - desc
            type: string
        - description: 1-based page number.
          in: query
          name: page
          schema:
            type: integer
        - description: Rows per page (max 1000, default 100).
          in: query
          name: pageSize
          schema:
            type: integer
        - description: Comma-separated fields to return; defaults to all fields.
          in: query
          name: selections
          schema:
            items:
              enum:
                - id
                - name
                - symbol
                - tokenID
                - referenceTokenID
                - underlyingTokenID
                - tokenAddress
                - chain
                - issuerID
                - bridgeID
                - networkID
                - networkSlug
                - projectID
                - projectSlug
              type: string
            type: array
        - description: >-
            Response format, overriding the Accept header: json (default), csv,
            or jsonl (NDJSON). csv and jsonl return the rows as a downloadable
            file.
          in: query
          name: acceptFormat
          schema:
            default: json
            enum:
              - json
              - csv
              - jsonl
            type: string
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  - bridgeID: <bridgeID>
                    chain: <chain>
                    id: <id>
                    issuerID: <issuerID>
                    name: <name>
                    networkID: <networkID>
                    networkSlug: <networkSlug>
                    projectID: <projectID>
                    projectSlug: <projectSlug>
                    referenceTokenID: <referenceTokenID>
                    symbol: <symbol>
                    tokenAddress: <tokenAddress>
                    tokenID: <tokenID>
                    underlyingTokenID: <underlyingTokenID>
                error: null
                metadata:
                  totalPages: 1
                  totalRows: 1
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/BridgedBitcoinDeploymentsRow'
                    type: array
                  error:
                    nullable: true
                    type: string
                  metadata:
                    description: >-
                      Pagination totals for the full filtered result set,
                      independent of the current page.
                    properties:
                      totalPages:
                        format: int64
                        type: integer
                      totalRows:
                        format: int64
                        type: integer
                    required:
                      - totalRows
                      - totalPages
                    type: object
                required:
                  - data
                  - metadata
                type: object
            application/x-ndjson:
              schema:
                description: JSON Lines (NDJSON); one JSON object per line.
                type: string
            text/csv:
              schema:
                description: CSV with a header row; one row per record.
                type: string
          description: >-
            One page of matching rows, with the totals for the whole filtered
            set.
        '400':
          content:
            application/json:
              example:
                data: null
                error: >-
                  unknown query parameter "id": column "id" is filtered by
                  "idEq", "idIsOneOf"
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            The request is malformed: an unknown query parameter (a filter needs
            its operator suffix, such as idEq), a filter value of the wrong
            type, a sortBy field that is not sortable, an unknown selections
            field, or a pageSize above 1000.
        '401':
          content:
            application/json:
              example:
                data: null
                error: this model requires authentication
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: No API key was sent and the model requires one.
        '402':
          content:
            application/json:
              example:
                data: null
                error: >-
                  You are out of credits (balance 0). Do not retry this request.
                  Visit https://app.blockworks.com/account/api to see balance
                  and get more credits.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            The caller's credit balance cannot cover this request. Not worth
            retrying until they hold more credits. The message distinguishes a
            spent balance from an account that never claimed its grant, and is
            written for an MCP client to relay to a model.
        '403':
          content:
            application/json:
              example:
                data: null
                error: >-
                  this model requires the "stablecoins-dataset" permission; see
                  https://app.blockworks.com/account/api for the public API
                  permissions you hold
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            The API key is not valid, or does not hold the "stablecoins-dataset"
            permission.
        '404':
          content:
            application/json:
              example:
                data: null
                error: tabular model "unknown-model" not found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            The path names a model that does not exist: the slug is mistyped or
            the model was removed.
        '503':
          content:
            application/json:
              example:
                data: null
                error: >-
                  the credit service is temporarily unavailable and this request
                  was refused without charge; retry in a moment
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            The credit service could not be reached, so the request was refused
            without charge. Retry in a moment.
components:
  schemas:
    BridgedBitcoinDeploymentsRow:
      properties:
        bridgeID:
          description: >-
            The bridge the deployment was bridged through; null for a native
            deployment.
          nullable: true
          type: string
        chain:
          description: The short name of the chain (ethereum, base, solana).
          nullable: true
          type: string
        id:
          description: >-
            The series key of the bridged-bitcoin-by-deployment timeseries
            model, the chain and token address joined with an underscore.
          nullable: true
          type: string
        issuerID:
          description: The identifier of the issuing company.
          nullable: true
          type: string
        name:
          description: The deployment's display name, the symbol and chain.
          nullable: true
          type: string
        networkID:
          description: The chain's networkID in the blockchains model; null when unmapped.
          nullable: true
          type: string
        networkSlug:
          description: The chain's slug in the blockchains model; null when unmapped.
          nullable: true
          type: string
        projectID:
          description: The identifier of the issuer's project record; null when unmapped.
          nullable: true
          type: string
        projectSlug:
          description: The slug of the issuer's project record; null when unmapped.
          nullable: true
          type: string
        referenceTokenID:
          description: >-
            The token id of the product this contract represents, the underlying
            token for a bridged copy and otherwise its own token id.
          nullable: true
          type: string
        symbol:
          description: The token's ticker symbol.
          nullable: true
          type: string
        tokenAddress:
          description: The token contract address (the mint address on Solana).
          nullable: true
          type: string
        tokenID:
          description: >-
            The token id of this contract, the series key of the
            bridged-bitcoin-by-product timeseries model.
          nullable: true
          type: string
        underlyingTokenID:
          description: >-
            The token id of the original token for a bridged copy (for example
            bitgo-wbtc), otherwise bitcoin.
          nullable: true
          type: string
      type: object
    ErrorResponse:
      properties:
        data:
          description: Always null on an error.
          nullable: true
          type: object
        error:
          description: What went wrong, in one sentence.
          type: string
      required:
        - error
        - data
      type: object
  securitySchemes:
    apiKey:
      description: >-
        API key sent in the `X-Blockworks-API-Key` header; `x-messari-api-key`
        is accepted for existing integrations. The catalog endpoints and models
        open to everyone need no key.
      in: header
      name: X-Blockworks-API-Key
      type: apiKey

````

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