API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

V1

ModelsExpand Collapse

type SecurityType string

Security type

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

type SortDirection string

Sort direction sorted results

One of the following:

const SortDirectionAsc SortDirection = "ASC"

const SortDirectionDesc SortDirection = "DESC"

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

Status AccountStatus

The current status of the account

One of the following:

const AccountStatusActive AccountStatus = "ACTIVE"

const AccountStatusInactive AccountStatus = "INACTIVE"

const AccountStatusClosed AccountStatus = "CLOSED"

Subtype AccountSubtype

The sub-type of account

One of the following:

const AccountSubtypeCash AccountSubtype = "CASH"

const AccountSubtypeMargin AccountSubtype = "MARGIN"

const AccountSubtypeOther AccountSubtype = "OTHER"

Type AccountType

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

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.

DailyChange string

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

DailyPnl string

Total profit or loss since start of day.

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.

Sod AccountBalancesSod

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

formatdate

DeprecatedDayTradeBuyingPower stringOptional

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

MaintenanceMarginExcess stringOptional

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

MaintenanceMarginRequirement stringOptional

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

TradeCash stringOptional

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

TradeCash string

Trade-date effective cash.

UnrealizedPnl string

Total unrealized profit or loss across all open positions.

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

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

IntradayDetails MarginSessionDetails

Intraday session margin calculation details.

BuyingPower string

Maximum buying power available in the account during the session.

Multiplier stringOptional

Effective multiplier for margin calculations during the session.

MaintenanceMarginExcess string

Maintenance margin excess for trade-date balances.

MaintenanceMarginRequirement string

Maintenance margin requirement for trade-date balances.

OvernightDetails MarginSessionDetails

Overnight session margin calculation details.

BuyingPower string

Maximum buying power available in the account during the session.

Multiplier stringOptional

Effective multiplier for margin calculations during the session.

DeprecatedPatternDayTrader bool

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

DeprecatedDayTradeBuyingPowerUsage stringOptional

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

TopContributors []MarginTopContributorOptional

Optional top margin contributors, returned only when explicitly requested.

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

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

ShortMarketValue stringOptional

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

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

formatdate

DeprecatedDayTradeBuyingPower stringOptional

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

MaintenanceMarginExcess stringOptional

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

MaintenanceMarginRequirement stringOptional

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

TradeCash stringOptional

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

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

Status AccountStatus

The current status of the account

One of the following:

const AccountStatusActive AccountStatus = "ACTIVE"

const AccountStatusInactive AccountStatus = "INACTIVE"

const AccountStatusClosed AccountStatus = "CLOSED"

Subtype AccountSubtype

The sub-type of account

One of the following:

const AccountSubtypeCash AccountSubtype = "CASH"

const AccountSubtypeMargin AccountSubtype = "MARGIN"

const AccountSubtypeOther AccountSubtype = "OTHER"

Type AccountType

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

formatdate

type AccountSettings struct{…}

Risk RiskSettingsOptional

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

MaxNotional stringOptional

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

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{…}

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

IntradayDetails MarginSessionDetails

Intraday session margin calculation details.

BuyingPower string

Maximum buying power available in the account during the session.

Multiplier stringOptional

Effective multiplier for margin calculations during the session.

MaintenanceMarginExcess string

Maintenance margin excess for trade-date balances.

MaintenanceMarginRequirement string

Maintenance margin requirement for trade-date balances.

OvernightDetails MarginSessionDetails

Overnight session margin calculation details.

BuyingPower string

Maximum buying power available in the account during the session.

Multiplier stringOptional

Effective multiplier for margin calculations during the session.

DeprecatedPatternDayTrader bool

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

DeprecatedDayTradeBuyingPowerUsage stringOptional

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

TopContributors []MarginTopContributorOptional

Optional top margin contributors, returned only when explicitly requested.

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

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 MarginSessionDetails struct{…}

BuyingPower string

Maximum buying power available in the account during the session.

Multiplier stringOptional

Effective multiplier for margin calculations during the session.

type MarginTopContributor struct{…}

DeprecatedDayTradeBuyingPowerUsage 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{…}

Segments []PortfolioHistorySegment

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

V1API Version

Endpoints for API service metadata.

Get the API version.

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

PreMarket SessionScheduleOptional

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

Regular SessionScheduleOptional

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

Status MarketStatus

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

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

PreMarket SessionScheduleOptional

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

Regular SessionScheduleOptional

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

PreMarket SessionScheduleOptional

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

Regular SessionScheduleOptional

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

Status MarketStatus

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

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

PreMarket SessionScheduleOptional

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

Regular SessionScheduleOptional

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

type TradingSessions struct{…}

Trading sessions for a market day with full timestamps

AfterHours SessionScheduleOptional

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

PreMarket SessionScheduleOptional

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

Regular SessionScheduleOptional

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

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

V1Instrument Data

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

Get All Instrument Events

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.

EventDates []InstrumentEventsByDate

Events grouped by date in descending order.

Date Time

Event date.

formatdate

Events []InstrumentEventEnvelope

Flat event envelopes for this date.

Symbol string

Symbol associated with the event.

Type AllEventsEventType

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

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

formatdate

DividendAmount stringOptional

The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.

DividendYield stringOptional

The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.

Frequency stringOptional

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.

PaymentDate TimeOptional

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

formatdate

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

formatdate

EarningsEventData InstrumentEarningsOptional

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

Date Time

The date when the earnings report was published

formatdate

EpsActual stringOptional

The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

EpsEstimate stringOptional

The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

EpsSurprisePercent stringOptional

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

RevenueActual stringOptional

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

RevenueEstimate stringOptional

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

RevenueSurprisePercent stringOptional

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

InstrumentID stringOptional

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

formatuuid

IpoEventData InstrumentEventIpoItemOptional

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

Actions stringOptional

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

AnnouncedAt TimeOptional

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

formatdate-time

Company stringOptional

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

Exchange stringOptional

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

MarketCap stringOptional

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

PriceRange stringOptional

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

Shares stringOptional

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

Name stringOptional

Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.

ReportingCurrency stringOptional

The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.

StockSplitEventData InstrumentSplitEventOptional

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

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

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

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

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

formatdate

DividendAmount stringOptional

The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.

DividendYield stringOptional

The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.

Frequency stringOptional

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.

PaymentDate TimeOptional

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

formatdate

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

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

EpsEstimate stringOptional

The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

EpsSurprisePercent stringOptional

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

RevenueActual stringOptional

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

