> ## 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. 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                            | `dexpaprika-cli transactions ethereum 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640` |
| `pool-ohlcv`   | Historical OHLCV candles                           | `dexpaprika-cli pool-ohlcv ethereum 0x88e6... --start 2025-01-01`                 |
| `token`        | Token price and details                            | `dexpaprika-cli token ethereum 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2`        |
| `token-pools`  | All pools containing a token                       | `dexpaprika-cli token-pools ethereum 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2`  |
| `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`                                                            |

***

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

```bash theme={null}
dexpaprika-cli pool-ohlcv ethereum 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640 --start 2025-01-01
```

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

<AccordionGroup>
  <Accordion title="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.
  </Accordion>

  <Accordion title="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
    ```
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="Streaming disconnects">
    SSE streams can drop due to network issues. The `stream` command will show an error. Restart it -- the CLI handles reconnection. For production use, wrap it in a script with retry logic.
  </Accordion>
</AccordionGroup>

***

## Next steps

<CardGroup cols={2}>
  <Card title="REST API Reference" icon="bolt" href="/api-reference/introduction">
    Full endpoint documentation with interactive playground
  </Card>

  <Card title="Streaming API" icon="signal-stream" href="/streaming/introduction">
    Real-time price streaming docs
  </Card>

  <Card title="Common Patterns" icon="book" href="/knowledge-base/common-patterns">
    Standard API workflows
  </Card>

  <Card title="Vibe Coding with AI" icon="wand-magic-sparkles" href="/tutorials/vibe-coding-with-ai">
    Build projects with AI + DexPaprika
  </Card>
</CardGroup>

### FAQs

<AccordionGroup>
  <Accordion title="Do I need an API key?">
    No. The CLI uses the public DexPaprika API. No keys, no registration.
  </Accordion>

  <Accordion title="What are the rate limits?">
    Same as the REST API: 10,000 requests per day. Each CLI command makes one API call (except `stream`, which is a single long-lived SSE connection).
  </Accordion>

  <Accordion title="Does the CLI support the filter endpoint?">
    The filter endpoint can be accessed via the REST API directly. Check the [pool filtering tutorial](/tutorials/pool-filtering) for examples.
  </Accordion>

  <Accordion title="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.
  </Accordion>
</AccordionGroup>

<script type="application/ld+json">
  {JSON.stringify({
      "@context": "https://schema.org",
      "@type": "FAQPage",
      "mainEntity": [
        {"@type": "Question","name": "How do I install the DexPaprika CLI?","acceptedAnswer": {"@type": "Answer","text": "Run: curl -sSL https://raw.githubusercontent.com/coinpaprika/dexpaprika-cli/main/install.sh | sh. Pre-built binaries also available on GitHub releases for macOS, Linux, and Windows."}},
        {"@type": "Question","name": "Do I need an API key for the DexPaprika CLI?","acceptedAnswer": {"@type": "Answer","text": "No. The CLI uses the public DexPaprika API. No keys, no registration needed."}},
        {"@type": "Question","name": "What output formats does the DexPaprika CLI support?","acceptedAnswer": {"@type": "Answer","text": "Table (default for humans), JSON with metadata, and raw JSON for piping to jq and scripts."}},
        {"@type": "Question","name": "Can AI agents use the DexPaprika CLI?","acceptedAnswer": {"@type": "Answer","text": "Yes. AI agents can install it with one command and use --output json --raw for machine-readable output."}}
      ]
    })}
</script>