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

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

> [card] [Batch Get Bridge Protocol timeseries](https://docs.blockworks.com/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols.md)
>
> Up to 10 series in one request, named by Bridge Protocol ID in `series`.

> [card] [Get Bridge Protocol timeseries](https://docs.blockworks.com/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-id.md)
>
> 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/<id>?timeframe=7d&selections=bridgeVolumeUSD,bridgeTransferCount" \
  -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY"
```

See [Get Bridge Protocol timeseries](https://docs.blockworks.com/api-reference/data-api/bridge-protocols/timeseries-bridge-protocols-by-id.md) for the response and the errors.


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