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
buying_power: str
The total buying power available in the account: base buying power plus the open order adjustment, where base buying power is maintenance margin excess times the multiplier for intraday and initial margin excess times the multiplier for overnight.
daily_unrealized_pnl: str
Total unrealized profit or loss across all positions relative to prior close.
equity: str
The total equity in the account: cash plus long market value plus short market value, where short market value is negative.
open_order_adjustment: str
Buying power correction from open orders, computed as projected buying power minus actual buying power. A negative value means open orders are consuming buying power.
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.
maintenance_margin_excess: Optional[str]
Start-of-day maintenance margin excess: the difference between equity and the maintenance margin requirement. 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.
Intraday session margin calculation details.
Overnight session margin calculation details.
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.
maintenance_margin_excess: Optional[str]
Start-of-day maintenance margin excess: the difference between equity and the maintenance margin requirement. When a null/undefined value is observed, it indicates it does not apply.
List[Account]
class AccountWithPersonalDetails: …
Represents a trading account
close_date: Optional[date]
The date the account was closed, if applicable When a null/undefined value is observed, it indicates it does not apply.
country_of_tax_residency: Optional[str]
The country of tax residency of the account-holder entity. null
when not on file or entity reference data is unavailable.
When a null/undefined value is observed, it indicates that there is no available data.
date_of_birth: Optional[date]
The date of birth of the account holder’s primary contact. null
when not on file or entity reference data is unavailable.
When a null/undefined value is observed, it indicates that there is no available data.
mailing_address: Optional[Address]
The mailing address of the account-holder entity. null when no
mailing address is on file or entity reference data is unavailable.
When a null/undefined value is observed, it indicates that there is no available data.
class MarginDetails: …
Intraday session margin calculation details.
Overnight session margin calculation details.
class MarginSessionDetails: …
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 AccountGetAccountByIDResponse: …
Represents a trading account
close_date: Optional[date]
The date the account was closed, if applicable When a null/undefined value is observed, it indicates it does not apply.
country_of_tax_residency: Optional[str]
The country of tax residency of the account-holder entity. null
when not on file or entity reference data is unavailable.
When a null/undefined value is observed, it indicates that there is no available data.
date_of_birth: Optional[date]
The date of birth of the account holder’s primary contact. null
when not on file or entity reference data is unavailable.
When a null/undefined value is observed, it indicates that there is no available data.
mailing_address: Optional[Address]
The mailing address of the account-holder entity. null when no
mailing address is on file or entity reference data is unavailable.
When a null/undefined value is observed, it indicates that there is no available data.
class AccountGetAccountBalancesResponse: …
Represents the balance details for a trading account
buying_power: str
The total buying power available in the account: base buying power plus the open order adjustment, where base buying power is maintenance margin excess times the multiplier for intraday and initial margin excess times the multiplier for overnight.
daily_unrealized_pnl: str
Total unrealized profit or loss across all positions relative to prior close.
equity: str
The total equity in the account: cash plus long market value plus short market value, where short market value is negative.
open_order_adjustment: str
Buying power correction from open orders, computed as projected buying power minus actual buying power. A negative value means open orders are consuming buying power.
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.
maintenance_margin_excess: Optional[str]
Start-of-day maintenance margin excess: the difference between equity and the maintenance margin requirement. 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.
Intraday session margin calculation details.
Overnight session margin calculation details.
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.
overnight: Optional[SessionSchedule]
Overnight session schedule (prior evening through early morning), 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.
overnight: Optional[SessionSchedule]
Overnight session schedule (prior evening through early morning), 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.
overnight: Optional[SessionSchedule]
Overnight session schedule (prior evening through early morning), 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.
overnight: Optional[SessionSchedule]
Overnight session schedule (prior evening through early morning), 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.
overnight: Optional[SessionSchedule]
Overnight session schedule (prior evening through early morning), 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.
overnight: Optional[SessionSchedule]
Overnight session schedule (prior evening through early morning), 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.
overnight: Optional[SessionSchedule]
Overnight session schedule (prior evening through early morning), 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.
IPO events
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 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 InstrumentIpoEvent: …
Represents an IPO event for an instrument
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 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.
IPO events
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 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 and not_applicable is Option:
- Unresolvable
instrument_id→ all other fieldsNone(includingsymbol). - Resolvable
instrument_idwith no realtime cache entry →symbolpopulated, OHLV/trade_date/open_interestNone. trade_datereflects the session the OHLV represents (today during trading hours, the last trading date during weekends/holidays).open_interestis populated for options only;Nonefor equities and indices.not_applicableis a non-optionalbool, always serialized:truefor instrument types with no daily summary by definition (e.g. an index, whose OHLV/trade_dateareNone),falseotherwise.
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.
not_applicable: Optional[bool]
true when the instrument type has no daily summary by definition (e.g. an
index). Distinguishes an intentional N/A from OHLV that is merely not loaded
yet. false for instruments that can have a summary.
open: Optional[str]
Opening price for the session. When a null/undefined value is observed, it indicates that there is no available data.
open_interest: Optional[int]
Open interest (outstanding contracts). Populated for options only;
None for equities and indices.
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.
not_applicable: Optional[bool]
true when the instrument type has no daily summary by definition (e.g. an
index). Distinguishes an intentional N/A from OHLV that is merely not loaded
yet. false for instruments that can have a summary.
open: Optional[str]
Opening price for the session. When a null/undefined value is observed, it indicates that there is no available data.
open_interest: Optional[int]
Open interest (outstanding contracts). Populated for options only;
None for equities and indices.
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.
Session-level pricing and OHLV metrics. Always present; each inner field is independently nullable.
ohlv_applicable: bool
false only for instrument types with no OHLV by definition (e.g. an
index instrument, whose price is a computed level rather than a
traded security) — open/high/low/ohlv_date/cumulative_volume
are then always absent. true otherwise, even when those fields
simply haven’t loaded yet. Always serialized.
change: Optional[str]
Absolute change from previous close to the most recent last-sale-eligible trade. Absent when either side of the computation is unavailable. When a null/undefined value is observed, it indicates that there is no available data.
change_percent: Optional[str]
Percent change from previous close to the most recent
last-sale-eligible trade. Absent under the same conditions as
change.
When a null/undefined value is observed, it indicates that there is no available data.
cumulative_volume: Optional[int]
Cumulative traded volume for the current session, in shares for
equities or contracts for options. Always reflects the current
session, even when ohlv_date trails it. Absent when
ohlv_applicable is false, or when no trade is available.
When a null/undefined value is observed, it indicates that there is no available data.
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.
ohlv_date: Optional[date]
Session date the open/high/low values represent, US/Eastern. May trail the current session until the upstream feed rolls. When a null/undefined value is observed, it indicates that there is no available data.
open: Optional[str]
Session opening price, from the day’s OHLC bar. Absent when
ohlv_applicable is false, or when the bar has not loaded yet.
When a null/undefined value is observed, it indicates that there is no available data.
previous_close: Optional[str]
Previous session close price. Corporate-action-adjusted (stock dividends, cash dividends, and forward/reverse splits) when an adjustment exists for the close date; the raw close otherwise. An adjustment can carry the price beyond 2 decimal places. Absent when no previous close is on record (e.g. an instrument’s first session). When a null/undefined value is observed, it indicates that there is no available data.
previous_close_unadjusted: Optional[str]
Unadjusted (raw) previous session close. Present only when a
corporate-action adjustment exists for the previous close date; when no
adjustment exists, previous_close is the raw close and this field is
omitted.
When a null/undefined value is observed, it indicates that there is no available data.
short_sale_restricted: Optional[bool]
Whether the SEC Rule 201 short-sale price test is currently restricting short sales in this security, from the trading-status feed.
true restricts non-exempt short sales at or below the national best
bid. null means we have no answer, either because no trading status
has been seen for this security yet or because Rule 201 does not cover
this security type. A null is not a statement that short selling is
unrestricted, and must not be treated as clear to short.
This is the current market condition, not a statement about whether
Clear Street will reject your order. It is also distinct from
is_short_prohibited on the instrument endpoints, which is a standing
property of the security rather than a live circuit breaker.
When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedcumulative_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.
Deprecated: use session.cumulative_volume, the same value from the
same source.
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.
ask_timestamp: Optional[datetime]
Exchange timestamp of the best ask. Absent when the ask side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
ask_venue: Optional[str]
ISO 10383 Market Identifier Code (MIC) of the venue currently holding the national best offer (NBBO). Absent when the ask side carries no venue. 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.
bid_size: Optional[int]
Size at the best bid, in shares. When a null/undefined value is observed, it indicates that there is no available data.
bid_timestamp: Optional[datetime]
Exchange timestamp of the best bid. Absent when the bid side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
last_trade: Optional[SnapshotLastTrade]
Most recent last-sale-eligible trade if available. Omitted when the most recent known print is ineligible (e.g. an odd lot or an out-of-sequence report) rather than showing that print’s price. When a null/undefined value is observed, it indicates that there is no available data.
price: str
Most recent last-sale eligible trade price. For index instruments, the current index level.
size: int
Share quantity of the most recent last-sale eligible trade. Always 0
for index instruments, whose level is computed rather than traded.
timestamp: Optional[datetime]
Exchange timestamp of the most recent last-sale eligible trade. For index instruments, the time the index level was computed. Absent when the trade carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
venue: Optional[str]
ISO 10383 Market Identifier Code (MIC) of the venue where the most recent last-sale eligible trade took place. Absent when the trade carries no venue; index levels are computed rather than traded and have no venue. When a null/undefined value is observed, it indicates that there is no available data.
List[MarketDataSnapshot]
Session-level pricing and OHLV metrics. Always present; each inner field is independently nullable.
ohlv_applicable: bool
false only for instrument types with no OHLV by definition (e.g. an
index instrument, whose price is a computed level rather than a
traded security) — open/high/low/ohlv_date/cumulative_volume
are then always absent. true otherwise, even when those fields
simply haven’t loaded yet. Always serialized.
change: Optional[str]
Absolute change from previous close to the most recent last-sale-eligible trade. Absent when either side of the computation is unavailable. When a null/undefined value is observed, it indicates that there is no available data.
change_percent: Optional[str]
Percent change from previous close to the most recent
last-sale-eligible trade. Absent under the same conditions as
change.
When a null/undefined value is observed, it indicates that there is no available data.
cumulative_volume: Optional[int]
Cumulative traded volume for the current session, in shares for
equities or contracts for options. Always reflects the current
session, even when ohlv_date trails it. Absent when
ohlv_applicable is false, or when no trade is available.
When a null/undefined value is observed, it indicates that there is no available data.
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.
ohlv_date: Optional[date]
Session date the open/high/low values represent, US/Eastern. May trail the current session until the upstream feed rolls. When a null/undefined value is observed, it indicates that there is no available data.
open: Optional[str]
Session opening price, from the day’s OHLC bar. Absent when
ohlv_applicable is false, or when the bar has not loaded yet.
When a null/undefined value is observed, it indicates that there is no available data.
previous_close: Optional[str]
Previous session close price. Corporate-action-adjusted (stock dividends, cash dividends, and forward/reverse splits) when an adjustment exists for the close date; the raw close otherwise. An adjustment can carry the price beyond 2 decimal places. Absent when no previous close is on record (e.g. an instrument’s first session). When a null/undefined value is observed, it indicates that there is no available data.
previous_close_unadjusted: Optional[str]
Unadjusted (raw) previous session close. Present only when a
corporate-action adjustment exists for the previous close date; when no
adjustment exists, previous_close is the raw close and this field is
omitted.
When a null/undefined value is observed, it indicates that there is no available data.
short_sale_restricted: Optional[bool]
Whether the SEC Rule 201 short-sale price test is currently restricting short sales in this security, from the trading-status feed.
true restricts non-exempt short sales at or below the national best
bid. null means we have no answer, either because no trading status
has been seen for this security yet or because Rule 201 does not cover
this security type. A null is not a statement that short selling is
unrestricted, and must not be treated as clear to short.
This is the current market condition, not a statement about whether
Clear Street will reject your order. It is also distinct from
is_short_prohibited on the instrument endpoints, which is a standing
property of the security rather than a live circuit breaker.
When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedcumulative_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.
Deprecated: use session.cumulative_volume, the same value from the
same source.
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.
ask_timestamp: Optional[datetime]
Exchange timestamp of the best ask. Absent when the ask side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
ask_venue: Optional[str]
ISO 10383 Market Identifier Code (MIC) of the venue currently holding the national best offer (NBBO). Absent when the ask side carries no venue. 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.
bid_size: Optional[int]
Size at the best bid, in shares. When a null/undefined value is observed, it indicates that there is no available data.
bid_timestamp: Optional[datetime]
Exchange timestamp of the best bid. Absent when the bid side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
last_trade: Optional[SnapshotLastTrade]
Most recent last-sale-eligible trade if available. Omitted when the most recent known print is ineligible (e.g. an odd lot or an out-of-sequence report) rather than showing that print’s price. When a null/undefined value is observed, it indicates that there is no available data.
price: str
Most recent last-sale eligible trade price. For index instruments, the current index level.
size: int
Share quantity of the most recent last-sale eligible trade. Always 0
for index instruments, whose level is computed rather than traded.
timestamp: Optional[datetime]
Exchange timestamp of the most recent last-sale eligible trade. For index instruments, the time the index level was computed. Absent when the trade carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
venue: Optional[str]
ISO 10383 Market Identifier Code (MIC) of the venue where the most recent last-sale eligible trade took place. Absent when the trade carries no venue; index levels are computed rather than traded and have no venue. When a null/undefined value is observed, it indicates that there is no available data.
class SnapshotLastTrade: …
Last-trade fields for a market data snapshot.
For index instruments this carries the current index level — a computed
value, not a trade: price is the level and size is always 0 (no
contract changes hands).
price: str
Most recent last-sale eligible trade price. For index instruments, the current index level.
size: int
Share quantity of the most recent last-sale eligible trade. Always 0
for index instruments, whose level is computed rather than traded.
timestamp: Optional[datetime]
Exchange timestamp of the most recent last-sale eligible trade. For index instruments, the time the index level was computed. Absent when the trade carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
venue: Optional[str]
ISO 10383 Market Identifier Code (MIC) of the venue where the most recent last-sale eligible trade took place. Absent when the trade carries no venue; index levels are computed rather than traded and have no venue. 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.
ask_timestamp: Optional[datetime]
Exchange timestamp of the best ask. Absent when the ask side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
ask_venue: Optional[str]
ISO 10383 Market Identifier Code (MIC) of the venue currently holding the national best offer (NBBO). Absent when the ask side carries no venue. 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.
bid_size: Optional[int]
Size at the best bid, in shares. When a null/undefined value is observed, it indicates that there is no available data.
bid_timestamp: Optional[datetime]
Exchange timestamp of the best bid. Absent when the bid side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
class SnapshotSession: …
Session-level pricing and OHLV metrics for a market data snapshot. Always
present on the snapshot row; every field here is independently nullable
except ohlv_applicable.
ohlv_applicable: bool
false only for instrument types with no OHLV by definition (e.g. an
index instrument, whose price is a computed level rather than a
traded security) — open/high/low/ohlv_date/cumulative_volume
are then always absent. true otherwise, even when those fields
simply haven’t loaded yet. Always serialized.
change: Optional[str]
Absolute change from previous close to the most recent last-sale-eligible trade. Absent when either side of the computation is unavailable. When a null/undefined value is observed, it indicates that there is no available data.
change_percent: Optional[str]
Percent change from previous close to the most recent
last-sale-eligible trade. Absent under the same conditions as
change.
When a null/undefined value is observed, it indicates that there is no available data.
cumulative_volume: Optional[int]
Cumulative traded volume for the current session, in shares for
equities or contracts for options. Always reflects the current
session, even when ohlv_date trails it. Absent when
ohlv_applicable is false, or when no trade is available.
When a null/undefined value is observed, it indicates that there is no available data.
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.
ohlv_date: Optional[date]
Session date the open/high/low values represent, US/Eastern. May trail the current session until the upstream feed rolls. When a null/undefined value is observed, it indicates that there is no available data.
open: Optional[str]
Session opening price, from the day’s OHLC bar. Absent when
ohlv_applicable is false, or when the bar has not loaded yet.
When a null/undefined value is observed, it indicates that there is no available data.
previous_close: Optional[str]
Previous session close price. Corporate-action-adjusted (stock dividends, cash dividends, and forward/reverse splits) when an adjustment exists for the close date; the raw close otherwise. An adjustment can carry the price beyond 2 decimal places. Absent when no previous close is on record (e.g. an instrument’s first session). When a null/undefined value is observed, it indicates that there is no available data.
previous_close_unadjusted: Optional[str]
Unadjusted (raw) previous session close. Present only when a
corporate-action adjustment exists for the previous close date; when no
adjustment exists, previous_close is the raw close and this field is
omitted.
When a null/undefined value is observed, it indicates that there is no available data.
class MarketDataGetSnapshotsResponse: …
Session-level pricing and OHLV metrics. Always present; each inner field is independently nullable.
ohlv_applicable: bool
false only for instrument types with no OHLV by definition (e.g. an
index instrument, whose price is a computed level rather than a
traded security) — open/high/low/ohlv_date/cumulative_volume
are then always absent. true otherwise, even when those fields
simply haven’t loaded yet. Always serialized.
change: Optional[str]
Absolute change from previous close to the most recent last-sale-eligible trade. Absent when either side of the computation is unavailable. When a null/undefined value is observed, it indicates that there is no available data.
change_percent: Optional[str]
Percent change from previous close to the most recent
last-sale-eligible trade. Absent under the same conditions as
change.
When a null/undefined value is observed, it indicates that there is no available data.
cumulative_volume: Optional[int]
Cumulative traded volume for the current session, in shares for
equities or contracts for options. Always reflects the current
session, even when ohlv_date trails it. Absent when
ohlv_applicable is false, or when no trade is available.
When a null/undefined value is observed, it indicates that there is no available data.
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.
ohlv_date: Optional[date]
Session date the open/high/low values represent, US/Eastern. May trail the current session until the upstream feed rolls. When a null/undefined value is observed, it indicates that there is no available data.
open: Optional[str]
Session opening price, from the day’s OHLC bar. Absent when
ohlv_applicable is false, or when the bar has not loaded yet.
When a null/undefined value is observed, it indicates that there is no available data.
previous_close: Optional[str]
Previous session close price. Corporate-action-adjusted (stock dividends, cash dividends, and forward/reverse splits) when an adjustment exists for the close date; the raw close otherwise. An adjustment can carry the price beyond 2 decimal places. Absent when no previous close is on record (e.g. an instrument’s first session). When a null/undefined value is observed, it indicates that there is no available data.
previous_close_unadjusted: Optional[str]
Unadjusted (raw) previous session close. Present only when a
corporate-action adjustment exists for the previous close date; when no
adjustment exists, previous_close is the raw close and this field is
omitted.
When a null/undefined value is observed, it indicates that there is no available data.
short_sale_restricted: Optional[bool]
Whether the SEC Rule 201 short-sale price test is currently restricting short sales in this security, from the trading-status feed.
true restricts non-exempt short sales at or below the national best
bid. null means we have no answer, either because no trading status
has been seen for this security yet or because Rule 201 does not cover
this security type. A null is not a statement that short selling is
unrestricted, and must not be treated as clear to short.
This is the current market condition, not a statement about whether
Clear Street will reject your order. It is also distinct from
is_short_prohibited on the instrument endpoints, which is a standing
property of the security rather than a live circuit breaker.
When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedcumulative_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.
Deprecated: use session.cumulative_volume, the same value from the
same source.
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.
ask_timestamp: Optional[datetime]
Exchange timestamp of the best ask. Absent when the ask side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
ask_venue: Optional[str]
ISO 10383 Market Identifier Code (MIC) of the venue currently holding the national best offer (NBBO). Absent when the ask side carries no venue. 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.
bid_size: Optional[int]
Size at the best bid, in shares. When a null/undefined value is observed, it indicates that there is no available data.
bid_timestamp: Optional[datetime]
Exchange timestamp of the best bid. Absent when the bid side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
last_trade: Optional[SnapshotLastTrade]
Most recent last-sale-eligible trade if available. Omitted when the most recent known print is ineligible (e.g. an odd lot or an out-of-sequence report) rather than showing that print’s price. When a null/undefined value is observed, it indicates that there is no available data.
price: str
Most recent last-sale eligible trade price. For index instruments, the current index level.
size: int
Share quantity of the most recent last-sale eligible trade. Always 0
for index instruments, whose level is computed rather than traded.
timestamp: Optional[datetime]
Exchange timestamp of the most recent last-sale eligible trade. For index instruments, the time the index level was computed. Absent when the trade carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
venue: Optional[str]
ISO 10383 Market Identifier Code (MIC) of the venue where the most recent last-sale eligible trade took place. Absent when the trade carries no venue; index levels are computed rather than traded and have no venue. 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.
not_applicable: Optional[bool]
true when the instrument type has no daily summary by definition (e.g. an
index). Distinguishes an intentional N/A from OHLV that is merely not loaded
yet. false for instruments that can have a summary.
open: Optional[str]
Opening price for the session. When a null/undefined value is observed, it indicates that there is no available data.
open_interest: Optional[int]
Open interest (outstanding contracts). Populated for options only;
None for equities and indices.
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_short_prohibited: bool
Indicates if short selling is prohibited for the instrument. This is a
standing property of the security. For the live Rule 201 circuit
breaker, see short_sale_restricted on the market-data snapshot.
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.
cax_adjusted_previous_close: Optional[str]
Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.
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 the cax-adjusted close when present, the raw previous close otherwise). When a null/undefined value is observed, it indicates that there is no available data.
Available options expiration dates for this instrument, each annotated
with which settlement cycles have listed contracts on it.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
has_settles_on_close: bool
Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.
has_settles_on_open: bool
Whether this date has at least one contract that settles on the opening print (AM settlement) and can still be traded. AM-settled contracts stop trading at the close of the business day before settlement, so this turns false before the expiration date arrives. A date leaves the list once no contract on it can be traded in either settlement cycle.
Deprecatedoptions_expiry_dates: Optional[List[date]]
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
Deprecated: use options_contract_expiry_dates, which carries the same
dates annotated with settlement-cycle information.
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.
short_margin_rate: Optional[str]
The percent of a short position’s value you must post as margin 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_short_prohibited: bool
Indicates if short selling is prohibited for the instrument. This is a
standing property of the security. For the live Rule 201 circuit
breaker, see short_sale_restricted on the market-data snapshot.
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.
cax_adjusted_previous_close: Optional[str]
Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.
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 the cax-adjusted close when present, the raw previous close otherwise). 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.
short_margin_rate: Optional[str]
The percent of a short position’s value you must post as margin 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_short_prohibited: bool
Indicates if short selling is prohibited for the instrument. This is a
standing property of the security. For the live Rule 201 circuit
breaker, see short_sale_restricted on the market-data snapshot.
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.
cax_adjusted_previous_close: Optional[str]
Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.
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 the cax-adjusted close when present, the raw previous close otherwise). 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.
short_margin_rate: Optional[str]
The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
class OptionExpiryDate: …
An options expiry date, annotated with which settlement cycles have listed contracts on it.
has_settles_on_close: bool
Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.
has_settles_on_open: bool
Whether this date has at least one contract that settles on the opening print (AM settlement) and can still be traded. AM-settled contracts stop trading at the close of the business day before settlement, so this turns false before the expiration date arrives. A date leaves the list once no contract on it can be traded in either settlement cycle.
class OptionsContract: …
An options contract with options-specific metadata
is_settle_on_open: Optional[bool]
Whether the option settles on the opening price (AM settlement), if known When a null/undefined value is observed, it indicates that there is no available data.
last_trade_cutoff: Optional[datetime]
Last moment the option can trade (UTC), if known When a null/undefined value is observed, it indicates that there is no available data.
open_interest: Optional[int]
Open interest (number of outstanding contracts), if available When a null/undefined value is observed, it indicates that there is no available data.
List[OptionsContract]
is_settle_on_open: Optional[bool]
Whether the option settles on the opening price (AM settlement), if known When a null/undefined value is observed, it indicates that there is no available data.
last_trade_cutoff: Optional[datetime]
Last moment the option can trade (UTC), if known When a null/undefined value is observed, it indicates that there is no available data.
open_interest: Optional[int]
Open interest (number of outstanding contracts), if available When a null/undefined value is observed, it indicates that there is no available data.
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_short_prohibited: bool
Indicates if short selling is prohibited for the instrument. This is a
standing property of the security. For the live Rule 201 circuit
breaker, see short_sale_restricted on the market-data snapshot.
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.
cax_adjusted_previous_close: Optional[str]
Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.
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 the cax-adjusted close when present, the raw previous close otherwise). 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.
short_margin_rate: Optional[str]
The percent of a short position’s value you must post as margin 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_short_prohibited: bool
Indicates if short selling is prohibited for the instrument. This is a
standing property of the security. For the live Rule 201 circuit
breaker, see short_sale_restricted on the market-data snapshot.
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.
cax_adjusted_previous_close: Optional[str]
Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.
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 the cax-adjusted close when present, the raw previous close otherwise). When a null/undefined value is observed, it indicates that there is no available data.
Available options expiration dates for this instrument, each annotated
with which settlement cycles have listed contracts on it.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
has_settles_on_close: bool
Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.
has_settles_on_open: bool
Whether this date has at least one contract that settles on the opening print (AM settlement) and can still be traded. AM-settled contracts stop trading at the close of the business day before settlement, so this turns false before the expiration date arrives. A date leaves the list once no contract on it can be traded in either settlement cycle.
Deprecatedoptions_expiry_dates: Optional[List[date]]
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
Deprecated: use options_contract_expiry_dates, which carries the same
dates annotated with settlement-cycle information.
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.
short_margin_rate: Optional[str]
The percent of a short position’s value you must post as margin 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_short_prohibited: bool
Indicates if short selling is prohibited for the instrument. This is a
standing property of the security. For the live Rule 201 circuit
breaker, see short_sale_restricted on the market-data snapshot.
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.
cax_adjusted_previous_close: Optional[str]
Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.
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 the cax-adjusted close when present, the raw previous close otherwise). 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.
short_margin_rate: Optional[str]
The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentGetOptionContractsResponse: …
is_settle_on_open: Optional[bool]
Whether the option settles on the opening price (AM settlement), if known When a null/undefined value is observed, it indicates that there is no available data.
last_trade_cutoff: Optional[datetime]
Last moment the option can trade (UTC), if known When a null/undefined value is observed, it indicates that there is no available data.
open_interest: Optional[int]
Open interest (number of outstanding contracts), if available When a null/undefined value is observed, it indicates that there is no available data.
V1Omni AI
ModelsExpand Collapse
class ActionButton: …
Button metadata shared by chart and suggested-actions payloads.
class ChartPayload: …
Typed chart payload rendered inline in assistant content.
Buttons associated with this chart.
class ContentPartChartPayload: …
Chart payload content part.
Typed chart payload rendered inline in assistant content.
Buttons associated with this chart.
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 PrefillOrder: …
class OpenChart: …
Open a chart for a symbol
Open a chart for a symbol
extras: Optional[object]
Additional chart configuration (indicators, overlays, etc.) When a null/undefined value is observed, it indicates it does not apply.
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.
item_id: Optional[str]
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
page_size: Optional[int]
Optional page size. When a null/undefined value is observed, it indicates it does not apply.
class ContentPartSuggestedActionsPayload: …
Suggested actions payload content part.
Suggested follow-up buttons rendered at the end of an assistant message.
Ordered message-level buttons.
class OpenChartAction: …
Action to open a chart for a symbol.
extras: Optional[object]
Additional chart configuration (indicators, overlays, etc.) 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.
item_id: Optional[str]
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
page_size: Optional[int]
Optional page size. When a null/undefined value is observed, it indicates it does not apply.
class PrefillModifyOrderAction: …
Modify-order prefill action.
class PrefillModifyOrderRequest: …
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.
instrument_id: Optional[InstrumentIDOrSymbol]
Instrument ID (UUID) or symbol (equity ticker or OSI option symbol). Either symbol or instrument_id must be provided.
item_id: Optional[str]
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
strategy: Optional[OrderStrategy]
Optional execution strategy. One of SOR, VWAP, or TWAP. Defaults to
SOR. VWAP and TWAP are supported only on MARKET and LIMIT orders
with DAY time-in-force, and are not supported on OTC common-stock orders.
class UnionMember1: …
class PrefillNewOrderRequest: …
Request to submit a new order
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.
instrument_id: Optional[InstrumentIDOrSymbol]
Instrument ID (UUID) or symbol (equity ticker or OSI option symbol). Either symbol or instrument_id must be provided.
item_id: Optional[str]
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
strategy: Optional[OrderStrategy]
Optional execution strategy. One of SOR, VWAP, or TWAP. Defaults to
SOR. VWAP and TWAP are supported only on MARKET and LIMIT orders
with DAY time-in-force, and are not supported on OTC common-stock orders.
class UnionMember1: …
Union[PrefillNewOrderAction, PrefillCancelOrderAction, PrefillModifyOrderAction]
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 PrefillOrder: …
class OpenChart: …
Open a chart for a symbol
Open a chart for a symbol
extras: Optional[object]
Additional chart configuration (indicators, overlays, etc.) When a null/undefined value is observed, it indicates it does not apply.
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.
item_id: Optional[str]
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
page_size: Optional[int]
Optional page size. When a null/undefined value is observed, it indicates it does not apply.
class SuggestedActionsPayload: …
Suggested follow-up buttons rendered at the end of an assistant message.
Ordered message-level buttons.
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
Submit Feedback
ModelsExpand Collapse
class MessageGetMessageByIDResponse: …
Final immutable message.
context: Optional[TurnContext]
Immutable snapshots attached to this user message. Omitted when none were supplied. When a null/undefined value is observed, it indicates that there is no available data.
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
Create Thread
Get Thread Response
Get Messages
Create Message
ModelsExpand Collapse
class Message: …
Final immutable message.
context: Optional[TurnContext]
Immutable snapshots attached to this user message. Omitted when none were supplied. When a null/undefined value is observed, it indicates that there is no available data.
List[Message]
context: Optional[TurnContext]
Immutable snapshots attached to this user message. Omitted when none were supplied. When a null/undefined value is observed, it indicates that there is no available data.
List[Thread]
class TurnContext: …
Client snapshots attached to one instant-chat user message.
Context is separate from visible message text and does not grant account access. The compact JSON representation must not exceed 64 KiB.
class ThreadGetThreadResponseResponse: …
data: Optional[Response]
class ThreadGetMessagesResponse: …
context: Optional[TurnContext]
Immutable snapshots attached to this user message. Omitted when none were supplied. When a null/undefined value is observed, it indicates that there is no available data.
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
class Execution: …
Represents a single fill of an order for an account.
instrument_id: Optional[str]
Unique instrument identifier. null when this fill has no single resolvable
instrument.
When a null/undefined value is observed, it indicates it does not apply.
price: Optional[str]
Fill price. null for multileg fills, whose price lives only at the leg level.
When a null/undefined value is observed, it indicates it does not apply.
symbol: Optional[str]
Trading symbol. null when this fill has no single resolvable instrument.
When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: Optional[str]
Underlying instrument identifier for an option fill. Omitted for a
non-derivative fill, when the underlier could not be resolved, or for a
multileg fill (per-leg underliers live in legs[]).
When a null/undefined value is observed, it indicates it does not apply.
List[Execution]
instrument_id: Optional[str]
Unique instrument identifier. null when this fill has no single resolvable
instrument.
When a null/undefined value is observed, it indicates it does not apply.
price: Optional[str]
Fill price. null for multileg fills, whose price lives only at the leg level.
When a null/undefined value is observed, it indicates it does not apply.
symbol: Optional[str]
Trading symbol. null when this fill has no single resolvable instrument.
When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: Optional[str]
Underlying instrument identifier for an option fill. Omitted for a
non-derivative fill, when the underlier could not be resolved, or for a
multileg fill (per-leg underliers live in legs[]).
When a null/undefined value is observed, it indicates it does not apply.
class NewOrderRequest: …
Request to submit a new order
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.
instrument_id: Optional[InstrumentIDOrSymbol]
Instrument ID (UUID) or symbol (equity ticker or OSI option symbol). Either symbol or instrument_id must be provided.
strategy: Optional[OrderStrategy]
Optional execution strategy. One of SOR, VWAP, or TWAP. Defaults to
SOR. VWAP and TWAP are supported only on MARKET and LIMIT orders
with DAY time-in-force, and are not supported on OTC common-stock orders.
class UnionMember1: …
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. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. 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.
instrument_id: Optional[str]
Instrument identifier for the traded instrument. null when the order has
no single resolvable instrument.
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.
symbol: Optional[str]
Trading symbol. null when the order has no single resolvable instrument.
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. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. 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. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. 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.
instrument_id: Optional[str]
Instrument identifier for the traded instrument. null when the order has
no single resolvable instrument.
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.
symbol: Optional[str]
Trading symbol. null when the order has no single resolvable instrument.
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. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. 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.
Optional execution strategy controlling how the order is worked in the market. Omit to use standard routing. One of SOR, VWAP, or TWAP.
class UnionMember1: …
class OrderGetOrdersResponse: …
average_fill_price: Optional[str]
Average fill price across all executions. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. 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.
instrument_id: Optional[str]
Instrument identifier for the traded instrument. null when the order has
no single resolvable instrument.
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.
symbol: Optional[str]
Trading symbol. null when the order has no single resolvable instrument.
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. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. 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. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. 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.
instrument_id: Optional[str]
Instrument identifier for the traded instrument. null when the order has
no single resolvable instrument.
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.
symbol: Optional[str]
Trading symbol. null when the order has no single resolvable instrument.
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. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. 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. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. 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.
instrument_id: Optional[str]
Instrument identifier for the traded instrument. null when the order has
no single resolvable instrument.
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.
symbol: Optional[str]
Trading symbol. null when the order has no single resolvable instrument.
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. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. 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. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. 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.
instrument_id: Optional[str]
Instrument identifier for the traded instrument. null when the order has
no single resolvable instrument.
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.
symbol: Optional[str]
Trading symbol. null when the order has no single resolvable instrument.
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. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. 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. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. 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.
instrument_id: Optional[str]
Instrument identifier for the traded instrument. null when the order has
no single resolvable instrument.
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.
symbol: Optional[str]
Trading symbol. null when the order has no single resolvable instrument.
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. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. 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. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. 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.
instrument_id: Optional[str]
Instrument identifier for the traded instrument. null when the order has
no single resolvable instrument.
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.
symbol: Optional[str]
Trading symbol. null when the order has no single resolvable instrument.
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. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. 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 OrderGetExecutionsResponse: …
instrument_id: Optional[str]
Unique instrument identifier. null when this fill has no single resolvable
instrument.
When a null/undefined value is observed, it indicates it does not apply.
price: Optional[str]
Fill price. null for multileg fills, whose price lives only at the leg level.
When a null/undefined value is observed, it indicates it does not apply.
symbol: Optional[str]
Trading symbol. null when this fill has no single resolvable instrument.
When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: Optional[str]
Underlying instrument identifier for an option fill. Omitted for a
non-derivative fill, when the underlier could not be resolved, or for a
multileg fill (per-leg underliers live in legs[]).
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.
client_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: Optional[PositionInstructionRejection]
Machine-readable counterpart to rejection_reason: a stable reason code,
human-readable description, and params, present on every rejected row —
on submit, cancel, get, and list alike. Branch on rejection.reason and
read rejection.description instead of the top-level rejection_reason.
When a null/undefined value is observed, it indicates it does not apply.
description: str
Human-readable explanation of the rejection. Duplicates the top-level
rejection_reason; prefer this field.
domain: str
Namespacing domain of the reason code — com.clearstreet.oems.exercise
for reasons OEMS validates, com.clearstreet.oems.clearing for
clearing-owned reasons.
metadata: Dict[str, str]
Reason-specific parameters as a string→string map. Which keys are present
depends on reason:
INSUFFICIENT_POSITION→available,requestedDNE_NOT_ON_EXPIRY/CEA_NOT_ON_EXPIRY→expiry,business_dateEXERCISE_PAST_CUTOFF→cutoff_timeDUPLICATE_INSTRUCTION→existing_id
Empty for reasons that carry no parameters. New keys may be added over time, so treat unknown keys leniently.
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]
client_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: Optional[PositionInstructionRejection]
Machine-readable counterpart to rejection_reason: a stable reason code,
human-readable description, and params, present on every rejected row —
on submit, cancel, get, and list alike. Branch on rejection.reason and
read rejection.description instead of the top-level rejection_reason.
When a null/undefined value is observed, it indicates it does not apply.
description: str
Human-readable explanation of the rejection. Duplicates the top-level
rejection_reason; prefer this field.
domain: str
Namespacing domain of the reason code — com.clearstreet.oems.exercise
for reasons OEMS validates, com.clearstreet.oems.clearing for
clearing-owned reasons.
metadata: Dict[str, str]
Reason-specific parameters as a string→string map. Which keys are present
depends on reason:
INSUFFICIENT_POSITION→available,requestedDNE_NOT_ON_EXPIRY/CEA_NOT_ON_EXPIRY→expiry,business_dateEXERCISE_PAST_CUTOFF→cutoff_timeDUPLICATE_INSTRUCTION→existing_id
Empty for reasons that carry no parameters. New keys may be added over time, so treat unknown keys leniently.
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 PositionInstructionRejection: …
Machine-readable detail for a rejected position instruction.
Present on every rejected row, across the full lifecycle — submit, cancel,
get, and list. Branch on reason for programmatic handling and template your
own copy from metadata, or show description directly.
description: str
Human-readable explanation of the rejection. Duplicates the top-level
rejection_reason; prefer this field.
domain: str
Namespacing domain of the reason code — com.clearstreet.oems.exercise
for reasons OEMS validates, com.clearstreet.oems.clearing for
clearing-owned reasons.
metadata: Dict[str, str]
Reason-specific parameters as a string→string map. Which keys are present
depends on reason:
INSUFFICIENT_POSITION→available,requestedDNE_NOT_ON_EXPIRY/CEA_NOT_ON_EXPIRY→expiry,business_dateEXERCISE_PAST_CUTOFF→cutoff_timeDUPLICATE_INSTRUCTION→existing_id
Empty for reasons that carry no parameters. New keys may be added over time, so treat unknown keys leniently.
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. duplicateclient_instruction_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. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. 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.
instrument_id: Optional[str]
Instrument identifier for the traded instrument. null when the order has
no single resolvable instrument.
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.
symbol: Optional[str]
Trading symbol. null when the order has no single resolvable instrument.
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. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. 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. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. 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.
instrument_id: Optional[str]
Instrument identifier for the traded instrument. null when the order has
no single resolvable instrument.
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.
symbol: Optional[str]
Trading symbol. null when the order has no single resolvable instrument.
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. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: Optional[datetime]
Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. 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: …
client_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: Optional[PositionInstructionRejection]
Machine-readable counterpart to rejection_reason: a stable reason code,
human-readable description, and params, present on every rejected row —
on submit, cancel, get, and list alike. Branch on rejection.reason and
read rejection.description instead of the top-level rejection_reason.
When a null/undefined value is observed, it indicates it does not apply.
description: str
Human-readable explanation of the rejection. Duplicates the top-level
rejection_reason; prefer this field.
domain: str
Namespacing domain of the reason code — com.clearstreet.oems.exercise
for reasons OEMS validates, com.clearstreet.oems.clearing for
clearing-owned reasons.
metadata: Dict[str, str]
Reason-specific parameters as a string→string map. Which keys are present
depends on reason:
INSUFFICIENT_POSITION→available,requestedDNE_NOT_ON_EXPIRY/CEA_NOT_ON_EXPIRY→expiry,business_dateEXERCISE_PAST_CUTOFF→cutoff_timeDUPLICATE_INSTRUCTION→existing_id
Empty for reasons that carry no parameters. New keys may be added over time, so treat unknown keys leniently.
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: …
client_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: Optional[PositionInstructionRejection]
Machine-readable counterpart to rejection_reason: a stable reason code,
human-readable description, and params, present on every rejected row —
on submit, cancel, get, and list alike. Branch on rejection.reason and
read rejection.description instead of the top-level rejection_reason.
When a null/undefined value is observed, it indicates it does not apply.
description: str
Human-readable explanation of the rejection. Duplicates the top-level
rejection_reason; prefer this field.
domain: str
Namespacing domain of the reason code — com.clearstreet.oems.exercise
for reasons OEMS validates, com.clearstreet.oems.clearing for
clearing-owned reasons.
metadata: Dict[str, str]
Reason-specific parameters as a string→string map. Which keys are present
depends on reason:
INSUFFICIENT_POSITION→available,requestedDNE_NOT_ON_EXPIRY/CEA_NOT_ON_EXPIRY→expiry,business_dateEXERCISE_PAST_CUTOFF→cutoff_timeDUPLICATE_INSTRUCTION→existing_id
Empty for reasons that carry no parameters. New keys may be added over time, so treat unknown keys leniently.
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.
client_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: Optional[PositionInstructionRejection]
Machine-readable counterpart to rejection_reason: a stable reason code,
human-readable description, and params, present on every rejected row —
on submit, cancel, get, and list alike. Branch on rejection.reason and
read rejection.description instead of the top-level rejection_reason.
When a null/undefined value is observed, it indicates it does not apply.
description: str
Human-readable explanation of the rejection. Duplicates the top-level
rejection_reason; prefer this field.
domain: str
Namespacing domain of the reason code — com.clearstreet.oems.exercise
for reasons OEMS validates, com.clearstreet.oems.clearing for
clearing-owned reasons.
metadata: Dict[str, str]
Reason-specific parameters as a string→string map. Which keys are present
depends on reason:
INSUFFICIENT_POSITION→available,requestedDNE_NOT_ON_EXPIRY/CEA_NOT_ON_EXPIRY→expiry,business_dateEXERCISE_PAST_CUTOFF→cutoff_timeDUPLICATE_INSTRUCTION→existing_id
Empty for reasons that carry no parameters. New keys may be added over time, so treat unknown keys leniently.
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.
V1Private Markets
Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.
Get SPV
List every live IOI for the caller's account-holder entity.
Create an IOI for a visible upcoming offering.
Update an IOI's notional, accepting the current NDA revision when required.
Withdraw a live IOI. Repeating a withdrawal returns 404.
Get Company
ModelsExpand Collapse
class PrivateMarketGetCompanyByIDResponse: …
A company’s identity and its complete published profile.
V1Private MarketsCompanies
ModelsExpand Collapse
class CompanyDetail: …
A company’s identity and its complete published profile.
class CompanyProfileResource: …
V1Private MarketsIois
ModelsExpand Collapse
List[IoiListingResource]
V1Private MarketsOfferings
Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.
List Offerings
Get Offering
ModelsExpand Collapse
class OfferingCard: …
One offering as it appears in a list: its derived class, indicative terms, a company identity summary, and any attached SPV.
List[OfferingCard]
V1Private MarketsSpvs
ModelsExpand Collapse
V1Screener
Search instruments and manage saved screeners.
Search Screener
Get Screener By ID
Create Screener
Replace Screener
Patch Screener
Get Screener Catalog
ModelsExpand Collapse
class Catalog: …
The complete screener field catalog, serialized as the data payload of
GET /screener/catalog.
default_response_fields: List[str]
The api_names that resolve to the POST default column set when
columns is omitted.
Request-side semantics for turning the data into a valid call.
api_name_composition: str
Requests and response field objects use the same reference shape:
base name plus at most one of period / lookback;
default_response_fields (the POST default column set when columns
is omitted) carries api_names, each decoding via suffixes.
axes: str
At most one of period / lookback; the empty combination selects
the field’s current or most recent value.
class Rules: …
Request-side semantics: how to turn the catalog data into a valid
POST /screener call.
api_name_composition: str
Requests and response field objects use the same reference shape:
base name plus at most one of period / lookback;
default_response_fields (the POST default column set when columns
is omitted) carries api_names, each decoding via suffixes.
axes: str
At most one of period / lookback; the empty combination selects
the field’s current or most recent value.
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]
class ScreenerPatchScreenerResponse: …
A saved screener configuration entry
op: Optional[FilterOpSpec]
class ScreenerGetScreenerCatalogResponse: …
The complete screener field catalog, serialized as the data payload of
GET /screener/catalog.
default_response_fields: List[str]
The api_names that resolve to the POST default column set when
columns is omitted.
Request-side semantics for turning the data into a valid call.
api_name_composition: str
Requests and response field objects use the same reference shape:
base name plus at most one of period / lookback;
default_response_fields (the POST default column set when columns
is omitted) carries api_names, each decoding via suffixes.
axes: str
At most one of period / lookback; the empty combination selects
the field’s current or most recent value.
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_short_prohibited: bool
Indicates if short selling is prohibited for the instrument. This is a
standing property of the security. For the live Rule 201 circuit
breaker, see short_sale_restricted on the market-data snapshot.
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.
cax_adjusted_previous_close: Optional[str]
Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.
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 the cax-adjusted close when present, the raw previous close otherwise). When a null/undefined value is observed, it indicates that there is no available data.
Available options expiration dates for this instrument, each annotated
with which settlement cycles have listed contracts on it.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
has_settles_on_close: bool
Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.
has_settles_on_open: bool
Whether this date has at least one contract that settles on the opening print (AM settlement) and can still be traded. AM-settled contracts stop trading at the close of the business day before settlement, so this turns false before the expiration date arrives. A date leaves the list once no contract on it can be traded in either settlement cycle.
Deprecatedoptions_expiry_dates: Optional[List[date]]
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
Deprecated: use options_contract_expiry_dates, which carries the same
dates annotated with settlement-cycle information.
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.
short_margin_rate: Optional[str]
The percent of a short position’s value you must post as margin 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_short_prohibited: bool
Indicates if short selling is prohibited for the instrument. This is a
standing property of the security. For the live Rule 201 circuit
breaker, see short_sale_restricted on the market-data snapshot.
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.
cax_adjusted_previous_close: Optional[str]
Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.
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 the cax-adjusted close when present, the raw previous close otherwise). When a null/undefined value is observed, it indicates that there is no available data.
Available options expiration dates for this instrument, each annotated
with which settlement cycles have listed contracts on it.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
has_settles_on_close: bool
Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.
has_settles_on_open: bool
Whether this date has at least one contract that settles on the opening print (AM settlement) and can still be traded. AM-settled contracts stop trading at the close of the business day before settlement, so this turns false before the expiration date arrives. A date leaves the list once no contract on it can be traded in either settlement cycle.
Deprecatedoptions_expiry_dates: Optional[List[date]]
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
Deprecated: use options_contract_expiry_dates, which carries the same
dates annotated with settlement-cycle information.
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.
short_margin_rate: Optional[str]
The percent of a short position’s value you must post as margin 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_short_prohibited: bool
Indicates if short selling is prohibited for the instrument. This is a
standing property of the security. For the live Rule 201 circuit
breaker, see short_sale_restricted on the market-data snapshot.
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.
cax_adjusted_previous_close: Optional[str]
Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.
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 the cax-adjusted close when present, the raw previous close otherwise). When a null/undefined value is observed, it indicates that there is no available data.
Available options expiration dates for this instrument, each annotated
with which settlement cycles have listed contracts on it.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
has_settles_on_close: bool
Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.
has_settles_on_open: bool
Whether this date has at least one contract that settles on the opening print (AM settlement) and can still be traded. AM-settled contracts stop trading at the close of the business day before settlement, so this turns false before the expiration date arrives. A date leaves the list once no contract on it can be traded in either settlement cycle.
Deprecatedoptions_expiry_dates: Optional[List[date]]
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
Deprecated: use options_contract_expiry_dates, which carries the same
dates annotated with settlement-cycle information.
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.
short_margin_rate: Optional[str]
The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.