V1
V1Accounts
Manage trading accounts, balances, and portfolio history.
Get Accounts
Get Account By ID
Patch Account By ID
Get Account Balances
Get Portfolio History
ModelsExpand Collapse
class Account:
Represents a trading account
AccountHolderEntityKind accountHolderEntityKind
AccountStatus status
AccountSubtype subtype
AccountType type
class AccountBalances:
Represents the balance details for a trading account
String buyingPower
The total buying power available in the account: base buying power plus the open order adjustment, where base buying power is maintenance margin excess times the multiplier for intraday and initial margin excess times the multiplier for overnight.
String dailyUnrealizedPnl
Total unrealized profit or loss across all positions relative to prior close.
String equity
The total equity in the account: cash plus long market value plus short market value, where short market value is negative.
MarginType marginType
The applicable margin model for the account
String openOrderAdjustment
Buying power correction from open orders, computed as projected buying power minus actual buying power. A negative value means open orders are consuming buying power.
Start-of-day snapshot balances.
Optional<LocalDate> asof
Timestamp for the start-of-day values. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> maintenanceMarginExcess
Start-of-day maintenance margin excess: the difference between equity and the maintenance margin requirement. When a null/undefined value is observed, it indicates it does not apply.
Margin-account-only details. When a null/undefined value is observed, it indicates it does not apply.
MarginSessionDetails intradayDetails
Intraday session margin calculation details.
MarginSessionDetails overnightDetails
Overnight session margin calculation details.
class AccountBalancesSod:
Optional<LocalDate> asof
Timestamp for the start-of-day values. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> maintenanceMarginExcess
Start-of-day maintenance margin excess: the difference between equity and the maintenance margin requirement. When a null/undefined value is observed, it indicates it does not apply.
class AccountWithPersonalDetails:
Represents a trading account
AccountHolderEntityKind accountHolderEntityKind
AccountStatus status
AccountSubtype subtype
AccountType type
Optional<LocalDate> closeDate
The date the account was closed, if applicable When a null/undefined value is observed, it indicates it does not apply.
Optional<String> countryOfTaxResidency
The country of tax residency of the account-holder entity. null
when not on file or entity reference data is unavailable.
When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDate> dateOfBirth
The date of birth of the account holder’s primary contact. null
when not on file or entity reference data is unavailable.
When a null/undefined value is observed, it indicates that there is no available data.
The mailing address of the account-holder entity. null when no
mailing address is on file or entity reference data is unavailable.
When a null/undefined value is observed, it indicates that there is no available data.
class MarginDetails:
MarginSessionDetails intradayDetails
Intraday session margin calculation details.
MarginSessionDetails overnightDetails
Overnight session margin calculation details.
class MarginSessionDetails:
class PortfolioHistoryResponse:
List<PortfolioHistorySegment> segments
Optional<String> dayPnl
Sum of the profit and loss from intraday trading activities for the trading day.
Optional<String> netPnl
P&L after netting all realized and unrealized P&L, adjustments, dividends, change in accruals, income and expenses
class PortfolioHistorySegment:
Optional<String> dayPnl
Sum of the profit and loss from intraday trading activities for the trading day.
Optional<String> netPnl
P&L after netting all realized and unrealized P&L, adjustments, dividends, change in accruals, income and expenses
V1API Version
Endpoints for API service metadata.
Get the API version.
V1Calendar
Access clocks and financial calendars for market sessions and events.
Get Clock
Get Market Hours Calendar.
ModelsExpand Collapse
class MarketHoursDetail:
Comprehensive market hours information for a specific market and date
MarketType market
TradingSessions nextSessions
Next trading day’s session schedules (without time_until fields)
After-hours session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
Overnight session schedule (prior evening through early morning), null if not available When a null/undefined value is observed, it indicates it does not apply.
Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.
MarketStatus status
Market status information
DayType dayType
TradingSessions todaySessions
Trading session schedules for the requested date with time_until fields
After-hours session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
Overnight session schedule (prior evening through early morning), null if not available When a null/undefined value is observed, it indicates it does not apply.
Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.
class MarketStatus:
Market status information
DayType dayType
class TradingSessions:
Trading sessions for a market day with full timestamps
After-hours session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
Overnight session schedule (prior evening through early morning), null if not available When a null/undefined value is observed, it indicates it does not apply.
Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.
Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.
V1Instrument Data
Retrieve instrument analytics, market data, news, and related reference data.
Get All Instrument Events
Get Instrument Events
Get Instrument Fundamentals
Get Instrument Balance Sheet Statements
Get Instrument Income Statements
Get Instrument Analyst Consensus
Get Instrument Cash Flow Statements
ModelsExpand Collapse
class InstrumentAllEventsData:
All-events payload grouped by date.
List<InstrumentEventsByDate> eventDates
Events grouped by date in descending order.
List<InstrumentEventEnvelope> events
Flat event envelopes for this date.
AllEventsEventType type
Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.
LocalDate exDate
The day the stock starts trading without the right to receive that dividend.
Optional<LocalDate> declarationDate
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> dividendAmount
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> dividendYield
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> frequency
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> epsActual
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> epsEstimate
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> epsSurprisePercent
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> revenueActual
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> instrumentId
Instrument identifier, when available. When a null/undefined value is observed, it indicates that there is no available data.
IPO payload when type is IPO. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> actions
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDateTime> announcedAt
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> company
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> exchange
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> marketCap
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> name
Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> reportingCurrency
The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentAnalystConsensus:
Aggregated analyst consensus metrics
class InstrumentBalanceSheetStatement:
A quarterly balance sheet statement for an instrument.
FiscalPeriodType periodType
class InstrumentCashFlowStatement:
A quarterly cash flow statement for an instrument.
FiscalPeriodType periodType
class InstrumentDividendEvent:
Represents a dividend event for an instrument
LocalDate exDate
The day the stock starts trading without the right to receive that dividend.
Optional<LocalDate> declarationDate
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> dividendAmount
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> dividendYield
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> frequency
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentEarnings:
Represents instrument earnings data
Optional<String> epsActual
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> epsEstimate
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> epsSurprisePercent
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> revenueActual
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentEventEnvelope:
Unified envelope for the all-events response.
AllEventsEventType type
Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.
LocalDate exDate
The day the stock starts trading without the right to receive that dividend.
Optional<LocalDate> declarationDate
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> dividendAmount
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> dividendYield
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> frequency
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> epsActual
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> epsEstimate
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> epsSurprisePercent
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> revenueActual
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> instrumentId
Instrument identifier, when available. When a null/undefined value is observed, it indicates that there is no available data.
IPO payload when type is IPO. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> actions
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDateTime> announcedAt
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> company
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> exchange
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> marketCap
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> name
Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> reportingCurrency
The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentEventIpoItem:
IPO event in the all-events date grouping response.
Optional<String> actions
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDateTime> announcedAt
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> company
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> exchange
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> marketCap
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentEventsByDate:
Instrument events for a single date.
List<InstrumentEventEnvelope> events
Flat event envelopes for this date.
AllEventsEventType type
Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.
LocalDate exDate
The day the stock starts trading without the right to receive that dividend.
Optional<LocalDate> declarationDate
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> dividendAmount
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> dividendYield
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> frequency
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> epsActual
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> epsEstimate
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> epsSurprisePercent
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> revenueActual
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> instrumentId
Instrument identifier, when available. When a null/undefined value is observed, it indicates that there is no available data.
IPO payload when type is IPO. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> actions
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDateTime> announcedAt
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> company
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> exchange
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> marketCap
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> name
Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> reportingCurrency
The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentEventsData:
Grouped instrument events by type
List<InstrumentDividendEvent> dividends
Dividend distribution events
LocalDate exDate
The day the stock starts trading without the right to receive that dividend.
Optional<LocalDate> declarationDate
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> dividendAmount
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> dividendYield
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> frequency
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
List<InstrumentEarnings> earnings
Earnings announcement events
Optional<String> epsActual
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> epsEstimate
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> epsSurprisePercent
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> revenueActual
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
List<InstrumentIpoEvent> ipos
IPO events
Optional<String> actions
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDateTime> announcedAt
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> company
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> exchange
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> marketCap
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
List<InstrumentSplitEvent> splits
class InstrumentFundamentals:
Supplemental fundamentals and company profile data for an instrument.
Optional<Long> averageVolume
The average daily trading volume over the past 30 days When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> beta
The beta value, measuring the instrument’s volatility relative to the overall market When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> description
A detailed description of the instrument or company When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> dividendYield
The trailing twelve months (TTM) dividend yield When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> earningsPerShare
The trailing twelve months (TTM) earnings per share When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> fiftyTwoWeekHigh
The highest price over the last 52 weeks When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> fiftyTwoWeekLow
The lowest price over the last 52 weeks When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> industry
The specific industry of the instrument’s issuer When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDate> listDate
The date the instrument was first listed When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> logoUrl
URL to a representative logo image for the instrument or issuer When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> marketCap
The total market capitalization When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> previousClose
The closing price from the previous trading day When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> priceToEarnings
The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentIncomeStatement:
A quarterly income statement for an instrument.
FiscalPeriodType periodType
class InstrumentIpoEvent:
Represents an IPO event for an instrument
Optional<String> actions
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDateTime> announcedAt
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> company
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> exchange
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> marketCap
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
V1Instrument DataMarket Data
Retrieve instrument analytics, market data, news, and related reference data.
Get Snapshots
Get Daily Aggregate Summaries
ModelsExpand Collapse
class DailySummary:
Daily aggregate (OHLV) summary for a single instrument.
Returned by GET /market-data/daily-summary. Every field except
instrument_id and not_applicable is Option:
- Unresolvable
instrument_id→ all other fieldsNone(includingsymbol). - Resolvable
instrument_idwith no realtime cache entry →symbolpopulated, OHLV/trade_date/open_interestNone. trade_datereflects the session the OHLV represents (today during trading hours, the last trading date during weekends/holidays).open_interestis populated for options only;Nonefor equities and indices.not_applicableis a non-optionalbool, always serialized:truefor instrument types with no daily summary by definition (e.g. an index, whose OHLV/trade_dateareNone),falseotherwise.
Optional<String> high
Session high. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> low
Session low. When a null/undefined value is observed, it indicates that there is no available data.
Optional<Boolean> notApplicable
true when the instrument type has no daily summary by definition (e.g. an
index). Distinguishes an intentional N/A from OHLV that is merely not loaded
yet. false for instruments that can have a summary.
Optional<String> open
Opening price for the session. When a null/undefined value is observed, it indicates that there is no available data.
Optional<Long> openInterest
Open interest (outstanding contracts). Populated for options only;
None for equities and indices.
When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> symbol
Display symbol for the security. None for unresolvable IDs.
When a null/undefined value is observed, it indicates that there is no available data.
class MarketDataSnapshot:
Market data snapshot for a single security.
SnapshotSession session
Session-level pricing and OHLV metrics. Always present; each inner field is independently nullable.
boolean ohlvApplicable
false only for instrument types with no OHLV by definition (e.g. an
index instrument, whose price is a computed level rather than a
traded security) — open/high/low/ohlv_date/cumulative_volume
are then always absent. true otherwise, even when those fields
simply haven’t loaded yet. Always serialized.
Optional<String> change
Absolute change from previous close to the most recent last-sale-eligible trade. Absent when either side of the computation is unavailable. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> changePercent
Percent change from previous close to the most recent
last-sale-eligible trade. Absent under the same conditions as
change.
When a null/undefined value is observed, it indicates that there is no available data.
Optional<Long> cumulativeVolume
Cumulative traded volume for the current session, in shares for
equities or contracts for options. Always reflects the current
session, even when ohlv_date trails it. Absent when
ohlv_applicable is false, or when no trade is available.
When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> high
Session high. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> low
Session low. When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDate> ohlvDate
Session date the open/high/low values represent, US/Eastern. May trail the current session until the upstream feed rolls. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> open
Session opening price, from the day’s OHLC bar. Absent when
ohlv_applicable is false, or when the bar has not loaded yet.
When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> previousClose
Previous session close price. Corporate-action-adjusted (stock dividends, cash dividends, and forward/reverse splits) when an adjustment exists for the close date; the raw close otherwise. An adjustment can carry the price beyond 2 decimal places. Absent when no previous close is on record (e.g. an instrument’s first session). When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> previousCloseUnadjusted
Unadjusted (raw) previous session close. Present only when a
corporate-action adjustment exists for the previous close date; when no
adjustment exists, previous_close is the raw close and this field is
omitted.
When a null/undefined value is observed, it indicates that there is no available data.
Optional<Boolean> shortSaleRestricted
Whether the SEC Rule 201 short-sale price test is currently restricting short sales in this security, from the trading-status feed.
true restricts non-exempt short sales at or below the national best
bid. null means we have no answer, either because no trading status
has been seen for this security yet or because Rule 201 does not cover
this security type. A null is not a statement that short selling is
unrestricted, and must not be treated as clear to short.
This is the current market condition, not a statement about whether
Clear Street will reject your order. It is also distinct from
is_short_prohibited on the instrument endpoints, which is a standing
property of the security rather than a live circuit breaker.
When a null/undefined value is observed, it indicates that there is no available data.
DeprecatedOptional<Long> cumulativeVolume
Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available.
Deprecated: use session.cumulative_volume, the same value from the
same source.
When a null/undefined value is observed, it indicates that there is no available data.
Theoretical price and Greeks for option instruments. None for
equities, and for options whose Greeks have not yet been observed
When a null/undefined value is observed, it indicates that there is no available data.
Most recent quote if available. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> ask
Current best ask. Absent when no ask is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
Optional<Long> askSize
Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDateTime> askTimestamp
Exchange timestamp of the best ask. Absent when the ask side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> askVenue
ISO 10383 Market Identifier Code (MIC) of the venue currently holding the national best offer (NBBO). Absent when the ask side carries no venue. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> bid
Current best bid. Absent when no bid is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
Optional<Long> bidSize
Size at the best bid, in shares. When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDateTime> bidTimestamp
Exchange timestamp of the best bid. Absent when the bid side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
Most recent last-sale-eligible trade if available. Omitted when the most recent known print is ineligible (e.g. an odd lot or an out-of-sequence report) rather than showing that print’s price. When a null/undefined value is observed, it indicates that there is no available data.
String price
Most recent last-sale eligible trade price. For index instruments, the current index level.
long size
Share quantity of the most recent last-sale eligible trade. Always 0
for index instruments, whose level is computed rather than traded.
Optional<LocalDateTime> timestamp
Exchange timestamp of the most recent last-sale eligible trade. For index instruments, the time the index level was computed. Absent when the trade carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> venue
ISO 10383 Market Identifier Code (MIC) of the venue where the most recent last-sale eligible trade took place. Absent when the trade carries no venue; index levels are computed rather than traded and have no venue. When a null/undefined value is observed, it indicates that there is no available data.
class SnapshotLastTrade:
Last-trade fields for a market data snapshot.
For index instruments this carries the current index level — a computed
value, not a trade: price is the level and size is always 0 (no
contract changes hands).
String price
Most recent last-sale eligible trade price. For index instruments, the current index level.
long size
Share quantity of the most recent last-sale eligible trade. Always 0
for index instruments, whose level is computed rather than traded.
Optional<LocalDateTime> timestamp
Exchange timestamp of the most recent last-sale eligible trade. For index instruments, the time the index level was computed. Absent when the trade carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> venue
ISO 10383 Market Identifier Code (MIC) of the venue where the most recent last-sale eligible trade took place. Absent when the trade carries no venue; index levels are computed rather than traded and have no venue. When a null/undefined value is observed, it indicates that there is no available data.
class SnapshotQuote:
L1 quote fields for a market data snapshot.
Optional<String> ask
Current best ask. Absent when no ask is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
Optional<Long> askSize
Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDateTime> askTimestamp
Exchange timestamp of the best ask. Absent when the ask side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> askVenue
ISO 10383 Market Identifier Code (MIC) of the venue currently holding the national best offer (NBBO). Absent when the ask side carries no venue. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> bid
Current best bid. Absent when no bid is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
Optional<Long> bidSize
Size at the best bid, in shares. When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDateTime> bidTimestamp
Exchange timestamp of the best bid. Absent when the bid side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.
class SnapshotSession:
Session-level pricing and OHLV metrics for a market data snapshot. Always
present on the snapshot row; every field here is independently nullable
except ohlv_applicable.
boolean ohlvApplicable
false only for instrument types with no OHLV by definition (e.g. an
index instrument, whose price is a computed level rather than a
traded security) — open/high/low/ohlv_date/cumulative_volume
are then always absent. true otherwise, even when those fields
simply haven’t loaded yet. Always serialized.
Optional<String> change
Absolute change from previous close to the most recent last-sale-eligible trade. Absent when either side of the computation is unavailable. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> changePercent
Percent change from previous close to the most recent
last-sale-eligible trade. Absent under the same conditions as
change.
When a null/undefined value is observed, it indicates that there is no available data.
Optional<Long> cumulativeVolume
Cumulative traded volume for the current session, in shares for
equities or contracts for options. Always reflects the current
session, even when ohlv_date trails it. Absent when
ohlv_applicable is false, or when no trade is available.
When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> high
Session high. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> low
Session low. When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDate> ohlvDate
Session date the open/high/low values represent, US/Eastern. May trail the current session until the upstream feed rolls. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> open
Session opening price, from the day’s OHLC bar. Absent when
ohlv_applicable is false, or when the bar has not loaded yet.
When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> previousClose
Previous session close price. Corporate-action-adjusted (stock dividends, cash dividends, and forward/reverse splits) when an adjustment exists for the close date; the raw close otherwise. An adjustment can carry the price beyond 2 decimal places. Absent when no previous close is on record (e.g. an instrument’s first session). When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> previousCloseUnadjusted
Unadjusted (raw) previous session close. Present only when a
corporate-action adjustment exists for the previous close date; when no
adjustment exists, previous_close is the raw close and this field is
omitted.
When a null/undefined value is observed, it indicates that there is no available data.
V1Instrument DataNews
Retrieve instrument analytics, market data, news, and related reference data.
Get News
ModelsExpand Collapse
class NewsItem:
A single news item and its associated instruments.
List<NewsInstrument> instruments
NewsType newsType
Optional<String> imageUrl
URL of an associated image if provided by the source. When a null/undefined value is observed, it indicates that there is no available data.
V1Instruments
Retrieve core details and discovery endpoints for tradable instruments.
Get Instruments
Get Instrument By ID
Search Instruments
Get Option Contracts
ModelsExpand Collapse
class Instrument:
Represents a tradable financial instrument.
boolean isPtp
Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.
boolean isShortProhibited
Indicates if short selling is prohibited for the instrument. This is a
standing property of the security. For the live Rule 201 circuit
breaker, see short_sale_restricted on the market-data snapshot.
boolean isThresholdSecurity
Indicates if the instrument is on the Regulation SHO Threshold Security List
Optional<String> adv
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> caxAdjustedPreviousClose
Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> longMarginRate
The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> name
The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> notionalAdv
Notional average daily volume (ADV multiplied by the cax-adjusted close when present, the raw previous close otherwise). When a null/undefined value is observed, it indicates that there is no available data.
Available options expiration dates for this instrument, each annotated
with which settlement cycles have listed contracts on it.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
boolean hasSettlesOnClose
Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.
boolean hasSettlesOnOpen
Whether this date has at least one contract that settles on the opening print (AM settlement) and can still be traded. AM-settled contracts stop trading at the close of the business day before settlement, so this turns false before the expiration date arrives. A date leaves the list once no contract on it can be traded in either settlement cycle.
DeprecatedOptional<List<LocalDate>> optionsExpiryDates
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
Deprecated: use options_contract_expiry_dates, which carries the same
dates annotated with settlement-cycle information.
When a null/undefined value is observed, it indicates it does not apply.
Optional<String> previousClose
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> shortMarginRate
The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentCore:
boolean isPtp
Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.
boolean isShortProhibited
Indicates if short selling is prohibited for the instrument. This is a
standing property of the security. For the live Rule 201 circuit
breaker, see short_sale_restricted on the market-data snapshot.
boolean isThresholdSecurity
Indicates if the instrument is on the Regulation SHO Threshold Security List
Optional<String> adv
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> caxAdjustedPreviousClose
Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> longMarginRate
The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> name
The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> notionalAdv
Notional average daily volume (ADV multiplied by the cax-adjusted close when present, the raw previous close otherwise). When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> previousClose
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> shortMarginRate
The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
class OptionExpiryDate:
An options expiry date, annotated with which settlement cycles have listed contracts on it.
boolean hasSettlesOnClose
Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.
boolean hasSettlesOnOpen
Whether this date has at least one contract that settles on the opening print (AM settlement) and can still be traded. AM-settled contracts stop trading at the close of the business day before settlement, so this turns false before the expiration date arrives. A date leaves the list once no contract on it can be traded in either settlement cycle.
class OptionsContract:
An options contract with options-specific metadata
ContractType contractType
ExerciseStyle exerciseStyle
ListingType listingType
Optional<Boolean> isSettleOnOpen
Whether the option settles on the opening price (AM settlement), if known When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDateTime> lastTradeCutoff
Last moment the option can trade (UTC), if known When a null/undefined value is observed, it indicates that there is no available data.
Optional<Long> openInterest
Open interest (number of outstanding contracts), if available When a null/undefined value is observed, it indicates that there is no available data.
V1Omni AI
ModelsExpand Collapse
class ActionButton:
Button metadata shared by chart and suggested-actions payloads.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
class ChartPayload:
Typed chart payload rendered inline in assistant content.
Buttons associated with this chart.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
class ContentPartChartPayload:
Chart payload content part.
ChartPayload payload
Typed chart payload rendered inline in assistant content.
Buttons associated with this chart.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
class ContentPartStructuredActionPayload:
Structured action content part.
StructuredAction action
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.
PrefillOrder
PrefillOrderAction prefillOrder
OpenChart
OpenChartAction openChart
Open a chart for a symbol
Optional<JsonValue> extras
Additional chart configuration (indicators, overlays, etc.) When a null/undefined value is observed, it indicates it does not apply.
OpenScreener
OpenScreenerAction openScreener
Open a stock screener with filters
List<ScreenerFilter> filters
Optional<List<String>> columns
Optional field/column selection for screener results. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
Optional<Long> pageSize
Optional page size. When a null/undefined value is observed, it indicates it does not apply.
OpenEntitlementConsent
OpenEntitlementConsentAction openEntitlementConsent
Open entitlement consent flow
EntitlementAgreementKey agreementKey
Stable entitlement agreement family key.
class ContentPartSuggestedActionsPayload:
Suggested actions payload content part.
SuggestedActionsPayload payload
Suggested follow-up buttons rendered at the end of an assistant message.
Ordered message-level buttons.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
class OpenChartAction:
Action to open a chart for a symbol.
Optional<JsonValue> extras
Additional chart configuration (indicators, overlays, etc.) When a null/undefined value is observed, it indicates it does not apply.
class OpenEntitlementConsentAction:
Action to open entitlement consent flow for one or more accounts.
EntitlementAgreementKey agreementKey
Stable entitlement agreement family key.
class OpenScreenerAction:
Action to open a stock screener with filters.
List<ScreenerFilter> filters
Optional<List<String>> columns
Optional field/column selection for screener results. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
Optional<Long> pageSize
Optional page size. When a null/undefined value is observed, it indicates it does not apply.
class PrefillCancelOrderAction:
Cancel-order prefill action.
List<PrefillCancelOrderRequest> orders
Orders to cancel using the same identifiers required by the cancel-order API.
class PrefillModifyOrderAction:
Modify-order prefill action.
List<PrefillModifyOrderRequest> orders
class PrefillModifyOrderRequest:
class PrefillNewOrderAction:
New-order prefill action.
List<PrefillNewOrderRequest> orders
Orders to prefill using the same shape accepted by the orders API.
RequestOrderType orderType
String quantity
Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported). For OPTION (single-leg): contracts (must be an integer)
Side side
RequestTimeInForce timeInForce
Optional<String> id
Optional client-provided unique ID (idempotency). Required to be unique per account.
Optional<LocalDateTime> expiresAt
The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE.
Optional<Boolean> extendedHours
Allow trading outside regular trading hours. Some brokers disallow options outside RTH.
Optional<String> instrumentId
Instrument ID (UUID) or symbol (equity ticker or OSI option symbol). Either symbol or instrument_id must be provided.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
Optional execution strategy. One of SOR, VWAP, or TWAP. Defaults to
SOR. VWAP and TWAP are supported only on MARKET and LIMIT orders
with DAY time-in-force, and are not supported on OTC common-stock orders.
Optional<String> symbol
Trading symbol. For equities, use the ticker symbol (e.g., “TSLA”).
For options, use the OSI symbol (e.g., “TSLA 250117C00190000”).
Either symbol or instrument_id must be provided.
class PrefillNewOrderRequest:
Request to submit a new order
RequestOrderType orderType
String quantity
Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported). For OPTION (single-leg): contracts (must be an integer)
Side side
RequestTimeInForce timeInForce
Optional<String> id
Optional client-provided unique ID (idempotency). Required to be unique per account.
Optional<LocalDateTime> expiresAt
The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE.
Optional<Boolean> extendedHours
Allow trading outside regular trading hours. Some brokers disallow options outside RTH.
Optional<String> instrumentId
Instrument ID (UUID) or symbol (equity ticker or OSI option symbol). Either symbol or instrument_id must be provided.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
Optional execution strategy. One of SOR, VWAP, or TWAP. Defaults to
SOR. VWAP and TWAP are supported only on MARKET and LIMIT orders
with DAY time-in-force, and are not supported on OTC common-stock orders.
Optional<String> symbol
Trading symbol. For equities, use the ticker symbol (e.g., “TSLA”).
For options, use the OSI symbol (e.g., “TSLA 250117C00190000”).
Either symbol or instrument_id must be provided.
class PrefillOrderAction: A class that can be one of several variants.union
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.
class StructuredAction: A class that can be one of several variants.union
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.
PrefillOrder
PrefillOrderAction prefillOrder
OpenChart
OpenChartAction openChart
Open a chart for a symbol
Optional<JsonValue> extras
Additional chart configuration (indicators, overlays, etc.) When a null/undefined value is observed, it indicates it does not apply.
OpenScreener
OpenScreenerAction openScreener
Open a stock screener with filters
List<ScreenerFilter> filters
Optional<List<String>> columns
Optional field/column selection for screener results. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
Optional<Long> pageSize
Optional page size. When a null/undefined value is observed, it indicates it does not apply.
OpenEntitlementConsent
OpenEntitlementConsentAction openEntitlementConsent
Open entitlement consent flow
EntitlementAgreementKey agreementKey
Stable entitlement agreement family key.
class SuggestedActionsPayload:
Suggested follow-up buttons rendered at the end of an assistant message.
Ordered message-level buttons.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
V1Omni AIEntitlements
Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use account_ids.
Get Entitlements
Create Entitlements
Delete Entitlement
Get Entitlement Agreements
ModelsExpand Collapse
class EntitlementAgreementResource:
EntitlementAgreementKey agreementKey
Stable entitlement agreement family key.
class EntitlementResource:
EntitlementCode entitlementCode
Stable entitlement code granted by an agreement.
V1Omni AIMessages
Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use account_ids.
Get Message
Submit Feedback
V1Omni AIResponses
Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use account_ids.
Get Response By ID
Cancel Response
ModelsExpand Collapse
class Response:
Dynamic pollable response.
ResponseStatus status
When a null/undefined value is observed, it indicates that there is no available data.
List<ResponseContentPart> parts
class ResponseContent:
Dynamic response content container. May include thinking parts.
List<ResponseContentPart> parts
V1Omni AIThreads
Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use account_ids.
Get Threads
Get Thread
Create Thread
Get Thread Response
Get Messages
Create Message
ModelsExpand Collapse
class Message:
Final immutable message.
MessageContent content
Finalized immutable message content container. Never includes thinking parts.
List<MessageContentPart> parts
MessageOutcome outcome
MessageRole role
Immutable snapshots attached to this user message. Omitted when none were supplied. When a null/undefined value is observed, it indicates that there is no available data.
List<ContextItem> items
One to four snapshots. Each snapshot’s data may contain at most 32 levels of nesting.
class MessageContent:
Finalized immutable message content container. Never includes thinking parts.
List<MessageContentPart> parts
class TurnContext:
Client snapshots attached to one instant-chat user message.
Context is separate from visible message text and does not grant account access. The compact JSON representation must not exceed 64 KiB.
List<ContextItem> items
One to four snapshots. Each snapshot’s data may contain at most 32 levels of nesting.
V1Orders
Place, monitor, and manage trading orders.
Get Orders
Get Order By ID
Submit Orders
Replace Order
Cancel Open Order
Cancel All Open Orders
Get Executions
ModelsExpand Collapse
class Execution:
Represents a single fill of an order for an account.
Side side
Optional<String> instrumentId
Unique instrument identifier. null when this fill has no single resolvable
instrument.
When a null/undefined value is observed, it indicates it does not apply.
Optional<String> price
Fill price. null for multileg fills, whose price lives only at the leg level.
When a null/undefined value is observed, it indicates it does not apply.
Optional<String> symbol
Trading symbol. null when this fill has no single resolvable instrument.
When a null/undefined value is observed, it indicates it does not apply.
Optional<String> underlyingInstrumentId
Underlying instrument identifier for an option fill. Omitted for a
non-derivative fill, when the underlier could not be resolved, or for a
multileg fill (per-leg underliers live in legs[]).
When a null/undefined value is observed, it indicates it does not apply.
class NewOrderRequest:
Request to submit a new order
RequestOrderType orderType
String quantity
Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported). For OPTION (single-leg): contracts (must be an integer)
Side side
RequestTimeInForce timeInForce
Optional<String> id
Optional client-provided unique ID (idempotency). Required to be unique per account.
Optional<LocalDateTime> expiresAt
The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE.
Optional<Boolean> extendedHours
Allow trading outside regular trading hours. Some brokers disallow options outside RTH.
Optional<String> instrumentId
Instrument ID (UUID) or symbol (equity ticker or OSI option symbol). Either symbol or instrument_id must be provided.
Optional execution strategy. One of SOR, VWAP, or TWAP. Defaults to
SOR. VWAP and TWAP are supported only on MARKET and LIMIT orders
with DAY time-in-force, and are not supported on OTC common-stock orders.
Optional<String> symbol
Trading symbol. For equities, use the ticker symbol (e.g., “TSLA”).
For options, use the OSI symbol (e.g., “TSLA 250117C00190000”).
Either symbol or instrument_id must be provided.
class Order:
A trading order with its current state and execution details.
This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking.
OrderType orderType
Side side
OrderStatus status
Current status of the order
TimeInForce timeInForce
Optional<String> averageFillPrice
Average fill price across all executions. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDateTime> expiresAt
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> instrumentId
Instrument identifier for the traded instrument. null when the order has
no single resolvable instrument.
When a null/undefined value is observed, it indicates it does not apply.
Optional<String> limitOffset
Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.
Optional<String> limitPrice
Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
Optional<LocalDateTime> releasesAt
Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> stopPrice
Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
Optional<String> symbol
Trading symbol. null when the order has no single resolvable instrument.
When a null/undefined value is observed, it indicates it does not apply.
Optional<String> trailingLimitPx
Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
Optional<String> trailingOffset
Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.
Optional<String> trailingStopPx
Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
Optional<String> trailingWatermarkPx
Trailing watermark price for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.
Optional<LocalDateTime> trailingWatermarkTs
Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> underlyingInstrumentId
Instrument ID of the option’s underlying instrument. Populated only for
options orders. A null means one of two things: the order is not an
option, so the field does not apply; or the order is an option whose
underlier has not yet been resolved.
When a null/undefined value is observed, it indicates it does not apply.
class OrderStrategy: A class that can be one of several variants.union
Optional execution strategy controlling how the order is worked in the market. Omit to use standard routing. One of SOR, VWAP, or TWAP.
V1Positions
View positions and manage position instructions.
Get Positions
Close Positions
Close Position
Get Position Instructions
Submit Position Instructions
Cancel Position Instruction
ModelsExpand Collapse
class Position:
Represents a holding of a particular instrument in an account
SecurityType instrumentType
PositionType positionType
Optional<String> avgPrice
The average price paid per share or contract for this position When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> closingPrice
The closing price used to value the position for the last trading day When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDate> closingPriceDate
The market date associated with closing_price
When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> costBasis
The total cost basis for this position When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> dailyRealizedPnl
The realized profit or loss for this position for the current day When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> dailyUnrealizedPnl
The unrealized profit or loss for this position relative to the previous close When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> dailyUnrealizedPnlPct
The unrealized profit/loss for the position for the current day, expressed as a percentage of the baseline value (range: 0-100). When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> instrumentPrice
The current market price of the instrument When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> underlyingInstrumentId
Identifier of the underlying instrument, when available When a null/undefined value is observed, it indicates it does not apply.
class PositionInstruction:
A position instruction and its current lifecycle state.
String clientInstructionId
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
PositionInstructionType instructionType
PositionInstructionStatus status
Optional<String> acceptedQuantity
Number of contracts accepted by the clearing venue. Populated once
the instruction reaches ACCEPTED.
When a null/undefined value is observed, it indicates that there is no available data.
Optional<LocalDateTime> createdAt
When the instruction was first accepted by the service. When a null/undefined value is observed, it indicates that there is no available data.
Machine-readable counterpart to rejection_reason: a stable reason code,
human-readable description, and params, present on every rejected row —
on submit, cancel, get, and list alike. Branch on rejection.reason and
read rejection.description instead of the top-level rejection_reason.
When a null/undefined value is observed, it indicates it does not apply.
String description
Human-readable explanation of the rejection. Duplicates the top-level
rejection_reason; prefer this field.
String domain
Namespacing domain of the reason code — com.clearstreet.oems.exercise
for reasons OEMS validates, com.clearstreet.oems.clearing for
clearing-owned reasons.
Metadata metadata
Reason-specific parameters as a string→string map. Which keys are present
depends on reason:
INSUFFICIENT_POSITION→available,requestedDNE_NOT_ON_EXPIRY/CEA_NOT_ON_EXPIRY→expiry,business_dateEXERCISE_PAST_CUTOFF→cutoff_timeDUPLICATE_INSTRUCTION→existing_id
Empty for reasons that carry no parameters. New keys may be added over time, so treat unknown keys leniently.
Optional<String> rejectionReason
Human-readable explanation populated on any non-success terminal
status — REJECTED or CANCEL_FAILED. On a
207 Multi-Status batch submit the top-level error field
summarizes the batch; per-row detail continues to live here.
When a null/undefined value is observed, it indicates it does not apply.
class PositionInstructionRejection:
Machine-readable detail for a rejected position instruction.
Present on every rejected row, across the full lifecycle — submit, cancel,
get, and list. Branch on reason for programmatic handling and template your
own copy from metadata, or show description directly.
String description
Human-readable explanation of the rejection. Duplicates the top-level
rejection_reason; prefer this field.
String domain
Namespacing domain of the reason code — com.clearstreet.oems.exercise
for reasons OEMS validates, com.clearstreet.oems.clearing for
clearing-owned reasons.
Metadata metadata
Reason-specific parameters as a string→string map. Which keys are present
depends on reason:
INSUFFICIENT_POSITION→available,requestedDNE_NOT_ON_EXPIRY/CEA_NOT_ON_EXPIRY→expiry,business_dateEXERCISE_PAST_CUTOFF→cutoff_timeDUPLICATE_INSTRUCTION→existing_id
Empty for reasons that carry no parameters. New keys may be added over time, so treat unknown keys leniently.
enum PositionInstructionStatus:
Lifecycle status of a position instruction.
SENT: accepted and submitted to the clearing venue.ACCEPTED: terminal — accepted by the clearing venue.REJECTED: terminal rejection;rejection_reasoncarries the detail. Covers both venue-reported rejections and rejections raised before the instruction reached the clearing venue (e.g. duplicateclient_instruction_id,DO_NOT_EXERCISE/CONTRARY_EXERCISEsubmitted on a non-expiry day, insufficient position, or an instrument that does not resolve).CANCEL_REQUESTED: cancel accepted; final cancel state pending.CANCELLED: terminal — cancel completed.CANCEL_FAILED: cancel could not be completed; operator attention required.rejection_reasoncarries the detail.UNKNOWN: status could not be determined.
V1Private Markets
Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.
Get SPV
List every live IOI for the caller's account-holder entity.
Create an IOI for a visible upcoming offering.
Update an IOI's notional, accepting the current NDA revision when required.
Withdraw a live IOI. Repeating a withdrawal returns 404.
Get Company
V1Private MarketsCompanies
ModelsExpand Collapse
class CompanyDetail:
A company’s identity and its complete published profile.
CompanyProfileResource profile
The complete versioned company profile.
Company-level research and source documents.
Historical and estimated metric series.
MetricFrequency frequency
MetricKey metricKey
Canonical metric key.
MetricUnit unit
Ordered observations.
MetricValueType valueType
Social/profile links.
CompanySocialType type
class CompanyDocumentResource:
A company-level research or source document.
class CompanyMetricPoint:
One metric observation.
MetricValueType valueType
class CompanyMetricSeries:
A historical or estimated company metric series.
MetricFrequency frequency
MetricKey metricKey
Canonical metric key.
MetricUnit unit
Ordered observations.
MetricValueType valueType
class CompanyProfileResource:
The complete versioned company profile (schema version one).
Company-level research and source documents.
Historical and estimated metric series.
MetricFrequency frequency
MetricKey metricKey
Canonical metric key.
MetricUnit unit
Ordered observations.
MetricValueType valueType
Social/profile links.
CompanySocialType type
class CompanySocialLink:
A company social/profile link.
CompanySocialType type
V1Private MarketsIois
ModelsExpand Collapse
class IoiListingResource:
IOI list item with the campaign identity needed to render it.
IoiCompanyResource company
IoiOfferingResource offering
class IoiResource:
One live indication of interest.
Currency currency
Terms currency.
V1Private MarketsOfferings
Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.
List Offerings
Get Offering
ModelsExpand Collapse
class OfferingCard:
One offering as it appears in a list: its derived class, indicative terms, a company identity summary, and any attached SPV.
OfferingClass class_
OfferingCompany company
Currency currency
Terms currency.
Attached SPV identity and lifecycle, once one exists.
SpvStatus status
class OfferingDetail:
One offering with everything needed to render its detail payload.
Campaign documents in display order.
OfferingDocumentType documentType
Ordered resolved highlights.
MetricUnit unit
Campaign participants in display order.
ParticipantRole role
class OfferingDocumentResource:
A campaign document’s display metadata. Exactly one of url/object_key
is set; an object key is resolved and signed elsewhere.
OfferingDocumentType documentType
class OfferingHighlight:
A curated highlight, resolved against the company profile’s metric series.
MetricUnit unit
class OfferingParticipantResource:
An offering participant’s display data.
ParticipantRole role
class OfferingSpv:
The attached SPV’s identity and lifecycle. Exact economics surface once the SPV opens; an upcoming offering’s indicative ranges describe the terms until then.
SpvStatus status
V1Private MarketsSpvs
ModelsExpand Collapse
class SpvDetail:
An OPEN SPV’s identity, exact economics, and typed fee schedule.
class SpvFeeTermResource:
One typed SPV fee term.
V1Screener
Search instruments and manage saved screeners.
Search Screener
Get Screeners
Get Screener By ID
Create Screener
Replace Screener
Patch Screener
Delete Screener
Get Screener Catalog
ModelsExpand Collapse
class Catalog:
The complete screener field catalog, serialized as the data payload of
GET /screener/catalog.
List<String> defaultResponseFields
The api_names that resolve to the POST default column set when
columns is omitted.
Enums enums
The enum universes every other section’s values are drawn from.
FieldColumns fields
Struct-of-arrays of the remaining per-field scalars.
List<FieldKind> kinds
The deduplicated (category, format, value_type, combinations, default combination) tuples; fields.kind[i] indexes into this.
List<Combination> combinations
Combination defaultCombination
List<ModifierDef> modifiers
The modifier operations and their legal args forms.
List<ModifierArg> args
The positional args slots, in order.
Rules rules
Request-side semantics for turning the data into a valid call.
String apiNameComposition
Requests and response field objects use the same reference shape:
base name plus at most one of period / lookback;
default_response_fields (the POST default column set when columns
is omitted) carries api_names, each decoding via suffixes.
String axes
At most one of period / lookback; the empty combination selects
the field’s current or most recent value.
List<VariableDef> variables
class FieldKind:
One deduplicated (category, format, value_type, combinations, default combination) tuple; fields.kind[i] indexes into Catalog::kinds.
List<Combination> combinations
Combination defaultCombination
class FilterOpSpec:
Operator specification with optional behavioral arguments.
FilterOperator name
The operator to apply.
class FilterValue:
A filter value: either a literal or a variable reference.
A variable reference.
class Modifier:
Arithmetic modifier applied to a variable value.
ModifierOp name
class ModifierDef:
A modifier operation and the positional args each context accepts.
List<ModifierArg> args
The positional args slots, in order.
class Rules:
Request-side semantics: how to turn the catalog data into a valid
POST /screener call.
String apiNameComposition
Requests and response field objects use the same reference shape:
base name plus at most one of period / lookback;
default_response_fields (the POST default column set when columns
is omitted) carries api_names, each decoding via suffixes.
String axes
At most one of period / lookback; the empty combination selects
the field’s current or most recent value.
class ScreenerColumn:
A single column in the screener search response.
FieldRef field
class ScreenerEntry:
A saved screener configuration entry
List<SearchFilter> filters
FieldRef left
The operator and optional arguments. Omit together with right for an unenabled filter.
FilterOperator name
The operator to apply.
The value(s) to compare against. Omit together with op for an unenabled filter.
A variable reference.
FieldRef field
class SearchFilter:
A single filter condition.
When op and right are both absent, the filter is “unenabled”:
it persists a left field reference without applying any predicate.
Unenabled filters are skipped during search execution but still
round-trip through save/load so callers can preserve draft state.
FieldRef left
The operator and optional arguments. Omit together with right for an unenabled filter.
FilterOperator name
The operator to apply.
The value(s) to compare against. Omit together with op for an unenabled filter.
A variable reference.
class SortSpec:
A sort specification pairing a field with a direction.
FieldRef field
class Variable:
A variable reference (field or built-in like today).
V1Watchlist
Create and manage watchlists.
Get Watchlists
Get Watchlist By ID
Create Watchlist
Delete Watchlist
Add Watchlist Item
Delete Watchlist Item
ModelsExpand Collapse
class WatchlistDetail:
Detailed watchlist with all items
List<WatchlistItemEntry> items
Items in the watchlist
Optional<String> addedPrice
Price when the item was added When a null/undefined value is observed, it indicates that there is no available data.
Instrument details When a null/undefined value is observed, it indicates that there is no available data.
boolean isPtp
Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.
boolean isShortProhibited
Indicates if short selling is prohibited for the instrument. This is a
standing property of the security. For the live Rule 201 circuit
breaker, see short_sale_restricted on the market-data snapshot.
boolean isThresholdSecurity
Indicates if the instrument is on the Regulation SHO Threshold Security List
Optional<String> adv
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> caxAdjustedPreviousClose
Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> longMarginRate
The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> name
The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> notionalAdv
Notional average daily volume (ADV multiplied by the cax-adjusted close when present, the raw previous close otherwise). When a null/undefined value is observed, it indicates that there is no available data.
Available options expiration dates for this instrument, each annotated
with which settlement cycles have listed contracts on it.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
boolean hasSettlesOnClose
Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.
boolean hasSettlesOnOpen
Whether this date has at least one contract that settles on the opening print (AM settlement) and can still be traded. AM-settled contracts stop trading at the close of the business day before settlement, so this turns false before the expiration date arrives. A date leaves the list once no contract on it can be traded in either settlement cycle.
DeprecatedOptional<List<LocalDate>> optionsExpiryDates
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
Deprecated: use options_contract_expiry_dates, which carries the same
dates annotated with settlement-cycle information.
When a null/undefined value is observed, it indicates it does not apply.
Optional<String> previousClose
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> shortMarginRate
The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
class WatchlistItemEntry:
A single item in a watchlist
Optional<String> addedPrice
Price when the item was added When a null/undefined value is observed, it indicates that there is no available data.
Instrument details When a null/undefined value is observed, it indicates that there is no available data.
boolean isPtp
Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.
boolean isShortProhibited
Indicates if short selling is prohibited for the instrument. This is a
standing property of the security. For the live Rule 201 circuit
breaker, see short_sale_restricted on the market-data snapshot.
boolean isThresholdSecurity
Indicates if the instrument is on the Regulation SHO Threshold Security List
Optional<String> adv
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> caxAdjustedPreviousClose
Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> longMarginRate
The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> name
The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> notionalAdv
Notional average daily volume (ADV multiplied by the cax-adjusted close when present, the raw previous close otherwise). When a null/undefined value is observed, it indicates that there is no available data.
Available options expiration dates for this instrument, each annotated
with which settlement cycles have listed contracts on it.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
boolean hasSettlesOnClose
Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.
boolean hasSettlesOnOpen
Whether this date has at least one contract that settles on the opening print (AM settlement) and can still be traded. AM-settled contracts stop trading at the close of the business day before settlement, so this turns false before the expiration date arrives. A date leaves the list once no contract on it can be traded in either settlement cycle.
DeprecatedOptional<List<LocalDate>> optionsExpiryDates
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
Deprecated: use options_contract_expiry_dates, which carries the same
dates annotated with settlement-cycle information.
When a null/undefined value is observed, it indicates it does not apply.
Optional<String> previousClose
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Optional<String> shortMarginRate
The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.