V1

ModelsExpand Collapse

type SecurityType string

Security type

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeIndex SecurityType = "INDEX"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

type SortDirection string

Sort direction for 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

AccountHolderEntityKind AccountHolderEntityKind

Whether the account holder is a natural person or a legal entity.

One of the following:

const AccountHolderEntityKindNaturalPerson AccountHolderEntityKind = "NATURAL_PERSON"

const AccountHolderEntityKindLegalEntity AccountHolderEntityKind = "LEGAL_ENTITY"

const AccountHolderEntityKindOther AccountHolderEntityKind = "OTHER"

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: base buying power plus the open order adjustment, where base buying power is maintenance margin excess times the multiplier for intraday and initial margin excess times the multiplier for overnight.

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.

DailyUnrealizedPnl string

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

Equity string

The total equity in the account: cash plus long market value plus short market value, where short market value is negative.

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

Buying power correction from open orders, computed as projected buying power minus actual buying power. A negative value means open orders are consuming buying power.

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

MaintenanceMarginExcess stringOptional

Start-of-day maintenance margin excess: the difference between equity and the maintenance margin requirement. When a null/undefined value is observed, it indicates it does not apply.

MaintenanceMarginRequirement stringOptional

Start-of-day maintenance margin requirement: the amount of equity required to maintain current positions. 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.

InitialMarginExcess string

The difference between equity and the initial margin requirement.

InitialMarginRequirement string

The amount of equity required to open new positions.

IntradayDetails MarginSessionDetails

Intraday session margin calculation details.

BuyingPower string

Maximum buying power available in the account during the session: base buying power plus the open order adjustment, where base buying power is maintenance margin excess times the multiplier for intraday and initial margin excess times the multiplier for overnight.

Multiplier stringOptional

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

MaintenanceMarginExcess string

The difference between equity and the maintenance margin requirement.

MaintenanceMarginRequirement string

The amount of equity required to maintain current positions.

OvernightDetails MarginSessionDetails

Overnight session margin calculation details.

BuyingPower string

Multiplier stringOptional

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

TopContributors []MarginTopContributorOptional

Optional top margin contributors, returned only when explicitly requested.

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

Margin multiplier: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session. 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

MaintenanceMarginExcess stringOptional

Start-of-day maintenance margin excess: the difference between equity and the maintenance margin requirement. When a null/undefined value is observed, it indicates it does not apply.

MaintenanceMarginRequirement stringOptional

Start-of-day maintenance margin requirement: the amount of equity required to maintain current positions. 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 AccountHolderEntityKind string

Whether an account holder is a natural person or a legal entity.

One of the following:

const AccountHolderEntityKindNaturalPerson AccountHolderEntityKind = "NATURAL_PERSON"

const AccountHolderEntityKindLegalEntity AccountHolderEntityKind = "LEGAL_ENTITY"

const AccountHolderEntityKindOther AccountHolderEntityKind = "OTHER"

type AccountList []Account

ID int64

The unique identifier for the account

formatint64

AccountHolderEntityID int64

The account holder entity identifier

formatint64

AccountHolderEntityKind AccountHolderEntityKind

Whether the account holder is a natural person or a legal entity.

One of the following:

const AccountHolderEntityKindNaturalPerson AccountHolderEntityKind = "NATURAL_PERSON"

const AccountHolderEntityKindLegalEntity AccountHolderEntityKind = "LEGAL_ENTITY"

const AccountHolderEntityKindOther AccountHolderEntityKind = "OTHER"

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

Represents a trading account

ID int64

The unique identifier for the account

formatint64

AccountHolderEntityID int64

The account holder entity identifier

formatint64

AccountHolderEntityKind AccountHolderEntityKind

Whether the account holder is a natural person or a legal entity.

One of the following:

const AccountHolderEntityKindNaturalPerson AccountHolderEntityKind = "NATURAL_PERSON"

const AccountHolderEntityKindLegalEntity AccountHolderEntityKind = "LEGAL_ENTITY"

const AccountHolderEntityKindOther AccountHolderEntityKind = "OTHER"

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

CountryOfTaxResidency stringOptional

The country of tax residency of the account-holder entity. null when not on file or entity reference data is unavailable. When a null/undefined value is observed, it indicates that there is no available data.

DateOfBirth TimeOptional

The date of birth of the account holder’s primary contact. null when not on file or entity reference data is unavailable. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

MailingAddress AddressOptional

The mailing address of the account-holder entity. null when no mailing address is on file or entity reference data is unavailable. When a null/undefined value is observed, it indicates that there is no available data.

City string

City

Country string

Country

Line1 string

First street address line

PostalCode string

Postal code

Line2 stringOptional

Second street address line When a null/undefined value is observed, it indicates it does not apply.

State stringOptional

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

PhoneNumber stringOptional

The phone number of the account holder’s primary contact. null when not on file or entity reference data is unavailable. When a null/undefined value is observed, it indicates that there is no available data.

type Address struct{…}

A postal address.

City string

City

Country string

Country

Line1 string

First street address line

PostalCode string

Postal code

Line2 stringOptional

Second street address line When a null/undefined value is observed, it indicates it does not apply.

State stringOptional

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

type MarginDetails struct{…}

InitialMarginExcess string

The difference between equity and the initial margin requirement.

InitialMarginRequirement string

The amount of equity required to open new positions.

IntradayDetails MarginSessionDetails

Intraday session margin calculation details.

BuyingPower string

Multiplier stringOptional

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

MaintenanceMarginExcess string

The difference between equity and the maintenance margin requirement.

MaintenanceMarginRequirement string

The amount of equity required to maintain current positions.

OvernightDetails MarginSessionDetails

Overnight session margin calculation details.

BuyingPower string

Multiplier stringOptional

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

TopContributors []MarginTopContributorOptional

Optional top margin contributors, returned only when explicitly requested.

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

Multiplier stringOptional

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

type MarginTopContributor struct{…}

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

Overnight SessionScheduleOptional

Overnight session schedule (prior evening through early morning), null if not available When a null/undefined value is observed, it indicates it does not apply.

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 MarketSessionTypeOvernight MarketSessionType = "overnight"

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

Overnight SessionScheduleOptional

Overnight session schedule (prior evening through early morning), null if not available When a null/undefined value is observed, it indicates it does not apply.

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

Overnight SessionScheduleOptional

Overnight session schedule (prior evening through early morning), null if not available When a null/undefined value is observed, it indicates it does not apply.

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 MarketSessionTypeOvernight MarketSessionType = "overnight"

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

Overnight SessionScheduleOptional

Overnight session schedule (prior evening through early morning), null if not available When a null/undefined value is observed, it indicates it does not apply.

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 MarketSessionTypeOvernight MarketSessionType = "overnight"

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 MarketSessionTypeOvernight MarketSessionType = "overnight"

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

Overnight SessionScheduleOptional

Overnight session schedule (prior evening through early morning), null if not available When a null/undefined value is observed, it indicates it does not apply.

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.

ReportTime ReportTimeOptional

Report timing: before market open or after market close When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

const ReportTimeBmo ReportTime = "BMO"

const ReportTimeAmc ReportTime = "AMC"

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

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.

ReportTime ReportTimeOptional

Report timing: before market open or after market close When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

const ReportTimeBmo ReportTime = "BMO"

const ReportTimeAmc ReportTime = "AMC"

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

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.

ReportTime ReportTimeOptional

Report timing: before market open or after market close When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

const ReportTimeBmo ReportTime = "BMO"

const ReportTimeAmc ReportTime = "AMC"

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

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.

ReportTime ReportTimeOptional

Report timing: before market open or after market close When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

const ReportTimeBmo ReportTime = "BMO"

const ReportTimeAmc ReportTime = "AMC"

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

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.

ReportTime ReportTimeOptional

Report timing: before market open or after market close When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

const ReportTimeBmo ReportTime = "BMO"

const ReportTimeAmc ReportTime = "AMC"

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

Ipos []InstrumentIpoEvent

IPO events

Date Time

The date of the IPO

formatdate

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.

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

Represents an IPO event for an instrument

Date Time

The date of the IPO

formatdate

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

type ReportTime string

Earnings report timing: before market open or after market close

One of the following:

const ReportTimeBmo ReportTime = "BMO"

const ReportTimeAmc ReportTime = "AMC"

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

Deprecated

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 and not_applicable is Option:

Unresolvable instrument_id → all other fields None (including symbol).
Resolvable instrument_id with no realtime cache entry → symbol populated, OHLV/trade_date/open_interest None.
trade_date reflects the session the OHLV represents (today during trading hours, the last trading date during weekends/holidays).
open_interest is populated for options only; None for equities and indices.
not_applicable is a non-optional bool, always serialized: true for instrument types with no daily summary by definition (e.g. an index, whose OHLV/trade_date are None), false otherwise.

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.

NotApplicable boolOptional

true when the instrument type has no daily summary by definition (e.g. an index). Distinguishes an intentional N/A from OHLV that is merely not loaded yet. false for instruments that can have a summary.

Open stringOptional

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

OpenInterest int64Optional

Open interest (outstanding contracts). Populated for options only; None for equities and indices. When a null/undefined value is observed, it indicates that there is no available data.

formatint64

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.

NotApplicable boolOptional

Open stringOptional

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

OpenInterest int64Optional

Open interest (outstanding contracts). Populated for options only; None for equities and indices. When a null/undefined value is observed, it indicates that there is no available data.

formatint64

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.

Session SnapshotSession

Session-level pricing and OHLV metrics. Always present; each inner field is independently nullable.

OhlvApplicable bool

false only for instrument types with no OHLV by definition (e.g. an index instrument, whose price is a computed level rather than a traded security) — open/high/low/ohlv_date/cumulative_volume are then always absent. true otherwise, even when those fields simply haven’t loaded yet. Always serialized.

Change stringOptional

Absolute change from previous close to the most recent last-sale-eligible trade. Absent when either side of the computation is unavailable. When a null/undefined value is observed, it indicates that there is no available data.

ChangePercent stringOptional

Percent change from previous close to the most recent last-sale-eligible trade. Absent under the same conditions as change. When a null/undefined value is observed, it indicates that there is no available data.

CumulativeVolume int64Optional

Cumulative traded volume for the current session, in shares for equities or contracts for options. Always reflects the current session, even when ohlv_date trails it. Absent when ohlv_applicable is false, or when no trade is available. When a null/undefined value is observed, it indicates that there is no available data.

formatint64

minimum0

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.

OhlvDate TimeOptional

Session date the open/high/low values represent, US/Eastern. May trail the current session until the upstream feed rolls. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

Open stringOptional

Session opening price, from the day’s OHLC bar. Absent when ohlv_applicable is false, or when the bar has not loaded yet. When a null/undefined value is observed, it indicates that there is no available data.

PreviousClose stringOptional

Previous session close price. Corporate-action-adjusted (stock dividends, cash dividends, and forward/reverse splits) when an adjustment exists for the close date; the raw close otherwise. An adjustment can carry the price beyond 2 decimal places. Absent when no previous close is on record (e.g. an instrument’s first session). When a null/undefined value is observed, it indicates that there is no available data.

PreviousCloseUnadjusted stringOptional

Unadjusted (raw) previous session close. Present only when a corporate-action adjustment exists for the previous close date; when no adjustment exists, previous_close is the raw close and this field is omitted. When a null/undefined value is observed, it indicates that there is no available data.

ShortSaleRestricted bool

Whether the SEC Rule 201 short-sale price test is currently restricting short sales in this security, from the trading-status feed.

true restricts non-exempt short sales at or below the national best bid. null means we have no answer, either because no trading status has been seen for this security yet or because Rule 201 does not cover this security type. A null is not a statement that short selling is unrestricted, and must not be treated as clear to short.

This is the current market condition, not a statement about whether Clear Street will reject your order. It is also distinct from is_short_prohibited on the instrument endpoints, which is a standing property of the security rather than a live circuit breaker. When a null/undefined value is observed, it indicates that there is no available data.

Symbol string

Display symbol for the security.

DeprecatedCumulativeVolume int64Optional

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

Deprecated: use session.cumulative_volume, the same value from the same source. When a null/undefined value is observed, it indicates that there is no available data.

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

AskTimestamp TimeOptional

Exchange timestamp of the best ask. Absent when the ask side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

AskVenue stringOptional

ISO 10383 Market Identifier Code (MIC) of the venue currently holding the national best offer (NBBO). Absent when the ask side carries no venue. When a null/undefined value is observed, it indicates that there is no available data.

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

BidTimestamp TimeOptional

Exchange timestamp of the best bid. Absent when the bid side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

BidVenue stringOptional

ISO 10383 Market Identifier Code (MIC) of the venue currently holding the national best bid (NBBO). Absent when the bid side carries no venue. When a null/undefined value is observed, it indicates that there is no available data.

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-eligible trade if available. Omitted when the most recent known print is ineligible (e.g. an odd lot or an out-of-sequence report) rather than showing that print’s price. When a null/undefined value is observed, it indicates that there is no available data.

Price string

Most recent last-sale eligible trade price. For index instruments, the current index level.

Size int64

Share quantity of the most recent last-sale eligible trade. Always 0 for index instruments, whose level is computed rather than traded.

