Skip to main content

Phase 1: Pre-Trade

The pre-trade phase covers customer account onboarding, cash balance auditing, SOD transaction verification (corporate actions, stock transfers), margin calculations, instrument reference data discovery, overnight option quote/trade snapshots, and real-time WebSocket subscriptions.

note

All pre-trade REST requests require authentication via the X-API-KEY header and an account_number parameter.

1.1 Account Onboarding & Information

StepActionMethod & PathDescription
1.1.1Create End Customer AccountPOST /accounts/ec/createRegister a new end-customer account under your initiator account.
1.1.2Fetch End Customer AccountsGET /accounts/ecRetrieve list of registered end-customer accounts.
1.1.3Fetch AccountsGET /accountsList accounts accessible by the authenticated API key.

1.2 Account Cash Balances, SOD Transactions & Margin Verification

StepActionMethod & PathDescription
1.2.1Check Account Cash & BalancesGET /balancesQuery account balances including cash_available, cash_secured, and cash_withheld.
1.2.2Audit SOD Transactions & Corporate ActionsGET /transactionsFetch Start-of-Day (SOD) transactions (e.g. corporate actions, stock transfers, cash adjustments) to reconcile opening portfolio state.
1.2.3Verify House MarginGET /house-marginRetrieve total house margin requirement summary for an account.
1.2.4Check House Margin DetailsGET /house-margin-detailsFetch detailed component breakdown of house margin requirements.
1.2.5Check ClearStreet MarginGET /house-margin/clearstreetFetch ClearStreet clearing house margin requirement status.

1.3 Market Status & Security Reference Data

StepActionMethod & PathDescription
1.3.1Check Market StatusGET /market/statusConfirm market operational session.
1.3.2Fetch Equity SecuritiesGET /equitiesDownload active daily equity instruments reference data.
1.3.3Fetch Option SecuritiesGET /optionsDownload active daily option contracts reference data.
1.3.4Fetch Option UnderliersGET /option-underliersRetrieve underlier symbols and tier parameters for options.

1.4 Overnight Options (US Only)

StepActionMethod & PathDescription
1.4.1Overnight Active UnderliersGET /overnight/active-underliersQuery list of symbols active for overnight options trading.
1.4.2Overnight Option Quotes SnapshotGET /overnight/quotes/optionFetch snapshot quotes for overnight options contracts.
1.4.3Overnight Option Trades HistoryGET /overnight/trades/optionFetch recent trade history for overnight options.
1.4.4Connect Option Quotes WebSocketGET /websocket/quotes/optionOpen WebSocket stream for live streaming overnight option level-1 quotes.
1.4.5Connect Option Trades WebSocketGET /websocket/trades/optionOpen WebSocket stream for live streaming overnight option trades.

1.5 Account Event Data Streaming

StepActionMethod & PathDescription
1.5.1Connect Account Event WebSocketGET /websocketOpen WebSocket connection for real-time order updates.

For details on connecting and handling WebSocket messages, see the WebSocket guide.