generated: '2026-10-21'
method: derived
generator: derive-vocabulary.py
source: openapi/snaptrade-openapi.yml
vocabulary:
  name: SnapTrade Domain Vocabulary
  description: 'Terms declared by SnapTrade''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-21'
  terms:
  - term: API Status
    definition: Check whether the API is operational and verify timestamps.
    tags:
    - Resource Group
    source: openapi/snaptrade-openapi.yml
  - term: Authentication
    definition: Register and authenticate users with SnapTrade.
    tags:
    - Resource Group
    source: openapi/snaptrade-openapi.yml
  - term: Connections
    definition: Retrieve and manage user connections.
    tags:
    - Resource Group
    source: openapi/snaptrade-openapi.yml
  - term: Account Information
    definition: Retrieve account information, such as positions, balances, etc.
    tags:
    - Resource Group
    source: openapi/snaptrade-openapi.yml
  - term: Trading
    definition: Manage orders on user accounts.
    tags:
    - Resource Group
    source: openapi/snaptrade-openapi.yml
  - term: Reference Data
    definition: Retrieve basic information for API use, such as supported brokerages, exchanges, currencies, etc.
    tags:
    - Resource Group
    source: openapi/snaptrade-openapi.yml
  - term: Management
    definition: Retrieve usage information about your SnapTrade Client ID.
    tags:
    - Resource Group
    source: openapi/snaptrade-openapi.yml
  - term: 400FailedRequestResponse
    definition: Example for failed request response
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/400FailedRequestResponse
  - term: 401FailedRequestResponse
    definition: Example for failed request response
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/401FailedRequestResponse
  - term: 402BrokerageAuthDisabledResponse
    definition: Cannot perform action because connection is disabled
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/402BrokerageAuthDisabledResponse
  - term: 402BrokerageAuthAlreadyDisabledException
    definition: This connection is already disabled.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/402BrokerageAuthAlreadyDisabledException
  - term: 403FailedRequestResponse
    definition: Example for failed request response
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/403FailedRequestResponse
  - term: 403FeatureNotEnabledResponse
    definition: Example for failed request response
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/403FeatureNotEnabledResponse
  - term: 404FailedRequestResponse
    definition: Example for failed request response
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/404FailedRequestResponse
  - term: 425FailedRequestResponse
    definition: Example for failed request response
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/425FailedRequestResponse
  - term: 429TooManyRequestsResponse
    definition: Example for a rate-limited request response
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/429TooManyRequestsResponse
  - term: 500UnexpectedExceptionResponse
    definition: Example for a response that failed for unexpected reasons
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/500UnexpectedExceptionResponse
  - term: 501NotImplementedResponse
    definition: Example for a response where the endpoint is not implemented for the brokerage
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/501NotImplementedResponse
  - term: 503BrokerageRequestResponse
    definition: Example for a response that failed because of an upstream brokerage API failure
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/503BrokerageRequestResponse
  - term: 503CurrencyConversionUnavailableResponse
    definition: Example for a response that failed because exchange rates for the requested currency are unavailable
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/503CurrencyConversionUnavailableResponse
  - term: AccountSyncStatus
    definition: Contains status update for the account sync process between SnapTrade and the brokerage.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountSyncStatus
  - term: TransactionsStatus
    definition: 'Status of account transaction sync. SnapTrade syncs transactions from the brokerage under the following conditions: 1. Initial
      connection - SnapTrade syncs all transactions from the brokerage account as far back as the brokerage allows. Check [our integrations doc](https://support.snaptrade.com/brokerages-table?v=6fab8012ade6441fa0c6d9af9c55ce3a)
      for details on how far back we sync for each broker'
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/TransactionsStatus
  - term: HoldingsStatus
    definition: 'Status of account holdings sync. SnapTrade syncs holdings from the brokerage under the following conditions: 1. Initial connection
      - SnapTrade syncs all holdings (positions, balances, recent orders, and transactions) immediately after the connection is established. 2.
      Daily sync - Once a day SnapTrade refreshes all holdings from the brokerage. 3. Manual sync - You can trigger a refresh of holdings'
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/HoldingsStatus
  - term: AccountBalance
    definition: Contains balance related information for the account.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountBalance
  - term: Account
    definition: A single account at a brokerage.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/Account
  - term: ConnectionAccountsResponse
    definition: Accounts under the specified connection.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/ConnectionAccountsResponse
  - term: AllUserAccountsResponse
    definition: Accounts across all of the user's connections.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AllUserAccountsResponse
  - term: ConnectionAccount
    definition: A single account under a connection, from the `kind`-discriminated union used by `Connections_listConnectionAccounts` and `AccountInformation_listAllUserAccounts`.
      Use `kind` to determine which schema is present. `investment`, `deposit`, and `line_of_credit` are implemented today.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/ConnectionAccount
  - term: InvestmentAccount
    definition: An investment account under a connection. `opening_date`, `funding_date`, and `net_value` are real-time or cached depending on
      the caller's plan -- see `Connections_listConnectionAccounts` -- and always cached on `AccountInformation_listAllUserAccounts`.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/InvestmentAccount
  - term: DepositAccount
    definition: A deposit account (checking, savings) under a connection.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/DepositAccount
  - term: LineOfCreditAccount
    definition: A line-of-credit account (e.g. a credit card) under a connection.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/LineOfCreditAccount
  - term: ConnectionAccountSyncStatus
    definition: Contains status updates for the account sync process between SnapTrade and the institution, used by `InvestmentAccount` in `Connections_listConnectionAccounts`.
      Each property is optional -- an institution may not report sync status for every data type. `orders`/`positions`/`balances` are the timestamp
      of the last successful sync of that data type (null if never synced). See `DepositAccountSyncStat
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/ConnectionAccountSyncStatus
  - term: DepositAccountSyncStatus
    definition: Contains status updates for the account sync process between SnapTrade and the institution, used by `DepositAccount` in `Connections_listConnectionAccounts`.
      Each property is optional -- an institution may not report sync status for every data type. Deposit accounts don't place orders or hold
      positions, so unlike `ConnectionAccountSyncStatus` this type has no `orders` or `positions` field. `balanc
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/DepositAccountSyncStatus
  - term: LineOfCreditAccountSyncStatus
    definition: 'Contains status updates for the account sync process between SnapTrade and the institution, used by `LineOfCreditAccount` in
      `Connections_listConnectionAccounts`. Each property is optional -- an institution may not report sync status for every data type. Line-of-credit
      accounts don''t place orders or hold positions, so like `DepositAccountSyncStatus` this type has no `orders` or `positions` field. '
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/LineOfCreditAccountSyncStatus
  - term: AccountSimple
    definition: A single account at a brokerage.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountSimple
  - term: AccountID
    definition: Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountID
  - term: AccountIDs
    definition: Comma separated list of account IDs
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountIDs
  - term: TradeDetectionSubscription
    definition: An active Trade Detection subscription for a brokerage account.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/TradeDetectionSubscription
  - term: TradeDetectionCancelSubscriptionResponse
    definition: 'Object declared by the contract with fields: success.'
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/TradeDetectionCancelSubscriptionResponse
  - term: BrokerageID
    definition: Unique identifier for the brokerage.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/BrokerageID
  - term: BrokerageAuthID
    definition: Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/BrokerageAuthID
  - term: BrokerageAuthIDs
    definition: Comma separated list of brokerage authorization IDs
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/BrokerageAuthIDs
  - term: AccountHoldings
    definition: Account Holdings
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountHoldings
  - term: AccountHoldingsAccount
    definition: A wrapper object containing holdings information for a single account.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountHoldingsAccount
  - term: RecentOrdersResponse
    definition: List of orders executed within the last 24 hours
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/RecentOrdersResponse
  - term: RateOfReturnResponse
    definition: List of return rates with their timeframe
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/RateOfReturnResponse
  - term: RateOfReturnObject
    definition: Individual rate of return object with return percent and timeframe
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/RateOfReturnObject
  - term: AccountOrderRecord
    definition: Describes a single recent order in an account. Each record here represents a single order leg. For multi-leg orders, there will
      be multiple records.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountOrderRecord
  - term: AccountValueHistoryResponse
    definition: The response to the account value history endpoint, containing a list of estimated account values at different points in time.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountValueHistoryResponse
  - term: AccountValueHistoryItem
    definition: The estimated account value at a specific point in time.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountValueHistoryItem
  - term: AccountOrdersV2Response
    definition: Contains a standardized list of account orders in the V2 format.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountOrdersV2Response
  - term: AccountOrderRecordV2
    definition: Describes a single order in the standardized V2 format.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountOrderRecordV2
  - term: AccountOrderRecordV2OrderRole
    definition: The role of an order within a complex order group (OCO, OTO, OTOCO).
    tags:
    - Enumeration
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountOrderRecordV2OrderRole
  - term: TrailingStop
    definition: Trail configuration for trailing stop orders.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/TrailingStop
  - term: AccountOrderRecordLeg
    definition: Describes an individual leg that makes up an order in the V2 format.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountOrderRecordLeg
  - term: AccountOrderRecordLegInstrument
    definition: Instrument metadata for an order leg.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountOrderRecordLegInstrument
  - term: AccountOrderRecordStatus
    definition: 'Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. Possible values
      include: - NONE - PENDING - ACCEPTED - FAILED - REJECTED - CANCELED - PARTIAL_CANCELED - CANCEL_PENDING - EXECUTED - PARTIAL - REPLACE_PENDING
      - REPLACED - EXPIRED - QUEUED - TRIGGERED - ACTIVATED'
    tags:
    - Enumeration
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountOrderRecordStatus
  - term: AccountOrderRecordStatusV2
    definition: Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum.
    tags:
    - Enumeration
    source: openapi/snaptrade-openapi.yml#/components/schemas/AccountOrderRecordStatusV2
  - term: OptionQuote
    definition: Real-time quote for a single option contract.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/OptionQuote
  - term: OptionsPosition
    definition: Describes a single option position in an account.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/OptionsPosition
  - term: OptionStrategy
    definition: 'Object declared by the contract with fields: id, underlying_symbol_id, strategy_type, number_of_legs, legs.'
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/OptionStrategy
  - term: StrategyQuotes
    definition: 'Object declared by the contract with fields: strategy, open_price, bid_price, ask_price, volatility, greek.'
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/StrategyQuotes
  - term: StrategyOrderRecord
    definition: Strategy order record
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/StrategyOrderRecord
  - term: SnapTradeHoldingsAccount
    definition: SnapTradeUser Investment Account
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/SnapTradeHoldingsAccount
  - term: SnapTradeHoldingsTotalValue
    definition: This field is deprecated. To get the brokerage reported total market value of the account, please refer to `account.balance.total`.
      The total market value of the account. Note that this field is calculated based on the sum of the values of account positions and cash balances
      known to SnapTrade. It may not be accurate if the brokerage account has holdings that SnapTrade is not aware of. For example
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/SnapTradeHoldingsTotalValue
  - term: Balance
    definition: Holds balance information for a single currency in an account.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/Balance
  - term: CurrencyID
    definition: Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/CurrencyID
  - term: Currency
    definition: Describes a currency object.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/Currency
  - term: Exchange
    definition: Describes a single stock or crypto exchange.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/Exchange
  - term: USExchange
    definition: US Stock Exchange
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/USExchange
  - term: LoginRedirectURI
    definition: Redirect uri upon successful login
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/LoginRedirectURI
  - term: ClientID
    definition: SnapTrade Client ID (generated and provided to partner by SnapTrade)
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/ClientID
  - term: UserID
    definition: SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for
      the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/UserID
  - term: UserSecret
    definition: SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via
      the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/UserSecret
  - term: PerformanceCustom
    definition: Performance Custom Response Object
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/PerformanceCustom
  - term: SubPeriodReturnRate
    definition: 'Object declared by the contract with fields: periodStart, periodEnd, rateOfReturn.'
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/SubPeriodReturnRate
  - term: DividendAtDate
    definition: 'Object declared by the contract with fields: symbol, amount, currency.'
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/DividendAtDate
  - term: PartnerStats
    definition: User, connection, and connected asset totals for your SnapTrade Client ID.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/PartnerStats
  - term: ConnectedAssetPartnerStats
    definition: User, connection, and connected asset totals for your SnapTrade Client ID.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/ConnectedAssetPartnerStats
  - term: PartnerData
    definition: Configurations for your SnapTrade Client ID, including allowed brokerages and data access.
    tags:
    - Object
    source: openapi/snaptrade-openapi.yml#/components/schemas/PartnerData