Skip to content

Quick Start

Get up and running in 3 minutes — install, configure, and make your first trade.

Step 1 — Install

bash
npm install -g toobit-trade-mcp toobit-trade-cli

Verify installation:

bash
toobit market ticker --symbol BTCUSDT

TIP

Market data works immediately without an API Key.

Step 2 — Add Toobit API Credentials

Create the config file ~/.toobit/config.toml:

toml
# ~/.toobit/config.toml
default_profile = "live"

[profiles.live]
api_key    = "your-api-key"
secret_key = "your-secret-key"

# Sub-account config (optional)
# [profiles.sub]
# api_key    = "sub-account-api-key"
# secret_key = "sub-account-secret-key"

Get API Key: Log in to toobit.com → Settings → API Keys → Create New API Key

WARNING

Never paste your API Key or Secret Key into an AI chat. All credentials should only be stored in the local config file. We recommend using a sub-account API Key with only the minimum required permissions.

Step 3 — Connect to an AI Client

For Cursor, create .cursor/mcp.json in your project root:

json
{
  "mcpServers": {
    "toobit-trade": {
      "command": "toobit-trade-mcp",
      "args": ["--modules", "all"]
    }
  }
}

Supported AI Clients

ClientConfiguration
Cursor.cursor/mcp.json
Claude Desktopclaude_desktop_config.json
VS Code (Copilot).vscode/mcp.json
Windsurf~/.codeium/windsurf/mcp_config.json
Claude Codeclaude-code mcp add

Auto Setup

You can also use the setup command for automatic configuration:

bash
toobit-trade-mcp setup --client <client>
Client<client> value
Claude Desktopclaude-desktop
Claude Codeclaude-code
Cursorcursor
VS Codevscode
Windsurfwindsurf

Step 4 — Try It Out

Open your AI client and type natural language:

# Query market data
What's the current price of BTC?

# Check account
Show my spot account balance

# Futures operations
What's the funding rate for ETH futures?

# Depth analysis
Show the BTC order book and analyze buy/sell pressure

Or use the CLI directly:

bash
# Market data (no API Key needed)
toobit market ticker --symbol BTCUSDT
toobit market candles --symbol BTCUSDT --interval 1h --limit 10

# Spot trading
toobit spot place --symbol BTCUSDT --side BUY --type MARKET --quantity 0.001

# Futures trading (use contract symbol format: BTC-SWAP-USDT)
toobit futures place --symbol BTC-SWAP-USDT --side BUY_OPEN --orderType MARKET --quantity 1 --leverage 10

# Account
toobit account balance

Released under the MIT License.