gate-cli

A command-line interface for the Gate API. Covers spot, futures, delivery, options, wallet, margin, alpha, tradfi, and account management. Designed for developers, quants, and AI agents.

Quick Start

• English Quick Start
• 中文快速上手

Features

• Spot — currencies, pairs, market data, account, orders, price-triggered orders
• Futures — contracts, market data, account, positions, orders, price-triggered orders, trailing stop orders
• Delivery — delivery contracts, market data, account, positions, orders, price-triggered orders
• Options — underlyings, contracts, market data, account, positions, orders, MMP
• Wallet — balances, deposits, withdrawals, transfers (main↔sub, cross-account)
• Account — account detail, rate limits, STP groups, debit fee settings
• Alpha — alpha token market data, account, orders
• TradFi — MT5 account, symbols, positions, orders, transactions
• Dual-position mode — add, remove, close automatically detect position direction; single and dual (hedge) mode handled transparently via the dual_comp API
• Two output modes — human-friendly table (default) or --format json for scripts and agents
• Multiple profiles — manage several API keys in one config file
• Credential priority — --api-key flag > env var > config file

Installation

git clone https://github.com/gate/gate-cli.git
cd gate-cli
go build -o gate-cli .

Configuration

gate-cli config init          # interactive setup → ~/.gate-cli/config.yaml

Or use environment variables:

export GATE_API_KEY=your-key
export GATE_API_SECRET=your-secret

Usage examples

# Public market data — no API key required
gate-cli spot market ticker --pair BTC_USDT
gate-cli futures market funding-rate --contract BTC_USDT
gate-cli delivery market contracts
gate-cli options market underlyings

# Account & wallet
gate-cli account detail
gate-cli spot account list
gate-cli wallet balance total
gate-cli wallet deposit list

# Spot orders
gate-cli spot order buy  --pair BTC_USDT --amount 0.001 --price 80000
gate-cli spot order buy  --pair BTC_USDT --quote 10          # market buy: spend 10 USDT
gate-cli spot order sell --pair BTC_USDT --amount 0.001

# Futures orders
gate-cli futures order long   --contract BTC_USDT --size 10 --price 80000
gate-cli futures order add    --contract BTC_USDT --size 5   # add to current position
gate-cli futures order close  --contract BTC_USDT            # close entire position

# Price-triggered & trailing stop orders
gate-cli futures price-trigger create --contract BTC_USDT --trigger-price 90000 --price 0 --size -10
gate-cli futures trail create --contract BTC_USDT --amount -10 --price-offset 0.02

# JSON output for scripting
gate-cli spot market ticker --pair BTC_USDT --format json | jq '.last'

See the Quick Start guide for a full walkthrough.

Global flags

Flag	Default	Description
--format	table	Output format: table or json
--profile	default	Config profile to use
--api-key	—	API key (overrides env and config file)
--api-secret	—	API secret (overrides env and config file)
--debug	false	Print raw HTTP request/response

Documentation

Document	Description
docs/quickstart.md	English quick start guide
docs/quickstart_zh.md	中文快速上手
docs/integration-test-plan.md	Integration test plan
docs/plans/2026-03-08-gate-cli-design.md	Design document