RevenueEstimate stringOptional

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

RevenueSurprisePercent stringOptional

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

type InstrumentEventEnvelope struct{…}

Unified envelope for the all-events response.

Symbol string

Symbol associated with the event.

Type AllEventsEventType

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

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

formatdate

DividendAmount stringOptional

The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.

DividendYield stringOptional

The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.

Frequency stringOptional

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.

PaymentDate TimeOptional

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

formatdate

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

formatdate

EarningsEventData InstrumentEarningsOptional

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

Date Time

The date when the earnings report was published

formatdate

EpsActual stringOptional

The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

EpsEstimate stringOptional

The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

EpsSurprisePercent stringOptional

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

RevenueActual stringOptional

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

RevenueEstimate stringOptional

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

RevenueSurprisePercent stringOptional

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

InstrumentID stringOptional

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

formatuuid

IpoEventData InstrumentEventIpoItemOptional

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

Actions stringOptional

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

AnnouncedAt TimeOptional

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

formatdate-time

Company stringOptional

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

Exchange stringOptional

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

MarketCap stringOptional

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

PriceRange stringOptional

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

Shares stringOptional

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

Name stringOptional

Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.

ReportingCurrency stringOptional

The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.

StockSplitEventData InstrumentSplitEventOptional

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

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

AnnouncedAt TimeOptional

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

formatdate-time

Company stringOptional

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

Exchange stringOptional

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

MarketCap stringOptional

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

PriceRange stringOptional

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

Shares stringOptional

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

type InstrumentEventsByDate struct{…}

Instrument events for a single date.

Date Time

Event date.

formatdate

Events []InstrumentEventEnvelope

Flat event envelopes for this date.

Symbol string

Symbol associated with the event.

Type AllEventsEventType

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

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

formatdate

DividendAmount stringOptional

The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.

DividendYield stringOptional

The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.

Frequency stringOptional

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.

PaymentDate TimeOptional

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

formatdate

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

formatdate

EarningsEventData InstrumentEarningsOptional

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

Date Time

The date when the earnings report was published

formatdate

EpsActual stringOptional

The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

EpsEstimate stringOptional

The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

EpsSurprisePercent stringOptional

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

RevenueActual stringOptional

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

RevenueEstimate stringOptional

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

RevenueSurprisePercent stringOptional

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

InstrumentID stringOptional

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

formatuuid

IpoEventData InstrumentEventIpoItemOptional

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

Actions stringOptional

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

AnnouncedAt TimeOptional

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

formatdate-time

Company stringOptional

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

Exchange stringOptional

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

MarketCap stringOptional

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

PriceRange stringOptional

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

Shares stringOptional

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

Name stringOptional

Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.

ReportingCurrency stringOptional

The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.

StockSplitEventData InstrumentSplitEventOptional

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

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

Dividends []InstrumentDividendEvent

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

formatdate

DividendAmount stringOptional

The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.

DividendYield stringOptional

The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.

Frequency stringOptional

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.

PaymentDate TimeOptional

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

formatdate

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

formatdate

Earnings []InstrumentEarnings

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

EpsEstimate stringOptional

The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

EpsSurprisePercent stringOptional

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

RevenueActual stringOptional

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

RevenueEstimate stringOptional

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

RevenueSurprisePercent stringOptional

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

InstrumentID string

Instrument identifier

formatuuid

Splits []InstrumentSplitEvent

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

formatint64

Beta stringOptional

The beta value, measuring the instrument’s volatility relative to the overall market When a null/undefined value is observed, it indicates that there is no available data.

Description stringOptional

A detailed description of the instrument or company When a null/undefined value is observed, it indicates that there is no available data.

DividendYield stringOptional

The trailing twelve months (TTM) dividend yield When a null/undefined value is observed, it indicates that there is no available data.

EarningsPerShare stringOptional

The trailing twelve months (TTM) earnings per share When a null/undefined value is observed, it indicates that there is no available data.

FiftyTwoWeekHigh stringOptional

The highest price over the last 52 weeks When a null/undefined value is observed, it indicates that there is no available data.

FiftyTwoWeekLow stringOptional

The lowest price over the last 52 weeks When a null/undefined value is observed, it indicates that there is no available data.

Industry stringOptional

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

ListDate TimeOptional

The date the instrument was first listed When a null/undefined value is observed, it indicates that there is no available data.

formatdate

LogoURL stringOptional

URL to a representative logo image for the instrument or issuer When a null/undefined value is observed, it indicates that there is no available data.

MarketCap stringOptional

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

PreviousClose stringOptional

The closing price from the previous trading day When a null/undefined value is observed, it indicates that there is no available data.

PriceToEarnings stringOptional

The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) When a null/undefined value is observed, it indicates that there is no available data.

ReportingCurrency stringOptional

The currency used for reporting financial data When a null/undefined value is observed, it indicates that there is no available data.

Sector stringOptional

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

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

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

formatuuid

High stringOptional

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

Low stringOptional

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

Open stringOptional

Opening price for the session. When a null/undefined value is observed, it indicates that there is no available data.

Symbol stringOptional

Display symbol for the security. None for unresolvable IDs. When a null/undefined value is observed, it indicates that there is no available data.

TradeDate TimeOptional

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

formatdate

Volume int64Optional

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

formatint64

type DailySummaryList []DailySummary

InstrumentID string

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

formatuuid

High stringOptional

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

Low stringOptional

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

Open stringOptional

Opening price for the session. When a null/undefined value is observed, it indicates that there is no available data.

Symbol stringOptional

Display symbol for the security. None for unresolvable IDs. When a null/undefined value is observed, it indicates that there is no available data.

TradeDate TimeOptional

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

formatdate

Volume int64Optional

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

formatint64

type MarketDataSnapshot struct{…}

Market data snapshot for a single security.

InstrumentID string

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

formatint64

minimum0

Greeks SnapshotGreeksOptional

Theoretical price and Greeks for option instruments. None for equities, and for options whose Greeks have not yet been observed When a null/undefined value is observed, it indicates that there is no available data.

Delta string

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

Gamma string

Gamma: ∂²V/∂S².

Iv string

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

Rho string

Rho per 1.0 rate point.

TheoPrice string

Theoretical option price in USD per share.

Theta string

Theta per trading day.

Timestamp Time

Timestamp when the Greeks were calculated.

formatdate-time

Vega string

Vega per 1.0 vol point.

LastQuote SnapshotQuoteOptional

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

Ask stringOptional

