OKX Cryptocurrency

by esshka

15 stars
Not rated
GitHub

About

Provides real-time cryptocurrency market data from OKX exchange through API endpoints for historical candlestick patterns and current price information

Details

Author
esshka
Repository
esshka/okx-mcp
GitHub stars
15
Categories
Cloud Service, Other, Finance, Design, Developer Tools, AI, Infrastructure, API, Frontend

This MCP server connects to the OKX API to provide cryptocurrency price information through a simple tool interface. It includes comprehensive error handling, request logging, and rate limiting via OKX's API.

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name OKX Cryptocurrency
    Command (node, npx, python, etc.) node
    Arguments
    • Argument 1 /path/to/okx-mcp-server/build/index.js

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

To use with Claude Desktop or VSCode, add the server config to your MCP settings:

macOS (VSCode):

~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json

macOS (Claude Desktop):

~/Library/Application Support/Claude/claude_desktop_config.json

Windows (VSCode):

%APPDATA%/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json

Windows (Claude Desktop):

%APPDATA%/Claude/claude_desktop_config.json

get_candlesticks

Retrieves historical candlestick (OHLCV) data for any instrument on OKX. Parameters: instrument (string, required), bar (string, optional), limit (number, optional)

get_price

Fetches the latest price and 24-hour market data for any instrument on OKX. Parameters: instrument (string, required)

get_candlesticks

Retrieves historical candlestick (OHLCV) data for any instrument on OKX.

- Input:
- instrument: String (required) - Instrument ID (e.g. "BTC-USDT")
- bar: String (optional) - Time interval (e.g. "1m", "5m", "1H", "1D"), default "1m"
- limit: Number (optional) - Number of candlesticks to return (max 100), default 100
- Output: Array of JSON objects, each containing:
- timestamp: ISO timestamp of the candlestick
- open: Opening price
- high: Highest price
- low: Lowest price
- close: Closing price
- volume: Trading volume
- volumeCurrency: Volume in currency terms

Example usage:

[
  {
    "timestamp": "2025-03-07T17:00:00.000Z",
    "open": "87242.8",
    "high": "87580.2",
    "low": "86548.0",
    "close": "87191.8",
    "volume": "455.72150427",
    "volumeCurrency": "39661166.242091111"
  }
]

get_price

Fetches the latest price and 24-hour market data for any instrument on OKX.

- Input:
- instrument: String (required) - Instrument ID (e.g. "BTC-USDT")
- Output: JSON object containing:
- instrument: The requested instrument ID
- lastPrice: Latest trade price
- bid: Current best bid price
- ask: Current best ask price
- high24h: 24-hour high price
- low24h: 24-hour low price
- volume24h: 24-hour trading volume
- timestamp: ISO timestamp of the data

Example usage:

{
  "instrument": "BTC-USDT",
  "lastPrice": "65432.1",
  "bid": "65432.0",
  "ask": "65432.2",
  "high24h": "66000.0",
  "low24h": "64000.0",
  "volume24h": "1234.56",
  "timestamp": "2024-03-07T17:22:28.000Z"
}

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "okx cryptocurrency": {
            "cwd": "string",
            "env": {},
            "args": [
                "/path/to/okx-mcp-server/build/index.js"
            ],
            "shell": false,
            "command": "node"
        }
    }
}

Linux

{
    "cwd": "string",
    "env": [],
    "args": [
        "/path/to/okx-mcp-server/build/index.js"
    ],
    "shell": false,
    "command": "node"
}

Macos

{
    "cwd": "string",
    "env": [],
    "args": [
        "/path/to/okx-mcp-server/build/index.js"
    ],
    "shell": false,
    "command": "node"
}

Windows

{
    "cwd": "string",
    "env": [],
    "args": [
        "/c",
        "node",
        "/path/to/okx-mcp-server/build/index.js"
    ],
    "shell": false,
    "command": "cmd"
}

A Model Context Protocol server that provides real-time cryptocurrency price data from OKX exchange.

This MCP server connects to the OKX API to provide cryptocurrency price information through a simple tool interface. It includes comprehensive error handling, request logging, and rate limiting via OKX's API.

Retrieves historical candlestick (OHLCV) data for any instrument on OKX.

- Input:

- instrument: String (required) - Instrument ID (e.g. "BTC-USDT")
- bar: String (optional) - Time interval (e.g. "1m", "5m", "1H", "1D"), default "1m"
- limit: Number (optional) - Number of candlesticks to return (max 100), default 100

- timestamp: ISO timestamp of the candlestick
- open: Opening price
- high: Highest price
- low: Lowest price
- close: Closing price
- volume: Trading volume
- volumeCurrency: Volume in currency terms

[ { "timestamp": "2025-03-07T17:00:00.000Z", "open": "87242.8", "high": "87580.2", "low": "86548.0", "close": "87191.8", "volume": "455.72150427", "volumeCurrency": "39661166.242091111" } ]

Fetches the latest price and 24-hour market data for any instrument on OKX.

- Input:

- instrument: String (required) - Instrument ID (e.g. "BTC-USDT")

- instrument: The requested instrument ID
- lastPrice: Latest trade price
- bid: Current best bid price
- ask: Current best ask price
- high24h: 24-hour high price
- low24h: 24-hour low price
- volume24h: 24-hour trading volume
- timestamp: ISO timestamp of the data

{ "instrument": "BTC-USDT", "lastPrice": "65432.1", "bid": "65432.0", "ask": "65432.2", "high24h": "66000.0", "low24h": "64000.0", "volume24h": "1234.56", "timestamp": "2024-03-07T17:22:28.000Z" }

To use with Claude Desktop or VSCode, add the server config to your MCP settings:

~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
~/Library/Application Support/Claude/claude_desktop_config.json
%APPDATA%/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
%APPDATA%/Claude/claude_desktop_config.json
{ "mcpServers": { "okx": { "command": "node", "args": ["/path/to/okx-mcp-server/build/index.js"], "disabled": false, "autoApprove": [] } } }

The server implements comprehensive error handling:

- Network errors are captured and returned with context
- Invalid instrument IDs return appropriate error messages
- API rate limits are respected through axios timeout configuration
- All errors are logged for debugging purposes

Realtime and Historical Exchange Rate Data, FX pairs, bid/ask, OHLC and Crypto prices

Streams real-time Binance Alpha token prices and liquidity data for AI agents and workflows.

Access Alpha Vantage financial data APIs to get real-time and historical stock data, forex rates, and cryptocurrency information.

Provides seamless access to the Binance exchange API. Requires Binance API credentials to be configured.

Interact with the Binance API to view portfolios, convert tokens, and execute trades with minimal market impact.

Access the Binance Futures API for trading, account management, and market data.

Interact with the Bitpin cryptocurrency exchange API to manage wallets, view market data, and execute orders.

Access Bybit's v5 API for real-time market data, trading operations, and account information.

Integrates with the Coincheck cryptocurrency exchange API.

Landau-Ginzburg market phase transition signals for financial markets. Agent-first MCP with x402 micropayment. Real-time HS300/BTC phase classification (SOLID/LIQUID/CRITICAL), SoTI sensing, daily briefings.

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.