Skip to main content

Sandbox Mode for API Integration​

Effective Immediately

We are pleased to announce the release of the Sandbox Mode for API integration, meticulously engineered to provide a sophisticated and flexible development environment. This feature is specifically designed to facilitate seamless integration, rigorous testing, and robust system development for API users prior to transitioning to Upstox's live environment.

Overview of Features​

Sandbox Mode replicates the functional nuances of the live integration environment, empowering developers to:

  • Simplify Integration Processes: Conduct comprehensive testing and fine-tuning within a controlled environment that closely emulates live operations.
  • Enhance Development Assurance: Establish a highly stable system in the Sandbox Mode, ensuring a smoother migration to the live API environment.

Core Advantages​

  1. Comprehensive Order Lifecycle Management - Orders submitted within Sandbox Mode remain active for a full 24-hour cycle, enabling developers to perform modifications, cancellations, and retrieve associated data (e.g., order details, orderbook, and historical records) with the same fidelity as in a live environment.

  2. Unrestricted API Accessibility - APIs within Sandbox Mode are available 24/7, free from the temporal constraints imposed by market operation hours.

  3. Authentic Validation Protocols - Sandbox APIs implement validation processes identical to those in the live environment, providing a credible and reliable testing framework.

  4. Fund-Free Order Placement - Developers can place orders without the necessity of actual funds, mitigating resource-related challenges typically encountered during live API integration.

  5. Expansive API Ecosystem Simulation - Sandbox Mode aspires to faithfully emulate the entire spectrum of API functionalities. Incremental updates will continue to enhance the comprehensiveness of this simulation. The current list of APIs with Sandbox Mode enabled can be found here

How To?​

Integrating with the Sandbox Mode requires a sandbox app and the corresponding sandbox access token. The detailed process to generate these credentials and how to identify APIs that are sandbox ready can be found in the Sandbox documentation.

Engage with Us​

We value your insights and invite you to participate in discussions on our Developer Community. Share your suggestions, inquiries, or requirements concerning the Sandbox environment or any related API features. Together, let us refine and elevate the API integration experience.