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

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

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

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


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