Getting Started

Set up your GoldenClaw integration in minutes

Prerequisites

Quick Start

1. Generate an API Key

Navigate to your Dashboard and create a new API key. Select the scopes you need — market:read and indicators:read are enough to get started.

Save your key

API keys are shown only once at creation. Copy it immediately and store it securely.

2. Make Your First Request

Terminal
curl "https://stage.goldenclaw.sh/api/v1/market/price?exchange=binance&marketType=futures&symbol=BTC/USDT" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

Response
{
  "success": true,
  "data": {
    "symbol": "BTC/USDT",
    "price": 87432.50,
    "timestamp": 1741683600000
  },
  "meta": {
    "timestamp": 1741683600000,
    "remaining": 99
  }
}

Good to know

All endpoints require exchange and marketType parameters. Common values:

  • exchange: binance, bybit, okx, kucoin, gate, htx, bitget, bingx, bitmart, bitmex, coinex, hyperliquid
  • marketType: spot, futures, coinm-futures

3. Connect an AI Client (Optional)

Add GoldenClaw as an MCP server in your AI assistant:

Claude Code

Terminal
claude mcp add --transport http goldenclaw https://stage.goldenclaw.sh/mcp \
  --header "Authorization: Bearer YOUR_API_KEY"

Cursor

Add to .cursor/mcp.json:

.cursor/mcp.json
{
  "mcpServers": {
    "goldenclaw": {
      "url": "https://stage.goldenclaw.sh/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

Claude Desktop

Add to your Claude Desktop config file:

claude_desktop_config.json
{
  "mcpServers": {
    "goldenclaw": {
      "url": "https://stage.goldenclaw.sh/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

Config file location:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json

For other clients, see the Clients section.

Test it by asking your AI assistant:

"What's the current BTC/USDT price on Binance futures?"

Next Steps