formatint32

minimum0

Timestamp TimeOptional

Exchange timestamp of the most recent last-sale eligible trade. For index instruments, the time the index level was computed. Absent when the trade carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

Venue stringOptional

ISO 10383 Market Identifier Code (MIC) of the venue where the most recent last-sale eligible trade took place. Absent when the trade carries no venue; index levels are computed rather than traded and have no venue. When a null/undefined value is observed, it indicates that there is no available data.

Name stringOptional

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

OpenInterest int64Optional

Open interest (outstanding contracts) as of the most recent OPRA Refresh. Populated for options only; absent for equities and indices. When a null/undefined value is observed, it indicates that there is no available data.

formatint64

minimum0

type MarketDataSnapshotList []MarketDataSnapshot

InstrumentID string

Unique instrument identifier.

Session SnapshotSession

Session-level pricing and OHLV metrics. Always present; each inner field is independently nullable.

OhlvApplicable bool

Change stringOptional

ChangePercent stringOptional

CumulativeVolume int64Optional

formatint64

minimum0

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.

OhlvDate TimeOptional

formatdate

Open stringOptional

PreviousClose stringOptional

PreviousCloseUnadjusted stringOptional

ShortSaleRestricted bool

Whether the SEC Rule 201 short-sale price test is currently restricting short sales in this security, from the trading-status feed.

Symbol string

Display symbol for the security.

DeprecatedCumulativeVolume int64Optional

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

Deprecated: use session.cumulative_volume, the same value from the same source. When a null/undefined value is observed, it indicates that there is no available data.

formatint64

minimum0

Greeks SnapshotGreeksOptional

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

AskTimestamp TimeOptional

Exchange timestamp of the best ask. Absent when the ask side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

AskVenue stringOptional

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

BidTimestamp TimeOptional

Exchange timestamp of the best bid. Absent when the bid side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

BidVenue stringOptional

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

Price string

Most recent last-sale eligible trade price. For index instruments, the current index level.

Size int64

Share quantity of the most recent last-sale eligible trade. Always 0 for index instruments, whose level is computed rather than traded.

formatint32

minimum0

Timestamp TimeOptional

formatdate-time

Venue stringOptional

Name stringOptional

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

OpenInterest int64Optional

formatint64

minimum0

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.

For index instruments this carries the current index level — a computed value, not a trade: price is the level and size is always 0 (no contract changes hands).

Price string

Most recent last-sale eligible trade price. For index instruments, the current index level.

Size int64

Share quantity of the most recent last-sale eligible trade. Always 0 for index instruments, whose level is computed rather than traded.

formatint32

minimum0

Timestamp TimeOptional

formatdate-time

Venue stringOptional

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

AskTimestamp TimeOptional

Exchange timestamp of the best ask. Absent when the ask side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

AskVenue stringOptional

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

BidTimestamp TimeOptional

Exchange timestamp of the best bid. Absent when the bid side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

BidVenue stringOptional

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 and OHLV metrics for a market data snapshot. Always present on the snapshot row; every field here is independently nullable except ohlv_applicable.

OhlvApplicable bool

Change stringOptional

ChangePercent stringOptional

CumulativeVolume int64Optional

formatint64

minimum0

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.

OhlvDate TimeOptional

formatdate

Open stringOptional

PreviousClose stringOptional

PreviousCloseUnadjusted stringOptional

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. This is a standing property of the security. For the live Rule 201 circuit breaker, see short_sale_restricted on the market-data snapshot.

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.

CaxAdjustedPreviousClose stringOptional

Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.

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 SecurityTypeIndex SecurityType = "INDEX"

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 the cax-adjusted close when present, the raw previous close otherwise). When a null/undefined value is observed, it indicates that there is no available data.

OptionsContractExpiryDates []OptionExpiryDateOptional

Available options expiration dates for this instrument, each annotated with which settlement cycles have listed contracts on it. Present only when include_options_expiry_dates=true in the request. When a null/undefined value is observed, it indicates it does not apply.

Date Time

The expiration date.

formatdate

HasSettlesOnClose bool

Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.

HasSettlesOnOpen bool

Whether this date has at least one contract that settles on the opening print (AM settlement) and can still be traded. AM-settled contracts stop trading at the close of the business day before settlement, so this turns false before the expiration date arrives. A date leaves the list once no contract on it can be traded in either settlement cycle.

DeprecatedOptionsExpiryDates []TimeOptional

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

Deprecated: use options_contract_expiry_dates, which carries the same dates annotated with settlement-cycle information. When a null/undefined value is observed, it indicates it does not apply.

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.

TickRules []TickRuleOptional

Price bands this instrument quotes on, ascending. Absent when we have no schedule for it, which includes an option whose penny-program status our reference data never supplied.

StartPrice string

Lowest price in the band, inclusive.

TickSize string

Minimum price increment within the band.

EndPrice stringOptional

Upper bound of the band, exclusive. Absent on the last band, which runs to infinity. 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

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.

CaxAdjustedPreviousClose stringOptional

Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.

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 SecurityTypeIndex SecurityType = "INDEX"

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

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.

TickRules []TickRuleOptional

Price bands this instrument quotes on, ascending. Absent when we have no schedule for it, which includes an option whose penny-program status our reference data never supplied.

StartPrice string

Lowest price in the band, inclusive.

TickSize string

Minimum price increment within the band.

EndPrice stringOptional

Upper bound of the band, exclusive. Absent on the last band, which runs to infinity. 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

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.

CaxAdjustedPreviousClose stringOptional

Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.

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 SecurityTypeIndex SecurityType = "INDEX"

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

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.

TickRules []TickRuleOptional

Price bands this instrument quotes on, ascending. Absent when we have no schedule for it, which includes an option whose penny-program status our reference data never supplied.

StartPrice string

Lowest price in the band, inclusive.

TickSize string

Minimum price increment within the band.

EndPrice stringOptional

Upper bound of the band, exclusive. Absent on the last band, which runs to infinity. 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 OptionExpiryDate struct{…}

An options expiry date, annotated with which settlement cycles have listed contracts on it.

Date Time

The expiration date.

formatdate

HasSettlesOnClose bool

Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.

HasSettlesOnOpen bool

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

IsTradable bool

Whether the contract is tradable

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

IsSettleOnOpen boolOptional

Whether the option settles on the opening price (AM settlement), if known When a null/undefined value is observed, it indicates that there is no available data.

LastTradeCutoff TimeOptional

Last moment the option can trade (UTC), if known When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

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

TickRules []TickRuleOptional

Price bands this contract quotes on, ascending. Absent when our reference data never supplied the contract’s penny-program status.

StartPrice string

Lowest price in the band, inclusive.

TickSize string

Minimum price increment within the band.

EndPrice stringOptional

Upper bound of the band, exclusive. Absent on the last band, which runs to infinity. When a null/undefined value is observed, it indicates it does not apply.

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

IsTradable bool

Whether the contract is tradable

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

IsSettleOnOpen boolOptional

Whether the option settles on the opening price (AM settlement), if known When a null/undefined value is observed, it indicates that there is no available data.

LastTradeCutoff TimeOptional

Last moment the option can trade (UTC), if known When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

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

TickRules []TickRuleOptional

Price bands this contract quotes on, ascending. Absent when our reference data never supplied the contract’s penny-program status.

StartPrice string

Lowest price in the band, inclusive.

TickSize string

Minimum price increment within the band.

EndPrice stringOptional

Upper bound of the band, exclusive. Absent on the last band, which runs to infinity. When a null/undefined value is observed, it indicates it does not apply.

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

One band of an instrument’s tick schedule. A price in the band is valid only if it is a whole multiple of tick_size. Bands describe the instrument itself: on an equity they say nothing about that equity’s option chain.

StartPrice string

Lowest price in the band, inclusive.

TickSize string

Minimum price increment within the band.

EndPrice stringOptional

Upper bound of the band, exclusive. Absent on the last band, which runs to infinity. When a null/undefined value is observed, it indicates it does not apply.

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.

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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.

Clicked bool

Whether the current user clicked this chart.

ActionButtons []ActionButtonOptional

Buttons associated with this chart.

ButtonID string

Stable button identifier within the content part.

Label string

User-visible label.

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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.

Clicked bool

Whether the current user clicked this chart.

ActionButtons []ActionButtonOptional

Buttons associated with this chart.

ButtonID string

Stable button identifier within the content part.

Label string

User-visible label.

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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

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

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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.

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

ActionID string

Clicked bool

Whether the current user clicked this action.

ClickedItemIDs []stringOptional

IDs of nested items clicked by the current user.

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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.

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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

ClickedItemIDs []stringOptional

IDs of buttons clicked by the current user.

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.

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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.

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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

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)

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

type PrefillCancelOrderRequest 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)

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

type PrefillModifyOrderAction struct{…}

Modify-order prefill action.

Orders []PrefillModifyOrderRequest

Modification targets and deltas needed to construct replace-order API requests.

AccountID int64Optional

Account ID that owns the order.

formatint64

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

LimitOffset stringOptional

New limit offset for trailing stop-limit orders (signed)

LimitPrice stringOptional

New limit price for the order

OrderID stringOptional

Order ID to modify.

Quantity stringOptional

New quantity for the order

StopPrice stringOptional

New stop price for the order

TrailingOffset stringOptional

New trailing offset for trailing orders

TrailingOffsetType TrailingOffsetTypeOptional

New trailing offset type (PRICE or BPS)

One of the following:

const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"

const TrailingOffsetTypeBps TrailingOffsetType = "BPS"

type PrefillModifyOrderRequest struct{…}

Request to replace (modify) an existing order

At least one field must be provided.

AccountID int64Optional

Account ID that owns the order.

formatint64

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

LimitOffset stringOptional

New limit offset for trailing stop-limit orders (signed)

LimitPrice stringOptional

New limit price for the order

OrderID stringOptional

Order ID to modify.

Quantity stringOptional

New quantity for the order

StopPrice stringOptional

New stop price for the order

TrailingOffset stringOptional

New trailing offset for trailing orders

TrailingOffsetType TrailingOffsetTypeOptional

New trailing offset type (PRICE or BPS)

One of the following:

const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"

const TrailingOffsetTypeBps TrailingOffsetType = "BPS"

type PrefillNewOrderAction struct{…}

New-order prefill action.

Orders []PrefillNewOrderRequest

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"

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 RequestTimeInForceAtOpen RequestTimeInForce = "AT_OPEN"

const RequestTimeInForceAtClose RequestTimeInForce = "AT_CLOSE"

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 ID (UUID) or symbol (equity ticker or OSI option symbol). Either symbol or instrument_id must be provided.

minLength1

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

LimitOffset stringOptional

Limit offset for trailing stop-limit orders (signed)

LimitPrice stringOptional

Limit price (required for LIMIT and STOP_LIMIT orders)

PositionIntent RequestPositionEffectOptional

Optional open/close intent for this order. When omitted, the platform determines the position effect.

One of the following:

const RequestPositionEffectOpen RequestPositionEffect = "OPEN"

const RequestPositionEffectClose RequestPositionEffect = "CLOSE"

StopPrice stringOptional

Stop price (required for STOP and STOP_LIMIT orders)

Strategy OrderStrategyUnionOptional

Optional execution strategy. One of SOR, VWAP, or TWAP. Defaults to SOR. VWAP and TWAP are supported only on MARKET and LIMIT orders with DAY time-in-force, and are not supported on OTC common-stock orders.

One of the following:

type OrderStrategyType struct{…}

Smart Order Router. Routes the order to the best available venue(s).

Type string

Execution strategy type.

type OrderStrategyObject struct{…}

Volume-Weighted Average Price. Works the order to track the volume-weighted average price over the execution window.

Type string

Execution strategy type.

EndAt TimeOptional

UTC timestamp (RFC 3339) by which to finish working the order. Defaults to market close.

formatdate-time

StartAt TimeOptional

UTC timestamp (RFC 3339) at which to begin working the order. Defaults to the time the order is received.

formatdate-time

type OrderStrategyObject2 struct{…}

Time-Weighted Average Price. Spreads execution evenly across the execution window.

Type string

Execution strategy type.

EndAt TimeOptional

UTC timestamp (RFC 3339) by which to finish working the order. Defaults to market close.

formatdate-time

StartAt TimeOptional

UTC timestamp (RFC 3339) at which to begin working the order. Defaults to the time the order is received.

formatdate-time

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

Request to submit a new order

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"

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 RequestTimeInForceAtOpen RequestTimeInForce = "AT_OPEN"

const RequestTimeInForceAtClose RequestTimeInForce = "AT_CLOSE"

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 ID (UUID) or symbol (equity ticker or OSI option symbol). Either symbol or instrument_id must be provided.

minLength1

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

LimitOffset stringOptional

Limit offset for trailing stop-limit orders (signed)

LimitPrice stringOptional

Limit price (required for LIMIT and STOP_LIMIT orders)

PositionIntent RequestPositionEffectOptional

Optional open/close intent for this order. When omitted, the platform determines the position effect.

One of the following:

const RequestPositionEffectOpen RequestPositionEffect = "OPEN"

const RequestPositionEffectClose RequestPositionEffect = "CLOSE"

