Open API

WBTC exposes a set of public, read-only REST APIs for transparency data, supported chains, mint and burn history, participants, providers, and ecosystem projects. All endpoints are free to use, require no API key, and support CORS.

1. Common - Network & Auth

All request examples below use the absolute Base URL, so they are copy-pasteable without consulting this table.

2. Common - Conventions

2.1 Response format

All API endpoints return the following JSON format:

{
  "data": { },
  "meta": {
    "updatedAt": "2026-06-24T04:00:49.863904Z",
    "version": "v1"
  }
}

2.2 Data conventions

2.3 Response Field Meanings

The following response field units and meanings apply:

2.4 Existence column

Response field tables include an Existence column so clients can tell whether a missing or empty value is expected:

2.5 Empty result is not an error

An empty array is a successful response, not an error.

Examples: /participants?tag=no-match may return an empty participants array; /providers?q=no-match may return an empty providers array. Do not treat these as failures or retry them aggressively.

2.6 Caching and conditional requests

Responses may include ETag and Cache-Control headers.

Clients should preserve and reuse ETag values where possible:

If-None-Match: "previous-etag-value"

When the data has not changed, the API may return:

HTTP/1.1 304 Not Modified

A 304 response has no response body. Continue using the cached representation from the previous 200 response.

3. Common - Errors

Error format. The WBTC Public API uses standard HTTP status codes for request and service errors. Error responses are JSON objects containing error.code, error.message, and error.requestId.

{
  "error": {
    "code": "INVALID_PARAM",
    "message": "Invalid category. Expected defi, chains, wallet, or bridge.",
    "requestId": "req_01HZY..."
  }
}

3.1 Error response fields

3.2 Code table

3.3 Common error cases

4. Endpoint Index

5. Endpoint Reference

5.1 Proof of Reserve

Overview. WBTC transparency summary, including circulating supply by chain, native BTC reserve information, reserve addresses, and collateralization ratio.

Typical use. Build a transparency dashboard, show reserve ratio, or verify public reserve addresses.

When not to use. For mint and burn history, use section 5.3. For chain contract information only, use section 5.2.

Endpoint. GET /public/v1/proof-of-reserve - Base URL & auth see section 1.

Request parameters. None.

Request example.

curl "https://openapi.wbtc.network/public/v1/proof-of-reserve"

Response fields.

Response example.

{
  "data": {
    "supply": {
      "circulatingSupply": "155000.00000000",
      "byChain": [
        {
          "chain": "Ethereum",
          "chainKey": "eth",
          "supply": "100000.00000000"
        },
        {
          "chain": "BNB Chain",
          "chainKey": "bsc",
          "supply": "55000.00000000"
        }
      ]
    },
    "reserves": {
      "nativeBtcReserve": "155010.00000000",
      "btcPriceUsd": "65000.00",
      "reserveValueUsd": "10075650000.00",
      "addressCount": 1,
      "addresses": [
        {
          "address": "bc1qwbtcreserveexample0000000000000000000",
          "balanceBtc": "155010.00000000",
          "explorerUrl": "https://mempool.space/address/bc1qwbtcreserveexample0000000000000000000"
        }
      ]
    },
    "collateralization": {
      "reserveRatio": "1.000064516129032258064516129"
    }
  },
  "meta": {
    "updatedAt": "2026-06-24T04:00:49.863904Z",
    "version": "v1"
  }
}

Errors. See section 3. This endpoint takes no parameters, so errors are generally limited to an unknown path, rate limiting, temporary data unavailability, or a service error.

5.2 Supported Chains

Overview. Native and bridge chain support information for WBTC, including token contract and explorer links.

Typical use. Display supported networks, contract addresses, or chain availability.

When not to use. For circulating supply by chain, use section 5.1.

Endpoint. GET /public/v1/chains - Base URL & auth see section 1.

Request parameters.

Request example.

curl "https://openapi.wbtc.network/public/v1/chains"
curl "https://openapi.wbtc.network/public/v1/chains?type=native"

Response fields.

Response example.

The example below shows a type=native response.

{
  "data": {
    "natives": [
      {
        "chain": "BNB Chain",
        "chainKey": "bsc",
        "type": "native",
        "isNew": true,
        "contract": {
          "contractType": "BEP-20",
          "contractAddress": "0x39665e85a68a4d7328b8799135E2ff301a0Ca86f",
          "explorerUrl": "https://bscscan.com/token/0x39665e85a68a4d7328b8799135E2ff301a0Ca86f"
        }
      }
    ]
  },
  "meta": {
    "updatedAt": "2026-06-24T04:00:49.863904Z",
    "version": "v1"
  }
}

Errors. See section 3. Invalid type values return an INVALID_PARAM error.

5.3 Mint and Burn History

Overview. Paginated WBTC mint and burn records.

