okx-cex-market
Use this skill when the user asks for: price of any asset, ticker, order book, candles, OHLCV, funding rate, open interest, OI change scanner, market screener (top movers, high-volume, newly listed), mark price, index price, recent trades, instrument list, stock tokens, metals prices (gold, XAU, XAG
OKX CEX Market Data CLI
Compliance notice: This skill provides raw market data only. No strategy, recommendation, or optimization logic is embedded. All indicator outputs are objective numerical values; interpretation and trading decisions remain solely with the user.
Public market data for OKX: prices, order books, candles, funding rates, open interest, instrument info, and technical indicators. All commands are read-only and require no API credentials.
Skill routing
- Market data / indicators →
okx-cex-market(this skill) - Account balance / positions →
okx-cex-portfolio - Place / cancel orders →
okx-cex-trade - Trading a directional view as an event contract →
okx-cex-trade - Market sentiment / most bullish-bearish coins →
okx-sentiment-tracker - Grid / DCA / Smart Portfolio / Recurring Buy bots →
okx-cex-bot
Preflight
Before running any command, follow ../_shared/preflight.md.
Use metadata.version from this file's frontmatter as the reference for Step 2.
Install
npm install -g @okx_ai/okx-trade-cli
okx market ticker BTC-USDT # verify
Market data commands return the same public data regardless of demo/live mode — no API credentials required. If the user's profile has demo=true set and they want live data context, they can use --live to confirm they are in live mode (it has no effect on public market data but clarifies environment). Always inform the user which environment is active (demo or live) when it is relevant to their query. No confirmation needed before running any market command. Add --json to any command for raw OKX API v5 response. Add --env to wrap the output as {"env", "profile", "data"}.
Command Index
| # | Command | Description |
|---|---|---|
| 1 | okx market ticker <instId> | Last price, 24h high/low/vol/change% |
| 2 | okx market tickers <instType> | All tickers for SPOT / SWAP / FUTURES / OPTION |
| 3 | okx market instruments --instType <type> [--instId <id>] [--uly <uly>] [--instFamily <fam>] [--seriesId <id>] | List instruments (instId, ctVal, lotSz, minSz, tickSz, state); OPTION requires --uly or --instFamily; EVENTS requires --seriesId |
| 4 | okx market orderbook <instId> [--sz <n>] | Order book asks/bids (default top 5 per side, max 400) |
| 5 | okx market candles <instId> [--bar <bar>] [--limit <n>] [--after <ts>] [--before <ts>] | OHLCV candles (default --bar 1m; UTC+0 bars 6Hutc…3Mutc available from 6H up); auto-routes to historical endpoint for data back to 2021; --after paginates back in time, --before paginates forward |
| 6 | okx market index-candles <instId> [--bar <bar>] [--limit <n>] [--history] | Index OHLCV (use BTC-USD not BTC-USDT) |
| 7 | okx market funding-rate <instId> [--history] [--limit <n>] | Current or historical funding rate (SWAP only) |
| 8 | okx market trades <instId> [--limit <n>] [--history [--type <1|2>] [--after <id|ts>] [--before <id>]] | Recent public trades (default 20, max 500). --history pages through the last 3 months (max 100 per page); --type/--after/--before require --history and are rejected otherwise |
| 9 | okx market mark-price --instType <type> [--instId <id>] | Mark price (SWAP / FUTURES / OPTION) |
| 10 | okx market index-ticker [--instId <id>] [--quoteCcy <ccy>] | Index price (e.g., BTC-USD) |
| 11 | okx market price-limit <instId> | Upper/lower price limits (SWAP / FUTURES only) |
| 12 | okx market open-interest --instType <type> [--instId <id>] | Open interest in contracts and base currency |
| 13 | okx market instruments-by-category --instCategory <3|4|5|6|7> | Discover instruments by asset category: 3=Stock tokens (AAPL/TSLA), 4=Metals (gold/silver), 5=Commodities (oil/gas), 6=Forex (EUR/USD), 7=Bonds |
| 13† | okx market stock-tokens | Deprecated — use instruments-by-category --instCategory 3 instead |
| 14 | okx market filter --instType <SPOT|SWAP|FUTURES> [--sortBy <field>] [--sortOrder <asc|desc>] [--limit <n>] [--baseCcy <ccy>] [--quoteCcy <ccy>] [--settleCcy <ccy>] [--instFamily <fam>] [--ctType <linear|inverse>] [--minLast <n>] [--maxLast <n>] [--minChg24hPct <n>] [--maxChg24hPct <n>] [--minMarketCapUsd <n>] [--maxMarketCapUsd <n>] [--minVolUsd24h <n>] [--maxVolUsd24h <n>] [--minFundingRate <n>] [--maxFundingRate <n>] [--minOiUsd <n>] [--maxOiUsd <n>] | Screen / rank instruments by multi-dimensional criteria (price, volume, OI, funding rate, market cap). Prints Total: N + a ranked table of matching instruments (No results only when nothing matches). Add --json for the raw OKX API v5 response (structurally unchanged). |
| 15 | okx market oi-history <instId> [--bar <5m|15m|1H|4H|1D>] [--limit <n>] [--ts <ms>] | OI history time series with bar-over-bar delta for a single instrument |
| 16 | okx market oi-change --instType <SWAP|FUTURES> [--bar <5m|15m|1H|4H|1D>] [--sortBy <field>] [--sortOrder <asc|desc>] [--limit <n>] [--minOiUsd <n>] [--minVolUsd24h <n>] [--minAbsOiDeltaPct <n>] | Find instruments with largest OI changes (accumulation/distribution scanner) |
| 17 | okx market indicator list | List all supported indicator names and descriptions |
| 18 | okx market indicator <indicator> <instId> [--bar] [--params] [--list] [--limit] [--backtest-time] | Technical indicator values. Omit --params to use the indicator's default (e.g. MACD 12,26,9, BB 20,2, RSI 14, MA 5,20,60, EMA 5,20, Supertrend 3,10); the CLI prints params: … (default). If you pass --params it must be complete — too few or too many values is an error (e.g. --params 12,26 for macd). Full list of params and defaults: references/indicator-commands.md. Unknown indicator names are rejected. |
| 19 | okx market pair-spread <instIdA> <instIdB> [--bar <5m|15m>] [--window <window>] [--backtest-time <ms>] | Spread statistics (abs + ratio: mean/stdDev/median/min/max) over a lookback window; supports backtest mode |
Operation Flow
Step 1 — Identify data type and load reference
| User intent | Reference to load |
|---|---|
| Price, candles, order book, recent trades | {baseDir}/references/price-data-commands.md |
| Technical indicators (RSI, MACD, EMA, BB, KDJ, SuperTrend, AHR999, Rainbow, etc.) | {baseDir}/references/indicator-commands.md |
| Funding rate, mark price, open interest, price limit, index ticker | {baseDir}/references/derivatives-commands.md |
| Screen / rank instruments; find top movers, high-OI, high-volume contracts | Use okx market filter directly |
| OI history time series for a single instrument | Use okx market oi-history directly |
| OI change scanner; find contracts with large OI shifts | Use okx market oi-change directly |
| Pair spread statistics; mean-reversion / pairs-trade sizing | Use okx market pair-spread directly |
| List instruments, discover stock tokens, metals/commodities/forex/bonds, find option instIds | {baseDir}/references/instrument-commands.md |
| Multi-step or cross-skill workflows; MCP tool names | {baseDir}/references/workflows.md |
Event contracts are not served by this skill.
| User asks | Do |
|---|---|
| Which way an asset is moving — "is BTC going up", "what's the 15m trend" | Answer here with candles / indicators |
| Direction and whether they can trade it | Answer the data half here, then name okx-cex-trade for the trade half |
| To trade an event contract — "buy YES/NO on …" | Route to okx-cex-trade, serve nothing here |
Never substitute another product for an event contract — not a perp, not a futures position,
not market data presented as the contract they asked for. If you cannot load
okx-cex-trade, say so and stop.
Step 2 — Run commands immediately
All market data commands are read-only — no confirmation needed.
Step 3 — No writes, no verification needed
All commands in this skill are read-only.
Edge Cases
- instId format: SPOT
BTC-USDT· SWAPBTC-USDT-SWAP· FUTURESBTC-USDT-250328· OPTIONBTC-USD-250328-95000-C· IndexBTC-USD· Stock tokenTSLA-USDT-SWAP· Metals/Commodities/Forex/Bonds: useinstruments-by-categoryto discover valid instIds first - OPTION listing:
instruments --instType OPTIONrequires--uly BTC-USDor--instFamily BTC-USD; if unknown, runopen-interest --instType OPTIONfirst to discover active instIds - EVENTS listing:
instruments --instType EVENTSrequires--seriesId(e.g.--seriesId BTC-ABOVE-DAILY); runokx event seriesfirst to discover valid series IDs - funding-rate / price-limit: SWAP only · mark-price: SWAP / FUTURES / OPTION only
- candles
--bar: uppercase —1Hnot1h; use--after <ts>to paginate back into historical data (back to 2021); index-candles supports--historyfor extended history - ⚠️ Large historical range: before fetching with
--after/--before, estimate candle count =time_range_ms / bar_interval_ms. If estimate > 500, tell the user the estimated count and ask for confirmation before proceeding. This prevents silently filling the context window. --barsets differ by command: thecandleslist is not theindicatorlist. Read the matching reference (price-data-commands.md/indicator-commands.md) for each command's bars.- indicator
--bar: uses1Dutcnot1D,1Wutcnot1W— indicators accept only the values listed below (a subset of the candle bar values) market filtersortBy values:lastchg24hPctmarketCapUsdvolUsd24hfundingRateoiUsdlistTime— defaultvolUsd24hmarket filterctType:linearorinverse(SWAP/FUTURES only); omit for SPOTmarket filterquoteCcy: comma-separated list supported, e.g.--quoteCcy USDT,USDCmarket filterSPOT + quoteCcy: when--instType SPOT, the API returns instruments across all quote currencies (USDT, USDC, BTC, ETH, etc.) mixed together — this pollutes sort order and bloats results. Always pass--quoteCcy USDTby default unless the user explicitly asks for other quote currencies.market filterchg24hPct: value is a percentage number —--minChg24hPct -5means -5%,--maxChg24hPct 10means 10%market oi-historyts: Unix ms timestamp; returns bars with ts ≤ this value for historical paginationmarket oi-history/oi-changebar: valid values5m15m1H4H1D— default1H. Server accepts case variants (1h==1H) but prefer canonical casing.market oi-historylimit: 1–500 (default 50)market oi-changeinstType: onlySWAPorFUTURESsupported (not SPOT)market oi-changeminAbsOiDeltaPct: filters by absolute OI change —1.0keeps only rows where |oiDeltaPct| ≥ 1%market oi-changesortBy values:oiUsdoiDeltaUsdoiDeltaPctabsOiDeltaPctvolUsd24hfundingRatelast— defaultoiDeltaPct(signed). UseabsOiDeltaPctto rank by |oiDeltaPct| (largest magnitude regardless of direction).market oi-changelimit: 1–100 (default 20). For deeper than 100 rows, fetchoi-historyper instId.- indicator
--barvalid values:3m5m15m1H4H12Hutc1Dutc3Dutc1Wutc—1mis not supported for indicators (usecandlesfor 1-minute data) - indicator
--limit: 1–100 (only used withreturnList, i.e. when a historical series is requested) - indicator arg order: indicator name before instId —
okx market indicator rsi BTC-USDT - indicator
--params: either omit it (default used) or pass the complete set — comma-separated integers, no spaces, given once:--params 12,26,9. Fixed-length indicators need exactly the full set (macd 3, kdj 3, bb 2, supertrend 2 asfactor,atrPeriod, stoch-rsi 4, …); ma/ema/rsi/wr/wma/dema/tema/zlema/hma/kama take one or more periods. Periods are 2–365; the bb multiplier and supertrend factor are 1–9; alphatrend and halftrend take any int32 integer (negative allowed, no 2–365 range). A leading negative value parses (--params -9,3,3) but is rejected as out of range where the slot is a period or factor. Non-numeric tokens, a wrong count or an out-of-range value fail with an error that shows the expected signature, default and example; a repeated--paramsfails withspecify --params once, comma-separated. Indicators not covered by the params contract (obv, vwap, sar, …) have no default and no count or range check, but malformed values (non-numeric,null, overflow) are still rejected. - indicator no values returned: (1) explicit
--paramsand no timeframe returns values → table mode fails withNo values returned for <indicator> with params [...](the period may exceed the available candles), exit code 1;--jsonprints the raw backend data and exits 0 as before. (2)--paramsomitted and a default was applied (theparams: … (default)line is shown) → printsNo indicator values returned for the default params; there may not be enough candles for this instrument and bar.(3)--paramsomitted for an indicator without a default → printsNo indicator values returned. This indicator may require a period — try --params (e.g. --params 14). - BTC-only indicators:
ahr999,rainbow— BTC-USDT only - Unknown indicator name: returns a
ValidationErrorwith similar-name suggestions before the API is called — usemarket_list_indicators/okx market indicator listto see all valid names - Stock token hours: US stocks trade Mon–Fri ~09:30–16:00 ET; verify live price before acting
- No data returned: instrument may be delisted — verify with
okx market instruments bollis an alias forbb
Global Notes
- No API key required for any command in this skill
- Rate limit: 20 req / 2 s per IP
- Candle data is sorted newest-first
vol24his in base currency (e.g., BTC for BTC-USDT)--demo/--liveand--profiledo not affect market data results via CLI (public endpoints); they only determine the active trading environment context
Related skills
- Downloads
- Security audit
- Pass
- Last updated
- 5d ago
- Current version
- v1.5.1
- License
- MIT-0