StopPrice stringOptional

Stop price (required for STOP and STOP_LIMIT orders)

Strategy OrderStrategyUnionOptional

One of the following:

type OrderStrategyType struct{…}

Smart Order Router. Routes the order to the best available venue(s).

Type string

Execution strategy type.

type OrderStrategyObject struct{…}

Volume-Weighted Average Price. Works the order to track the volume-weighted average price over the execution window.

Type string

Execution strategy type.

EndAt TimeOptional

UTC timestamp (RFC 3339) by which to finish working the order. Defaults to market close.

formatdate-time

StartAt TimeOptional

UTC timestamp (RFC 3339) at which to begin working the order. Defaults to the time the order is received.

formatdate-time

type OrderStrategyObject2 struct{…}

Time-Weighted Average Price. Spreads execution evenly across the execution window.

Type string

Execution strategy type.

EndAt TimeOptional

UTC timestamp (RFC 3339) by which to finish working the order. Defaults to market close.

formatdate-time

StartAt TimeOptional

UTC timestamp (RFC 3339) at which to begin working the order. Defaults to the time the order is received.

formatdate-time

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

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

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

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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.

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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.

ItemID stringOptional

Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

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

ClickedItemIDs []stringOptional

IDs of buttons clicked by the current user.

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

AccountID int64

AgreementID string

EntitlementCode EntitlementCode

Stable entitlement code granted by an agreement.

EntitlementID string

GrantedAt string

type EntitlementResourceList []EntitlementResource

AccountID int64

AgreementID string

EntitlementCode EntitlementCode

Stable entitlement code granted by an agreement.

EntitlementID string

GrantedAt string

V1Omni AIMessages

Get Message

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

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

Get Threads

client.V1.OmniAI.Threads.GetThreads(ctx, query) (*V1OmniAIThreadGetThreadsResponse, error)

GET/v1/omni-ai/threads

Get Thread

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

A snapshot of the widget the user asks about.

Data map[string, any]

Relevant widget data, selections, and units. Use strings for exact decimals and large IDs.

Kind string

Nonblank descriptive kind. New kinds do not require a backend release.

minLength1

Label string

Nonblank attachment label for conversation rendering.

minLength1

CapturedAt TimeOptional

Client-reported snapshot time. Omit when unknown.

formatdate-time

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 Time

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

Context TurnContextOptional

Immutable snapshots attached to this user message. Omitted when none were supplied. When a null/undefined value is observed, it indicates that there is no available data.

Items []ContextItem

One to four snapshots. Each snapshot’s data may contain at most 32 levels of nesting.

Data map[string, any]

Relevant widget data, selections, and units. Use strings for exact decimals and large IDs.

Kind string

Nonblank descriptive kind. New kinds do not require a backend release.

minLength1

Label string

Nonblank attachment label for conversation rendering.

minLength1

CapturedAt TimeOptional

Client-reported snapshot time. Omit when unknown.

formatdate-time

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 Time

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

Context TurnContextOptional

Immutable snapshots attached to this user message. Omitted when none were supplied. When a null/undefined value is observed, it indicates that there is no available data.

Items []ContextItem

One to four snapshots. Each snapshot’s data may contain at most 32 levels of nesting.

Data map[string, any]

Relevant widget data, selections, and units. Use strings for exact decimals and large IDs.

Kind string

Nonblank descriptive kind. New kinds do not require a backend release.

minLength1

Label string

Nonblank attachment label for conversation rendering.

minLength1

CapturedAt TimeOptional

Client-reported snapshot time. Omit when unknown.

formatdate-time

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.

ID string

CreatedAt Time

Title string

UpdatedAt Time

type ThreadList []Thread

ID string

CreatedAt Time

Title string

UpdatedAt Time

type TurnContext struct{…}

Client snapshots attached to one instant-chat user message.

Context is separate from visible message text and does not grant account access. The compact JSON representation must not exceed 64 KiB.

Items []ContextItem

One to four snapshots. Each snapshot’s data may contain at most 32 levels of nesting.

Data map[string, any]

Relevant widget data, selections, and units. Use strings for exact decimals and large IDs.

Kind string

Nonblank descriptive kind. New kinds do not require a backend release.

minLength1

Label string

Nonblank attachment label for conversation rendering.

minLength1

CapturedAt TimeOptional

Client-reported snapshot time. Omit when unknown.

formatdate-time

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

Represents a single fill of an order for an account.

ID string

Unique identifier for this execution report.

formatuuid

OrderID string

Identifier of the order this execution belongs to.

formatuuid

Quantity string

Filled quantity.

Side Side

Side of the fill.

One of the following:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

TransactionTime Time

Transaction timestamp in nanosecond precision (UTC).

formatdate-time

InstrumentID stringOptional

Unique instrument identifier. null when this fill has no single resolvable instrument. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

Price stringOptional

Fill price. null for multileg fills, whose price lives only at the leg level. When a null/undefined value is observed, it indicates it does not apply.

Symbol stringOptional

Trading symbol. null when this fill has no single resolvable instrument. When a null/undefined value is observed, it indicates it does not apply.

UnderlyingInstrumentID stringOptional

Underlying instrument identifier for an option fill. Omitted for a non-derivative fill, when the underlier could not be resolved, or for a multileg fill (per-leg underliers live in legs[]). When a null/undefined value is observed, it indicates it does not apply.

formatuuid

UnderlyingInstrumentType SecurityTypeOptional

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeIndex SecurityType = "INDEX"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

Venue stringOptional

Venue where this fill occurred, as reported by that venue. Distinct from an order’s venue, which is the routing destination. Codes are not normalized, so the format varies by venue. When a null/undefined value is observed, it indicates that there is no available data.

type ExecutionList []Execution

ID string

Unique identifier for this execution report.

formatuuid

OrderID string

Identifier of the order this execution belongs to.

formatuuid

Quantity string

Filled quantity.

Side Side

Side of the fill.

One of the following:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

TransactionTime Time

Transaction timestamp in nanosecond precision (UTC).

formatdate-time

InstrumentID stringOptional

Unique instrument identifier. null when this fill has no single resolvable instrument. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

Price stringOptional

Fill price. null for multileg fills, whose price lives only at the leg level. When a null/undefined value is observed, it indicates it does not apply.

Symbol stringOptional

Trading symbol. null when this fill has no single resolvable instrument. When a null/undefined value is observed, it indicates it does not apply.

UnderlyingInstrumentID stringOptional

formatuuid

UnderlyingInstrumentType SecurityTypeOptional

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeIndex SecurityType = "INDEX"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

Venue stringOptional

type InstrumentIDOrSymbol string

Instrument identifier: either an instrument UUID or a symbol (symbol for equities, OSI for options). Non-UUID inputs are resolved server-side.

type NewOrderRequest struct{…}

Request to submit a new order

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"

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 RequestTimeInForceAtOpen RequestTimeInForce = "AT_OPEN"

const RequestTimeInForceAtClose RequestTimeInForce = "AT_CLOSE"

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 ID (UUID) or symbol (equity ticker or OSI option symbol). Either symbol or instrument_id must be provided.

minLength1

LimitOffset stringOptional

Limit offset for trailing stop-limit orders (signed)

LimitPrice stringOptional

Limit price (required for LIMIT and STOP_LIMIT orders)

PositionIntent RequestPositionEffectOptional

Optional open/close intent for this order. When omitted, the platform determines the position effect.

One of the following:

const RequestPositionEffectOpen RequestPositionEffect = "OPEN"

const RequestPositionEffectClose RequestPositionEffect = "CLOSE"

StopPrice stringOptional

Stop price (required for STOP and STOP_LIMIT orders)

Strategy OrderStrategyUnionOptional

One of the following:

type OrderStrategyType struct{…}

Smart Order Router. Routes the order to the best available venue(s).

Type string

Execution strategy type.

type OrderStrategyObject struct{…}

Volume-Weighted Average Price. Works the order to track the volume-weighted average price over the execution window.

Type string

Execution strategy type.

EndAt TimeOptional

UTC timestamp (RFC 3339) by which to finish working the order. Defaults to market close.

formatdate-time

StartAt TimeOptional

UTC timestamp (RFC 3339) at which to begin working the order. Defaults to the time the order is received.

formatdate-time

type OrderStrategyObject2 struct{…}

Time-Weighted Average Price. Spreads execution evenly across the execution window.

Type string

Execution strategy type.

EndAt TimeOptional

UTC timestamp (RFC 3339) by which to finish working the order. Defaults to market close.

formatdate-time

StartAt TimeOptional

UTC timestamp (RFC 3339) at which to begin working the order. Defaults to the time the order is received.

formatdate-time

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

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 or SELL)

One of the following:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

Status OrderStatus

Current status of the order

One of the following:

const OrderStatusPendingNew OrderStatus = "PENDING_NEW"

const OrderStatusQueued OrderStatus = "QUEUED"

const OrderStatusPendingTrigger OrderStatus = "PENDING_TRIGGER"

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"

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 TimeInForceAtOpen TimeInForce = "AT_OPEN"

const TimeInForceAtClose TimeInForce = "AT_CLOSE"

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. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. When a null/undefined value is observed, it indicates that there is no available data.

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.

InstrumentID stringOptional

Instrument identifier for the traded instrument. null when the order has no single resolvable instrument. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

InstrumentType SecurityTypeOptional

Type of security. null when the order has no single resolvable instrument. When a null/undefined value is observed, it indicates it does not apply.

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeIndex SecurityType = "INDEX"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

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.

Strategy OrderStrategyOptional

The execution strategy the order was submitted with, if any.

Type string

Execution strategy type.

EndAt TimeOptional

UTC timestamp (RFC 3339) at which execution ends.

formatdate-time

StartAt TimeOptional

UTC timestamp (RFC 3339) at which execution begins.

formatdate-time

Symbol stringOptional

Trading symbol. null when the order has no single resolvable instrument. 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. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

TrailingWatermarkTs TimeOptional

Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

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

UnderlyingInstrumentType SecurityTypeOptional

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeIndex SecurityType = "INDEX"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

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

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 or SELL)

One of the following:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

Status OrderStatus

Current status of the order

One of the following:

const OrderStatusPendingNew OrderStatus = "PENDING_NEW"

const OrderStatusQueued OrderStatus = "QUEUED"

const OrderStatusPendingTrigger OrderStatus = "PENDING_TRIGGER"

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"

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 TimeInForceAtOpen TimeInForce = "AT_OPEN"

const TimeInForceAtClose TimeInForce = "AT_CLOSE"

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

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.

InstrumentID stringOptional

Instrument identifier for the traded instrument. null when the order has no single resolvable instrument. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

InstrumentType SecurityTypeOptional

Type of security. null when the order has no single resolvable instrument. When a null/undefined value is observed, it indicates it does not apply.

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeIndex SecurityType = "INDEX"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

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.

Strategy OrderStrategyOptional

The execution strategy the order was submitted with, if any.

Type string

Execution strategy type.

EndAt TimeOptional

UTC timestamp (RFC 3339) at which execution ends.

formatdate-time

StartAt TimeOptional

UTC timestamp (RFC 3339) at which execution begins.

formatdate-time

Symbol stringOptional

Trading symbol. null when the order has no single resolvable instrument. 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

TrailingWatermarkTs TimeOptional

formatdate-time

UnderlyingInstrumentID stringOptional

formatuuid

UnderlyingInstrumentType SecurityTypeOptional

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeIndex SecurityType = "INDEX"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

type OrderStatus string

Order status

One of the following:

const OrderStatusPendingNew OrderStatus = "PENDING_NEW"

const OrderStatusQueued OrderStatus = "QUEUED"

const OrderStatusPendingTrigger OrderStatus = "PENDING_TRIGGER"

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

Optional execution strategy controlling how the order is worked in the market. Omit to use standard routing. One of SOR, VWAP, or TWAP.

One of the following:

type OrderStrategyType struct{…}

Smart Order Router. Routes the order to the best available venue(s).

Type string

Execution strategy type.

type OrderStrategyObject struct{…}

Volume-Weighted Average Price. Works the order to track the volume-weighted average price over the execution window.

Type string

Execution strategy type.

EndAt TimeOptional

UTC timestamp (RFC 3339) by which to finish working the order. Defaults to market close.

formatdate-time

StartAt TimeOptional

UTC timestamp (RFC 3339) at which to begin working the order. Defaults to the time the order is received.

formatdate-time

type OrderStrategyObject2 struct{…}

Time-Weighted Average Price. Spreads execution evenly across the execution window.

Type string

Execution strategy type.

EndAt TimeOptional

UTC timestamp (RFC 3339) by which to finish working the order. Defaults to market close.

formatdate-time

StartAt TimeOptional

UTC timestamp (RFC 3339) at which to begin working the order. Defaults to the time the order is received.

formatdate-time

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

Parent order queue or hold state.

One of the following:

const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"

const QueueStateReleased QueueState = "RELEASED"

type ReplaceOrderRequest struct{…}

Request to replace (modify) an existing order

At least one field must be provided.

LimitOffset stringOptional

New limit offset for trailing stop-limit orders (signed)

LimitPrice stringOptional

New limit price for the order