Typical use. Build a mint/burn activity table or filter recent records by action, network, status, or merchant.

When not to use. For aggregate supply and reserves, use section 5.1.

Endpoint. GET /public/v1/mint-burn - Base URL & auth see section 1.

Request parameters.

Request example.

curl "https://openapi.wbtc.network/public/v1/mint-burn?pageIndex=1&pageSize=20"

Response fields.

Response example.

{
  "data": {
    "records": [
      {
        "action": "mint",
        "status": "pending",
        "network": "eth",
        "amount": "10.00000000",
        "merchantName": "Unknown",
        "date": "2026-06-23T07:05:25.168000Z",
        "txHash": "0xfe830751bd2bb181595258a1948752436c4ba9b85b2d839483d93276f4855156"
      }
    ],
    "pagination": {
      "pageIndex": 1,
      "pageSize": 20,
      "total": 1666
    }
  },
  "meta": {
    "updatedAt": "2026-06-22T15:20:48Z",
    "version": "v1"
  }
}

Errors. See section 3. Invalid pagination parameters return INVALID_PARAM. Use the supported filter values listed above for consistent results.

5.4 Participants

Overview. Public WBTC participants, such as custodians and merchants.

Typical use. Display WBTC participant lists or filter participants by role or tag.

When not to use. For exchanges, wallets, bridges, DeFi integrations, and other service providers, use sections 5.5 and 5.6.

Endpoint. GET /public/v1/participants - Base URL & auth see section 1.

Request parameters.

Request example.

curl "https://openapi.wbtc.network/public/v1/participants"
curl "https://openapi.wbtc.network/public/v1/participants?role=custodian"

Response fields.

Response example.

{
  "data": {
    "participants": [
      {
        "role": "custodian",
        "name": "BitGo",
        "description": "BitGo is the market leader in institutional cryptocurrency financial services, providing security, compliance, and custodial solutions.",
        "tags": ["Custodian"],
        "website": "https://www.bitgo.com/"
      }
    ]
  },
  "meta": {
    "updatedAt": "2026-06-24T04:00:49.863904Z",
    "version": "v1"
  }
}

Errors. See section 3. Invalid filter parameters return INVALID_PARAM.

5.5 Providers

Overview. Public Get WBTC providers, such as centralized and decentralized exchanges.

Typical use. Show where users can access or trade WBTC.

When not to use. For protocol participants such as custodians and merchants, use section 5.4.

Endpoint. GET /public/v1/providers - Base URL & auth see section 1.

Request parameters.

Request example.

curl "https://openapi.wbtc.network/public/v1/providers"
curl "https://openapi.wbtc.network/public/v1/providers?type=cex"
curl "https://openapi.wbtc.network/public/v1/providers?network=Ethereum&q=binance"

Response fields.

Response example.

{
  "data": {
    "providers": [
      {
        "name": "Binance",
        "type": "CEX",
        "networks": ["Ethereum", "KAVA"],
        "url": "https://www.binance.com"
      }
    ]
  },
  "meta": {
    "updatedAt": "2026-06-24T04:00:49.863904Z",
    "version": "v1"
  }
}

Errors. See section 3. Invalid filter parameters return INVALID_PARAM.

5.6 Ecosystem Projects

Overview. Ecosystem projects that integrate or support WBTC.

Typical use. Display WBTC integrations grouped by category or network.

When not to use. For provider-oriented listings such as exchanges and wallets, use section 5.5.

Endpoint. GET /public/v1/ecosystem - Base URL & auth see section 1.

Request parameters.

Request example.

curl "https://openapi.wbtc.network/public/v1/ecosystem"
curl "https://openapi.wbtc.network/public/v1/ecosystem?category=defi"
curl "https://openapi.wbtc.network/public/v1/ecosystem?network=Ethereum"

Response fields.

Response example.

{
  "data": {
    "projects": [
      {
        "name": "AAVE",
        "category": "DeFi",
        "networks": ["Ethereum", "Arbitrum", "Polygon", "Optimism"],
        "url": "https://app.aave.com/reserve-overview/?underlyingAsset=0x2260fac5e5542a773aa44fbcfedf7c193bc2c599&marketName=proto_mainnet_v3"
      }
    ]
  },
  "meta": {
    "updatedAt": "2026-06-24T04:00:49.863904Z",
    "version": "v1"
  }
}

Errors. See section 3. Invalid filter parameters return INVALID_PARAM.

5.7 OpenAPI Document

Overview. An OpenAPI JSON document describing the WBTC Public API.

Typical use. Generate API clients or inspect request and response definitions.

When not to use. For live WBTC data, call the relevant endpoint directly.

Endpoint. GET /public/v1/openapi.json - Base URL & auth see section 1.

Request parameters. None.

Request example.

curl "https://openapi.wbtc.network/public/v1/openapi.json"

Response. OpenAPI JSON document.

Errors. See section 3.