V1
V1Accounts
Manage trading accounts, balances, and portfolio history.
Get Accounts
Get Account By ID
Patch Account By ID
Get Account Balances
Get Portfolio History
ModelsExpand Collapse
class AccountBalances: …
Represents the balance details for a trading account
daily_unrealized_pnl: str
Total unrealized profit or loss across all positions relative to prior close.
margin_details: Optional[MarginDetails]
Margin-account-only details.
day_trade_count: int
The number of day trades executed over the 5 most recent trading days.
day_trade_buying_power_usage: Optional[str]
The amount of day-trade buying power used during the current trading day.
List[Account]
class MarginDetails: …
day_trade_count: int
The number of day trades executed over the 5 most recent trading days.
day_trade_buying_power_usage: Optional[str]
The amount of day-trade buying power used during the current trading day.
class PortfolioHistoryResponse: …
day_pnl: Optional[str]
Sum of the profit and loss from intraday trading activities for the trading day.
net_pnl: Optional[str]
P&L after netting all realized and unrealized P&L, adjustments, dividends, change in accruals, income and expenses
class PortfolioHistorySegment: …
day_pnl: Optional[str]
Sum of the profit and loss from intraday trading activities for the trading day.
net_pnl: Optional[str]
P&L after netting all realized and unrealized P&L, adjustments, dividends, change in accruals, income and expenses
class AccountGetAccountBalancesResponse: …
Represents the balance details for a trading account
daily_unrealized_pnl: str
Total unrealized profit or loss across all positions relative to prior close.
margin_details: Optional[MarginDetails]
Margin-account-only details.
day_trade_count: int
The number of day trades executed over the 5 most recent trading days.
day_trade_buying_power_usage: Optional[str]
The amount of day-trade buying power used during the current trading day.
class AccountGetPortfolioHistoryResponse: …
day_pnl: Optional[str]
Sum of the profit and loss from intraday trading activities for the trading day.
net_pnl: Optional[str]
P&L after netting all realized and unrealized P&L, adjustments, dividends, change in accruals, income and expenses
V1Calendar
Access clocks and financial calendars for market sessions and events.
Get Market Hours Calendar.
ModelsExpand Collapse
class MarketHoursDetail: …
Comprehensive market hours information for a specific market and date
Next trading day’s session schedules (without time_until fields)
after_hours: Optional[SessionSchedule]
pre_market: Optional[SessionSchedule]
Trading session schedules for the requested date with time_until fields
after_hours: Optional[SessionSchedule]
pre_market: Optional[SessionSchedule]
List[MarketHoursDetail]
Next trading day’s session schedules (without time_until fields)
after_hours: Optional[SessionSchedule]
pre_market: Optional[SessionSchedule]
Trading session schedules for the requested date with time_until fields
after_hours: Optional[SessionSchedule]
pre_market: Optional[SessionSchedule]
class TradingSessions: …
Trading sessions for a market day with full timestamps
after_hours: Optional[SessionSchedule]
pre_market: Optional[SessionSchedule]
class CalendarGetMarketHoursCalendarResponse: …
Next trading day’s session schedules (without time_until fields)
after_hours: Optional[SessionSchedule]
pre_market: Optional[SessionSchedule]
Trading session schedules for the requested date with time_until fields
after_hours: Optional[SessionSchedule]
pre_market: Optional[SessionSchedule]
V1Instrument Data
Retrieve instrument analytics, market data, news, and related reference data.
Get All Instrument Events
Get Instrument Events
Get Instrument Fundamentals
Get Instrument Balance Sheet Statements
Get Instrument Income Statements
Get Instrument Analyst Consensus
Get Instrument Cash Flow Statements
ModelsExpand Collapse
class InstrumentAllEventsData: …
All-events payload grouped by date.
Events grouped by date in descending order.
Flat event envelopes for this date.
dividend_event_data: Optional[InstrumentDividendEvent]
instrument_id: Optional[str]
OEMS instrument identifier, when the instrument is found in the instrument cache.
class InstrumentEventEnvelope: …
Unified envelope for the all-events response.
dividend_event_data: Optional[InstrumentDividendEvent]
instrument_id: Optional[str]
OEMS instrument identifier, when the instrument is found in the instrument cache.
class InstrumentEventsByDate: …
Instrument events for a single date.
Flat event envelopes for this date.
dividend_event_data: Optional[InstrumentDividendEvent]
instrument_id: Optional[str]
OEMS instrument identifier, when the instrument is found in the instrument cache.
class InstrumentFundamentals: …
class InstrumentDataGetAllInstrumentEventsResponse: …
All-events payload grouped by date.
Events grouped by date in descending order.
Flat event envelopes for this date.
dividend_event_data: Optional[InstrumentDividendEvent]
instrument_id: Optional[str]
OEMS instrument identifier, when the instrument is found in the instrument cache.
class InstrumentDataGetInstrumentFundamentalsResponse: …
V1Instrument DataMarket Data
Retrieve instrument analytics, market data, news, and related reference data.
Get Snapshots
Get Daily Aggregate Summaries
ModelsExpand Collapse
class DailySummary: …
Daily aggregate (OHLV) summary for a single instrument.
Returned by GET /market-data/daily-summary. Every field except
instrument_id is Option:
- Unresolvable
instrument_id→ all other fieldsNone(includingsymbol). - Resolvable
instrument_idwith no realtime cache entry →symbolpopulated, OHLV/trade_dateNone. trade_datereflects the session the OHLV represents (today during trading hours, the last trading date during weekends/holidays).
List[DailySummary]
class MarketDataSnapshot: …
Market data snapshot for a single security.
List[MarketDataSnapshot]
class MarketDataGetSnapshotsResponse: …
V1Instrument DataNews
Retrieve instrument analytics, market data, news, and related reference data.
Get News
ModelsExpand Collapse
List[NewsItem]
V1Instruments
Retrieve core details and discovery endpoints for tradable instruments.
Get Instruments
Get Instrument By ID
Search Instruments
Get Option Contracts
ModelsExpand Collapse
class Instrument: …
Represents a tradable financial instrument.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
notional_adv: Optional[str]
Notional ADV (adv × previous_close). The primary liquidity signal
used by /instruments/search ranking. Computed at response time so
it stays consistent with whatever adv and previous_close show.
class InstrumentCore: …
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
List[InstrumentCore]
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
List[OptionsContract]
class InstrumentGetInstrumentsResponse: …
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
class InstrumentGetInstrumentByIDResponse: …
Represents a tradable financial instrument.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
notional_adv: Optional[str]
Notional ADV (adv × previous_close). The primary liquidity signal
used by /instruments/search ranking. Computed at response time so
it stays consistent with whatever adv and previous_close show.
class InstrumentSearchInstrumentsResponse: …
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
V1Omni AI
ModelsExpand Collapse
class ContentPartStructuredActionPayload: …
Structured action content part.
Structured actions that Omni AI can return to clients.
These actions provide machine-readable instructions for the client to execute, such as prefilling an order ticket, opening a chart, or navigating to a route.
class PrefillNewOrderAction: …
New-order prefill action.
Orders to prefill using the same shape accepted by the orders API.
quantity: str
Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported). For OPTION (single-leg): contracts (must be an integer)
id: Optional[str]
Optional client-provided unique ID (idempotency). Required to be unique per account.
expires_at: Optional[datetime]
The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE.
extended_hours: Optional[bool]
Allow trading outside regular trading hours. Some brokers disallow options outside RTH.
Union[PrefillNewOrderAction, PrefillCancelOrderAction]
Action to prefill order details for user confirmation.
The user must review and authorize the order before submission to the trading API. This action provides parsed order data that can be used to prefill an order ticket UI or submitted directly via the orders API after user confirmation.
Structured actions that Omni AI can return to clients.
These actions provide machine-readable instructions for the client to execute, such as prefilling an order ticket, opening a chart, or navigating to a route.
V1Omni AIEntitlements
Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use trading_account_ids.
Get Entitlements
Create Entitlements
Delete Entitlement
Get Entitlement Agreements
ModelsExpand Collapse
List[EntitlementResource]
V1Omni AIMessages
Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use trading_account_ids.
Get Message By ID
Submit Feedback
V1Omni AIResponses
Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use trading_account_ids.
Get Response By ID
Cancel Response
ModelsExpand Collapse
V1Omni AIThreads
Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use trading_account_ids.
Get Threads
Get Thread By ID
Create Thread
Get Thread Response
Get Messages
Create Message
ModelsExpand Collapse
List[Message]
List[Thread]
V1Orders
Place, monitor, and manage trading orders.
Get Orders
Get Order By ID
Submit Orders
Replace Order
Cancel Open Order
Cancel All Open Orders
ModelsExpand Collapse
class NewOrderRequest: …
Request to submit a new order (PlaceOrderRequest from spec)
quantity: str
Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported). For OPTION (single-leg): contracts (must be an integer)
id: Optional[str]
Optional client-provided unique ID (idempotency). Required to be unique per account.
expires_at: Optional[datetime]
The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE.
extended_hours: Optional[bool]
Allow trading outside regular trading hours. Some brokers disallow options outside RTH.
class Order: …
A trading order with its current state and execution details.
This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking.
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.
List[Order]
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.
class OrderGetOrdersResponse: …
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.
class OrderGetOrderByIDResponse: …
A trading order with its current state and execution details.
This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking.
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.
class OrderSubmitOrdersResponse: …
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.
class OrderReplaceOrderResponse: …
A trading order with its current state and execution details.
This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking.
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.
class OrderCancelOpenOrderResponse: …
A trading order with its current state and execution details.
This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking.
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.
class OrderCancelAllOpenOrdersResponse: …
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.
V1Positions
View positions and manage position instructions.
Get Positions
Close Positions
Close Position
List Position Instructions
Submit Position Instructions
Cancel Position Instruction
ModelsExpand Collapse
class Position: …
Represents a holding of a particular instrument in an account
daily_unrealized_pnl: Optional[str]
The unrealized profit or loss for this position relative to the previous close
daily_unrealized_pnl_pct: Optional[str]
The unrealized profit/loss for the position for the current day, expressed as a percentage of the baseline value (range: 0-100).
underlying_instrument_id: Optional[str]
OEMS instrument identifier of the underlying instrument, if resolvable
class PositionInstruction: …
A position instruction and its current lifecycle state.
instruction_id: str
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
accepted_quantity: Optional[str]
Number of contracts accepted by the clearing venue. Populated once
the instruction reaches ACCEPTED.
created_at: Optional[datetime]
When the instruction was first accepted by the service.
List[PositionInstruction]
instruction_id: str
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
accepted_quantity: Optional[str]
Number of contracts accepted by the clearing venue. Populated once
the instruction reaches ACCEPTED.
created_at: Optional[datetime]
When the instruction was first accepted by the service.
List[Position]
daily_unrealized_pnl: Optional[str]
The unrealized profit or loss for this position relative to the previous close
daily_unrealized_pnl_pct: Optional[str]
The unrealized profit/loss for the position for the current day, expressed as a percentage of the baseline value (range: 0-100).
underlying_instrument_id: Optional[str]
OEMS instrument identifier of the underlying instrument, if resolvable
class PositionGetPositionsResponse: …
daily_unrealized_pnl: Optional[str]
The unrealized profit or loss for this position relative to the previous close
daily_unrealized_pnl_pct: Optional[str]
The unrealized profit/loss for the position for the current day, expressed as a percentage of the baseline value (range: 0-100).
underlying_instrument_id: Optional[str]
OEMS instrument identifier of the underlying instrument, if resolvable
class PositionClosePositionsResponse: …
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.
class PositionClosePositionResponse: …
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.
class PositionGetPositionInstructionsResponse: …
instruction_id: str
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
accepted_quantity: Optional[str]
Number of contracts accepted by the clearing venue. Populated once
the instruction reaches ACCEPTED.
created_at: Optional[datetime]
When the instruction was first accepted by the service.
class PositionSubmitPositionInstructionsResponse: …
instruction_id: str
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
accepted_quantity: Optional[str]
Number of contracts accepted by the clearing venue. Populated once
the instruction reaches ACCEPTED.
created_at: Optional[datetime]
When the instruction was first accepted by the service.
class PositionCancelPositionInstructionResponse: …
A position instruction and its current lifecycle state.
instruction_id: str
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
accepted_quantity: Optional[str]
Number of contracts accepted by the clearing venue. Populated once
the instruction reaches ACCEPTED.
created_at: Optional[datetime]
When the instruction was first accepted by the service.
V1Watchlist
Create and manage watchlists.
Get Watchlists
Get Watchlist By ID
Create Watchlist
Delete Watchlist
Add Watchlist Item
Delete Watchlist Item
ModelsExpand Collapse
class WatchlistDetail: …
Detailed watchlist with all items
Items in the watchlist
instrument: Optional[Instrument]
Instrument details
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
notional_adv: Optional[str]
Notional ADV (adv × previous_close). The primary liquidity signal
used by /instruments/search ranking. Computed at response time so
it stays consistent with whatever adv and previous_close show.
List[WatchlistEntry]
class WatchlistItemEntry: …
A single item in a watchlist
instrument: Optional[Instrument]
Instrument details
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
notional_adv: Optional[str]
Notional ADV (adv × previous_close). The primary liquidity signal
used by /instruments/search ranking. Computed at response time so
it stays consistent with whatever adv and previous_close show.
class WatchlistGetWatchlistByIDResponse: …
Detailed watchlist with all items
Items in the watchlist
instrument: Optional[Instrument]
Instrument details
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
notional_adv: Optional[str]
Notional ADV (adv × previous_close). The primary liquidity signal
used by /instruments/search ranking. Computed at response time so
it stays consistent with whatever adv and previous_close show.
V1Websocket
Active Websocket.