Okx
live CryptoMarketsOKX v5 public API — tickers, orderbooks, OHLC candles, funding rates, mark prices, and index data for crypto spot/futures/options.
Tools
instruments OKX crypto exchange — list instruments by type: 'SPOT', 'MARGIN', 'SWAP', 'FUTURES', or 'OPTION'. Returns instrument IDs, tick sizes, lot sizes, and trading rules for each.
No parameters required.
Try it
ticker OKX crypto exchange — single instrument ticker (e.g. "BTC-USDT", "BTC-USD-SWAP"). Returns bid/ask, last, 24h vol/change. Use for current pricing of an OKX-listed instrument.
No parameters required.
Try it
tickers OKX crypto exchange — bulk tickers by instrument type ("SPOT", "MARGIN", "SWAP", "FUTURES", "OPTION"). Use to enumerate all spot or all perp instruments. NOT a general stock-ticker search — use polygo
No parameters required.
Try it
order_book OKX crypto exchange order book (bids + asks) for a spot/perp/futures instrument. Use for live depth-of-book on OKX-listed instruments.
No parameters required.
Try it
candles OKX crypto exchange OHLC candles for a spot/perp/futures instrument. Bars 1m through 1M. Use for charting and backtesting OKX instruments.
No parameters required.
Try it
trades OKX crypto exchange recent trade tape for an instrument. Returns price, size, side, timestamp. Use for tick-level execution analysis on OKX.
No parameters required.
Try it
market_24hr OKX crypto exchange 24-hour rolling stats for an instrument: open, high, low, last, volume, vol-ccy. Use for daily summary on OKX.
No parameters required.
Try it
index_tickers OKX crypto exchange index tickers — current index price and 24h change for OKX index instruments. Filter by quote currency (e.g. 'USD') or specific instId.
No parameters required.
Try it
funding_rate OKX crypto exchange current perpetual swap funding rate for a SWAP instrument (e.g. 'BTC-USDT-SWAP'): funding rate, next settlement time, and method.
No parameters required.
Try it
funding_rate_history OKX crypto exchange historical perpetual swap funding rates for a SWAP instrument (e.g. 'BTC-USDT-SWAP'). Optional before/after (ms epoch) cursors and limit. Use for funding cost analysis.
No parameters required.
Try it
mark_price OKX crypto exchange mark price for derivatives: pass instType (e.g. 'SWAP') and optionally uly or instId. Returns the mark price used for unrealised P&L and liquidation calculations.
No parameters required.
Try it
time OKX exchange server time in Unix milliseconds. Use to synchronise request timestamps or verify API connectivity.
No parameters required.
Try it
status OKX exchange system status — current operational state and any scheduled or ongoing maintenance windows affecting trading.
No parameters required.
Try it
perp_metrics Crypto perpetual futures snapshot in one call: funding rate, open interest, taker buy/sell volume (CVD) and long/short account ratio for a perpetual swap. Accepts exchange-style symbols such as 'MASKU
No parameters required.
Try it
open_interest Open interest for a crypto perpetual swap or dated futures contract on the OKX venue — contracts outstanding, coin-denominated size and USD notional, with timestamp. Accepts 'MASKUSDT', 'MASK' or 'MAS
No parameters required.
Try it
taker_volume Taker buy versus taker sell volume for a crypto perpetual contract on the OKX venue, bucketed by period. Returns the per-bucket series, the buy/sell ratio and cumulative volume delta (CVD) across the
No parameters required.
Try it
long_short_ratio Long/short account ratio for a crypto perpetual contract on the OKX venue — the ratio of accounts holding longs to accounts holding shorts, bucketed by period. A value above 1 means more accounts sit
No parameters required.
Try it
Test with curl
The gateway speaks JSON-RPC 2.0 over HTTP POST. You can test any pack directly from the terminal.
curl -X POST https://gateway.pipeworx.io/okx/mcp \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'curl -X POST https://gateway.pipeworx.io/okx/mcp \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"instruments","arguments":{}}}'Use with the SDK
Install @pipeworx/sdk to call tools from any TypeScript/Node project.
import { Pipeworx } from '@pipeworx/sdk';
const px = new Pipeworx();
const result = await px.call("instruments", {});// Or ask in plain English:
const answer = await px.ask("okx v5 public api — tickers, orderbooks, ohlc candles, funding rates, mark prices, and index data for crypto spot/futures/options");