CtrlK
BlogDocsLog inGet started
Tessl Logo

okx-market

OKX cryptocurrency market data interface. Uses the OKX V5 REST API to retrieve spot, derivatives, index, and other crypto market data, including real-time prices, candlesticks, funding rates, open interest, and more. No authentication required, free to use.

68

Quality

83%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

OKX Market

Overview

The OKX V5 REST API provides comprehensive cryptocurrency market data covering spot, perpetual swaps, delivery futures, options, and more. All market-data endpoints are public and can be called directly without authentication. The data comes from OKX, the world's second-largest cryptocurrency exchange.

Quick Start

  • Install a Python runtime (Python 3.9+ recommended) and the required requests dependency.
pip install requests pandas
  • No account registration or token configuration is required. Market-data endpoints are fully open.
  • Review the endpoint documentation below and locate the interface you need.
  • Use Python code to retrieve data according to the documentation. Example for the spot ticker endpoint:
import requests
import pandas as pd

BASE_URL = "https://www.okx.com/api/v5"

# Get the latest BTC-USDT market quote
resp = requests.get(f"{BASE_URL}/market/ticker", params={"instId": "BTC-USDT"})
data = resp.json()["data"][0]
print(f"BTC last price: {data['last']}  24h change: {float(data['last'])/float(data['open24h'])*100-100:.2f}%")

Parameter Format Reference

  • Instrument format (instId):
    • Spot: BTC-USDT, ETH-USDT
    • Perpetual swap: BTC-USDT-SWAP, ETH-USDT-SWAP
    • Delivery futures: BTC-USDT-250328 (expiry date in YYMMDD)
    • Options: BTC-USD-250328-95000-C (expiry-strike-C/P)
    • Index: BTC-USD, ETH-USD
  • Candlestick interval (bar): 1m, 3m, 5m, 15m, 30m, 1H, 2H, 4H, 6H, 12H, 1D, 1W, 1M
  • Instrument type (instType): SPOT (spot), SWAP (perpetual), FUTURES (delivery), OPTION (option)
  • Timestamp: millisecond Unix timestamp (for example 1773763200000)
  • Response format: JSON. code=0 indicates success, and data is returned in the data field

Link convention: every link to references/ in this document is written with the skill-name prefix (for example okx-market/references/...). The read_file tool resolves paths rooted at skills/, so omitting the prefix makes the read fail. When adding new skill docs, always use the <skill-name>/references/... form.

Python Script Examples

  • Market data retrieval example
  • Candlestick data retrieval example

Market Data Endpoint List

IDEndpoint PathTitle (Detailed Documentation)CategoryDescription
1/market/tickerSingle TickerSpot MarketRetrieve the latest market data for a single trading instrument, including last price, bid/ask, 24h volume, and more
2/market/tickersBatch TickersSpot MarketRetrieve all market data for a given instrument class (SPOT/SWAP/FUTURES/OPTION) in batch
3/market/candlesCandlestick DataSpot MarketRetrieve candlestick (OHLCV) data with multiple supported intervals
4/market/tradesRecent TradesSpot MarketRetrieve recent trade-level details
5/public/instrumentsInstrument ListSpot MarketRetrieve metadata for all tradable instruments, including minimum order size and price precision
6/market/booksOrder Book DepthSpot MarketRetrieve bid/ask order book depth data
7/public/funding-rateFunding RateDerivatives MarketRetrieve current and historical funding rates for perpetual contracts
8/public/funding-rate-historyHistorical Funding RateDerivatives MarketRetrieve historical funding-rate data for perpetual contracts
9/public/mark-priceMark PriceDerivatives MarketRetrieve mark prices for derivatives, used for PnL and liquidation calculations
10/public/open-interestOpen InterestDerivatives MarketRetrieve open-interest data for derivatives
11/public/price-limitPrice LimitDerivatives MarketRetrieve the current maximum and minimum price limits for derivatives
12/market/index-tickersIndex TickersIndex MarketRetrieve index price market data
13/market/index-candlesIndex CandlesIndex MarketRetrieve index candlestick data
Repository
HKUDS/Vibe-Trading
Last updated
First committed

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.