Quantity stringOptional

New quantity for the order

StopPrice stringOptional

New stop price for the order

TrailingOffset stringOptional

New trailing offset for trailing orders

TrailingOffsetType TrailingOffsetTypeOptional

New trailing offset type (PRICE or BPS)

One of the following:

const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"

const TrailingOffsetTypeBps TrailingOffsetType = "BPS"

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

Client-attested open/close intent for an order.

One of the following:

const RequestPositionEffectOpen RequestPositionEffect = "OPEN"

const RequestPositionEffectClose RequestPositionEffect = "CLOSE"

type RequestTimeInForce string

Strict time-in-force enum for order submission 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 RequestTimeInForceAtOpen RequestTimeInForce = "AT_OPEN"

const RequestTimeInForceAtClose RequestTimeInForce = "AT_CLOSE"

type Side string

Side of the order (BUY or SELL).

One of the following:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

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 TimeInForceAtOpen TimeInForce = "AT_OPEN"

const TimeInForceAtClose TimeInForce = "AT_CLOSE"

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 SecurityTypeIndex SecurityType = "INDEX"

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"

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

UnderlyingInstrumentType SecurityTypeOptional

Type of the underlying instrument, alongside underlying_instrument_id When a null/undefined value is observed, it indicates it does not apply.

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeIndex SecurityType = "INDEX"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

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

ClientInstructionID 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

Rejection PositionInstructionRejectionOptional

Machine-readable counterpart to rejection_reason: a stable reason code, human-readable description, and params, present on every rejected row — on submit, cancel, get, and list alike. Branch on rejection.reason and read rejection.description instead of the top-level rejection_reason. When a null/undefined value is observed, it indicates it does not apply.

Description string

Human-readable explanation of the rejection. Duplicates the top-level rejection_reason; prefer this field.

Domain string

Namespacing domain of the reason code — com.clearstreet.oems.exercise for reasons OEMS validates, com.clearstreet.oems.clearing for clearing-owned reasons.

Metadata map[string, string]

Reason-specific parameters as a string→string map. Which keys are present depends on reason:

INSUFFICIENT_POSITION → available, requested
DNE_NOT_ON_EXPIRY / CEA_NOT_ON_EXPIRY → expiry, business_date
EXERCISE_PAST_CUTOFF → cutoff_time
DUPLICATE_INSTRUCTION → existing_id

Empty for reasons that carry no parameters. New keys may be added over time, so treat unknown keys leniently.

Reason string

Stable, machine-readable reason code, e.g. DNE_NOT_ON_EXPIRY, INSUFFICIENT_POSITION, OPTIONS_LEVEL_EXCEEDED, EXERCISE_PAST_CUTOFF.

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.

UnderlyingInstrumentID stringOptional

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

formatuuid

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

ClientInstructionID 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

Rejection PositionInstructionRejectionOptional

Description string

Human-readable explanation of the rejection. Duplicates the top-level rejection_reason; prefer this field.

Domain string

Namespacing domain of the reason code — com.clearstreet.oems.exercise for reasons OEMS validates, com.clearstreet.oems.clearing for clearing-owned reasons.

Metadata map[string, string]

Reason-specific parameters as a string→string map. Which keys are present depends on reason:

INSUFFICIENT_POSITION → available, requested
DNE_NOT_ON_EXPIRY / CEA_NOT_ON_EXPIRY → expiry, business_date
EXERCISE_PAST_CUTOFF → cutoff_time
DUPLICATE_INSTRUCTION → existing_id

Empty for reasons that carry no parameters. New keys may be added over time, so treat unknown keys leniently.

Reason string

Stable, machine-readable reason code, e.g. DNE_NOT_ON_EXPIRY, INSUFFICIENT_POSITION, OPTIONS_LEVEL_EXCEEDED, EXERCISE_PAST_CUTOFF.

RejectionReason stringOptional

UnderlyingInstrumentID stringOptional

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

formatuuid

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

Machine-readable detail for a rejected position instruction.

Present on every rejected row, across the full lifecycle — submit, cancel, get, and list. Branch on reason for programmatic handling and template your own copy from metadata, or show description directly.

Description string

Human-readable explanation of the rejection. Duplicates the top-level rejection_reason; prefer this field.

Domain string

Namespacing domain of the reason code — com.clearstreet.oems.exercise for reasons OEMS validates, com.clearstreet.oems.clearing for clearing-owned reasons.

Metadata map[string, string]

Reason-specific parameters as a string→string map. Which keys are present depends on reason:

INSUFFICIENT_POSITION → available, requested
DNE_NOT_ON_EXPIRY / CEA_NOT_ON_EXPIRY → expiry, business_date
EXERCISE_PAST_CUTOFF → cutoff_time
DUPLICATE_INSTRUCTION → existing_id

Empty for reasons that carry no parameters. New keys may be added over time, so treat unknown keys leniently.

Reason string

Stable, machine-readable reason code, e.g. DNE_NOT_ON_EXPIRY, INSUFFICIENT_POSITION, OPTIONS_LEVEL_EXCEEDED, EXERCISE_PAST_CUTOFF.

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 client_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 SecurityTypeIndex SecurityType = "INDEX"

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"

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

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

UnderlyingInstrumentType SecurityTypeOptional

Type of the underlying instrument, alongside underlying_instrument_id When a null/undefined value is observed, it indicates it does not apply.

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeIndex SecurityType = "INDEX"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

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

type PositionType string

Position type classification

One of the following:

const PositionTypeLong PositionType = "LONG"

const PositionTypeShort PositionType = "SHORT"

V1Private Markets

Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.

Get SPV

client.V1.PrivateMarkets.GetSpvByID(ctx, spvID, query) (*V1PrivateMarketGetSpvByIDResponse, error)

GET/v1/private-markets/spvs/{spv_id}

List every live IOI for the caller's account-holder entity.

client.V1.PrivateMarkets.GetIois(ctx, query) (*V1PrivateMarketGetIoisResponse, error)

GET/v1/private-markets/iois

Create an IOI for a visible upcoming offering.

client.V1.PrivateMarkets.NewIoi(ctx, params) (*V1PrivateMarketNewIoiResponse, error)

POST/v1/private-markets/iois

Update an IOI's notional, accepting the current NDA revision when required.

client.V1.PrivateMarkets.UpdateIoi(ctx, ioiID, params) (*V1PrivateMarketUpdateIoiResponse, error)

PATCH/v1/private-markets/iois/{ioi_id}

Withdraw a live IOI. Repeating a withdrawal returns 404.

client.V1.PrivateMarkets.DeleteIoi(ctx, ioiID, body) error

DELETE/v1/private-markets/iois/{ioi_id}

Get Company

client.V1.PrivateMarkets.GetCompanyByID(ctx, companyID, query) (*V1PrivateMarketGetCompanyByIDResponse, error)

GET/v1/private-markets/companies/{company_id}

V1Private MarketsCompanies

ModelsExpand Collapse

type CompanyCategory struct{…}

A company category.

Name string

Display name.

Slug string

Stable lowercase category slug.

type CompanyCitation struct{…}

A cited source.

ID string

Stable profile-local citation identifier.

Source string

Source publisher or provider.

Title string

Human-readable source title.

URL string

Source URL.

PublishedAt TimeOptional

Source publication time, when known.

formatdate-time

type CompanyCustomer struct{…}

A named company customer.

Name string

Customer name.

LogoURL stringOptional

Customer logo, when supplied.

type CompanyDetail struct{…}

A company’s identity and its complete published profile.

ID string

Stable company identifier.

formatuuid

Name string

Display name.

Profile CompanyProfileResource

The complete versioned company profile.

Categories []CompanyCategoryOptional

Company categories.

Name string

Display name.

Slug string

Stable lowercase category slug.

Citations []CompanyCitationOptional

Sources referenced by narrative sections and metrics.

ID string

Stable profile-local citation identifier.

Source string

Source publisher or provider.

Title string

Human-readable source title.

URL string

Source URL.

PublishedAt TimeOptional

Source publication time, when known.

formatdate-time

Customers []CompanyCustomerOptional

Named customers evidenced by the source material.

Name string

Customer name.

LogoURL stringOptional

Customer logo, when supplied.

Documents []CompanyDocumentResourceOptional

Company-level research and source documents.

DocumentType CompanyDocumentType

Typed document kind.

One of the following:

const CompanyDocumentTypeCompanyProfile CompanyDocumentType = "COMPANY_PROFILE"

const CompanyDocumentTypeMarketResearch CompanyDocumentType = "MARKET_RESEARCH"

const CompanyDocumentTypeInterview CompanyDocumentType = "INTERVIEW"

const CompanyDocumentTypeDealSheet CompanyDocumentType = "DEAL_SHEET"

const CompanyDocumentTypePressRelease CompanyDocumentType = "PRESS_RELEASE"

const CompanyDocumentTypeNews CompanyDocumentType = "NEWS"

const CompanyDocumentTypeOther CompanyDocumentType = "OTHER"

Relation CompanyDocumentRelation

Relationship to this company.

One of the following:

const CompanyDocumentRelationSubject CompanyDocumentRelation = "SUBJECT"

const CompanyDocumentRelationConnected CompanyDocumentRelation = "CONNECTED"

Title string

Display title.

URL string

Document URL.

ExternalID stringOptional

Optional source identifier retained for reconciliation.

Preview CompanyDocumentPreviewOptional

Optional card preview.

Description stringOptional

Preview description.

ImageURL stringOptional

Preview image URL.

PublishedAt TimeOptional

Publication time, when known.

formatdate-time

Headquarters CompanyHeadquartersOptional

Company headquarters, when known.

City string

City.

Country string

Country.

LegalEntities []CompanyLegalEntityOptional

Known legal entities associated with the company.

Country string

Country name or ISO country code supplied by the source.

Name string

Legal name.

MetricSeries []CompanyMetricSeriesOptional

Historical and estimated metric series.

Frequency MetricFrequency

Observation cadence.

One of the following:

const MetricFrequencyYear MetricFrequency = "YEAR"

const MetricFrequencyQuarter MetricFrequency = "QUARTER"

const MetricFrequencyMonth MetricFrequency = "MONTH"

const MetricFrequencyPointInTime MetricFrequency = "POINT_IN_TIME"

Label string

Display label.

MetricKey MetricKey

Canonical metric key.

One of the following:

const MetricKeyAnnualizedRevenue MetricKey = "ANNUALIZED_REVENUE"

const MetricKeyRevenueGrowth MetricKey = "REVENUE_GROWTH"

const MetricKeyValuation MetricKey = "VALUATION"

const MetricKeyIssuePrice MetricKey = "ISSUE_PRICE"

const MetricKeyPricePerShare MetricKey = "PRICE_PER_SHARE"

const MetricKeyAmountRaised MetricKey = "AMOUNT_RAISED"

const MetricKeyOrderVolume MetricKey = "ORDER_VOLUME"

const MetricKeyPipelineValue MetricKey = "PIPELINE_VALUE"

const MetricKeyGrossMargin MetricKey = "GROSS_MARGIN"

const MetricKeyEbitMargin MetricKey = "EBIT_MARGIN"

const MetricKeyFcfConversion MetricKey = "FCF_CONVERSION"

const MetricKeyContractedRevenuePercent MetricKey = "CONTRACTED_REVENUE_PERCENT"

const MetricKeyNetRevenueRetention MetricKey = "NET_REVENUE_RETENTION"

const MetricKeyCustomerCount MetricKey = "CUSTOMER_COUNT"

const MetricKeyMarketPosition MetricKey = "MARKET_POSITION"

Source string

Publisher/provider name.

Unit MetricUnit

Value unit.

One of the following:

const MetricUnitUsd MetricUnit = "USD"

const MetricUnitPercent MetricUnit = "PERCENT"

const MetricUnitCount MetricUnit = "COUNT"

const MetricUnitRank MetricUnit = "RANK"

ExternalID stringOptional

Optional source identifier retained for reconciliation.

Points []CompanyMetricPointOptional

Ordered observations.

ObservedAt Time

Observation time.

formatdate-time

Value string

Exact decimal value, serialized as a string.

ValueType MetricValueType

Historical or estimated classification.

One of the following:

const MetricValueTypeHistorical MetricValueType = "HISTORICAL"

const MetricValueTypeEstimated MetricValueType = "ESTIMATED"

CitationIDs []stringOptional

Profile-local citation ids supporting this point.

SourceEventID stringOptional

Optional source event identifier.

SourceMetadata map[string, string]Optional

Optional provider reconciliation metadata.

SourceURL stringOptional

Source URL, when available.

NarrativeSections []CompanyNarrativeSectionOptional

Ordered durable company fact and thesis blocks.

Body string

Plain-text section body.

DisplayOrder int64

Stable display position within the profile.

formatint32

Title string

Section heading.

CitationIDs []stringOptional

Profile-local citation ids supporting this block.

Overview stringOptional

Long company overview.

People []CompanyPersonOptional

Key people and their roles.

Name string

Display name.

ExternalID stringOptional

Optional source identifier retained for reconciliation.

Roles []CompanyPersonRoleOptional

One or more curated company roles.

One of the following:

const CompanyPersonRoleFounder CompanyPersonRole = "FOUNDER"

const CompanyPersonRoleCeo CompanyPersonRole = "CEO"

const CompanyPersonRoleOther CompanyPersonRole = "OTHER"

Social/profile links.

Type CompanySocialType

Link type.

One of the following:

const CompanySocialTypeWebsite CompanySocialType = "WEBSITE"

const CompanySocialTypeLinkedin CompanySocialType = "LINKEDIN"

const CompanySocialTypeX CompanySocialType = "X"

const CompanySocialTypeFacebook CompanySocialType = "FACEBOOK"

const CompanySocialTypeOther CompanySocialType = "OTHER"

URL string

Link URL.

Tagline stringOptional

Short durable positioning line used with the company name.

ProfileSchemaVersion int64

Profile schema version discriminator.

formatint32

ShortDescription string

Short card/search description.

Slug string

Lowercase URL slug.

LogoURL stringOptional

Company logo URL, when known.

PrimaryDomain stringOptional

Canonical lowercase domain, when known.

PublishedAt TimeOptional

Publication time.

formatdate-time

type CompanyDocumentPreview struct{…}

Optional document card preview.

Description stringOptional

Preview description.

ImageURL stringOptional

Preview image URL.

type CompanyDocumentRelation string

How a document relates to the company.

One of the following:

const CompanyDocumentRelationSubject CompanyDocumentRelation = "SUBJECT"

const CompanyDocumentRelationConnected CompanyDocumentRelation = "CONNECTED"

type CompanyDocumentResource struct{…}

A company-level research or source document.

DocumentType CompanyDocumentType

Typed document kind.

One of the following:

const CompanyDocumentTypeCompanyProfile CompanyDocumentType = "COMPANY_PROFILE"

const CompanyDocumentTypeMarketResearch CompanyDocumentType = "MARKET_RESEARCH"

const CompanyDocumentTypeInterview CompanyDocumentType = "INTERVIEW"

const CompanyDocumentTypeDealSheet CompanyDocumentType = "DEAL_SHEET"

const CompanyDocumentTypePressRelease CompanyDocumentType = "PRESS_RELEASE"

const CompanyDocumentTypeNews CompanyDocumentType = "NEWS"

const CompanyDocumentTypeOther CompanyDocumentType = "OTHER"

Relation CompanyDocumentRelation

Relationship to this company.

One of the following:

const CompanyDocumentRelationSubject CompanyDocumentRelation = "SUBJECT"

const CompanyDocumentRelationConnected CompanyDocumentRelation = "CONNECTED"

Title string

Display title.

URL string

Document URL.

ExternalID stringOptional

Optional source identifier retained for reconciliation.

Preview CompanyDocumentPreviewOptional

Optional card preview.

Description stringOptional

Preview description.

ImageURL stringOptional

Preview image URL.

PublishedAt TimeOptional

Publication time, when known.

formatdate-time

type CompanyDocumentType string

Company document kind.

One of the following:

const CompanyDocumentTypeCompanyProfile CompanyDocumentType = "COMPANY_PROFILE"

const CompanyDocumentTypeMarketResearch CompanyDocumentType = "MARKET_RESEARCH"

const CompanyDocumentTypeInterview CompanyDocumentType = "INTERVIEW"

const CompanyDocumentTypeDealSheet CompanyDocumentType = "DEAL_SHEET"

const CompanyDocumentTypePressRelease CompanyDocumentType = "PRESS_RELEASE"

const CompanyDocumentTypeNews CompanyDocumentType = "NEWS"

const CompanyDocumentTypeOther CompanyDocumentType = "OTHER"

type CompanyHeadquarters struct{…}

Company headquarters.

City string

City.

Country string

Country.

type CompanyLegalEntity struct{…}

A legal entity associated with the company.

Country string

Country name or ISO country code supplied by the source.

Name string

Legal name.

type CompanyMetricPoint struct{…}

One metric observation.

ObservedAt Time

Observation time.

formatdate-time

Value string

Exact decimal value, serialized as a string.

ValueType MetricValueType

Historical or estimated classification.

One of the following:

const MetricValueTypeHistorical MetricValueType = "HISTORICAL"

const MetricValueTypeEstimated MetricValueType = "ESTIMATED"

CitationIDs []stringOptional

Profile-local citation ids supporting this point.

SourceEventID stringOptional

Optional source event identifier.

SourceMetadata map[string, string]Optional

Optional provider reconciliation metadata.

type CompanyMetricSeries struct{…}

A historical or estimated company metric series.

Frequency MetricFrequency

Observation cadence.

One of the following:

const MetricFrequencyYear MetricFrequency = "YEAR"

const MetricFrequencyQuarter MetricFrequency = "QUARTER"

const MetricFrequencyMonth MetricFrequency = "MONTH"

const MetricFrequencyPointInTime MetricFrequency = "POINT_IN_TIME"

Label string

Display label.

MetricKey MetricKey

Canonical metric key.

One of the following:

const MetricKeyAnnualizedRevenue MetricKey = "ANNUALIZED_REVENUE"

const MetricKeyRevenueGrowth MetricKey = "REVENUE_GROWTH"

const MetricKeyValuation MetricKey = "VALUATION"

const MetricKeyIssuePrice MetricKey = "ISSUE_PRICE"

const MetricKeyPricePerShare MetricKey = "PRICE_PER_SHARE"

const MetricKeyAmountRaised MetricKey = "AMOUNT_RAISED"

const MetricKeyOrderVolume MetricKey = "ORDER_VOLUME"

const MetricKeyPipelineValue MetricKey = "PIPELINE_VALUE"

const MetricKeyGrossMargin MetricKey = "GROSS_MARGIN"

const MetricKeyEbitMargin MetricKey = "EBIT_MARGIN"

const MetricKeyFcfConversion MetricKey = "FCF_CONVERSION"

const MetricKeyContractedRevenuePercent MetricKey = "CONTRACTED_REVENUE_PERCENT"

const MetricKeyNetRevenueRetention MetricKey = "NET_REVENUE_RETENTION"

const MetricKeyCustomerCount MetricKey = "CUSTOMER_COUNT"

const MetricKeyMarketPosition MetricKey = "MARKET_POSITION"

Source string

Publisher/provider name.

Unit MetricUnit

Value unit.

One of the following:

const MetricUnitUsd MetricUnit = "USD"

const MetricUnitPercent MetricUnit = "PERCENT"

const MetricUnitCount MetricUnit = "COUNT"

const MetricUnitRank MetricUnit = "RANK"

ExternalID stringOptional

Optional source identifier retained for reconciliation.

Points []CompanyMetricPointOptional

Ordered observations.

ObservedAt Time

Observation time.

formatdate-time

Value string

Exact decimal value, serialized as a string.

ValueType MetricValueType

Historical or estimated classification.

One of the following:

const MetricValueTypeHistorical MetricValueType = "HISTORICAL"

const MetricValueTypeEstimated MetricValueType = "ESTIMATED"

CitationIDs []stringOptional

Profile-local citation ids supporting this point.

SourceEventID stringOptional

Optional source event identifier.

SourceMetadata map[string, string]Optional

Optional provider reconciliation metadata.

SourceURL stringOptional

Source URL, when available.

type CompanyNarrativeSection struct{…}

One ordered durable narrative block.

Body string

Plain-text section body.

DisplayOrder int64

Stable display position within the profile.

formatint32

Title string

Section heading.

CitationIDs []stringOptional

Profile-local citation ids supporting this block.

type CompanyPerson struct{…}

A key person associated with the company.

Name string

Display name.

ExternalID stringOptional

Optional source identifier retained for reconciliation.

Roles []CompanyPersonRoleOptional

One or more curated company roles.

One of the following:

const CompanyPersonRoleFounder CompanyPersonRole = "FOUNDER"

const CompanyPersonRoleCeo CompanyPersonRole = "CEO"

const CompanyPersonRoleOther CompanyPersonRole = "OTHER"

type CompanyPersonRole string

A key person’s relationship to the company.

One of the following:

const CompanyPersonRoleFounder CompanyPersonRole = "FOUNDER"

const CompanyPersonRoleCeo CompanyPersonRole = "CEO"

const CompanyPersonRoleOther CompanyPersonRole = "OTHER"

type CompanyProfileResource struct{…}

The complete versioned company profile (schema version one).

Categories []CompanyCategoryOptional

Company categories.

Name string

Display name.

Slug string

Stable lowercase category slug.

Citations []CompanyCitationOptional

Sources referenced by narrative sections and metrics.

ID string

Stable profile-local citation identifier.

Source string

Source publisher or provider.

Title string

Human-readable source title.

URL string

Source URL.

PublishedAt TimeOptional

Source publication time, when known.

formatdate-time

Customers []CompanyCustomerOptional

Named customers evidenced by the source material.

Name string

Customer name.

LogoURL stringOptional

Customer logo, when supplied.

Documents []CompanyDocumentResourceOptional

Company-level research and source documents.

DocumentType CompanyDocumentType

Typed document kind.

One of the following:

const CompanyDocumentTypeCompanyProfile CompanyDocumentType = "COMPANY_PROFILE"

const CompanyDocumentTypeMarketResearch CompanyDocumentType = "MARKET_RESEARCH"

const CompanyDocumentTypeInterview CompanyDocumentType = "INTERVIEW"

const CompanyDocumentTypeDealSheet CompanyDocumentType = "DEAL_SHEET"

const CompanyDocumentTypePressRelease CompanyDocumentType = "PRESS_RELEASE"

const CompanyDocumentTypeNews CompanyDocumentType = "NEWS"

const CompanyDocumentTypeOther CompanyDocumentType = "OTHER"

Relation CompanyDocumentRelation

Relationship to this company.

One of the following:

const CompanyDocumentRelationSubject CompanyDocumentRelation = "SUBJECT"

const CompanyDocumentRelationConnected CompanyDocumentRelation = "CONNECTED"

Title string

Display title.

URL string

Document URL.

ExternalID stringOptional

Optional source identifier retained for reconciliation.

Preview CompanyDocumentPreviewOptional

Optional card preview.

Description stringOptional

Preview description.

ImageURL stringOptional

Preview image URL.

PublishedAt TimeOptional

Publication time, when known.

formatdate-time

Headquarters CompanyHeadquartersOptional

Company headquarters, when known.

City string

City.

Country string

Country.

LegalEntities []CompanyLegalEntityOptional

Known legal entities associated with the company.

Country string

Country name or ISO country code supplied by the source.

Name string

Legal name.

MetricSeries []CompanyMetricSeriesOptional

Historical and estimated metric series.

Frequency MetricFrequency

Observation cadence.

One of the following:

const MetricFrequencyYear MetricFrequency = "YEAR"

const MetricFrequencyQuarter MetricFrequency = "QUARTER"

const MetricFrequencyMonth MetricFrequency = "MONTH"

const MetricFrequencyPointInTime MetricFrequency = "POINT_IN_TIME"

Label string

Display label.

MetricKey MetricKey

Canonical metric key.

One of the following:

const MetricKeyAnnualizedRevenue MetricKey = "ANNUALIZED_REVENUE"

const MetricKeyRevenueGrowth MetricKey = "REVENUE_GROWTH"

const MetricKeyValuation MetricKey = "VALUATION"

const MetricKeyIssuePrice MetricKey = "ISSUE_PRICE"

const MetricKeyPricePerShare MetricKey = "PRICE_PER_SHARE"

const MetricKeyAmountRaised MetricKey = "AMOUNT_RAISED"

const MetricKeyOrderVolume MetricKey = "ORDER_VOLUME"

const MetricKeyPipelineValue MetricKey = "PIPELINE_VALUE"

const MetricKeyGrossMargin MetricKey = "GROSS_MARGIN"

const MetricKeyEbitMargin MetricKey = "EBIT_MARGIN"

const MetricKeyFcfConversion MetricKey = "FCF_CONVERSION"

const MetricKeyContractedRevenuePercent MetricKey = "CONTRACTED_REVENUE_PERCENT"

const MetricKeyNetRevenueRetention MetricKey = "NET_REVENUE_RETENTION"

const MetricKeyCustomerCount MetricKey = "CUSTOMER_COUNT"

const MetricKeyMarketPosition MetricKey = "MARKET_POSITION"

Source string

Publisher/provider name.

Unit MetricUnit

Value unit.

One of the following:

const MetricUnitUsd MetricUnit = "USD"

const MetricUnitPercent MetricUnit = "PERCENT"

const MetricUnitCount MetricUnit = "COUNT"

const MetricUnitRank MetricUnit = "RANK"

ExternalID stringOptional

Optional source identifier retained for reconciliation.

Points []CompanyMetricPointOptional

Ordered observations.

ObservedAt Time

Observation time.

formatdate-time

Value string

Exact decimal value, serialized as a string.

ValueType MetricValueType

Historical or estimated classification.

One of the following:

const MetricValueTypeHistorical MetricValueType = "HISTORICAL"

const MetricValueTypeEstimated MetricValueType = "ESTIMATED"

CitationIDs []stringOptional

Profile-local citation ids supporting this point.

SourceEventID stringOptional

Optional source event identifier.

SourceMetadata map[string, string]Optional