Current best ask. Absent when no ask is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.

AskSize int64Optional

Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.

formatint32

minimum0

Bid stringOptional

Current best bid. Absent when no bid is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.

BidSize int64Optional

Size at the best bid, in shares. When a null/undefined value is observed, it indicates that there is no available data.

formatint32

minimum0

Midpoint stringOptional

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

LastTrade SnapshotLastTradeOptional

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

Price string

Most recent last-sale eligible trade price.

Size int64

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

formatint32

minimum0

Name stringOptional

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

Session SnapshotSessionOptional

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

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

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

formatint64

minimum0

Greeks SnapshotGreeksOptional

Theoretical price and Greeks for option instruments. None for equities, and for options whose Greeks have not yet been observed When a null/undefined value is observed, it indicates that there is no available data.

Delta string

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

Gamma string

Gamma: ∂²V/∂S².

Iv string

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

Rho string

Rho per 1.0 rate point.

TheoPrice string

Theoretical option price in USD per share.

Theta string

Theta per trading day.

Timestamp Time

Timestamp when the Greeks were calculated.

formatdate-time

Vega string

Vega per 1.0 vol point.

LastQuote SnapshotQuoteOptional

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

Ask stringOptional

Current best ask. Absent when no ask is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.

AskSize int64Optional

Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.

formatint32

minimum0

Bid stringOptional

Current best bid. Absent when no bid is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.

BidSize int64Optional

Size at the best bid, in shares. When a null/undefined value is observed, it indicates that there is no available data.

formatint32

minimum0

Midpoint stringOptional

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

LastTrade SnapshotLastTradeOptional

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

Price string

Most recent last-sale eligible trade price.

Size int64

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

formatint32

minimum0

Name stringOptional

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

Session SnapshotSessionOptional

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

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 SnapshotGreeks struct{…}

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

Delta string

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

Gamma string

Gamma: ∂²V/∂S².

Iv string

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

Rho string

Rho per 1.0 rate point.

TheoPrice string

Theoretical option price in USD per share.

Theta string

Theta per trading day.

Timestamp Time

Timestamp when the Greeks were calculated.

formatdate-time

Vega string

Vega per 1.0 vol point.

type SnapshotLastTrade struct{…}

Last-trade fields for a market data snapshot.

Price string

Most recent last-sale eligible trade price.

Size int64

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

formatint32

minimum0

type SnapshotQuote struct{…}

L1 quote fields for a market data snapshot.

Ask stringOptional

Current best ask. Absent when no ask is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.

AskSize int64Optional

Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.

formatint32

minimum0

Bid stringOptional

Current best bid. Absent when no bid is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.

BidSize int64Optional

Size at the best bid, in shares. When a null/undefined value is observed, it indicates that there is no available data.

formatint32

minimum0

Midpoint stringOptional

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

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

Instrument identifier.

formatuuid

Name stringOptional

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

Symbol stringOptional

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

type NewsItem struct{…}

A single news item and its associated instruments.

Instruments []NewsInstrument

Instruments associated with this news item.

InstrumentID string

Instrument identifier.

formatuuid

Name stringOptional

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

Symbol stringOptional

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

NewsType NewsType

Classification of the item.

One of the following:

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

Site stringOptional

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

Text stringOptional

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

type NewsItemList []NewsItem

Instruments []NewsInstrument

Instruments associated with this news item.

InstrumentID string

Instrument identifier.

formatuuid

Name stringOptional

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

Symbol stringOptional

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

NewsType NewsType

Classification of the item.

One of the following:

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

Site stringOptional

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

Text stringOptional

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

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

IsFractionable bool

Indicates if the instrument supports fractional-quantity orders

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsPtp bool

Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.

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

DeprecatedExpiry TimeOptional

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

formatdate

InstrumentType SecurityTypeOptional

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

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

LongMarginRate stringOptional

The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

Name stringOptional

The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.

NotionalAdv stringOptional

Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.

OptionsExpiryDates []TimeOptional

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

PreviousClose stringOptional

Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.

ShortMarginRate stringOptional

The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

DeprecatedStrikePrice stringOptional

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

type InstrumentCore struct{…}

ID string

Unique 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

IsFractionable bool

Indicates if the instrument supports fractional-quantity orders

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsPtp bool

Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.

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

DeprecatedExpiry TimeOptional

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

formatdate

InstrumentType SecurityTypeOptional

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

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

LongMarginRate stringOptional

The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

Name stringOptional

The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.

NotionalAdv stringOptional

Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.

PreviousClose stringOptional

Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.

ShortMarginRate stringOptional

The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

DeprecatedStrikePrice stringOptional

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

type InstrumentCoreList []InstrumentCore

ID string

Unique 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

IsFractionable bool

Indicates if the instrument supports fractional-quantity orders

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsPtp bool

Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.

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

DeprecatedExpiry TimeOptional

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

formatdate

InstrumentType SecurityTypeOptional

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

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

LongMarginRate stringOptional

The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

Name stringOptional

The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.

NotionalAdv stringOptional

Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.

PreviousClose stringOptional

Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.

ShortMarginRate stringOptional

The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

DeprecatedStrikePrice stringOptional

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

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

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

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

formatint64

UnderlyingInstrumentID stringOptional

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

formatuuid

type OptionsContractList []OptionsContract

ID string

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

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

formatint64

UnderlyingInstrumentID stringOptional

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

formatuuid

V1Omni AI

ModelsExpand Collapse

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

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

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

ActionID stringOptional

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

formatuuid

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

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

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

ActionID stringOptional

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

formatuuid

DataChart DataChartOptional

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

Series []ChartSeriesOptional

Name string

Points []ChartPointOptional

X string

Y float64

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

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

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

ActionID stringOptional

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

formatuuid

DataChart DataChartOptional

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

Series []ChartSeriesOptional

Name string

Points []ChartPointOptional

X string

Y float64

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

Timeframe stringOptional

Chart timeframe (e.g., “1D”, “1W”, “1M”, “3M”, “1Y”, “5Y”) When a null/undefined value is observed, it indicates it does not apply.

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

Columns []stringOptional

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

DeprecatedFieldFilter []stringOptional

Deprecated: use columns instead. Mirrors columns.

PageSize int64Optional

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

formatint32

SortBy stringOptional

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

SortDirection stringOptional

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

type StructuredActionOpenEntitlementConsent struct{…}

Open entitlement consent flow

OpenEntitlementConsent OpenEntitlementConsentAction

Open entitlement consent flow

