Skip to content
Clear Street Clear Street
Get started
API Reference

V1

ModelsExpand Collapse
type SecurityType string

Security type

One of the following:
const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"
const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"
const SecurityTypeOption SecurityType = "OPTION"
const SecurityTypeCash SecurityType = "CASH"
const SecurityTypeOther SecurityType = "OTHER"

V1Accounts

Manage trading accounts, balances, and portfolio history.

Get Accounts
client.V1.Accounts.GetAccounts(ctx, query) (*V1AccountGetAccountsResponse, error)
GET/v1/accounts
Get Account By ID
client.V1.Accounts.GetAccountByID(ctx, accountID) (*V1AccountGetAccountByIDResponse, error)
GET/v1/accounts/{account_id}
Patch Account By ID
client.V1.Accounts.PatchAccountByID(ctx, accountID, body) (*V1AccountPatchAccountByIDResponse, error)
PATCH/v1/accounts/{account_id}
Get Account Balances
client.V1.Accounts.GetAccountBalances(ctx, accountID, query) (*V1AccountGetAccountBalancesResponse, error)
GET/v1/accounts/{account_id}/balances
Get Portfolio History
client.V1.Accounts.GetPortfolioHistory(ctx, accountID, query) (*V1AccountGetPortfolioHistoryResponse, error)
GET/v1/accounts/{account_id}/portfolio-history
ModelsExpand Collapse
type Account struct{…}

Represents a trading account

ID int64

The unique identifier for the account

formatint64
AccountHolderEntityID int64

The account holder entity identifier

formatint64
FullName string

The full legal name of the account

OpenDate Time

The date the account was opened

formatdate
OptionsLevel int64

The options level of the account

formatint64
ShortName string

The short name of the account

The current status of the account

One of the following:
const AccountStatusActive AccountStatus = "ACTIVE"
const AccountStatusInactive AccountStatus = "INACTIVE"
const AccountStatusClosed AccountStatus = "CLOSED"

The sub-type of account

One of the following:
const AccountSubtypeCash AccountSubtype = "CASH"
const AccountSubtypeMargin AccountSubtype = "MARGIN"
const AccountSubtypeOther AccountSubtype = "OTHER"

The type of account

One of the following:
const AccountTypeCustomer AccountType = "CUSTOMER"
const AccountTypeOther AccountType = "OTHER"
CloseDate TimeOptional

The date the account was closed, if applicable

formatdate
type AccountBalances struct{…}

Represents the balance details for a trading account

AccountID int64

The unique identifier for the account

formatint64
BuyingPower string

The total buying power available in the account.

Currency string

Currency identifier for all monetary values.

DailyRealizedPnl string

Realized profit or loss since start of day.

DailyTotalPnl string

Total profit or loss since start of day.

DailyUnrealizedPnl string

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

Equity string

The total equity in the account.

LongMarketValue string

The total market value of all long positions.

MarginType MarginType

The applicable margin model for the account

One of the following:
const MarginTypeOther MarginType = "OTHER"
const MarginTypeNone MarginType = "NONE"
const MarginTypePortfolioMargin MarginType = "PORTFOLIO_MARGIN"
const MarginTypeRiskBasedHaircutBrokerDealer MarginType = "RISK_BASED_HAIRCUT_BROKER_DEALER"
const MarginTypeRegT MarginType = "REG_T"
const MarginTypeRiskBasedHaircutMarketMaker MarginType = "RISK_BASED_HAIRCUT_MARKET_MAKER"
const MarginTypeCiro MarginType = "CIRO"
const MarginTypeFuturesNlv MarginType = "FUTURES_NLV"
const MarginTypeFuturesTotEq MarginType = "FUTURES_TOT_EQ"
OpenOrderAdjustment string

Signed buying-power correction from open orders.

SettledCash string

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

Start-of-day snapshot balances.

BuyingPower string

Start-of-day buying power.

Equity string

Start-of-day equity.

LongMarketValue string

Start-of-day long market value.

ShortMarketValue string

Start-of-day short market value.

Asof TimeOptional

Timestamp for the start-of-day values.

formatdate
DayTradeBuyingPower stringOptional

Start-of-day day-trade buying power.

MaintenanceMarginExcess stringOptional

Start-of-day maintenance margin excess.

MaintenanceMarginRequirement stringOptional

Start-of-day maintenance margin requirement.

TradeCash stringOptional

Start-of-day trade cash.

TradeCash string

Trade-date effective cash.

UnsettledCredits string

Trade-date unsettled cash credits.

UnsettledDebits string

Trade-date unsettled cash debits.

WithdrawableCash string

The amount of cash currently available to withdraw.

MarginDetails MarginDetailsOptional

Margin-account-only details.

DayTradeCount int64

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

formatint32
minimum0
InitialMarginExcess string

Initial margin excess for trade-date balances.

InitialMarginRequirement string

Initial margin requirement for trade-date balances.

MaintenanceMarginExcess string

Maintenance margin excess for trade-date balances.

MaintenanceMarginRequirement string

Maintenance margin requirement for trade-date balances.

PatternDayTrader bool

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

DayTradeBuyingPowerUsage stringOptional

The amount of day-trade buying power used during the current trading day.

TopContributors []MarginTopContributorOptional

Optional top margin contributors, returned only when explicitly requested.

DayTradeBuyingPowerUsage string

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

InitialMarginRequirement string

Initial margin requirement attributable to this underlying.

MaintenanceMarginRequirement string

Maintenance margin requirement attributable to this underlying.

MarketValue string

Net market value attributable to this underlying.

UnderlyingInstrumentID string

UUID of the underlying security contributing to margin requirement.

formatuuid
Usage MarginDetailsUsageOptional

Current usage totals.

Total string

The total margin available in the current model.

Used string

The amount of margin that is currently being utilized.

Multiplier stringOptional

Applied multiplier for margin calculations.

ShortMarketValue stringOptional

The total market value of all short positions.

type AccountBalancesSod struct{…}
BuyingPower string

Start-of-day buying power.

Equity string

Start-of-day equity.

LongMarketValue string

Start-of-day long market value.

ShortMarketValue string

Start-of-day short market value.

Asof TimeOptional

Timestamp for the start-of-day values.

formatdate
DayTradeBuyingPower stringOptional

Start-of-day day-trade buying power.

MaintenanceMarginExcess stringOptional

Start-of-day maintenance margin excess.

MaintenanceMarginRequirement stringOptional

Start-of-day maintenance margin requirement.

TradeCash stringOptional

Start-of-day trade cash.

type AccountList []Account
ID int64

The unique identifier for the account

formatint64
AccountHolderEntityID int64

The account holder entity identifier

formatint64
FullName string

The full legal name of the account

OpenDate Time

The date the account was opened

formatdate
OptionsLevel int64

The options level of the account

formatint64
ShortName string

The short name of the account

The current status of the account

One of the following:
const AccountStatusActive AccountStatus = "ACTIVE"
const AccountStatusInactive AccountStatus = "INACTIVE"
const AccountStatusClosed AccountStatus = "CLOSED"

The sub-type of account

One of the following:
const AccountSubtypeCash AccountSubtype = "CASH"
const AccountSubtypeMargin AccountSubtype = "MARGIN"
const AccountSubtypeOther AccountSubtype = "OTHER"

The type of account

One of the following:
const AccountTypeCustomer AccountType = "CUSTOMER"
const AccountTypeOther AccountType = "OTHER"
CloseDate TimeOptional

The date the account was closed, if applicable

formatdate
type AccountSettings struct{…}
Risk RiskSettingsOptional

Risk settings for the account

MaxNotional stringOptional

The maximum notional value available to the account

type AccountStatus string

Account status

One of the following:
const AccountStatusActive AccountStatus = "ACTIVE"
const AccountStatusInactive AccountStatus = "INACTIVE"
const AccountStatusClosed AccountStatus = "CLOSED"
type AccountSubtype string

Account subtype classification providing more granular categorization

One of the following:
const AccountSubtypeCash AccountSubtype = "CASH"
const AccountSubtypeMargin AccountSubtype = "MARGIN"
const AccountSubtypeOther AccountSubtype = "OTHER"
type AccountType string

Account type classification

One of the following:
const AccountTypeCustomer AccountType = "CUSTOMER"
const AccountTypeOther AccountType = "OTHER"
type MarginDetails struct{…}
DayTradeCount int64

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

formatint32
minimum0
InitialMarginExcess string

Initial margin excess for trade-date balances.

InitialMarginRequirement string

Initial margin requirement for trade-date balances.

MaintenanceMarginExcess string

Maintenance margin excess for trade-date balances.

MaintenanceMarginRequirement string

Maintenance margin requirement for trade-date balances.

PatternDayTrader bool

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

DayTradeBuyingPowerUsage stringOptional

The amount of day-trade buying power used during the current trading day.

TopContributors []MarginTopContributorOptional

Optional top margin contributors, returned only when explicitly requested.

DayTradeBuyingPowerUsage string

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

InitialMarginRequirement string

Initial margin requirement attributable to this underlying.

MaintenanceMarginRequirement string

Maintenance margin requirement attributable to this underlying.

MarketValue string

Net market value attributable to this underlying.

UnderlyingInstrumentID string

UUID of the underlying security contributing to margin requirement.

formatuuid
Usage MarginDetailsUsageOptional

Current usage totals.

Total string

The total margin available in the current model.

Used string

The amount of margin that is currently being utilized.

type MarginDetailsUsage struct{…}
Total string

The total margin available in the current model.

Used string

The amount of margin that is currently being utilized.

type MarginTopContributor struct{…}
DayTradeBuyingPowerUsage string

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

InitialMarginRequirement string

Initial margin requirement attributable to this underlying.

MaintenanceMarginRequirement string

Maintenance margin requirement attributable to this underlying.

MarketValue string

Net market value attributable to this underlying.

UnderlyingInstrumentID string

UUID of the underlying security contributing to margin requirement.

formatuuid
type MarginType string

An account’s margin type

One of the following:
const MarginTypeOther MarginType = "OTHER"
const MarginTypeNone MarginType = "NONE"
const MarginTypePortfolioMargin MarginType = "PORTFOLIO_MARGIN"
const MarginTypeRiskBasedHaircutBrokerDealer MarginType = "RISK_BASED_HAIRCUT_BROKER_DEALER"
const MarginTypeRegT MarginType = "REG_T"
const MarginTypeRiskBasedHaircutMarketMaker MarginType = "RISK_BASED_HAIRCUT_MARKET_MAKER"
const MarginTypeCiro MarginType = "CIRO"
const MarginTypeFuturesNlv MarginType = "FUTURES_NLV"
const MarginTypeFuturesTotEq MarginType = "FUTURES_TOT_EQ"
type PortfolioHistoryResponse struct{…}
Date Time

The date for this segment

formatdate
EodEquity string

The equity at the end of the trading day.

RealizedPnl string

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

SodEquity string

The equity at the start of the trading day.

UnrealizedPnl string

Sum of the profit and loss from market changes.

BoughtNotional stringOptional

Amount bought MTM

DayPnl stringOptional

Sum of the profit and loss from intraday trading activities for the trading day.

NetPnl stringOptional

P&L after netting all realized and unrealized P&L, adjustments, dividends, change in accruals, income and expenses

PositionPnl stringOptional

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

SoldNotional stringOptional

Amount sold MTM

type PortfolioHistorySegment struct{…}
Date Time

The date for this segment

formatdate
EodEquity string

The equity at the end of the trading day.

RealizedPnl string

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

SodEquity string

The equity at the start of the trading day.

UnrealizedPnl string

Sum of the profit and loss from market changes.

BoughtNotional stringOptional

Amount bought MTM

DayPnl stringOptional

Sum of the profit and loss from intraday trading activities for the trading day.

NetPnl stringOptional

P&L after netting all realized and unrealized P&L, adjustments, dividends, change in accruals, income and expenses

PositionPnl stringOptional

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

SoldNotional stringOptional

Amount sold MTM

type RiskSettings struct{…}

Risk settings for an account

MaxNotional stringOptional

The maximum notional value available to the account

V1API Version

Endpoints for API service metadata.

Get the API version.
client.V1.APIVersion.GetVersion(ctx) (*V1APIVersionGetVersionResponse, error)
GET/v1/version
ModelsExpand Collapse
type Version struct{…}

API version information

Version string

API version string

V1Calendar

Access clocks and financial calendars for market sessions and events.

Get Clock
client.V1.Calendar.GetClock(ctx) (*V1CalendarGetClockResponse, error)
GET/v1/clock
Get Market Hours Calendar.
client.V1.Calendar.GetMarketHoursCalendar(ctx, query) (*V1CalendarGetMarketHoursCalendarResponse, error)
GET/v1/calendars/market-hours
ModelsExpand Collapse
type ClockDetail struct{…}

Current server time and market clock information

Clock Time

Current server time in UTC

formatdate-time
type DayType string

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

One of the following:
const DayTypeTradingDay DayType = "TRADING_DAY"
const DayTypeEarlyClose DayType = "EARLY_CLOSE"
const DayTypeHoliday DayType = "HOLIDAY"
const DayTypeWeekend DayType = "WEEKEND"
type MarketHoursDetail struct{…}

Comprehensive market hours information for a specific market and date

CurrentTime Time

Current time in market timezone with offset

formatdate-time
Date Time

The date for which market hours are provided

formatdate
Market MarketType

Market type identifier

One of the following:
const MarketTypeUsEquities MarketType = "us_equities"
const MarketTypeUsOptions MarketType = "us_options"
MarketName string

Human-readable market name

NextSessions TradingSessions

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

AfterHours SessionScheduleOptional

After-hours session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration
PreMarket SessionScheduleOptional

Pre-market session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration
Regular SessionScheduleOptional

Regular trading session schedule, null if holiday/weekend

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration

Market status information

DayType DayType

The type of trading day

One of the following:
const DayTypeTradingDay DayType = "TRADING_DAY"
const DayTypeEarlyClose DayType = "EARLY_CLOSE"
const DayTypeHoliday DayType = "HOLIDAY"
const DayTypeWeekend DayType = "WEEKEND"
IsOpen bool

Whether the market is currently open (real-time)

CurrentSession MarketSessionTypeOptional

Current session type if market is open, null if closed

One of the following:
const MarketSessionTypePreMarket MarketSessionType = "pre_market"
const MarketSessionTypeRegular MarketSessionType = "regular"
const MarketSessionTypeAfterHours MarketSessionType = "after_hours"
Timezone string

IANA timezone identifier for the market

TodaySessions TradingSessions

Trading session schedules for the requested date with time_until fields

AfterHours SessionScheduleOptional

After-hours session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration
PreMarket SessionScheduleOptional

Pre-market session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration
Regular SessionScheduleOptional

Regular trading session schedule, null if holiday/weekend

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration
type MarketHoursDetailList []MarketHoursDetail
CurrentTime Time

Current time in market timezone with offset

formatdate-time
Date Time

The date for which market hours are provided

formatdate
Market MarketType

Market type identifier

One of the following:
const MarketTypeUsEquities MarketType = "us_equities"
const MarketTypeUsOptions MarketType = "us_options"
MarketName string

Human-readable market name

NextSessions TradingSessions

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

AfterHours SessionScheduleOptional

After-hours session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration
PreMarket SessionScheduleOptional

Pre-market session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration
Regular SessionScheduleOptional

Regular trading session schedule, null if holiday/weekend

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration

Market status information

DayType DayType

The type of trading day

