Terminology
This guide defines key terms and concepts used throughout the Tradovate Partner API documentation. Understanding these terms will help you navigate the API more effectively and make better integration decisions.
Detailed Definitions
Environments
See the Environments page for more information.
Account States
Account states help you understand and manage your users’ trading accounts effectively:
SOD State (Start of Day State) This is the initial state of an account at the beginning of a trading session. You can return accounts to their SOD state at a given date, which is useful for resetting accounts or handling specific trading scenarios.
Session Date vs Calendar Date
- Session Date: This is a trading session-based date system used for account state management. It’s different from regular calendar dates and is important for trading operations.
- Calendar Date: This is the standard calendar date system you’re familiar with.
Risk Management
Risk management terms help you understand how to control and monitor trading risks:
Risk Category This is an account risk classification system that determines trading permissions and restrictions. You can use risk categories to:
- Apply different rules to individual accounts
- Halt trading for entire categories in emergencies
- Upgrade accounts to new types
- Adjust baseline risk rules
Max-Net Liquidity This represents the maximum net liquidity limits for simulated accounts. You can adjust these limits via the API for SIM accounts to control how much risk your users can take.
Halted-Trading Category This is an emergency trading stop mechanism. You can apply it to individual accounts or entire categories to stop trading in emergency situations - a crucial safety feature for managing risk.
Trading Operations
These terms relate to how you’ll handle trading operations in your integration:
Automated Orders
These are orders placed via code or automated processes (like trade bots). You MUST include the isAutomated flag set to true in the request body. This is required by exchange policies and helps distinguish between human and automated trading.
Market Data Subscription These are real-time market data feeds that require proper subscription management and renewal handling. You’ll need to manage these subscriptions carefully to ensure your users get the data they need.
Time-Sensitive Operations
Some operations have critical timing requirements:
End-of-Month Processing These are critical timing windows for market data subscription renewals and account management operations. You’ll need to handle these carefully to avoid issues.
Maintenance Windows These are scheduled system maintenance periods that may impact API availability and functionality. You should plan your operations around these windows.
WebSocket Operations
WebSocket terms help you understand real-time communication:
Heartbeat
This is a client-side mechanism to keep WebSocket connections alive. You send empty array frames ([]) every 2.5 seconds to prevent disconnection.
User Sync Request
This is a WebSocket endpoint (user/syncrequest) used for real-time user data synchronization and updates. It’s essential for keeping your application in sync with user changes.
API Conventions
These terms relate to API authentication and usage:
Access Token This is the authentication credential required for API access. You obtain it through the standard Access procedure.
Bearer Token
This is the authorization method using the access token in the Authorization: Bearer <token> header format.
