tickdb

Real-time market data from the command line.

Covers forex, precious metals, indices, US/HK/A-shares, and crypto — 37,500+ symbols via the TickDB unified API.

Install

npm install -g tickdb

Requires Node.js ≥ 18.

Quick Start

# 1. Get a free API key at https://tickdb.ai
# 2. Save it locally
tickdb config set-key YOUR_KEY

# 3. Start querying
tickdb ticker BTCUSDT
tickdb ticker BTCUSDT,XAUUSD,AAPL.US,700.HK

Commands

Market Data

| Command | Description | |---------|-------------| | tickdb ticker <symbols> | Real-time price snapshots | | tickdb kline <symbol> -i <interval> | Historical K-line (OHLCV) candles | | tickdb kline-latest <symbols> -i <interval> | Live (incomplete) K-line candle | | tickdb depth <symbol> | Order book (bids and asks) | | tickdb trades <symbol> | Recent executed trades | | tickdb symbols | List tradable symbols (37,527+) | | tickdb intervals | List supported K-line intervals |

Stock Data

| Command | Description | |---------|-------------| | tickdb stock-info <symbols> | Stock fundamentals (name, lot, EPS, BPS, dividend) | | tickdb intraday <symbols> | Today's minute-by-minute price | | tickdb sessions -m <market> | Trading session schedule | | tickdb trade-days -m <market> --from --to | Trading calendar | | tickdb metrics <symbols> | Market metrics (PE, PB, market cap) | | tickdb capital-flow <symbol> | Capital flow analysis |

Configuration

| Command | Description | |---------|-------------| | tickdb config set-key <key> | Save API key locally | | tickdb config show-key | Show stored key (masked) | | tickdb config clear-key | Remove stored key |

Global Options

| Flag | Description | |------|-------------| | -k, --key <key> | Override API key for a single call | | -t, --type <type> | Asset type for disambiguation (stock, crypto, forex, futures, indices) | | -j, --json | Output raw JSON instead of formatted tables | | -V, --version | Show version | | -h, --help | Show help |

Examples

# Price snapshots — crypto, forex, stocks
tickdb ticker BTCUSDT,ETHUSDT
tickdb ticker XAUUSD,EURUSD
tickdb ticker AAPL.US,TSLA.US,700.HK

# Disambiguate symbols that exist in multiple markets
tickdb ticker 000070 -t stock
tickdb kline 000070 -i 1d -t stock

# K-line candles
tickdb kline BTCUSDT -i 1d --limit 10
tickdb kline XAUUSD -i 1h --limit 24

# Live candle
tickdb kline-latest BTCUSDT,XAUUSD -i 1h

# Order book
tickdb depth BTCUSDT -l 10

# Recent trades
tickdb trades 700.HK -l 20

# Discover symbols
tickdb symbols -t crypto -l 20
tickdb symbols -m US -l 10

# Stock fundamentals
tickdb stock-info AAPL.US,700.HK

# Intraday minute data
tickdb intraday AAPL.US

# Trading sessions & calendar
tickdb sessions -m US
tickdb trade-days -m HK --from 20260101 --to 20260131

# Market metrics
tickdb metrics AAPL.US,TSLA.US

# Capital flow
tickdb capital-flow 700.HK

# Raw JSON output
tickdb ticker BTCUSDT --json

API Key

You need a TickDB API key. Get one (free) at tickdb.ai.

Three ways to provide it (checked in this order):

1. --key flag: tickdb ticker BTCUSDT --key YOUR_KEY
2. Environment variable: export TICKDB_API_KEY=YOUR_KEY
3. Local config: tickdb config set-key YOUR_KEY

Keys are stored at ~/.config/tickdb/config.json.

License

MIT