One of the following:
const DayTypeTradingDay DayType = "TRADING_DAY"
const DayTypeEarlyClose DayType = "EARLY_CLOSE"
const DayTypeHoliday DayType = "HOLIDAY"
const DayTypeWeekend DayType = "WEEKEND"
IsOpen bool

Whether the market is currently open (real-time)

CurrentSession MarketSessionTypeOptional

Current session type if market is open, null if closed

One of the following:
const MarketSessionTypePreMarket MarketSessionType = "pre_market"
const MarketSessionTypeRegular MarketSessionType = "regular"
const MarketSessionTypeAfterHours MarketSessionType = "after_hours"
Timezone string

IANA timezone identifier for the market

TodaySessions TradingSessions

Trading session schedules for the requested date with time_until fields

AfterHours SessionScheduleOptional

After-hours session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration
PreMarket SessionScheduleOptional

Pre-market session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration
Regular SessionScheduleOptional

Regular trading session schedule, null if holiday/weekend

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration
type MarketSessionType string

Session type for market hours

One of the following:
const MarketSessionTypePreMarket MarketSessionType = "pre_market"
const MarketSessionTypeRegular MarketSessionType = "regular"
const MarketSessionTypeAfterHours MarketSessionType = "after_hours"
type MarketStatus struct{…}

Market status information

DayType DayType

The type of trading day

One of the following:
const DayTypeTradingDay DayType = "TRADING_DAY"
const DayTypeEarlyClose DayType = "EARLY_CLOSE"
const DayTypeHoliday DayType = "HOLIDAY"
const DayTypeWeekend DayType = "WEEKEND"
IsOpen bool

Whether the market is currently open (real-time)

CurrentSession MarketSessionTypeOptional

Current session type if market is open, null if closed

One of the following:
const MarketSessionTypePreMarket MarketSessionType = "pre_market"
const MarketSessionTypeRegular MarketSessionType = "regular"
const MarketSessionTypeAfterHours MarketSessionType = "after_hours"
type MarketType string

Market type for market hours calendar endpoint

One of the following:
const MarketTypeUsEquities MarketType = "us_equities"
const MarketTypeUsOptions MarketType = "us_options"
type SessionSchedule struct{…}

Session schedule with open and close timestamps

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration
type TradingSessions struct{…}

Trading sessions for a market day with full timestamps

AfterHours SessionScheduleOptional

After-hours session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration
PreMarket SessionScheduleOptional

Pre-market session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration
Regular SessionScheduleOptional

Regular trading session schedule, null if holiday/weekend

Close Time

Session close timestamp with timezone offset

formatdate-time
Open Time

Session open timestamp with timezone offset

formatdate-time
TimeUntilClose stringOptional

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration
TimeUntilOpen stringOptional

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration

V1Instrument Data

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

Get All Instrument Events
client.V1.InstrumentData.GetAllInstrumentEvents(ctx, query) (*V1InstrumentDataGetAllInstrumentEventsResponse, error)
GET/v1/instruments/events
Get Instrument Events
client.V1.InstrumentData.GetInstrumentEvents(ctx, instrumentID, query) (*V1InstrumentDataGetInstrumentEventsResponse, error)
GET/v1/instruments/{instrument_id}/events
Get Instrument Fundamentals
client.V1.InstrumentData.GetInstrumentFundamentals(ctx, instrumentID) (*V1InstrumentDataGetInstrumentFundamentalsResponse, error)
GET/v1/instruments/{instrument_id}/fundamentals
Get Instrument Balance Sheet Statements
client.V1.InstrumentData.GetInstrumentBalanceSheetStatements(ctx, instrumentID, query) (*V1InstrumentDataGetInstrumentBalanceSheetStatementsResponse, error)
GET/v1/instruments/{instrument_id}/balance-sheets
Get Instrument Income Statements
client.V1.InstrumentData.GetInstrumentIncomeStatements(ctx, instrumentID, query) (*V1InstrumentDataGetInstrumentIncomeStatementsResponse, error)
GET/v1/instruments/{instrument_id}/income-statements
Get Instrument Analyst Consensus
client.V1.InstrumentData.GetInstrumentAnalystConsensus(ctx, instrumentID, query) (*V1InstrumentDataGetInstrumentAnalystConsensusResponse, error)
GET/v1/instruments/{instrument_id}/analyst-reporting
Get Instrument Cash Flow Statements
client.V1.InstrumentData.GetInstrumentCashFlowStatements(ctx, instrumentID, query) (*V1InstrumentDataGetInstrumentCashFlowStatementsResponse, error)
GET/v1/instruments/{instrument_id}/cash-flow-statements
ModelsExpand Collapse
type AllEventsEventType string

Event types supported by the all-events endpoint.

One of the following:
const AllEventsEventTypeEarnings AllEventsEventType = "EARNINGS"
const AllEventsEventTypeDividend AllEventsEventType = "DIVIDEND"
const AllEventsEventTypeStockSplit AllEventsEventType = "STOCK_SPLIT"
const AllEventsEventTypeIpo AllEventsEventType = "IPO"
type AnalystDistribution struct{…}

Analyst recommendation distribution

Buy int64

Number of buy recommendations

formatint64
Hold int64

Number of hold recommendations

formatint64
Sell int64

Number of sell recommendations

formatint64
StrongBuy int64

Number of strong buy recommendations

formatint64
StrongSell int64

Number of strong sell recommendations

formatint64
type AnalystRating string

Analyst rating category

One of the following:
const AnalystRatingStrongBuy AnalystRating = "STRONG_BUY"
const AnalystRatingBuy AnalystRating = "BUY"
const AnalystRatingHold AnalystRating = "HOLD"
const AnalystRatingSell AnalystRating = "SELL"
const AnalystRatingStrongSell AnalystRating = "STRONG_SELL"
type FiscalPeriodType string

Fiscal period type for earnings reports

One of the following:
const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"
const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"
const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"
const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"
type InstrumentAllEventsData struct{…}

All-events payload grouped by date.

Events grouped by date in descending order.

Date Time

Event date.

formatdate

Flat event envelopes for this date.

Symbol string

Symbol associated with the event.

Event type discriminator.

One of the following:
const AllEventsEventTypeEarnings AllEventsEventType = "EARNINGS"
const AllEventsEventTypeDividend AllEventsEventType = "DIVIDEND"
const AllEventsEventTypeStockSplit AllEventsEventType = "STOCK_SPLIT"
const AllEventsEventTypeIpo AllEventsEventType = "IPO"
DividendEventData InstrumentDividendEventOptional

Dividend payload when type is DIVIDEND.

AdjustedDividendAmount string

The adjusted dividend amount accounting for any splits.

ExDate Time

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

formatdate
DeclarationDate TimeOptional

The declaration date of the dividend

formatdate
DividendAmount stringOptional

The dividend amount per share.

DividendYield stringOptional

The dividend yield as a percentage of the stock price.

Frequency stringOptional

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”).

PaymentDate TimeOptional

The payment date is the date on which a declared stock dividend is scheduled to be paid.

formatdate
RecordDate TimeOptional

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.

formatdate
EarningsEventData InstrumentEarningsOptional

Earnings payload when type is EARNINGS.

Date Time

The date when the earnings report was published

formatdate
EpsActual stringOptional

The actual earnings per share (EPS) for the period

EpsEstimate stringOptional

The estimated earnings per share (EPS) for the period

EpsSurprisePercent stringOptional

The percentage difference between actual and estimated EPS

RevenueActual stringOptional

The actual total revenue for the period

RevenueEstimate stringOptional

The estimated total revenue for the period

RevenueSurprisePercent stringOptional

The percentage difference between actual and estimated revenue

InstrumentID stringOptional

OEMS instrument identifier, when the instrument is found in the instrument cache.

formatuuid
IpoEventData InstrumentEventIpoItemOptional

IPO payload when type is IPO.

Actions stringOptional

IPO action.

AnnouncedAt TimeOptional

IPO announced timestamp.

formatdate-time
Company stringOptional

IPO company name.

Exchange stringOptional

IPO exchange.

MarketCap stringOptional

IPO market cap.

PriceRange stringOptional

IPO price range.

Shares stringOptional

IPO shares offered.

Name stringOptional

Instrument name associated with the event, when available.

ReportingCurrency stringOptional

The currency used for reporting financial data.

StockSplitEventData InstrumentSplitEventOptional

Stock split payload when type is STOCK_SPLIT.

Date Time

The date of the stock split

formatdate
Denominator string

The denominator of the split ratio

Numerator string

The numerator of the split ratio

SplitType string

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

type InstrumentAnalystConsensus struct{…}

Aggregated analyst consensus metrics

Date Time

The date the consensus snapshot was generated

formatdate
Distribution AnalystDistributionOptional

Count of individual analyst recommendations by category

Buy int64

Number of buy recommendations

formatint64
Hold int64

Number of hold recommendations

formatint64
Sell int64

Number of sell recommendations

formatint64
StrongBuy int64

Number of strong buy recommendations

formatint64
StrongSell int64

Number of strong sell recommendations

formatint64
PriceTarget PriceTargetOptional

Aggregated analyst price target statistics

Average string

Average analyst price target

Currency string

ISO 4217 currency code of the price targets

High string

Highest analyst price target

Low string

Lowest analyst price target

Rating AnalystRatingOptional

Consensus analyst rating

One of the following:
const AnalystRatingStrongBuy AnalystRating = "STRONG_BUY"
const AnalystRatingBuy AnalystRating = "BUY"
const AnalystRatingHold AnalystRating = "HOLD"
const AnalystRatingSell AnalystRating = "SELL"
const AnalystRatingStrongSell AnalystRating = "STRONG_SELL"
type InstrumentBalanceSheetStatement struct{…}

A quarterly balance sheet statement for an instrument.

AcceptedDate Time

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

formatdate-time
FilingDate Time

The date the financial statement was filed

formatdate
Period string

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

PeriodType FiscalPeriodType

The type of fiscal period

One of the following:
const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"
const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"
const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"
const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"
ReportedCurrency string

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

Year int64

The fiscal year of the statement

formatint32
AccountPayables stringOptional

Account payables

AccountsReceivables stringOptional

Accounts receivables

AccruedExpenses stringOptional

Accrued expenses

AccumulatedOtherComprehensiveIncomeLoss stringOptional

Accumulated other comprehensive income/loss

AdditionalPaidInCapital stringOptional

Additional paid-in capital

CapitalLeaseObligations stringOptional

Capital lease obligations (total)

CapitalLeaseObligationsCurrent stringOptional

Capital lease obligations (current portion)

CashAndCashEquivalents stringOptional

Cash and cash equivalents

CashAndShortTermInvestments stringOptional

Cash and short-term investments combined

CommonStock stringOptional

Common stock

DeferredRevenue stringOptional

Deferred revenue

DeferredRevenueNonCurrent stringOptional

Deferred revenue (non-current)

DeferredTaxLiabilitiesNonCurrent stringOptional

Deferred tax liabilities (non-current)

Goodwill stringOptional

Goodwill

GoodwillAndIntangibleAssets stringOptional

Goodwill and intangible assets combined

IntangibleAssets stringOptional

Intangible assets

Inventory stringOptional

Inventory

LongTermDebt stringOptional

Long-term debt

LongTermInvestments stringOptional

Long-term investments

MinorityInterest stringOptional

Minority interest

NetDebt stringOptional

Net debt (total debt minus cash)

NetReceivables stringOptional

Net receivables

OtherAssets stringOptional

Other assets

OtherCurrentAssets stringOptional

Other current assets

OtherCurrentLiabilities stringOptional

Other current liabilities

OtherLiabilities stringOptional

Other liabilities

OtherNonCurrentAssets stringOptional

Other non-current assets

OtherNonCurrentLiabilities stringOptional

Other non-current liabilities

OtherPayables stringOptional

Other payables

OtherReceivables stringOptional

Other receivables

OtherTotalStockholdersEquity stringOptional

Other total stockholders equity

PreferredStock stringOptional

Preferred stock

Prepaids stringOptional

Prepaids

PropertyPlantAndEquipmentNet stringOptional

Property, plant and equipment net of depreciation

RetainedEarnings stringOptional

Retained earnings

ShortTermDebt stringOptional

Short-term debt

ShortTermInvestments stringOptional

Short-term investments

TaxAssets stringOptional

Tax assets

TaxPayables stringOptional

Tax payables

TotalAssets stringOptional

Total assets

TotalCurrentAssets stringOptional

Total current assets

TotalCurrentLiabilities stringOptional

Total current liabilities

TotalDebt stringOptional

Total debt

TotalEquity stringOptional

Total equity

TotalInvestments stringOptional

Total investments

TotalLiabilities stringOptional

Total liabilities

TotalLiabilitiesAndTotalEquity stringOptional

Total liabilities and total equity

TotalNonCurrentAssets stringOptional

Total non-current assets

TotalNonCurrentLiabilities stringOptional

Total non-current liabilities

TotalPayables stringOptional

Total payables

TotalStockholdersEquity stringOptional

Total stockholders equity

TreasuryStock stringOptional

Treasury stock

type InstrumentBalanceSheetStatementList []InstrumentBalanceSheetStatement
AcceptedDate Time

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

formatdate-time
FilingDate Time

The date the financial statement was filed

formatdate
Period string

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

PeriodType FiscalPeriodType

The type of fiscal period

One of the following:
const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"
const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"
const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"
const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"
ReportedCurrency string

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

Year int64

The fiscal year of the statement

formatint32
AccountPayables stringOptional

Account payables

AccountsReceivables stringOptional

Accounts receivables

AccruedExpenses stringOptional

Accrued expenses

AccumulatedOtherComprehensiveIncomeLoss stringOptional

Accumulated other comprehensive income/loss

AdditionalPaidInCapital stringOptional

Additional paid-in capital

CapitalLeaseObligations stringOptional

Capital lease obligations (total)

CapitalLeaseObligationsCurrent stringOptional

Capital lease obligations (current portion)

CashAndCashEquivalents stringOptional

Cash and cash equivalents

CashAndShortTermInvestments stringOptional

Cash and short-term investments combined

CommonStock stringOptional

Common stock

DeferredRevenue stringOptional

Deferred revenue

DeferredRevenueNonCurrent stringOptional

Deferred revenue (non-current)

DeferredTaxLiabilitiesNonCurrent stringOptional

Deferred tax liabilities (non-current)

Goodwill stringOptional

Goodwill

GoodwillAndIntangibleAssets stringOptional

Goodwill and intangible assets combined

IntangibleAssets stringOptional

Intangible assets

Inventory stringOptional

Inventory

LongTermDebt stringOptional

Long-term debt

LongTermInvestments stringOptional

Long-term investments

MinorityInterest stringOptional

Minority interest

NetDebt stringOptional

Net debt (total debt minus cash)

NetReceivables stringOptional

Net receivables

OtherAssets stringOptional

Other assets

OtherCurrentAssets stringOptional

Other current assets

OtherCurrentLiabilities stringOptional

Other current liabilities

OtherLiabilities stringOptional

Other liabilities

OtherNonCurrentAssets stringOptional

Other non-current assets

OtherNonCurrentLiabilities stringOptional

Other non-current liabilities

OtherPayables stringOptional

Other payables

OtherReceivables stringOptional

Other receivables

OtherTotalStockholdersEquity stringOptional

Other total stockholders equity

PreferredStock stringOptional

Preferred stock

Prepaids stringOptional

Prepaids

PropertyPlantAndEquipmentNet stringOptional

Property, plant and equipment net of depreciation

