V1
ModelsExpand Collapse
APIDecimal64 = string
A decimal number represented as a string.
SecurityIDSource = "CMS" | "CLST" | "OPRA" | 36 more
Security identifier source
SecurityType = "COMMON_STOCK" | "PREFERRED_STOCK" | "CORPORATE_BOND" | 5 more
Security type
V1Accounts
Fetch account details by ID
List accounts the authenticated user has permission to access
Update account risk settings
ModelsExpand Collapse
Account { id, account_holder_entity_id, full_name, 6 more }
Represents a trading account
id: number
The unique identifier for the account
account_holder_entity_id: number
The account holder entity identifier
full_name: string
The full legal name of the account
The type of account
open_date: string
The date the account was opened
short_name: string
The short name of the account
The current status of the account
The sub-type of account
close_date?: string | null
The date the account was closed, if applicable
AccountKind = "HOUSE" | "PAB" | "CUSTOMER" | 2 more
Account kind classification
id: number
The unique identifier for the account
account_holder_entity_id: number
The account holder entity identifier
full_name: string
The full legal name of the account
The type of account
open_date: string
The date the account was opened
short_name: string
The short name of the account
The current status of the account
The sub-type of account
close_date?: string | null
The date the account was closed, if applicable
AccountSettings { risk }
Risk settings for the account
max_notional?: string | null
The maximum notional value available to the account
AccountStatus = "ACTIVE" | "INACTIVE" | "CLOSED"
Account status
AccountSubkind = "AFFILIATE" | "ALLOCATION" | "ARRANGING" | 26 more
Account sub-kind classification providing more granular categorization
RiskSettings { max_notional }
Risk settings for an account
max_notional?: string | null
The maximum notional value available to the account
V1AccountsBalances
Fetch account balance information
ModelsExpand Collapse
AccountBalances { account_id, buying_power, currency, 15 more }
Represents the balance details for a trading account
account_id: number
The unique identifier for the account
buying_power: string
The total buying power available in the account.
currency: string
Currency identifier for all monetary values.
daily_realized_pnl: string
Realized profit or loss since start of day.
daily_total_pnl: string
Total profit or loss since start of day.
daily_unrealized_pnl: string
Total unrealized profit or loss across all positions relative to prior close.
equity: string
The total equity in the account.
long_market_value: string
The total market value of all long positions.
The applicable margin model for the account
open_order_adjustment: string
Signed buying-power correction from open orders.
settled_cash: string
The amount of cash that is settled and available for withdrawal or trading.
Start-of-day snapshot balances.
buying_power: string
Start-of-day buying power.
equity: string
Start-of-day equity.
long_market_value: string
Start-of-day long market value.
short_market_value: string
Start-of-day short market value.
asof?: string | null
Timestamp for the start-of-day values.
day_trade_buying_power?: string | null
Start-of-day day-trade buying power.
maintenance_margin_excess?: string | null
Start-of-day maintenance margin excess.
maintenance_margin_requirement?: string | null
Start-of-day maintenance margin requirement.
trade_cash?: string | null
Start-of-day trade cash.
trade_cash: string
Trade-date effective cash.
unsettled_credits: string
Trade-date unsettled cash credits.
unsettled_debits: string
Trade-date unsettled cash debits.
margin_details?: MarginDetails { day_trade_count, initial_margin_excess, initial_margin_requirement, 6 more } | null
Margin-account-only details.
day_trade_count: number
The number of day trades executed over the 5 most recent trading days.
initial_margin_excess: string
Initial margin excess for trade-date balances.
initial_margin_requirement: string
Initial margin requirement for trade-date balances.
maintenance_margin_excess: string
Maintenance margin excess for trade-date balances.
maintenance_margin_requirement: string
Maintenance margin requirement for trade-date balances.
pattern_day_trader: boolean
true if the account is currently flagged as a PDT, otherwise false.
day_trade_buying_power_usage?: string | null
The amount of day-trade buying power used during the current trading day.
top_contributors?: Array<MarginTopContributor { initial_margin_requirement, maintenance_margin_requirement, market_value, underlying_instrument_id } >
Optional top margin contributors, returned only when explicitly requested.
initial_margin_requirement: string
Initial margin requirement attributable to this underlying.
maintenance_margin_requirement: string
Maintenance margin requirement attributable to this underlying.
market_value: string
Net market value attributable to this underlying.
underlying_instrument_id: string
UUID of the underlying security contributing to margin requirement.
Current usage totals.
total: string
The total margin available in the current model.
used: string
The amount of margin that is currently being utilized.
multiplier?: string | null
Applied multiplier for margin calculations.
short_market_value?: string | null
The total market value of all short positions.
AccountBalancesSod { buying_power, equity, long_market_value, 6 more }
buying_power: string
Start-of-day buying power.
equity: string
Start-of-day equity.
long_market_value: string
Start-of-day long market value.
short_market_value: string
Start-of-day short market value.
asof?: string | null
Timestamp for the start-of-day values.
day_trade_buying_power?: string | null
Start-of-day day-trade buying power.
maintenance_margin_excess?: string | null
Start-of-day maintenance margin excess.
maintenance_margin_requirement?: string | null
Start-of-day maintenance margin requirement.
trade_cash?: string | null
Start-of-day trade cash.
MarginDetails { day_trade_count, initial_margin_excess, initial_margin_requirement, 6 more }
day_trade_count: number
The number of day trades executed over the 5 most recent trading days.
initial_margin_excess: string
Initial margin excess for trade-date balances.
initial_margin_requirement: string
Initial margin requirement for trade-date balances.
maintenance_margin_excess: string
Maintenance margin excess for trade-date balances.
maintenance_margin_requirement: string
Maintenance margin requirement for trade-date balances.
pattern_day_trader: boolean
true if the account is currently flagged as a PDT, otherwise false.
day_trade_buying_power_usage?: string | null
The amount of day-trade buying power used during the current trading day.
top_contributors?: Array<MarginTopContributor { initial_margin_requirement, maintenance_margin_requirement, market_value, underlying_instrument_id } >
Optional top margin contributors, returned only when explicitly requested.
initial_margin_requirement: string
Initial margin requirement attributable to this underlying.
maintenance_margin_requirement: string
Maintenance margin requirement attributable to this underlying.
market_value: string
Net market value attributable to this underlying.
underlying_instrument_id: string
UUID of the underlying security contributing to margin requirement.
Current usage totals.
total: string
The total margin available in the current model.
used: string
The amount of margin that is currently being utilized.
MarginDetailsUsage { total, used }
total: string
The total margin available in the current model.
used: string
The amount of margin that is currently being utilized.
MarginTopContributor { initial_margin_requirement, maintenance_margin_requirement, market_value, underlying_instrument_id }
initial_margin_requirement: string
Initial margin requirement attributable to this underlying.
maintenance_margin_requirement: string
Maintenance margin requirement attributable to this underlying.
market_value: string
Net market value attributable to this underlying.
underlying_instrument_id: string
UUID of the underlying security contributing to margin requirement.
MarginType = "OTHER" | "NONE" | "PORTFOLIO_MARGIN" | 6 more
An account's margin type
V1AccountsLocates
Create a locate request.
Get locate requests.
Update a locate request.
ModelsExpand Collapse
LocateOrder { locate_order_id, located_quantity, mpid, 12 more }
Represents a single locate order and its status
locate_order_id: string
The unique system-generated ID for the locate order
located_quantity: number
The quantity of shares that have been located
mpid: string
The client Market Participant Identifier, assigned by Clear Street
requested_at: string
The timestamp when the locate order was received from the client in UTC
requested_quantity: number
The quantity of shares requested by the client
The status of the locate order
symbol: string
The symbol of the security to locate
borrow_rate?: string | null
The borrow rate for the security if held overnight, expressed as a decimal
desk_comment?: string | null
Comments provided by the trading desk
expires_at?: string | null
The timestamp when the locate order will expire, set once the order has been processed, in UTC
locate_id?: string | null
A unique ID for the locate order, available after the order has been OFFERED
located_at?: string | null
The timestamp when the security was located in UTC
reference_id?: string | null
The reference ID provided when submitting the locate order
total_cost?: string | null
The total cost of the locate
trader_comment?: string | null
Comments provided by the trader when submitting the locate order
locate_order_id: string
The unique system-generated ID for the locate order
located_quantity: number
The quantity of shares that have been located
mpid: string
The client Market Participant Identifier, assigned by Clear Street
requested_at: string
The timestamp when the locate order was received from the client in UTC
requested_quantity: number
The quantity of shares requested by the client
The status of the locate order
symbol: string
The symbol of the security to locate
borrow_rate?: string | null
The borrow rate for the security if held overnight, expressed as a decimal
desk_comment?: string | null
Comments provided by the trading desk
expires_at?: string | null
The timestamp when the locate order will expire, set once the order has been processed, in UTC
locate_id?: string | null
A unique ID for the locate order, available after the order has been OFFERED
located_at?: string | null
The timestamp when the security was located in UTC
reference_id?: string | null
The reference ID provided when submitting the locate order
total_cost?: string | null
The total cost of the locate
trader_comment?: string | null
Comments provided by the trader when submitting the locate order
LocateOrderStatus = "PENDING" | "OFFERED" | "FILLED" | 4 more
The status of a locate order
V1AccountsLocatesInventory
Get locate inventory.
ModelsExpand Collapse
LocateInventoryItem { account_id, available, reserved, 2 more }
Represents the available locate inventory for a symbol
account_id: number
The account the locate inventory belongs to
available: number
The available quantity of shares that can be located to borrow
reserved: number
The quantity of shares reserved for locate orders that have been OFFERED but not yet FILLED
symbol: string
The symbol of the security
used: number
The quantity of shares that have been FILLED and are currently borrowed
account_id: number
The account the locate inventory belongs to
available: number
The available quantity of shares that can be located to borrow
reserved: number
The quantity of shares reserved for locate orders that have been OFFERED but not yet FILLED
symbol: string
The symbol of the security
used: number
The quantity of shares that have been FILLED and are currently borrowed
V1AccountsOrders
Cancel all orders for an account
Cancel a specific order
Get order by ID
List orders for an account with optional filtering
Replace an order with new parameters
Submit new orders
ModelsExpand Collapse
Arrival Price strategy
Maximum percentage of market volume to participate in (0-100)
Minimum percentage of market volume to participate in (0-100)
BaseStrategyParams { end_at, start_at, urgency }
Base parameters common to most algorithmic strategies
end_at?: string | null
UTC timestamp to end execution (defaults to market close)
start_at?: string | null
UTC timestamp to start execution (defaults to order placement time)
Urgency level for execution aggressiveness
Dark Pool strategy
Maximum percentage of market volume to participate in (0-100)
DmaStrategy { destination }
Direct Market Access strategy
destination: string
Destination exchange (MIC code)
Order { id, account_id, created_at, 24 more }
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.
id: string
Client-provided unique identifier for this order
account_id: number
Account placing the order
created_at: string
Timestamp when order was created (UTC)
filled_quantity: string
Cumulative filled quantity
leaves_quantity: string
Remaining unfilled quantity
Type of order (MARKET, LIMIT, etc.)
quantity: string
Total order quantity
security_id: string
The identifier for the traded instrument (CMS/CUSIP/ISIN/FIGI for equities or option OPRA OSI)
The source of the security identifier
Type of security
Side of the order (BUY, SELL, SELL_SHORT)
Current status of the order
symbol: string
Trading symbol
Time in force instruction
updated_at: string
Timestamp of the most recent update (UTC)
venue: string
MIC code of the venue where the order is routed
average_fill_price?: string | null
Average fill price across all executions
details?: Array<string>
Contains execution, rejection or cancellation details, if any
expires_at?: string | null
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.
limit_offset?: string | null
Limit offset for trailing stop-limit orders (signed)
limit_price?: string | null
Limit price (for LIMIT and STOP_LIMIT orders)
stop_price?: string | null
Stop price (for STOP and STOP_LIMIT orders)
Execution strategy for this order
Smart Order Router (default) - routes to best available venue
type: "SOR"
Volume Weighted Average Price - matches VWAP over a period
type: "VWAP"
Time Weighted Average Price - spreads execution evenly over time
type: "TWAP"
Arrival Price - aims to match price at order placement time
type: "AP"
Percentage of Volume - participates as a percentage of market volume
type: "POV"
Dark Pool - routes to dark pool venues
type: "DARK"
Direct Market Access - sends directly to a specified exchange
type: "DMA"
trailing_offset_amt?: string | null
Trailing offset amount for trailing orders
Trailing offset type for trailing orders
trailing_watermark_px?: string | null
Trailing watermark price for trailing orders
trailing_watermark_ts?: string | null
Trailing watermark timestamp for trailing orders
id: string
Client-provided unique identifier for this order
account_id: number
Account placing the order
created_at: string
Timestamp when order was created (UTC)
filled_quantity: string
Cumulative filled quantity
leaves_quantity: string
Remaining unfilled quantity
Type of order (MARKET, LIMIT, etc.)
quantity: string
Total order quantity
security_id: string
The identifier for the traded instrument (CMS/CUSIP/ISIN/FIGI for equities or option OPRA OSI)
The source of the security identifier
Type of security
Side of the order (BUY, SELL, SELL_SHORT)
Current status of the order
symbol: string
Trading symbol
Time in force instruction
updated_at: string
Timestamp of the most recent update (UTC)
venue: string
MIC code of the venue where the order is routed
average_fill_price?: string | null
Average fill price across all executions
details?: Array<string>
Contains execution, rejection or cancellation details, if any
expires_at?: string | null
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.
limit_offset?: string | null
Limit offset for trailing stop-limit orders (signed)
limit_price?: string | null
Limit price (for LIMIT and STOP_LIMIT orders)
stop_price?: string | null
Stop price (for STOP and STOP_LIMIT orders)
Execution strategy for this order
Smart Order Router (default) - routes to best available venue
type: "SOR"
Volume Weighted Average Price - matches VWAP over a period
type: "VWAP"
Time Weighted Average Price - spreads execution evenly over time
type: "TWAP"
Arrival Price - aims to match price at order placement time
type: "AP"
Percentage of Volume - participates as a percentage of market volume
type: "POV"
Dark Pool - routes to dark pool venues
type: "DARK"
Direct Market Access - sends directly to a specified exchange
type: "DMA"
trailing_offset_amt?: string | null
Trailing offset amount for trailing orders
Trailing offset type for trailing orders
trailing_watermark_px?: string | null
Trailing watermark price for trailing orders
trailing_watermark_ts?: string | null
Trailing watermark timestamp for trailing orders
OrderStatus = "PENDING_NEW" | "NEW" | "PARTIALLY_FILLED" | 12 more
Order status
OrderStrategy = Sor { type } | Vwap { type } | Twap { type } | 4 more
Execution strategy for an order
Defines advanced routing and execution logic beyond simple order types. The strategy type determines which parameters are available and required.
Smart Order Router (default) - routes to best available venue
type: "SOR"
Volume Weighted Average Price - matches VWAP over a period
type: "VWAP"
Time Weighted Average Price - spreads execution evenly over time
type: "TWAP"
Arrival Price - aims to match price at order placement time
type: "AP"
Percentage of Volume - participates as a percentage of market volume
type: "POV"
Dark Pool - routes to dark pool venues
type: "DARK"
Direct Market Access - sends directly to a specified exchange
type: "DMA"
OrderType = "MARKET" | "LIMIT" | "STOP" | 4 more
Order type
Percentage of Volume strategy
Target percentage of market volume to participate in (0-100)
Side = "BUY" | "SELL" | "SELL_SHORT" | "OTHER"
Side of an order
SorStrategy { end_at, start_at, urgency }
Base parameters common to most algorithmic strategies
end_at?: string | null
UTC timestamp to end execution (defaults to market close)
start_at?: string | null
UTC timestamp to start execution (defaults to order placement time)
Urgency level for execution aggressiveness
TimeInForce = "DAY" | "GOOD_TILL_CANCEL" | "IMMEDIATE_OR_CANCEL" | 8 more
Time in force
TrailingOffsetType = "PRICE" | "PERCENT_BPS"
Trailing offset type for trailing stop orders.
Time Weighted Average Price strategy
Maximum percentage of market volume to participate in (0-50)
Minimum percentage of market volume to participate in (0-100)
Urgency = "SUPER_PASSIVE" | "PASSIVE" | "MODERATE" | 2 more
Urgency level for algorithmic execution
Volume Weighted Average Price strategy
Maximum percentage of market volume to participate in (0-50)
Minimum percentage of market volume to participate in (0-100)
V1AccountsPortfolio History
Get account portfolio history.
ModelsExpand Collapse
PortfolioHistoryResponse { segments }
date: string
The date for this segment
ending_equity: string
The equity at the end of the trading day.
realized_pnl: string
Sum of the profit and loss realized from position closing trading activity.
starting_equity: string
The equity at the start of the trading day.
unrealized_pnl: string
Sum of the profit and loss from market changes.
bought_notional?: string | null
Amount bought MTM
bought_quantity?: string | null
Quantity bought MTM
day_pnl?: string | null
Sum of the profit and loss from intraday trading activities for the trading day.
net_pnl?: string | null
P&L after netting all realized and unrealized P&L, adjustments, dividends, change in accruals, income and expenses
position_pnl?: string | null
Sum of the profit and loss from the previous trading day.
sold_notional?: string | null
Amount sold MTM
sold_quantity?: string | null
Quantity sold MTM
PortfolioHistorySegment { date, ending_equity, realized_pnl, 9 more }
date: string
The date for this segment
ending_equity: string
The equity at the end of the trading day.
realized_pnl: string
Sum of the profit and loss realized from position closing trading activity.
starting_equity: string
The equity at the start of the trading day.
unrealized_pnl: string
Sum of the profit and loss from market changes.
bought_notional?: string | null
Amount bought MTM
bought_quantity?: string | null
Quantity bought MTM
day_pnl?: string | null
Sum of the profit and loss from intraday trading activities for the trading day.
net_pnl?: string | null
P&L after netting all realized and unrealized P&L, adjustments, dividends, change in accruals, income and expenses
position_pnl?: string | null
Sum of the profit and loss from the previous trading day.
sold_notional?: string | null
Amount sold MTM
sold_quantity?: string | null
Quantity sold MTM
V1AccountsPositions
Delete a position within an account for an instrument.
Delete all positions within an account.
Get account positions.
ModelsExpand Collapse
Position { account_id, available_quantity, instrument_type, 14 more }
Represents a holding of a particular instrument in an account
account_id: number
The account this position belongs to
available_quantity: string
The quantity of a position that is free to be operated on.
Type of security
market_value: string
The current market value of the position
The type of position
quantity: string
The number of shares or contracts. Can be positive (long) or negative (short)
security_id: string
An identifier for the instrument which, when paired with security_id_source,
identifies one or more financial instruments.
The source of the security identifier
symbol: string
The trading symbol for the instrument
avg_price?: string | null
The average price paid per share or contract for this position
closing_price?: string | null
The closing price used to value the position for the last trading day
cost_basis?: string | null
The total cost basis for this position
daily_unrealized_pnl?: string | null
The unrealized profit or loss for this position relative to the previous close
daily_unrealized_pnl_pct?: string | null
The unrealized profit/loss for the position for the current day, expressed as a percentage of the baseline value (range: 0-100).
market_price?: string | null
The current market price of the instrument
unrealized_pnl?: string | null
The total unrealized profit or loss for this position based on current market value
unrealized_pnl_pct?: string | null
The unrealized profit/loss for the position, expressed as a percentage of the position's cost basis (range: 0-100).
account_id: number
The account this position belongs to
available_quantity: string
The quantity of a position that is free to be operated on.
Type of security
market_value: string
The current market value of the position
The type of position
quantity: string
The number of shares or contracts. Can be positive (long) or negative (short)
security_id: string
An identifier for the instrument which, when paired with security_id_source,
identifies one or more financial instruments.
The source of the security identifier
symbol: string
The trading symbol for the instrument
avg_price?: string | null
The average price paid per share or contract for this position
closing_price?: string | null
The closing price used to value the position for the last trading day
cost_basis?: string | null
The total cost basis for this position
daily_unrealized_pnl?: string | null
The unrealized profit or loss for this position relative to the previous close
daily_unrealized_pnl_pct?: string | null
The unrealized profit/loss for the position for the current day, expressed as a percentage of the baseline value (range: 0-100).
market_price?: string | null
The current market price of the instrument
unrealized_pnl?: string | null
The total unrealized profit or loss for this position based on current market value
unrealized_pnl_pct?: string | null
The unrealized profit/loss for the position, expressed as a percentage of the position's cost basis (range: 0-100).
PositionType = "LONG" | "SHORT" | "LONG_CALL" | 3 more
Position type classification
V1API Keys
Create a new API key
List API keys for the authenticated user
Revoke a specific API key
Revoke all API keys for the authenticated user
ModelsExpand Collapse
APIKey { id, api_key, created_at, 2 more }
APIKeyListEntry { id, created_at, expires_at, 2 more }
Revocation { id, revoked_at }
V1Calendars
V1CalendarsDividends
Get dividends calendar.
ModelsExpand Collapse
DividendCalendarEvent { adjusted_dividend, date, dividend, 6 more }
Represents a single dividend event
adjusted_dividend: string
The dividend amount adjusted for any stock splits
date: string
The ex-dividend date
dividend: string
The dividend amount per share
symbol: string
The symbol for the instrument
declaration_date?: string | null
The date the dividend was declared
The frequency of the dividend payment
payment_date?: string | null
The payment date for the dividend
record_date?: string | null
The record date for the dividend
yield?: string | null
The dividend yield as a percentage decimal
DividendCalendarEventList = Array<DividendCalendarEvent { adjusted_dividend, date, dividend, 6 more } >
adjusted_dividend: string
The dividend amount adjusted for any stock splits
date: string
The ex-dividend date
dividend: string
The dividend amount per share
symbol: string
The symbol for the instrument
declaration_date?: string | null
The date the dividend was declared
The frequency of the dividend payment
payment_date?: string | null
The payment date for the dividend
record_date?: string | null
The record date for the dividend
yield?: string | null
The dividend yield as a percentage decimal
DividendFrequency = "ANNUALLY" | "SEMI_ANNUALLY" | "QUARTERLY" | 2 more
Dividend payment frequency
V1CalendarsEarnings
Get earnings calendar.
ModelsExpand Collapse
EarningsCalendarEvent { date, last_updated, symbol, 4 more }
Represents a single earnings announcement event
date: string
The date of the earnings announcement
last_updated: string
The date of the last update to this event
symbol: string
The symbol for the instrument
eps_actual?: string | null
The actual reported earnings per share
eps_estimated?: string | null
The consensus estimated earnings per share
revenue_actual?: string | null
The actual reported revenue
revenue_estimated?: string | null
The consensus estimated revenue
date: string
The date of the earnings announcement
last_updated: string
The date of the last update to this event
symbol: string
The symbol for the instrument
eps_actual?: string | null
The actual reported earnings per share
eps_estimated?: string | null
The consensus estimated earnings per share
revenue_actual?: string | null
The actual reported revenue
revenue_estimated?: string | null
The consensus estimated revenue
V1CalendarsEconomic
Get economic calendar.
ModelsExpand Collapse
EconomicCalendarEvent { country, currency, event_name, 6 more }
Represents a single economic calendar event
country: string
The ISO 3166-1 alpha-2 country code
currency: string
The ISO 4217 currency code
event_name: string
The name of the economic event
event_timestamp: string
The date and time of the event in UTC
The expected market impact of the event
actual_value?: string | null
The actual value reported for the event
change_percent?: string | null
The percentage change between the actual and previous values
estimated_value?: string | null
The market consensus estimate for the event's value
previous_value?: string | null
The previous value for this event
country: string
The ISO 3166-1 alpha-2 country code
currency: string
The ISO 4217 currency code
event_name: string
The name of the economic event
event_timestamp: string
The date and time of the event in UTC
The expected market impact of the event
actual_value?: string | null
The actual value reported for the event
change_percent?: string | null
The percentage change between the actual and previous values
estimated_value?: string | null
The market consensus estimate for the event's value
previous_value?: string | null
The previous value for this event
EconomicEventImpact = "LOW" | "MEDIUM" | "HIGH"
Economic event impact level
V1CalendarsMarket Hours
Get market hours calendar.
ModelsExpand Collapse
DayType = "TRADING_DAY" | "EARLY_CLOSE" | "HOLIDAY" | "WEEKEND"
Day type for market hours - indicates the type of trading day
MarketHoursDetail { current_time, date, market, 5 more }
Comprehensive market hours information for a specific market and date
current_time: string
Current time in market timezone with offset
date: string
The date for which market hours are provided
Market type identifier
market_name: string
Human-readable market name
Next trading day's session schedules (without time_until fields)
After-hours session schedule, null if not available
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
Pre-market session schedule, null if not available
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
Regular trading session schedule, null if holiday/weekend
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
Market status information
The type of trading day
is_open: boolean
Whether the market is currently open (real-time)
Current session type if market is open, null if closed
timezone: string
IANA timezone identifier for the market
Trading session schedules for the requested date with time_until fields
After-hours session schedule, null if not available
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
Pre-market session schedule, null if not available
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
Regular trading session schedule, null if holiday/weekend
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
current_time: string
Current time in market timezone with offset
date: string
The date for which market hours are provided
Market type identifier
market_name: string
Human-readable market name
Next trading day's session schedules (without time_until fields)
After-hours session schedule, null if not available
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
Pre-market session schedule, null if not available
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
Regular trading session schedule, null if holiday/weekend
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
Market status information
The type of trading day
is_open: boolean
Whether the market is currently open (real-time)
Current session type if market is open, null if closed
timezone: string
IANA timezone identifier for the market
Trading session schedules for the requested date with time_until fields
After-hours session schedule, null if not available
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
Pre-market session schedule, null if not available
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
Regular trading session schedule, null if holiday/weekend
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
MarketSessionType = "pre_market" | "regular" | "after_hours"
Session type for market hours
MarketStatus { day_type, is_open, current_session }
Market status information
The type of trading day
is_open: boolean
Whether the market is currently open (real-time)
Current session type if market is open, null if closed
MarketType = "us_equities" | "us_options"
Market type for market hours calendar endpoint
SessionSchedule { close, open, time_until_close, time_until_open }
Session schedule with open and close timestamps
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
TradingSessions { after_hours, pre_market, regular }
Trading sessions for a market day with full timestamps
After-hours session schedule, null if not available
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
Pre-market session schedule, null if not available
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
Regular trading session schedule, null if holiday/weekend
close: string
Session close timestamp with timezone offset
open: string
Session open timestamp with timezone offset
time_until_close?: string | null
ISO 8601 duration until session closes. Null if session is not currently open.
time_until_open?: string | null
ISO 8601 duration until session opens. Null if session has already started or closed.
V1CalendarsMergers Acquisitions
Get mergers and acquisitions calendar.
ModelsExpand Collapse
MergersAcquisitionsEvent { acquirer_symbol, target_symbol, transaction_date, 5 more }
Represents a merger or acquisition event
acquirer_symbol: string
The symbol of the acquiring company
target_symbol: string
The symbol of the target company being acquired
transaction_date: string
The date of the transaction
accepted_at?: string | null
The timestamp when the merger or acquisition was accepted in UTC
acquirer_cik?: string | null
The CIK of the acquiring company
acquirer_name?: string | null
The name of the acquiring company
link?: string | null
A URL link to more details about the merger or acquisition
target_cik?: string | null
The CIK of the target company
MergersAcquisitionsEventList = Array<MergersAcquisitionsEvent { acquirer_symbol, target_symbol, transaction_date, 5 more } >
acquirer_symbol: string
The symbol of the acquiring company
target_symbol: string
The symbol of the target company being acquired
transaction_date: string
The date of the transaction
accepted_at?: string | null
The timestamp when the merger or acquisition was accepted in UTC
acquirer_cik?: string | null
The CIK of the acquiring company
acquirer_name?: string | null
The name of the acquiring company
link?: string | null
A URL link to more details about the merger or acquisition
target_cik?: string | null
The CIK of the target company
V1CalendarsSplits
Get stock splits calendar.
ModelsExpand Collapse
StockSplitEvent { date, denominator, numerator, symbol }
Represents a stock split event
date: string
The date the split will occur
denominator: number
The pre-split number of shares
numerator: number
The post-split number of shares for every 'denominator' pre-split shares
symbol: string
The symbol for the instrument
date: string
The date the split will occur
denominator: number
The pre-split number of shares
numerator: number
The post-split number of shares for every 'denominator' pre-split shares
symbol: string
The symbol for the instrument
V1CalendarsSummary
Get calendar summary.
ModelsExpand Collapse
CalendarDateSummary { date, dividends_count, earnings_count, 3 more }
Summary of events for a specific date
date: string
The date of the events
dividends_count: number
The number of dividend events on this date
earnings_count: number
The number of earnings announcements on this date
economic_events_count: number
The number of economic events on this date
mergers_acquisitions_count: number
The number of mergers and acquisitions on this date
stock_splits_count: number
The number of stock split events on this date
CalendarDateSummaryList = Array<CalendarDateSummary { date, dividends_count, earnings_count, 3 more } >
date: string
The date of the events
dividends_count: number
The number of dividend events on this date
earnings_count: number
The number of earnings announcements on this date
economic_events_count: number
The number of economic events on this date
mergers_acquisitions_count: number
The number of mergers and acquisitions on this date
stock_splits_count: number
The number of stock split events on this date
V1Instruments
Get instrument by ID.
List instruments.
ModelsExpand Collapse
AnalystRating = "STRONG_BUY" | "BUY" | "HOLD" | 2 more
Analyst rating category
Instrument extends InstrumentCore { id, country_of_issue, currency, 17 more } { available_to_borrow, average_volume, beta, 16 more }
Represents a tradable financial instrument, including supplemental information
available_to_borrow?: number | null
The number of shares currently available to borrow
average_volume?: number | null
The average daily trading volume over the past 30 days
beta?: string | null
The beta value, measuring the instrument's volatility relative to the overall market
borrow_fee?: string | null
The fee associated with borrowing the instrument, expressed as a decimal
description?: string | null
A detailed description of the instrument or company
dividend_yield?: string | null
The trailing twelve months (TTM) dividend yield
earnings_per_share?: string | null
The trailing twelve months (TTM) earnings per share
fifty_two_week_high?: string | null
The highest price over the last 52 weeks
fifty_two_week_low?: string | null
The lowest price over the last 52 weeks
industry?: string | null
The specific industry of the instrument's issuer
list_date?: string | null
The date the instrument was first listed
logo_url?: string | null
URL to a representative logo image for the instrument or issuer
long_concentration_limit?: string | null
A cap on how much of your equity you can put into a single symbol on the long side
market_cap?: string | null
The total market capitalization
previous_close?: string | null
The closing price from the previous trading day
price_to_earnings?: string | null
The price-to-earnings (P/E) ratio for the trailing twelve months (TTM)
Real-time market quote data for the instrument
high: string
The highest trade price during the current trading day
last_price: string
The most recent trade price
low: string
The lowest trade price during the current trading day
open: string
The opening price for the current trading day
volume: number
The total number of shares traded during the current trading day
sector?: string | null
The business sector of the instrument's issuer
short_concentration_limit?: string | null
A cap on how much of your equity you can allocate to a single symbol on the short side
InstrumentCore { id, country_of_issue, currency, 17 more }
id: string
Unique instrument identifier
country_of_issue: string
The ISO country code of the instrument's issue
currency: string
The ISO currency code in which the instrument is traded
easy_to_borrow: boolean
Indicates if the instrument is classified as Easy-To-Borrow
is_liquidation_only: boolean
Indicates if the instrument is liquidation only and cannot be bought
is_marginable: boolean
Indicates if the instrument is marginable
is_restricted: boolean
Indicates if the instrument is restricted from trading
is_short_prohibited: boolean
Indicates if short selling is prohibited for the instrument
is_threshold_security: boolean
Indicates if the instrument is on the Regulation SHO Threshold Security List
Deprecatedsecurity_id: string
Deprecated. Use security_ids.
A primary security identifier for this instrument.
Deprecated. Use security_ids.
The source for security_id.
All known security identifiers for this instrument
security_id: string
The identifier for the instrument
The source system for the security identifier
symbol: string
The trading symbol for the instrument
venue: string
The MIC code of the primary listing venue
expiry?: string | null
The expiration date for options instruments
long_margin_rate?: string | null
The percent of a long position's value you must post as margin
name?: string | null
The full name of the instrument or its issuer
The type of security (e.g., Common Stock, ETF)
short_margin_rate?: string | null
The percent of a short position's value you must post as margin
strike_price?: string | null
The strike price for options instruments
id: string
Unique instrument identifier
country_of_issue: string
The ISO country code of the instrument's issue
currency: string
The ISO currency code in which the instrument is traded
easy_to_borrow: boolean
Indicates if the instrument is classified as Easy-To-Borrow
is_liquidation_only: boolean
Indicates if the instrument is liquidation only and cannot be bought
is_marginable: boolean
Indicates if the instrument is marginable
is_restricted: boolean
Indicates if the instrument is restricted from trading
is_short_prohibited: boolean
Indicates if short selling is prohibited for the instrument
is_threshold_security: boolean
Indicates if the instrument is on the Regulation SHO Threshold Security List
Deprecatedsecurity_id: string
Deprecated. Use security_ids.
A primary security identifier for this instrument.
Deprecated. Use security_ids.
The source for security_id.
All known security identifiers for this instrument
security_id: string
The identifier for the instrument
The source system for the security identifier
symbol: string
The trading symbol for the instrument
venue: string
The MIC code of the primary listing venue
expiry?: string | null
The expiration date for options instruments
long_margin_rate?: string | null
The percent of a long position's value you must post as margin
name?: string | null
The full name of the instrument or its issuer
The type of security (e.g., Common Stock, ETF)
short_margin_rate?: string | null
The percent of a short position's value you must post as margin
strike_price?: string | null
The strike price for options instruments
InstrumentEarnings { date, eps_actual, eps_estimate, 4 more }
Represents instrument earnings data
date: string
The date when the earnings report was published
eps_actual?: string | null
The actual earnings per share (EPS) for the period
eps_estimate?: string | null
The estimated earnings per share (EPS) for the period
eps_surprise_percent?: string | null
The percentage difference between actual and estimated EPS
revenue_actual?: string | null
The actual total revenue for the period
revenue_estimate?: string | null
The estimated total revenue for the period
revenue_surprise_percent?: string | null
The percentage difference between actual and estimated revenue
InstrumentQuote { high, last_price, low, 2 more }
Real-time market quote data for a specific instrument
high: string
The highest trade price during the current trading day
last_price: string
The most recent trade price
low: string
The lowest trade price during the current trading day
open: string
The opening price for the current trading day
volume: number
The total number of shares traded during the current trading day
InstrumentSecurityID { security_id, security_id_source }
Represents a tradable financial instrument, as a more concise item listing only key fields.
security_id: string
The identifier for the instrument
The source system for the security identifier
V1InstrumentsAnalyst Reporting
Get analyst consensus.
ModelsExpand Collapse
AnalystDistribution { buy, hold, sell, 2 more }
Analyst recommendation distribution
buy: number
Number of buy recommendations
hold: number
Number of hold recommendations
sell: number
Number of sell recommendations
strong_buy: number
Number of strong buy recommendations
strong_sell: number
Number of strong sell recommendations
InstrumentAnalystConsensus { date, distribution, price_target, rating }
Aggregated analyst consensus metrics
date: string
The date the consensus snapshot was generated
Count of individual analyst recommendations by category
buy: number
Number of buy recommendations
hold: number
Number of hold recommendations
sell: number
Number of sell recommendations
strong_buy: number
Number of strong buy recommendations
strong_sell: number
Number of strong sell recommendations
Aggregated analyst price target statistics
average: string
Average analyst price target
currency: string
ISO 4217 currency code of the price targets
high: string
Highest analyst price target
low: string
Lowest analyst price target
Consensus analyst rating
PriceTarget { average, currency, high, low }
Analyst price target statistics
average: string
Average analyst price target
currency: string
ISO 4217 currency code of the price targets
high: string
Highest analyst price target
low: string
Lowest analyst price target
V1InstrumentsEvents
List instrument events across all securities.
Get instrument events.
ModelsExpand Collapse
AllEventsEventType = "EARNINGS" | "DIVIDEND" | "STOCK_SPLIT" | "IPO"
Event types supported by the all-events endpoint.
InstrumentAllEventsData { event_dates }
All-events payload grouped by date.
Events grouped by date in descending order.
date: string
Event date.
Flat event envelopes for this date.
security_id: string
Security identifier for the event.
Security identifier source for the event.
symbol: string
Symbol associated with the event.
Event type discriminator.
dividend_event_data?: InstrumentDividendEvent { adjusted_dividend_amount, ex_date, declaration_date, 5 more } | null
Dividend payload when type is DIVIDEND.
adjusted_dividend_amount: string
The adjusted dividend amount accounting for any splits.
ex_date: string
The day the stock starts trading without the right to receive that dividend.
declaration_date?: string | null
The declaration date of the dividend
dividend_amount?: string | null
The dividend amount per share.
dividend_yield?: string | null
The dividend yield as a percentage of the stock price.
frequency?: string | null
The frequency of the dividend payments (e.g., "Quarterly", "Annual").
payment_date?: string | null
The payment date is the date on which a declared stock dividend is scheduled to be paid.
record_date?: string | null
The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend.
Earnings payload when type is EARNINGS.
date: string
The date when the earnings report was published
eps_actual?: string | null
The actual earnings per share (EPS) for the period
eps_estimate?: string | null
The estimated earnings per share (EPS) for the period
eps_surprise_percent?: string | null
The percentage difference between actual and estimated EPS
revenue_actual?: string | null
The actual total revenue for the period
revenue_estimate?: string | null
The estimated total revenue for the period
revenue_surprise_percent?: string | null
The percentage difference between actual and estimated revenue
instrument_id?: string | null
OEMS instrument identifier, when the instrument is found in the instrument cache.
IPO payload when type is IPO.
actions?: string | null
IPO action.
announced_at?: string | null
IPO announced timestamp.
company?: string | null
IPO company name.
exchange?: string | null
IPO exchange.
market_cap?: string | null
IPO market cap.
price_range?: string | null
IPO price range.
shares?: string | null
IPO shares offered.
name?: string | null
Instrument name associated with the event, when available.
Stock split payload when type is STOCK_SPLIT.
date: string
The date of the stock split
denominator: string
The denominator of the split ratio
numerator: string
The numerator of the split ratio
split_type: string
The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue")
InstrumentDividendEvent { adjusted_dividend_amount, ex_date, declaration_date, 5 more }
Represents a dividend event for an instrument
adjusted_dividend_amount: string
The adjusted dividend amount accounting for any splits.
ex_date: string
The day the stock starts trading without the right to receive that dividend.
declaration_date?: string | null
The declaration date of the dividend
dividend_amount?: string | null
The dividend amount per share.
dividend_yield?: string | null
The dividend yield as a percentage of the stock price.
frequency?: string | null
The frequency of the dividend payments (e.g., "Quarterly", "Annual").
payment_date?: string | null
The payment date is the date on which a declared stock dividend is scheduled to be paid.
record_date?: string | null
The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend.
InstrumentEventEnvelope { security_id, security_id_source, symbol, 7 more }
Unified envelope for the all-events response.
security_id: string
Security identifier for the event.
Security identifier source for the event.
symbol: string
Symbol associated with the event.
Event type discriminator.
dividend_event_data?: InstrumentDividendEvent { adjusted_dividend_amount, ex_date, declaration_date, 5 more } | null
Dividend payload when type is DIVIDEND.
adjusted_dividend_amount: string
The adjusted dividend amount accounting for any splits.
ex_date: string
The day the stock starts trading without the right to receive that dividend.
declaration_date?: string | null
The declaration date of the dividend
dividend_amount?: string | null
The dividend amount per share.
dividend_yield?: string | null
The dividend yield as a percentage of the stock price.
frequency?: string | null
The frequency of the dividend payments (e.g., "Quarterly", "Annual").
payment_date?: string | null
The payment date is the date on which a declared stock dividend is scheduled to be paid.
record_date?: string | null
The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend.
Earnings payload when type is EARNINGS.
date: string
The date when the earnings report was published
eps_actual?: string | null
The actual earnings per share (EPS) for the period
eps_estimate?: string | null
The estimated earnings per share (EPS) for the period
eps_surprise_percent?: string | null
The percentage difference between actual and estimated EPS
revenue_actual?: string | null
The actual total revenue for the period
revenue_estimate?: string | null
The estimated total revenue for the period
revenue_surprise_percent?: string | null
The percentage difference between actual and estimated revenue
instrument_id?: string | null
OEMS instrument identifier, when the instrument is found in the instrument cache.
IPO payload when type is IPO.
actions?: string | null
IPO action.
announced_at?: string | null
IPO announced timestamp.
company?: string | null
IPO company name.
exchange?: string | null
IPO exchange.
market_cap?: string | null
IPO market cap.
price_range?: string | null
IPO price range.
shares?: string | null
IPO shares offered.
name?: string | null
Instrument name associated with the event, when available.
Stock split payload when type is STOCK_SPLIT.
date: string
The date of the stock split
denominator: string
The denominator of the split ratio
numerator: string
The numerator of the split ratio
split_type: string
The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue")
InstrumentEventIpoItem { actions, announced_at, company, 4 more }
IPO event in the all-events date grouping response.
actions?: string | null
IPO action.
announced_at?: string | null
IPO announced timestamp.
company?: string | null
IPO company name.
exchange?: string | null
IPO exchange.
market_cap?: string | null
IPO market cap.
price_range?: string | null
IPO price range.
shares?: string | null
IPO shares offered.
InstrumentEventsByDate { date, events }
Instrument events for a single date.
date: string
Event date.
Flat event envelopes for this date.
security_id: string
Security identifier for the event.
Security identifier source for the event.
symbol: string
Symbol associated with the event.
Event type discriminator.
dividend_event_data?: InstrumentDividendEvent { adjusted_dividend_amount, ex_date, declaration_date, 5 more } | null
Dividend payload when type is DIVIDEND.
adjusted_dividend_amount: string
The adjusted dividend amount accounting for any splits.
ex_date: string
The day the stock starts trading without the right to receive that dividend.
declaration_date?: string | null
The declaration date of the dividend
dividend_amount?: string | null
The dividend amount per share.
dividend_yield?: string | null
The dividend yield as a percentage of the stock price.
frequency?: string | null
The frequency of the dividend payments (e.g., "Quarterly", "Annual").
payment_date?: string | null
The payment date is the date on which a declared stock dividend is scheduled to be paid.
record_date?: string | null
The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend.
Earnings payload when type is EARNINGS.
date: string
The date when the earnings report was published
eps_actual?: string | null
The actual earnings per share (EPS) for the period
eps_estimate?: string | null
The estimated earnings per share (EPS) for the period
eps_surprise_percent?: string | null
The percentage difference between actual and estimated EPS
revenue_actual?: string | null
The actual total revenue for the period
revenue_estimate?: string | null
The estimated total revenue for the period
revenue_surprise_percent?: string | null
The percentage difference between actual and estimated revenue
instrument_id?: string | null
OEMS instrument identifier, when the instrument is found in the instrument cache.
IPO payload when type is IPO.
actions?: string | null
IPO action.
announced_at?: string | null
IPO announced timestamp.
company?: string | null
IPO company name.
exchange?: string | null
IPO exchange.
market_cap?: string | null
IPO market cap.
price_range?: string | null
IPO price range.
shares?: string | null
IPO shares offered.
name?: string | null
Instrument name associated with the event, when available.
Stock split payload when type is STOCK_SPLIT.
date: string
The date of the stock split
denominator: string
The denominator of the split ratio
numerator: string
The numerator of the split ratio
split_type: string
The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue")
InstrumentEventsData { dividends, earnings, security_id, 2 more }
Grouped instrument events by type
dividends: Array<InstrumentDividendEvent { adjusted_dividend_amount, ex_date, declaration_date, 5 more } >
Dividend distribution events
adjusted_dividend_amount: string
The adjusted dividend amount accounting for any splits.
ex_date: string
The day the stock starts trading without the right to receive that dividend.
declaration_date?: string | null
The declaration date of the dividend
dividend_amount?: string | null
The dividend amount per share.
dividend_yield?: string | null
The dividend yield as a percentage of the stock price.
frequency?: string | null
The frequency of the dividend payments (e.g., "Quarterly", "Annual").
payment_date?: string | null
The payment date is the date on which a declared stock dividend is scheduled to be paid.
record_date?: string | null
The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend.
Earnings announcement events
date: string
The date when the earnings report was published
eps_actual?: string | null
The actual earnings per share (EPS) for the period
eps_estimate?: string | null
The estimated earnings per share (EPS) for the period
eps_surprise_percent?: string | null
The percentage difference between actual and estimated EPS
revenue_actual?: string | null
The actual total revenue for the period
revenue_estimate?: string | null
The estimated total revenue for the period
revenue_surprise_percent?: string | null
The percentage difference between actual and estimated revenue
security_id: string
The security ID from the request
The security ID source from the request
Stock split events
date: string
The date of the stock split
denominator: string
The denominator of the split ratio
numerator: string
The numerator of the split ratio
split_type: string
The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue")
InstrumentSplitEvent { date, denominator, numerator, split_type }
Represents a stock split event for an instrument
date: string
The date of the stock split
denominator: string
The denominator of the split ratio
numerator: string
The numerator of the split ratio
split_type: string
The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue")
V1InstrumentsReporting
Get instrument reporting data.
V1InstrumentsVenues
Get trading venues.
ModelsExpand Collapse
DisplayType = "LIT" | "DARK" | "PERIODIC_AUCTION" | "RFQ"
Display characteristics of a venue
GtdAccepts { date, timestamp }
Good-till-date order acceptance capabilities
date: boolean
Whether the venue accepts date-only expiration (YYYY-MM-DD)
timestamp: boolean
Whether the venue accepts precise timestamp expiration
Venue { country, display_type, gtd_accepts, 8 more }
A trading venue with its characteristics and capabilities
country: string
The ISO country code where the venue operates
The display characteristics of the venue
Indicates whether GOOD_TILL_DATE orders accept date-only or timestamp specifications
date: boolean
Whether the venue accepts date-only expiration (YYYY-MM-DD)
timestamp: boolean
Whether the venue accepts precise timestamp expiration
lot_size: number
The minimum quantity increment for orders at this venue
mic: string
The Market Identifier Code (MIC) for the venue
name: string
The display name of the venue
Trading sessions available at this venue
end_local: string
Session end time in venue's local timezone (HH:MM format, 24-hour)
name: string
The name of the trading session
start_local: string
Session start time in venue's local timezone (HH:MM format, 24-hour)
supported_order_types: Array<string>
Order types supported by this venue
supported_tifs: Array<string>
Time-in-force options supported by this venue
tick_size: string
The minimum price increment for orders at this venue
timezone: string
IANA timezone identifier for the venue's local time
country: string
The ISO country code where the venue operates
The display characteristics of the venue
Indicates whether GOOD_TILL_DATE orders accept date-only or timestamp specifications
date: boolean
Whether the venue accepts date-only expiration (YYYY-MM-DD)
timestamp: boolean
Whether the venue accepts precise timestamp expiration
lot_size: number
The minimum quantity increment for orders at this venue
mic: string
The Market Identifier Code (MIC) for the venue
name: string
The display name of the venue
Trading sessions available at this venue
end_local: string
Session end time in venue's local timezone (HH:MM format, 24-hour)
name: string
The name of the trading session
start_local: string
Session start time in venue's local timezone (HH:MM format, 24-hour)
supported_order_types: Array<string>
Order types supported by this venue
supported_tifs: Array<string>
Time-in-force options supported by this venue
tick_size: string
The minimum price increment for orders at this venue
timezone: string
IANA timezone identifier for the venue's local time
VenueSession { end_local, name, start_local }
A trading session within a venue's trading day
end_local: string
Session end time in venue's local timezone (HH:MM format, 24-hour)
name: string
The name of the trading session
start_local: string
Session start time in venue's local timezone (HH:MM format, 24-hour)
V1Iris
V1IrisFeedback
Create feedback on a message (deprecated).
V1IrisRuns
Cancel a running assistant run (deprecated).
Get run status and events (deprecated).
Start a new assistant run (deprecated).
V1IrisThreads
Get a specific thread (deprecated).
List conversation threads (deprecated).
V1IrisThreadsMessages
List messages in a thread (deprecated).
V1Market Data
V1Market DataSnapshot
Get market data snapshots for one or more securities.
ModelsExpand Collapse
MarketDataSnapshot { instrument_id, symbol, last_quote, 3 more }
Market data snapshot for a single security.
instrument_id: string
OEMS instrument identifier.
symbol: string
Display symbol for the security.
Most recent quote if available.
ask: string
Current best ask.
bid: string
Current best bid.
midpoint: string
Midpoint of bid and ask.
ask_size?: number | null
Size at the best ask, in shares.
bid_size?: number | null
Size at the best bid, in shares.
Most recent last-sale trade if available.
price: string
Most recent last-sale eligible trade price.
name?: string | null
Security name if available.
Session metrics computed from previous close and last trade, if available.
change: string
Absolute change from previous close to last trade.
change_percent: string
Percent change from previous close to last trade.
previous_close: string
Previous session close price.
instrument_id: string
OEMS instrument identifier.
symbol: string
Display symbol for the security.
Most recent quote if available.
ask: string
Current best ask.
bid: string
Current best bid.
midpoint: string
Midpoint of bid and ask.
ask_size?: number | null
Size at the best ask, in shares.
bid_size?: number | null
Size at the best bid, in shares.
Most recent last-sale trade if available.
price: string
Most recent last-sale eligible trade price.
name?: string | null
Security name if available.
Session metrics computed from previous close and last trade, if available.
change: string
Absolute change from previous close to last trade.
change_percent: string
Percent change from previous close to last trade.
previous_close: string
Previous session close price.
SnapshotLastTrade { price }
Last-trade fields for a market data snapshot.
price: string
Most recent last-sale eligible trade price.
SnapshotQuote { ask, bid, midpoint, 2 more }
L1 quote fields for a market data snapshot.
ask: string
Current best ask.
bid: string
Current best bid.
midpoint: string
Midpoint of bid and ask.
ask_size?: number | null
Size at the best ask, in shares.
bid_size?: number | null
Size at the best bid, in shares.
SnapshotSession { change, change_percent, previous_close }
Session-level pricing metrics for a market data snapshot.
change: string
Absolute change from previous close to last trade.
change_percent: string
Percent change from previous close to last trade.
previous_close: string
Previous session close price.
V1News
Get news.
ModelsExpand Collapse
NewsInstrument { security_id, security_id_source, instrument_id, 2 more }
Instrument associated with a news item.
security_id: string
Security identifier value.
Security identifier source.
instrument_id?: string | null
OEMS instrument UUID, if available from instrument cache enrichment.
name?: string | null
Instrument name/description, if available from instrument cache enrichment.
symbol?: string | null
Trading symbol, if available from instrument cache enrichment.
NewsItem { instruments, news_type, published_at, 6 more }
A single news item and its associated instruments.
Instruments associated with this news item.
security_id: string
Security identifier value.
Security identifier source.
instrument_id?: string | null
OEMS instrument UUID, if available from instrument cache enrichment.
name?: string | null
Instrument name/description, if available from instrument cache enrichment.
symbol?: string | null
Trading symbol, if available from instrument cache enrichment.
Classification of the item.
published_at: string
The published date/time of the article in UTC.
publisher: string
The publisher or newswire source.
title: string
The headline/title of the article.
url: string
Canonical URL to the full article.
image_url?: string | null
URL of an associated image if provided by the source.
site?: string | null
The primary domain/site of the publisher.
text?: string | null
The full or excerpted article body.
Instruments associated with this news item.
security_id: string
Security identifier value.
Security identifier source.
instrument_id?: string | null
OEMS instrument UUID, if available from instrument cache enrichment.
name?: string | null
Instrument name/description, if available from instrument cache enrichment.
symbol?: string | null
Trading symbol, if available from instrument cache enrichment.
Classification of the item.
published_at: string
The published date/time of the article in UTC.
publisher: string
The publisher or newswire source.
title: string
The headline/title of the article.
url: string
Canonical URL to the full article.
image_url?: string | null
URL of an associated image if provided by the source.
site?: string | null
The primary domain/site of the publisher.
text?: string | null
The full or excerpted article body.
NewsType = "NEWS" | "PRESS_RELEASE"
News item classification.
V1Omni AI
ModelsExpand Collapse
CancelRunResponse { canceled }
Capability = "NAVIGATE" | "OPEN_CHAT_WINDOW" | "PREFILL_ORDER" | 2 more
Capability allowlist for structured actions.
Clients declare which capabilities they support when starting a run. Omni AI will only emit structured actions that match the declared capabilities.
ContentPart = Text { type } | PrefillOrder { action_type, type } | OpenChart { action_type, type } | OpenScreener { action_type, type } | 2 more | Type { type }
A single content part (text or structured action).
Plain text content
type: "text"
PrefillOrder { action_type, type } | OpenChart { action_type, type } | OpenScreener { action_type, type } | 2 more
Prefill an order ticket for user confirmation
action_type: "prefill_order"
type?: "structured_action"
Open a chart for a symbol
action_type: "open_chart"
type?: "structured_action"
OpenScreener extends OpenScreenerAction { filters, field_filter, page_size, 2 more } { action_type, type }
Open a stock screener with filters
action_type: "open_screener"
type?: "structured_action"
Open a chat window
action_type: "open_chat_window"
type?: "structured_action"
Navigate to a client route
action_type: "navigate"
type?: "structured_action"
Type { type }
Custom/extensible content
type: "custom"
ContentPartText { text }
CreateFeedbackResponse { created_at, feedback_id }
GetRunResponse { events, run, next_page_token }
GetThreadResponse { thread }
ListMessagesResponse { messages, next_page_token }
content_text: string
Denormalized text content for search/display
Parsed content parts (text and structured actions)
Plain text content
type: "text"
PrefillOrder { action_type, type } | OpenChart { action_type, type } | OpenScreener { action_type, type } | 2 more
Prefill an order ticket for user confirmation
action_type: "prefill_order"
type?: "structured_action"
Open a chart for a symbol
action_type: "open_chart"
type?: "structured_action"
OpenScreener extends OpenScreenerAction { filters, field_filter, page_size, 2 more } { action_type, type }
Open a stock screener with filters
action_type: "open_screener"
type?: "structured_action"
Open a chat window
action_type: "open_chat_window"
type?: "structured_action"
Navigate to a client route
action_type: "navigate"
type?: "structured_action"
Type { type }
Custom/extensible content
type: "custom"
ListThreadsResponse { threads, next_page_token }
Message { content_text, created_at, role, 7 more }
content_text: string
Denormalized text content for search/display
Parsed content parts (text and structured actions)
Plain text content
type: "text"
PrefillOrder { action_type, type } | OpenChart { action_type, type } | OpenScreener { action_type, type } | 2 more
Prefill an order ticket for user confirmation
action_type: "prefill_order"
type?: "structured_action"
Open a chart for a symbol
action_type: "open_chart"
type?: "structured_action"
OpenScreener extends OpenScreenerAction { filters, field_filter, page_size, 2 more } { action_type, type }
Open a stock screener with filters
action_type: "open_screener"
type?: "structured_action"
Open a chat window
action_type: "open_chat_window"
type?: "structured_action"
Navigate to a client route
action_type: "navigate"
type?: "structured_action"
Type { type }
Custom/extensible content
type: "custom"
MessageContent { parts }
Message content containing text and structured action parts.
Plain text content
type: "text"
PrefillOrder { action_type, type } | OpenChart { action_type, type } | OpenScreener { action_type, type } | 2 more
Prefill an order ticket for user confirmation
action_type: "prefill_order"
type?: "structured_action"
Open a chart for a symbol
action_type: "open_chart"
type?: "structured_action"
OpenScreener extends OpenScreenerAction { filters, field_filter, page_size, 2 more } { action_type, type }
Open a stock screener with filters
action_type: "open_screener"
type?: "structured_action"
Open a chat window
action_type: "open_chat_window"
type?: "structured_action"
Navigate to a client route
action_type: "navigate"
type?: "structured_action"
Type { type }
Custom/extensible content
type: "custom"
MessageRole = "UNSPECIFIED" | "SYSTEM" | "USER" | 2 more
NavigateAction { route, params }
Action to navigate to a client route.
route: string
Route path or key
params?: unknown
Route parameters
OpenChartAction { symbol, extras, timeframe }
Action to open a chart for a symbol.
symbol: string
Trading symbol to chart
extras?: unknown
Additional chart configuration (indicators, overlays, etc.)
timeframe?: string | null
Chart timeframe (e.g., "1D", "1W", "1M", "3M", "1Y", "5Y")
OpenChatWindowAction { extras, thread_id, title }
Action to open a chat window.
extras?: unknown
Additional configuration
thread_id?: string | null
Thread ID to open (None to open a new chat window)
title?: string | null
Window title
OpenScreenerAction { filters, field_filter, page_size, 2 more }
Action to open a stock screener with filters.
Filter criteria for the screener
field: string
Field to filter on (e.g., "market_cap", "sector", "price")
operator: string
Comparison operator (e.g., "eq", "gte", "lte", "in")
value: unknown
Filter value
field_filter?: Array<string> | null
Optional field/column selection for screener results.
page_size?: number | null
Optional page size.
sort_by?: string | null
Optional sort field for screener rows.
sort_direction?: string | null
Optional sort direction (ASC or DESC).
OrderPayload { order_type, quantity, security_type, 6 more }
Order payload for prefilling an order ticket.
This schema aligns with the NewOrderRequest schema used for order submission, containing the fields needed to prefill an order ticket or submit via API.
Order type
quantity: string
Quantity (shares for stocks, contracts for options)
Type of security
Order side
symbol: string
Trading symbol (e.g., "AAPL" for equities, OSI for options)
Time in force
limit_price?: string | null
Limit price (required for LIMIT and STOP_LIMIT orders)
stop_price?: string | null
Stop price (required for STOP and STOP_LIMIT orders)
Execution strategy (simplified enum, not the full strategy params for now)
OrderStrategyType = "SOR" | "VWAP" | "TWAP" | 4 more
Simplified order strategy type for prefill actions.
This is a simplified enum compared to the full OrderStrategy with params, suitable for indicating the desired strategy without full configuration.
PrefillOrderAction { orders, account_id }
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.
The orders to prefill
Order type
quantity: string
Quantity (shares for stocks, contracts for options)
Type of security
Order side
symbol: string
Trading symbol (e.g., "AAPL" for equities, OSI for options)
Time in force
limit_price?: string | null
Limit price (required for LIMIT and STOP_LIMIT orders)
stop_price?: string | null
Stop price (required for STOP and STOP_LIMIT orders)
Execution strategy (simplified enum, not the full strategy params for now)
account_id?: number | null
Account to prefill for (if known from context)
Run { created_at, model, provider, 10 more }
RunStatus = "UNSPECIFIED" | "QUEUED" | "RUNNING" | 3 more
StartRunResponse { run, thread, user_message }
content_text: string
Denormalized text content for search/display
Parsed content parts (text and structured actions)
Plain text content
type: "text"
PrefillOrder { action_type, type } | OpenChart { action_type, type } | OpenScreener { action_type, type } | 2 more
Prefill an order ticket for user confirmation
action_type: "prefill_order"
type?: "structured_action"
Open a chart for a symbol
action_type: "open_chart"
type?: "structured_action"
OpenScreener extends OpenScreenerAction { filters, field_filter, page_size, 2 more } { action_type, type }
Open a stock screener with filters
action_type: "open_screener"
type?: "structured_action"
Open a chat window
action_type: "open_chat_window"
type?: "structured_action"
Navigate to a client route
action_type: "navigate"
type?: "structured_action"
Type { type }
Custom/extensible content
type: "custom"
StructuredAction = PrefillOrder { action_type } | OpenChart { action_type } | OpenScreener { action_type } | 2 more
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.
Prefill an order ticket for user confirmation
action_type: "prefill_order"
Open a chart for a symbol
action_type: "open_chart"
OpenScreener extends OpenScreenerAction { filters, field_filter, page_size, 2 more } { action_type }
Open a stock screener with filters
action_type: "open_screener"
Open a chat window
action_type: "open_chat_window"
Navigate to a client route
action_type: "navigate"
Thread { account_id, created_at, description, 5 more }
V1Omni AIFeedback
Create feedback on a message.
V1Omni AIRuns
Cancel a running assistant run.
Get run status and events.
Start a new assistant run.
V1Omni AIThreads
Get a specific thread.
List conversation threads.
V1Omni AIThreadsMessages
List messages in a thread.
V1Saved Screeners
Create a saved screener configuration.
Delete a saved screener configuration.
Get a saved screener configuration by ID.
List saved screener configurations.
Update a saved screener configuration.
ModelsExpand Collapse
SavedScreenerFilter { field_name, operation, value }
A single filter criterion for a screener
field_name: string
The field name to filter on
operation: string
The filter operation (lt, lte, gt, gte, eq, rgx, bw, ew)
value: string
The filter value
ScreenerEntry { id, created_at, filters, 5 more }
A saved screener configuration entry
id: string
Unique identifier for this screener
created_at: string
When this screener was created
Filter criteria for this screener
field_name: string
The field name to filter on
operation: string
The filter operation (lt, lte, gt, gte, eq, rgx, bw, ew)
value: string
The filter value
name: string
The name of this screener configuration
updated_at: string
When this screener was last updated
field_filter?: Array<string> | null
List of field names to include when running this screener
sort_by?: string | null
Field name to sort results by
sort_direction?: string | null
Sort direction for results
id: string
Unique identifier for this screener
created_at: string
When this screener was created
Filter criteria for this screener
field_name: string
The field name to filter on
operation: string
The filter operation (lt, lte, gt, gte, eq, rgx, bw, ew)
value: string
The filter value
name: string
The name of this screener configuration
updated_at: string
When this screener was last updated
field_filter?: Array<string> | null
List of field names to include when running this screener
sort_by?: string | null
Field name to sort results by
sort_direction?: string | null
Sort direction for results
V1Screener
Screen instruments.
ModelsExpand Collapse
ScreenerFilter { field, operator, value }
A single filter criterion for the screener.
field: string
Field to filter on (e.g., "market_cap", "sector", "price")
operator: string
Comparison operator (e.g., "eq", "gte", "lte", "in")
value: unknown
Filter value
ScreenerItem { buy_ratings, hold_ratings, price, 50 more }
An instrument returned by the screener
buy_ratings: number
The count of buy analyst ratings
hold_ratings: number
The count of hold analyst ratings
price: string
The latest price for the instrument
security_id: string
The identifier for the instrument
The source of the security identifier
sell_ratings: number
The count of sell analyst ratings
strong_buy_ratings: number
The count of strong buy analyst ratings
strong_sell_ratings: number
The count of strong sell analyst ratings
symbol: string
The trading symbol for the instrument
total_ratings: number
The total count of analyst ratings
consensus_price_target?: string | null
The consensus analyst price target
consensus_price_target_high?: string | null
The highest analyst price target
consensus_price_target_low?: string | null
The lowest analyst price target
The consensus analyst rating
country_of_issue?: string | null
The ISO country code of the instrument's issue
description?: string | null
A detailed description of the instrument or company
fifty_two_week_high?: string | null
The highest price over the last 52 weeks
fifty_two_week_low?: string | null
The lowest price over the last 52 weeks
gap_from_52w_high_pct?: string | null
Percent gap from 52-week high to previous day close (negative = below high)
gap_from_52w_low_pct?: string | null
Percent gap from 52-week low to previous day close (positive = above low)
industry?: string | null
The specific industry of the instrument's issuer
list_date?: string | null
The date the instrument was first listed
market_cap?: string | null
The total market capitalization
month_avg_volume?: string | null
The average trading volume over the past month
name?: string | null
The full name of the instrument or its issuer
one_month_ago_close?: string | null
The closing price approximately one month ago
one_month_ago_open?: string | null
The opening price approximately one month ago
one_month_change_pct?: string | null
Percent change from one month ago close to previous day close
one_week_ago_close?: string | null
The closing price approximately one week ago
one_week_ago_open?: string | null
The opening price approximately one week ago
one_week_change_pct?: string | null
Percent change from one week ago close to previous day close
one_year_ago_close?: string | null
The closing price approximately one year ago
one_year_ago_open?: string | null
The opening price approximately one year ago
one_year_change_pct?: string | null
Percent change from one year ago close to previous day close
percent_change?: string | null
The percent change from previous close to current price
prev_day_close?: string | null
The previous day's closing price
sector?: string | null
The business sector of the instrument's issuer
security_type?: string | null
The type of security
six_month_change_pct?: string | null
Percent change from six months ago close to previous day close
six_months_ago_close?: string | null
The closing price approximately six months ago
six_months_ago_open?: string | null
The opening price approximately six months ago
three_month_change_pct?: string | null
Percent change from three months ago close to previous day close
three_months_ago_close?: string | null
The closing price approximately three months ago
three_months_ago_open?: string | null
The opening price approximately three months ago
ttm_debt_to_equity?: string | null
The TTM debt-to-equity ratio
ttm_dividend_yield?: string | null
The TTM dividend yield percent
ttm_earnings_per_share?: string | null
The TTM earnings per share
ttm_price_to_earnings?: string | null
The TTM price-to-earnings ratio
venue?: string | null
The MIC code of the primary listing venue
volume?: string | null
The latest trading volume for the instrument
week_avg_volume?: string | null
The average trading volume over the past week
year_to_date_open?: string | null
The opening price on the first trading day of the current year
ytd_change_pct?: string | null
Percent change from year-to-date open to previous day close
buy_ratings: number
The count of buy analyst ratings
hold_ratings: number
The count of hold analyst ratings
price: string
The latest price for the instrument
security_id: string
The identifier for the instrument
The source of the security identifier
sell_ratings: number
The count of sell analyst ratings
strong_buy_ratings: number
The count of strong buy analyst ratings
strong_sell_ratings: number
The count of strong sell analyst ratings
symbol: string
The trading symbol for the instrument
total_ratings: number
The total count of analyst ratings
consensus_price_target?: string | null
The consensus analyst price target
consensus_price_target_high?: string | null
The highest analyst price target
consensus_price_target_low?: string | null
The lowest analyst price target
The consensus analyst rating
country_of_issue?: string | null
The ISO country code of the instrument's issue
description?: string | null
A detailed description of the instrument or company
fifty_two_week_high?: string | null
The highest price over the last 52 weeks
fifty_two_week_low?: string | null
The lowest price over the last 52 weeks
gap_from_52w_high_pct?: string | null
Percent gap from 52-week high to previous day close (negative = below high)
gap_from_52w_low_pct?: string | null
Percent gap from 52-week low to previous day close (positive = above low)
industry?: string | null
The specific industry of the instrument's issuer
list_date?: string | null
The date the instrument was first listed
market_cap?: string | null
The total market capitalization
month_avg_volume?: string | null
The average trading volume over the past month
name?: string | null
The full name of the instrument or its issuer
one_month_ago_close?: string | null
The closing price approximately one month ago
one_month_ago_open?: string | null
The opening price approximately one month ago
one_month_change_pct?: string | null
Percent change from one month ago close to previous day close
one_week_ago_close?: string | null
The closing price approximately one week ago
one_week_ago_open?: string | null
The opening price approximately one week ago
one_week_change_pct?: string | null
Percent change from one week ago close to previous day close
one_year_ago_close?: string | null
The closing price approximately one year ago
one_year_ago_open?: string | null
The opening price approximately one year ago
one_year_change_pct?: string | null
Percent change from one year ago close to previous day close
percent_change?: string | null
The percent change from previous close to current price
prev_day_close?: string | null
The previous day's closing price
sector?: string | null
The business sector of the instrument's issuer
security_type?: string | null
The type of security
six_month_change_pct?: string | null
Percent change from six months ago close to previous day close
six_months_ago_close?: string | null
The closing price approximately six months ago
six_months_ago_open?: string | null
The opening price approximately six months ago
three_month_change_pct?: string | null
Percent change from three months ago close to previous day close
three_months_ago_close?: string | null
The closing price approximately three months ago
three_months_ago_open?: string | null
The opening price approximately three months ago
ttm_debt_to_equity?: string | null
The TTM debt-to-equity ratio
ttm_dividend_yield?: string | null
The TTM dividend yield percent
ttm_earnings_per_share?: string | null
The TTM earnings per share
ttm_price_to_earnings?: string | null
The TTM price-to-earnings ratio
venue?: string | null
The MIC code of the primary listing venue
volume?: string | null
The latest trading volume for the instrument
week_avg_volume?: string | null
The average trading volume over the past week
year_to_date_open?: string | null
The opening price on the first trading day of the current year
ytd_change_pct?: string | null
Percent change from year-to-date open to previous day close
V1Version
Get the API version.
Update API version preferences.
ModelsExpand Collapse
Version { version }
API version information
version: string
API version string
V1Watchlists
Create a new watchlist
Delete a watchlist and all its items
Get a watchlist by ID with all its items
List watchlists for the authenticated user
ModelsExpand Collapse
WatchlistDetail { id, created_at, items, name }
Detailed watchlist with all items
id: string
Watchlist ID
created_at: string
Creation timestamp
Items in the watchlist
id: string
Item ID
added_at: string
When the item was added
added_price?: string | null
Price when the item was added
Instrument details
available_to_borrow?: number | null
The number of shares currently available to borrow
average_volume?: number | null
The average daily trading volume over the past 30 days
beta?: string | null
The beta value, measuring the instrument's volatility relative to the overall market
borrow_fee?: string | null
The fee associated with borrowing the instrument, expressed as a decimal
description?: string | null
A detailed description of the instrument or company
dividend_yield?: string | null
The trailing twelve months (TTM) dividend yield
earnings_per_share?: string | null
The trailing twelve months (TTM) earnings per share
fifty_two_week_high?: string | null
The highest price over the last 52 weeks
fifty_two_week_low?: string | null
The lowest price over the last 52 weeks
industry?: string | null
The specific industry of the instrument's issuer
list_date?: string | null
The date the instrument was first listed
logo_url?: string | null
URL to a representative logo image for the instrument or issuer
long_concentration_limit?: string | null
A cap on how much of your equity you can put into a single symbol on the long side
market_cap?: string | null
The total market capitalization
previous_close?: string | null
The closing price from the previous trading day
price_to_earnings?: string | null
The price-to-earnings (P/E) ratio for the trailing twelve months (TTM)
Real-time market quote data for the instrument
high: string
The highest trade price during the current trading day
last_price: string
The most recent trade price
low: string
The lowest trade price during the current trading day
open: string
The opening price for the current trading day
volume: number
The total number of shares traded during the current trading day
sector?: string | null
The business sector of the instrument's issuer
short_concentration_limit?: string | null
A cap on how much of your equity you can allocate to a single symbol on the short side
name: string
Watchlist name
WatchlistEntry { id, created_at, name }
Represents a user watchlist.
id: string
The unique identifier for the watchlist.
created_at: string
The timestamp when the watchlist was created.
name: string
The user-provided watchlist name.
id: string
The unique identifier for the watchlist.
created_at: string
The timestamp when the watchlist was created.
name: string
The user-provided watchlist name.
WatchlistItemEntry { id, added_at, added_price, instrument }
A single item in a watchlist
id: string
Item ID
added_at: string
When the item was added
added_price?: string | null
Price when the item was added
Instrument details
available_to_borrow?: number | null
The number of shares currently available to borrow
average_volume?: number | null
The average daily trading volume over the past 30 days
beta?: string | null
The beta value, measuring the instrument's volatility relative to the overall market
borrow_fee?: string | null
The fee associated with borrowing the instrument, expressed as a decimal
description?: string | null
A detailed description of the instrument or company
dividend_yield?: string | null
The trailing twelve months (TTM) dividend yield
earnings_per_share?: string | null
The trailing twelve months (TTM) earnings per share
fifty_two_week_high?: string | null
The highest price over the last 52 weeks
fifty_two_week_low?: string | null
The lowest price over the last 52 weeks
industry?: string | null
The specific industry of the instrument's issuer
list_date?: string | null
The date the instrument was first listed
logo_url?: string | null
URL to a representative logo image for the instrument or issuer
long_concentration_limit?: string | null
A cap on how much of your equity you can put into a single symbol on the long side
market_cap?: string | null
The total market capitalization
previous_close?: string | null
The closing price from the previous trading day
price_to_earnings?: string | null
The price-to-earnings (P/E) ratio for the trailing twelve months (TTM)
Real-time market quote data for the instrument
high: string
The highest trade price during the current trading day
last_price: string
The most recent trade price
low: string
The lowest trade price during the current trading day
open: string
The opening price for the current trading day
volume: number
The total number of shares traded during the current trading day
sector?: string | null
The business sector of the instrument's issuer
short_concentration_limit?: string | null
A cap on how much of your equity you can allocate to a single symbol on the short side
V1WatchlistsItems
Add an instrument to a watchlist
Delete an instrument from a watchlist
ModelsExpand Collapse
AddWatchlistItemData { item_id }
Response data for adding a watchlist item
item_id: string
ID of the created item