AccountIDs []int64

AgreementKey EntitlementAgreementKey

Stable entitlement agreement family key.

EntitlementCodes []EntitlementCode

Reason string

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

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

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

ActionID stringOptional

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

formatuuid

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 EntitlementAgreementKey string

Stable entitlement agreement family key.

type EntitlementCode string

Stable entitlement code granted by an agreement.

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

Timeframe stringOptional

Chart timeframe (e.g., “1D”, “1W”, “1M”, “3M”, “1Y”, “5Y”) When a null/undefined value is observed, it indicates it does not apply.

type OpenEntitlementConsentAction struct{…}

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

AccountIDs []int64

AgreementKey EntitlementAgreementKey

Stable entitlement agreement family key.

EntitlementCodes []EntitlementCode

Reason string

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

Columns []stringOptional

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

DeprecatedFieldFilter []stringOptional

Deprecated: use columns instead. Mirrors columns.

PageSize int64Optional

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

formatint32

SortBy stringOptional

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

SortDirection stringOptional

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

type PrefillCancelOrderAction struct{…}

Cancel-order prefill action.

Orders []CancelOrderRequest

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 []NewOrderRequest

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

OrderType RequestOrderType

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

Instrument identifier

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 for options. 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., “TSLA”). For options, use the OSI symbol (e.g., “TSLA 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 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

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

Timeframe stringOptional

Chart timeframe (e.g., “1D”, “1W”, “1M”, “3M”, “1Y”, “5Y”) When a null/undefined value is observed, it indicates it does not apply.

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

Columns []stringOptional

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

DeprecatedFieldFilter []stringOptional

Deprecated: use columns instead. Mirrors columns.

PageSize int64Optional

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

formatint32

SortBy stringOptional

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

SortDirection stringOptional

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

type StructuredActionOpenEntitlementConsent struct{…}

Open entitlement consent flow

OpenEntitlementConsent OpenEntitlementConsentAction

Open entitlement consent flow

AccountIDs []int64

AgreementKey EntitlementAgreementKey

Stable entitlement agreement family key.

EntitlementCodes []EntitlementCode

Reason string

type StructuredActionButtonAction struct{…}

Structured-action button behavior.

ActionID stringOptional

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

formatuuid

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

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

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

ActionID stringOptional

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

formatuuid

V1Omni AIEntitlements

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

Get Entitlements

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 EntitlementAgreementResource struct{…}

AgreementID string

AgreementKey EntitlementAgreementKey

Stable entitlement agreement family key.

DocumentContent string

DocumentSha256 string

EntitlementCodes []EntitlementCode

Title string

Version int64

type EntitlementAgreementResourceList []EntitlementAgreementResource

AgreementID string

AgreementKey EntitlementAgreementKey

Stable entitlement agreement family key.

DocumentContent string

DocumentSha256 string

EntitlementCodes []EntitlementCode

Title string

Version int64

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

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

formatuuid

V1Omni AIResponses

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

Get Response By ID

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

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

type Response struct{…}

Dynamic pollable response.

ID string

Status ResponseStatus

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

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

Parts []ResponseContentPartUnion

One of the following:

type ResponseContentPartContentPartText struct{…}

Text content part.

Type string

type ResponseContentPartContentPartThinking struct{…}

Thinking content part shown on dynamic response polling.

Type string

type ResponseContentPartContentPartStructuredAction struct{…}

Structured action content part.

Type string

type ResponseContentPartContentPartChart struct{…}

Chart payload content part.

Type string

type ResponseContentPartContentPartSuggestedActions struct{…}

Suggested actions payload content part.

Type string

type ResponseContentPartContentPartCustom struct{…}

Escape-hatch custom payload content part.

Type string

Error ErrorStatusOptional

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

Code string

Message string

Details anyOptional

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

OutputMessageID stringOptional

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

formatuuid

type ResponseContent struct{…}

Dynamic response content container. May include thinking parts.

Parts []ResponseContentPartUnion

One of the following:

type ResponseContentPartContentPartText struct{…}

Text content part.

Type string

type ResponseContentPartContentPartThinking struct{…}

Thinking content part shown on dynamic response polling.

Type string

type ResponseContentPartContentPartStructuredAction struct{…}

Structured action content part.

Type string

type ResponseContentPartContentPartChart struct{…}

Chart payload content part.

Type string

type ResponseContentPartContentPartSuggestedActions struct{…}

Suggested actions payload content part.

Type string

type ResponseContentPartContentPartCustom 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 ResponseContentPartContentPartText struct{…}

Text content part.

Type string

type ResponseContentPartContentPartThinking struct{…}

Thinking content part shown on dynamic response polling.

Type string

type ResponseContentPartContentPartStructuredAction struct{…}

Structured action content part.

Type string

type ResponseContentPartContentPartChart struct{…}

Chart payload content part.

Type string

type ResponseContentPartContentPartSuggestedActions struct{…}

Suggested actions payload content part.

Type string

type ResponseContentPartContentPartCustom 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 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 MessageContentPartContentPartText struct{…}

Text content part.

Type string

type MessageContentPartContentPartStructuredAction struct{…}

Structured action content part.

Type string

type MessageContentPartContentPartChart struct{…}

Chart payload content part.

Type string

type MessageContentPartContentPartSuggestedActions struct{…}

Suggested actions payload content part.

Type string

type MessageContentPartContentPartCustom struct{…}

Escape-hatch custom payload content part.

Type string

CreatedAt string

Outcome MessageOutcome

Immutable terminal outcome for a finalized assistant message.

One of the following:

const MessageOutcomeCompleted MessageOutcome = "completed"

const MessageOutcomeErrored MessageOutcome = "errored"

const MessageOutcomeCanceled MessageOutcome = "canceled"

Role MessageRole

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

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

Code string

Message string

Details anyOptional

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

type MessageContent struct{…}

Finalized immutable message content container. Never includes thinking parts.

Parts []MessageContentPartUnion

One of the following:

type MessageContentPartContentPartText struct{…}

Text content part.

Type string

type MessageContentPartContentPartStructuredAction struct{…}

Structured action content part.

Type string

type MessageContentPartContentPartChart struct{…}

Chart payload content part.

Type string

type MessageContentPartContentPartSuggestedActions struct{…}

Suggested actions payload content part.

Type string

type MessageContentPartContentPartCustom 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 MessageContentPartContentPartText struct{…}

Text content part.

Type string

type MessageContentPartContentPartStructuredAction struct{…}

Structured action content part.

Type string

type MessageContentPartContentPartChart struct{…}

Chart payload content part.

Type string

type MessageContentPartContentPartSuggestedActions struct{…}

Suggested actions payload content part.

Type string

type MessageContentPartContentPartCustom 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 MessageContentPartContentPartText struct{…}

Text content part.

Type string

type MessageContentPartContentPartStructuredAction struct{…}

Structured action content part.

Type string

type MessageContentPartContentPartChart struct{…}

Chart payload content part.

Type string

type MessageContentPartContentPartSuggestedActions struct{…}

Suggested actions payload content part.

Type string

type MessageContentPartContentPartCustom struct{…}

Escape-hatch custom payload content part.

Type string

CreatedAt string

Outcome MessageOutcome

Immutable terminal outcome for a finalized assistant message.

One of the following:

const MessageOutcomeCompleted MessageOutcome = "completed"

const MessageOutcomeErrored MessageOutcome = "errored"

const MessageOutcomeCanceled MessageOutcome = "canceled"

Role MessageRole

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

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

Code string

Message string

Details anyOptional

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

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

Get Executions

client.V1.Orders.GetExecutions(ctx, accountID, query) (*V1OrderGetExecutionsResponse, error)

GET/v1/accounts/{account_id}/executions

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 Execution struct{…}

Represents a single fill of an order for an account.

ID string

Unique identifier for this execution report.

formatuuid

InstrumentID string

Unique instrument identifier.

formatuuid

OrderID string

Identifier of the order this execution belongs to.

formatuuid

Price string

Fill price.

Quantity string

Filled quantity.

Side Side

Side of the fill.

One of the following:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

const SideSellShort Side = "SELL_SHORT"

const SideOther Side = "OTHER"

Symbol string

Trading symbol.

TransactionTime Time

Transaction timestamp in nanosecond precision (UTC).

formatdate-time

type ExecutionList []Execution

ID string

Unique identifier for this execution report.

formatuuid

InstrumentID string

Unique instrument identifier.

formatuuid

OrderID string

Identifier of the order this execution belongs to.

formatuuid

Price string

Fill price.

Quantity string

Filled quantity.

Side Side

Side of the fill.

One of the following:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

const SideSellShort Side = "SELL_SHORT"

const SideOther Side = "OTHER"

Symbol string

Trading symbol.

TransactionTime Time

Transaction timestamp in nanosecond precision (UTC).

formatdate-time

type InstrumentIDOrSymbol string

Instrument identifier

type NewOrderRequest struct{…}

Request to submit a new order (PlaceOrderRequest from spec)

OrderType RequestOrderType

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

Instrument identifier

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 for options. 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., “TSLA”). For options, use the OSI symbol (e.g., “TSLA 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.

CreatedAt Time

Timestamp when order was created (UTC)

formatdate-time

FilledQuantity string

Cumulative filled quantity

InstrumentID string

Instrument identifier for the traded instrument.

formatuuid

InstrumentType SecurityType

Type of security

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

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"

Status OrderStatus

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

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

formatdate-time

ExtendedHours boolOptional

Whether the order is eligible for extended-hours trading.

LimitOffset stringOptional

Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.

LimitPrice stringOptional

Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.

QueueState QueueStateOptional

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

One of the following:

const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"

const QueueStateReleased QueueState = "RELEASED"

ReleasesAt TimeOptional

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

formatdate-time

StopPrice stringOptional

Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.

TrailingLimitPx stringOptional

Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.

TrailingOffset stringOptional

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

TrailingOffsetType TrailingOffsetTypeOptional

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

One of the following:

const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"

const TrailingOffsetTypeBps TrailingOffsetType = "BPS"

TrailingStopPx stringOptional

Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.

TrailingWatermarkPx stringOptional

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

TrailingWatermarkTs TimeOptional

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

formatdate-time

UnderlyingInstrumentID stringOptional

Instrument ID of the option’s underlying instrument. Populated only for options orders. A null means one of two things: the order is not an option, so the field does not apply; or the order is an option whose underlier has not yet been resolved. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

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.

CreatedAt Time

Timestamp when order was created (UTC)

formatdate-time

FilledQuantity string

Cumulative filled quantity

InstrumentID string

Instrument identifier for the traded instrument.

formatuuid

InstrumentType SecurityType

Type of security

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

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"

Status OrderStatus

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

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

formatdate-time

ExtendedHours boolOptional

Whether the order is eligible for extended-hours trading.

LimitOffset stringOptional

Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.

LimitPrice stringOptional

Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.

QueueState QueueStateOptional

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

One of the following:

const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"

const QueueStateReleased QueueState = "RELEASED"

ReleasesAt TimeOptional

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

formatdate-time

StopPrice stringOptional

Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.

TrailingLimitPx stringOptional

Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.

TrailingOffset stringOptional

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

TrailingOffsetType TrailingOffsetTypeOptional

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

One of the following:

const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"

const TrailingOffsetTypeBps TrailingOffsetType = "BPS"

TrailingStopPx stringOptional

Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.

TrailingWatermarkPx stringOptional

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

TrailingWatermarkTs TimeOptional

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

formatdate-time

UnderlyingInstrumentID stringOptional

Instrument ID of the option’s underlying instrument. Populated only for options orders. A null means one of two things: the order is not an option, so the field does not apply; or the order is an option whose underlier has not yet been resolved. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

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}