RetainedEarnings stringOptional

Retained earnings

ShortTermDebt stringOptional

Short-term debt

ShortTermInvestments stringOptional

Short-term investments

TaxAssets stringOptional

Tax assets

TaxPayables stringOptional

Tax payables

TotalAssets stringOptional

Total assets

TotalCurrentAssets stringOptional

Total current assets

TotalCurrentLiabilities stringOptional

Total current liabilities

TotalDebt stringOptional

Total debt

TotalEquity stringOptional

Total equity

TotalInvestments stringOptional

Total investments

TotalLiabilities stringOptional

Total liabilities

TotalLiabilitiesAndTotalEquity stringOptional

Total liabilities and total equity

TotalNonCurrentAssets stringOptional

Total non-current assets

TotalNonCurrentLiabilities stringOptional

Total non-current liabilities

TotalPayables stringOptional

Total payables

TotalStockholdersEquity stringOptional

Total stockholders equity

TreasuryStock stringOptional

Treasury stock

type InstrumentCashFlowStatement struct{…}

A quarterly cash flow statement for an instrument.

AcceptedDate Time

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

formatdate-time
FilingDate Time

The date the financial statement was filed

formatdate
Period string

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

PeriodType FiscalPeriodType

The type of fiscal period

One of the following:
const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"
const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"
const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"
const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"
ReportedCurrency string

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

Year int64

The fiscal year of the statement

formatint32
AccountsPayables stringOptional

Change in accounts payables

AccountsReceivables stringOptional

Change in accounts receivables

AcquisitionsNet stringOptional

Net acquisitions

CapitalExpenditure stringOptional

Capital expenditure

CashAtBeginningOfPeriod stringOptional

Cash and cash equivalents at beginning of period

CashAtEndOfPeriod stringOptional

Cash and cash equivalents at end of period

ChangeInWorkingCapital stringOptional

Change in working capital

CommonDividendsPaid stringOptional

Common dividends paid

CommonStockIssuance stringOptional

Common stock issuance

CommonStockRepurchased stringOptional

Common stock repurchased (buybacks)

DeferredIncomeTax stringOptional

Deferred income tax expense

DepreciationAndAmortization stringOptional

Depreciation and amortization expense

EffectOfForexChangesOnCash stringOptional

Effect of foreign exchange changes on cash

FreeCashFlow stringOptional

Free cash flow (operating cash flow minus capital expenditure)

IncomeTaxesPaid stringOptional

Income taxes paid

InterestPaid stringOptional

Interest paid

Inventory stringOptional

Change in inventory

InvestmentsInPropertyPlantAndEquipment stringOptional

Investments in property, plant, and equipment

LongTermNetDebtIssuance stringOptional

Long-term net debt issuance

NetCashProvidedByFinancingActivities stringOptional

Net cash provided by financing activities

NetCashProvidedByInvestingActivities stringOptional

Net cash provided by investing activities

NetCashProvidedByOperatingActivities stringOptional

Net cash provided by operating activities

NetChangeInCash stringOptional

Net change in cash during the period

NetCommonStockIssuance stringOptional

Net common stock issuance

NetDebtIssuance stringOptional

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

NetDividendsPaid stringOptional

Net dividends paid (common + preferred)

NetIncome stringOptional

Net income for the period

NetPreferredStockIssuance stringOptional

Net preferred stock issuance

NetStockIssuance stringOptional

Net stock issuance (common + preferred)

OperatingCashFlow stringOptional

Operating cash flow (alternative calculation)

OtherFinancingActivities stringOptional

Other financing activities

OtherInvestingActivities stringOptional

Other investing activities

OtherNonCashItems stringOptional

Other non-cash items

OtherWorkingCapital stringOptional

Change in other working capital

PreferredDividendsPaid stringOptional

Preferred dividends paid

PurchasesOfInvestments stringOptional

Purchases of investments

SalesMaturitiesOfInvestments stringOptional

Sales and maturities of investments

ShortTermNetDebtIssuance stringOptional

Short-term net debt issuance

StockBasedCompensation stringOptional

Stock-based compensation expense

type InstrumentCashFlowStatementList []InstrumentCashFlowStatement
AcceptedDate Time

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

formatdate-time
FilingDate Time

The date the financial statement was filed

formatdate
Period string

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

PeriodType FiscalPeriodType

The type of fiscal period

One of the following:
const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"
const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"
const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"
const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"
ReportedCurrency string

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

Year int64

The fiscal year of the statement

formatint32
AccountsPayables stringOptional

Change in accounts payables

AccountsReceivables stringOptional

Change in accounts receivables

AcquisitionsNet stringOptional

Net acquisitions

CapitalExpenditure stringOptional

Capital expenditure

CashAtBeginningOfPeriod stringOptional

Cash and cash equivalents at beginning of period

CashAtEndOfPeriod stringOptional

Cash and cash equivalents at end of period

ChangeInWorkingCapital stringOptional

Change in working capital

CommonDividendsPaid stringOptional

Common dividends paid

CommonStockIssuance stringOptional

Common stock issuance

CommonStockRepurchased stringOptional

Common stock repurchased (buybacks)

DeferredIncomeTax stringOptional

Deferred income tax expense

DepreciationAndAmortization stringOptional

Depreciation and amortization expense

EffectOfForexChangesOnCash stringOptional

Effect of foreign exchange changes on cash

FreeCashFlow stringOptional

Free cash flow (operating cash flow minus capital expenditure)

IncomeTaxesPaid stringOptional

Income taxes paid

InterestPaid stringOptional

Interest paid

Inventory stringOptional

Change in inventory

InvestmentsInPropertyPlantAndEquipment stringOptional

Investments in property, plant, and equipment

LongTermNetDebtIssuance stringOptional

Long-term net debt issuance

NetCashProvidedByFinancingActivities stringOptional

Net cash provided by financing activities

NetCashProvidedByInvestingActivities stringOptional

Net cash provided by investing activities

NetCashProvidedByOperatingActivities stringOptional

Net cash provided by operating activities

NetChangeInCash stringOptional

Net change in cash during the period

NetCommonStockIssuance stringOptional

Net common stock issuance

NetDebtIssuance stringOptional

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

NetDividendsPaid stringOptional

Net dividends paid (common + preferred)

NetIncome stringOptional

Net income for the period

NetPreferredStockIssuance stringOptional

Net preferred stock issuance

NetStockIssuance stringOptional

Net stock issuance (common + preferred)

OperatingCashFlow stringOptional

Operating cash flow (alternative calculation)

OtherFinancingActivities stringOptional

Other financing activities

OtherInvestingActivities stringOptional

Other investing activities

OtherNonCashItems stringOptional

Other non-cash items

OtherWorkingCapital stringOptional

Change in other working capital

PreferredDividendsPaid stringOptional

Preferred dividends paid

PurchasesOfInvestments stringOptional

Purchases of investments

SalesMaturitiesOfInvestments stringOptional

Sales and maturities of investments

ShortTermNetDebtIssuance stringOptional

Short-term net debt issuance

StockBasedCompensation stringOptional

Stock-based compensation expense

type InstrumentDividendEvent struct{…}

Represents a dividend event for an instrument

AdjustedDividendAmount string

The adjusted dividend amount accounting for any splits.

ExDate Time

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

formatdate
DeclarationDate TimeOptional

The declaration date of the dividend

formatdate
DividendAmount stringOptional

The dividend amount per share.

DividendYield stringOptional

The dividend yield as a percentage of the stock price.

Frequency stringOptional

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”).

PaymentDate TimeOptional

The payment date is the date on which a declared stock dividend is scheduled to be paid.

formatdate
RecordDate TimeOptional

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.

formatdate
type InstrumentEarnings struct{…}

Represents instrument earnings data

Date Time

The date when the earnings report was published

formatdate
EpsActual stringOptional

The actual earnings per share (EPS) for the period

EpsEstimate stringOptional

The estimated earnings per share (EPS) for the period

EpsSurprisePercent stringOptional

The percentage difference between actual and estimated EPS

RevenueActual stringOptional

The actual total revenue for the period

RevenueEstimate stringOptional

The estimated total revenue for the period

RevenueSurprisePercent stringOptional

The percentage difference between actual and estimated revenue

type InstrumentEventEnvelope struct{…}

Unified envelope for the all-events response.

Symbol string

Symbol associated with the event.

Event type discriminator.

One of the following:
const AllEventsEventTypeEarnings AllEventsEventType = "EARNINGS"
const AllEventsEventTypeDividend AllEventsEventType = "DIVIDEND"
const AllEventsEventTypeStockSplit AllEventsEventType = "STOCK_SPLIT"
const AllEventsEventTypeIpo AllEventsEventType = "IPO"
DividendEventData InstrumentDividendEventOptional

Dividend payload when type is DIVIDEND.

AdjustedDividendAmount string

The adjusted dividend amount accounting for any splits.

ExDate Time

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

formatdate
DeclarationDate TimeOptional

The declaration date of the dividend

formatdate
DividendAmount stringOptional

The dividend amount per share.

DividendYield stringOptional

The dividend yield as a percentage of the stock price.

Frequency stringOptional

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”).

PaymentDate TimeOptional

The payment date is the date on which a declared stock dividend is scheduled to be paid.

formatdate
RecordDate TimeOptional

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.

formatdate
EarningsEventData InstrumentEarningsOptional

Earnings payload when type is EARNINGS.

Date Time

The date when the earnings report was published

formatdate
EpsActual stringOptional

The actual earnings per share (EPS) for the period

EpsEstimate stringOptional

The estimated earnings per share (EPS) for the period

EpsSurprisePercent stringOptional

The percentage difference between actual and estimated EPS

RevenueActual stringOptional

The actual total revenue for the period

RevenueEstimate stringOptional

The estimated total revenue for the period

RevenueSurprisePercent stringOptional

The percentage difference between actual and estimated revenue

InstrumentID stringOptional

OEMS instrument identifier, when the instrument is found in the instrument cache.

formatuuid
IpoEventData InstrumentEventIpoItemOptional

IPO payload when type is IPO.

Actions stringOptional

IPO action.

AnnouncedAt TimeOptional

IPO announced timestamp.

formatdate-time
Company stringOptional

IPO company name.

Exchange stringOptional

IPO exchange.

MarketCap stringOptional

IPO market cap.

PriceRange stringOptional

IPO price range.

Shares stringOptional

IPO shares offered.

Name stringOptional

Instrument name associated with the event, when available.

ReportingCurrency stringOptional

The currency used for reporting financial data.

StockSplitEventData InstrumentSplitEventOptional

Stock split payload when type is STOCK_SPLIT.

Date Time

The date of the stock split

formatdate
Denominator string

The denominator of the split ratio

Numerator string

The numerator of the split ratio

SplitType string

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

type InstrumentEventIpoItem struct{…}

IPO event in the all-events date grouping response.

Actions stringOptional

IPO action.

AnnouncedAt TimeOptional

IPO announced timestamp.

formatdate-time
Company stringOptional

IPO company name.

Exchange stringOptional

IPO exchange.

MarketCap stringOptional

IPO market cap.

PriceRange stringOptional

IPO price range.

Shares stringOptional

IPO shares offered.

type InstrumentEventsByDate struct{…}

Instrument events for a single date.

Date Time

Event date.

formatdate

Flat event envelopes for this date.

Symbol string

Symbol associated with the event.

Event type discriminator.

One of the following:
const AllEventsEventTypeEarnings AllEventsEventType = "EARNINGS"
const AllEventsEventTypeDividend AllEventsEventType = "DIVIDEND"
const AllEventsEventTypeStockSplit AllEventsEventType = "STOCK_SPLIT"
const AllEventsEventTypeIpo AllEventsEventType = "IPO"
DividendEventData InstrumentDividendEventOptional

Dividend payload when type is DIVIDEND.

AdjustedDividendAmount string

The adjusted dividend amount accounting for any splits.

ExDate Time

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

formatdate
DeclarationDate TimeOptional

The declaration date of the dividend

formatdate
DividendAmount stringOptional

The dividend amount per share.

DividendYield stringOptional

The dividend yield as a percentage of the stock price.

Frequency stringOptional

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”).

PaymentDate TimeOptional

The payment date is the date on which a declared stock dividend is scheduled to be paid.

formatdate
RecordDate TimeOptional

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.

formatdate
EarningsEventData InstrumentEarningsOptional

Earnings payload when type is EARNINGS.

Date Time

The date when the earnings report was published

formatdate
EpsActual stringOptional

The actual earnings per share (EPS) for the period

EpsEstimate stringOptional

The estimated earnings per share (EPS) for the period

EpsSurprisePercent stringOptional

The percentage difference between actual and estimated EPS

RevenueActual stringOptional

The actual total revenue for the period

RevenueEstimate stringOptional

The estimated total revenue for the period

RevenueSurprisePercent stringOptional

The percentage difference between actual and estimated revenue

InstrumentID stringOptional

OEMS instrument identifier, when the instrument is found in the instrument cache.

formatuuid
IpoEventData InstrumentEventIpoItemOptional

IPO payload when type is IPO.

Actions stringOptional

IPO action.

AnnouncedAt TimeOptional

IPO announced timestamp.

formatdate-time
Company stringOptional

IPO company name.

Exchange stringOptional

IPO exchange.

MarketCap stringOptional

IPO market cap.

PriceRange stringOptional

IPO price range.

Shares stringOptional

IPO shares offered.

Name stringOptional

Instrument name associated with the event, when available.

ReportingCurrency stringOptional

The currency used for reporting financial data.

StockSplitEventData InstrumentSplitEventOptional

Stock split payload when type is STOCK_SPLIT.

Date Time

The date of the stock split

formatdate
Denominator string

The denominator of the split ratio

Numerator string

The numerator of the split ratio

SplitType string

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

type InstrumentEventsData struct{…}

Grouped instrument events by type

Dividend distribution events

AdjustedDividendAmount string

The adjusted dividend amount accounting for any splits.

ExDate Time

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

formatdate
DeclarationDate TimeOptional

The declaration date of the dividend

formatdate
DividendAmount stringOptional

The dividend amount per share.

DividendYield stringOptional

The dividend yield as a percentage of the stock price.

Frequency stringOptional

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”).

PaymentDate TimeOptional

The payment date is the date on which a declared stock dividend is scheduled to be paid.

formatdate
RecordDate TimeOptional

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.

formatdate

Earnings announcement events

Date Time

The date when the earnings report was published

formatdate
EpsActual stringOptional

The actual earnings per share (EPS) for the period

EpsEstimate stringOptional

The estimated earnings per share (EPS) for the period

EpsSurprisePercent stringOptional

The percentage difference between actual and estimated EPS

RevenueActual stringOptional

The actual total revenue for the period

RevenueEstimate stringOptional

The estimated total revenue for the period

RevenueSurprisePercent stringOptional

The percentage difference between actual and estimated revenue

InstrumentID string

OEMS instrument UUID from the request

formatuuid

Stock split events

Date Time

The date of the stock split

formatdate
Denominator string

The denominator of the split ratio

Numerator string

The numerator of the split ratio

SplitType string

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

ReportingCurrency stringOptional

The currency used for reporting financial data

type InstrumentFundamentals struct{…}

Supplemental fundamentals and company profile data for an instrument.

AverageVolume int64Optional

The average daily trading volume over the past 30 days

formatint64
Beta stringOptional

The beta value, measuring the instrument’s volatility relative to the overall market

Description stringOptional

A detailed description of the instrument or company

DividendYield stringOptional

The trailing twelve months (TTM) dividend yield

