> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dexpaprika.com/llms.txt
> Use this file to discover all available pages before exploring further.

# DexPaprika CLI: DEX data from your terminal

> Install the DexPaprika CLI with one command. Query token prices, pool data, OHLCV history, transactions, and stream live prices from your terminal. Supports macOS, Linux, and Windows.

## What is the DexPaprika CLI?

A fast, standalone command-line tool for querying on-chain DEX data. Written in Rust. Covers the entire DexPaprika API: token prices, pools, OHLCV, transactions, search, pool filtering, and real-time price streaming via SSE.

No API key needed to start. No dependencies. One binary.

**Source:** [github.com/coinpaprika/dexpaprika-cli](https://github.com/coinpaprika/dexpaprika-cli)

***

## Install

### One-line install (macOS, Linux)

```bash theme={null}
curl -sSL https://raw.githubusercontent.com/coinpaprika/dexpaprika-cli/main/install.sh | sh
```

Downloads the latest release binary for your platform and puts it in `~/.local/bin`. You can override the install path:

```bash theme={null}
DEXPAPRIKA_INSTALL_DIR=/usr/local/bin curl -sSL https://raw.githubusercontent.com/coinpaprika/dexpaprika-cli/main/install.sh | sh
```

### Download from GitHub

Pre-built binaries for every platform are on the [releases page](https://github.com/coinpaprika/dexpaprika-cli/releases):

| Platform | Binary |
| - | - |
| macOS (Apple Silicon) | `dexpaprika-cli-{version}-darwin-aarch64.tar.gz` |
| macOS (Intel) | `dexpaprika-cli-{version}-darwin-x86_64.tar.gz` |
| Linux (x86\_64) | `dexpaprika-cli-{version}-linux-x86_64.tar.gz` |
| Linux (ARM64) | `dexpaprika-cli-{version}-linux-aarch64.tar.gz` |
| Windows (x86\_64) | `dexpaprika-cli-{version}-windows-x86_64.zip` |

### Build from source

Requires [Rust](https://rustup.rs/):

```bash theme={null}
cargo install --git https://github.com/coinpaprika/dexpaprika-cli
```

### Verify installation

```bash theme={null}
dexpaprika-cli status
```

You should see a health check response confirming the API is reachable.

***

## Commands

Every DexPaprika REST API endpoint has a matching CLI command:

| Command | What it does | Example |
| - | - | - |
| `stats` | Ecosystem overview (total networks, pools, tokens) | `dexpaprika-cli stats` |
| `networks` | List all supported chains | `dexpaprika-cli networks` |
| `dexes` | DEXes on a network | `dexpaprika-cli dexes ethereum` |
| `pools` | Top pools on a network | `dexpaprika-cli pools ethereum --limit 5` |
| `pool` | Single pool details | `dexpaprika-cli pool ethereum 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640` |
| `dex-pools` | Pools on a specific DEX | `dexpaprika-cli dex-pools ethereum uniswap_v3` |
| `transactions` | Recent swaps for a pool. Dev or Pro key on the paid host | `dexpaprika-cli transactions ethereum 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640` |
| `pool-ohlcv` | Historical OHLCV candles | `dexpaprika-cli pool-ohlcv ethereum 0x88e6... --start $(date -u +%F) --interval 1h` |
| `pool-indicator` | RSI, EMA, MACD, Bollinger Bands or VWAP for a pool. CLI 0.10.0+ | `dexpaprika-cli pool-indicator ethereum 0x88e6... --indicator rsi --interval 1h` |
| `token` | Token price and details | `dexpaprika-cli token ethereum 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2` |
| `token-pools` | All pools containing a token | `dexpaprika-cli token-pools ethereum 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2` |
| `token-indicator` | The same indicators for a token across all its pools. Dev or Pro key on the paid host, CLI 0.10.0+ | `dexpaprika-cli token-indicator ethereum 0xc02a... --indicator rsi --interval 1h` |
| `prices` | Batch token prices (up to 10) | `dexpaprika-cli prices ethereum --tokens 0xc02a...,0xdac1...` |
| `search` | Search tokens, pools, DEXes | `dexpaprika-cli search uniswap` |
| `stream` | Real-time SSE price stream | `dexpaprika-cli stream ethereum 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2` |
| `status` | API health check | `dexpaprika-cli status` |
| `attribution` | License attribution snippets | `dexpaprika-cli attribution` |
| `onboard` | Quick start walkthrough | `dexpaprika-cli onboard` |
| `shell` | Interactive REPL mode | `dexpaprika-cli shell` |

> [!NOTE]
>
> `dex-pools` reads pool search with a `dex_name` filter. The REST path it used to call,
> `GET /networks/{network}/dexes/{dex}/pools`, was removed and returns `410 Gone`, so an older
> build of the CLI fails on that command until you upgrade. The command name and arguments are
> unchanged; in `--raw` JSON the rows arrive under `results` with `has_next_page` and
> `next_cursor`, and the 24h volume field is `volume_usd_24h`.

***

## Output formats

The CLI outputs tables by default. Switch to JSON for scripting and piping:

```bash theme={null}
# Table output (default, human-readable)
dexpaprika-cli pools ethereum

# JSON with metadata wrapper
dexpaprika-cli --output json pools ethereum

# Raw JSON (no _meta wrapper, for piping to jq)
dexpaprika-cli --output json --raw pools ethereum
```

Pipe raw JSON into `jq` for filtering:

```bash theme={null}
dexpaprika-cli --output json --raw token ethereum 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 | jq '.summary.price_usd'
```

***

## Examples

### Get a token price

```bash theme={null}
dexpaprika-cli token solana So11111111111111111111111111111111111111112
```

### Search for a token you don't know the address of

```bash theme={null}
dexpaprika-cli search jupiter
```

### List top pools by volume

```bash theme={null}
dexpaprika-cli pools ethereum --limit 10
```

### Get OHLCV history for a pool

Without a key, OHLCV reaches back 24 hours at `1h` and up, so start from today (UTC). A free key reaches 7 days at `10m` and longer; see [OHLCV limits by plan](https://docs.dexpaprika.com/knowledge-base/rate-limits.md#ohlcv-limits-by-plan).

```bash theme={null}
dexpaprika-cli pool-ohlcv ethereum 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640 --start "$(date -u +%F)" --interval 1h
```

### Get a technical indicator for a pool

`pool-indicator` returns RSI, EMA, MACD, Bollinger Bands or VWAP computed from the pool's candles, on every plan with the same interval and history limits as `pool-ohlcv`. `--indicator` is required; pass only the parameters the chosen indicator uses (`--period`; `--fast-period`, `--slow-period` and `--signal-period` for macd; `--std-dev` for bbands), because one that belongs to another indicator is refused with a `400`. Needs CLI 0.10.0 or later.

```bash theme={null}
dexpaprika-cli pool-indicator ethereum 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640 --indicator rsi --interval 1h --start -24h
dexpaprika-cli pool-indicator ethereum 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640 --indicator macd --interval 1h
```

`token-indicator` takes the same flags for a token across all its pools and needs a Dev or Pro key on the paid host. See the [technical indicators tutorial](https://docs.dexpaprika.com/tutorials/technical-indicators.md).

### Stream live prices

```bash theme={null}
# Single token -- streams until you hit Ctrl+C
dexpaprika-cli stream ethereum 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2

# Stop after 50 price updates
dexpaprika-cli stream ethereum 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 --limit 50

# Multiple tokens from a JSON watchlist file
dexpaprika-cli stream --tokens watchlist.json --limit 100
```

### Interactive REPL

```bash theme={null}
dexpaprika-cli shell
```

Opens an interactive session where you can run commands without typing `dexpaprika-cli` each time.

### Batch prices for a portfolio

```bash theme={null}
dexpaprika-cli prices ethereum --tokens 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2,0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48,0x6b175474e89094c44da98b954eedeac495271d0f
```

***

## Use with AI agents

AI agents running in terminals (Claude Code, Aider, etc.) can install and use the CLI as a tool. The one-liner install works in any shell:

```bash theme={null}
curl -sSL https://raw.githubusercontent.com/coinpaprika/dexpaprika-cli/main/install.sh | sh
```

Once installed, agents can call `dexpaprika-cli` directly with `--output json --raw` for machine-readable output. This is useful when:

* The agent doesn't have MCP support
* You want the agent to script data pipelines
* You need to pipe output into other tools (`jq`, `csvkit`, scripts)
* You're running headless or in CI/CD

**Example agent workflow:**

```bash theme={null}
# Agent searches for a token
dexpaprika-cli --output json --raw search "pepe" | jq '.tokens[0]'

# Agent gets the price
dexpaprika-cli --output json --raw token ethereum 0x6982508145454ce325ddbe47a25d4ec3d2311933 | jq '.summary.price_usd'

# Agent finds the top pool
dexpaprika-cli --output json --raw token-pools ethereum 0x6982508145454ce325ddbe47a25d4ec3d2311933 | jq '.[0]'
```

***

## Troubleshooting

> **Command not found after install**
>
> The installer puts the binary in `~/.local/bin`. If that's not in your PATH, add it:
>
> ```bash theme={null}
> export PATH="$HOME/.local/bin:$PATH"
> ```
>
> Add that line to your `~/.bashrc`, `~/.zshrc`, or `~/.profile` to make it permanent.

> **Permission denied during install**
>
> The installer tries `~/.local/bin` first (no sudo needed). If it falls back to `/usr/local/bin`, it will ask for sudo. You can also set a custom directory:
>
> ```bash theme={null}
> DEXPAPRIKA_INSTALL_DIR=~/bin curl -sSL https://raw.githubusercontent.com/coinpaprika/dexpaprika-cli/main/install.sh | sh
> ```

> **No data returned for a token**
>
> Check the network ID (must be lowercase: `ethereum`, not `Ethereum`) and verify the token address. Use `dexpaprika-cli search <name>` to find the correct network and address.

> **Streaming disconnects**
>
> SSE streams can drop due to network issues. The `stream` command will show an error. Restart it and the CLI handles reconnection. For production use, wrap it in a script with retry logic.

***

## Next steps

> **[REST API Reference](https://docs.dexpaprika.com/api-reference/introduction.md)**
>
> Full endpoint documentation with interactive playground

> **[Streaming API](https://docs.dexpaprika.com/streaming/introduction.md)**
>
> Real-time price streaming docs

> **[Common Patterns](https://docs.dexpaprika.com/knowledge-base/common-patterns.md)**
>
> Standard API workflows

> **[Vibe Coding with AI](https://docs.dexpaprika.com/ai-integration/vibe-coding-with-ai.md)**
>
> Build projects with AI + DexPaprika

### FAQs

> **Do I need an API key?**
>
> No. Without one the CLI calls the API keyless, metered per IP against the keyless allowance. A [free key from the console](https://console.dexpaprika.com/dashboard) raises the allowance and opens 7 days of OHLCV at `10m` and longer. Store it with `dexpaprika-cli config set-key <KEY>`, pass `--api-key <KEY>` on a single command, or set `DEXPAPRIKA_API_KEY`; `dexpaprika-cli config show` tells you which key is in use. On Dev, Pro or Enterprise, point the CLI at the paid host with `--base-url https://api-pro.dexpaprika.com` or `DEXPAPRIKA_API_BASE_URL` (0.9.0 and later); `transactions` and `token-ohlcv` need it. See [upgrading to Pro](https://docs.dexpaprika.com/api-pro/upgrading.md).

> **What are the rate limits?**
>
> Same as the REST API: 10,000 credits per rolling 30 days without a key at 15 requests a minute, 100,000 with a [free key](https://console.dexpaprika.com) at 30 requests a minute. Each CLI command makes one API call. `stream` opens a single long-lived SSE connection, and each price update it delivers costs one credit, the same as a REST call. A stream left running all month can outgrow the free allowance, so see [Pro pricing](https://dexpaprika.com/api/pricing) if you need 5,000,000 credits at 500 requests a minute.

> **Does the CLI support the filter endpoint?**
>
> The filter endpoint can be accessed via the REST API directly. Check the [pool filtering tutorial](https://docs.dexpaprika.com/tutorials/pool-filtering.md) for examples.

> **Can I use the CLI on Windows?**
>
> Yes. Download the Windows binary from the [releases page](https://github.com/coinpaprika/dexpaprika-cli/releases). The install script works on macOS and Linux only.


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