Skip to main content

​
Who Is This Guide For?

This guide is designed for anyone using FlashAPI for the first time. The guide focuses on the Sandbox environment and explains:
  • How the Sandbox works
  • How Sandbox behavior differs from Production
  • How to test APIs directly from the documentation
  • How to test APIs using Postman or your own application

​
What Is the Sandbox?

The Sandbox is a safe, no-risk testing environment for FlashAPI. It follows the same API structure as Production, including the same:
  • API paths
  • Request parameters
  • Authentication flow
  • Response structures
However, Sandbox data and transactions are isolated from the real trading environment.

​
Sandbox Behavior

​
What Can You Do in the Sandbox?

Use the Sandbox to safely:
  • Learn the API structure and request/response format
  • Test authentication and token handling
  • Build and debug your integration
  • Validate API request parameters
  • Test trading workflows without financial risk
  • Demonstrate an end-to-end trading flow

​
Example Workflow

A typical Sandbox workflow is:
All trading operations in this workflow are simulated and do not reach the real exchange.
The Sandbox is intended for development, testing, and integration validation. It should not be used as a source of live market data or real trading results.

​
Sandbox vs Production

The Sandbox and Production environments use the same API structure, but their purposes are different.
Do not use Production credentials or real trading accounts for development and testing. Complete your integration testing in the Sandbox before switching to Production.

​
Getting Started

For a typical first-time integration, follow this sequence:
1

Authenticate

Authenticate using the appropriate account type.
2

Retrieve market data

Retrieve market data to verify the connection.
3

Query account information

Query account and portfolio information.
4

Test order placement

Test order placement in the Sandbox.
5

Validate the workflow

Validate the complete workflow.
6

Switch to Production

Switch to Production after testing is completed and your OpenAPI access has been approved.
Production access requires the appropriate OpenAPI permissions and approval from PHS.