Get 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

Unique instrument identifier

formatuuid

InstrumentType SecurityType

Type of security

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

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

ClosingPrice stringOptional

The closing price used to value the position for the last trading day When a null/undefined value is observed, it indicates that there is no available data.

ClosingPriceDate TimeOptional

The market date associated with closing_price When a null/undefined value is observed, it indicates that there is no available data.

formatdate

CostBasis stringOptional

The total cost basis for this position When a null/undefined value is observed, it indicates that there is no available data.

DailyRealizedPnl stringOptional

The realized profit or loss for this position for the current day When a null/undefined value is observed, it indicates that there is no available data.

DailyUnrealizedPnl stringOptional

The unrealized profit or loss for this position relative to the previous close When a null/undefined value is observed, it indicates that there is no available data.

DailyUnrealizedPnlPct stringOptional

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

InstrumentPrice stringOptional

The current market price of the instrument When a null/undefined value is observed, it indicates that there is no available data.

UnderlyingInstrumentID stringOptional

Identifier of the underlying instrument, when available When a null/undefined value is observed, it indicates it does not apply.

formatuuid

UnrealizedPnl stringOptional

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

UnrealizedPnlPct stringOptional

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

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.

Status PositionInstructionStatus

Current lifecycle status.

One of the following:

const PositionInstructionStatusSent PositionInstructionStatus = "SENT"

