Getting Started
June 25, 2026 · View on GitHub
This guide walks you through installing and configuring any Bitget Agent Hub package.
Choose Your Integration
| I want to… | Use |
|---|---|
| Connect Claude Desktop / Cursor / Copilot to Bitget | bitget-agent-mcp |
| Query Bitget from the terminal or scripts | bitget-agent-cli (bgc) |
| Let Claude Code call Bitget APIs autonomously | bitget-agent-skill |
| Build my own Bitget integration in TypeScript | bitget-agent-sdk |
Prerequisites
- Node.js ≥ 20
- A Bitget API key (optional for public market data)
Get API Credentials
- Log in to bitget.com
- Go to Settings → API Management
- Create a new API key
- Select permissions:
- Read Only — for market data and account queries
- Trade — for placing and cancelling orders
- Withdraw — only if you need withdrawal tools
- Note your API Key, Secret Key, and Passphrase
Tip: create a Demo API Key and run with
--paper-tradingto rehearse against Bitget's Demo Trading environment before touching real funds.
Set Environment Variables
All packages read credentials from environment variables:
export BITGET_API_KEY="your-api-key"
export BITGET_SECRET_KEY="your-secret-key"
export BITGET_PASSPHRASE="your-passphrase"
Or pass them inline:
BITGET_API_KEY=xxx BITGET_SECRET_KEY=yyy BITGET_PASSPHRASE=zzz bgc account_overview
Verify Without Credentials
Public market data works without any credentials:
# MCP Server — starts without env vars, exposes public tools
npx -y @bitget-ai/bitget-agent-mcp
# CLI — no auth needed for market data
npx @bitget-ai/bitget-agent-cli market --action tickers --category SPOT --symbol BTCUSDT