¶ APIs
¶ Description:
The API Module hosted at api.tradegrub.com and wss://api.tradegrub.com/ws is a robust, enterprise-grade API service that powers the entire TradeGrub platform. It provides unified access to all key modules, supporting multiple brokers and exchanges, and allows users to manage their accounts, execute trades, and retrieve real-time market data. This API is available to tradegrub customers and offers both REST and WebSocket interfaces to ensure seamless integration with your trading systems.
¶ Key Features:
- Unified Access: A single API interface to access account management, trading, and real-time market data across various brokers and exchanges. It also includes unified access to peripheral gateways (PGs) like FIX, MT5, stock brokers, crypto exchanges, RMS (Risk Management Server), OMS (Order Management Server), Reporting Server (RS), Feed Server (FS), Bot Server (BS), News Server(NS), Quotes Server(QS) and Signal Servers (SS).
- REST API: Standard HTTP-based interface for performing tasks like managing accounts, placing orders, and retrieving historical and real-time data.
- WebSocket Interface: For real-time streaming of market quotes, order book updates, and notifications about trade execution and account changes.
- Cross-Broker and Cross-Exchange Support: Easily interact with multiple brokers and exchanges through a single integration point.
- Enterprise-Grade Security: Built with security best practices to ensure safe communication and data integrity.
- Scalable Infrastructure: Designed to handle high-frequency trading and large-scale enterprise applications.
¶ API Capabilities:
- Account Management: Manage multiple accounts, view balances, portfolio positions, and trading history.
- Order Management: Place, modify, and cancel orders (limit, market, stop, etc.) across multiple brokers and exchanges.
- Real-Time Market Data: Access live quotes, bid/ask prices, order books, and trade history for a variety of assets.
- Trade Execution: Submit orders in real time, and get instant notifications on the status of trades and account updates.
- Historical Data: Retrieve historical market data for backtesting or analysis.
¶ Authentication and Access:
The API Module is restricted to enterprise customers.
Each customer receives dedicated API keys and must authenticate using these credentials.
- REST calls require authentication headers.
- Real-time access via WebSockets requires secure connections with authentication.
You must generate API Key & Secret and provide them in your environment variables before making any request. For order placement and signals/webhooks, an Account ID is also required.
¶ 🔑 Generate API & Secret Keys
Follow these steps in the TradeGrub app:
-
Open the app → More → Preferences
-
Navigate to the API Management tab
-
Click the ➕ (plus icon) at the top-right corner
-
Give your key a descriptive name and set required permissions → click Generate
-
Copy your keys:
- API Key: Can be viewed anytime in the app
- Secret Key: ⚠️ Visible only once when generated
-
Add them to
TradegrubPostman Environment:
.png)
¶ 🏦 How to Get Your Account ID
Your Account ID is required for order placement and webhooks.
- Go to the Accounts section in the app
- ➕ If not done already, click Add Account
- Enter the credentials for the exchange/broker you want to connect
- ✅ Once added, return to the Accounts page
- 👁️ Your Account ID will be shown with an eye icon
- 📋 Tap the copy button to copy it safely
Real-time access to market data and trading actions is facilitated via secure WebSocket connections.
¶ API Documentation:
Comprehensive API documentation is available to enterprise customers, detailing the request formats, response structures, and authentication methods. Contact your TradeGrub account manager for more information and access to the API documentation.
¶ Endpoints:
- REST API Base URL:
https://api.tradegrub.com/v1/ - WebSocket API Base URL:
wss://api.tradegrub.com/ws/
¶ How to Get Access:
¶ Postman Collection
We provide a ready-to-use Postman collection named Tradegrub Published API, which contains:
- All the services are present inside the
Trading APIfolder. - Variables (
baseUrl,exchange_name,accountId, etc.) are pre-configured for convenience.
👉 Explore the official Postman docs: TradeGrub Postman Documentation
¶ Postman Environment
To make testing easier, a Postman environment file named Tradegrub will also be shared with you.
This file contains pre-configured variables such as:
api-keysecret-key
Import this environment file in Postman and select it from the environment dropdown to use these variables directly in requests. Paste your api-key and secret-key in the pre-configured variables.