EarningsPerShare stringOptional

The trailing twelve months (TTM) earnings per share

FiftyTwoWeekHigh stringOptional

The highest price over the last 52 weeks

FiftyTwoWeekLow stringOptional

The lowest price over the last 52 weeks

Industry stringOptional

The specific industry of the instrument’s issuer

ListDate TimeOptional

The date the instrument was first listed

formatdate
LogoURL stringOptional

URL to a representative logo image for the instrument or issuer

MarketCap stringOptional

The total market capitalization

PreviousClose stringOptional

The closing price from the previous trading day

PriceToEarnings stringOptional

The price-to-earnings (P/E) ratio for the trailing twelve months (TTM)

ReportingCurrency stringOptional

The currency used for reporting financial data

Sector stringOptional

The business sector of the instrument’s issuer

type InstrumentIncomeStatement struct{…}

A quarterly income statement for an instrument.

AcceptedDate Time

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

formatdate-time
FilingDate Time

The date the financial statement was filed

formatdate
Period string

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

PeriodType FiscalPeriodType

The type of fiscal period

One of the following:
const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"
const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"
const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"
const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"
ReportedCurrency string

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

Year int64

The fiscal year of the statement

formatint32
BottomLineNetIncome stringOptional

Bottom line net income after all adjustments

CostAndExpenses stringOptional

Total costs and expenses

CostOfRevenue stringOptional

Direct costs attributable to producing goods sold

DepreciationAndAmortization stringOptional

Depreciation and amortization expenses

Ebit stringOptional

Earnings before interest and taxes

Ebitda stringOptional

Earnings before interest, taxes, depreciation, and amortization

Eps stringOptional

Basic earnings per share

EpsDiluted stringOptional

Diluted earnings per share

GeneralAndAdministrativeExpenses stringOptional

General administrative overhead expenses

GrossProfit stringOptional

Revenue minus cost of revenue

IncomeBeforeTax stringOptional

Income before income tax expense

IncomeTaxExpense stringOptional

Income tax expense for the period

InterestExpense stringOptional

Interest paid on debt

InterestIncome stringOptional

Interest earned on investments and cash

NetIncome stringOptional

Total net income for the period

NetIncomeDeductions stringOptional

Deductions from net income

NetIncomeFromContinuingOperations stringOptional

Net income from continuing operations

NetIncomeFromDiscontinuedOperations stringOptional

Net income from discontinued operations

NetInterestIncome stringOptional

Net interest income (interest income minus interest expense)

NonOperatingIncomeExcludingInterest stringOptional

Non-operating income excluding interest

OperatingExpenses stringOptional

Total operating expenses

OperatingIncome stringOptional

Income from core business operations

OtherAdjustmentsToNetIncome stringOptional

Other adjustments to net income

OtherExpenses stringOptional

Other miscellaneous expenses

ResearchAndDevelopmentExpenses stringOptional

Expenditure on research and development activities

Revenue stringOptional

Total revenue from sales of goods and services

SellingAndMarketingExpenses stringOptional

Expenditure on marketing and sales activities

SellingGeneralAndAdministrativeExpenses stringOptional

Combined selling, general, and administrative expenses

TotalOtherIncomeExpensesNet stringOptional

Net of other income and expenses

WeightedAverageShsOut stringOptional

Weighted average shares outstanding (basic)

WeightedAverageShsOutDil stringOptional

Weighted average shares outstanding (diluted)

type InstrumentIncomeStatementList []InstrumentIncomeStatement
AcceptedDate Time

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

formatdate-time
FilingDate Time

The date the financial statement was filed

formatdate
Period string

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

PeriodType FiscalPeriodType

The type of fiscal period

One of the following:
const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"
const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"
const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"
const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"
ReportedCurrency string

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

Year int64

The fiscal year of the statement

formatint32
BottomLineNetIncome stringOptional

Bottom line net income after all adjustments

CostAndExpenses stringOptional

Total costs and expenses

CostOfRevenue stringOptional

Direct costs attributable to producing goods sold

DepreciationAndAmortization stringOptional

Depreciation and amortization expenses

Ebit stringOptional

Earnings before interest and taxes

Ebitda stringOptional

Earnings before interest, taxes, depreciation, and amortization

Eps stringOptional

Basic earnings per share

EpsDiluted stringOptional

Diluted earnings per share

GeneralAndAdministrativeExpenses stringOptional

General administrative overhead expenses

GrossProfit stringOptional

Revenue minus cost of revenue

IncomeBeforeTax stringOptional

Income before income tax expense

IncomeTaxExpense stringOptional

Income tax expense for the period

InterestExpense stringOptional

Interest paid on debt

InterestIncome stringOptional

Interest earned on investments and cash

NetIncome stringOptional

Total net income for the period

NetIncomeDeductions stringOptional

Deductions from net income

NetIncomeFromContinuingOperations stringOptional

Net income from continuing operations

NetIncomeFromDiscontinuedOperations stringOptional

Net income from discontinued operations

NetInterestIncome stringOptional

Net interest income (interest income minus interest expense)

NonOperatingIncomeExcludingInterest stringOptional

Non-operating income excluding interest

OperatingExpenses stringOptional

Total operating expenses

OperatingIncome stringOptional

Income from core business operations

OtherAdjustmentsToNetIncome stringOptional

Other adjustments to net income

OtherExpenses stringOptional

Other miscellaneous expenses

ResearchAndDevelopmentExpenses stringOptional

Expenditure on research and development activities

Revenue stringOptional

Total revenue from sales of goods and services

SellingAndMarketingExpenses stringOptional

Expenditure on marketing and sales activities

SellingGeneralAndAdministrativeExpenses stringOptional

Combined selling, general, and administrative expenses

TotalOtherIncomeExpensesNet stringOptional

Net of other income and expenses

WeightedAverageShsOut stringOptional

Weighted average shares outstanding (basic)

WeightedAverageShsOutDil stringOptional

Weighted average shares outstanding (diluted)

type InstrumentSplitEvent struct{…}

Represents a stock split event for an instrument

Date Time

The date of the stock split

formatdate
Denominator string

The denominator of the split ratio

Numerator string

The numerator of the split ratio

SplitType string

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

type PriceTarget struct{…}

Analyst price target statistics

Average string

Average analyst price target

Currency string

ISO 4217 currency code of the price targets

High string

Highest analyst price target

Low string

Lowest analyst price target

V1Instrument DataMarket Data

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

Get Snapshots
client.V1.InstrumentData.MarketData.GetSnapshots(ctx, query) (*V1InstrumentDataMarketDataGetSnapshotsResponse, error)
GET/v1/market-data/snapshot
Get Daily Aggregate Summaries
client.V1.InstrumentData.MarketData.GetDailySummaries(ctx, query) (*V1InstrumentDataMarketDataGetDailySummariesResponse, error)
GET/v1/market-data/daily-summary
ModelsExpand Collapse
type DailySummary struct{…}

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).
InstrumentID string

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

formatuuid
High stringOptional

Session high.

Low stringOptional

Session low.

Open stringOptional

Opening price for the session.

Symbol stringOptional

Display symbol for the security. None for unresolvable IDs.

TradeDate TimeOptional

Session date the OHLV represents, US/Eastern.

formatdate
Volume int64Optional

Session cumulative trading volume.

formatint64
type DailySummaryList []DailySummary
InstrumentID string

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

formatuuid
High stringOptional

Session high.

Low stringOptional

Session low.

Open stringOptional

Opening price for the session.

Symbol stringOptional

Display symbol for the security. None for unresolvable IDs.

TradeDate TimeOptional

Session date the OHLV represents, US/Eastern.

formatdate
Volume int64Optional

Session cumulative trading volume.

formatint64
type MarketDataSnapshot struct{…}

Market data snapshot for a single security.

InstrumentID string

OEMS instrument identifier.

Symbol string

Display symbol for the security.

CumulativeVolume int64Optional

Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available.

formatint64
minimum0
LastQuote SnapshotQuoteOptional

Most recent quote if available.

Ask string

Current best ask.

Bid string

Current best bid.

Midpoint string

Midpoint of bid and ask.

AskSize int64Optional

Size at the best ask, in shares.

formatint32
minimum0
BidSize int64Optional

Size at the best bid, in shares.

formatint32
minimum0
LastTrade SnapshotLastTradeOptional

Most recent last-sale trade if available.

Price string

Most recent last-sale eligible trade price.

Name stringOptional

Security name if available.

Session SnapshotSessionOptional

Session metrics computed from previous close and last trade, if available.

Change string

Absolute change from previous close to last trade.

ChangePercent string

Percent change from previous close to last trade.

PreviousClose string

Previous session close price.

type MarketDataSnapshotList []MarketDataSnapshot
InstrumentID string

OEMS instrument identifier.

Symbol string

Display symbol for the security.

CumulativeVolume int64Optional

Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available.

formatint64
minimum0
LastQuote SnapshotQuoteOptional

Most recent quote if available.

Ask string

Current best ask.

Bid string

Current best bid.

Midpoint string

Midpoint of bid and ask.

AskSize int64Optional

Size at the best ask, in shares.

formatint32
minimum0
BidSize int64Optional

Size at the best bid, in shares.

formatint32
minimum0
LastTrade SnapshotLastTradeOptional

Most recent last-sale trade if available.

Price string

Most recent last-sale eligible trade price.

Name stringOptional

Security name if available.

Session SnapshotSessionOptional

Session metrics computed from previous close and last trade, if available.

Change string

Absolute change from previous close to last trade.

ChangePercent string

Percent change from previous close to last trade.

PreviousClose string

Previous session close price.

type SnapshotLastTrade struct{…}

Last-trade fields for a market data snapshot.

Price string

Most recent last-sale eligible trade price.

type SnapshotQuote struct{…}

L1 quote fields for a market data snapshot.

Ask string

Current best ask.

Bid string

Current best bid.

Midpoint string

Midpoint of bid and ask.

AskSize int64Optional

Size at the best ask, in shares.

formatint32
minimum0
BidSize int64Optional

Size at the best bid, in shares.

formatint32
minimum0
type SnapshotSession struct{…}

Session-level pricing metrics for a market data snapshot.

Change string

Absolute change from previous close to last trade.

ChangePercent string

Percent change from previous close to last trade.

PreviousClose string

Previous session close price.

V1Instrument DataNews

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

Get News
client.V1.InstrumentData.News.GetNews(ctx, query) (*V1InstrumentDataNewsGetNewsResponse, error)
GET/v1/news
ModelsExpand Collapse
type NewsInstrument struct{…}

Instrument associated with a news item.

InstrumentID string

OEMS instrument UUID.

formatuuid
Name stringOptional

Instrument name/description, if available from instrument cache enrichment.

Symbol stringOptional

Trading symbol, if available from instrument cache enrichment.

type NewsItem struct{…}

A single news item and its associated instruments.

Instruments []NewsInstrument

Instruments associated with this news item.

InstrumentID string

OEMS instrument UUID.

formatuuid
Name stringOptional

Instrument name/description, if available from instrument cache enrichment.

Symbol stringOptional

Trading symbol, if available from instrument cache enrichment.

NewsType NewsType

Classification of the item.

One of the following:
const NewsTypeNews NewsType = "NEWS"
const NewsTypePressRelease NewsType = "PRESS_RELEASE"
PublishedAt Time

The published date/time of the article in UTC.

formatdate-time
Publisher string

The publisher or newswire source.

Title string

The headline/title of the article.

URL string

Canonical URL to the full article.

ImageURL stringOptional

URL of an associated image if provided by the source.

Site stringOptional

The primary domain/site of the publisher.

Text stringOptional

The full or excerpted article body.

type NewsItemList []NewsItem
Instruments []NewsInstrument

Instruments associated with this news item.

InstrumentID string

OEMS instrument UUID.

formatuuid
Name stringOptional

Instrument name/description, if available from instrument cache enrichment.

Symbol stringOptional

Trading symbol, if available from instrument cache enrichment.

NewsType NewsType

Classification of the item.

One of the following:
const NewsTypeNews NewsType = "NEWS"
const NewsTypePressRelease NewsType = "PRESS_RELEASE"
PublishedAt Time

The published date/time of the article in UTC.

formatdate-time
Publisher string

The publisher or newswire source.

Title string

The headline/title of the article.

URL string

Canonical URL to the full article.

ImageURL stringOptional

URL of an associated image if provided by the source.

Site stringOptional

The primary domain/site of the publisher.

Text stringOptional

The full or excerpted article body.

type NewsType string

News item classification.

One of the following:
const NewsTypeNews NewsType = "NEWS"
const NewsTypePressRelease NewsType = "PRESS_RELEASE"

V1Instruments

Retrieve core details and discovery endpoints for tradable instruments.

Get Instruments
client.V1.Instruments.GetInstruments(ctx, query) (*V1InstrumentGetInstrumentsResponse, error)
GET/v1/instruments
Get Instrument By ID
client.V1.Instruments.GetInstrumentByID(ctx, instrumentID, query) (*V1InstrumentGetInstrumentByIDResponse, error)
GET/v1/instruments/{instrument_id}
Search Instruments
client.V1.Instruments.SearchInstruments(ctx, query) (*V1InstrumentSearchInstrumentsResponse, error)
GET/v1/instruments/search
Get Option Contracts
client.V1.Instruments.GetOptionContracts(ctx, query) (*V1InstrumentGetOptionContractsResponse, error)
GET/v1/instruments/options/contracts
ModelsExpand Collapse
type ContractType string

The type of options contract

One of the following:
const ContractTypeCall ContractType = "CALL"
const ContractTypePut ContractType = "PUT"
type ExerciseStyle string

The exercise style of an options contract

One of the following:
const ExerciseStyleAmerican ExerciseStyle = "AMERICAN"
const ExerciseStyleEuropean ExerciseStyle = "EUROPEAN"
type Instrument struct{…}

Represents a tradable financial instrument.

ID string

Unique OEMS instrument identifier (UUID)

formatuuid
CountryOfIssue string

The ISO country code of the instrument’s issue

Currency string

The ISO currency code in which the instrument is traded

EasyToBorrow bool

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

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsRestricted bool

Indicates if the instrument is restricted from trading

IsShortProhibited bool

Indicates if short selling is prohibited for the instrument

IsThresholdSecurity bool

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

IsTradable bool

Indicates if the instrument is tradable

Symbol string

The trading symbol for the instrument

Venue string

The MIC code of the primary listing venue

Adv stringOptional

Average daily share volume from the security definition.

Expiry TimeOptional

The expiration date for options instruments

formatdate
InstrumentType SecurityTypeOptional

The type of security (e.g., Common Stock, ETF)

One of the following:
const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"
const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"
const SecurityTypeOption SecurityType = "OPTION"
const SecurityTypeCash SecurityType = "CASH"
const SecurityTypeOther SecurityType = "OTHER"
LongMarginRate stringOptional

The percent of a long position’s value you must post as margin

Name stringOptional

The full name of the instrument or its issuer

NotionalAdv stringOptional

Notional ADV (adv × previous_close). The primary liquidity signal used by /instruments/search ranking. Computed at response time so it stays consistent with whatever adv and previous_close show.

OptionsExpiryDates []TimeOptional

Available options expiration dates for this instrument. Present only when include_options_expiry_dates=true in the request.

PreviousClose stringOptional

Last close price from the security definition.

ShortMarginRate stringOptional

The percent of a short position’s value you must post as margin

StrikePrice stringOptional

The strike price for options instruments

type InstrumentCore struct{…}
ID string

Unique OEMS instrument identifier (UUID)

