¶ TradeGrub API
Getting Started: Subscribe to a Pro or Pay As You Go plan from API Management in the TradeGrub app to unlock higher rate limits, WebSocket access, and premium features. Go to More → Preferences → API Management → Upgrade Plan. Please follow instructions given below.
¶ Overview
The TradeGrub API provides REST and WebSocket access to trading, market data, and account management across multiple exchanges and brokers under a single, scalable infrastructure.
¶ Base URLs
| Type | URL |
|---|---|
| REST | https://api.tradegrub.com/v1/ |
| WebSocket | wss://ws.tradegrub.com/ |
¶ Capabilities
¶ REST API
Standard HTTP endpoints with JSON request/response for:
- Order placement, modification, and cancellation
- Portfolio, positions, and balance retrieval
- Trade history and OHLCV market data
- News, fundamentals, and analytics
¶ WebSocket API
Persistent connections for real-time streaming:
- Live tick data, order books, and trades
- Account balance, position, and execution updates
- Optimized for algorithmic and high-frequency trading
¶ Supported Integrations
- Stocks: Tradier, Alpaca, Interactive Brokers, and more
- Crypto: Binance, Coinbase, Kraken, OKX, Bybit, and more
- Gateways: FIX, MT5, TradeGrub RMS/OMS
- Options: Coming soon
¶ Infrastructure
- TLS 1.3 encryption with HMAC-SHA256 authentication
- Millisecond-level latency with auto-scaled containers across US, EU, and AP regions
- 24/7 uptime with automatic failover and DDoS protection
¶ Authentication
All endpoints require an API Key and Secret. Order placement and webhooks also require an Account ID.
¶ Generate API Key and Secret
In the TradeGrub app:
-
Go to More → Preferences
-
Open API Management
-
Tap the + icon in the top-right corner
-
Enter a name, select permissions, and tap Generate
-
Copy your credentials:
- API Key — visible anytime in the app
- Secret Key — shown only once at generation
Important: Store your Secret Key securely. It cannot be retrieved after leaving the generation screen.
¶ Get Your Account ID
Required for order placement and webhook signals.
- Go to Accounts in the app
- Add an account if you haven't already (tap +, enter exchange/broker credentials)
- Your Account ID appears with an eye icon — tap the copy button to copy it
¶ REST Authentication
Include an Authorization header with every request using your API Key and Secret.
¶ API Documentation
¶ Interactive API Reference (Scalar)
Browse endpoints, view schemas, and test calls directly in your browser:
| Service | Description |
|---|---|
| General | Exchanges, markets, currencies, tickers, OHLCV, charts, rates |
| Fundamentals | Balance sheets, income statements, on-chain metrics |
| News | Headlines for any stock or crypto symbol |
| Signals | TradingView-style webhook alerts for automated trade execution |
| Auth | Link exchange accounts and manage session tokens |
| Orders | Place, list, cancel orders; view positions, balances, trade history |
| Quotes | Low-latency OHLCV snapshots from premium data sources |
| Risk | Portfolio rules that trigger alerts or auto-trades |
| Wallet | Generate wallets, check balances, send blockchain transactions |
The Scalar docs are generated from our OpenAPI spec, which can also be imported into Postman, Insomnia, or any OpenAPI-compatible tool.
¶ Postman Collection
A ready-to-use Postman collection (Tradegrub Published API) is available with all endpoints pre-configured.
REST API:
WebSocket API:
View WebSocket Collection on Postman
¶ Managed Users (Multi-Tenant Access)
API subscribers on Pro or Enterprise plans can manage end-user accounts through a consent-based enrollment flow. This allows an admin (API subscriber) to access portfolio, positions, and account data for users who have explicitly granted permission.
¶ How It Works
- Admin generates an invite link — In the TradeGrub app, go to More → Preferences → API Management → Managed Users and tap Generate Invite. The invite link is valid for 7 days and can be accepted by multiple users.
- User accepts the invite — The user opens the invite link (or enters the code in the app). A consent screen shows the admin's name and requested permissions. The user reviews and taps Accept.
- Admin accesses user data — The admin's API key can now query portfolio, positions, balances, and account data for any managed user by passing the user's ID in API requests.
¶ Generating an Invite
- Go to More → Preferences → API Management
- Tap Managed Users
- Tap Generate Invite — a shareable link is created
- Share the link with users you want to manage
Note: Each invite link can be accepted by multiple users during its 7-day validity period. You can generate new invites at any time.
¶ Accepting an Invite
Users can accept invites in two ways:
- Via link — Open the invite link on a device with TradeGrub installed. The app opens directly to the consent screen.
- Via code — Go to More → Preferences → API Management → Account Access and enter the invite code manually.
The consent screen displays:
- The admin's name
- Requested permissions (e.g., read portfolio)
- Option to accept or decline
¶ Managing Access
For admins:
- View all managed users from API Management → Managed Users
- Revoke access for any user at any time
For users:
- View who manages your account from API Management → Account Access
- Revoke access at any time — the admin immediately loses access to your data
¶ Using the API with Managed Users
Once a user has accepted your invite, you can query their data using your existing API key by passing the managed user's ID in your API requests. All standard endpoints (portfolio, positions, balances, orders, account data) work with managed user IDs, subject to the permissions granted.
¶ Security
- Consent-based — Admins can only access data for users who have explicitly accepted an invite
- User-revocable — Users can revoke access at any time; revocation takes effect immediately
- Server-enforced — Access control is enforced server-side on every API request; client-side UI cannot bypass it
- Auditable — All managed user relationships are tracked with timestamps