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.
Start-of-day snapshot balances.
asof: Optional[date]
Timestamp for the start-of-day values. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedday_trade_buying_power: Optional[str]
Start-of-day day-trade buying power. When a null/undefined value is observed, it indicates it does not apply.
maintenance_margin_excess: Optional[str]
Start-of-day maintenance margin excess. When a null/undefined value is observed, it indicates it does not apply.
margin_details: Optional[MarginDetails]
Margin-account-only details. When a null/undefined value is observed, it indicates it does not apply.
Deprecatedday_trade_count: int
The number of day trades executed over the 5 most recent trading days.
Deprecatedpattern_day_trader: bool
true if the account is currently flagged as a PDT, otherwise false.
Deprecatedday_trade_buying_power_usage: Optional[str]
The amount of day-trade buying power used during the current trading day. When null/undefined, the value should be assumed to be zero. The field is omitted to simplify the response.
class AccountBalancesSod: …
asof: Optional[date]
Timestamp for the start-of-day values. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedday_trade_buying_power: Optional[str]
Start-of-day day-trade buying power. When a null/undefined value is observed, it indicates it does not apply.
maintenance_margin_excess: Optional[str]
Start-of-day maintenance margin excess. When a null/undefined value is observed, it indicates it does not apply.
List[Account]
class MarginDetails: …
Deprecatedday_trade_count: int
The number of day trades executed over the 5 most recent trading days.
Deprecatedpattern_day_trader: bool
true if the account is currently flagged as a PDT, otherwise false.
Deprecatedday_trade_buying_power_usage: Optional[str]
The amount of day-trade buying power used during the current trading day. When null/undefined, the value should be assumed to be zero. The field is omitted to simplify the response.
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.
Start-of-day snapshot balances.
asof: Optional[date]
Timestamp for the start-of-day values. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedday_trade_buying_power: Optional[str]
Start-of-day day-trade buying power. When a null/undefined value is observed, it indicates it does not apply.
maintenance_margin_excess: Optional[str]
Start-of-day maintenance margin excess. When a null/undefined value is observed, it indicates it does not apply.
margin_details: Optional[MarginDetails]
Margin-account-only details. When a null/undefined value is observed, it indicates it does not apply.
Deprecatedday_trade_count: int
The number of day trades executed over the 5 most recent trading days.
Deprecatedpattern_day_trader: bool
true if the account is currently flagged as a PDT, otherwise false.
Deprecatedday_trade_buying_power_usage: Optional[str]
The amount of day-trade buying power used during the current trading day. When null/undefined, the value should be assumed to be zero. The field is omitted to simplify the response.
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]
After-hours session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
pre_market: Optional[SessionSchedule]
Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
regular: Optional[SessionSchedule]
Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.
Trading session schedules for the requested date with time_until fields
after_hours: Optional[SessionSchedule]
After-hours session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
pre_market: Optional[SessionSchedule]
Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
regular: Optional[SessionSchedule]
Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.
List[MarketHoursDetail]
Next trading day’s session schedules (without time_until fields)
after_hours: Optional[SessionSchedule]
After-hours session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
pre_market: Optional[SessionSchedule]
Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
regular: Optional[SessionSchedule]
Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.
Trading session schedules for the requested date with time_until fields
after_hours: Optional[SessionSchedule]
After-hours session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
pre_market: Optional[SessionSchedule]
Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
regular: Optional[SessionSchedule]
Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.
class TradingSessions: …
Trading sessions for a market day with full timestamps
after_hours: Optional[SessionSchedule]
After-hours session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
pre_market: Optional[SessionSchedule]
Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
regular: Optional[SessionSchedule]
Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.
class CalendarGetMarketHoursCalendarResponse: …
Next trading day’s session schedules (without time_until fields)
after_hours: Optional[SessionSchedule]
After-hours session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
pre_market: Optional[SessionSchedule]
Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
regular: Optional[SessionSchedule]
Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.
Trading session schedules for the requested date with time_until fields
after_hours: Optional[SessionSchedule]
After-hours session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
pre_market: Optional[SessionSchedule]
Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
regular: Optional[SessionSchedule]
Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.
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]
Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.
declaration_date: Optional[date]
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
dividend_amount: Optional[str]
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: Optional[str]
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
frequency: Optional[str]
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
earnings_event_data: Optional[InstrumentEarnings]
Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.
eps_actual: Optional[str]
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_estimate: Optional[str]
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_surprise_percent: Optional[str]
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
revenue_actual: Optional[str]
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
instrument_id: Optional[str]
Instrument identifier, when available. When a null/undefined value is observed, it indicates that there is no available data.
ipo_event_data: Optional[InstrumentEventIpoItem]
IPO payload when type is IPO. When a null/undefined value is observed, it indicates it does not apply.
actions: Optional[str]
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
announced_at: Optional[datetime]
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
company: Optional[str]
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
exchange: Optional[str]
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
market_cap: Optional[str]
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.
reporting_currency: Optional[str]
The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentDividendEvent: …
Represents a dividend event for an instrument
declaration_date: Optional[date]
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
dividend_amount: Optional[str]
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: Optional[str]
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
frequency: Optional[str]
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentEarnings: …
Represents instrument earnings data
eps_actual: Optional[str]
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_estimate: Optional[str]
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_surprise_percent: Optional[str]
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
revenue_actual: Optional[str]
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentEventEnvelope: …
Unified envelope for the all-events response.
dividend_event_data: Optional[InstrumentDividendEvent]
Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.
declaration_date: Optional[date]
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
dividend_amount: Optional[str]
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: Optional[str]
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
frequency: Optional[str]
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
earnings_event_data: Optional[InstrumentEarnings]
Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.
eps_actual: Optional[str]
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_estimate: Optional[str]
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_surprise_percent: Optional[str]
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
revenue_actual: Optional[str]
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
instrument_id: Optional[str]
Instrument identifier, when available. When a null/undefined value is observed, it indicates that there is no available data.
ipo_event_data: Optional[InstrumentEventIpoItem]
IPO payload when type is IPO. When a null/undefined value is observed, it indicates it does not apply.
actions: Optional[str]
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
announced_at: Optional[datetime]
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
company: Optional[str]
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
exchange: Optional[str]
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
market_cap: Optional[str]
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.
reporting_currency: Optional[str]
The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentEventIpoItem: …
IPO event in the all-events date grouping response.
actions: Optional[str]
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
announced_at: Optional[datetime]
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
company: Optional[str]
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
exchange: Optional[str]
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
market_cap: Optional[str]
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentEventsByDate: …
Instrument events for a single date.
Flat event envelopes for this date.
dividend_event_data: Optional[InstrumentDividendEvent]
Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.
declaration_date: Optional[date]
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
dividend_amount: Optional[str]
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: Optional[str]
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
frequency: Optional[str]
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
earnings_event_data: Optional[InstrumentEarnings]
Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.
eps_actual: Optional[str]
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_estimate: Optional[str]
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_surprise_percent: Optional[str]
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
revenue_actual: Optional[str]
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
instrument_id: Optional[str]
Instrument identifier, when available. When a null/undefined value is observed, it indicates that there is no available data.
ipo_event_data: Optional[InstrumentEventIpoItem]
IPO payload when type is IPO. When a null/undefined value is observed, it indicates it does not apply.
actions: Optional[str]
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
announced_at: Optional[datetime]
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
company: Optional[str]
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
exchange: Optional[str]
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
market_cap: Optional[str]
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.
reporting_currency: Optional[str]
The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentEventsData: …
Grouped instrument events by type
Dividend distribution events
declaration_date: Optional[date]
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
dividend_amount: Optional[str]
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: Optional[str]
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
frequency: Optional[str]
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
Earnings announcement events
eps_actual: Optional[str]
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_estimate: Optional[str]
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_surprise_percent: Optional[str]
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
revenue_actual: Optional[str]
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentFundamentals: …
Supplemental fundamentals and company profile data for an instrument.
average_volume: Optional[int]
The average daily trading volume over the past 30 days When a null/undefined value is observed, it indicates that there is no available data.
beta: Optional[str]
The beta value, measuring the instrument’s volatility relative to the overall market When a null/undefined value is observed, it indicates that there is no available data.
description: Optional[str]
A detailed description of the instrument or company When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: Optional[str]
The trailing twelve months (TTM) dividend yield When a null/undefined value is observed, it indicates that there is no available data.
earnings_per_share: Optional[str]
The trailing twelve months (TTM) earnings per share When a null/undefined value is observed, it indicates that there is no available data.
fifty_two_week_high: Optional[str]
The highest price over the last 52 weeks When a null/undefined value is observed, it indicates that there is no available data.
fifty_two_week_low: Optional[str]
The lowest price over the last 52 weeks When a null/undefined value is observed, it indicates that there is no available data.
industry: Optional[str]
The specific industry of the instrument’s issuer When a null/undefined value is observed, it indicates that there is no available data.
list_date: Optional[date]
The date the instrument was first listed When a null/undefined value is observed, it indicates that there is no available data.
logo_url: Optional[str]
URL to a representative logo image for the instrument or issuer When a null/undefined value is observed, it indicates that there is no available data.
market_cap: Optional[str]
The total market capitalization When a null/undefined value is observed, it indicates that there is no available data.
previous_close: Optional[str]
The closing price from the previous trading day When a null/undefined value is observed, it indicates that there is no available data.
price_to_earnings: Optional[str]
The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) When a null/undefined value is observed, it indicates that there is no available data.
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]
Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.
declaration_date: Optional[date]
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
dividend_amount: Optional[str]
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: Optional[str]
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
frequency: Optional[str]
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
earnings_event_data: Optional[InstrumentEarnings]
Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.
eps_actual: Optional[str]
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_estimate: Optional[str]
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_surprise_percent: Optional[str]
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
revenue_actual: Optional[str]
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
instrument_id: Optional[str]
Instrument identifier, when available. When a null/undefined value is observed, it indicates that there is no available data.
ipo_event_data: Optional[InstrumentEventIpoItem]
IPO payload when type is IPO. When a null/undefined value is observed, it indicates it does not apply.
actions: Optional[str]
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
announced_at: Optional[datetime]
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
company: Optional[str]
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
exchange: Optional[str]
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
market_cap: Optional[str]
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.
reporting_currency: Optional[str]
The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentDataGetInstrumentEventsResponse: …
Grouped instrument events by type
Dividend distribution events
declaration_date: Optional[date]
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
dividend_amount: Optional[str]
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: Optional[str]
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
frequency: Optional[str]
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
Earnings announcement events
eps_actual: Optional[str]
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_estimate: Optional[str]
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_surprise_percent: Optional[str]
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
revenue_actual: Optional[str]
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentDataGetInstrumentFundamentalsResponse: …
Supplemental fundamentals and company profile data for an instrument.
average_volume: Optional[int]
The average daily trading volume over the past 30 days When a null/undefined value is observed, it indicates that there is no available data.
beta: Optional[str]
The beta value, measuring the instrument’s volatility relative to the overall market When a null/undefined value is observed, it indicates that there is no available data.
description: Optional[str]
A detailed description of the instrument or company When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: Optional[str]
The trailing twelve months (TTM) dividend yield When a null/undefined value is observed, it indicates that there is no available data.
earnings_per_share: Optional[str]
The trailing twelve months (TTM) earnings per share When a null/undefined value is observed, it indicates that there is no available data.
fifty_two_week_high: Optional[str]
The highest price over the last 52 weeks When a null/undefined value is observed, it indicates that there is no available data.
fifty_two_week_low: Optional[str]
The lowest price over the last 52 weeks When a null/undefined value is observed, it indicates that there is no available data.
industry: Optional[str]
The specific industry of the instrument’s issuer When a null/undefined value is observed, it indicates that there is no available data.
list_date: Optional[date]
The date the instrument was first listed When a null/undefined value is observed, it indicates that there is no available data.
logo_url: Optional[str]
URL to a representative logo image for the instrument or issuer When a null/undefined value is observed, it indicates that there is no available data.
market_cap: Optional[str]
The total market capitalization When a null/undefined value is observed, it indicates that there is no available data.
previous_close: Optional[str]
The closing price from the previous trading day When a null/undefined value is observed, it indicates that there is no available data.
price_to_earnings: Optional[str]
The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentDataGetInstrumentAnalystConsensusResponse: …
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).
high: Optional[str]
Session high. When a null/undefined value is observed, it indicates that there is no available data.
low: Optional[str]
Session low. When a null/undefined value is observed, it indicates that there is no available data.
open: Optional[str]
Opening price for the session. When a null/undefined value is observed, it indicates that there is no available data.
symbol: Optional[str]
Display symbol for the security. None for unresolvable IDs.
When a null/undefined value is observed, it indicates that there is no available data.
List[DailySummary]
high: Optional[str]
Session high. When a null/undefined value is observed, it indicates that there is no available data.
low: Optional[str]
Session low. When a null/undefined value is observed, it indicates that there is no available data.
open: Optional[str]
Opening price for the session. When a null/undefined value is observed, it indicates that there is no available data.
symbol: Optional[str]
Display symbol for the security. None for unresolvable IDs.
When a null/undefined value is observed, it indicates that there is no available data.
class MarketDataSnapshot: …
Market data snapshot for a single security.
cumulative_volume: Optional[int]
Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. When a null/undefined value is observed, it indicates that there is no available data.
greeks: Optional[SnapshotGreeks]
Theoretical price and Greeks for option instruments. None for
equities, and for options whose Greeks have not yet been observed
When a null/undefined value is observed, it indicates that there is no available data.
last_quote: Optional[SnapshotQuote]
Most recent quote if available. When a null/undefined value is observed, it indicates that there is no available data.
ask: Optional[str]
Current best ask. Absent when no ask is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
ask_size: Optional[int]
Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.
bid: Optional[str]
Current best bid. Absent when no bid is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
Security name if available. When a null/undefined value is observed, it indicates that there is no available data.
List[MarketDataSnapshot]
cumulative_volume: Optional[int]
Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. When a null/undefined value is observed, it indicates that there is no available data.
greeks: Optional[SnapshotGreeks]
Theoretical price and Greeks for option instruments. None for
equities, and for options whose Greeks have not yet been observed
When a null/undefined value is observed, it indicates that there is no available data.
last_quote: Optional[SnapshotQuote]
Most recent quote if available. When a null/undefined value is observed, it indicates that there is no available data.
ask: Optional[str]
Current best ask. Absent when no ask is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
ask_size: Optional[int]
Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.
bid: Optional[str]
Current best bid. Absent when no bid is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
Security name if available. When a null/undefined value is observed, it indicates that there is no available data.
class SnapshotQuote: …
L1 quote fields for a market data snapshot.
ask: Optional[str]
Current best ask. Absent when no ask is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
ask_size: Optional[int]
Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.
bid: Optional[str]
Current best bid. Absent when no bid is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
class MarketDataGetSnapshotsResponse: …
cumulative_volume: Optional[int]
Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. When a null/undefined value is observed, it indicates that there is no available data.
greeks: Optional[SnapshotGreeks]
Theoretical price and Greeks for option instruments. None for
equities, and for options whose Greeks have not yet been observed
When a null/undefined value is observed, it indicates that there is no available data.
last_quote: Optional[SnapshotQuote]
Most recent quote if available. When a null/undefined value is observed, it indicates that there is no available data.
ask: Optional[str]
Current best ask. Absent when no ask is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
ask_size: Optional[int]
Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.
bid: Optional[str]
Current best bid. Absent when no bid is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
Security name if available. When a null/undefined value is observed, it indicates that there is no available data.
class MarketDataGetDailySummariesResponse: …
high: Optional[str]
Session high. When a null/undefined value is observed, it indicates that there is no available data.
low: Optional[str]
Session low. When a null/undefined value is observed, it indicates that there is no available data.
open: Optional[str]
Opening price for the session. When a null/undefined value is observed, it indicates that there is no available data.
symbol: Optional[str]
Display symbol for the security. None for unresolvable IDs.
When a null/undefined value is observed, it indicates that there is no available data.
V1Instrument DataNews
Retrieve instrument analytics, market data, news, and related reference data.
Get News
ModelsExpand Collapse
class NewsItem: …
A single news item and its associated instruments.
image_url: Optional[str]
URL of an associated image if provided by the source. When a null/undefined value is observed, it indicates that there is no available data.
List[NewsItem]
image_url: Optional[str]
URL of an associated image if provided by the source. When a null/undefined value is observed, it indicates that there is no available data.
class NewsGetNewsResponse: …
image_url: Optional[str]
URL of an associated image if provided by the source. When a null/undefined value is observed, it indicates that there is no available data.
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_ptp: bool
Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.
notional_adv: Optional[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
options_expiry_dates: Optional[List[date]]
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentCore: …
is_ptp: bool
Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.
notional_adv: Optional[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
List[InstrumentCore]
is_ptp: bool
Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.
notional_adv: Optional[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
List[OptionsContract]
class InstrumentGetInstrumentsResponse: …
is_ptp: bool
Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.
notional_adv: Optional[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentGetInstrumentByIDResponse: …
Represents a tradable financial instrument.
is_ptp: bool
Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.
notional_adv: Optional[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
options_expiry_dates: Optional[List[date]]
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentSearchInstrumentsResponse: …
is_ptp: bool
Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.
notional_adv: Optional[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
V1Omni AI
ModelsExpand Collapse
class ChartPayload: …
Typed chart payload rendered inline in assistant content.
class ContentPartChartPayload: …
Chart payload content part.
Typed chart payload rendered inline in assistant content.
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 OpenChart: …
class OpenScreener: …
Open a stock screener with filters
Open a stock screener with filters
columns: Optional[List[str]]
Optional field/column selection for screener results. When a null/undefined value is observed, it indicates it does not apply.
page_size: Optional[int]
Optional page size. When a null/undefined value is observed, it indicates it does not apply.
class OpenScreenerAction: …
Action to open a stock screener with filters.
columns: Optional[List[str]]
Optional field/column selection for screener results. When a null/undefined value is observed, it indicates it does not apply.
page_size: Optional[int]
Optional page size. When a null/undefined value is observed, it indicates it does not apply.
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.
class OpenChart: …
class OpenScreener: …
Open a stock screener with filters
Open a stock screener with filters
columns: Optional[List[str]]
Optional field/column selection for screener results. When a null/undefined value is observed, it indicates it does not apply.
page_size: Optional[int]
Optional page size. When a null/undefined value is observed, it indicates it does not apply.
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 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 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 account_ids.
Get Response By ID
Cancel Response
ModelsExpand Collapse
class Response: …
class ResponseGetResponseByIDResponse: …
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 account_ids.
Get Threads
Get Thread By ID
Create Thread
Get Thread Response
Get Messages
Create Message
ModelsExpand Collapse
List[Message]
List[Thread]
class ThreadGetThreadResponseResponse: …
data: Optional[Response]
V1Orders
Place, monitor, and manage trading orders.
Get Orders
Get Order By ID
Submit Orders
Replace Order
Cancel Open Order
Cancel All Open Orders
Get Executions
ModelsExpand Collapse
List[Execution]
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.
average_fill_price: Optional[str]
Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.
limit_offset: Optional[str]
Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.
limit_price: Optional[str]
Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
releases_at: Optional[datetime]
Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.
stop_price: Optional[str]
Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
trailing_limit_px: Optional[str]
Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_offset: Optional[str]
Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_stop_px: Optional[str]
Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_px: Optional[str]
Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: Optional[str]
Instrument ID of the option’s underlying instrument. Populated only for
options orders. A null means one of two things: the order is not an
option, so the field does not apply; or the order is an option whose
underlier has not yet been resolved.
When a null/undefined value is observed, it indicates it does not apply.
List[Order]
average_fill_price: Optional[str]
Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.
limit_offset: Optional[str]
Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.
limit_price: Optional[str]
Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
releases_at: Optional[datetime]
Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.
stop_price: Optional[str]
Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
trailing_limit_px: Optional[str]
Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_offset: Optional[str]
Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_stop_px: Optional[str]
Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_px: Optional[str]
Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: Optional[str]
Instrument ID of the option’s underlying instrument. Populated only for
options orders. A null means one of two things: the order is not an
option, so the field does not apply; or the order is an option whose
underlier has not yet been resolved.
When a null/undefined value is observed, it indicates it does not apply.
class OrderGetOrdersResponse: …
average_fill_price: Optional[str]
Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.
limit_offset: Optional[str]
Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.
limit_price: Optional[str]
Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
releases_at: Optional[datetime]
Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.
stop_price: Optional[str]
Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
trailing_limit_px: Optional[str]
Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_offset: Optional[str]
Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_stop_px: Optional[str]
Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_px: Optional[str]
Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: Optional[str]
Instrument ID of the option’s underlying instrument. Populated only for
options orders. A null means one of two things: the order is not an
option, so the field does not apply; or the order is an option whose
underlier has not yet been resolved.
When a null/undefined value is observed, it indicates it does not apply.
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.
average_fill_price: Optional[str]
Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.
limit_offset: Optional[str]
Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.
limit_price: Optional[str]
Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
releases_at: Optional[datetime]
Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.
stop_price: Optional[str]
Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
trailing_limit_px: Optional[str]
Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_offset: Optional[str]
Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_stop_px: Optional[str]
Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_px: Optional[str]
Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: Optional[str]
Instrument ID of the option’s underlying instrument. Populated only for
options orders. A null means one of two things: the order is not an
option, so the field does not apply; or the order is an option whose
underlier has not yet been resolved.
When a null/undefined value is observed, it indicates it does not apply.
class OrderSubmitOrdersResponse: …
average_fill_price: Optional[str]
Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.
limit_offset: Optional[str]
Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.
limit_price: Optional[str]
Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
releases_at: Optional[datetime]
Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.
stop_price: Optional[str]
Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
trailing_limit_px: Optional[str]
Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_offset: Optional[str]
Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_stop_px: Optional[str]
Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_px: Optional[str]
Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: Optional[str]
Instrument ID of the option’s underlying instrument. Populated only for
options orders. A null means one of two things: the order is not an
option, so the field does not apply; or the order is an option whose
underlier has not yet been resolved.
When a null/undefined value is observed, it indicates it does not apply.
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.
average_fill_price: Optional[str]
Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.
limit_offset: Optional[str]
Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.
limit_price: Optional[str]
Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
releases_at: Optional[datetime]
Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.
stop_price: Optional[str]
Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
trailing_limit_px: Optional[str]
Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_offset: Optional[str]
Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_stop_px: Optional[str]
Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_px: Optional[str]
Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: Optional[str]
Instrument ID of the option’s underlying instrument. Populated only for
options orders. A null means one of two things: the order is not an
option, so the field does not apply; or the order is an option whose
underlier has not yet been resolved.
When a null/undefined value is observed, it indicates it does not apply.
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.
average_fill_price: Optional[str]
Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.
limit_offset: Optional[str]
Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.
limit_price: Optional[str]
Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
releases_at: Optional[datetime]
Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.
stop_price: Optional[str]
Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
trailing_limit_px: Optional[str]
Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_offset: Optional[str]
Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_stop_px: Optional[str]
Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_px: Optional[str]
Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: Optional[str]
Instrument ID of the option’s underlying instrument. Populated only for
options orders. A null means one of two things: the order is not an
option, so the field does not apply; or the order is an option whose
underlier has not yet been resolved.
When a null/undefined value is observed, it indicates it does not apply.
class OrderCancelAllOpenOrdersResponse: …
average_fill_price: Optional[str]
Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.
limit_offset: Optional[str]
Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.
limit_price: Optional[str]
Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
releases_at: Optional[datetime]
Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.
stop_price: Optional[str]
Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
trailing_limit_px: Optional[str]
Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_offset: Optional[str]
Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_stop_px: Optional[str]
Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_px: Optional[str]
Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: Optional[str]
Instrument ID of the option’s underlying instrument. Populated only for
options orders. A null means one of two things: the order is not an
option, so the field does not apply; or the order is an option whose
underlier has not yet been resolved.
When a null/undefined value is observed, it indicates it does not apply.
V1Positions
View positions and manage position instructions.
Get Positions
Close Positions
Close Position
Get Position Instructions
Submit Position Instructions
Cancel Position Instruction
ModelsExpand Collapse
class Position: …
Represents a holding of a particular instrument in an account
avg_price: Optional[str]
The average price paid per share or contract for this position When a null/undefined value is observed, it indicates that there is no available data.
closing_price: Optional[str]
The closing price used to value the position for the last trading day When a null/undefined value is observed, it indicates that there is no available data.
closing_price_date: Optional[date]
The market date associated with closing_price
When a null/undefined value is observed, it indicates that there is no available data.
cost_basis: Optional[str]
The total cost basis for this position When a null/undefined value is observed, it indicates that there is no available data.
daily_realized_pnl: Optional[str]
The realized profit or loss for this position for the current day When a null/undefined value is observed, it indicates that there is no available data.
daily_unrealized_pnl: Optional[str]
The unrealized profit or loss for this position relative to the previous close When a null/undefined value is observed, it indicates that there is no available data.
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). When a null/undefined value is observed, it indicates that there is no available data.
instrument_price: Optional[str]
The current market price of the instrument When a null/undefined value is observed, it indicates that there is no available data.
underlying_instrument_id: Optional[str]
Identifier of the underlying instrument, when available When a null/undefined value is observed, it indicates it does not apply.
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.
When a null/undefined value is observed, it indicates that there is no available data.
created_at: Optional[datetime]
When the instruction was first accepted by the service. When a null/undefined value is observed, it indicates that there is no available data.
rejection_reason: Optional[str]
Human-readable explanation populated on any non-success terminal
status — REJECTED or CANCEL_FAILED. On a
207 Multi-Status batch submit the top-level error field
summarizes the batch; per-row detail continues to live here.
When a null/undefined value is observed, it indicates it does not apply.
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.
When a null/undefined value is observed, it indicates that there is no available data.
created_at: Optional[datetime]
When the instruction was first accepted by the service. When a null/undefined value is observed, it indicates that there is no available data.
rejection_reason: Optional[str]
Human-readable explanation populated on any non-success terminal
status — REJECTED or CANCEL_FAILED. On a
207 Multi-Status batch submit the top-level error field
summarizes the batch; per-row detail continues to live here.
When a null/undefined value is observed, it indicates it does not apply.
Literal["SENT", "ACCEPTED", "REJECTED", 4 more]
Lifecycle status of a position instruction.
SENT: accepted and submitted to the clearing venue.ACCEPTED: terminal — accepted by the clearing venue.REJECTED: terminal rejection;rejection_reasoncarries the detail. Covers both venue-reported rejections and rejections raised before the instruction reached the clearing venue (e.g. duplicateinstruction_id,DO_NOT_EXERCISE/CONTRARY_EXERCISEsubmitted on a non-expiry day, insufficient position, or an instrument that does not resolve).CANCEL_REQUESTED: cancel accepted; final cancel state pending.CANCELLED: terminal — cancel completed.CANCEL_FAILED: cancel could not be completed; operator attention required.rejection_reasoncarries the detail.UNKNOWN: status could not be determined.
List[Position]
avg_price: Optional[str]
The average price paid per share or contract for this position When a null/undefined value is observed, it indicates that there is no available data.
closing_price: Optional[str]
The closing price used to value the position for the last trading day When a null/undefined value is observed, it indicates that there is no available data.
closing_price_date: Optional[date]
The market date associated with closing_price
When a null/undefined value is observed, it indicates that there is no available data.
cost_basis: Optional[str]
The total cost basis for this position When a null/undefined value is observed, it indicates that there is no available data.
daily_realized_pnl: Optional[str]
The realized profit or loss for this position for the current day When a null/undefined value is observed, it indicates that there is no available data.
daily_unrealized_pnl: Optional[str]
The unrealized profit or loss for this position relative to the previous close When a null/undefined value is observed, it indicates that there is no available data.
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). When a null/undefined value is observed, it indicates that there is no available data.
instrument_price: Optional[str]
The current market price of the instrument When a null/undefined value is observed, it indicates that there is no available data.
underlying_instrument_id: Optional[str]
Identifier of the underlying instrument, when available When a null/undefined value is observed, it indicates it does not apply.
class PositionGetPositionsResponse: …
avg_price: Optional[str]
The average price paid per share or contract for this position When a null/undefined value is observed, it indicates that there is no available data.
closing_price: Optional[str]
The closing price used to value the position for the last trading day When a null/undefined value is observed, it indicates that there is no available data.
closing_price_date: Optional[date]
The market date associated with closing_price
When a null/undefined value is observed, it indicates that there is no available data.
cost_basis: Optional[str]
The total cost basis for this position When a null/undefined value is observed, it indicates that there is no available data.
daily_realized_pnl: Optional[str]
The realized profit or loss for this position for the current day When a null/undefined value is observed, it indicates that there is no available data.
daily_unrealized_pnl: Optional[str]
The unrealized profit or loss for this position relative to the previous close When a null/undefined value is observed, it indicates that there is no available data.
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). When a null/undefined value is observed, it indicates that there is no available data.
instrument_price: Optional[str]
The current market price of the instrument When a null/undefined value is observed, it indicates that there is no available data.
underlying_instrument_id: Optional[str]
Identifier of the underlying instrument, when available When a null/undefined value is observed, it indicates it does not apply.
class PositionClosePositionsResponse: …
average_fill_price: Optional[str]
Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.
limit_offset: Optional[str]
Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.
limit_price: Optional[str]
Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
releases_at: Optional[datetime]
Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.
stop_price: Optional[str]
Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
trailing_limit_px: Optional[str]
Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_offset: Optional[str]
Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_stop_px: Optional[str]
Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_px: Optional[str]
Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: Optional[str]
Instrument ID of the option’s underlying instrument. Populated only for
options orders. A null means one of two things: the order is not an
option, so the field does not apply; or the order is an option whose
underlier has not yet been resolved.
When a null/undefined value is observed, it indicates it does not apply.
class PositionClosePositionResponse: …
average_fill_price: Optional[str]
Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.
limit_offset: Optional[str]
Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.
limit_price: Optional[str]
Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
releases_at: Optional[datetime]
Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.
stop_price: Optional[str]
Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
trailing_limit_px: Optional[str]
Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_offset: Optional[str]
Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_stop_px: Optional[str]
Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_px: Optional[str]
Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: Optional[str]
Instrument ID of the option’s underlying instrument. Populated only for
options orders. A null means one of two things: the order is not an
option, so the field does not apply; or the order is an option whose
underlier has not yet been resolved.
When a null/undefined value is observed, it indicates it does not apply.
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.
When a null/undefined value is observed, it indicates that there is no available data.
created_at: Optional[datetime]
When the instruction was first accepted by the service. When a null/undefined value is observed, it indicates that there is no available data.
rejection_reason: Optional[str]
Human-readable explanation populated on any non-success terminal
status — REJECTED or CANCEL_FAILED. On a
207 Multi-Status batch submit the top-level error field
summarizes the batch; per-row detail continues to live here.
When a null/undefined value is observed, it indicates it does not apply.
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.
When a null/undefined value is observed, it indicates that there is no available data.
created_at: Optional[datetime]
When the instruction was first accepted by the service. When a null/undefined value is observed, it indicates that there is no available data.
rejection_reason: Optional[str]
Human-readable explanation populated on any non-success terminal
status — REJECTED or CANCEL_FAILED. On a
207 Multi-Status batch submit the top-level error field
summarizes the batch; per-row detail continues to live here.
When a null/undefined value is observed, it indicates it does not apply.
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.
When a null/undefined value is observed, it indicates that there is no available data.
created_at: Optional[datetime]
When the instruction was first accepted by the service. When a null/undefined value is observed, it indicates that there is no available data.
rejection_reason: Optional[str]
Human-readable explanation populated on any non-success terminal
status — REJECTED or CANCEL_FAILED. On a
207 Multi-Status batch submit the top-level error field
summarizes the batch; per-row detail continues to live here.
When a null/undefined value is observed, it indicates it does not apply.
V1Screener
Search instruments and manage saved screeners.
Search Screener
Get Screener By ID
Create Screener
Replace Screener
ModelsExpand Collapse
class ScreenerEntry: …
A saved screener configuration entry
op: Optional[FilterOpSpec]
List[ScreenerEntry]
op: Optional[FilterOpSpec]
List[ScreenerColumn]
List[ScreenerRow]
class SearchFilter: …
A single filter condition.
When op and right are both absent, the filter is “unenabled”:
it persists a left field reference without applying any predicate.
Unenabled filters are skipped during search execution but still
round-trip through save/load so callers can preserve draft state.
op: Optional[FilterOpSpec]
class ScreenerGetScreenersResponse: …
op: Optional[FilterOpSpec]
class ScreenerGetScreenerByIDResponse: …
A saved screener configuration entry
op: Optional[FilterOpSpec]
class ScreenerCreateScreenerResponse: …
A saved screener configuration entry
op: Optional[FilterOpSpec]
class ScreenerReplaceScreenerResponse: …
A saved screener configuration entry
op: Optional[FilterOpSpec]
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
added_price: Optional[str]
Price when the item was added When a null/undefined value is observed, it indicates that there is no available data.
instrument: Optional[Instrument]
Instrument details When a null/undefined value is observed, it indicates that there is no available data.
is_ptp: bool
Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.
notional_adv: Optional[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
options_expiry_dates: Optional[List[date]]
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
List[WatchlistEntry]
class WatchlistItemEntry: …
A single item in a watchlist
added_price: Optional[str]
Price when the item was added When a null/undefined value is observed, it indicates that there is no available data.
instrument: Optional[Instrument]
Instrument details When a null/undefined value is observed, it indicates that there is no available data.
is_ptp: bool
Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.
notional_adv: Optional[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
options_expiry_dates: Optional[List[date]]
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
class WatchlistGetWatchlistByIDResponse: …
Detailed watchlist with all items
Items in the watchlist
added_price: Optional[str]
Price when the item was added When a null/undefined value is observed, it indicates that there is no available data.
instrument: Optional[Instrument]
Instrument details When a null/undefined value is observed, it indicates that there is no available data.
is_ptp: bool
Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
name: Optional[str]
The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.
notional_adv: Optional[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
options_expiry_dates: Optional[List[date]]
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.