formatuuid
CountryOfIssue string

The ISO country code of the instrument’s issue

Currency string

The ISO currency code in which the instrument is traded

EasyToBorrow bool

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

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsRestricted bool

Indicates if the instrument is restricted from trading

IsShortProhibited bool

Indicates if short selling is prohibited for the instrument

IsThresholdSecurity bool

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

IsTradable bool

Indicates if the instrument is tradable

Symbol string

The trading symbol for the instrument

Venue string

The MIC code of the primary listing venue

Adv stringOptional

Average daily share volume from the security definition.

Expiry TimeOptional

The expiration date for options instruments

formatdate
InstrumentType SecurityTypeOptional

The type of security (e.g., Common Stock, ETF)

One of the following:
const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"
const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"
const SecurityTypeOption SecurityType = "OPTION"
const SecurityTypeCash SecurityType = "CASH"
const SecurityTypeOther SecurityType = "OTHER"
LongMarginRate stringOptional

The percent of a long position’s value you must post as margin

Name stringOptional

The full name of the instrument or its issuer

NotionalAdv stringOptional

Notional ADV (adv × previous_close). The primary liquidity signal used by /instruments/search ranking. Computed at response time so it stays consistent with whatever adv and previous_close show.

PreviousClose stringOptional

Last close price from the security definition.

ShortMarginRate stringOptional

The percent of a short position’s value you must post as margin

StrikePrice stringOptional

The strike price for options instruments

type InstrumentCoreList []InstrumentCore
ID string

Unique OEMS instrument identifier (UUID)

formatuuid
CountryOfIssue string

The ISO country code of the instrument’s issue

Currency string

The ISO currency code in which the instrument is traded

EasyToBorrow bool

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

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsRestricted bool

Indicates if the instrument is restricted from trading

IsShortProhibited bool

Indicates if short selling is prohibited for the instrument

IsThresholdSecurity bool

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

IsTradable bool

Indicates if the instrument is tradable

Symbol string

The trading symbol for the instrument

Venue string

The MIC code of the primary listing venue

Adv stringOptional

Average daily share volume from the security definition.

Expiry TimeOptional

The expiration date for options instruments

formatdate
InstrumentType SecurityTypeOptional

The type of security (e.g., Common Stock, ETF)

One of the following:
const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"
const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"
const SecurityTypeOption SecurityType = "OPTION"
const SecurityTypeCash SecurityType = "CASH"
const SecurityTypeOther SecurityType = "OTHER"
LongMarginRate stringOptional

The percent of a long position’s value you must post as margin

Name stringOptional

The full name of the instrument or its issuer

NotionalAdv stringOptional

Notional ADV (adv × previous_close). The primary liquidity signal used by /instruments/search ranking. Computed at response time so it stays consistent with whatever adv and previous_close show.

PreviousClose stringOptional

Last close price from the security definition.

ShortMarginRate stringOptional

The percent of a short position’s value you must post as margin

StrikePrice stringOptional

The strike price for options instruments

type ListingType string

The listing type of an options contract

One of the following:
const ListingTypeStandard ListingType = "STANDARD"
const ListingTypeFlex ListingType = "FLEX"
const ListingTypeOtc ListingType = "OTC"
type OptionsContract struct{…}

An options contract with options-specific metadata

ID string

OEMS instrument identifier

formatuuid
ContractType ContractType

Whether this is a CALL or PUT

One of the following:
const ContractTypeCall ContractType = "CALL"
const ContractTypePut ContractType = "PUT"
Currency string

ISO currency code

Exchange string

MIC code of the primary listing venue

ExerciseStyle ExerciseStyle

Exercise style

One of the following:
const ExerciseStyleAmerican ExerciseStyle = "AMERICAN"
const ExerciseStyleEuropean ExerciseStyle = "EUROPEAN"
Expiry Time

Expiration date

formatdate
IsLiquidationOnly bool

Whether the contract is liquidation-only

IsMarginable bool

Whether the contract is marginable

IsRestricted bool

Whether the contract is restricted from trading

ListingType ListingType

Listing type

One of the following:
const ListingTypeStandard ListingType = "STANDARD"
const ListingTypeFlex ListingType = "FLEX"
const ListingTypeOtc ListingType = "OTC"
Multiplier string

Contract multiplier (100 for standard options)

StrikePrice string

Strike price

Symbol string

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

OpenInterest int64Optional

Open interest (number of outstanding contracts), if available

formatint64
UnderlyingInstrumentID stringOptional

OEMS instrument ID of the underlying instrument, if resolvable

formatuuid
type OptionsContractList []OptionsContract
ID string

OEMS instrument identifier

formatuuid
ContractType ContractType

Whether this is a CALL or PUT

One of the following:
const ContractTypeCall ContractType = "CALL"
const ContractTypePut ContractType = "PUT"
Currency string

ISO currency code

Exchange string

MIC code of the primary listing venue

ExerciseStyle ExerciseStyle

Exercise style

One of the following:
const ExerciseStyleAmerican ExerciseStyle = "AMERICAN"
const ExerciseStyleEuropean ExerciseStyle = "EUROPEAN"
Expiry Time

Expiration date

formatdate
IsLiquidationOnly bool

Whether the contract is liquidation-only

IsMarginable bool

Whether the contract is marginable

IsRestricted bool

Whether the contract is restricted from trading

ListingType ListingType

Listing type

One of the following:
const ListingTypeStandard ListingType = "STANDARD"
const ListingTypeFlex ListingType = "FLEX"
const ListingTypeOtc ListingType = "OTC"
Multiplier string

Contract multiplier (100 for standard options)

StrikePrice string

Strike price

Symbol string

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

OpenInterest int64Optional

Open interest (number of outstanding contracts), if available

formatint64
UnderlyingInstrumentID stringOptional

OEMS instrument ID of the underlying instrument, if resolvable

formatuuid

V1Omni AI

ModelsExpand Collapse
type ActionButton struct{…}

Button metadata shared by chart and suggested-actions payloads.

ButtonID string

Stable button identifier within the content part.

Label string

User-visible label.

Prompt PromptButtonActionOptional

Follow-up prompt to submit as the next user message.

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

Structured action in the same message to execute on click.

ActionID stringOptional

UUID of a structured_action content part in the same message.

formatuuid
type ChartPayload struct{…}

Typed chart payload rendered inline in assistant content.

ChartID string

Stable chart identifier scoped to the content part.

ActionButtons []ActionButtonOptional

Buttons associated with this chart.

ButtonID string

Stable button identifier within the content part.

Label string

User-visible label.

Prompt PromptButtonActionOptional

Follow-up prompt to submit as the next user message.

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

Structured action in the same message to execute on click.

ActionID stringOptional

UUID of a structured_action content part in the same message.

formatuuid
DataChart DataChartOptional

Explicit series-driven chart definition.

Series []ChartSeriesOptional
Name string
Points []ChartPointOptional
X string
Y float64
SymbolChart SymbolChartOptional

Symbol-driven chart definition.

Symbol string
Timeframe stringOptional
type ChartPoint struct{…}

Single chart coordinate.

X string
Y float64
type ChartSeries struct{…}

Named data series within a chart.

Name string
Points []ChartPointOptional
X string
Y float64
type ContentPartChartPayload struct{…}

Chart payload content part.

Payload ChartPayload

Typed chart payload rendered inline in assistant content.

ChartID string

Stable chart identifier scoped to the content part.

ActionButtons []ActionButtonOptional

Buttons associated with this chart.

ButtonID string

Stable button identifier within the content part.

Label string

User-visible label.

Prompt PromptButtonActionOptional

Follow-up prompt to submit as the next user message.

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

Structured action in the same message to execute on click.

ActionID stringOptional

UUID of a structured_action content part in the same message.

formatuuid
DataChart DataChartOptional

Explicit series-driven chart definition.

Series []ChartSeriesOptional
Name string
Points []ChartPointOptional
X string
Y float64
SymbolChart SymbolChartOptional

Symbol-driven chart definition.

Symbol string
Timeframe stringOptional
type ContentPartCustomPayload struct{…}

Escape-hatch custom payload content part.

Payload any
type ContentPartStructuredActionPayload struct{…}

Structured action content part.

Action StructuredActionUnion

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:
type StructuredActionPrefillOrder struct{…}

Prefill an order ticket for user confirmation

PrefillOrder PrefillOrderActionUnion

Prefill an order ticket for user confirmation

One of the following:
type PrefillOrderActionPrefillNewOrderAction struct{…}

Create one or more new orders.

ActionType string
type PrefillOrderActionPrefillCancelOrderAction struct{…}

Cancel one or more existing orders.

ActionType string
type StructuredActionOpenChart struct{…}

Open a chart for a symbol

OpenChart OpenChartAction

Open a chart for a symbol

Symbol string

Trading symbol to chart

Extras anyOptional

Additional chart configuration (indicators, overlays, etc.)

Timeframe stringOptional

Chart timeframe (e.g., “1D”, “1W”, “1M”, “3M”, “1Y”, “5Y”)

type StructuredActionOpenScreener struct{…}

Open a stock screener with filters

OpenScreener OpenScreenerAction

Open a stock screener with filters

Filters []ScreenerFilter

Filter criteria for the screener

Field string

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

Operator string

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

Value any

Filter value

FieldFilter []stringOptional

Optional field/column selection for screener results.

PageSize int64Optional

Optional page size.

formatint32
SortBy stringOptional

Optional sort field for screener rows.

SortDirection stringOptional

Optional sort direction (ASC or DESC).

type StructuredActionOpenEntitlementConsent struct{…}

Open entitlement consent flow

OpenEntitlementConsent OpenEntitlementConsentAction

Open entitlement consent flow

Stable entitlement agreement family key.

ActionID string
type ContentPartSuggestedActionsPayload struct{…}

Suggested actions payload content part.

Payload SuggestedActionsPayload

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

ActionButtons []ActionButtonOptional

Ordered message-level buttons.

ButtonID string

Stable button identifier within the content part.

Label string

User-visible label.

Prompt PromptButtonActionOptional

Follow-up prompt to submit as the next user message.

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

Structured action in the same message to execute on click.

ActionID stringOptional

UUID of a structured_action content part in the same message.

formatuuid
type ContentPartTextPayload struct{…}

Text content part.

Text string
type ContentPartThinkingPayload struct{…}

Thinking content part shown on dynamic response polling.

Thoughts []string
type DataChart struct{…}

Chart represented by explicit data series.

Series []ChartSeriesOptional
Name string
Points []ChartPointOptional
X string
Y float64
type OpenChartAction struct{…}

Action to open a chart for a symbol.

Symbol string

Trading symbol to chart

Extras anyOptional

Additional chart configuration (indicators, overlays, etc.)

Timeframe stringOptional

Chart timeframe (e.g., “1D”, “1W”, “1M”, “3M”, “1Y”, “5Y”)

Action to open entitlement consent flow for one or more accounts.

Stable entitlement agreement family key.

type OpenScreenerAction struct{…}

Action to open a stock screener with filters.

Filters []ScreenerFilter

Filter criteria for the screener

Field string

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

Operator string

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

Value any

Filter value

FieldFilter []stringOptional

Optional field/column selection for screener results.

PageSize int64Optional

Optional page size.

formatint32
SortBy stringOptional

Optional sort field for screener rows.

SortDirection stringOptional

Optional sort direction (ASC or DESC).

type PrefillCancelOrderAction struct{…}

Cancel-order prefill action.

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

AccountID int64

Account ID (from path parameter)

formatint64
OrderID string

Order ID to cancel (from path parameter)

type PrefillNewOrderAction struct{…}

New-order prefill action.

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

InstrumentType SecurityType

Type of security

One of the following:
const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"
const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"
const SecurityTypeOption SecurityType = "OPTION"
const SecurityTypeCash SecurityType = "CASH"
const SecurityTypeOther SecurityType = "OTHER"

Type of order

One of the following:
const RequestOrderTypeMarket RequestOrderType = "MARKET"
const RequestOrderTypeLimit RequestOrderType = "LIMIT"
const RequestOrderTypeStop RequestOrderType = "STOP"
const RequestOrderTypeStopLimit RequestOrderType = "STOP_LIMIT"
const RequestOrderTypeTrailingStop RequestOrderType = "TRAILING_STOP"
const RequestOrderTypeTrailingStopLimit RequestOrderType = "TRAILING_STOP_LIMIT"
Quantity string

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:
const SideBuy Side = "BUY"
const SideSell Side = "SELL"
const SideSellShort Side = "SELL_SHORT"
const SideOther Side = "OTHER"
TimeInForce RequestTimeInForce

Time in force

One of the following:
const RequestTimeInForceDay RequestTimeInForce = "DAY"
const RequestTimeInForceGoodTillCancel RequestTimeInForce = "GOOD_TILL_CANCEL"
const RequestTimeInForceImmediateOrCancel RequestTimeInForce = "IMMEDIATE_OR_CANCEL"
const RequestTimeInForceFillOrKill RequestTimeInForce = "FILL_OR_KILL"
const RequestTimeInForceGoodTillDate RequestTimeInForce = "GOOD_TILL_DATE"
const RequestTimeInForceAtTheOpening RequestTimeInForce = "AT_THE_OPENING"
const RequestTimeInForceAtTheClose RequestTimeInForce = "AT_THE_CLOSE"
const RequestTimeInForceGoodTillCrossing RequestTimeInForce = "GOOD_TILL_CROSSING"
const RequestTimeInForceGoodThroughCrossing RequestTimeInForce = "GOOD_THROUGH_CROSSING"
const RequestTimeInForceAtCrossing RequestTimeInForce = "AT_CROSSING"
ID stringOptional

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

maxLength64
ExpiresAt TimeOptional

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

formatdate-time
ExtendedHours boolOptional

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

InstrumentID InstrumentIDOrSymbolOptional

OEMS instrument UUID

formatuuid
LimitOffset stringOptional

Limit offset for trailing stop-limit orders (signed)

LimitPrice stringOptional

Limit price (required for LIMIT and STOP_LIMIT orders)

PositionEffect PositionEffectOptional

Required when instrument_type is OPTION. Specifies whether the order opens or closes a position.

One of the following:
const PositionEffectOpen PositionEffect = "OPEN"
const PositionEffectClose PositionEffect = "CLOSE"
StopPrice stringOptional

Stop price (required for STOP and STOP_LIMIT orders)

Symbol stringOptional

Trading symbol. For equities, use the ticker symbol (e.g., “AAPL”). For options, use the OSI symbol (e.g., “AAPL 250117C00190000”). Either symbol or instrument_id must be provided.

TrailingOffset stringOptional

Trailing offset amount (required for trailing orders)

TrailingOffsetType TrailingOffsetTypeOptional

Trailing offset type (PRICE or PERCENT_BPS)

One of the following:
const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"
const TrailingOffsetTypeBps TrailingOffsetType = "BPS"
type PrefillOrderActionUnion interface{…}

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.

One of the following:
type PrefillOrderActionPrefillNewOrderAction struct{…}

Create one or more new orders.

ActionType string
type PrefillOrderActionPrefillCancelOrderAction struct{…}

Cancel one or more existing orders.

ActionType string
type PromptButtonAction struct{…}

Prompt-style button behavior.

Prompt string

Prompt text to submit as the next user turn.

type ScreenerFilter struct{…}

A single filter criterion for the screener.

Field string

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

Operator string

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

Value any

Filter value

type StructuredActionUnion interface{…}

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:
type StructuredActionPrefillOrder struct{…}

