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

# Spot DEX Liquidity Balances

> Daily token balance, in native units and USD, held as liquidity by one spot DEX deployment for one token on one chain. Each series is one deployment token balance, keyed by chain, exchange, version, design and token address. Many series per exchange, so name the balances you need.

One row per token held as liquidity by one spot DEX deployment on one chain, keyed by chain, exchange, version, design and token address: the exchange, its version and design, the token, the chain and the mapped network record. The id is the series key of the spot-dex-liquidity-balances timeseries model.

| | |
| - | - |
| Access | Spot-dex-protocols-dataset |
| Tabular model | `spot-dex-liquidity-balances`: primary key `id` |
| Timeseries model | `spot-dex-liquidity-balances`: intervals `1d`, series key `id` (Spot DEX Liquidity Balance ID), series must be named (up to 20 per call) |

## Endpoints

> **[List Spot DEX Liquidity Balances](https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/tabular-spot-dex-liquidity-balances.md)**
>
> One page of rows with per-column filters, sorting and pagination.

> **[Batch Get Spot DEX Liquidity Balance timeseries](https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-liquidity-balances.md)**
>
> Up to 20 series in one request, named by Spot DEX Liquidity Balance ID in `series`.

> **[Get Spot DEX Liquidity Balance timeseries](https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-liquidity-balances-by-id.md)**
>
> One series over a time window, keyed by its Spot DEX Liquidity Balance ID.

## Metrics

2 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order.

| Field | Name | Type | Unit | Description |
| - | - | - | - | - |
| `balance` | Balance | float64 | | Token balance held as liquidity, in native units. |
| `balanceUSD` | Balance (USD) | float64 | | Token balance held as liquidity in USD. |

## 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 spot-dex-liquidity-balances timeseries model, the chain, exchange id, exchange version, exchange type and token address, joined with underscores. (primary key) |
| `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the balance, the exchange deployment and token. |
| `slug` | string | `Eq`, `IsOneOf` | yes | The exchange's project slug, the slug used for the same project across the API; null when unmapped. |
| `chain` | string | `Eq`, `IsOneOf` | yes | The short name of the chain (ethereum, base, solana). |
| `exchangeID` | string | `Eq`, `IsOneOf` | yes | The exchange's identifier (uniswap, aerodrome, trader-joe). |
| `exchangeVersion` | string | `Eq`, `IsOneOf` | | The exchange version or deployment (v3, slipstream, lb-2.1). |
| `exchangeType` | string | `Eq`, `IsOneOf` | | The exchange design (concentrated-liquidity, constant-product, orderbook); unlabeled where unknown. |
| `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); unlabeled for the unclassified-token remainder. |
| `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. |

## Example

```bash curl theme={null}
curl "https://api.blockworks.com/query/timeseries/spot-dex-liquidity-balances/1d/<id>?timeframe=7d&selections=balance,balanceUSD" \
  -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY"
```

See [Get Spot DEX Liquidity Balance timeseries](https://docs.blockworks.com/api-reference/data-api/spot-dex-protocols/timeseries-spot-dex-liquidity-balances-by-id.md) for the response and the errors.


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