Optional provider reconciliation metadata.

SourceURL stringOptional

Source URL, when available.

NarrativeSections []CompanyNarrativeSectionOptional

Ordered durable company fact and thesis blocks.

Body string

Plain-text section body.

DisplayOrder int64

Stable display position within the profile.

formatint32

Title string

Section heading.

CitationIDs []stringOptional

Profile-local citation ids supporting this block.

Overview stringOptional

Long company overview.

People []CompanyPersonOptional

Key people and their roles.

Name string

Display name.

ExternalID stringOptional

Optional source identifier retained for reconciliation.

Roles []CompanyPersonRoleOptional

One or more curated company roles.

One of the following:

const CompanyPersonRoleFounder CompanyPersonRole = "FOUNDER"

const CompanyPersonRoleCeo CompanyPersonRole = "CEO"

const CompanyPersonRoleOther CompanyPersonRole = "OTHER"

Social/profile links.

Type CompanySocialType

Link type.

One of the following:

const CompanySocialTypeWebsite CompanySocialType = "WEBSITE"

const CompanySocialTypeLinkedin CompanySocialType = "LINKEDIN"

const CompanySocialTypeX CompanySocialType = "X"

const CompanySocialTypeFacebook CompanySocialType = "FACEBOOK"

const CompanySocialTypeOther CompanySocialType = "OTHER"

URL string

Link URL.

Tagline stringOptional

Short durable positioning line used with the company name.

type CompanySocialLink struct{…}

A company social/profile link.

Type CompanySocialType

Link type.

One of the following:

const CompanySocialTypeWebsite CompanySocialType = "WEBSITE"

const CompanySocialTypeLinkedin CompanySocialType = "LINKEDIN"

const CompanySocialTypeX CompanySocialType = "X"

const CompanySocialTypeFacebook CompanySocialType = "FACEBOOK"

const CompanySocialTypeOther CompanySocialType = "OTHER"

URL string

Link URL.

type CompanySocialType string

Kind of company social/profile link.

One of the following:

const CompanySocialTypeWebsite CompanySocialType = "WEBSITE"

const CompanySocialTypeLinkedin CompanySocialType = "LINKEDIN"

const CompanySocialTypeX CompanySocialType = "X"

const CompanySocialTypeFacebook CompanySocialType = "FACEBOOK"

const CompanySocialTypeOther CompanySocialType = "OTHER"

type MetricFrequency string

Observation cadence for a metric series.

One of the following:

const MetricFrequencyYear MetricFrequency = "YEAR"

const MetricFrequencyQuarter MetricFrequency = "QUARTER"

const MetricFrequencyMonth MetricFrequency = "MONTH"

const MetricFrequencyPointInTime MetricFrequency = "POINT_IN_TIME"

type MetricKey string

Canonical company metric key.

One of the following:

const MetricKeyAnnualizedRevenue MetricKey = "ANNUALIZED_REVENUE"

const MetricKeyRevenueGrowth MetricKey = "REVENUE_GROWTH"

const MetricKeyValuation MetricKey = "VALUATION"

const MetricKeyIssuePrice MetricKey = "ISSUE_PRICE"

const MetricKeyPricePerShare MetricKey = "PRICE_PER_SHARE"

const MetricKeyAmountRaised MetricKey = "AMOUNT_RAISED"

const MetricKeyOrderVolume MetricKey = "ORDER_VOLUME"

const MetricKeyPipelineValue MetricKey = "PIPELINE_VALUE"

const MetricKeyGrossMargin MetricKey = "GROSS_MARGIN"

const MetricKeyEbitMargin MetricKey = "EBIT_MARGIN"

const MetricKeyFcfConversion MetricKey = "FCF_CONVERSION"

const MetricKeyContractedRevenuePercent MetricKey = "CONTRACTED_REVENUE_PERCENT"

const MetricKeyNetRevenueRetention MetricKey = "NET_REVENUE_RETENTION"

const MetricKeyCustomerCount MetricKey = "CUSTOMER_COUNT"

const MetricKeyMarketPosition MetricKey = "MARKET_POSITION"

V1Private MarketsIois

ModelsExpand Collapse

type IoiCompanyResource struct{…}

Company identity embedded in an IOI list item.

ID string

Name string

type IoiListingResource struct{…}

IOI list item with the campaign identity needed to render it.

Company IoiCompanyResource

Company identity embedded in an IOI list item.

ID string

Name string

Offering IoiOfferingResource

Offering identity embedded in an IOI list item.

ID string

Headline string

type IoiListingResourceList []IoiListingResource

Company IoiCompanyResource

Company identity embedded in an IOI list item.

ID string

Name string

Offering IoiOfferingResource

Offering identity embedded in an IOI list item.

ID string

Headline string

type IoiOfferingResource struct{…}

Offering identity embedded in an IOI list item.

ID string

Headline string

type IoiResource struct{…}

One live indication of interest.

ID string

AccountID int64

CreatedAt Time

Currency Currency

Terms currency.

NotionalAmount string

OfferingID string

UpdatedAt Time

NdaAcceptance NdaAcceptanceResourceOptional

Most recent NDA acceptance linked to this IOI, if any.

AcceptedAt Time

AgreementID string

Version int64

type NdaAcceptanceResource struct{…}

Public evidence that an NDA version was accepted. Signing IP and other provenance remain audit-only and are never returned by this API.

AcceptedAt Time

AgreementID string

Version int64

V1Private MarketsOfferings

Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.

List Offerings

client.V1.PrivateMarkets.Offerings.GetOfferings(ctx, query) (*V1PrivateMarketOfferingGetOfferingsResponse, error)

GET/v1/private-markets/offerings

Get Offering

client.V1.PrivateMarkets.Offerings.GetOfferingByID(ctx, offeringID, query) (*V1PrivateMarketOfferingGetOfferingByIDResponse, error)

GET/v1/private-markets/offerings/{offering_id}

ModelsExpand Collapse

type Currency string

Terms currency.

type MetricUnit string

Unit for a resolved highlight metric.

One of the following:

const MetricUnitUsd MetricUnit = "USD"

const MetricUnitPercent MetricUnit = "PERCENT"

const MetricUnitCount MetricUnit = "COUNT"

const MetricUnitRank MetricUnit = "RANK"

type MetricValueType string

Whether a resolved highlight value is observed or estimated.

One of the following:

const MetricValueTypeHistorical MetricValueType = "HISTORICAL"

const MetricValueTypeEstimated MetricValueType = "ESTIMATED"

type NdaAgreementResource struct{…}

Current NDA agreement for an SPV-backed deal.

AcceptanceText string

Exact assent and authority representation shown to the signer.

AcceptanceTextVersion int64

Version of the acceptance representation.

formatint32

AgreementID string

Stable agreement identifier submitted with an IOI acceptance.

formatuuid

DocumentReference string

Durable reference to the immutable NDA artifact.

DocumentSha256 string

Lowercase SHA-256 digest of the artifact bytes.

EffectiveAt Time

Time this version became effective.

formatdate-time

Version int64

Strictly increasing SPV-local agreement version.

formatint32

type OfferingCard struct{…}

One offering as it appears in a list: its derived class, indicative terms, a company identity summary, and any attached SPV.

ID string

Stable public identifier; IOIs and history hang off it.

formatuuid

Class OfferingClass

Derived classification.

One of the following:

const OfferingClassUpcoming OfferingClass = "UPCOMING"

const OfferingClassActive OfferingClass = "ACTIVE"

Company OfferingCompany

Owning company identity.

ID string

Stable company identifier.

formatuuid

Name string

Display name.

ShortDescription string

Short card/search description.

Slug string

Lowercase URL slug.

LogoURL stringOptional

Company logo URL, when known.

PrimaryDomain stringOptional

Canonical lowercase domain, when known.

Currency Currency

Terms currency.

Headline string

Card/detail headline.

Summary string

Top opportunity paragraph.

IndicativePriceHigh stringOptional

Indicative price-per-share range, high endpoint.

IndicativePriceLow stringOptional

Indicative price-per-share range, low endpoint.

IndicativeValuationBasis ValuationBasisOptional

Meaning of the indicative valuation range.

One of the following:

const ValuationBasisPreMoney ValuationBasis = "PRE_MONEY"

const ValuationBasisPostMoney ValuationBasis = "POST_MONEY"

const ValuationBasisReference ValuationBasis = "REFERENCE"

const ValuationBasisImplied ValuationBasis = "IMPLIED"

IndicativeValuationHigh stringOptional

Indicative valuation range, high endpoint.

IndicativeValuationLow stringOptional

Indicative valuation range, low endpoint.

IoiDeadline TimeOptional

Deadline for indications of interest.

formatdate-time

MinimumIoiAmount stringOptional

Minimum indication-of-interest amount.

Spv OfferingSpvOptional

Attached SPV identity and lifecycle, once one exists.

ID string

Stable SPV identifier.

formatuuid

Name string

Legal/display name.

Status SpvStatus

Lifecycle state.

One of the following:

const SpvStatusDraft SpvStatus = "DRAFT"

const SpvStatusOpen SpvStatus = "OPEN"

const SpvStatusClosed SpvStatus = "CLOSED"

const SpvStatusLiquidating SpvStatus = "LIQUIDATING"

const SpvStatusDissolved SpvStatus = "DISSOLVED"

CustodianName stringOptional

Custodian.

ManagerName stringOptional

SPV manager.

NdaAgreement NdaAgreementResourceOptional

Current NDA agreement. Absent when this SPV does not require one.

AcceptanceText string

Exact assent and authority representation shown to the signer.

AcceptanceTextVersion int64

Version of the acceptance representation.

formatint32

AgreementID string

Stable agreement identifier submitted with an IOI acceptance.

formatuuid

DocumentReference string

Durable reference to the immutable NDA artifact.

DocumentSha256 string

Lowercase SHA-256 digest of the artifact bytes.

EffectiveAt Time

Time this version became effective.

formatdate-time

Version int64

Strictly increasing SPV-local agreement version.

formatint32

ShareClass stringOptional

Underlying share class, when specified.

StructureDescription stringOptional

Plain-text vehicle structure.

type OfferingCardList []OfferingCard

ID string

Stable public identifier; IOIs and history hang off it.

formatuuid

Class OfferingClass

Derived classification.

One of the following:

const OfferingClassUpcoming OfferingClass = "UPCOMING"

const OfferingClassActive OfferingClass = "ACTIVE"

Company OfferingCompany

Owning company identity.

ID string

Stable company identifier.

formatuuid

Name string

Display name.

ShortDescription string

Short card/search description.

Slug string

Lowercase URL slug.

LogoURL stringOptional

Company logo URL, when known.

PrimaryDomain stringOptional

Canonical lowercase domain, when known.

Currency Currency

Terms currency.

Headline string

Card/detail headline.

Summary string

Top opportunity paragraph.

IndicativePriceHigh stringOptional

Indicative price-per-share range, high endpoint.

IndicativePriceLow stringOptional

Indicative price-per-share range, low endpoint.

IndicativeValuationBasis ValuationBasisOptional

Meaning of the indicative valuation range.

One of the following:

const ValuationBasisPreMoney ValuationBasis = "PRE_MONEY"

const ValuationBasisPostMoney ValuationBasis = "POST_MONEY"

const ValuationBasisReference ValuationBasis = "REFERENCE"

const ValuationBasisImplied ValuationBasis = "IMPLIED"

IndicativeValuationHigh stringOptional

Indicative valuation range, high endpoint.

IndicativeValuationLow stringOptional

Indicative valuation range, low endpoint.

IoiDeadline TimeOptional

Deadline for indications of interest.

formatdate-time

MinimumIoiAmount stringOptional

Minimum indication-of-interest amount.

Spv OfferingSpvOptional

Attached SPV identity and lifecycle, once one exists.

ID string

Stable SPV identifier.

formatuuid

Name string

Legal/display name.

Status SpvStatus

Lifecycle state.

One of the following:

const SpvStatusDraft SpvStatus = "DRAFT"

const SpvStatusOpen SpvStatus = "OPEN"

const SpvStatusClosed SpvStatus = "CLOSED"

const SpvStatusLiquidating SpvStatus = "LIQUIDATING"

const SpvStatusDissolved SpvStatus = "DISSOLVED"

CustodianName stringOptional

Custodian.

ManagerName stringOptional

SPV manager.

NdaAgreement NdaAgreementResourceOptional

Current NDA agreement. Absent when this SPV does not require one.

AcceptanceText string

Exact assent and authority representation shown to the signer.

AcceptanceTextVersion int64

Version of the acceptance representation.

formatint32

AgreementID string

Stable agreement identifier submitted with an IOI acceptance.

formatuuid

DocumentReference string

Durable reference to the immutable NDA artifact.

DocumentSha256 string

Lowercase SHA-256 digest of the artifact bytes.

EffectiveAt Time

Time this version became effective.

formatdate-time

Version int64

Strictly increasing SPV-local agreement version.

formatint32

ShareClass stringOptional

Underlying share class, when specified.

StructureDescription stringOptional

Plain-text vehicle structure.

type OfferingClass string

Derived offering classification.

One of the following:

const OfferingClassUpcoming OfferingClass = "UPCOMING"