Prefill an order ticket for user confirmation

Prefill an order ticket for user confirmation

One of the following:
type PrefillOrderActionPrefillNewOrderAction struct{…}

Create one or more new orders.

ActionType string
type PrefillOrderActionPrefillCancelOrderAction struct{…}

Cancel one or more existing orders.

ActionType string
type StructuredActionOpenChart struct{…}

Open a chart for a symbol

OpenChart OpenChartAction

Open a chart for a symbol

Symbol string

Trading symbol to chart

Extras anyOptional

Additional chart configuration (indicators, overlays, etc.)

Timeframe stringOptional

Chart timeframe (e.g., “1D”, “1W”, “1M”, “3M”, “1Y”, “5Y”)

type StructuredActionOpenScreener struct{…}

Open a stock screener with filters

OpenScreener OpenScreenerAction

Open a stock screener with filters

Filters []ScreenerFilter

Filter criteria for the screener

Field string

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

Operator string

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

Value any

Filter value

FieldFilter []stringOptional

Optional field/column selection for screener results.

PageSize int64Optional

Optional page size.

formatint32
SortBy stringOptional

Optional sort field for screener rows.

SortDirection stringOptional

Optional sort direction (ASC or DESC).

type StructuredActionOpenEntitlementConsent struct{…}

Open entitlement consent flow

Open entitlement consent flow

Stable entitlement agreement family key.

type StructuredActionButtonAction struct{…}

Structured-action button behavior.

ActionID stringOptional

UUID of a structured_action content part in the same message.

formatuuid
type SuggestedActionsPayload struct{…}

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

ActionButtons []ActionButtonOptional

Ordered message-level buttons.

ButtonID string

Stable button identifier within the content part.

Label string

User-visible label.

Prompt PromptButtonActionOptional

Follow-up prompt to submit as the next user message.

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

Structured action in the same message to execute on click.

ActionID stringOptional

UUID of a structured_action content part in the same message.

formatuuid
type SymbolChart struct{…}

Chart for a single symbol and timeframe.

Symbol string
Timeframe stringOptional

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

Get Entitlements
client.V1.OmniAI.Entitlements.GetEntitlements(ctx, query) (*V1OmniAIEntitlementGetEntitlementsResponse, error)
GET/v1/omni-ai/entitlements
Create Entitlements
client.V1.OmniAI.Entitlements.NewEntitlements(ctx, body) (*V1OmniAIEntitlementNewEntitlementsResponse, error)
POST/v1/omni-ai/entitlements
Delete Entitlement
client.V1.OmniAI.Entitlements.DeleteEntitlement(ctx, entitlementID) (*V1OmniAIEntitlementDeleteEntitlementResponse, error)
DELETE/v1/omni-ai/entitlements/{entitlement_id}
Get Entitlement Agreements
client.V1.OmniAI.Entitlements.GetEntitlementAgreements(ctx) (*V1OmniAIEntitlementGetEntitlementAgreementsResponse, error)
GET/v1/omni-ai/entitlement-agreements
ModelsExpand Collapse
type DeleteEntitlementResponse struct{…}
EntitlementID string
Revoked bool
type EntitlementAgreementKey string

Stable entitlement agreement family key.

type EntitlementAgreementResource struct{…}
AgreementID string

Stable entitlement agreement family key.

DocumentContent string
DocumentSha256 string
EntitlementCodes []EntitlementCode
Title string
Version int64
type EntitlementAgreementResourceList []EntitlementAgreementResource
AgreementID string

Stable entitlement agreement family key.

DocumentContent string
DocumentSha256 string
EntitlementCodes []EntitlementCode
Title string
Version int64
type EntitlementCode string

Stable entitlement code granted by an agreement.

type EntitlementResource struct{…}
AgreementID string
EntitlementCode EntitlementCode

Stable entitlement code granted by an agreement.

EntitlementID string
GrantedAt string
TradingAccountID int64
type EntitlementResourceList []EntitlementResource
AgreementID string
EntitlementCode EntitlementCode

Stable entitlement code granted by an agreement.

EntitlementID string
GrantedAt string
TradingAccountID int64

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

Get Message By ID
client.V1.OmniAI.Messages.GetMessageByID(ctx, messageID, query) (*V1OmniAIMessageGetMessageByIDResponse, error)
GET/v1/omni-ai/messages/{message_id}
Submit Feedback
client.V1.OmniAI.Messages.SubmitFeedback(ctx, messageID, body) (*V1OmniAIMessageSubmitFeedbackResponse, error)
POST/v1/omni-ai/messages/{message_id}/feedback
ModelsExpand Collapse
type CreateFeedbackResponse struct{…}
CreatedAt string
FeedbackID stringOptional

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

Get Response By ID
client.V1.OmniAI.Responses.GetResponseByID(ctx, responseID, query) (*V1OmniAIResponseGetResponseByIDResponse, error)
GET/v1/omni-ai/responses/{response_id}
Cancel Response
client.V1.OmniAI.Responses.CancelResponse(ctx, responseID, body) (*V1OmniAIResponseCancelResponseResponse, error)
DELETE/v1/omni-ai/responses/{response_id}
ModelsExpand Collapse
type CancelResponsePayload struct{…}
Canceled bool
type ErrorStatus struct{…}

Shared sanitized error payload.

Code string
Message string
Details anyOptional
type Response struct{…}

Dynamic pollable response.

ID string

Dynamic lifecycle status for a pollable response.

One of the following:
const ResponseStatusQueued ResponseStatus = "queued"
const ResponseStatusRunning ResponseStatus = "running"
const ResponseStatusSucceeded ResponseStatus = "succeeded"
const ResponseStatusFailed ResponseStatus = "failed"
const ResponseStatusCanceled ResponseStatus = "canceled"
ThreadID string
UserMessageID string
Content ResponseContentOptional

Dynamic response content container. May include thinking parts.

Parts []ResponseContentPartUnion
One of the following:
type ResponseContentPartObject struct{…}

Text content part.

Type string
type ResponseContentPartObject2 struct{…}

Thinking content part shown on dynamic response polling.

Type string
type ResponseContentPartObject3 struct{…}

Structured action content part.

Type string
type ResponseContentPartObject4 struct{…}

Chart payload content part.

Type string
type ResponseContentPartObject5 struct{…}

Suggested actions payload content part.

Type string
type ResponseContentPartObject6 struct{…}

Escape-hatch custom payload content part.

Type string
Error ErrorStatusOptional

Shared sanitized error payload.

Code string
Message string
Details anyOptional
OutputMessageID stringOptional
type ResponseContent struct{…}

Dynamic response content container. May include thinking parts.

Parts []ResponseContentPartUnion
One of the following:
type ResponseContentPartObject struct{…}

Text content part.

Type string
type ResponseContentPartObject2 struct{…}

Thinking content part shown on dynamic response polling.

Type string
type ResponseContentPartObject3 struct{…}

Structured action content part.

Type string
type ResponseContentPartObject4 struct{…}

Chart payload content part.

Type string
type ResponseContentPartObject5 struct{…}

Suggested actions payload content part.

Type string
type ResponseContentPartObject6 struct{…}

Escape-hatch custom payload content part.

Type string
type ResponseContentPartUnion interface{…}

Dynamic content part visible on a pollable response.

One of the following:
type ResponseContentPartObject struct{…}

Text content part.

Type string
type ResponseContentPartObject2 struct{…}

Thinking content part shown on dynamic response polling.

Type string
type ResponseContentPartObject3 struct{…}

Structured action content part.

Type string
type ResponseContentPartObject4 struct{…}

Chart payload content part.

Type string
type ResponseContentPartObject5 struct{…}

Suggested actions payload content part.

Type string
type ResponseContentPartObject6 struct{…}

Escape-hatch custom payload content part.

Type string
type ResponseStatus string

Dynamic lifecycle status for a pollable response.

One of the following:
const ResponseStatusQueued ResponseStatus = "queued"
const ResponseStatusRunning ResponseStatus = "running"
const ResponseStatusSucceeded ResponseStatus = "succeeded"
const ResponseStatusFailed ResponseStatus = "failed"
const ResponseStatusCanceled ResponseStatus = "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 trading_account_ids.

Get Threads
client.V1.OmniAI.Threads.GetThreads(ctx, query) (*V1OmniAIThreadGetThreadsResponse, error)
GET/v1/omni-ai/threads
Get Thread By ID
client.V1.OmniAI.Threads.GetThreadByID(ctx, threadID, query) (*V1OmniAIThreadGetThreadByIDResponse, error)
GET/v1/omni-ai/threads/{thread_id}
Create Thread
client.V1.OmniAI.Threads.NewThread(ctx, body) (*V1OmniAIThreadNewThreadResponse, error)
POST/v1/omni-ai/threads
Get Thread Response
client.V1.OmniAI.Threads.GetThreadResponse(ctx, threadID, query) (*V1OmniAIThreadGetThreadResponseResponse, error)
GET/v1/omni-ai/threads/{thread_id}/response
Get Messages
client.V1.OmniAI.Threads.GetMessages(ctx, threadID, query) (*V1OmniAIThreadGetMessagesResponse, error)
GET/v1/omni-ai/threads/{thread_id}/messages
Create Message
client.V1.OmniAI.Threads.NewMessage(ctx, threadID, body) (*V1OmniAIThreadNewMessageResponse, error)
POST/v1/omni-ai/threads/{thread_id}/messages
ModelsExpand Collapse
type CreateMessageResponse struct{…}

Response payload for continuing a thread with a new message.

ResponseID string
ThreadID string
UserMessageID string
type CreateThreadResponse struct{…}

Response payload for thread creation.

ResponseID string
ThreadID string
UserMessageID string
type Message struct{…}

Final immutable message.

ID string
Content MessageContent

Finalized immutable message content container. Never includes thinking parts.

Parts []MessageContentPartUnion
One of the following:
type MessageContentPartObject struct{…}

Text content part.

Type string
type MessageContentPartObject2 struct{…}

Structured action content part.

Type string
type MessageContentPartObject3 struct{…}

Chart payload content part.

Type string
type MessageContentPartObject4 struct{…}

Suggested actions payload content part.

Type string
type MessageContentPartObject5 struct{…}

Escape-hatch custom payload content part.

Type string
CreatedAt string

Immutable terminal outcome for a finalized assistant message.

One of the following:
const MessageOutcomeCompleted MessageOutcome = "completed"
const MessageOutcomeErrored MessageOutcome = "errored"
const MessageOutcomeCanceled MessageOutcome = "canceled"

Finalized message role in the public contract.

One of the following:
const MessageRoleUser MessageRole = "USER"
const MessageRoleAssistant MessageRole = "ASSISTANT"
Seq int64
ThreadID string
Error ErrorStatusOptional

Shared sanitized error payload.

Code string
Message string
Details anyOptional
type MessageContent struct{…}

Finalized immutable message content container. Never includes thinking parts.

Parts []MessageContentPartUnion
One of the following:
type MessageContentPartObject struct{…}

Text content part.

Type string
type MessageContentPartObject2 struct{…}

Structured action content part.

Type string
type MessageContentPartObject3 struct{…}

Chart payload content part.

Type string
type MessageContentPartObject4 struct{…}

Suggested actions payload content part.

Type string
type MessageContentPartObject5 struct{…}

Escape-hatch custom payload content part.

Type string
type MessageContentPartUnion interface{…}

Final immutable content part visible on persisted messages.

One of the following:
type MessageContentPartObject struct{…}

Text content part.

Type string
type MessageContentPartObject2 struct{…}

Structured action content part.

Type string
type MessageContentPartObject3 struct{…}

Chart payload content part.

Type string
type MessageContentPartObject4 struct{…}

Suggested actions payload content part.

Type string
type MessageContentPartObject5 struct{…}

Escape-hatch custom payload content part.

Type string
type MessageList []Message
ID string
Content MessageContent

Finalized immutable message content container. Never includes thinking parts.

Parts []MessageContentPartUnion
One of the following:
type MessageContentPartObject struct{…}

Text content part.

Type string
type MessageContentPartObject2 struct{…}

Structured action content part.

Type string
type MessageContentPartObject3 struct{…}

Chart payload content part.

Type string
type MessageContentPartObject4 struct{…}

Suggested actions payload content part.

Type string
type MessageContentPartObject5 struct{…}

Escape-hatch custom payload content part.

Type string
CreatedAt string

Immutable terminal outcome for a finalized assistant message.

One of the following:
const MessageOutcomeCompleted MessageOutcome = "completed"
const MessageOutcomeErrored MessageOutcome = "errored"
const MessageOutcomeCanceled MessageOutcome = "canceled"

Finalized message role in the public contract.

One of the following:
const MessageRoleUser MessageRole = "USER"
const MessageRoleAssistant MessageRole = "ASSISTANT"
Seq int64
ThreadID string
Error ErrorStatusOptional

Shared sanitized error payload.

Code string
Message string
Details anyOptional
type MessageOutcome string

Immutable terminal outcome for a finalized assistant message.

One of the following:
const MessageOutcomeCompleted MessageOutcome = "completed"
const MessageOutcomeErrored MessageOutcome = "errored"
const MessageOutcomeCanceled MessageOutcome = "canceled"
type MessageRole string

Finalized message role in the public contract.

One of the following:
const MessageRoleUser MessageRole = "USER"
const MessageRoleAssistant MessageRole = "ASSISTANT"
type Thread struct{…}

Thread metadata returned by list/get thread endpoints.

ID string
CreatedAt string
Title string
UpdatedAt string
type ThreadList []Thread
ID string
CreatedAt string
Title string
UpdatedAt string

V1Orders

Place, monitor, and manage trading orders.

Get Orders
client.V1.Orders.GetOrders(ctx, accountID, query) (*V1OrderGetOrdersResponse, error)
GET/v1/accounts/{account_id}/orders
Get Order By ID
client.V1.Orders.GetOrderByID(ctx, orderID, query) (*V1OrderGetOrderByIDResponse, error)
GET/v1/accounts/{account_id}/orders/{order_id}
Submit Orders
client.V1.Orders.SubmitOrders(ctx, accountID, body) (*V1OrderSubmitOrdersResponse, error)
POST/v1/accounts/{account_id}/orders
Replace Order
client.V1.Orders.ReplaceOrder(ctx, orderID, params) (*V1OrderReplaceOrderResponse, error)
PATCH/v1/accounts/{account_id}/orders/{order_id}
Cancel Open Order
client.V1.Orders.CancelOpenOrder(ctx, orderID, body) (*V1OrderCancelOpenOrderResponse, error)
DELETE/v1/accounts/{account_id}/orders/{order_id}
Cancel All Open Orders
client.V1.Orders.CancelAllOpenOrders(ctx, accountID, body) (*V1OrderCancelAllOpenOrdersResponse, error)
DELETE/v1/accounts/{account_id}/orders
ModelsExpand Collapse
type CancelOrderRequest struct{…}

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.

AccountID int64

Account ID (from path parameter)

formatint64
OrderID string

Order ID to cancel (from path parameter)

type InstrumentIDOrSymbol string

OEMS instrument UUID

type NewOrderRequest struct{…}

Request to submit a new order (PlaceOrderRequest from spec)

InstrumentType SecurityType

Type of security

One of the following:
const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"
const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"
const SecurityTypeOption SecurityType = "OPTION"
const SecurityTypeCash SecurityType = "CASH"
const SecurityTypeOther SecurityType = "OTHER"

Type of order