const PositionInstructionStatusAccepted PositionInstructionStatus = "ACCEPTED"

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

CreatedAt TimeOptional

When the instruction was first accepted by the service. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

RejectionReason stringOptional

Human-readable explanation populated on any non-success terminal status — REJECTED or CANCEL_FAILED. On a 207 Multi-Status batch submit the top-level error field summarizes the batch; per-row detail continues to live here. When a null/undefined value is observed, it indicates it does not apply.

UpdatedAt TimeOptional

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

formatdate-time

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.

Status PositionInstructionStatus

Current lifecycle status.

One of the following:

const PositionInstructionStatusSent PositionInstructionStatus = "SENT"

const PositionInstructionStatusAccepted PositionInstructionStatus = "ACCEPTED"

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

CreatedAt TimeOptional

When the instruction was first accepted by the service. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

RejectionReason stringOptional

Human-readable explanation populated on any non-success terminal status — REJECTED or CANCEL_FAILED. On a 207 Multi-Status batch submit the top-level error field summarizes the batch; per-row detail continues to live here. When a null/undefined value is observed, it indicates it does not apply.

UpdatedAt TimeOptional

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

formatdate-time

type PositionInstructionStatus string

Lifecycle status of a position instruction.

• SENT: accepted and submitted to the clearing venue.
• ACCEPTED: terminal — accepted by the clearing venue.
• REJECTED: terminal rejection; rejection_reason carries the detail. Covers both venue-reported rejections and rejections raised before the instruction reached the clearing venue (e.g. duplicate instruction_id, DO_NOT_EXERCISE / CONTRARY_EXERCISE submitted on a non-expiry day, insufficient position, or an instrument that does not resolve).
• CANCEL_REQUESTED: cancel accepted; final cancel state pending.
• CANCELLED: terminal — cancel completed.
• CANCEL_FAILED: cancel could not be completed; operator attention required. rejection_reason carries the detail.
• UNKNOWN: status could not be determined.

One of the following:

const PositionInstructionStatusSent PositionInstructionStatus = "SENT"

const PositionInstructionStatusAccepted PositionInstructionStatus = "ACCEPTED"

const PositionInstructionStatusRejected PositionInstructionStatus = "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

Unique instrument identifier

formatuuid

InstrumentType SecurityType

Type of security

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

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

ClosingPrice stringOptional

The closing price used to value the position for the last trading day When a null/undefined value is observed, it indicates that there is no available data.

ClosingPriceDate TimeOptional

The market date associated with closing_price When a null/undefined value is observed, it indicates that there is no available data.

formatdate

CostBasis stringOptional

The total cost basis for this position When a null/undefined value is observed, it indicates that there is no available data.

DailyRealizedPnl stringOptional

The realized profit or loss for this position for the current day When a null/undefined value is observed, it indicates that there is no available data.

DailyUnrealizedPnl stringOptional

The unrealized profit or loss for this position relative to the previous close When a null/undefined value is observed, it indicates that there is no available data.

DailyUnrealizedPnlPct stringOptional

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

InstrumentPrice stringOptional

The current market price of the instrument When a null/undefined value is observed, it indicates that there is no available data.

UnderlyingInstrumentID stringOptional

Identifier of the underlying instrument, when available When a null/undefined value is observed, it indicates it does not apply.

formatuuid

UnrealizedPnl stringOptional

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

UnrealizedPnlPct stringOptional

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

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"

V1Screener

Search instruments and manage saved screeners.

Search Screener

client.V1.Screener.SearchScreener(ctx, body) (*V1ScreenerSearchScreenerResponse, error)

POST/v1/screener

Get Screeners

client.V1.Screener.GetScreeners(ctx) (*V1ScreenerGetScreenersResponse, error)

GET/v1/saved-screeners

Get Screener By ID

client.V1.Screener.GetScreenerByID(ctx, screenerID) (*V1ScreenerGetScreenerByIDResponse, error)

GET/v1/saved-screeners/{screener_id}

Create Screener

client.V1.Screener.NewScreener(ctx, body) (*V1ScreenerNewScreenerResponse, error)

POST/v1/saved-screeners

Replace Screener

client.V1.Screener.ReplaceScreener(ctx, screenerID, body) (*V1ScreenerReplaceScreenerResponse, error)

PUT/v1/saved-screeners/{screener_id}

Delete Screener

client.V1.Screener.DeleteScreener(ctx, screenerID) error

DELETE/v1/saved-screeners/{screener_id}

ModelsExpand Collapse

type FieldLookback string

Historical lookback window for price/change fields.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

type FieldPeriod string

Reporting period for financial data fields.

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

type FieldRef struct{…}

A reference to a screener field.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

type FieldType string

The data type of a screener field value.

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

type FilterOpSpec struct{…}

Operator specification with optional behavioral arguments.

Name FilterOperator

The operator to apply.

One of the following:

const FilterOperatorLessThan FilterOperator = "LESS_THAN"

const FilterOperatorLessOrEqual FilterOperator = "LESS_OR_EQUAL"

const FilterOperatorGreaterThan FilterOperator = "GREATER_THAN"

const FilterOperatorGreaterOrEqual FilterOperator = "GREATER_OR_EQUAL"

const FilterOperatorEqual FilterOperator = "EQUAL"

const FilterOperatorBetween FilterOperator = "BETWEEN"

const FilterOperatorNotBetween FilterOperator = "NOT_BETWEEN"

const FilterOperatorOneOf FilterOperator = "ONE_OF"

const FilterOperatorRegex FilterOperator = "REGEX"

const FilterOperatorBeginsWith FilterOperator = "BEGINS_WITH"

const FilterOperatorEndsWith FilterOperator = "ENDS_WITH"

const FilterOperatorContains FilterOperator = "CONTAINS"

const FilterOperatorIsNull FilterOperator = "IS_NULL"

const FilterOperatorIsNotNull FilterOperator = "IS_NOT_NULL"

Args []OperatorArgOptional

Optional arguments that modify operator behavior.

One of the following:

const OperatorArgLeftInclusive OperatorArg = "LEFT_INCLUSIVE"

const OperatorArgRightInclusive OperatorArg = "RIGHT_INCLUSIVE"

