kaiko-cli

Command-line interface for the Kaiko REST API. Covers all 40+ endpoints. Designed for both AI agents (JSON output) and human analysts (table/CSV output).

Install

npm install -g kaiko-cli

Or run without installing:

npx kaiko-cli assets list

Authentication

Reference data endpoints (assets, exchanges, instruments) are public and need no key.

Market data endpoints require a Kaiko API key:

export KAIKO_API_KEY=your_api_key_here

Add to ~/.zshrc or ~/.bashrc to persist across sessions.

Usage

kaiko <group> <command> [options]

Reference data (no auth required)

kaiko assets list
kaiko exchanges list
kaiko instruments list --exchange cbse --class spot
kaiko protocols list
kaiko pools list
kaiko blockchains list

Market data

# Trades
kaiko trades get --exchange cbse --class spot --instrument btc-usd

# OHLCV / VWAP
kaiko ohlcv get --exchange cbse --class spot --instrument btc-usd --interval 1h
kaiko ohlcv vwap --exchange cbse --class spot --instrument btc-usd --interval 1h

# Order book
kaiko orderbook depth --exchange cbse --class spot --instrument btc-usd
kaiko orderbook slippage --exchange cbse --class spot --instrument btc-usd

# Analytics / pricing
kaiko price direct --base btc --quote usd
kaiko price synthetic --base eth --quote eur

# Derivatives
kaiko risk iv-smile --base btc --quote usd --expiry 2026-06-26 --value-time 2026-03-14T12:00:00Z
kaiko risk metrics --base btc --quote usd

# Monitoring
kaiko metrics asset --asset btc
kaiko supply get --asset btc
kaiko tvl get --protocol uniswap

# Wallets
kaiko wallet audit --blockchain ethereum --user-address 0x1234...

Output formats

Default is JSON. Use --format to change:

kaiko assets list --format table
kaiko ohlcv get --exchange cbse --class spot --instrument btc-usd --format csv > data.csv

Format	Use case
json	Agent consumption, scripting (default)
table	Human-readable terminal output
csv	Export to spreadsheet or analysis tool

JSON output always has this shape:

{ "data": [...], "count": 42 }

Global flags

Flag	Default	Description
--format <json|table|csv>	json	Output format
--region <us|eu>	us	API region
--no-paginate	—	Return first page only
--page-size <n>	—	Results per page
--max-pages <n>	10	Max pages to auto-fetch
--verbose	—	Show request URL and response headers
--quiet	—	Suppress all non-data output
--no-color	—	Disable color in table output

Command groups

Group	Commands	API section
assets	list	A1
exchanges	list	A2
instruments	list	A3
protocols	list	A4
pools	list	A5
blockchains	list	A6
derivatives	contracts, prices	B1–B2
trades	get, liquidations, lending-events	C1–C3
ohlcv	get, vwap, full	D1–D3
orderbook	depth, depth-agg, slippage, slippage-agg, spread, raw, full	E1–E7
liquidity	reserves, reserves-v3, rates, events	E8–E10, F1
price	direct, synthetic, fx, principal, state	G1–G5
risk	metrics, liquidations, iv-smile, iv-surface, var, valuation	H1–H4, I1–I2
metrics	asset, exchange	J1–J2
supply	get, aggregated, ranking	J3–J5
tvl	get	J6
wallet	audit, transactions	K1–K4
cme	fixing, benchmarks	L1–L2
dlr	statistics	L3

Development

git clone https://github.com/alexandernacho/kaiko-cli
cd kaiko-cli
npm install
npm run build
npm test

To test locally:

npm run build && npm link
kaiko assets list

Requirements

• Node.js 18+
• Kaiko API key (for market data endpoints)

License

MIT