API Reference
Complete reference for the GoldenClaw REST API and MCP tools
Base URL
https://stage.goldenclaw.sh/api/v1Authentication
All requests require a Bearer token:
curl "https://stage.goldenclaw.sh/api/v1/..." \
-H "Authorization: Bearer YOUR_API_KEY"See Authentication for scopes and plan details.
REST Endpoints
Exchange
| Method | Path | Description |
|---|---|---|
| GET | /exchanges | List supported exchanges with capabilities |
Market Data
| Method | Path | Description |
|---|---|---|
| GET | /market/price | Get current price for a symbol |
| GET | /market/ohlcv | Get OHLCV candlestick data |
| GET | /market/pairs | Get available trading pairs |
| GET | /market/symbols | Get symbol details for an exchange |
| GET | /market/ticker | Get 24h ticker statistics |
| GET | /market/timeframes | Get supported timeframes |
Trading
| Method | Path | Description |
|---|---|---|
| POST | /trading/orders/place | Place an order (MARKET, LIMIT, STOP, STOP_LIMIT) |
| POST | /trading/orders/cancel | Cancel an open order |
| GET | /trading/orders | Get open orders for a symbol |
| GET | /trading/positions | Get open positions |
| POST | /trading/positions/close | Close an open position |
Account
| Method | Path | Description |
|---|---|---|
| GET | /account/balance | Get account balance with multi-currency breakdown |
| GET | /account/info | Get full account information |
Indicators
| Method | Path | Description |
|---|---|---|
| GET | /indicators/{category} | List available indicators in a category |
| POST | /indicators/{category} | Calculate a technical indicator |
Categories: trend, momentum, volatility, volume, support-resistance
Response Format
Success
{
"success": true,
"data": { ... },
"meta": {
"timestamp": 1741683600000,
"remaining": 9847
}
}Error
{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid parameter: symbol"
},
"meta": {
"timestamp": 1741683600000
}
}Error Codes
| HTTP | Code | Description |
|---|---|---|
| 400 | BAD_REQUEST | Invalid parameters |
| 401 | UNAUTHORIZED | Invalid or missing API key |
| 403 | FORBIDDEN | Insufficient scope |
| 404 | NOT_FOUND | Resource not found |
| 429 | RATE_LIMITED | Request quota exceeded |
| 500 | INTERNAL_ERROR | Server error |
MCP Endpoint
The same functionality is available via Model Context Protocol:
POST https://stage.goldenclaw.sh/mcp15 tools across discovery, market data, trading, account, and indicator categories. See MCP Tools Reference for complete parameter documentation or MCP Tools Overview for example prompts.
SDKs
Coming Soon
- @goldenclaw/sdk — TypeScript REST API client with full type safety
- @goldenclaw/mcp — Run GoldenClaw MCP server locally via
npx - @goldenclaw/ai — Vercel AI SDK plugin for building trading agents