const OperatorArgLeftExclusive OperatorArg = "LEFT_EXCLUSIVE"

const OperatorArgRightExclusive OperatorArg = "RIGHT_EXCLUSIVE"

const OperatorArgCaseInsensitive OperatorArg = "CASE_INSENSITIVE"

type FilterOperator string

Filter operators supported by the screener.

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

One of the following:

const FilterOperatorLessThan FilterOperator = "LESS_THAN"

const FilterOperatorLessOrEqual FilterOperator = "LESS_OR_EQUAL"

const FilterOperatorGreaterThan FilterOperator = "GREATER_THAN"

const FilterOperatorGreaterOrEqual FilterOperator = "GREATER_OR_EQUAL"

const FilterOperatorEqual FilterOperator = "EQUAL"

const FilterOperatorBetween FilterOperator = "BETWEEN"

const FilterOperatorNotBetween FilterOperator = "NOT_BETWEEN"

const FilterOperatorOneOf FilterOperator = "ONE_OF"

const FilterOperatorRegex FilterOperator = "REGEX"

const FilterOperatorBeginsWith FilterOperator = "BEGINS_WITH"

const FilterOperatorEndsWith FilterOperator = "ENDS_WITH"

const FilterOperatorContains FilterOperator = "CONTAINS"

const FilterOperatorIsNull FilterOperator = "IS_NULL"

const FilterOperatorIsNotNull FilterOperator = "IS_NOT_NULL"

type FilterValue struct{…}

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

Value FilterValueValueUnionOptional

One of the following:

float64

string

Variable VariableOptional

A variable reference.

Name string

The variable name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Modifier ModifierOptional

Optional arithmetic modifier.

Args []ModifierArgUnion

One of the following:

float64

string

Name ModifierOp

The modifier operation.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

Period FieldPeriodOptional

Optional reporting period.

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

type Modifier struct{…}

Arithmetic modifier applied to a variable value.

Args []ModifierArgUnion

One of the following:

float64

string

Name ModifierOp

The modifier operation.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

type ModifierOp string

Modifier operation applied to a variable.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

type OperatorArg string

Argument that modifies operator behavior.

One of the following:

const OperatorArgLeftInclusive OperatorArg = "LEFT_INCLUSIVE"

const OperatorArgRightInclusive OperatorArg = "RIGHT_INCLUSIVE"

const OperatorArgLeftExclusive OperatorArg = "LEFT_EXCLUSIVE"

const OperatorArgRightExclusive OperatorArg = "RIGHT_EXCLUSIVE"

const OperatorArgCaseInsensitive OperatorArg = "CASE_INSENSITIVE"

type ScreenerColumn struct{…}

A single column in the screener search response.

Field FieldRef

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

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Name string

Human-readable display name for this field

Value ScreenerColumnValueUnion

One of the following:

float64

string

Type stringOptional

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

type ScreenerEntry struct{…}

A saved screener configuration entry

ID string

CreatedAt Time

Filters []SearchFilter

Left FieldRef

The field to filter on.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Op FilterOpSpecOptional

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

Name FilterOperator

The operator to apply.

One of the following:

const FilterOperatorLessThan FilterOperator = "LESS_THAN"

const FilterOperatorLessOrEqual FilterOperator = "LESS_OR_EQUAL"

const FilterOperatorGreaterThan FilterOperator = "GREATER_THAN"

const FilterOperatorGreaterOrEqual FilterOperator = "GREATER_OR_EQUAL"

const FilterOperatorEqual FilterOperator = "EQUAL"

const FilterOperatorBetween FilterOperator = "BETWEEN"

const FilterOperatorNotBetween FilterOperator = "NOT_BETWEEN"

const FilterOperatorOneOf FilterOperator = "ONE_OF"

const FilterOperatorRegex FilterOperator = "REGEX"

const FilterOperatorBeginsWith FilterOperator = "BEGINS_WITH"

const FilterOperatorEndsWith FilterOperator = "ENDS_WITH"

const FilterOperatorContains FilterOperator = "CONTAINS"

const FilterOperatorIsNull FilterOperator = "IS_NULL"

const FilterOperatorIsNotNull FilterOperator = "IS_NOT_NULL"

Args []OperatorArgOptional

Optional arguments that modify operator behavior.

One of the following:

const OperatorArgLeftInclusive OperatorArg = "LEFT_INCLUSIVE"

const OperatorArgRightInclusive OperatorArg = "RIGHT_INCLUSIVE"

const OperatorArgLeftExclusive OperatorArg = "LEFT_EXCLUSIVE"

const OperatorArgRightExclusive OperatorArg = "RIGHT_EXCLUSIVE"

const OperatorArgCaseInsensitive OperatorArg = "CASE_INSENSITIVE"

Right []FilterValueOptional

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

Value FilterValueValueUnionOptional

One of the following:

float64

string

Variable VariableOptional

A variable reference.

Name string

The variable name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Modifier ModifierOptional

Optional arithmetic modifier.

Args []ModifierArgUnion

One of the following:

float64

string

Name ModifierOp

The modifier operation.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

Period FieldPeriodOptional

Optional reporting period.

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

Name string

UpdatedAt Time

Columns []FieldRefOptional

Field references included when running this screener.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

DeprecatedFieldFilter []FieldRefOptional

Deprecated: use columns instead. Mirrors columns.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Sorts []SortSpecOptional

Field FieldRef

The field to sort by.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Direction SortDirectionOptional

Sort direction (defaults to DESC).

One of the following:

const SortDirectionAsc SortDirection = "ASC"

const SortDirectionDesc SortDirection = "DESC"

type ScreenerEntryList []ScreenerEntry

ID string

CreatedAt Time

Filters []SearchFilter

Left FieldRef

The field to filter on.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Op FilterOpSpecOptional

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

Name FilterOperator

The operator to apply.

One of the following:

const FilterOperatorLessThan FilterOperator = "LESS_THAN"

const FilterOperatorLessOrEqual FilterOperator = "LESS_OR_EQUAL"

const FilterOperatorGreaterThan FilterOperator = "GREATER_THAN"

const FilterOperatorGreaterOrEqual FilterOperator = "GREATER_OR_EQUAL"

const FilterOperatorEqual FilterOperator = "EQUAL"

const FilterOperatorBetween FilterOperator = "BETWEEN"

const FilterOperatorNotBetween FilterOperator = "NOT_BETWEEN"

const FilterOperatorOneOf FilterOperator = "ONE_OF"