const OfferingClassActive OfferingClass = "ACTIVE"

type OfferingCompany struct{…}

Company identity carried on an offering card/detail.

ID string

Stable company identifier.

formatuuid

Name string

Display name.

ShortDescription string

Short card/search description.

Slug string

Lowercase URL slug.

LogoURL stringOptional

Company logo URL, when known.

PrimaryDomain stringOptional

Canonical lowercase domain, when known.

type OfferingDetail struct{…}

One offering with everything needed to render its detail payload.

Disclosures stringOptional

Important disclosures.

Documents []OfferingDocumentResourceOptional

Campaign documents in display order.

ID string

Stable identifier.

formatuuid

DisplayOrder int64

Stable display position.

formatint32

DocumentType OfferingDocumentType

Document kind.

One of the following:

const OfferingDocumentTypeTearsheet OfferingDocumentType = "TEARSHEET"

const OfferingDocumentTypeKeyTerms OfferingDocumentType = "KEY_TERMS"

const OfferingDocumentTypeRiskFactors OfferingDocumentType = "RISK_FACTORS"

const OfferingDocumentTypePpm OfferingDocumentType = "PPM"

const OfferingDocumentTypeOther OfferingDocumentType = "OTHER"

Title string

Display title.

ObjectKey stringOptional

Object-store key, when the document is stored internally.

PublishedAt TimeOptional

Publication time, when known.

formatdate-time

Source stringOptional

Source publisher/provider.

SourceURL stringOptional

Source URL.

URL stringOptional

Externally reachable URL, when the document lives at one.

Highlights []OfferingHighlightOptional

Ordered resolved highlights.

Label string

Display label (the highlight’s override, else the series’ own label).

MetricKey string

Canonical metric key selected by the highlight (e.g. REVENUE_GROWTH).

Unit MetricUnit

Value unit.

One of the following:

const MetricUnitUsd MetricUnit = "USD"

const MetricUnitPercent MetricUnit = "PERCENT"

const MetricUnitCount MetricUnit = "COUNT"

const MetricUnitRank MetricUnit = "RANK"

ObservedAt TimeOptional

Observation time of the latest value.

formatdate-time

Value stringOptional

Latest observed value, when the series carries any points.

ValueType MetricValueTypeOptional

Whether the latest value is historical or estimated.

One of the following:

const MetricValueTypeHistorical MetricValueType = "HISTORICAL"

const MetricValueTypeEstimated MetricValueType = "ESTIMATED"

InvestmentThesis stringOptional

Campaign-specific investment framing.

KeyRisks []OfferingKeyRiskOptional

Ordered key risks.

Body string

Plain-text risk body.

Title string

Risk heading.

CitationIDs []stringOptional

Profile-local citation ids supporting the risk.

Participants []OfferingParticipantResourceOptional

Campaign participants in display order.

ID string

Stable identifier.

formatuuid

DisplayOrder int64

Stable display position.

formatint32

Name string

Display name.

Role ParticipantRole

Presentation role.

One of the following:

const ParticipantRoleLeadInvestor ParticipantRole = "LEAD_INVESTOR"

const ParticipantRoleCoLead ParticipantRole = "CO_LEAD"

const ParticipantRoleFundManager ParticipantRole = "FUND_MANAGER"

const ParticipantRolePlacementAgent ParticipantRole = "PLACEMENT_AGENT"

StructureDescription stringOptional

Vehicle/structure framing shown before typed SPV terms exist.

WhyNow stringOptional

Why-now framing.

type OfferingDocumentResource struct{…}

A campaign document’s display metadata. Exactly one of url/object_key is set; an object key is resolved and signed elsewhere.

ID string

Stable identifier.

formatuuid

DisplayOrder int64

Stable display position.

formatint32

DocumentType OfferingDocumentType

Document kind.

One of the following:

const OfferingDocumentTypeTearsheet OfferingDocumentType = "TEARSHEET"

const OfferingDocumentTypeKeyTerms OfferingDocumentType = "KEY_TERMS"

const OfferingDocumentTypeRiskFactors OfferingDocumentType = "RISK_FACTORS"

const OfferingDocumentTypePpm OfferingDocumentType = "PPM"

const OfferingDocumentTypeOther OfferingDocumentType = "OTHER"

Title string

Display title.

ObjectKey stringOptional

Object-store key, when the document is stored internally.

PublishedAt TimeOptional

Publication time, when known.

formatdate-time

Source stringOptional

Source publisher/provider.

SourceURL stringOptional

Source URL.

URL stringOptional

Externally reachable URL, when the document lives at one.

type OfferingDocumentType string

Kind of campaign document.

One of the following:

const OfferingDocumentTypeTearsheet OfferingDocumentType = "TEARSHEET"

const OfferingDocumentTypeKeyTerms OfferingDocumentType = "KEY_TERMS"

const OfferingDocumentTypeRiskFactors OfferingDocumentType = "RISK_FACTORS"

const OfferingDocumentTypePpm OfferingDocumentType = "PPM"

const OfferingDocumentTypeOther OfferingDocumentType = "OTHER"

type OfferingHighlight struct{…}

A curated highlight, resolved against the company profile’s metric series.

Label string

Display label (the highlight’s override, else the series’ own label).

MetricKey string

Canonical metric key selected by the highlight (e.g. REVENUE_GROWTH).

Unit MetricUnit

Value unit.

One of the following:

const MetricUnitUsd MetricUnit = "USD"

const MetricUnitPercent MetricUnit = "PERCENT"

const MetricUnitCount MetricUnit = "COUNT"

const MetricUnitRank MetricUnit = "RANK"

ObservedAt TimeOptional

Observation time of the latest value.

formatdate-time

Value stringOptional

Latest observed value, when the series carries any points.

ValueType MetricValueTypeOptional

Whether the latest value is historical or estimated.

One of the following:

const MetricValueTypeHistorical MetricValueType = "HISTORICAL"

const MetricValueTypeEstimated MetricValueType = "ESTIMATED"

type OfferingKeyRisk struct{…}

One ordered key-risk block.

Body string

Plain-text risk body.

Title string

Risk heading.

CitationIDs []stringOptional

Profile-local citation ids supporting the risk.

type OfferingParticipantResource struct{…}

An offering participant’s display data.

ID string

Stable identifier.

formatuuid

DisplayOrder int64

Stable display position.

formatint32

Name string

Display name.

Role ParticipantRole

Presentation role.

One of the following:

const ParticipantRoleLeadInvestor ParticipantRole = "LEAD_INVESTOR"

const ParticipantRoleCoLead ParticipantRole = "CO_LEAD"

const ParticipantRoleFundManager ParticipantRole = "FUND_MANAGER"

const ParticipantRolePlacementAgent ParticipantRole = "PLACEMENT_AGENT"

type OfferingSpv struct{…}

The attached SPV’s identity and lifecycle. Exact economics surface once the SPV opens; an upcoming offering’s indicative ranges describe the terms until then.

ID string

Stable SPV identifier.

formatuuid

Name string

Legal/display name.

Status SpvStatus

Lifecycle state.

One of the following:

const SpvStatusDraft SpvStatus = "DRAFT"

const SpvStatusOpen SpvStatus = "OPEN"

const SpvStatusClosed SpvStatus = "CLOSED"

const SpvStatusLiquidating SpvStatus = "LIQUIDATING"

const SpvStatusDissolved SpvStatus = "DISSOLVED"

CustodianName stringOptional

Custodian.

ManagerName stringOptional

SPV manager.

NdaAgreement NdaAgreementResourceOptional

Current NDA agreement. Absent when this SPV does not require one.

AcceptanceText string

Exact assent and authority representation shown to the signer.

AcceptanceTextVersion int64

Version of the acceptance representation.

formatint32

AgreementID string

Stable agreement identifier submitted with an IOI acceptance.

formatuuid

DocumentReference string

Durable reference to the immutable NDA artifact.

DocumentSha256 string

Lowercase SHA-256 digest of the artifact bytes.

EffectiveAt Time

Time this version became effective.

formatdate-time

Version int64

Strictly increasing SPV-local agreement version.

formatint32

ShareClass stringOptional

Underlying share class, when specified.

StructureDescription stringOptional

Plain-text vehicle structure.

type ParticipantRole string

Presentation role of an offering participant.

One of the following:

const ParticipantRoleLeadInvestor ParticipantRole = "LEAD_INVESTOR"

const ParticipantRoleCoLead ParticipantRole = "CO_LEAD"

const ParticipantRoleFundManager ParticipantRole = "FUND_MANAGER"

const ParticipantRolePlacementAgent ParticipantRole = "PLACEMENT_AGENT"

type SpvStatus string

SPV lifecycle state.

One of the following:

const SpvStatusDraft SpvStatus = "DRAFT"

const SpvStatusOpen SpvStatus = "OPEN"

const SpvStatusClosed SpvStatus = "CLOSED"

const SpvStatusLiquidating SpvStatus = "LIQUIDATING"

const SpvStatusDissolved SpvStatus = "DISSOLVED"

type ValuationBasis string

Meaning of an indicative valuation range or an SPV valuation.

One of the following:

const ValuationBasisPreMoney ValuationBasis = "PRE_MONEY"

const ValuationBasisPostMoney ValuationBasis = "POST_MONEY"

const ValuationBasisReference ValuationBasis = "REFERENCE"

const ValuationBasisImplied ValuationBasis = "IMPLIED"

V1Private MarketsSpvs

ModelsExpand Collapse

type ChargedBy string

Party charging a fee.

One of the following:

const ChargedByFundManager ChargedBy = "FUND_MANAGER"

const ChargedByClearStreet ChargedBy = "CLEAR_STREET"

const ChargedByThirdParty ChargedBy = "THIRD_PARTY"

type FeeFrequency string

Fee timing/cadence.

One of the following:

const FeeFrequencyOneTime FeeFrequency = "ONE_TIME"

const FeeFrequencyAnnual FeeFrequency = "ANNUAL"

const FeeFrequencyAtExit FeeFrequency = "AT_EXIT"

const FeeFrequencyPassThrough FeeFrequency = "PASS_THROUGH"

type FeeType string

Kind of SPV fee.

One of the following:

const FeeTypeManagement FeeType = "MANAGEMENT"

const FeeTypeCarry FeeType = "CARRY"

const FeeTypePlacement FeeType = "PLACEMENT"

const FeeTypeAdministrative FeeType = "ADMINISTRATIVE"

const FeeTypeOther FeeType = "OTHER"

type SpvDetail struct{…}

An OPEN SPV’s identity, exact economics, and typed fee schedule.

ID string

Stable SPV identifier.

formatuuid

CompanyID string

Company whose shares the vehicle holds.

formatuuid

Currency Currency

Terms currency.

Name string

Legal/display name.

Status SpvStatus

Lifecycle state.

One of the following:

const SpvStatusDraft SpvStatus = "DRAFT"

const SpvStatusOpen SpvStatus = "OPEN"

const SpvStatusClosed SpvStatus = "CLOSED"

const SpvStatusLiquidating SpvStatus = "LIQUIDATING"

const SpvStatusDissolved SpvStatus = "DISSOLVED"

AllInPricePerShare stringOptional

Price per share including fees.

CustodianName stringOptional

Custodian.

FeePerShare stringOptional

Per-share fee.

FeeTerms []SpvFeeTermResourceOptional

Typed fee schedule.

ChargedBy ChargedBy

Charging party.

One of the following:

const ChargedByFundManager ChargedBy = "FUND_MANAGER"

const ChargedByClearStreet ChargedBy = "CLEAR_STREET"

const ChargedByThirdParty ChargedBy = "THIRD_PARTY"

Currency Currency

Terms currency.

Description string

Plain-text fee disclosure.

FeeType FeeType

Fee kind.

One of the following:

const FeeTypeManagement FeeType = "MANAGEMENT"

const FeeTypeCarry FeeType = "CARRY"

const FeeTypePlacement FeeType = "PLACEMENT"

const FeeTypeAdministrative FeeType = "ADMINISTRATIVE"

const FeeTypeOther FeeType = "OTHER"

Frequency FeeFrequency

Timing/cadence.

One of the following:

const FeeFrequencyOneTime FeeFrequency = "ONE_TIME"

const FeeFrequencyAnnual FeeFrequency = "ANNUAL"

const FeeFrequencyAtExit FeeFrequency = "AT_EXIT"

const FeeFrequencyPassThrough FeeFrequency = "PASS_THROUGH"

Amount stringOptional

Exact fixed amount, when amount-based.

DurationYears stringOptional

Charge duration in years, when specified.

HurdleRate stringOptional

Carry hurdle as a decimal fraction, when specified.

Rate stringOptional

Decimal fraction between zero and one, when percentage-based.

FundedPercent stringOptional

Percentage of dollar allocation funded, derived from the allocation pair.

FundingDeadline TimeOptional

Funding deadline.

formatdate-time

ManagerName stringOptional

SPV manager.

MinimumInvestmentAmount stringOptional

Minimum investment amount.

OpenedAt TimeOptional

Time the vehicle opened.

formatdate-time

PricePerShare stringOptional

Price per share excluding fees.

