API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

V1

ModelsExpand Collapse

enum SecurityType:

Security type

COMMON_STOCK("COMMON_STOCK")

OPTION("OPTION")

CASH("CASH")

enum SortDirection:

Sort direction sorted results

ASC("ASC")

DESC("DESC")

V1Accounts

Manage trading accounts, balances, and portfolio history.

Get Accounts

AccountGetAccountsResponse v1().accounts().getAccounts(AccountGetAccountsParamsparams = AccountGetAccountsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/accounts

Get Account By ID

AccountGetAccountByIdResponse v1().accounts().getAccountById(AccountGetAccountByIdParamsparams = AccountGetAccountByIdParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/accounts/{account_id}

Patch Account By ID

AccountPatchAccountByIdResponse v1().accounts().patchAccountById(AccountPatchAccountByIdParamsparams = AccountPatchAccountByIdParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

PATCH/v1/accounts/{account_id}

Get Account Balances

AccountGetAccountBalancesResponse v1().accounts().getAccountBalances(AccountGetAccountBalancesParamsparams = AccountGetAccountBalancesParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/accounts/{account_id}/balances

Get Portfolio History

AccountGetPortfolioHistoryResponse v1().accounts().getPortfolioHistory(AccountGetPortfolioHistoryParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/accounts/{account_id}/portfolio-history

ModelsExpand Collapse

class Account:

Represents a trading account

long id

The unique identifier for the account

formatint64

long accountHolderEntityId

The account holder entity identifier

formatint64

String fullName

The full legal name of the account

LocalDate openDate

The date the account was opened

formatdate

long optionsLevel

The options level of the account

formatint64

String shortName

The short name of the account

AccountStatus status

The current status of the account

One of the following:

ACTIVE("ACTIVE")

INACTIVE("INACTIVE")

CLOSED("CLOSED")

AccountSubtype subtype

The sub-type of account

One of the following:

CASH("CASH")

MARGIN("MARGIN")

OTHER("OTHER")

AccountType type

The type of account

One of the following:

CUSTOMER("CUSTOMER")

OTHER("OTHER")

Optional<LocalDate> closeDate

The date the account was closed, if applicable When a null/undefined value is observed, it indicates it does not apply.

formatdate

class AccountBalances:

Represents the balance details for a trading account

long accountId

The unique identifier for the account

formatint64

String buyingPower

The total buying power available in the account.

String currency

Currency identifier for all monetary values.

String dailyChange

Difference between current equity and start-of-day equity.

String dailyPnl

Total profit or loss since start of day.

String dailyRealizedPnl

Realized profit or loss since start of day.

String dailyTotalPnl

Total profit or loss since start of day.

String dailyUnrealizedPnl

Total unrealized profit or loss across all positions relative to prior close.

String equity

The total equity in the account.

String longMarketValue

The total market value of all long positions.

MarginType marginType

The applicable margin model for the account

One of the following:

OTHER("OTHER")

NONE("NONE")

PORTFOLIO_MARGIN("PORTFOLIO_MARGIN")

RISK_BASED_HAIRCUT_BROKER_DEALER("RISK_BASED_HAIRCUT_BROKER_DEALER")

REG_T("REG_T")

RISK_BASED_HAIRCUT_MARKET_MAKER("RISK_BASED_HAIRCUT_MARKET_MAKER")

CIRO("CIRO")

FUTURES_NLV("FUTURES_NLV")

FUTURES_TOT_EQ("FUTURES_TOT_EQ")

String openOrderAdjustment

Signed buying-power correction from open orders.

String settledCash

The amount of cash that is settled and available for withdrawal or trading.

AccountBalancesSod sod

Start-of-day snapshot balances.

String buyingPower

Start-of-day buying power.

String equity

Start-of-day equity.

String longMarketValue

Start-of-day long market value.

String shortMarketValue

Start-of-day short market value.

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.

formatdate

DeprecatedOptional<String> dayTradeBuyingPower

Start-of-day day-trade buying power. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> maintenanceMarginExcess

Start-of-day maintenance margin excess. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> maintenanceMarginRequirement

Start-of-day maintenance margin requirement. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> tradeCash

Start-of-day trade cash. When a null/undefined value is observed, it indicates it does not apply.

String tradeCash

Trade-date effective cash.

String unrealizedPnl

Total unrealized profit or loss across all open positions.

String unsettledCredits

Trade-date unsettled cash credits.

String unsettledDebits

Trade-date unsettled cash debits.

String withdrawableCash

The amount of cash currently available to withdraw.

Optional<MarginDetails> marginDetails

Margin-account-only details. When a null/undefined value is observed, it indicates it does not apply.

Deprecatedlong dayTradeCount

The number of day trades executed over the 5 most recent trading days.

formatint32

minimum0

String initialMarginExcess

Initial margin excess for trade-date balances.

String initialMarginRequirement

Initial margin requirement for trade-date balances.

MarginSessionDetails intradayDetails

Intraday session margin calculation details.

String buyingPower

Maximum buying power available in the account during the session.

Optional<String> multiplier

Effective multiplier for margin calculations during the session.

String maintenanceMarginExcess

Maintenance margin excess for trade-date balances.

String maintenanceMarginRequirement

Maintenance margin requirement for trade-date balances.

MarginSessionDetails overnightDetails

Overnight session margin calculation details.

String buyingPower

Maximum buying power available in the account during the session.

Optional<String> multiplier

Effective multiplier for margin calculations during the session.

Deprecatedboolean patternDayTrader

true if the account is currently flagged as a PDT, otherwise false.

DeprecatedOptional<String> dayTradeBuyingPowerUsage

The amount of day-trade buying power used during the current trading day. When null/undefined, the value should be assumed to be zero. The field is omitted to simplify the response.

Optional<List<MarginTopContributor>> topContributors

Optional top margin contributors, returned only when explicitly requested.

DeprecatedString dayTradeBuyingPowerUsage

Day-trade buying power consumed by fills against this underlying on the current trade date. Populated only for pattern day trader accounts.

String initialMarginRequirement

Initial margin requirement attributable to this underlying.

String maintenanceMarginRequirement

Maintenance margin requirement attributable to this underlying.

String marketValue

Net market value attributable to this underlying.

String underlyingInstrumentId

UUID of the underlying security contributing to margin requirement.

formatuuid

Optional<MarginDetailsUsage> usage

Current usage totals. When a null/undefined value is observed, it indicates that there is no available data.

String total

The total margin available in the current model.

String used

The amount of margin that is currently being utilized.

Optional<String> multiplier

Applied multiplier for margin calculations. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> shortMarketValue

The total market value of all short positions. When null/undefined, the value should be assumed to be zero. The field is omitted to simplify the response.

class AccountBalancesSod:

String buyingPower

Start-of-day buying power.

String equity

Start-of-day equity.

String longMarketValue

Start-of-day long market value.

String shortMarketValue

Start-of-day short market value.

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.

formatdate

DeprecatedOptional<String> dayTradeBuyingPower

Start-of-day day-trade buying power. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> maintenanceMarginExcess

Start-of-day maintenance margin excess. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> maintenanceMarginRequirement

Start-of-day maintenance margin requirement. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> tradeCash

Start-of-day trade cash. When a null/undefined value is observed, it indicates it does not apply.

class AccountSettings:

Optional<RiskSettings> risk

Risk settings for the account When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> maxNotional

The maximum notional value available to the account When a null/undefined value is observed, it indicates that there is no available data.

enum AccountStatus:

Account status

ACTIVE("ACTIVE")

INACTIVE("INACTIVE")

CLOSED("CLOSED")

enum AccountSubtype:

Account subtype classification providing more granular categorization

CASH("CASH")

MARGIN("MARGIN")

OTHER("OTHER")

enum AccountType:

Account type classification

CUSTOMER("CUSTOMER")

OTHER("OTHER")

class MarginDetails:

Deprecatedlong dayTradeCount

The number of day trades executed over the 5 most recent trading days.

formatint32

minimum0

String initialMarginExcess

Initial margin excess for trade-date balances.

String initialMarginRequirement

Initial margin requirement for trade-date balances.

MarginSessionDetails intradayDetails

Intraday session margin calculation details.

String buyingPower

Maximum buying power available in the account during the session.

Optional<String> multiplier

Effective multiplier for margin calculations during the session.

String maintenanceMarginExcess

Maintenance margin excess for trade-date balances.

String maintenanceMarginRequirement

Maintenance margin requirement for trade-date balances.

MarginSessionDetails overnightDetails

Overnight session margin calculation details.

String buyingPower

Maximum buying power available in the account during the session.

Optional<String> multiplier

Effective multiplier for margin calculations during the session.

Deprecatedboolean patternDayTrader

true if the account is currently flagged as a PDT, otherwise false.

DeprecatedOptional<String> dayTradeBuyingPowerUsage

The amount of day-trade buying power used during the current trading day. When null/undefined, the value should be assumed to be zero. The field is omitted to simplify the response.

Optional<List<MarginTopContributor>> topContributors

Optional top margin contributors, returned only when explicitly requested.

DeprecatedString dayTradeBuyingPowerUsage

Day-trade buying power consumed by fills against this underlying on the current trade date. Populated only for pattern day trader accounts.

String initialMarginRequirement

Initial margin requirement attributable to this underlying.

String maintenanceMarginRequirement

Maintenance margin requirement attributable to this underlying.

String marketValue

Net market value attributable to this underlying.

String underlyingInstrumentId

UUID of the underlying security contributing to margin requirement.

formatuuid

Optional<MarginDetailsUsage> usage

Current usage totals. When a null/undefined value is observed, it indicates that there is no available data.

String total

The total margin available in the current model.

String used

The amount of margin that is currently being utilized.

class MarginDetailsUsage:

String total

The total margin available in the current model.

String used

The amount of margin that is currently being utilized.

class MarginSessionDetails:

String buyingPower

Maximum buying power available in the account during the session.

Optional<String> multiplier

Effective multiplier for margin calculations during the session.

class MarginTopContributor:

DeprecatedString dayTradeBuyingPowerUsage

Day-trade buying power consumed by fills against this underlying on the current trade date. Populated only for pattern day trader accounts.

String initialMarginRequirement

Initial margin requirement attributable to this underlying.

String maintenanceMarginRequirement

Maintenance margin requirement attributable to this underlying.

String marketValue

Net market value attributable to this underlying.

String underlyingInstrumentId

UUID of the underlying security contributing to margin requirement.

formatuuid

enum MarginType:

An account’s margin type

OTHER("OTHER")

NONE("NONE")

PORTFOLIO_MARGIN("PORTFOLIO_MARGIN")

RISK_BASED_HAIRCUT_BROKER_DEALER("RISK_BASED_HAIRCUT_BROKER_DEALER")

REG_T("REG_T")

RISK_BASED_HAIRCUT_MARKET_MAKER("RISK_BASED_HAIRCUT_MARKET_MAKER")

CIRO("CIRO")

FUTURES_NLV("FUTURES_NLV")

FUTURES_TOT_EQ("FUTURES_TOT_EQ")

class PortfolioHistoryResponse:

List<PortfolioHistorySegment> segments

LocalDate date

The date for this segment

formatdate

String eodEquity

The equity at the end of the trading day.

String realizedPnl

Sum of the profit and loss realized from position closing trading activity.

String sodEquity

The equity at the start of the trading day.

String unrealizedPnl

Sum of the profit and loss from market changes.

Optional<String> boughtNotional

Amount bought MTM

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

Optional<String> positionPnl

P&L attributable to start-of-day (carried) positions from market movement during this trading day.

Optional<String> soldNotional

Amount sold MTM

class PortfolioHistorySegment:

LocalDate date

The date for this segment

formatdate

String eodEquity

The equity at the end of the trading day.

String realizedPnl

Sum of the profit and loss realized from position closing trading activity.

String sodEquity

The equity at the start of the trading day.

String unrealizedPnl

Sum of the profit and loss from market changes.

Optional<String> boughtNotional

Amount bought MTM

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

Optional<String> positionPnl

P&L attributable to start-of-day (carried) positions from market movement during this trading day.

Optional<String> soldNotional

Amount sold MTM

class RiskSettings:

Risk settings for an account

Optional<String> maxNotional

The maximum notional value available to the account When a null/undefined value is observed, it indicates that there is no available data.

V1API Version

Endpoints for API service metadata.

Get the API version.

ApiVersionGetVersionResponse v1().apiVersion().getVersion(ApiVersionGetVersionParamsparams = ApiVersionGetVersionParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/version

ModelsExpand Collapse

class Version:

API version information

String version

API version string

V1Calendar

Access clocks and financial calendars for market sessions and events.

Get Clock

CalendarGetClockResponse v1().calendar().getClock(CalendarGetClockParamsparams = CalendarGetClockParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/clock

Get Market Hours Calendar.

CalendarGetMarketHoursCalendarResponse v1().calendar().getMarketHoursCalendar(CalendarGetMarketHoursCalendarParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/calendars/market-hours

ModelsExpand Collapse

class ClockDetail:

Current server time and market clock information

LocalDateTime clock

Current server time in UTC

formatdate-time

enum DayType:

Day type for market hours - indicates the type of trading day

TRADING_DAY("TRADING_DAY")

EARLY_CLOSE("EARLY_CLOSE")

HOLIDAY("HOLIDAY")

WEEKEND("WEEKEND")

class MarketHoursDetail:

Comprehensive market hours information for a specific market and date

LocalDateTime currentTime

Current time in market timezone with offset

formatdate-time

LocalDate date

The date for which market hours are provided

formatdate

MarketType market

Market type identifier

One of the following:

US_EQUITIES("us_equities")

US_OPTIONS("us_options")

String marketName

Human-readable market name

TradingSessions nextSessions

Next trading day’s session schedules (without time_until fields)

Optional<SessionSchedule> afterHours

After-hours session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> preMarket

Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> regular

Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

MarketStatus status

Market status information

DayType dayType

The type of trading day

One of the following:

TRADING_DAY("TRADING_DAY")

EARLY_CLOSE("EARLY_CLOSE")

HOLIDAY("HOLIDAY")

WEEKEND("WEEKEND")

boolean isOpen

Whether the market is currently open (real-time)

Optional<MarketSessionType> currentSession

Current session type if market is open, null if closed When a null/undefined value is observed, it indicates it does not apply.

One of the following:

PRE_MARKET("pre_market")

REGULAR("regular")

AFTER_HOURS("after_hours")

String timezone

IANA timezone identifier for the market

TradingSessions todaySessions

Trading session schedules for the requested date with time_until fields

Optional<SessionSchedule> afterHours

After-hours session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> preMarket

Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> regular

Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

enum MarketSessionType:

Session type for market hours

PRE_MARKET("pre_market")

REGULAR("regular")

AFTER_HOURS("after_hours")

class MarketStatus:

Market status information

DayType dayType

The type of trading day

One of the following:

TRADING_DAY("TRADING_DAY")

EARLY_CLOSE("EARLY_CLOSE")

HOLIDAY("HOLIDAY")

WEEKEND("WEEKEND")

boolean isOpen

Whether the market is currently open (real-time)

Optional<MarketSessionType> currentSession

Current session type if market is open, null if closed When a null/undefined value is observed, it indicates it does not apply.

One of the following:

PRE_MARKET("pre_market")

REGULAR("regular")

AFTER_HOURS("after_hours")

enum MarketType:

Market type for market hours calendar endpoint

US_EQUITIES("us_equities")

US_OPTIONS("us_options")

class SessionSchedule:

Session schedule with open and close timestamps

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

class TradingSessions:

Trading sessions for a market day with full timestamps

Optional<SessionSchedule> afterHours

After-hours session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> preMarket

Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> regular

Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

V1Instrument Data

Retrieve instrument analytics, market data, news, and related reference data.

Get All Instrument Events

InstrumentDataGetAllInstrumentEventsResponse v1().instrumentData().getAllInstrumentEvents(InstrumentDataGetAllInstrumentEventsParamsparams = InstrumentDataGetAllInstrumentEventsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/instruments/events

Get Instrument Events

InstrumentDataGetInstrumentEventsResponse v1().instrumentData().getInstrumentEvents(InstrumentDataGetInstrumentEventsParamsparams = InstrumentDataGetInstrumentEventsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/instruments/{instrument_id}/events

Get Instrument Fundamentals

InstrumentDataGetInstrumentFundamentalsResponse v1().instrumentData().getInstrumentFundamentals(InstrumentDataGetInstrumentFundamentalsParamsparams = InstrumentDataGetInstrumentFundamentalsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/instruments/{instrument_id}/fundamentals

Get Instrument Balance Sheet Statements

InstrumentDataGetInstrumentBalanceSheetStatementsResponse v1().instrumentData().getInstrumentBalanceSheetStatements(InstrumentDataGetInstrumentBalanceSheetStatementsParamsparams = InstrumentDataGetInstrumentBalanceSheetStatementsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/instruments/{instrument_id}/balance-sheets

Get Instrument Income Statements

InstrumentDataGetInstrumentIncomeStatementsResponse v1().instrumentData().getInstrumentIncomeStatements(InstrumentDataGetInstrumentIncomeStatementsParamsparams = InstrumentDataGetInstrumentIncomeStatementsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/instruments/{instrument_id}/income-statements

Get Instrument Analyst Consensus

InstrumentDataGetInstrumentAnalystConsensusResponse v1().instrumentData().getInstrumentAnalystConsensus(InstrumentDataGetInstrumentAnalystConsensusParamsparams = InstrumentDataGetInstrumentAnalystConsensusParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/instruments/{instrument_id}/analyst-reporting

Get Instrument Cash Flow Statements

InstrumentDataGetInstrumentCashFlowStatementsResponse v1().instrumentData().getInstrumentCashFlowStatements(InstrumentDataGetInstrumentCashFlowStatementsParamsparams = InstrumentDataGetInstrumentCashFlowStatementsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/instruments/{instrument_id}/cash-flow-statements

ModelsExpand Collapse

enum AllEventsEventType:

Event types supported by the all-events endpoint.

EARNINGS("EARNINGS")

DIVIDEND("DIVIDEND")

STOCK_SPLIT("STOCK_SPLIT")

IPO("IPO")

class AnalystDistribution:

Analyst recommendation distribution

long buy

Number of buy recommendations

formatint64

long hold

Number of hold recommendations

formatint64

long sell

Number of sell recommendations

formatint64

long strongBuy

Number of strong buy recommendations

formatint64

long strongSell

Number of strong sell recommendations

formatint64

enum AnalystRating:

Analyst rating category

STRONG_BUY("STRONG_BUY")

BUY("BUY")

HOLD("HOLD")

SELL("SELL")

STRONG_SELL("STRONG_SELL")

enum FiscalPeriodType:

Fiscal period type for earnings reports

QUARTERLY("QUARTERLY")

ANNUAL("ANNUAL")

TTM("TTM")

BIANNUAL("BIANNUAL")

class InstrumentAllEventsData:

All-events payload grouped by date.

List<InstrumentEventsByDate> eventDates

Events grouped by date in descending order.

LocalDate date

Event date.

formatdate

List<InstrumentEventEnvelope> events

Flat event envelopes for this date.

String symbol

Symbol associated with the event.

AllEventsEventType type

Event type discriminator.

One of the following:

EARNINGS("EARNINGS")

DIVIDEND("DIVIDEND")

STOCK_SPLIT("STOCK_SPLIT")

IPO("IPO")

Optional<InstrumentDividendEvent> dividendEventData

Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.

String adjustedDividendAmount

The adjusted dividend amount accounting for any splits.

LocalDate exDate

The day the stock starts trading without the right to receive that dividend.

formatdate

Optional<LocalDate> declarationDate

The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.

formatdate

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.

Optional<LocalDate> paymentDate

The payment date is the date on which a declared stock dividend is scheduled to be paid. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

Optional<LocalDate> recordDate

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. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

Optional<InstrumentEarnings> earningsEventData

Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.

LocalDate date

The date when the earnings report was published

formatdate

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> revenueEstimate

The estimated total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> revenueSurprisePercent

The percentage difference between actual and estimated revenue 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.

formatuuid

Optional<InstrumentEventIpoItem> ipoEventData

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.

formatdate-time

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> priceRange

IPO price range. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> shares

IPO shares offered. 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.

Optional<InstrumentSplitEvent> stockSplitEventData

Stock split payload when type is STOCK_SPLIT. When a null/undefined value is observed, it indicates it does not apply.

LocalDate date

The date of the stock split

formatdate

String denominator

The denominator of the split ratio

String numerator

The numerator of the split ratio

String splitType

The type of stock split (e.g., “stock-split”, “stock-dividend”, “bonus-issue”)

class InstrumentAnalystConsensus:

Aggregated analyst consensus metrics

LocalDate date

The date the consensus snapshot was generated

formatdate

Optional<AnalystDistribution> distribution

Count of individual analyst recommendations by category When a null/undefined value is observed, it indicates that there is no available data.

long buy

Number of buy recommendations

formatint64

long hold

Number of hold recommendations

formatint64

long sell

Number of sell recommendations

formatint64

long strongBuy

Number of strong buy recommendations

formatint64

long strongSell

Number of strong sell recommendations

formatint64

Optional<PriceTarget> priceTarget

Aggregated analyst price target statistics When a null/undefined value is observed, it indicates that there is no available data.

String average

Average analyst price target

String currency

ISO 4217 currency code of the price targets

String high

Highest analyst price target

String low

Lowest analyst price target

Optional<AnalystRating> rating

Consensus analyst rating When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

STRONG_BUY("STRONG_BUY")

BUY("BUY")

HOLD("HOLD")

SELL("SELL")

STRONG_SELL("STRONG_SELL")

class InstrumentBalanceSheetStatement:

A quarterly balance sheet statement for an instrument.

LocalDateTime acceptedDate

The date and time when the filing was accepted by the SEC

formatdate-time

LocalDate filingDate

The date the financial statement was filed

formatdate

String period

The fiscal period identifier (e.g., “Q1”, “Q2”, “Q3”, “Q4”)

FiscalPeriodType periodType

The type of fiscal period

One of the following:

QUARTERLY("QUARTERLY")

ANNUAL("ANNUAL")

TTM("TTM")

BIANNUAL("BIANNUAL")

String reportedCurrency

The currency in which the statement is reported (ISO 4217)

long year

The fiscal year of the statement

formatint32

Optional<String> accountPayables

Account payables

Optional<String> accountsReceivables

Accounts receivables

Optional<String> accruedExpenses

Accrued expenses

Optional<String> accumulatedOtherComprehensiveIncomeLoss

Accumulated other comprehensive income/loss

Optional<String> additionalPaidInCapital

Additional paid-in capital

Optional<String> capitalLeaseObligations

Capital lease obligations (total)

Optional<String> capitalLeaseObligationsCurrent

Capital lease obligations (current portion)

Optional<String> cashAndCashEquivalents

Cash and cash equivalents

Optional<String> cashAndShortTermInvestments

Cash and short-term investments combined

Optional<String> commonStock

Common stock

Optional<String> deferredRevenue

Deferred revenue

Optional<String> deferredRevenueNonCurrent

Deferred revenue (non-current)

Optional<String> deferredTaxLiabilitiesNonCurrent

Deferred tax liabilities (non-current)

Optional<String> goodwill

Goodwill

Optional<String> goodwillAndIntangibleAssets

Goodwill and intangible assets combined

Optional<String> intangibleAssets

Intangible assets

Optional<String> inventory

Inventory

Optional<String> longTermDebt

Long-term debt

Optional<String> longTermInvestments

Long-term investments

Optional<String> minorityInterest

Minority interest

Optional<String> netDebt

Net debt (total debt minus cash)

Optional<String> netReceivables

Net receivables

Optional<String> otherAssets

Other assets

Optional<String> otherCurrentAssets

Other current assets

Optional<String> otherCurrentLiabilities

Other current liabilities

Optional<String> otherLiabilities

Other liabilities

Optional<String> otherNonCurrentAssets

Other non-current assets

Optional<String> otherNonCurrentLiabilities

Other non-current liabilities

Optional<String> otherPayables

Other payables

Optional<String> otherReceivables

Other receivables

Optional<String> otherTotalStockholdersEquity

Other total stockholders equity

Optional<String> preferredStock

Preferred stock

Optional<String> prepaids

Prepaids

Optional<String> propertyPlantAndEquipmentNet

Property, plant and equipment net of depreciation

Optional<String> retainedEarnings

Retained earnings

Optional<String> shortTermDebt

Short-term debt

Optional<String> shortTermInvestments

Short-term investments

Optional<String> taxAssets

Tax assets

Optional<String> taxPayables

Tax payables

Optional<String> totalAssets

Total assets

Optional<String> totalCurrentAssets

Total current assets

Optional<String> totalCurrentLiabilities

Total current liabilities

Optional<String> totalDebt

Total debt

Optional<String> totalEquity

Total equity

Optional<String> totalInvestments

Total investments

Optional<String> totalLiabilities

Total liabilities

Optional<String> totalLiabilitiesAndTotalEquity

Total liabilities and total equity

Optional<String> totalNonCurrentAssets

Total non-current assets

Optional<String> totalNonCurrentLiabilities

Total non-current liabilities

Optional<String> totalPayables

Total payables

Optional<String> totalStockholdersEquity

Total stockholders equity

Optional<String> treasuryStock

Treasury stock

class InstrumentCashFlowStatement:

A quarterly cash flow statement for an instrument.

LocalDateTime acceptedDate

The date and time when the filing was accepted by the SEC

formatdate-time

LocalDate filingDate

The date the financial statement was filed

formatdate

String period

The fiscal period identifier (e.g., “Q1”, “Q2”, “Q3”, “Q4”)

FiscalPeriodType periodType

The type of fiscal period

One of the following:

QUARTERLY("QUARTERLY")

ANNUAL("ANNUAL")

TTM("TTM")

BIANNUAL("BIANNUAL")

String reportedCurrency

The currency in which the statement is reported (ISO 4217)

long year

The fiscal year of the statement

formatint32

Optional<String> accountsPayables

Change in accounts payables

Optional<String> accountsReceivables

Change in accounts receivables

Optional<String> acquisitionsNet

Net acquisitions

Optional<String> capitalExpenditure

Capital expenditure

Optional<String> cashAtBeginningOfPeriod

Cash and cash equivalents at beginning of period

Optional<String> cashAtEndOfPeriod

Cash and cash equivalents at end of period

Optional<String> changeInWorkingCapital

Change in working capital

Optional<String> commonDividendsPaid

Common dividends paid

Optional<String> commonStockIssuance

Common stock issuance

Optional<String> commonStockRepurchased

Common stock repurchased (buybacks)

Optional<String> deferredIncomeTax

Deferred income tax expense

Optional<String> depreciationAndAmortization

Depreciation and amortization expense

Optional<String> effectOfForexChangesOnCash

Effect of foreign exchange changes on cash

Optional<String> freeCashFlow

Free cash flow (operating cash flow minus capital expenditure)

Optional<String> incomeTaxesPaid

Income taxes paid

Optional<String> interestPaid

Interest paid

Optional<String> inventory

Change in inventory

Optional<String> investmentsInPropertyPlantAndEquipment

Investments in property, plant, and equipment

Optional<String> longTermNetDebtIssuance

Long-term net debt issuance

Optional<String> netCashProvidedByFinancingActivities

Net cash provided by financing activities

Optional<String> netCashProvidedByInvestingActivities

Net cash provided by investing activities

Optional<String> netCashProvidedByOperatingActivities

Net cash provided by operating activities

Optional<String> netChangeInCash

Net change in cash during the period

Optional<String> netCommonStockIssuance

Net common stock issuance

Optional<String> netDebtIssuance

Net debt issuance (long-term + short-term)

Optional<String> netDividendsPaid

Net dividends paid (common + preferred)

Optional<String> netIncome

Net income for the period

Optional<String> netPreferredStockIssuance

Net preferred stock issuance

Optional<String> netStockIssuance

Net stock issuance (common + preferred)

Optional<String> operatingCashFlow

Operating cash flow (alternative calculation)

Optional<String> otherFinancingActivities

Other financing activities

Optional<String> otherInvestingActivities

Other investing activities

Optional<String> otherNonCashItems

Other non-cash items

Optional<String> otherWorkingCapital

Change in other working capital

Optional<String> preferredDividendsPaid

Preferred dividends paid

Optional<String> purchasesOfInvestments

Purchases of investments

Optional<String> salesMaturitiesOfInvestments

Sales and maturities of investments

Optional<String> shortTermNetDebtIssuance

Short-term net debt issuance

Optional<String> stockBasedCompensation

Stock-based compensation expense

class InstrumentDividendEvent:

Represents a dividend event for an instrument

String adjustedDividendAmount

The adjusted dividend amount accounting for any splits.

LocalDate exDate

The day the stock starts trading without the right to receive that dividend.

formatdate

Optional<LocalDate> declarationDate

The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.

formatdate

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.

Optional<LocalDate> paymentDate

The payment date is the date on which a declared stock dividend is scheduled to be paid. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

Optional<LocalDate> recordDate

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. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

class InstrumentEarnings:

Represents instrument earnings data

LocalDate date

The date when the earnings report was published

formatdate

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> revenueEstimate

The estimated total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> revenueSurprisePercent

The percentage difference between actual and estimated revenue When a null/undefined value is observed, it indicates that there is no available data.

class InstrumentEventEnvelope:

Unified envelope for the all-events response.

String symbol

Symbol associated with the event.

AllEventsEventType type

Event type discriminator.

One of the following:

EARNINGS("EARNINGS")

DIVIDEND("DIVIDEND")

STOCK_SPLIT("STOCK_SPLIT")

IPO("IPO")

Optional<InstrumentDividendEvent> dividendEventData

Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.

String adjustedDividendAmount

The adjusted dividend amount accounting for any splits.

LocalDate exDate

The day the stock starts trading without the right to receive that dividend.

formatdate

Optional<LocalDate> declarationDate

The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.

formatdate

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.

Optional<LocalDate> paymentDate

The payment date is the date on which a declared stock dividend is scheduled to be paid. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

Optional<LocalDate> recordDate

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. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

Optional<InstrumentEarnings> earningsEventData

Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.

LocalDate date

The date when the earnings report was published

formatdate

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> revenueEstimate

The estimated total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> revenueSurprisePercent

The percentage difference between actual and estimated revenue 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.

formatuuid

Optional<InstrumentEventIpoItem> ipoEventData

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.

formatdate-time

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> priceRange

IPO price range. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> shares

IPO shares offered. 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.

Optional<InstrumentSplitEvent> stockSplitEventData

Stock split payload when type is STOCK_SPLIT. When a null/undefined value is observed, it indicates it does not apply.

LocalDate date

The date of the stock split

formatdate

String denominator

The denominator of the split ratio

String numerator

The numerator of the split ratio

String splitType

The type of stock split (e.g., “stock-split”, “stock-dividend”, “bonus-issue”)

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.

formatdate-time

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> priceRange

IPO price range. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> shares

IPO shares offered. When a null/undefined value is observed, it indicates that there is no available data.

class InstrumentEventsByDate:

Instrument events for a single date.

LocalDate date

Event date.

formatdate

List<InstrumentEventEnvelope> events

Flat event envelopes for this date.

String symbol

Symbol associated with the event.

AllEventsEventType type

Event type discriminator.

One of the following:

EARNINGS("EARNINGS")

DIVIDEND("DIVIDEND")

STOCK_SPLIT("STOCK_SPLIT")

IPO("IPO")

Optional<InstrumentDividendEvent> dividendEventData

Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.

String adjustedDividendAmount

The adjusted dividend amount accounting for any splits.

LocalDate exDate

The day the stock starts trading without the right to receive that dividend.

formatdate

Optional<LocalDate> declarationDate

The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.

formatdate

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.

Optional<LocalDate> paymentDate

The payment date is the date on which a declared stock dividend is scheduled to be paid. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

Optional<LocalDate> recordDate

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. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

Optional<InstrumentEarnings> earningsEventData

Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.

LocalDate date

The date when the earnings report was published

formatdate

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> revenueEstimate

The estimated total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> revenueSurprisePercent

The percentage difference between actual and estimated revenue 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.

formatuuid

Optional<InstrumentEventIpoItem> ipoEventData

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.

formatdate-time

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> priceRange

IPO price range. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> shares

IPO shares offered. 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.

Optional<InstrumentSplitEvent> stockSplitEventData

Stock split payload when type is STOCK_SPLIT. When a null/undefined value is observed, it indicates it does not apply.

LocalDate date

The date of the stock split

formatdate

String denominator

The denominator of the split ratio

String numerator

The numerator of the split ratio

String splitType

The type of stock split (e.g., “stock-split”, “stock-dividend”, “bonus-issue”)

class InstrumentEventsData:

Grouped instrument events by type

List<InstrumentDividendEvent> dividends

Dividend distribution events

String adjustedDividendAmount

The adjusted dividend amount accounting for any splits.

LocalDate exDate

The day the stock starts trading without the right to receive that dividend.

formatdate

Optional<LocalDate> declarationDate

The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.

formatdate

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.

Optional<LocalDate> paymentDate

The payment date is the date on which a declared stock dividend is scheduled to be paid. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

Optional<LocalDate> recordDate

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. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

List<InstrumentEarnings> earnings

Earnings announcement events

LocalDate date

The date when the earnings report was published

formatdate

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> revenueEstimate

The estimated total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> revenueSurprisePercent

The percentage difference between actual and estimated revenue When a null/undefined value is observed, it indicates that there is no available data.

String instrumentId

Instrument identifier

formatuuid

List<InstrumentSplitEvent> splits

Stock split events

LocalDate date

The date of the stock split

formatdate

String denominator

The denominator of the split ratio

String numerator

The numerator of the split ratio

String splitType

The type of stock split (e.g., “stock-split”, “stock-dividend”, “bonus-issue”)

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 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.

formatint64

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.

formatdate

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.

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.

Optional<String> sector

The business sector of the instrument’s issuer When a null/undefined value is observed, it indicates that there is no available data.

class InstrumentIncomeStatement:

A quarterly income statement for an instrument.

LocalDateTime acceptedDate

The date and time when the filing was accepted by the SEC

formatdate-time

LocalDate filingDate

The date the financial statement was filed

formatdate

String period

The fiscal period identifier (e.g., “Q1”, “Q2”, “Q3”, “Q4”)

FiscalPeriodType periodType

The type of fiscal period

One of the following:

QUARTERLY("QUARTERLY")

ANNUAL("ANNUAL")

TTM("TTM")

BIANNUAL("BIANNUAL")

String reportedCurrency

The currency in which the statement is reported (ISO 4217)

long year

The fiscal year of the statement

formatint32

Optional<String> bottomLineNetIncome

Bottom line net income after all adjustments

Optional<String> costAndExpenses

Total costs and expenses

Optional<String> costOfRevenue

Direct costs attributable to producing goods sold

Optional<String> depreciationAndAmortization

Depreciation and amortization expenses

Optional<String> ebit

Earnings before interest and taxes

Optional<String> ebitda

Earnings before interest, taxes, depreciation, and amortization

Optional<String> eps

Basic earnings per share

Optional<String> epsDiluted

Diluted earnings per share

Optional<String> generalAndAdministrativeExpenses

General administrative overhead expenses

Optional<String> grossProfit

Revenue minus cost of revenue

Optional<String> incomeBeforeTax

Income before income tax expense

Optional<String> incomeTaxExpense

Income tax expense for the period

Optional<String> interestExpense

Interest paid on debt

Optional<String> interestIncome

Interest earned on investments and cash

Optional<String> netIncome

Total net income for the period

Optional<String> netIncomeDeductions

Deductions from net income

Optional<String> netIncomeFromContinuingOperations

Net income from continuing operations

Optional<String> netIncomeFromDiscontinuedOperations

Net income from discontinued operations

Optional<String> netInterestIncome

Net interest income (interest income minus interest expense)

Optional<String> nonOperatingIncomeExcludingInterest

Non-operating income excluding interest

Optional<String> operatingExpenses

Total operating expenses

Optional<String> operatingIncome

Income from core business operations

Optional<String> otherAdjustmentsToNetIncome

Other adjustments to net income

Optional<String> otherExpenses

Other miscellaneous expenses

Optional<String> researchAndDevelopmentExpenses

Expenditure on research and development activities

Optional<String> revenue

Total revenue from sales of goods and services

Optional<String> sellingAndMarketingExpenses

Expenditure on marketing and sales activities

Optional<String> sellingGeneralAndAdministrativeExpenses

Combined selling, general, and administrative expenses

Optional<String> totalOtherIncomeExpensesNet

Net of other income and expenses

Optional<String> weightedAverageShsOut

Weighted average shares outstanding (basic)

Optional<String> weightedAverageShsOutDil

Weighted average shares outstanding (diluted)

class InstrumentSplitEvent:

Represents a stock split event for an instrument

LocalDate date

The date of the stock split

formatdate

String denominator

The denominator of the split ratio

String numerator

The numerator of the split ratio

String splitType

The type of stock split (e.g., “stock-split”, “stock-dividend”, “bonus-issue”)

class PriceTarget:

Analyst price target statistics

String average

Average analyst price target

String currency

ISO 4217 currency code of the price targets

String high

Highest analyst price target

String low

Lowest analyst price target

V1Instrument DataMarket Data

Retrieve instrument analytics, market data, news, and related reference data.

Get Snapshots

MarketDataGetSnapshotsResponse v1().instrumentData().marketData().getSnapshots(MarketDataGetSnapshotsParamsparams = MarketDataGetSnapshotsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/market-data/snapshot

Get Daily Aggregate Summaries

MarketDataGetDailySummariesResponse v1().instrumentData().marketData().getDailySummaries(MarketDataGetDailySummariesParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/market-data/daily-summary

ModelsExpand Collapse

class DailySummary:

Daily aggregate (OHLV) summary for a single instrument.

Returned by GET /market-data/daily-summary. Every field except instrument_id is Option:

• Unresolvable instrument_id → all other fields None (including symbol).
• Resolvable instrument_id with no realtime cache entry → symbol populated, OHLV/trade_date None.
• trade_date reflects the session the OHLV represents (today during trading hours, the last trading date during weekends/holidays).

String instrumentId

Unique instrument identifier. Always populated; echoes the request ID.

formatuuid

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<String> open

Opening price for the session. 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.

Optional<LocalDate> tradeDate

Session date the OHLV represents, US/Eastern. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

Optional<Long> volume

Session cumulative trading volume. When a null/undefined value is observed, it indicates that there is no available data.

formatint64

class MarketDataSnapshot:

Market data snapshot for a single security.

String instrumentId

Unique instrument identifier.

String symbol

Display symbol for the security.

Optional<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. When a null/undefined value is observed, it indicates that there is no available data.

formatint64

minimum0

Optional<SnapshotGreeks> greeks

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.

String delta

Delta: ∂V/∂S, range [-1, 1].

String gamma

Gamma: ∂²V/∂S².

String iv

Implied volatility, annualized (0.20 == 20%).

String rho

Rho per 1.0 rate point.

String theoPrice

Theoretical option price in USD per share.

String theta

Theta per trading day.

LocalDateTime timestamp

Timestamp when the Greeks were calculated.

formatdate-time

String vega

Vega per 1.0 vol point.

Optional<SnapshotQuote> lastQuote

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.

formatint32

minimum0

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.

formatint32

minimum0

Optional<String> midpoint

Midpoint of bid and ask. Absent when either side is missing. When a null/undefined value is observed, it indicates that there is no available data.

Optional<SnapshotLastTrade> lastTrade

Most recent last-sale trade if available. When a null/undefined value is observed, it indicates that there is no available data.

String price

Most recent last-sale eligible trade price.

long size

Share quantity of the most recent last-sale eligible trade.

formatint32

minimum0

Optional<String> name

Security name if available. When a null/undefined value is observed, it indicates that there is no available data.

Optional<SnapshotSession> session

Session metrics computed from previous close and last trade, if available. When a null/undefined value is observed, it indicates that there is no available data.

String change

Absolute change from previous close to last trade.

String changePercent

Percent change from previous close to last trade.

String previousClose

Previous session close price.

class SnapshotGreeks:

Theoretical price and Greeks for an options snapshot. All values are per share; no contract multiplier is applied.

String delta

Delta: ∂V/∂S, range [-1, 1].

String gamma

Gamma: ∂²V/∂S².

String iv

Implied volatility, annualized (0.20 == 20%).

String rho

Rho per 1.0 rate point.

String theoPrice

Theoretical option price in USD per share.

String theta

Theta per trading day.

LocalDateTime timestamp

Timestamp when the Greeks were calculated.

formatdate-time

String vega

Vega per 1.0 vol point.

class SnapshotLastTrade:

Last-trade fields for a market data snapshot.

String price

Most recent last-sale eligible trade price.

long size

Share quantity of the most recent last-sale eligible trade.

formatint32

minimum0

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.

formatint32

minimum0

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.

formatint32

minimum0

Optional<String> midpoint

Midpoint of bid and ask. Absent when either side is missing. When a null/undefined value is observed, it indicates that there is no available data.

class SnapshotSession:

Session-level pricing metrics for a market data snapshot.

String change

Absolute change from previous close to last trade.

String changePercent

Percent change from previous close to last trade.

String previousClose

Previous session close price.

V1Instrument DataNews

Retrieve instrument analytics, market data, news, and related reference data.

Get News

NewsGetNewsResponse v1().instrumentData().news().getNews(NewsGetNewsParamsparams = NewsGetNewsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/news

ModelsExpand Collapse

class NewsInstrument:

Instrument associated with a news item.

String instrumentId

Instrument identifier.

formatuuid

Optional<String> name

Instrument name/description, if available. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> symbol

Trading symbol, if available. When a null/undefined value is observed, it indicates that there is no available data.

class NewsItem:

A single news item and its associated instruments.

List<NewsInstrument> instruments

Instruments associated with this news item.

String instrumentId

Instrument identifier.

formatuuid

Optional<String> name

Instrument name/description, if available. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> symbol

Trading symbol, if available. When a null/undefined value is observed, it indicates that there is no available data.

NewsType newsType

Classification of the item.

One of the following:

NEWS("NEWS")

PRESS_RELEASE("PRESS_RELEASE")

LocalDateTime publishedAt

The published date/time of the article in UTC.

formatdate-time

String publisher

The publisher or newswire source.

String title

The headline/title of the article.

String url

Canonical URL to the full article.

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.

Optional<String> site

The primary domain/site of the publisher. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> text

The full or excerpted article body. When a null/undefined value is observed, it indicates that there is no available data.

enum NewsType:

News item classification.

NEWS("NEWS")

PRESS_RELEASE("PRESS_RELEASE")

V1Instruments

Retrieve core details and discovery endpoints for tradable instruments.

Get Instruments

InstrumentGetInstrumentsResponse v1().instruments().getInstruments(InstrumentGetInstrumentsParamsparams = InstrumentGetInstrumentsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/instruments

Get Instrument By ID

InstrumentGetInstrumentByIdResponse v1().instruments().getInstrumentById(InstrumentGetInstrumentByIdParamsparams = InstrumentGetInstrumentByIdParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/instruments/{instrument_id}

Search Instruments

InstrumentSearchInstrumentsResponse v1().instruments().searchInstruments(InstrumentSearchInstrumentsParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/instruments/search

Get Option Contracts

InstrumentGetOptionContractsResponse v1().instruments().getOptionContracts(InstrumentGetOptionContractsParamsparams = InstrumentGetOptionContractsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/instruments/options/contracts

ModelsExpand Collapse

enum ContractType:

The type of options contract

CALL("CALL")

PUT("PUT")

enum ExerciseStyle:

The exercise style of an options contract

AMERICAN("AMERICAN")

EUROPEAN("EUROPEAN")

class Instrument:

Represents a tradable financial instrument.

String id

Unique instrument identifier (UUID)

formatuuid

String countryOfIssue

The ISO country code of the instrument’s issue

String currency

The ISO currency code in which the instrument is traded

boolean easyToBorrow

Indicates if the instrument is classified as Easy-To-Borrow

boolean isFractionable

Indicates if the instrument supports fractional-quantity orders

boolean isLiquidationOnly

Indicates if the instrument is liquidation only and cannot be bought

boolean isMarginable

Indicates if the instrument is marginable

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

boolean isThresholdSecurity

Indicates if the instrument is on the Regulation SHO Threshold Security List

boolean isTradable

Indicates if the instrument is tradable

String symbol

The trading symbol for the instrument

String venue

The MIC code of the primary listing venue

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.

DeprecatedOptional<LocalDate> expiry

Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.

formatdate

Optional<SecurityType> instrumentType

The type of security (e.g., Common Stock, ETF) When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

COMMON_STOCK("COMMON_STOCK")

OPTION("OPTION")

CASH("CASH")

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 previous close price). When a null/undefined value is observed, it indicates that there is no available data.

Optional<List<LocalDate>> optionsExpiryDates

Available options expiration dates for this instrument. Present only when include_options_expiry_dates=true in the request. When a null/undefined value is observed, it indicates it does not apply.

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.

DeprecatedOptional<String> strikePrice

Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.

class InstrumentCore:

String id

Unique instrument identifier (UUID)

formatuuid

String countryOfIssue

The ISO country code of the instrument’s issue

String currency

The ISO currency code in which the instrument is traded

boolean easyToBorrow

Indicates if the instrument is classified as Easy-To-Borrow

boolean isFractionable

Indicates if the instrument supports fractional-quantity orders

boolean isLiquidationOnly

Indicates if the instrument is liquidation only and cannot be bought

boolean isMarginable

Indicates if the instrument is marginable

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

boolean isThresholdSecurity

Indicates if the instrument is on the Regulation SHO Threshold Security List

boolean isTradable

Indicates if the instrument is tradable

String symbol

The trading symbol for the instrument

String venue

The MIC code of the primary listing venue

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.

DeprecatedOptional<LocalDate> expiry

Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.

formatdate

Optional<SecurityType> instrumentType

The type of security (e.g., Common Stock, ETF) When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

COMMON_STOCK("COMMON_STOCK")

OPTION("OPTION")

CASH("CASH")

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 previous close price). 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.

DeprecatedOptional<String> strikePrice

Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.

enum ListingType:

The listing type of an options contract

STANDARD("STANDARD")

FLEX("FLEX")

OTC("OTC")

class OptionsContract:

An options contract with options-specific metadata

String id

Instrument identifier

formatuuid

ContractType contractType

Whether this is a CALL or PUT

One of the following:

CALL("CALL")

PUT("PUT")

String currency

ISO currency code

String exchange

MIC code of the primary listing venue

ExerciseStyle exerciseStyle

Exercise style

One of the following:

AMERICAN("AMERICAN")

EUROPEAN("EUROPEAN")

LocalDate expiry

Expiration date

formatdate

boolean isLiquidationOnly

Whether the contract is liquidation-only

boolean isMarginable

Whether the contract is marginable

ListingType listingType

Listing type

One of the following:

STANDARD("STANDARD")

FLEX("FLEX")

OTC("OTC")

String multiplier

Contract multiplier (100 for standard options)

String strikePrice

Strike price

String symbol

OSI symbol (e.g. “AAPL 251219C00150000”)

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.

formatint64

Optional<String> underlyingInstrumentId

Instrument ID of the underlying instrument, when available When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

V1Omni AI

ModelsExpand Collapse

class ActionButton:

Button metadata shared by chart and suggested-actions payloads.

String buttonId

Stable button identifier within the content part.

String label

User-visible label.

Optional<PromptButtonAction> prompt

Follow-up prompt to submit as the next user message. When a null/undefined value is observed, it indicates it does not apply.

String prompt

Prompt text to submit as the next user turn.

Optional<StructuredActionButtonAction> structuredAction

Structured action in the same message to execute on click. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> actionId

UUID of a structured_action content part in the same message. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

class ChartPayload:

Typed chart payload rendered inline in assistant content.

String chartId

Stable chart identifier scoped to the content part.

Optional<List<ActionButton>> actionButtons

Buttons associated with this chart.

String buttonId

Stable button identifier within the content part.

String label

User-visible label.

Optional<PromptButtonAction> prompt

Follow-up prompt to submit as the next user message. When a null/undefined value is observed, it indicates it does not apply.

String prompt

Prompt text to submit as the next user turn.

Optional<StructuredActionButtonAction> structuredAction

Structured action in the same message to execute on click. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> actionId

UUID of a structured_action content part in the same message. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

Optional<DataChart> dataChart

Explicit series-driven chart definition. When a null/undefined value is observed, it indicates it does not apply.

Optional<List<ChartSeries>> series

String name

Optional<List<ChartPoint>> points

String x

double y

class ChartPoint:

Single chart coordinate.

String x

double y

class ChartSeries:

Named data series within a chart.

String name

Optional<List<ChartPoint>> points

String x

double y

class ContentPartChartPayload:

Chart payload content part.

ChartPayload payload

Typed chart payload rendered inline in assistant content.

String chartId

Stable chart identifier scoped to the content part.

Optional<List<ActionButton>> actionButtons

Buttons associated with this chart.

String buttonId

Stable button identifier within the content part.

String label

User-visible label.

Optional<PromptButtonAction> prompt

Follow-up prompt to submit as the next user message. When a null/undefined value is observed, it indicates it does not apply.

String prompt

Prompt text to submit as the next user turn.

Optional<StructuredActionButtonAction> structuredAction

Structured action in the same message to execute on click. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> actionId

UUID of a structured_action content part in the same message. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

Optional<DataChart> dataChart

Explicit series-driven chart definition. When a null/undefined value is observed, it indicates it does not apply.

Optional<List<ChartSeries>> series

String name

Optional<List<ChartPoint>> points

String x

double y

class ContentPartCustomPayload:

Escape-hatch custom payload content part.

JsonValue payload

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.

One of the following:

PrefillOrder

PrefillOrderAction prefillOrder

Prefill an order ticket for user confirmation

One of the following:

PrefillNewOrderAction

ActionType actionType

PrefillCancelOrderAction

ActionType actionType

OpenChart

OpenChartAction openChart

Open a chart for a symbol

String symbol

Trading symbol to chart

Optional<JsonValue> extras

Additional chart configuration (indicators, overlays, etc.) When a null/undefined value is observed, it indicates it does not apply.

Optional<String> timeframe

Chart timeframe (e.g., “1D”, “1W”, “1M”, “3M”, “1Y”, “5Y”) 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

Filter criteria for the screener

String field

Field to filter on (e.g., “market_cap”, “sector”, “price”)

String operator

Comparison operator (e.g., “eq”, “gte”, “lte”, “in”)

JsonValue value

Filter value

Optional<List<String>> columns

Optional field/column selection for screener results. When a null/undefined value is observed, it indicates it does not apply.

DeprecatedOptional<List<String>> fieldFilter

Deprecated: use columns instead. Mirrors columns.

Optional<Long> pageSize

Optional page size. When a null/undefined value is observed, it indicates it does not apply.

formatint32

Optional<String> sortBy

Optional sort field for screener rows. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> sortDirection

Optional sort direction (ASC or DESC). When a null/undefined value is observed, it indicates it does not apply.

OpenEntitlementConsent

OpenEntitlementConsentAction openEntitlementConsent

Open entitlement consent flow

List<long> accountIds

EntitlementAgreementKey agreementKey

Stable entitlement agreement family key.

List<EntitlementCode> entitlementCodes

String reason

String actionId

class ContentPartSuggestedActionsPayload:

Suggested actions payload content part.

SuggestedActionsPayload payload

Suggested follow-up buttons rendered at the end of an assistant message.

Optional<List<ActionButton>> actionButtons

Ordered message-level buttons.

String buttonId

Stable button identifier within the content part.

String label

User-visible label.

Optional<PromptButtonAction> prompt

Follow-up prompt to submit as the next user message. When a null/undefined value is observed, it indicates it does not apply.

String prompt

Prompt text to submit as the next user turn.

Optional<StructuredActionButtonAction> structuredAction

Structured action in the same message to execute on click. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> actionId

UUID of a structured_action content part in the same message. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

class ContentPartTextPayload:

Text content part.

String text

class ContentPartThinkingPayload:

Thinking content part shown on dynamic response polling.

List<String> thoughts

class DataChart:

Chart represented by explicit data series.

Optional<List<ChartSeries>> series

String name

Optional<List<ChartPoint>> points

String x

double y

enum EntitlementAgreementKey:

Stable entitlement agreement family key.

OMNI_ACCOUNT_DATA_ACCESS("omni_account_data_access")

enum EntitlementCode:

Stable entitlement code granted by an agreement.

OMNI_ACCOUNT_DATA("omni.account_data")

class OpenChartAction:

Action to open a chart for a symbol.

String symbol

Trading symbol to chart

Optional<JsonValue> extras

Additional chart configuration (indicators, overlays, etc.) When a null/undefined value is observed, it indicates it does not apply.

Optional<String> timeframe

Chart timeframe (e.g., “1D”, “1W”, “1M”, “3M”, “1Y”, “5Y”) 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.

List<long> accountIds

EntitlementAgreementKey agreementKey

Stable entitlement agreement family key.

List<EntitlementCode> entitlementCodes

String reason

class OpenScreenerAction:

Action to open a stock screener with filters.

List<ScreenerFilter> filters

Filter criteria for the screener

String field

Field to filter on (e.g., “market_cap”, “sector”, “price”)

String operator

Comparison operator (e.g., “eq”, “gte”, “lte”, “in”)

JsonValue value

Filter value

Optional<List<String>> columns

Optional field/column selection for screener results. When a null/undefined value is observed, it indicates it does not apply.

DeprecatedOptional<List<String>> fieldFilter

Deprecated: use columns instead. Mirrors columns.

Optional<Long> pageSize

Optional page size. When a null/undefined value is observed, it indicates it does not apply.

formatint32

Optional<String> sortBy

Optional sort field for screener rows. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> sortDirection

Optional sort direction (ASC or DESC). When a null/undefined value is observed, it indicates it does not apply.

class PrefillCancelOrderAction:

Cancel-order prefill action.

List<CancelOrderRequest> orders

Orders to cancel using the same identifiers required by the cancel-order API.

long accountId

Account ID (from path parameter)

formatint64

String orderId

Order ID to cancel (from path parameter)

class PrefillNewOrderAction:

New-order prefill action.

List<NewOrderRequest> orders

Orders to prefill using the same shape accepted by the orders API.

RequestOrderType orderType

Type of order

One of the following:

MARKET("MARKET")

LIMIT("LIMIT")

STOP("STOP")

STOP_LIMIT("STOP_LIMIT")

TRAILING_STOP("TRAILING_STOP")

TRAILING_STOP_LIMIT("TRAILING_STOP_LIMIT")

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

Side of the order

One of the following:

BUY("BUY")

SELL("SELL")

SELL_SHORT("SELL_SHORT")

OTHER("OTHER")

RequestTimeInForce timeInForce

Time in force

One of the following:

DAY("DAY")

GOOD_TILL_CANCEL("GOOD_TILL_CANCEL")

IMMEDIATE_OR_CANCEL("IMMEDIATE_OR_CANCEL")

FILL_OR_KILL("FILL_OR_KILL")

GOOD_TILL_DATE("GOOD_TILL_DATE")

AT_THE_OPENING("AT_THE_OPENING")

AT_THE_CLOSE("AT_THE_CLOSE")

GOOD_TILL_CROSSING("GOOD_TILL_CROSSING")

GOOD_THROUGH_CROSSING("GOOD_THROUGH_CROSSING")

AT_CROSSING("AT_CROSSING")

Optional<String> id

Optional client-provided unique ID (idempotency). Required to be unique per account.

maxLength64

Optional<LocalDateTime> expiresAt

The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE.

formatdate-time

Optional<Boolean> extendedHours

Allow trading outside regular trading hours. Some brokers disallow options outside RTH.

Optional<String> instrumentId

Instrument identifier

formatuuid

Optional<String> limitOffset

Limit offset for trailing stop-limit orders (signed)

Optional<String> limitPrice

Limit price (required for LIMIT and STOP_LIMIT orders)

Optional<PositionEffect> positionEffect

Required for options. Specifies whether the order opens or closes a position.

One of the following:

OPEN("OPEN")

CLOSE("CLOSE")

Optional<String> stopPrice

Stop price (required for STOP and STOP_LIMIT 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.

Optional<String> trailingOffset

Trailing offset amount (required for trailing orders)

Optional<TrailingOffsetType> trailingOffsetType

Trailing offset type (PRICE or PERCENT_BPS)

One of the following:

PRICE("PRICE")

BPS("BPS")

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.

PrefillNewOrderAction

ActionType actionType

PrefillCancelOrderAction

ActionType actionType

class PromptButtonAction:

Prompt-style button behavior.

String prompt

Prompt text to submit as the next user turn.

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

Prefill an order ticket for user confirmation

One of the following:

PrefillNewOrderAction

ActionType actionType

PrefillCancelOrderAction

ActionType actionType

OpenChart

OpenChartAction openChart

Open a chart for a symbol

String symbol

Trading symbol to chart

Optional<JsonValue> extras

Additional chart configuration (indicators, overlays, etc.) When a null/undefined value is observed, it indicates it does not apply.

Optional<String> timeframe

Chart timeframe (e.g., “1D”, “1W”, “1M”, “3M”, “1Y”, “5Y”) 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

Filter criteria for the screener

String field

Field to filter on (e.g., “market_cap”, “sector”, “price”)

String operator

Comparison operator (e.g., “eq”, “gte”, “lte”, “in”)

JsonValue value

Filter value

Optional<List<String>> columns

Optional field/column selection for screener results. When a null/undefined value is observed, it indicates it does not apply.

DeprecatedOptional<List<String>> fieldFilter

Deprecated: use columns instead. Mirrors columns.

Optional<Long> pageSize

Optional page size. When a null/undefined value is observed, it indicates it does not apply.

formatint32

Optional<String> sortBy

Optional sort field for screener rows. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> sortDirection

Optional sort direction (ASC or DESC). When a null/undefined value is observed, it indicates it does not apply.

OpenEntitlementConsent

OpenEntitlementConsentAction openEntitlementConsent

Open entitlement consent flow

List<long> accountIds

EntitlementAgreementKey agreementKey

Stable entitlement agreement family key.

List<EntitlementCode> entitlementCodes

String reason

class StructuredActionButtonAction:

Structured-action button behavior.

Optional<String> actionId

UUID of a structured_action content part in the same message. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

class SuggestedActionsPayload:

Suggested follow-up buttons rendered at the end of an assistant message.

Optional<List<ActionButton>> actionButtons

Ordered message-level buttons.

String buttonId

Stable button identifier within the content part.

String label

User-visible label.

Optional<PromptButtonAction> prompt

Follow-up prompt to submit as the next user message. When a null/undefined value is observed, it indicates it does not apply.

String prompt

Prompt text to submit as the next user turn.

Optional<StructuredActionButtonAction> structuredAction

Structured action in the same message to execute on click. When a null/undefined value is observed, it indicates it does not apply.

Optional<String> actionId

UUID of a structured_action content part in the same message. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

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

EntitlementGetEntitlementsResponse v1().omniAi().entitlements().getEntitlements(EntitlementGetEntitlementsParamsparams = EntitlementGetEntitlementsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/omni-ai/entitlements

Create Entitlements

EntitlementCreateEntitlementsResponse v1().omniAi().entitlements().createEntitlements(EntitlementCreateEntitlementsParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/omni-ai/entitlements

Delete Entitlement

EntitlementDeleteEntitlementResponse v1().omniAi().entitlements().deleteEntitlement(EntitlementDeleteEntitlementParamsparams = EntitlementDeleteEntitlementParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/omni-ai/entitlements/{entitlement_id}

Get Entitlement Agreements

EntitlementGetEntitlementAgreementsResponse v1().omniAi().entitlements().getEntitlementAgreements(EntitlementGetEntitlementAgreementsParamsparams = EntitlementGetEntitlementAgreementsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/omni-ai/entitlement-agreements

ModelsExpand Collapse

class DeleteEntitlementResponse:

String entitlementId

boolean revoked

class EntitlementAgreementResource:

String agreementId

EntitlementAgreementKey agreementKey

Stable entitlement agreement family key.

String documentContent

String documentSha256

List<EntitlementCode> entitlementCodes

String title

long version

class EntitlementResource:

String agreementId

EntitlementCode entitlementCode

Stable entitlement code granted by an agreement.

String entitlementId

String grantedAt

long tradingAccountId

V1Omni AIMessages

Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use account_ids.

Get Message By ID

MessageGetMessageByIdResponse v1().omniAi().messages().getMessageById(MessageGetMessageByIdParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/omni-ai/messages/{message_id}

Submit Feedback

MessageSubmitFeedbackResponse v1().omniAi().messages().submitFeedback(MessageSubmitFeedbackParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/omni-ai/messages/{message_id}/feedback

ModelsExpand Collapse

class CreateFeedbackResponse:

String createdAt

Optional<String> feedbackId

When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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

ResponseGetResponseByIdResponse v1().omniAi().responses().getResponseById(ResponseGetResponseByIdParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/omni-ai/responses/{response_id}

Cancel Response

ResponseCancelResponseResponse v1().omniAi().responses().cancelResponse(ResponseCancelResponseParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/omni-ai/responses/{response_id}

ModelsExpand Collapse

class CancelResponsePayload:

boolean canceled

class ErrorStatus:

Shared sanitized error payload.

String code

String message

Optional<JsonValue> details

When a null/undefined value is observed, it indicates it does not apply.

class Response:

Dynamic pollable response.

String id

ResponseStatus status

Dynamic lifecycle status for a pollable response.

One of the following:

QUEUED("queued")

RUNNING("running")

SUCCEEDED("succeeded")

FAILED("failed")

CANCELED("canceled")

String threadId

String userMessageId

Optional<ResponseContent> content

When a null/undefined value is observed, it indicates that there is no available data.

List<ResponseContentPart> parts

One of the following:

ContentPartText

Type type

ContentPartThinking

Type type

ContentPartStructuredAction

Type type

ContentPartChart

Type type

ContentPartSuggestedActions

Type type

ContentPartCustom

Type type

Optional<ErrorStatus> error

When a null/undefined value is observed, it indicates it does not apply.

String code

String message

Optional<JsonValue> details

When a null/undefined value is observed, it indicates it does not apply.

Optional<String> outputMessageId

When a null/undefined value is observed, it indicates it does not apply.

formatuuid

class ResponseContent:

Dynamic response content container. May include thinking parts.

List<ResponseContentPart> parts

One of the following:

ContentPartText

Type type

ContentPartThinking

Type type

ContentPartStructuredAction

Type type

ContentPartChart

Type type

ContentPartSuggestedActions

Type type

ContentPartCustom

Type type

class ResponseContentPart: A class that can be one of several variants.union

Dynamic content part visible on a pollable response.

ContentPartText

Type type

ContentPartThinking

Type type

ContentPartStructuredAction

Type type

ContentPartChart

Type type

ContentPartSuggestedActions

Type type

ContentPartCustom

Type type

enum ResponseStatus:

Dynamic lifecycle status for a pollable response.

QUEUED("queued")

RUNNING("running")

SUCCEEDED("succeeded")

FAILED("failed")

CANCELED("canceled")

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

ThreadGetThreadsResponse v1().omniAi().threads().getThreads(ThreadGetThreadsParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/omni-ai/threads

Get Thread By ID

ThreadGetThreadByIdResponse v1().omniAi().threads().getThreadById(ThreadGetThreadByIdParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/omni-ai/threads/{thread_id}

Create Thread

ThreadCreateThreadResponse v1().omniAi().threads().createThread(ThreadCreateThreadParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/omni-ai/threads

Get Thread Response

ThreadGetThreadResponseResponse v1().omniAi().threads().getThreadResponse(ThreadGetThreadResponseParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/omni-ai/threads/{thread_id}/response

Get Messages

ThreadGetMessagesResponse v1().omniAi().threads().getMessages(ThreadGetMessagesParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/omni-ai/threads/{thread_id}/messages

Create Message

ThreadCreateMessageResponse v1().omniAi().threads().createMessage(ThreadCreateMessageParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/omni-ai/threads/{thread_id}/messages

ModelsExpand Collapse

class CreateMessageResponse:

Response payload for continuing a thread with a new message.

String responseId

String threadId

String userMessageId

class CreateThreadResponse:

Response payload for thread creation.

String responseId

String threadId

String userMessageId

class Message:

Final immutable message.

String id

MessageContent content

Finalized immutable message content container. Never includes thinking parts.

List<MessageContentPart> parts

One of the following:

ContentPartText

Type type

ContentPartStructuredAction

Type type

ContentPartChart

Type type

ContentPartSuggestedActions

Type type

ContentPartCustom

Type type

String createdAt

MessageOutcome outcome

Immutable terminal outcome for a finalized assistant message.

One of the following:

COMPLETED("completed")

ERRORED("errored")

CANCELED("canceled")

MessageRole role

Finalized message role in the public contract.

One of the following:

USER("USER")

ASSISTANT("ASSISTANT")

long seq

String threadId

Optional<ErrorStatus> error

When a null/undefined value is observed, it indicates it does not apply.

String code

String message

Optional<JsonValue> details

When a null/undefined value is observed, it indicates it does not apply.

class MessageContent:

Finalized immutable message content container. Never includes thinking parts.

List<MessageContentPart> parts

One of the following:

ContentPartText

Type type

ContentPartStructuredAction

Type type

ContentPartChart

Type type

ContentPartSuggestedActions

Type type

ContentPartCustom

Type type

class MessageContentPart: A class that can be one of several variants.union

Final immutable content part visible on persisted messages.

ContentPartText

Type type

ContentPartStructuredAction

Type type

ContentPartChart

Type type

ContentPartSuggestedActions

Type type

ContentPartCustom

Type type

enum MessageOutcome:

Immutable terminal outcome for a finalized assistant message.

COMPLETED("completed")

ERRORED("errored")

CANCELED("canceled")

enum MessageRole:

Finalized message role in the public contract.

USER("USER")

ASSISTANT("ASSISTANT")

class Thread:

Thread metadata returned by list/get thread endpoints.

String id

String createdAt

String title

String updatedAt

V1Orders

Place, monitor, and manage trading orders.

Get Orders

OrderGetOrdersResponse v1().orders().getOrders(OrderGetOrdersParamsparams = OrderGetOrdersParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/accounts/{account_id}/orders

Get Order By ID

OrderGetOrderByIdResponse v1().orders().getOrderById(OrderGetOrderByIdParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/accounts/{account_id}/orders/{order_id}

Submit Orders

OrderSubmitOrdersResponse v1().orders().submitOrders(OrderSubmitOrdersParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/accounts/{account_id}/orders

Replace Order

OrderReplaceOrderResponse v1().orders().replaceOrder(OrderReplaceOrderParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

PATCH/v1/accounts/{account_id}/orders/{order_id}

Cancel Open Order

OrderCancelOpenOrderResponse v1().orders().cancelOpenOrder(OrderCancelOpenOrderParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/accounts/{account_id}/orders/{order_id}

Cancel All Open Orders

OrderCancelAllOpenOrdersResponse v1().orders().cancelAllOpenOrders(OrderCancelAllOpenOrdersParamsparams = OrderCancelAllOpenOrdersParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/accounts/{account_id}/orders

Get Executions

OrderGetExecutionsResponse v1().orders().getExecutions(OrderGetExecutionsParamsparams = OrderGetExecutionsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/accounts/{account_id}/executions

ModelsExpand Collapse

class CancelOrderRequest:

Request to cancel an existing order

Note: In the API, order cancellation is done via DELETE request without a body. The order_id and account_id come from the URL path parameters.

long accountId

Account ID (from path parameter)

formatint64

String orderId

Order ID to cancel (from path parameter)

class Execution:

Represents a single fill of an order for an account.

String id

Unique identifier for this execution report.

formatuuid

String instrumentId

Unique instrument identifier.

formatuuid

String orderId

Identifier of the order this execution belongs to.

formatuuid

String price

Fill price.

String quantity

Filled quantity.

Side side

Side of the fill.

One of the following:

BUY("BUY")

SELL("SELL")

SELL_SHORT("SELL_SHORT")

OTHER("OTHER")

String symbol

Trading symbol.

LocalDateTime transactionTime

Transaction timestamp in nanosecond precision (UTC).

formatdate-time

class NewOrderRequest:

Request to submit a new order (PlaceOrderRequest from spec)

RequestOrderType orderType

Type of order

One of the following:

MARKET("MARKET")

LIMIT("LIMIT")

STOP("STOP")

STOP_LIMIT("STOP_LIMIT")

TRAILING_STOP("TRAILING_STOP")

TRAILING_STOP_LIMIT("TRAILING_STOP_LIMIT")

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

Side of the order

One of the following:

BUY("BUY")

SELL("SELL")

SELL_SHORT("SELL_SHORT")

OTHER("OTHER")

RequestTimeInForce timeInForce

Time in force

One of the following:

DAY("DAY")

GOOD_TILL_CANCEL("GOOD_TILL_CANCEL")

IMMEDIATE_OR_CANCEL("IMMEDIATE_OR_CANCEL")

FILL_OR_KILL("FILL_OR_KILL")

GOOD_TILL_DATE("GOOD_TILL_DATE")

AT_THE_OPENING("AT_THE_OPENING")

AT_THE_CLOSE("AT_THE_CLOSE")

GOOD_TILL_CROSSING("GOOD_TILL_CROSSING")

GOOD_THROUGH_CROSSING("GOOD_THROUGH_CROSSING")

AT_CROSSING("AT_CROSSING")

Optional<String> id

Optional client-provided unique ID (idempotency). Required to be unique per account.

maxLength64

Optional<LocalDateTime> expiresAt

The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE.

formatdate-time

Optional<Boolean> extendedHours

Allow trading outside regular trading hours. Some brokers disallow options outside RTH.

Optional<String> instrumentId

Instrument identifier

formatuuid

Optional<String> limitOffset

Limit offset for trailing stop-limit orders (signed)

Optional<String> limitPrice

Limit price (required for LIMIT and STOP_LIMIT orders)

Optional<PositionEffect> positionEffect

Required for options. Specifies whether the order opens or closes a position.

One of the following:

OPEN("OPEN")

CLOSE("CLOSE")

Optional<String> stopPrice

Stop price (required for STOP and STOP_LIMIT 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.

Optional<String> trailingOffset

Trailing offset amount (required for trailing orders)

Optional<TrailingOffsetType> trailingOffsetType

Trailing offset type (PRICE or PERCENT_BPS)

One of the following:

PRICE("PRICE")

BPS("BPS")

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.

String id

Engine-assigned unique identifier for this order (UUID).

long accountId

Account placing the order

formatint64

String clientOrderId

Client-provided identifier echoed back.

LocalDateTime createdAt

Timestamp when order was created (UTC)

formatdate-time

String filledQuantity

Cumulative filled quantity

String instrumentId

Instrument identifier for the traded instrument.

formatuuid

SecurityType instrumentType

Type of security

One of the following:

COMMON_STOCK("COMMON_STOCK")

OPTION("OPTION")

CASH("CASH")

String leavesQuantity

Remaining unfilled quantity

OrderType orderType

Type of order (MARKET, LIMIT, etc.)

One of the following:

MARKET("MARKET")

LIMIT("LIMIT")

STOP("STOP")

STOP_LIMIT("STOP_LIMIT")

TRAILING_STOP("TRAILING_STOP")

TRAILING_STOP_LIMIT("TRAILING_STOP_LIMIT")

OTHER("OTHER")

String quantity

Total order quantity

Side side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:

BUY("BUY")

SELL("SELL")

SELL_SHORT("SELL_SHORT")

OTHER("OTHER")

OrderStatus status

Current status of the order

One of the following:

PENDING_NEW("PENDING_NEW")

NEW("NEW")

PARTIALLY_FILLED("PARTIALLY_FILLED")

FILLED("FILLED")

CANCELED("CANCELED")

REJECTED("REJECTED")

EXPIRED("EXPIRED")

PENDING_CANCEL("PENDING_CANCEL")

PENDING_REPLACE("PENDING_REPLACE")

REPLACED("REPLACED")

DONE_FOR_DAY("DONE_FOR_DAY")

STOPPED("STOPPED")

SUSPENDED("SUSPENDED")

CALCULATED("CALCULATED")

OTHER("OTHER")

String symbol

Trading symbol

TimeInForce timeInForce

Time in force instruction

One of the following:

DAY("DAY")

GOOD_TILL_CANCEL("GOOD_TILL_CANCEL")

IMMEDIATE_OR_CANCEL("IMMEDIATE_OR_CANCEL")

FILL_OR_KILL("FILL_OR_KILL")

GOOD_TILL_DATE("GOOD_TILL_DATE")

AT_THE_OPENING("AT_THE_OPENING")

AT_THE_CLOSE("AT_THE_CLOSE")

GOOD_TILL_CROSSING("GOOD_TILL_CROSSING")

GOOD_THROUGH_CROSSING("GOOD_THROUGH_CROSSING")

AT_CROSSING("AT_CROSSING")

OTHER("OTHER")

LocalDateTime updatedAt

Timestamp of the most recent update (UTC)

formatdate-time

String venue

MIC code of the venue where the order is routed

Optional<String> averageFillPrice

Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.

Optional<List<String>> details

Contains execution, rejection or cancellation details, if any

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.

formatdate-time

Optional<Boolean> extendedHours

Whether the order is eligible for extended-hours trading.

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<QueueState> queueState

Parent order queue state, present when the order is awaiting release or released. When a null/undefined value is observed, it indicates it does not apply.

One of the following:

AWAITING_RELEASE("AWAITING_RELEASE")

RELEASED("RELEASED")

Optional<LocalDateTime> releasesAt

Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time

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> 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<TrailingOffsetType> trailingOffsetType

Trailing offset type for trailing orders When a null/undefined value is observed, it indicates it does not apply.

One of the following:

PRICE("PRICE")

BPS("BPS")

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 When a null/undefined value is observed, it indicates it does not apply.

Optional<LocalDateTime> trailingWatermarkTs

Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.

formatdate-time

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.

formatuuid

enum OrderStatus:

Order status

PENDING_NEW("PENDING_NEW")

NEW("NEW")

PARTIALLY_FILLED("PARTIALLY_FILLED")

FILLED("FILLED")

CANCELED("CANCELED")

REJECTED("REJECTED")

EXPIRED("EXPIRED")

PENDING_CANCEL("PENDING_CANCEL")

PENDING_REPLACE("PENDING_REPLACE")

REPLACED("REPLACED")

DONE_FOR_DAY("DONE_FOR_DAY")

STOPPED("STOPPED")

SUSPENDED("SUSPENDED")

CALCULATED("CALCULATED")

OTHER("OTHER")

enum OrderType:

Order type

MARKET("MARKET")

LIMIT("LIMIT")

STOP("STOP")

STOP_LIMIT("STOP_LIMIT")

TRAILING_STOP("TRAILING_STOP")

TRAILING_STOP_LIMIT("TRAILING_STOP_LIMIT")

OTHER("OTHER")

enum PositionEffect:

Position effect for options orders

OPEN("OPEN")

CLOSE("CLOSE")

enum QueueState:

Parent order queue or hold state.

AWAITING_RELEASE("AWAITING_RELEASE")

RELEASED("RELEASED")

enum RequestOrderType:

Strict order-type enum for order submission/replacement requests.

MARKET("MARKET")

LIMIT("LIMIT")

STOP("STOP")

STOP_LIMIT("STOP_LIMIT")

TRAILING_STOP("TRAILING_STOP")

TRAILING_STOP_LIMIT("TRAILING_STOP_LIMIT")

enum RequestTimeInForce:

Strict time-in-force enum for order submission/replacement requests.

DAY("DAY")

GOOD_TILL_CANCEL("GOOD_TILL_CANCEL")

IMMEDIATE_OR_CANCEL("IMMEDIATE_OR_CANCEL")

FILL_OR_KILL("FILL_OR_KILL")

GOOD_TILL_DATE("GOOD_TILL_DATE")

AT_THE_OPENING("AT_THE_OPENING")

AT_THE_CLOSE("AT_THE_CLOSE")

GOOD_TILL_CROSSING("GOOD_TILL_CROSSING")

GOOD_THROUGH_CROSSING("GOOD_THROUGH_CROSSING")

AT_CROSSING("AT_CROSSING")

enum Side:

Side of an order

BUY("BUY")

SELL("SELL")

SELL_SHORT("SELL_SHORT")

OTHER("OTHER")

enum TimeInForce:

Time in force

DAY("DAY")

GOOD_TILL_CANCEL("GOOD_TILL_CANCEL")

IMMEDIATE_OR_CANCEL("IMMEDIATE_OR_CANCEL")

FILL_OR_KILL("FILL_OR_KILL")

GOOD_TILL_DATE("GOOD_TILL_DATE")

AT_THE_OPENING("AT_THE_OPENING")

AT_THE_CLOSE("AT_THE_CLOSE")

GOOD_TILL_CROSSING("GOOD_TILL_CROSSING")

GOOD_THROUGH_CROSSING("GOOD_THROUGH_CROSSING")

AT_CROSSING("AT_CROSSING")

OTHER("OTHER")

enum TrailingOffsetType:

Trailing offset type for trailing stop orders.

PRICE("PRICE")

BPS("BPS")

V1Positions

View positions and manage position instructions.

Get Positions

PositionGetPositionsResponse v1().positions().getPositions(PositionGetPositionsParamsparams = PositionGetPositionsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/accounts/{account_id}/positions

Close Positions

PositionClosePositionsResponse v1().positions().closePositions(PositionClosePositionsParamsparams = PositionClosePositionsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/accounts/{account_id}/positions

Close Position

PositionClosePositionResponse v1().positions().closePosition(PositionClosePositionParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/accounts/{account_id}/positions/{instrument_id}

Get Position Instructions

PositionGetPositionInstructionsResponse v1().positions().getPositionInstructions(PositionGetPositionInstructionsParamsparams = PositionGetPositionInstructionsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/accounts/{account_id}/positions/instructions

Submit Position Instructions

PositionSubmitPositionInstructionsResponse v1().positions().submitPositionInstructions(PositionSubmitPositionInstructionsParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/accounts/{account_id}/positions/instructions

Cancel Position Instruction

PositionCancelPositionInstructionResponse v1().positions().cancelPositionInstruction(PositionCancelPositionInstructionParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/accounts/{account_id}/positions/instructions/{instruction_id}

ModelsExpand Collapse

class Position:

Represents a holding of a particular instrument in an account

long accountId

The account this position belongs to

formatint64

String availableQuantity

The quantity of a position that is free to be operated on.

String instrumentId

Unique instrument identifier

formatuuid

SecurityType instrumentType

Type of security

One of the following:

COMMON_STOCK("COMMON_STOCK")

OPTION("OPTION")

CASH("CASH")

String marketValue

The current market value of the position

PositionType positionType

The type of position

One of the following:

LONG("LONG")

SHORT("SHORT")

LONG_CALL("LONG_CALL")

SHORT_CALL("SHORT_CALL")

LONG_PUT("LONG_PUT")

SHORT_PUT("SHORT_PUT")

String quantity

The number of shares or contracts. Can be positive (long) or negative (short)

String symbol

The trading symbol for the instrument

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.

formatdate

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.

formatuuid

Optional<String> unrealizedPnl

The total unrealized profit or loss for this position based on current market value When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> unrealizedPnlPct

The unrealized profit/loss for the position, expressed as a percentage of the position’s cost basis (range: 0-100). When a null/undefined value is observed, it indicates that there is no available data.

class PositionInstruction:

A position instruction and its current lifecycle state.

String id

Server-assigned id. Used as the path parameter on cancel.

formatuuid

long accountId

Account the instruction belongs to.

formatint64

String instructionId

Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.

PositionInstructionType instructionType

The action this instruction requests.

One of the following:

EXERCISE("EXERCISE")

DO_NOT_EXERCISE("DO_NOT_EXERCISE")

CONTRARY_EXERCISE("CONTRARY_EXERCISE")

String instrumentId

Identifier of the options contract this instruction acts on.

formatuuid

String quantity

Number of contracts included in the instruction.

PositionInstructionStatus status

Current lifecycle status.

One of the following:

SENT("SENT")

ACCEPTED("ACCEPTED")

REJECTED("REJECTED")

CANCEL_REQUESTED("CANCEL_REQUESTED")

CANCELLED("CANCELLED")

CANCEL_FAILED("CANCEL_FAILED")

UNKNOWN("UNKNOWN")

String symbol

Options symbol (OSI) for display.

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.

formatdate-time

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.

Optional<LocalDateTime> updatedAt

When the instruction’s lifecycle state last changed. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

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_reason carries the detail. Covers both venue-reported rejections and rejections raised before the instruction reached the clearing venue (e.g. duplicate instruction_id, DO_NOT_EXERCISE / CONTRARY_EXERCISE submitted 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_reason carries the detail.
• UNKNOWN: status could not be determined.

SENT("SENT")

ACCEPTED("ACCEPTED")

REJECTED("REJECTED")

CANCEL_REQUESTED("CANCEL_REQUESTED")

CANCELLED("CANCELLED")

CANCEL_FAILED("CANCEL_FAILED")

UNKNOWN("UNKNOWN")

enum PositionInstructionType:

The action to take against an options position.

EXERCISE("EXERCISE")

DO_NOT_EXERCISE("DO_NOT_EXERCISE")

CONTRARY_EXERCISE("CONTRARY_EXERCISE")

enum PositionType:

Position type classification

LONG("LONG")

SHORT("SHORT")

LONG_CALL("LONG_CALL")

SHORT_CALL("SHORT_CALL")

LONG_PUT("LONG_PUT")

SHORT_PUT("SHORT_PUT")

V1Screener

Search instruments and manage saved screeners.

Search Screener

ScreenerSearchScreenerResponse v1().screener().searchScreener(ScreenerSearchScreenerParamsparams = ScreenerSearchScreenerParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/screener

Get Screeners

ScreenerGetScreenersResponse v1().screener().getScreeners(ScreenerGetScreenersParamsparams = ScreenerGetScreenersParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/saved-screeners

Get Screener By ID

ScreenerGetScreenerByIdResponse v1().screener().getScreenerById(ScreenerGetScreenerByIdParamsparams = ScreenerGetScreenerByIdParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/saved-screeners/{screener_id}

Create Screener

ScreenerCreateScreenerResponse v1().screener().createScreener(ScreenerCreateScreenerParamsparams = ScreenerCreateScreenerParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/saved-screeners

Replace Screener

ScreenerReplaceScreenerResponse v1().screener().replaceScreener(ScreenerReplaceScreenerParamsparams = ScreenerReplaceScreenerParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

PUT/v1/saved-screeners/{screener_id}

Delete Screener

v1().screener().deleteScreener(ScreenerDeleteScreenerParamsparams = ScreenerDeleteScreenerParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/saved-screeners/{screener_id}

ModelsExpand Collapse

enum FieldLookback:

Historical lookback window for price/change fields.

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

enum FieldPeriod:

Reporting period for financial data fields.

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

class FieldRef:

A reference to a screener field.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

Optional reporting period (e.g. quarter or TTM).

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

Optional<FieldType> valueType

The data type of the field value. Present only in responses.

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

enum FieldType:

The data type of a screener field value.

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

class FilterOpSpec:

Operator specification with optional behavioral arguments.

FilterOperator name

The operator to apply.

One of the following:

LESS_THAN("LESS_THAN")

LESS_OR_EQUAL("LESS_OR_EQUAL")

GREATER_THAN("GREATER_THAN")

GREATER_OR_EQUAL("GREATER_OR_EQUAL")

EQUAL("EQUAL")

BETWEEN("BETWEEN")

NOT_BETWEEN("NOT_BETWEEN")

ONE_OF("ONE_OF")

REGEX("REGEX")

BEGINS_WITH("BEGINS_WITH")

ENDS_WITH("ENDS_WITH")

CONTAINS("CONTAINS")

IS_NULL("IS_NULL")

IS_NOT_NULL("IS_NOT_NULL")

Optional<List<OperatorArg>> args

Optional arguments that modify operator behavior.

One of the following:

LEFT_INCLUSIVE("LEFT_INCLUSIVE")

RIGHT_INCLUSIVE("RIGHT_INCLUSIVE")

LEFT_EXCLUSIVE("LEFT_EXCLUSIVE")

RIGHT_EXCLUSIVE("RIGHT_EXCLUSIVE")

CASE_INSENSITIVE("CASE_INSENSITIVE")

enum FilterOperator:

Filter operators supported by the screener.

Abbreviated and lowercase forms are accepted as serde aliases for backward compatibility with earlier API revisions; the canonical wire form is the SCREAMING_SNAKE_CASE rendering.

LESS_THAN("LESS_THAN")

LESS_OR_EQUAL("LESS_OR_EQUAL")

GREATER_THAN("GREATER_THAN")

GREATER_OR_EQUAL("GREATER_OR_EQUAL")

EQUAL("EQUAL")

BETWEEN("BETWEEN")

NOT_BETWEEN("NOT_BETWEEN")

ONE_OF("ONE_OF")

REGEX("REGEX")

BEGINS_WITH("BEGINS_WITH")

ENDS_WITH("ENDS_WITH")

CONTAINS("CONTAINS")

IS_NULL("IS_NULL")

IS_NOT_NULL("IS_NOT_NULL")

class FilterValue:

A filter value: either a literal or a variable reference.

Optional<Value> value

One of the following:

double

String

Optional<Variable> variable

A variable reference.

String name

The variable name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<Modifier> modifier

Optional arithmetic modifier.

List<Arg> args

One of the following:

double

String

ModifierOp name

The modifier operation.

One of the following:

ADD("ADD")

SUBTRACT("SUBTRACT")

Optional<FieldPeriod> period

Optional reporting period.

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

class Modifier:

Arithmetic modifier applied to a variable value.

List<Arg> args

One of the following:

double

String

ModifierOp name

The modifier operation.

One of the following:

ADD("ADD")

SUBTRACT("SUBTRACT")

enum ModifierOp:

Modifier operation applied to a variable.

ADD("ADD")

SUBTRACT("SUBTRACT")

enum OperatorArg:

Argument that modifies operator behavior.

LEFT_INCLUSIVE("LEFT_INCLUSIVE")

RIGHT_INCLUSIVE("RIGHT_INCLUSIVE")

LEFT_EXCLUSIVE("LEFT_EXCLUSIVE")

RIGHT_EXCLUSIVE("RIGHT_EXCLUSIVE")

CASE_INSENSITIVE("CASE_INSENSITIVE")

class ScreenerColumn:

A single column in the screener search response.

FieldRef field

Field reference (same shape as filter/sort field references)

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

Optional reporting period (e.g. quarter or TTM).

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

Optional<FieldType> valueType

The data type of the field value. Present only in responses.

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

String name

Human-readable display name for this field

Optional<Value> value

One of the following:

double

String

Optional<String> type

Value format hint: “CURR_USD”, “PERCENT”, etc. Omitted when not applicable. When a null/undefined value is observed, it indicates it does not apply.

class ScreenerEntry:

A saved screener configuration entry

String id

LocalDateTime createdAt

List<SearchFilter> filters

FieldRef left

The field to filter on.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

Optional reporting period (e.g. quarter or TTM).

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

Optional<FieldType> valueType

The data type of the field value. Present only in responses.

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

Optional<FilterOpSpec> op

The operator and optional arguments. Omit together with right for an unenabled filter.

FilterOperator name

The operator to apply.

One of the following:

LESS_THAN("LESS_THAN")

LESS_OR_EQUAL("LESS_OR_EQUAL")

GREATER_THAN("GREATER_THAN")

GREATER_OR_EQUAL("GREATER_OR_EQUAL")

EQUAL("EQUAL")

BETWEEN("BETWEEN")

NOT_BETWEEN("NOT_BETWEEN")

ONE_OF("ONE_OF")

REGEX("REGEX")

BEGINS_WITH("BEGINS_WITH")

ENDS_WITH("ENDS_WITH")

CONTAINS("CONTAINS")

IS_NULL("IS_NULL")

IS_NOT_NULL("IS_NOT_NULL")

Optional<List<OperatorArg>> args

Optional arguments that modify operator behavior.

One of the following:

LEFT_INCLUSIVE("LEFT_INCLUSIVE")

RIGHT_INCLUSIVE("RIGHT_INCLUSIVE")

LEFT_EXCLUSIVE("LEFT_EXCLUSIVE")

RIGHT_EXCLUSIVE("RIGHT_EXCLUSIVE")

CASE_INSENSITIVE("CASE_INSENSITIVE")

Optional<List<FilterValue>> right

The value(s) to compare against. Omit together with op for an unenabled filter.

Optional<Value> value

One of the following:

double

String

Optional<Variable> variable

A variable reference.

String name

The variable name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<Modifier> modifier

Optional arithmetic modifier.

List<Arg> args

One of the following:

double

String

ModifierOp name

The modifier operation.

One of the following:

ADD("ADD")

SUBTRACT("SUBTRACT")

Optional<FieldPeriod> period

Optional reporting period.

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

String name

LocalDateTime updatedAt

Optional<List<FieldRef>> columns

Field references included when running this screener.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

Optional reporting period (e.g. quarter or TTM).

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

Optional<FieldType> valueType

The data type of the field value. Present only in responses.

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

DeprecatedOptional<List<FieldRef>> fieldFilter

Deprecated: use columns instead. Mirrors columns.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

Optional reporting period (e.g. quarter or TTM).

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

Optional<FieldType> valueType

The data type of the field value. Present only in responses.

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

Optional<List<SortSpec>> sorts

FieldRef field

The field to sort by.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

Optional reporting period (e.g. quarter or TTM).

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

Optional<FieldType> valueType

The data type of the field value. Present only in responses.

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

Optional<SortDirection> direction

Sort direction (defaults to DESC).

One of the following:

ASC("ASC")

DESC("DESC")

class ScreenerFilter:

A single filter criterion for the screener.

String field

Field to filter on (e.g., “market_cap”, “sector”, “price”)

String operator

Comparison operator (e.g., “eq”, “gte”, “lte”, “in”)

JsonValue value

Filter value

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 field to filter on.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

Optional reporting period (e.g. quarter or TTM).

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

Optional<FieldType> valueType

The data type of the field value. Present only in responses.

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

Optional<FilterOpSpec> op

The operator and optional arguments. Omit together with right for an unenabled filter.

FilterOperator name

The operator to apply.

One of the following:

LESS_THAN("LESS_THAN")

LESS_OR_EQUAL("LESS_OR_EQUAL")

GREATER_THAN("GREATER_THAN")

GREATER_OR_EQUAL("GREATER_OR_EQUAL")

EQUAL("EQUAL")

BETWEEN("BETWEEN")

NOT_BETWEEN("NOT_BETWEEN")

ONE_OF("ONE_OF")

REGEX("REGEX")

BEGINS_WITH("BEGINS_WITH")

ENDS_WITH("ENDS_WITH")

CONTAINS("CONTAINS")

IS_NULL("IS_NULL")

IS_NOT_NULL("IS_NOT_NULL")

Optional<List<OperatorArg>> args

Optional arguments that modify operator behavior.

One of the following:

LEFT_INCLUSIVE("LEFT_INCLUSIVE")

RIGHT_INCLUSIVE("RIGHT_INCLUSIVE")

LEFT_EXCLUSIVE("LEFT_EXCLUSIVE")

RIGHT_EXCLUSIVE("RIGHT_EXCLUSIVE")

CASE_INSENSITIVE("CASE_INSENSITIVE")

Optional<List<FilterValue>> right

The value(s) to compare against. Omit together with op for an unenabled filter.

Optional<Value> value

One of the following:

double

String

Optional<Variable> variable

A variable reference.

String name

The variable name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<Modifier> modifier

Optional arithmetic modifier.

List<Arg> args

One of the following:

double

String

ModifierOp name

The modifier operation.

One of the following:

ADD("ADD")

SUBTRACT("SUBTRACT")

Optional<FieldPeriod> period

Optional reporting period.

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

class SortSpec:

A sort specification pairing a field with a direction.

FieldRef field

The field to sort by.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

Optional reporting period (e.g. quarter or TTM).

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

Optional<FieldType> valueType

The data type of the field value. Present only in responses.

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

Optional<SortDirection> direction

Sort direction (defaults to DESC).

One of the following:

ASC("ASC")

DESC("DESC")

class Variable:

A variable reference (field or built-in like today).

String name

The variable name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<Modifier> modifier

Optional arithmetic modifier.

List<Arg> args

One of the following:

double

String

ModifierOp name

The modifier operation.

One of the following:

ADD("ADD")

SUBTRACT("SUBTRACT")

Optional<FieldPeriod> period

Optional reporting period.

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

V1Watchlist

Create and manage watchlists.

Get Watchlists

WatchlistGetWatchlistsResponse v1().watchlist().getWatchlists(WatchlistGetWatchlistsParamsparams = WatchlistGetWatchlistsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/watchlists

Get Watchlist By ID

WatchlistGetWatchlistByIdResponse v1().watchlist().getWatchlistById(WatchlistGetWatchlistByIdParamsparams = WatchlistGetWatchlistByIdParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/watchlists/{watchlist_id}

Create Watchlist

WatchlistCreateWatchlistResponse v1().watchlist().createWatchlist(WatchlistCreateWatchlistParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/watchlists

Delete Watchlist

WatchlistDeleteWatchlistResponse v1().watchlist().deleteWatchlist(WatchlistDeleteWatchlistParamsparams = WatchlistDeleteWatchlistParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/watchlists/{watchlist_id}

Add Watchlist Item

WatchlistAddWatchlistItemResponse v1().watchlist().addWatchlistItem(WatchlistAddWatchlistItemParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/watchlists/{watchlist_id}/items

Delete Watchlist Item

WatchlistDeleteWatchlistItemResponse v1().watchlist().deleteWatchlistItem(WatchlistDeleteWatchlistItemParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/watchlists/{watchlist_id}/items/{item_id}

ModelsExpand Collapse

class AddWatchlistItemData:

Response data for adding a watchlist item

String itemId

ID of the created item

formatuuid

class WatchlistDetail:

Detailed watchlist with all items

String id

Watchlist ID

formatuuid

LocalDateTime createdAt

Creation timestamp

formatdate-time

List<WatchlistItemEntry> items

Items in the watchlist

String id

Item ID

formatuuid

LocalDateTime addedAt

When the item was added

formatdate-time

Optional<String> addedPrice

Price when the item was added When a null/undefined value is observed, it indicates that there is no available data.

Optional<Instrument> instrument

Instrument details When a null/undefined value is observed, it indicates that there is no available data.

String id

Unique instrument identifier (UUID)

formatuuid

String countryOfIssue

The ISO country code of the instrument’s issue

String currency

The ISO currency code in which the instrument is traded

boolean easyToBorrow

Indicates if the instrument is classified as Easy-To-Borrow

boolean isFractionable

Indicates if the instrument supports fractional-quantity orders

boolean isLiquidationOnly

Indicates if the instrument is liquidation only and cannot be bought

boolean isMarginable

Indicates if the instrument is marginable

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

boolean isThresholdSecurity

Indicates if the instrument is on the Regulation SHO Threshold Security List

boolean isTradable

Indicates if the instrument is tradable

String symbol

The trading symbol for the instrument

String venue

The MIC code of the primary listing venue

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.

DeprecatedOptional<LocalDate> expiry

Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.

formatdate

Optional<SecurityType> instrumentType

The type of security (e.g., Common Stock, ETF) When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

COMMON_STOCK("COMMON_STOCK")

OPTION("OPTION")

CASH("CASH")

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 previous close price). When a null/undefined value is observed, it indicates that there is no available data.

Optional<List<LocalDate>> optionsExpiryDates

Available options expiration dates for this instrument. Present only when include_options_expiry_dates=true in the request. When a null/undefined value is observed, it indicates it does not apply.

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.

DeprecatedOptional<String> strikePrice

Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.

String name

Watchlist name

class WatchlistEntry:

Represents a user watchlist.

String id

The unique identifier for the watchlist.

formatuuid

LocalDateTime createdAt

The timestamp when the watchlist was created.

formatdate-time

String name

The user-provided watchlist name.

class WatchlistItemEntry:

A single item in a watchlist

String id

Item ID

formatuuid

LocalDateTime addedAt

When the item was added

formatdate-time

Optional<String> addedPrice

Price when the item was added When a null/undefined value is observed, it indicates that there is no available data.

Optional<Instrument> instrument

Instrument details When a null/undefined value is observed, it indicates that there is no available data.

String id

Unique instrument identifier (UUID)

formatuuid

String countryOfIssue

The ISO country code of the instrument’s issue

String currency

The ISO currency code in which the instrument is traded

boolean easyToBorrow

Indicates if the instrument is classified as Easy-To-Borrow

boolean isFractionable

Indicates if the instrument supports fractional-quantity orders

boolean isLiquidationOnly

Indicates if the instrument is liquidation only and cannot be bought

boolean isMarginable

Indicates if the instrument is marginable

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

boolean isThresholdSecurity

Indicates if the instrument is on the Regulation SHO Threshold Security List

boolean isTradable

Indicates if the instrument is tradable

String symbol

The trading symbol for the instrument

String venue

The MIC code of the primary listing venue

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.

DeprecatedOptional<LocalDate> expiry

Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.

formatdate

Optional<SecurityType> instrumentType

The type of security (e.g., Common Stock, ETF) When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

COMMON_STOCK("COMMON_STOCK")

OPTION("OPTION")

CASH("CASH")

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 previous close price). When a null/undefined value is observed, it indicates that there is no available data.

Optional<List<LocalDate>> optionsExpiryDates

Available options expiration dates for this instrument. Present only when include_options_expiry_dates=true in the request. When a null/undefined value is observed, it indicates it does not apply.

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.

DeprecatedOptional<String> strikePrice

Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.