Token API CLI @pinax/token-api

Power your apps & AI agents with real-time token data.

Overview

The @pinax/token-api-cli provides a CLI for The Graph's Token API. Access blockchain token information including:

• Token Transfers - ERC-20 and native token transfers
• DEX Swaps - Uniswap and other DEX swap events
• Token Metadata - Symbol, name, decimals, supply
• Balances - Real-time token holdings
• Prices - Current USD prices and OHLCV data
• Liquidity Pools - DEX pool information

Supported Networks

The SDK provides typed chain constants for type-safe network selection:

• EVM Chains: Ethereum, ArbitrumOne, Unichain, Base, Optimism, Polygon, BNB Chain & Avalanche.
• Solana: Mainnet.
• Tron: Mainnet.

Supported environment variables

| Variable | Description | |----------|-------------| | TOKENAPI_KEY | API Token (Authentication JWT) | | TOKEN_API_BASE_URL | Custom base URL for the Token API |

CLI Usage

The SDK includes a command-line interface for quick access to the Token API.

Installation

After installing the package globally, you can use the CLI directly:

npm install -g @pinax/token-api-cli

or call npmx without global install:

npx @pinax/token-api-cli evm tokens transfers --network mainnet --limit 10

Commands

# EVM token transfers
token-api evm tokens transfers --network mainnet --from 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 --limit 10

# EVM token balances
token-api evm tokens balances --network mainnet --address 0xd8da6bf26964af9d7eed9e03e53415d37aa96045

# EVM DEX swaps
token-api evm dexs swaps --network mainnet --limit 10

# SVM (Solana) token transfers
token-api svm tokens transfers --network solana --limit 10

# TVM (Tron) token transfers
token-api tvm tokens transfers --network tron --limit 10

# Monitoring commands
token-api monitoring health
token-api monitoring version
token-api monitoring networks

Development Usage

When running from the repository using npm run cli, use -- to separate npm arguments from CLI options:

# Correct usage with npm run
npm run cli -- evm tokens transfers --network mainnet --limit 10
npm run cli -- svm tokens transfers --network solana --limit 10
npm run cli -- monitoring health

Help

View all available commands and options:

token-api --help
token-api evm --help
token-api evm tokens --help
token-api evm tokens transfers --help

Development

Building from Source

# Clone the repository
git clone https://github.com/pinax-network/token-api-cli.git
cd token-api-cli

# Install dependencies
bun install

# Build the package
bun run build

Related Resources

• Token API Documentation
• The Graph Market - Get your API key
• Token API Repository

License

Apache 2.0 - see LICENSE for details.