One of the following:
const RequestOrderTypeMarket RequestOrderType = "MARKET"
const RequestOrderTypeLimit RequestOrderType = "LIMIT"
const RequestOrderTypeStop RequestOrderType = "STOP"
const RequestOrderTypeStopLimit RequestOrderType = "STOP_LIMIT"
const RequestOrderTypeTrailingStop RequestOrderType = "TRAILING_STOP"
const RequestOrderTypeTrailingStopLimit RequestOrderType = "TRAILING_STOP_LIMIT"
Quantity string

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:
const SideBuy Side = "BUY"
const SideSell Side = "SELL"
const SideSellShort Side = "SELL_SHORT"
const SideOther Side = "OTHER"
TimeInForce RequestTimeInForce

Time in force

One of the following:
const RequestTimeInForceDay RequestTimeInForce = "DAY"
const RequestTimeInForceGoodTillCancel RequestTimeInForce = "GOOD_TILL_CANCEL"
const RequestTimeInForceImmediateOrCancel RequestTimeInForce = "IMMEDIATE_OR_CANCEL"
const RequestTimeInForceFillOrKill RequestTimeInForce = "FILL_OR_KILL"
const RequestTimeInForceGoodTillDate RequestTimeInForce = "GOOD_TILL_DATE"
const RequestTimeInForceAtTheOpening RequestTimeInForce = "AT_THE_OPENING"
const RequestTimeInForceAtTheClose RequestTimeInForce = "AT_THE_CLOSE"
const RequestTimeInForceGoodTillCrossing RequestTimeInForce = "GOOD_TILL_CROSSING"
const RequestTimeInForceGoodThroughCrossing RequestTimeInForce = "GOOD_THROUGH_CROSSING"
const RequestTimeInForceAtCrossing RequestTimeInForce = "AT_CROSSING"
ID stringOptional

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

maxLength64
ExpiresAt TimeOptional

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

formatdate-time
ExtendedHours boolOptional

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

InstrumentID InstrumentIDOrSymbolOptional

OEMS instrument UUID

formatuuid
LimitOffset stringOptional

Limit offset for trailing stop-limit orders (signed)

LimitPrice stringOptional

Limit price (required for LIMIT and STOP_LIMIT orders)

PositionEffect PositionEffectOptional

Required when instrument_type is OPTION. Specifies whether the order opens or closes a position.

One of the following:
const PositionEffectOpen PositionEffect = "OPEN"
const PositionEffectClose PositionEffect = "CLOSE"
StopPrice stringOptional

Stop price (required for STOP and STOP_LIMIT orders)

Symbol stringOptional

Trading symbol. For equities, use the ticker symbol (e.g., “AAPL”). For options, use the OSI symbol (e.g., “AAPL 250117C00190000”). Either symbol or instrument_id must be provided.

TrailingOffset stringOptional

Trailing offset amount (required for trailing orders)

TrailingOffsetType TrailingOffsetTypeOptional

Trailing offset type (PRICE or PERCENT_BPS)

One of the following:
const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"
const TrailingOffsetTypeBps TrailingOffsetType = "BPS"
type Order struct{…}

A trading order with its current state and execution details.

This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking.

ID string

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

AccountID int64

Account placing the order

formatint64
ClientOrderID string

Client-provided identifier echoed back (FIX tag 11).

CreatedAt Time

Timestamp when order was created (UTC)

formatdate-time
FilledQuantity string

Cumulative filled quantity

InstrumentID string

OEMS instrument UUID for the traded instrument.

formatuuid
InstrumentType SecurityType

Type of security

One of the following:
const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"
const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"
const SecurityTypeOption SecurityType = "OPTION"
const SecurityTypeCash SecurityType = "CASH"
const SecurityTypeOther SecurityType = "OTHER"
LeavesQuantity string

Remaining unfilled quantity

OrderType OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
const OrderTypeMarket OrderType = "MARKET"
const OrderTypeLimit OrderType = "LIMIT"
const OrderTypeStop OrderType = "STOP"
const OrderTypeStopLimit OrderType = "STOP_LIMIT"
const OrderTypeTrailingStop OrderType = "TRAILING_STOP"
const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"
const OrderTypeOther OrderType = "OTHER"
Quantity string

Total order quantity

Side Side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:
const SideBuy Side = "BUY"
const SideSell Side = "SELL"
const SideSellShort Side = "SELL_SHORT"
const SideOther Side = "OTHER"

Current status of the order

One of the following:
const OrderStatusPendingNew OrderStatus = "PENDING_NEW"
const OrderStatusNew OrderStatus = "NEW"
const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"
const OrderStatusFilled OrderStatus = "FILLED"
const OrderStatusCanceled OrderStatus = "CANCELED"
const OrderStatusRejected OrderStatus = "REJECTED"
const OrderStatusExpired OrderStatus = "EXPIRED"
const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"
const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"
const OrderStatusReplaced OrderStatus = "REPLACED"
const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"
const OrderStatusStopped OrderStatus = "STOPPED"
const OrderStatusSuspended OrderStatus = "SUSPENDED"
const OrderStatusCalculated OrderStatus = "CALCULATED"
const OrderStatusOther OrderStatus = "OTHER"
Symbol string

Trading symbol

TimeInForce TimeInForce

Time in force instruction

One of the following:
const TimeInForceDay TimeInForce = "DAY"
const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"
const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"
const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"
const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"
const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"
const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"
const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"
const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"
const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"
const TimeInForceOther TimeInForce = "OTHER"
UpdatedAt Time

Timestamp of the most recent update (UTC)

formatdate-time
Venue string

MIC code of the venue where the order is routed

AverageFillPrice stringOptional

Average fill price across all executions

Details []stringOptional

Contains execution, rejection or cancellation details, if any

ExpiresAt TimeOptional

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

formatdate-time
ExtendedHours boolOptional

Whether the order is eligible for extended-hours trading.

LimitOffset stringOptional

Limit offset for trailing stop-limit orders (signed)

LimitPrice stringOptional

Limit price (for LIMIT and STOP_LIMIT orders)

QueueState QueueStateOptional

Parent order queue state, present when the order is awaiting release or released.

One of the following:
const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"
const QueueStateReleased QueueState = "RELEASED"
ReleasesAt TimeOptional

Scheduled release time for orders awaiting release.

formatdate-time
StopPrice stringOptional

Stop price (for STOP and STOP_LIMIT orders)

TrailingLimitPx stringOptional

Current trailing limit price computed by the trailing strategy

TrailingOffset stringOptional

Trailing offset amount for trailing orders

TrailingOffsetType TrailingOffsetTypeOptional

Trailing offset type for trailing orders

One of the following:
const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"
const TrailingOffsetTypeBps TrailingOffsetType = "BPS"
TrailingStopPx stringOptional

Current trailing stop price computed by the trailing strategy

TrailingWatermarkPx stringOptional

Trailing watermark price for trailing orders

TrailingWatermarkTs TimeOptional

Trailing watermark timestamp for trailing orders

formatdate-time
UnderlyingInstrumentID stringOptional

OEMS instrument ID of the option’s underlying instrument. Populated only for OPTIONS orders; null for non-options and for options whose underlier cannot be resolved from the instrument cache.

formatuuid
type OrderList []Order
ID string

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

AccountID int64

Account placing the order

formatint64
ClientOrderID string

Client-provided identifier echoed back (FIX tag 11).

CreatedAt Time

Timestamp when order was created (UTC)

formatdate-time
FilledQuantity string

Cumulative filled quantity

InstrumentID string

OEMS instrument UUID for the traded instrument.

formatuuid
InstrumentType SecurityType

Type of security

One of the following:
const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"
const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"
const SecurityTypeOption SecurityType = "OPTION"
const SecurityTypeCash SecurityType = "CASH"
const SecurityTypeOther SecurityType = "OTHER"
LeavesQuantity string

Remaining unfilled quantity

OrderType OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
const OrderTypeMarket OrderType = "MARKET"
const OrderTypeLimit OrderType = "LIMIT"
const OrderTypeStop OrderType = "STOP"
const OrderTypeStopLimit OrderType = "STOP_LIMIT"
const OrderTypeTrailingStop OrderType = "TRAILING_STOP"
const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"
const OrderTypeOther OrderType = "OTHER"
Quantity string

Total order quantity

Side Side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:
const SideBuy Side = "BUY"
const SideSell Side = "SELL"
const SideSellShort Side = "SELL_SHORT"
const SideOther Side = "OTHER"

Current status of the order

One of the following:
const OrderStatusPendingNew OrderStatus = "PENDING_NEW"
const OrderStatusNew OrderStatus = "NEW"
const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"
const OrderStatusFilled OrderStatus = "FILLED"
const OrderStatusCanceled OrderStatus = "CANCELED"
const OrderStatusRejected OrderStatus = "REJECTED"
const OrderStatusExpired OrderStatus = "EXPIRED"
const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"
const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"
const OrderStatusReplaced OrderStatus = "REPLACED"
const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"
const OrderStatusStopped OrderStatus = "STOPPED"
const OrderStatusSuspended OrderStatus = "SUSPENDED"
const OrderStatusCalculated OrderStatus = "CALCULATED"
const OrderStatusOther OrderStatus = "OTHER"
Symbol string

Trading symbol

TimeInForce TimeInForce

Time in force instruction

One of the following:
const TimeInForceDay TimeInForce = "DAY"
const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"
const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"
const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"
const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"
const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"
const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"
const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"
const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"
const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"
const TimeInForceOther TimeInForce = "OTHER"
UpdatedAt Time

Timestamp of the most recent update (UTC)

formatdate-time
Venue string

MIC code of the venue where the order is routed

AverageFillPrice stringOptional

Average fill price across all executions

Details []stringOptional

Contains execution, rejection or cancellation details, if any

ExpiresAt TimeOptional

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

formatdate-time
ExtendedHours boolOptional

Whether the order is eligible for extended-hours trading.

LimitOffset stringOptional

Limit offset for trailing stop-limit orders (signed)

LimitPrice stringOptional

Limit price (for LIMIT and STOP_LIMIT orders)

QueueState QueueStateOptional

Parent order queue state, present when the order is awaiting release or released.

One of the following:
const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"
const QueueStateReleased QueueState = "RELEASED"
ReleasesAt TimeOptional

Scheduled release time for orders awaiting release.

formatdate-time
StopPrice stringOptional

Stop price (for STOP and STOP_LIMIT orders)

TrailingLimitPx stringOptional

Current trailing limit price computed by the trailing strategy

TrailingOffset stringOptional

Trailing offset amount for trailing orders

TrailingOffsetType TrailingOffsetTypeOptional

Trailing offset type for trailing orders

One of the following:
const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"
const TrailingOffsetTypeBps TrailingOffsetType = "BPS"
TrailingStopPx stringOptional

Current trailing stop price computed by the trailing strategy

TrailingWatermarkPx stringOptional

Trailing watermark price for trailing orders

TrailingWatermarkTs TimeOptional

Trailing watermark timestamp for trailing orders

formatdate-time
UnderlyingInstrumentID stringOptional

OEMS instrument ID of the option’s underlying instrument. Populated only for OPTIONS orders; null for non-options and for options whose underlier cannot be resolved from the instrument cache.

formatuuid
type OrderStatus string

Order status

One of the following:
const OrderStatusPendingNew OrderStatus = "PENDING_NEW"
const OrderStatusNew OrderStatus = "NEW"
const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"
const OrderStatusFilled OrderStatus = "FILLED"
const OrderStatusCanceled OrderStatus = "CANCELED"
const OrderStatusRejected OrderStatus = "REJECTED"
const OrderStatusExpired OrderStatus = "EXPIRED"
const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"
const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"
const OrderStatusReplaced OrderStatus = "REPLACED"
const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"
const OrderStatusStopped OrderStatus = "STOPPED"
const OrderStatusSuspended OrderStatus = "SUSPENDED"
const OrderStatusCalculated OrderStatus = "CALCULATED"
const OrderStatusOther OrderStatus = "OTHER"
type OrderType string

Order type

One of the following:
const OrderTypeMarket OrderType = "MARKET"
const OrderTypeLimit OrderType = "LIMIT"
const OrderTypeStop OrderType = "STOP"
const OrderTypeStopLimit OrderType = "STOP_LIMIT"
const OrderTypeTrailingStop OrderType = "TRAILING_STOP"
const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"
const OrderTypeOther OrderType = "OTHER"
type PositionEffect string

Position effect for options orders

One of the following:
const PositionEffectOpen PositionEffect = "OPEN"
const PositionEffectClose PositionEffect = "CLOSE"
type QueueState string

Parent order queue or hold state.

One of the following:
const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"
const QueueStateReleased QueueState = "RELEASED"
type RequestOrderType string

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

One of the following:
const RequestOrderTypeMarket RequestOrderType = "MARKET"
const RequestOrderTypeLimit RequestOrderType = "LIMIT"
const RequestOrderTypeStop RequestOrderType = "STOP"
const RequestOrderTypeStopLimit RequestOrderType = "STOP_LIMIT"
const RequestOrderTypeTrailingStop RequestOrderType = "TRAILING_STOP"
const RequestOrderTypeTrailingStopLimit RequestOrderType = "TRAILING_STOP_LIMIT"
type RequestTimeInForce string

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

One of the following:
const RequestTimeInForceDay RequestTimeInForce = "DAY"
const RequestTimeInForceGoodTillCancel RequestTimeInForce = "GOOD_TILL_CANCEL"
const RequestTimeInForceImmediateOrCancel RequestTimeInForce = "IMMEDIATE_OR_CANCEL"
const RequestTimeInForceFillOrKill RequestTimeInForce = "FILL_OR_KILL"
const RequestTimeInForceGoodTillDate RequestTimeInForce = "GOOD_TILL_DATE"
const RequestTimeInForceAtTheOpening RequestTimeInForce = "AT_THE_OPENING"
const RequestTimeInForceAtTheClose RequestTimeInForce = "AT_THE_CLOSE"
const RequestTimeInForceGoodTillCrossing RequestTimeInForce = "GOOD_TILL_CROSSING"
const RequestTimeInForceGoodThroughCrossing RequestTimeInForce = "GOOD_THROUGH_CROSSING"
const RequestTimeInForceAtCrossing RequestTimeInForce = "AT_CROSSING"
type Side string

Side of an order

One of the following:
const SideBuy Side = "BUY"
const SideSell Side = "SELL"
const SideSellShort Side = "SELL_SHORT"
const SideOther Side = "OTHER"
type TimeInForce string

Time in force

One of the following:
const TimeInForceDay TimeInForce = "DAY"
const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"
const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"
const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"
const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"
const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"
const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"
const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"
const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"
const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"
const TimeInForceOther TimeInForce = "OTHER"
type TrailingOffsetType string

Trailing offset type for trailing stop orders.

One of the following:
const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"
const TrailingOffsetTypeBps TrailingOffsetType = "BPS"

V1Positions

View positions and manage position instructions.

Get Positions
client.V1.Positions.GetPositions(ctx, accountID, query) (*V1PositionGetPositionsResponse, error)
GET/v1/accounts/{account_id}/positions
Close Positions
client.V1.Positions.ClosePositions(ctx, accountID, body) (*V1PositionClosePositionsResponse, error)
DELETE/v1/accounts/{account_id}/positions
Close Position
client.V1.Positions.ClosePosition(ctx, instrumentID, params) (*V1PositionClosePositionResponse, error)
DELETE/v1/accounts/{account_id}/positions/{instrument_id}
List Position Instructions
client.V1.Positions.GetPositionInstructions(ctx, accountID, query) (*V1PositionGetPositionInstructionsResponse, error)
GET/v1/accounts/{account_id}/positions/instructions
Submit Position Instructions
client.V1.Positions.SubmitPositionInstructions(ctx, accountID, body) (*V1PositionSubmitPositionInstructionsResponse, error)
POST/v1/accounts/{account_id}/positions/instructions
Cancel Position Instruction
client.V1.Positions.CancelPositionInstruction(ctx, instructionID, body) (*V1PositionCancelPositionInstructionResponse, error)
DELETE/v1/accounts/{account_id}/positions/instructions/{instruction_id}
ModelsExpand Collapse
type Position struct{…}