RemainingAllocationAmount stringOptional

Remaining dollar allocation.

RemainingShareAllocation stringOptional

Remaining share allocation.

ShareClass stringOptional

Underlying share class, when specified.

StructureDescription stringOptional

Plain-text vehicle structure.

TotalAllocationAmount stringOptional

Total dollar allocation.

TotalShareAllocation stringOptional

Total share allocation.

Valuation stringOptional

Exact company valuation.

ValuationBasis ValuationBasisOptional

Meaning of valuation.

One of the following:

const ValuationBasisPreMoney ValuationBasis = "PRE_MONEY"

const ValuationBasisPostMoney ValuationBasis = "POST_MONEY"

const ValuationBasisReference ValuationBasis = "REFERENCE"

const ValuationBasisImplied ValuationBasis = "IMPLIED"

type SpvFeeTermResource struct{…}

One typed SPV fee term.

ChargedBy ChargedBy

Charging party.

One of the following:

const ChargedByFundManager ChargedBy = "FUND_MANAGER"

const ChargedByClearStreet ChargedBy = "CLEAR_STREET"

const ChargedByThirdParty ChargedBy = "THIRD_PARTY"

Currency Currency

Terms currency.

Description string

Plain-text fee disclosure.

FeeType FeeType

Fee kind.

One of the following:

const FeeTypeManagement FeeType = "MANAGEMENT"

const FeeTypeCarry FeeType = "CARRY"

const FeeTypePlacement FeeType = "PLACEMENT"

const FeeTypeAdministrative FeeType = "ADMINISTRATIVE"

const FeeTypeOther FeeType = "OTHER"

Frequency FeeFrequency

Timing/cadence.

One of the following:

const FeeFrequencyOneTime FeeFrequency = "ONE_TIME"

const FeeFrequencyAnnual FeeFrequency = "ANNUAL"

const FeeFrequencyAtExit FeeFrequency = "AT_EXIT"

const FeeFrequencyPassThrough FeeFrequency = "PASS_THROUGH"

Amount stringOptional

Exact fixed amount, when amount-based.

DurationYears stringOptional

Charge duration in years, when specified.

HurdleRate stringOptional

Carry hurdle as a decimal fraction, when specified.

Rate stringOptional

Decimal fraction between zero and one, when percentage-based.

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

Deprecated

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

PUT/v1/saved-screeners/{screener_id}

Patch Screener

client.V1.Screener.PatchScreener(ctx, screenerID, body) (*V1ScreenerPatchScreenerResponse, error)

PATCH/v1/saved-screeners/{screener_id}

Delete Screener

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

DELETE/v1/saved-screeners/{screener_id}

Get Screener Catalog

client.V1.Screener.GetScreenerCatalog(ctx) (*V1ScreenerGetScreenerCatalogResponse, error)

GET/v1/screener/catalog

ModelsExpand Collapse

type Catalog struct{…}

The complete screener field catalog, serialized as the data payload of GET /screener/catalog.

DefaultResponseFields []string

The api_names that resolve to the POST default column set when columns is omitted.

Enums Enums

The enum universes every other section’s values are drawn from.

BuiltinVariable []string

The built-in variable names, e.g. "today", "start_of_year".

Category []string

FieldCategory variants, e.g. "PROFILE", "VALUATION".

DateUnit []string

The modifier date units, e.g. "DAY", "YEAR".

Format []string

FieldFormat variants, e.g. "CURRENCY", "PERCENT".

Lookback []string

FieldLookback variants, e.g. "ONE_WEEK", "YEAR_TO_DATE".

ModifierOp []string

The modifier operation names, "ADD" and "SUBTRACT".

Operator []string

FilterOperator variants, e.g. "BETWEEN", "ONE_OF".

OperatorArg []string

The modifier arg forms, e.g. "LEFT_INCLUSIVE".

Period []string

FieldPeriod variants, e.g. "QUARTER", "ANNUAL".

ValueType []string

FieldValueType variants, e.g. "DECIMAL", "DATE".

Fields FieldColumns

Struct-of-arrays of the remaining per-field scalars.

Description []string

A human-readable description of the field.

DisplayName []string

The display name of the column when no period / lookback is set.

Kind []int64

Index into Catalog::kinds.

Name []string

The base field name, as accepted in a request’s left.name / right[].variable field reference.

Kinds []FieldKind

The deduplicated (category, format, value_type, combinations, default combination) tuples; fields.kind[i] indexes into this.

Category string

The field’s category, a member of enums.category.

Combinations []Combination

Ordered, in declaration order. The empty combination is the current or most recent value.

Lookback stringOptional

The lookback, a member of enums.lookback.

Period stringOptional

The period, a member of enums.period.

DefaultCombination Combination

The combination a bare field reference resolves to: the field’s current or most recent value when the kind offers it, otherwise the kind’s default period / lookback.

Lookback stringOptional

The lookback, a member of enums.lookback.

Period stringOptional

The period, a member of enums.period.

Format string

The field’s format, a member of enums.format.

ValueType string

The field’s value type, a member of enums.value_type.

Modifiers []ModifierDef

The modifier operations and their legal args forms.

Args []ModifierArg

The positional args slots, in order.

Kind string

"NUMBER" or "ENUM".

Note string

The arg’s meaning and constraints.

Position int64

Zero-based position in the args array.

formatint32

minimum0

Required bool

Whether the arg must be present in every modifier use.

Default stringOptional

For optional args: the value used when the arg is omitted.

Ref stringOptional

For "ENUM" args: the enums list the value must be a member of.

Name string

The modifier operation name: one of "ADD" or "SUBTRACT".

OperatorsByValueType map[string, []string]

value_type -> canonically-ordered valid operators.

Rules Rules

Request-side semantics for turning the data into a valid call.

APINameComposition string

Requests and response field objects use the same reference shape: base name plus at most one of period / lookback; default_response_fields (the POST default column set when columns is omitted) carries api_names, each decoding via suffixes.

Axes string

At most one of period / lookback; the empty combination selects the field’s current or most recent value.

Defaults string

Omitting both is always valid; it resolves to the field’s current or most recent value when the kind offers it, otherwise to default_combination.

Modifiers string

Where modifier is legal, its args forms, and unit semantics.

Operators string

Filter operator value counts for the right array.

Variables string

Built-in variables and field references in right[].variable.

Suffixes map[string, string]

Axis token -> abbreviation, for every token in use in kinds.

Variables []VariableDef

The built-in variables accepted in filters[].right[].variable.

Description string

A human-readable description of what the variable resolves to.

Name string

The variable name as accepted in filters[].right[].variable.

ResolvesTo string

What the variable resolves to at call time (DATE for all built-ins).

type Combination struct{…}

A single combination, expressed with the API’s own parameter names.

At most one of period / lookback is set; a combination with neither selects the field’s current or most recent value.

Lookback stringOptional

The lookback, a member of enums.lookback.

Period stringOptional

The period, a member of enums.period.

type Enums struct{…}

The enum universes every other section’s values are drawn from.

BuiltinVariable []string

The built-in variable names, e.g. "today", "start_of_year".

Category []string

FieldCategory variants, e.g. "PROFILE", "VALUATION".

DateUnit []string

The modifier date units, e.g. "DAY", "YEAR".

Format []string

FieldFormat variants, e.g. "CURRENCY", "PERCENT".

Lookback []string

FieldLookback variants, e.g. "ONE_WEEK", "YEAR_TO_DATE".

ModifierOp []string

The modifier operation names, "ADD" and "SUBTRACT".

Operator []string

FilterOperator variants, e.g. "BETWEEN", "ONE_OF".

OperatorArg []string

The modifier arg forms, e.g. "LEFT_INCLUSIVE".

Period []string

FieldPeriod variants, e.g. "QUARTER", "ANNUAL".

ValueType []string

FieldValueType variants, e.g. "DECIMAL", "DATE".

type FieldColumns struct{…}

Struct-of-arrays: all four fields are the same length, index i is one field.

Description []string

A human-readable description of the field.

DisplayName []string

The display name of the column when no period / lookback is set.

Kind []int64

Index into Catalog::kinds.

Name []string

The base field name, as accepted in a request’s left.name / right[].variable field reference.

type FieldKind struct{…}

One deduplicated (category, format, value_type, combinations, default combination) tuple; fields.kind[i] indexes into Catalog::kinds.

Category string

The field’s category, a member of enums.category.

Combinations []Combination

Ordered, in declaration order. The empty combination is the current or most recent value.

Lookback stringOptional

The lookback, a member of enums.lookback.

Period stringOptional

The period, a member of enums.period.

DefaultCombination Combination

The combination a bare field reference resolves to: the field’s current or most recent value when the kind offers it, otherwise the kind’s default period / lookback.

Lookback stringOptional

The lookback, a member of enums.lookback.

Period stringOptional

The period, a member of enums.period.

Format string

The field’s format, a member of enums.format.

ValueType string

The field’s value type, a member of enums.value_type.

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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

One positional modifier.args slot.

Kind string

"NUMBER" or "ENUM".

Note string

The arg’s meaning and constraints.

Position int64

Zero-based position in the args array.

formatint32

minimum0

Required bool

Whether the arg must be present in every modifier use.

Default stringOptional

For optional args: the value used when the arg is omitted.

Ref stringOptional

For "ENUM" args: the enums list the value must be a member of.

type ModifierDef struct{…}

A modifier operation and the positional args each context accepts.

Args []ModifierArg

The positional args slots, in order.

Kind string

"NUMBER" or "ENUM".

Note string

The arg’s meaning and constraints.

Position int64

Zero-based position in the args array.

formatint32

minimum0

Required bool

Whether the arg must be present in every modifier use.

Default stringOptional

For optional args: the value used when the arg is omitted.

Ref stringOptional

For "ENUM" args: the enums list the value must be a member of.

Name string

The modifier operation name: one of "ADD" or "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 Rules struct{…}

Request-side semantics: how to turn the catalog data into a valid POST /screener call.

APINameComposition string

Axes string

At most one of period / lookback; the empty combination selects the field’s current or most recent value.

Defaults string

Omitting both is always valid; it resolves to the field’s current or most recent value when the kind offers it, otherwise to default_combination.

Modifiers string

Where modifier is legal, its args forms, and unit semantics.

Operators string

Filter operator value counts for the right array.

Variables string

Built-in variables and field references in right[].variable.

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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

The field to filter on.

The field name.

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"

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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"

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

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"

Optional arguments that modify operator behavior.

One of the following:

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

Name string

Shared bool

Whether any user may fetch this screener by id.

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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

The field to filter on.

The field name.

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"

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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"

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

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"

Optional arguments that modify operator behavior.

One of the following:

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

Name string

Shared bool

Whether any user may fetch this screener by id.

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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.

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.

The field to filter on.

The field name.

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"

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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"

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

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"

Optional arguments that modify operator behavior.

One of the following:

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

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"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

type VariableDef struct{…}

A built-in variable, as accepted in filters[].right[].variable.

Description string

A human-readable description of what the variable resolves to.

Name string

The variable name as accepted in filters[].right[].variable.

ResolvesTo string

What the variable resolves to at call time (DATE for all built-ins).

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

The unique identifier for the watchlist.

formatuuid

CreatedAt Time

The timestamp when the watchlist was created.

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

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.

CaxAdjustedPreviousClose stringOptional

Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.

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 SecurityTypeIndex SecurityType = "INDEX"

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

OptionsContractExpiryDates []OptionExpiryDateOptional

Date Time

The expiration date.

formatdate

HasSettlesOnClose bool

Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.

HasSettlesOnOpen bool

DeprecatedOptionsExpiryDates []TimeOptional

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

Deprecated: use options_contract_expiry_dates, which carries the same dates annotated with settlement-cycle information. When a null/undefined value is observed, it indicates it does not apply.

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.

TickRules []TickRuleOptional

Price bands this instrument quotes on, ascending. Absent when we have no schedule for it, which includes an option whose penny-program status our reference data never supplied.

StartPrice string

Lowest price in the band, inclusive.

TickSize string

Minimum price increment within the band.

EndPrice stringOptional

Upper bound of the band, exclusive. Absent on the last band, which runs to infinity. When a null/undefined value is observed, it indicates it does not apply.

Name string

The user-provided 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

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.

CaxAdjustedPreviousClose stringOptional

Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.

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 SecurityTypeIndex SecurityType = "INDEX"

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

OptionsContractExpiryDates []OptionExpiryDateOptional

Date Time

The expiration date.

formatdate

HasSettlesOnClose bool

Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.

HasSettlesOnOpen bool

DeprecatedOptionsExpiryDates []TimeOptional

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

Deprecated: use options_contract_expiry_dates, which carries the same dates annotated with settlement-cycle information. When a null/undefined value is observed, it indicates it does not apply.

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.

TickRules []TickRuleOptional

Price bands this instrument quotes on, ascending. Absent when we have no schedule for it, which includes an option whose penny-program status our reference data never supplied.

StartPrice string

Lowest price in the band, inclusive.

TickSize string

Minimum price increment within the band.

EndPrice stringOptional

Upper bound of the band, exclusive. Absent on the last band, which runs to infinity. When a null/undefined value is observed, it indicates it does not apply.