Maintenance Windows

When integrating with the Tradovate/NinjaTrader API, it’s important to account for regularly scheduled maintenance windows that may impact API availability and functionality. These windows are designated periods during which system maintenance, including archival processes, is performed.

Quick Reference

Maintenance Schedule

API Behavior During Maintenance

During the above maintenance windows:

• An archival process is performed on backend systems
• Certain API endpoints—especially those related to account creation—may be unresponsive or return errors
• Specifically, calling endpoints like CreateEvaluationAccounts during these times can result in a Request Timeout error

Best Practices for Handling Maintenance Windows

Avoid Sensitive Operations

• Avoid calling account creation endpoints during maintenance windows
• If you need to create accounts during these times, consider queuing requests and submitting them after the maintenance window concludes

Buffer Time Recommendations

To reduce the likelihood of encountering errors:

• Add a 15–30 minute buffer before and after each maintenance window when scheduling account creation requests or other sensitive operations

Proactive Handling

This proactive handling ensures more reliable API integration and a smoother end user experience.

Implementation Guidelines

Error Handling

• Implement proper error handling for maintenance window scenarios
• Handle Request Timeout errors gracefully
• Implement retry logic with appropriate delays

Monitoring

• Monitor API response times during maintenance windows
• Set up alerts for increased error rates
• Track maintenance window impact on your operations

Scheduling

• Schedule sensitive operations outside of maintenance windows
• Use the buffer time recommendations for critical operations
• Plan for extended maintenance periods (especially Friday and weekend windows)

Queue Management

• Implement request queuing for operations that can be delayed
• Process queued requests after maintenance windows conclude
• Monitor queue status and handle queue overflow scenarios

Maintenance Window Types

Weekday Maintenance (Monday-Thursday)

• Duration: 1 hour (4:00 PM – 5:00 PM CT)
• Impact: Minimal impact on most operations
• Recommendation: Avoid account creation during this window

Friday Maintenance

• Duration: 4 hours (4:00 PM – 8:00 PM CT)
• Impact: Extended maintenance period
• Recommendation: Plan for longer downtime, avoid all sensitive operations

Weekend Maintenance

• Duration: 8.5 hours (Saturday 10:00 PM – Sunday 6:30 AM CT)
• Impact: Extended maintenance period covering weekend
• Recommendation: Plan for extended downtime, schedule operations for Monday morning

Troubleshooting

Common Issues

• Request Timeout errors: Expected during maintenance windows
• Unresponsive endpoints: Normal behavior during maintenance
• Connection failures: May occur during maintenance periods

Resolution Steps

1. Wait for maintenance window to conclude
2. Add buffer time before retrying operations
3. Implement exponential backoff for retry attempts
4. Monitor system status for maintenance completion

Emergency Procedures

• For critical operations during maintenance windows, contact support
• Document any critical issues that occur during maintenance
• Implement fallback procedures for essential operations