const FilterOperatorRegex FilterOperator = "REGEX"

const FilterOperatorBeginsWith FilterOperator = "BEGINS_WITH"

const FilterOperatorEndsWith FilterOperator = "ENDS_WITH"

const FilterOperatorContains FilterOperator = "CONTAINS"

const FilterOperatorIsNull FilterOperator = "IS_NULL"

const FilterOperatorIsNotNull FilterOperator = "IS_NOT_NULL"

Args []OperatorArgOptional

Optional arguments that modify operator behavior.

One of the following:

const OperatorArgLeftInclusive OperatorArg = "LEFT_INCLUSIVE"

const OperatorArgRightInclusive OperatorArg = "RIGHT_INCLUSIVE"

const OperatorArgLeftExclusive OperatorArg = "LEFT_EXCLUSIVE"

const OperatorArgRightExclusive OperatorArg = "RIGHT_EXCLUSIVE"

const OperatorArgCaseInsensitive OperatorArg = "CASE_INSENSITIVE"

Right []FilterValueOptional

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

Value FilterValueValueUnionOptional

One of the following:

float64

string

Variable VariableOptional

A variable reference.

Name string

The variable name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Modifier ModifierOptional

Optional arithmetic modifier.

Args []ModifierArgUnion

One of the following:

float64

string

Name ModifierOp

The modifier operation.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

Period FieldPeriodOptional

Optional reporting period.

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

Name string

UpdatedAt Time

Columns []FieldRefOptional

Field references included when running this screener.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

DeprecatedFieldFilter []FieldRefOptional

Deprecated: use columns instead. Mirrors columns.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Sorts []SortSpecOptional

Field FieldRef

The field to sort by.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Direction SortDirectionOptional

Sort direction (defaults to DESC).

One of the following:

const SortDirectionAsc SortDirection = "ASC"

const SortDirectionDesc SortDirection = "DESC"

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 ScreenerRow []ScreenerColumn

A single row of screener columns for one instrument.

Field FieldRef

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

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Name string

Human-readable display name for this field

Value ScreenerColumnValueUnion

One of the following:

float64

string

Type stringOptional

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

type ScreenerRowList []ScreenerRow

Field FieldRef

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

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Name string

Human-readable display name for this field

Value ScreenerColumnValueUnion

One of the following:

float64

string

Type stringOptional

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

type SearchFilter struct{…}

A single filter condition.

When op and right are both absent, the filter is “unenabled”: it persists a left field reference without applying any predicate. Unenabled filters are skipped during search execution but still round-trip through save/load so callers can preserve draft state.

Left FieldRef

The field to filter on.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Op FilterOpSpecOptional

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

Name FilterOperator

The operator to apply.

One of the following:

const FilterOperatorLessThan FilterOperator = "LESS_THAN"

const FilterOperatorLessOrEqual FilterOperator = "LESS_OR_EQUAL"

const FilterOperatorGreaterThan FilterOperator = "GREATER_THAN"

const FilterOperatorGreaterOrEqual FilterOperator = "GREATER_OR_EQUAL"

const FilterOperatorEqual FilterOperator = "EQUAL"

const FilterOperatorBetween FilterOperator = "BETWEEN"

const FilterOperatorNotBetween FilterOperator = "NOT_BETWEEN"

const FilterOperatorOneOf FilterOperator = "ONE_OF"

const FilterOperatorRegex FilterOperator = "REGEX"

const FilterOperatorBeginsWith FilterOperator = "BEGINS_WITH"

const FilterOperatorEndsWith FilterOperator = "ENDS_WITH"

const FilterOperatorContains FilterOperator = "CONTAINS"

const FilterOperatorIsNull FilterOperator = "IS_NULL"

const FilterOperatorIsNotNull FilterOperator = "IS_NOT_NULL"

Args []OperatorArgOptional

Optional arguments that modify operator behavior.

One of the following:

const OperatorArgLeftInclusive OperatorArg = "LEFT_INCLUSIVE"

const OperatorArgRightInclusive OperatorArg = "RIGHT_INCLUSIVE"

const OperatorArgLeftExclusive OperatorArg = "LEFT_EXCLUSIVE"

const OperatorArgRightExclusive OperatorArg = "RIGHT_EXCLUSIVE"

const OperatorArgCaseInsensitive OperatorArg = "CASE_INSENSITIVE"

Right []FilterValueOptional

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

Value FilterValueValueUnionOptional

One of the following:

float64

string

Variable VariableOptional

A variable reference.

Name string

The variable name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Modifier ModifierOptional

Optional arithmetic modifier.

Args []ModifierArgUnion

One of the following:

float64

string

Name ModifierOp

The modifier operation.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

Period FieldPeriodOptional

Optional reporting period.

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

type SortSpec struct{…}

A sort specification pairing a field with a direction.

Field FieldRef

The field to sort by.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Direction SortDirectionOptional

Sort direction (defaults to DESC).

One of the following:

const SortDirectionAsc SortDirection = "ASC"

const SortDirectionDesc SortDirection = "DESC"

type Variable struct{…}

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

Name string

The variable name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Modifier ModifierOptional

Optional arithmetic modifier.

Args []ModifierArgUnion

One of the following:

float64

string

Name ModifierOp

The modifier operation.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

Period FieldPeriodOptional

Optional reporting period.

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

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 []WatchlistItemEntry

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

Instrument InstrumentOptional

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

ID string

Unique 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

IsFractionable bool

Indicates if the instrument supports fractional-quantity orders

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsPtp bool

Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.

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

DeprecatedExpiry TimeOptional

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

formatdate

InstrumentType SecurityTypeOptional

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

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

LongMarginRate stringOptional

The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

Name stringOptional

The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.

NotionalAdv stringOptional

Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.

OptionsExpiryDates []TimeOptional

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

PreviousClose stringOptional

Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.

ShortMarginRate stringOptional

The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

DeprecatedStrikePrice stringOptional

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

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

Instrument InstrumentOptional

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

ID string

Unique 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

IsFractionable bool

Indicates if the instrument supports fractional-quantity orders

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsPtp bool

Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.

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

DeprecatedExpiry TimeOptional

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

formatdate

InstrumentType SecurityTypeOptional

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

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

LongMarginRate stringOptional

The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

Name stringOptional

The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.

NotionalAdv stringOptional

Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.

OptionsExpiryDates []TimeOptional

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

PreviousClose stringOptional

Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.

ShortMarginRate stringOptional

The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

DeprecatedStrikePrice stringOptional

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