Represents a holding of a particular instrument in an account

AccountID int64

The account this position belongs to

formatint64
AvailableQuantity string

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

InstrumentID string

OEMS instrument UUID

formatuuid
InstrumentType SecurityType

Type of security

One of the following:
const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"
const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"
const SecurityTypeOption SecurityType = "OPTION"
const SecurityTypeCash SecurityType = "CASH"
const SecurityTypeOther SecurityType = "OTHER"
MarketValue string

The current market value of the position

PositionType PositionType

The type of position

One of the following:
const PositionTypeLong PositionType = "LONG"
const PositionTypeShort PositionType = "SHORT"
const PositionTypeLongCall PositionType = "LONG_CALL"
const PositionTypeShortCall PositionType = "SHORT_CALL"
const PositionTypeLongPut PositionType = "LONG_PUT"
const PositionTypeShortPut PositionType = "SHORT_PUT"
Quantity string

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

Symbol string

The trading symbol for the instrument

AvgPrice stringOptional

The average price paid per share or contract for this position

ClosingPrice stringOptional

The closing price used to value the position for the last trading day

ClosingPriceDate TimeOptional

The market date associated with closing_price

formatdate
CostBasis stringOptional

The total cost basis for this position

DailyUnrealizedPnl stringOptional

The unrealized profit or loss for this position relative to the previous close

DailyUnrealizedPnlPct stringOptional

The unrealized profit/loss for the position for the current day, expressed as a percentage of the baseline value (range: 0-100).

InstrumentPrice stringOptional

The current market price of the instrument

UnderlyingInstrumentID stringOptional

OEMS instrument identifier of the underlying instrument, if resolvable

formatuuid
UnrealizedPnl stringOptional

The total unrealized profit or loss for this position based on current market value

UnrealizedPnlPct stringOptional

The unrealized profit/loss for the position, expressed as a percentage of the position’s cost basis (range: 0-100).

type PositionInstruction struct{…}

A position instruction and its current lifecycle state.

ID string

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

formatuuid
AccountID int64

Account the instruction belongs to.

formatint64
InstructionID string

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

InstructionType PositionInstructionType

The action this instruction requests.

One of the following:
const PositionInstructionTypeExercise PositionInstructionType = "EXERCISE"
const PositionInstructionTypeDoNotExercise PositionInstructionType = "DO_NOT_EXERCISE"
const PositionInstructionTypeContraryExercise PositionInstructionType = "CONTRARY_EXERCISE"
InstrumentID string

Identifier of the options contract this instruction acts on.

formatuuid
Quantity string

Number of contracts included in the instruction.

Current lifecycle status.

One of the following:
const PositionInstructionStatusSent PositionInstructionStatus = "SENT"
const PositionInstructionStatusAccepted PositionInstructionStatus = "ACCEPTED"
const PositionInstructionStatusRejected PositionInstructionStatus = "REJECTED"
const PositionInstructionStatusEngineRejected PositionInstructionStatus = "ENGINE_REJECTED"
const PositionInstructionStatusCancelRequested PositionInstructionStatus = "CANCEL_REQUESTED"
const PositionInstructionStatusCancelled PositionInstructionStatus = "CANCELLED"
const PositionInstructionStatusCancelFailed PositionInstructionStatus = "CANCEL_FAILED"
const PositionInstructionStatusUnknown PositionInstructionStatus = "UNKNOWN"
Symbol string

Options symbol (OSI) for display.

AcceptedQuantity stringOptional

Number of contracts accepted by the clearing venue. Populated once the instruction reaches ACCEPTED.

CreatedAt TimeOptional

When the instruction was first accepted by the service.

formatdate-time
RejectionReason stringOptional

Human-readable explanation populated on any non-success terminal status — REJECTED, ENGINE_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.

UpdatedAt TimeOptional

When the instruction’s lifecycle state last changed.

formatdate-time
type PositionInstructionList []PositionInstruction
ID string

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

formatuuid
AccountID int64

Account the instruction belongs to.

formatint64
InstructionID string

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

InstructionType PositionInstructionType

The action this instruction requests.

One of the following:
const PositionInstructionTypeExercise PositionInstructionType = "EXERCISE"
const PositionInstructionTypeDoNotExercise PositionInstructionType = "DO_NOT_EXERCISE"
const PositionInstructionTypeContraryExercise PositionInstructionType = "CONTRARY_EXERCISE"
InstrumentID string

Identifier of the options contract this instruction acts on.

formatuuid
Quantity string

Number of contracts included in the instruction.

Current lifecycle status.

One of the following:
const PositionInstructionStatusSent PositionInstructionStatus = "SENT"
const PositionInstructionStatusAccepted PositionInstructionStatus = "ACCEPTED"
const PositionInstructionStatusRejected PositionInstructionStatus = "REJECTED"
const PositionInstructionStatusEngineRejected PositionInstructionStatus = "ENGINE_REJECTED"
const PositionInstructionStatusCancelRequested PositionInstructionStatus = "CANCEL_REQUESTED"
const PositionInstructionStatusCancelled PositionInstructionStatus = "CANCELLED"
const PositionInstructionStatusCancelFailed PositionInstructionStatus = "CANCEL_FAILED"
const PositionInstructionStatusUnknown PositionInstructionStatus = "UNKNOWN"
Symbol string

Options symbol (OSI) for display.

AcceptedQuantity stringOptional

Number of contracts accepted by the clearing venue. Populated once the instruction reaches ACCEPTED.

CreatedAt TimeOptional

When the instruction was first accepted by the service.

formatdate-time
RejectionReason stringOptional

Human-readable explanation populated on any non-success terminal status — REJECTED, ENGINE_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.

UpdatedAt TimeOptional

When the instruction’s lifecycle state last changed.

formatdate-time
type PositionInstructionStatus string

Lifecycle status of a position instruction.

One of the following:
const PositionInstructionStatusSent PositionInstructionStatus = "SENT"
const PositionInstructionStatusAccepted PositionInstructionStatus = "ACCEPTED"
const PositionInstructionStatusRejected PositionInstructionStatus = "REJECTED"
const PositionInstructionStatusEngineRejected PositionInstructionStatus = "ENGINE_REJECTED"
const PositionInstructionStatusCancelRequested PositionInstructionStatus = "CANCEL_REQUESTED"
const PositionInstructionStatusCancelled PositionInstructionStatus = "CANCELLED"
const PositionInstructionStatusCancelFailed PositionInstructionStatus = "CANCEL_FAILED"
const PositionInstructionStatusUnknown PositionInstructionStatus = "UNKNOWN"
type PositionInstructionType string

The action to take against an options position.

One of the following:
const PositionInstructionTypeExercise PositionInstructionType = "EXERCISE"
const PositionInstructionTypeDoNotExercise PositionInstructionType = "DO_NOT_EXERCISE"
const PositionInstructionTypeContraryExercise PositionInstructionType = "CONTRARY_EXERCISE"
type PositionList []Position
AccountID int64

The account this position belongs to

formatint64
AvailableQuantity string

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

InstrumentID string

OEMS instrument UUID

formatuuid
InstrumentType SecurityType

Type of security

One of the following:
const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"
const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"
const SecurityTypeOption SecurityType = "OPTION"
const SecurityTypeCash SecurityType = "CASH"
const SecurityTypeOther SecurityType = "OTHER"
MarketValue string

The current market value of the position

PositionType PositionType

The type of position

One of the following:
const PositionTypeLong PositionType = "LONG"
const PositionTypeShort PositionType = "SHORT"
const PositionTypeLongCall PositionType = "LONG_CALL"
const PositionTypeShortCall PositionType = "SHORT_CALL"
const PositionTypeLongPut PositionType = "LONG_PUT"
const PositionTypeShortPut PositionType = "SHORT_PUT"
Quantity string

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

Symbol string

The trading symbol for the instrument

AvgPrice stringOptional

The average price paid per share or contract for this position

ClosingPrice stringOptional

The closing price used to value the position for the last trading day

ClosingPriceDate TimeOptional

The market date associated with closing_price

formatdate
CostBasis stringOptional

The total cost basis for this position

DailyUnrealizedPnl stringOptional

The unrealized profit or loss for this position relative to the previous close

DailyUnrealizedPnlPct stringOptional

The unrealized profit/loss for the position for the current day, expressed as a percentage of the baseline value (range: 0-100).

InstrumentPrice stringOptional

The current market price of the instrument

UnderlyingInstrumentID stringOptional

OEMS instrument identifier of the underlying instrument, if resolvable

formatuuid
UnrealizedPnl stringOptional

The total unrealized profit or loss for this position based on current market value

UnrealizedPnlPct stringOptional

The unrealized profit/loss for the position, expressed as a percentage of the position’s cost basis (range: 0-100).

type PositionType string

Position type classification

One of the following:
const PositionTypeLong PositionType = "LONG"
const PositionTypeShort PositionType = "SHORT"
const PositionTypeLongCall PositionType = "LONG_CALL"
const PositionTypeShortCall PositionType = "SHORT_CALL"
const PositionTypeLongPut PositionType = "LONG_PUT"
const PositionTypeShortPut PositionType = "SHORT_PUT"

V1Watchlist

Create and manage watchlists.

Get Watchlists
client.V1.Watchlist.GetWatchlists(ctx, query) (*V1WatchlistGetWatchlistsResponse, error)
GET/v1/watchlists
Get Watchlist By ID
client.V1.Watchlist.GetWatchlistByID(ctx, watchlistID) (*V1WatchlistGetWatchlistByIDResponse, error)
GET/v1/watchlists/{watchlist_id}
Create Watchlist
client.V1.Watchlist.NewWatchlist(ctx, body) (*V1WatchlistNewWatchlistResponse, error)
POST/v1/watchlists
Delete Watchlist
client.V1.Watchlist.DeleteWatchlist(ctx, watchlistID) (*V1WatchlistDeleteWatchlistResponse, error)
DELETE/v1/watchlists/{watchlist_id}
Add Watchlist Item
client.V1.Watchlist.AddWatchlistItem(ctx, watchlistID, body) (*V1WatchlistAddWatchlistItemResponse, error)
POST/v1/watchlists/{watchlist_id}/items
Delete Watchlist Item
client.V1.Watchlist.DeleteWatchlistItem(ctx, itemID, body) (*V1WatchlistDeleteWatchlistItemResponse, error)
DELETE/v1/watchlists/{watchlist_id}/items/{item_id}
ModelsExpand Collapse
type AddWatchlistItemData struct{…}

Response data for adding a watchlist item

ItemID string

ID of the created item

formatuuid
type WatchlistDetail struct{…}

Detailed watchlist with all items

ID string

Watchlist ID

formatuuid
CreatedAt Time

Creation timestamp

formatdate-time

Items in the watchlist

ID string

Item ID

formatuuid
AddedAt Time

When the item was added

formatdate-time
AddedPrice stringOptional

Price when the item was added

Instrument InstrumentOptional

Instrument details

ID string

Unique OEMS instrument identifier (UUID)

formatuuid
CountryOfIssue string

The ISO country code of the instrument’s issue

Currency string

The ISO currency code in which the instrument is traded

EasyToBorrow bool

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

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsRestricted bool

Indicates if the instrument is restricted from trading

IsShortProhibited bool

Indicates if short selling is prohibited for the instrument

IsThresholdSecurity bool

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

IsTradable bool

Indicates if the instrument is tradable

Symbol string

The trading symbol for the instrument

Venue string

The MIC code of the primary listing venue

Adv stringOptional

Average daily share volume from the security definition.

Expiry TimeOptional

The expiration date for options instruments

formatdate
InstrumentType SecurityTypeOptional

The type of security (e.g., Common Stock, ETF)

One of the following:
const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"
const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"
const SecurityTypeOption SecurityType = "OPTION"
const SecurityTypeCash SecurityType = "CASH"
const SecurityTypeOther SecurityType = "OTHER"
LongMarginRate stringOptional

The percent of a long position’s value you must post as margin

Name stringOptional

The full name of the instrument or its issuer

NotionalAdv stringOptional

Notional ADV (adv × previous_close). The primary liquidity signal used by /instruments/search ranking. Computed at response time so it stays consistent with whatever adv and previous_close show.

OptionsExpiryDates []TimeOptional

Available options expiration dates for this instrument. Present only when include_options_expiry_dates=true in the request.

PreviousClose stringOptional

Last close price from the security definition.

ShortMarginRate stringOptional

The percent of a short position’s value you must post as margin

StrikePrice stringOptional

The strike price for options instruments

Name string

Watchlist name

type WatchlistEntry struct{…}

Represents a user watchlist.

ID string

The unique identifier for the watchlist.

formatuuid
CreatedAt Time

The timestamp when the watchlist was created.

formatdate-time
Name string

The user-provided watchlist name.

type WatchlistEntryList []WatchlistEntry
ID string

The unique identifier for the watchlist.

formatuuid
CreatedAt Time

The timestamp when the watchlist was created.

formatdate-time
Name string

The user-provided watchlist name.

type WatchlistItemEntry struct{…}

A single item in a watchlist

ID string

Item ID

formatuuid
AddedAt Time

When the item was added

formatdate-time
AddedPrice stringOptional

Price when the item was added

Instrument InstrumentOptional

Instrument details

ID string

Unique OEMS instrument identifier (UUID)

formatuuid
CountryOfIssue string

The ISO country code of the instrument’s issue

Currency string

The ISO currency code in which the instrument is traded

EasyToBorrow bool

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

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsRestricted bool

Indicates if the instrument is restricted from trading

IsShortProhibited bool

Indicates if short selling is prohibited for the instrument

IsThresholdSecurity bool

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

IsTradable bool

Indicates if the instrument is tradable

Symbol string

The trading symbol for the instrument

Venue string

The MIC code of the primary listing venue

Adv stringOptional

Average daily share volume from the security definition.

Expiry TimeOptional

The expiration date for options instruments

formatdate
InstrumentType SecurityTypeOptional

The type of security (e.g., Common Stock, ETF)

One of the following:
const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"
const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"
const SecurityTypeOption SecurityType = "OPTION"
const SecurityTypeCash SecurityType = "CASH"
const SecurityTypeOther SecurityType = "OTHER"
LongMarginRate stringOptional

The percent of a long position’s value you must post as margin

Name stringOptional

The full name of the instrument or its issuer

NotionalAdv stringOptional

Notional ADV (adv × previous_close). The primary liquidity signal used by /instruments/search ranking. Computed at response time so it stays consistent with whatever adv and previous_close show.

OptionsExpiryDates []TimeOptional

Available options expiration dates for this instrument. Present only when include_options_expiry_dates=true in the request.

PreviousClose stringOptional

Last close price from the security definition.

ShortMarginRate stringOptional

The percent of a short position’s value you must post as margin

StrikePrice stringOptional

The strike price for options instruments

V1Websocket

Active Websocket.

Websocket Handler
client.V1.Websocket.WebsocketHandler(ctx) error
GET/v1/ws