Response fields
objectA wrapper object containing holdings information for a single account.
accountobjectA single account at a brokerage.
idstring (format: uuid)Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated.
brokerage_authorizationstring (format: uuid)Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
namestring or nullA display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity.
numberstringThe account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
institution_namestringThe name of the brokerage that holds the account.
created_datestring (format: date-time)Timestamp in ISO 8601 format indicating when the account was created in SnapTrade. This is not the account opening date at the brokerage.
sync_statusobjectContains status update for the account sync process between SnapTrade and the brokerage.
transactionsobjectStatus of account transaction sync. SnapTrade syncs transactions from the brokerage under the following conditions:
- Initial connection - SnapTrade syncs all transactions from the brokerage account as far back as the brokerage allows. Check our integrations doc for details on how far back we sync for each brokerage.
- Daily sync - Once a day SnapTrade syncs new transactions from the brokerage.
- Manual sync - You can retrigger an incremental sync of transactions with the manual refresh endpoint.
initial_sync_completedbooleanIndicates if the initial sync of transactions has been completed. For accounts with a large number of transactions, the initial sync may take a while to complete.
last_successful_syncstring (format: date) or nullAll transactions up to this date have been successfully synced. Please note that this is not the date of the last transaction, nor the last time SnapTrade attempted to sync transactions.
first_transaction_datestring (format: date) or nullThe date of the first transaction in the account known to SnapTrade. It's possible that the account has transactions before this date, but they are not known to SnapTrade.
holdingsobjectStatus of account holdings sync. SnapTrade syncs holdings from the brokerage under the following conditions:
- Initial connection - SnapTrade syncs all holdings (positions, balances, recent orders, and transactions) immediately after the connection is established.
- Daily sync - Once a day SnapTrade refreshes all holdings from the brokerage.
- Manual sync - You can trigger a refresh of holdings with the manual refresh endpoint.
initial_sync_completedbooleanIndicates if the initial sync of holdings has been completed. For accounts with a large number of positions/orders/transactions, the initial sync may take a while to complete.
last_successful_syncstring (format: date-time) or nullThe last time holdings were successfully synced by SnapTrade.
balanceobjectContains balance related information for the account.
totalobject or nullTotal market value of this account (includes cash, equity, fixed income, etc). This value is directly obtained from the brokerage and should reflect the most accurate value of the account.
amountnumberTotal value denominated in the currency of the currency field.
currencystringThe ISO-4217 currency code for the amount.
statusstring or nullThe current status of the account. Can be either "open", "closed", "archived" or null if the status is unknown or not provided by the brokerage.
raw_typestring or nullThe account type as provided by the brokerage
metaobjectAdditional information about the account, such as account type, status, etc. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version.
portfolio_groupstring (format: uuid)Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it.
cash_restrictionsarray of stringsThis field is deprecated.
stringbalancesarray of objects or nullList of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade allows holding multiple currencies in the same account.
currencyobjectThe currency of the balance. This applies to both cash and buying_power.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
cashnumber or nullThe amount of available cash in the account denominated in the currency of the currency field.
buying_powernumber or nullBuying power only applies to margin accounts. For non-margin accounts, buying power should be the same as cash. Please note that this field is not always available for all brokerages.
positionsarray of objects or nullList of stock/ETF/crypto/mutual fund positions in the account.
symbolobjectUniquely describes a security for the position within an account. The distinction between this and the symbol child property is that this object is specific to a position within an account, while the symbol child property is universal across all brokerage accounts. The caller should rely on the symbol child property for most use cases.
symbolobjectUniquely describes a single security + exchange combination across all brokerages.
idstring (format: uuid)Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
symbolstringThe security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the Yahoo Finance ticker format(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
raw_symbolstringThe raw symbol is symbol with the exchange suffix removed. For example, if symbol is "VAB.TO", then raw_symbol is "VAB".
descriptionstring or nullA human-readable description of the security. This is usually the company name or ETF name.
currencyobjectThe currency in which the security is traded.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
exchangeobjectThe exchange on which the security is listed and traded.
idstring (format: uuid)Unique ID for the exchange in SnapTrade.
codestringA short name for the exchange. For standardized exchange code, please us the mic_code field.
mic_codestringThe Market Identifier Code (MIC) for the exchange.
namestringThe full name of the exchange.
timezonestringThe timezone for the trading hours (start_time and close_time) of the exchange.
start_timestringThe time when the exchange opens for trading.
close_timestringThe time when the exchange closes for trading.
suffixstring or nullThe suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is .TO. See UniversalSymbol->symbol and UniversalSymbol->raw_symbol for more detail.
typeobjectThe type of security. For example, "Common Stock" or "ETF".
idstring (format: uuid)Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
codestringA short code representing the security type. For example, "cs" for Common Stock. Here are some common values:
ad- ADRbnd- Bondcs- Common Stockcef- Closed End Fundcrypto- Cryptocurrencyet- ETFoef- Open Ended Fundps- Preferred Stockrt- Rightstruct- Structured Productut- Unitwi- When Issuedwt- Warrant
descriptionstringA human-readable description of the security type. For example, "Common Stock" or "ETF".
is_supportedbooleanThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information. This value should be the same as the figi_code in the figi_instrument child property.
figi_instrumentobject or nullFinancial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information.
figi_share_classstring or nullThis enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, AAPL has a different FIGI for each exchange/trading venue it is traded on. The figi_share_class is the same for all of these FIGIs. See section 1.4.3 of the FIGI Standard for more information.
currenciesarray of objectsThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
idstring (format: uuid)A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
descriptionstringThis field is deprecated and the caller should use the symbol child property's description instead.
local_idstring or nullThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
is_quotablebooleanThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
is_tradablebooleanThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
unitsnumber or nullThe number of shares of the position. This can be fractional or integer units.
pricenumber or nullLast known market price for the symbol. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.
open_pnlnumber or nullThe profit or loss on the position since it was opened. This is calculated as the difference between the current market value of the position and the total cost of the position. It is recommended to calculate this value using the average purchase price and the current market price yourself, instead of relying on this field.
average_purchase_pricenumber or nullCost basis per share of this position.
fractional_unitsnumber or nullDeprecated, use the units field for both fractional and integer units going forward
currencyobjectThe 'position currency' (price and average_purchase_price). This currency can potentially be different from the 'listing currency' of the security. The 'listing currency' is what's quoted on the listing exchange, while the 'position currency' is what the brokerage uses to hold and value your position.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
cash_equivalentboolean or nullIf the position is a cash equivalent (usually a money market fund) that is also counted in account cash balance and buying power
option_positionsarray of objects or nullList of option positions in the account.
symbolobjectUniquely describes a security for the option position within an account. The distinction between this and the option_symbol child property is that this object is specific to a position within an account, while the option_symbol child property is universal across all brokerage accounts. The caller should rely on the option_symbol child property for most use cases.
option_symbolobjectUniquely describes an option security + exchange combination across all brokerages.
idstring (format: uuid)Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
tickerstringThe OCC symbol for the option.
option_typestringThe type of option. Either "CALL" or "PUT".
strike_pricenumberThe option strike price.
expiration_datestring (format: date)The option expiration date.
is_mini_optionbooleanWhether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
underlying_symbolobjectSymbol object for the underlying security of an option.
idstring (format: uuid)Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
symbolstringThe security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the Yahoo Finance ticker format(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
raw_symbolstringThe raw symbol is symbol with the exchange suffix removed. For example, if symbol is "VAB.TO", then raw_symbol is "VAB".
descriptionstring or nullA human-readable description of the security. This is usually the company name or ETF name.
currencyobjectThe currency in which the security is traded.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
exchangeobjectThe exchange on which the security is listed and traded.
idstring (format: uuid)codestringmic_codestringnamestringtimezonestringstart_timestringclose_timestringsuffixstring or nullallows_cryptocurrency_symbolsbooleantypeobjectThe type of security. For example, "Common Stock" or "ETF".
idstring (format: uuid)Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
codestringA short code representing the security type. For example, "cs" for Common Stock. Here are some common values:
ad- ADRbnd- Bondcs- Common Stockcef- Closed End Fundcrypto- Cryptocurrencyet- ETFoef- Open Ended Fundps- Preferred Stockrt- Rightstruct- Structured Productut- Unitwi- When Issuedwt- Warrant
descriptionstringA human-readable description of the security type. For example, "Common Stock" or "ETF".
is_supportedbooleanThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information. This value should be the same as the figi_code in the figi_instrument child property.
figi_instrumentobject or nullFinancial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information.
figi_share_classstring or nullThis enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, AAPL has a different FIGI for each exchange/trading venue it is traded on. The figi_share_class is the same for all of these FIGIs. See section 1.4.3 of the FIGI Standard for more information.
currenciesarray of objectsThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
idstring (format: uuid)A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
descriptionstringThis field is deprecated and the caller should use the option_symbol child property's description instead.
pricenumber or nullLast known market price per share of the option contract. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.
unitsnumberThe number of contracts for this option position. A positive number indicates a long position, while a negative number indicates a short position.
average_purchase_pricenumber or nullCost basis per contract of this option position. To get the cost basis per share, divide this value by the number of shares per contract (usually 100).
currencyobject or nullThe currency of the price. This field is deprecated and will be removed in a future version. The currency of the price is determined by the currency of the underlying security.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
ordersarray of objects or nullList of recent orders in the account, including both pending and executed orders. Note that option orders are included in this list. Option orders will have a null universal_symbol field and a non-null option_symbol field.
brokerage_order_idstringOrder ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
statusstringIndicates 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
universal_symbolobjectContains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the option_symbol field will be populated.
idstring (format: uuid)Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
symbolstringThe security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the Yahoo Finance ticker format(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
raw_symbolstringThe raw symbol is symbol with the exchange suffix removed. For example, if symbol is "VAB.TO", then raw_symbol is "VAB".
descriptionstring or nullA human-readable description of the security. This is usually the company name or ETF name.
currencyobjectThe currency in which the security is traded.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
exchangeobjectThe exchange on which the security is listed and traded.
idstring (format: uuid)Unique ID for the exchange in SnapTrade.
codestringA short name for the exchange. For standardized exchange code, please us the mic_code field.
mic_codestringThe Market Identifier Code (MIC) for the exchange.
namestringThe full name of the exchange.
timezonestringThe timezone for the trading hours (start_time and close_time) of the exchange.
start_timestringThe time when the exchange opens for trading.
close_timestringThe time when the exchange closes for trading.
suffixstring or nullThe suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is .TO. See UniversalSymbol->symbol and UniversalSymbol->raw_symbol for more detail.
typeobjectThe type of security. For example, "Common Stock" or "ETF".
idstring (format: uuid)Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
codestringA short code representing the security type. For example, "cs" for Common Stock. Here are some common values:
ad- ADRbnd- Bondcs- Common Stockcef- Closed End Fundcrypto- Cryptocurrencyet- ETFoef- Open Ended Fundps- Preferred Stockrt- Rightstruct- Structured Productut- Unitwi- When Issuedwt- Warrant
descriptionstringA human-readable description of the security type. For example, "Common Stock" or "ETF".
is_supportedbooleanThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information. This value should be the same as the figi_code in the figi_instrument child property.
figi_instrumentobject or nullFinancial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information.
figi_share_classstring or nullThis enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, AAPL has a different FIGI for each exchange/trading venue it is traded on. The figi_share_class is the same for all of these FIGIs. See section 1.4.3 of the FIGI Standard for more information.
currenciesarray of objectsThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
option_symbolobjectContains information about the option contract that the order is for. This field is only present for option orders. For stock/ETF/crypto/mutual fund orders, this field will be null and the universal_symbol field will be populated.
idstring (format: uuid)Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
tickerstringThe OCC symbol for the option.
option_typestringThe type of option. Either "CALL" or "PUT".
strike_pricenumberThe option strike price.
expiration_datestring (format: date)The option expiration date.
is_mini_optionbooleanWhether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
underlying_symbolobjectSymbol object for the underlying security of an option.
idstring (format: uuid)Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
symbolstringThe security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the Yahoo Finance ticker format(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
raw_symbolstringThe raw symbol is symbol with the exchange suffix removed. For example, if symbol is "VAB.TO", then raw_symbol is "VAB".
descriptionstring or nullA human-readable description of the security. This is usually the company name or ETF name.
currencyobjectThe currency in which the security is traded.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
exchangeobjectThe exchange on which the security is listed and traded.
idstring (format: uuid)codestringmic_codestringnamestringtimezonestringstart_timestringclose_timestringsuffixstring or nullallows_cryptocurrency_symbolsbooleantypeobjectThe type of security. For example, "Common Stock" or "ETF".
idstring (format: uuid)Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
codestringA short code representing the security type. For example, "cs" for Common Stock. Here are some common values:
ad- ADRbnd- Bondcs- Common Stockcef- Closed End Fundcrypto- Cryptocurrencyet- ETFoef- Open Ended Fundps- Preferred Stockrt- Rightstruct- Structured Productut- Unitwi- When Issuedwt- Warrant
descriptionstringA human-readable description of the security type. For example, "Common Stock" or "ETF".
is_supportedbooleanThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information. This value should be the same as the figi_code in the figi_instrument child property.
figi_instrumentobject or nullFinancial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information.
figi_share_classstring or nullThis enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, AAPL has a different FIGI for each exchange/trading venue it is traded on. The figi_share_class is the same for all of these FIGIs. See section 1.4.3 of the FIGI Standard for more information.
currenciesarray of objectsThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
quote_universal_symbolobjectQuote cryptocurrency. This field is only present for cryptocurrency pair orders with a cryptocurrency as quote.
idstring (format: uuid)Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
symbolstringThe security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the Yahoo Finance ticker format(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
raw_symbolstringThe raw symbol is symbol with the exchange suffix removed. For example, if symbol is "VAB.TO", then raw_symbol is "VAB".
descriptionstring or nullA human-readable description of the security. This is usually the company name or ETF name.
currencyobjectThe currency in which the security is traded.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
exchangeobjectThe exchange on which the security is listed and traded.
idstring (format: uuid)Unique ID for the exchange in SnapTrade.
codestringA short name for the exchange. For standardized exchange code, please us the mic_code field.
mic_codestringThe Market Identifier Code (MIC) for the exchange.
namestringThe full name of the exchange.
timezonestringThe timezone for the trading hours (start_time and close_time) of the exchange.
start_timestringThe time when the exchange opens for trading.
close_timestringThe time when the exchange closes for trading.
suffixstring or nullThe suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is .TO. See UniversalSymbol->symbol and UniversalSymbol->raw_symbol for more detail.
typeobjectThe type of security. For example, "Common Stock" or "ETF".
idstring (format: uuid)Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
codestringA short code representing the security type. For example, "cs" for Common Stock. Here are some common values:
ad- ADRbnd- Bondcs- Common Stockcef- Closed End Fundcrypto- Cryptocurrencyet- ETFoef- Open Ended Fundps- Preferred Stockrt- Rightstruct- Structured Productut- Unitwi- When Issuedwt- Warrant
descriptionstringA human-readable description of the security type. For example, "Common Stock" or "ETF".
is_supportedbooleanThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information. This value should be the same as the figi_code in the figi_instrument child property.
figi_instrumentobject or nullFinancial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information.
figi_share_classstring or nullThis enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, AAPL has a different FIGI for each exchange/trading venue it is traded on. The figi_share_class is the same for all of these FIGIs. See section 1.4.3 of the FIGI Standard for more information.
currenciesarray of objectsThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
quote_currencyobjectQuote currency. This field is only present for cryptocurrency pair orders with a fiat currency as quote.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
actionstringThe action describes the intent or side of a trade. This is usually BUY or SELL but can include other potential values like the following depending on the specific brokerage.
- BUY
- SELL
- BUY_COVER
- SELL_SHORT
- BUY_OPEN
- BUY_CLOSE
- SELL_OPEN
- SELL_CLOSE
total_quantitystring or nullThe total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares.
open_quantitystring or nullThe number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares.
canceled_quantitystring or nullThe number of shares or contracts that have been canceled. Can be a decimal number for fractional shares.
filled_quantitystring or nullThe number of shares or contracts that have been filled. Can be a decimal number for fractional shares.
execution_pricenumber or nullThe price at which the order was executed.
limit_pricenumber or nullThe limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to Limit and StopLimit orders.
stop_pricenumber or nullThe stop price is the price at which a stop order is triggered. Should only apply to Stop and StopLimit orders.
order_typestring or nullThe type of order placed. The most common values are Market, Limit, Stop, and StopLimit. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value.
time_in_forcestringThe Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value.
Day- Day. The order is valid only for the trading day on which it is placed.GTC- Good Til Canceled. The order is valid until it is executed or canceled.FOK- Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.IOC- Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.GTD- Good Til Date. The order is valid until the specified date.MOO- Market On Open. The order is to be executed at the day's opening price.EHP- Extended Hours P.M. The order is to be placed during extended hour trading, after markets close.
time_placedstring (format: date-time)The time the order was placed. This is the time the order was submitted to the brokerage.
time_updatedstring (format: date-time) or nullThe time the order was last updated in the brokerage system. This value is not always available from the brokerage.
time_executedstring (format: date-time) or nullThe time the order was executed in the brokerage system. This value is not always available from the brokerage.
expiry_datestring (format: date-time) or nullThe time the order expires. This value is not always available from the brokerage.
symbolstring (format: uuid)A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
child_brokerage_order_idsobject or nulltake_profit_order_idstringThe brokerage order ID for the take profit leg of the bracket order
stop_loss_order_idstringThe brokerage order ID for the stop loss leg of the bracket order
total_valueobjectThis 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, if the brokerage account holds assets that SnapTrade does not support, the total value may be underreported. In certain cases, this value may also be double-counting cash-equivalent assets if those assets are represented as both cash and positions in the account.
valuenumber or nullTotal value denominated in the currency of the currency field.
currencystring or nullThe ISO-4217 currency code for the amount.
1{2"account": {3"id": "917c8734-8470-4a3e-a18f-57c3f2ee6631",4"brokerage_authorization": "87b24961-b51e-4db8-9226-f198f6518a89",5"name": "Robinhood Individual",6"number": "Q6542138443",7"institution_name": "Robinhood",8"created_date": "2024-07-23T22:50:22.761Z",9"sync_status": {10"transactions": {11"initial_sync_completed": true,12"last_successful_sync": "2022-01-24",13"first_transaction_date": "2022-01-24"14},15"holdings": {16"initial_sync_completed": true,17"last_successful_sync": "2024-06-28 18:42:46.561408+00:00"18}19},20"balance": {21"total": {22"amount": 15363.23,23"currency": "USD"24}25},26"status": "open",27"raw_type": "Margin",28"meta": {29"type": "Margin",30"status": "ACTIVE",31"institution_name": "Robinhood"32},33"portfolio_group": "2bcd7cc3-e922-4976-bce1-9858296801c3",34"cash_restrictions": []35},36"balances": [37{38"currency": {39"id": "87b24961-b51e-4db8-9226-f198f6518a89",40"code": "USD",41"name": "US Dollar"42},43"cash": 300.71,44"buying_power": 410.7145}46],47"positions": [48{49"symbol": {50"symbol": {51"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",52"symbol": "VAB.TO",53"raw_symbol": "VAB",54"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",55"currency": {56"id": "87b24961-b51e-4db8-9226-f198f6518a89",57"code": "USD",58"name": "US Dollar"59},60"exchange": {61"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",62"code": "TSX",63"mic_code": "XTSE",64"name": "Toronto Stock Exchange",65"timezone": "America/New_York",66"start_time": "09:30:00",67"close_time": "16:00:00",68"suffix": ".TO"69},70"type": {71"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",72"code": "cs",73"description": "Common Stock",74"is_supported": true75},76"figi_code": "BBG000B9XRY4",77"figi_instrument": {78"figi_code": "BBG000B9Y5X2",79"figi_share_class": "BBG001S5N8V8"80},81"currencies": [82{83"id": "87b24961-b51e-4db8-9226-f198f6518a89",84"code": "USD",85"name": "US Dollar"86}87]88},89"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",90"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",91"local_id": "3291231",92"is_quotable": true,93"is_tradable": true94},95"units": 40,96"price": 113.15,97"open_pnl": 0.44,98"average_purchase_price": 108.3353,99"fractional_units": 1.44,100"currency": {101"id": "87b24961-b51e-4db8-9226-f198f6518a89",102"code": "USD",103"name": "US Dollar"104},105"cash_equivalent": false106}107],108"option_positions": [109{110"symbol": {111"option_symbol": {112"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",113"ticker": "AAPL 261218C00240000",114"option_type": "CALL",115"strike_price": 240,116"expiration_date": "2026-12-18",117"is_mini_option": false,118"underlying_symbol": {119"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",120"symbol": "SPY",121"raw_symbol": "VAB",122"description": "SPDR S&P 500 ETF Trust",123"currency": {124"id": "87b24961-b51e-4db8-9226-f198f6518a89",125"code": "USD",126"name": "US Dollar"127},128"exchange": {129"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",130"code": "ARCX",131"mic_code": "ARCA",132"name": "NYSE ARCA",133"timezone": "America/New_York",134"start_time": "09:30:00",135"close_time": "16:00:00",136"suffix": "None",137"allows_cryptocurrency_symbols": false138},139"type": {140"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",141"code": "cs",142"description": "Common Stock",143"is_supported": true144},145"figi_code": "BBG000B9XRY4",146"figi_instrument": {147"figi_code": "BBG000B9Y5X2",148"figi_share_class": "BBG001S5N8V8"149},150"currencies": [151{152"id": "87b24961-b51e-4db8-9226-f198f6518a89",153"code": "USD",154"name": "US Dollar"155}156]157}158},159"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",160"description": "SPY CALL 7/17 200"161},162"price": 38.4,163"units": -50,164"average_purchase_price": 4126,165"currency": {166"id": "87b24961-b51e-4db8-9226-f198f6518a89",167"code": "USD",168"name": "US Dollar"169}170}171],172"orders": [173{174"brokerage_order_id": "66a033fa-da74-4fcf-b527-feefdec9257e",175"status": "NONE",176"universal_symbol": {177"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",178"symbol": "VAB.TO",179"raw_symbol": "VAB",180"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",181"currency": {182"id": "87b24961-b51e-4db8-9226-f198f6518a89",183"code": "USD",184"name": "US Dollar"185},186"exchange": {187"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",188"code": "TSX",189"mic_code": "XTSE",190"name": "Toronto Stock Exchange",191"timezone": "America/New_York",192"start_time": "09:30:00",193"close_time": "16:00:00",194"suffix": ".TO"195},196"type": {197"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",198"code": "cs",199"description": "Common Stock",200"is_supported": true201},202"figi_code": "BBG000B9XRY4",203"figi_instrument": {204"figi_code": "BBG000B9Y5X2",205"figi_share_class": "BBG001S5N8V8"206},207"currencies": [208{209"id": "87b24961-b51e-4db8-9226-f198f6518a89",210"code": "USD",211"name": "US Dollar"212}213]214},215"option_symbol": {216"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",217"ticker": "AAPL 261218C00240000",218"option_type": "CALL",219"strike_price": 240,220"expiration_date": "2026-12-18",221"is_mini_option": false,222"underlying_symbol": {223"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",224"symbol": "SPY",225"raw_symbol": "VAB",226"description": "SPDR S&P 500 ETF Trust",227"currency": {228"id": "87b24961-b51e-4db8-9226-f198f6518a89",229"code": "USD",230"name": "US Dollar"231},232"exchange": {233"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",234"code": "ARCX",235"mic_code": "ARCA",236"name": "NYSE ARCA",237"timezone": "America/New_York",238"start_time": "09:30:00",239"close_time": "16:00:00",240"suffix": "None",241"allows_cryptocurrency_symbols": false242},243"type": {244"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",245"code": "cs",246"description": "Common Stock",247"is_supported": true248},249"figi_code": "BBG000B9XRY4",250"figi_instrument": {251"figi_code": "BBG000B9Y5X2",252"figi_share_class": "BBG001S5N8V8"253},254"currencies": [255{256"id": "87b24961-b51e-4db8-9226-f198f6518a89",257"code": "USD",258"name": "US Dollar"259}260]261}262},263"quote_universal_symbol": {264"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",265"symbol": "VAB.TO",266"raw_symbol": "VAB",267"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",268"currency": {269"id": "87b24961-b51e-4db8-9226-f198f6518a89",270"code": "USD",271"name": "US Dollar"272},273"exchange": {274"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",275"code": "TSX",276"mic_code": "XTSE",277"name": "Toronto Stock Exchange",278"timezone": "America/New_York",279"start_time": "09:30:00",280"close_time": "16:00:00",281"suffix": ".TO"282},283"type": {284"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",285"code": "cs",286"description": "Common Stock",287"is_supported": true288},289"figi_code": "BBG000B9XRY4",290"figi_instrument": {291"figi_code": "BBG000B9Y5X2",292"figi_share_class": "BBG001S5N8V8"293},294"currencies": [295{296"id": "87b24961-b51e-4db8-9226-f198f6518a89",297"code": "USD",298"name": "US Dollar"299}300]301},302"quote_currency": {303"id": "87b24961-b51e-4db8-9226-f198f6518a89",304"code": "USD",305"name": "US Dollar"306},307"action": "string",308"total_quantity": "100",309"open_quantity": "10",310"canceled_quantity": "10",311"filled_quantity": "80",312"execution_price": 12.34,313"limit_price": 12.34,314"stop_price": 12.5,315"order_type": "Market",316"time_in_force": "string",317"time_placed": "2024-07-30T22:51:49.746Z",318"time_updated": "2024-08-05T00:05:57.409Z",319"time_executed": "2024-08-05T00:05:57.409Z",320"expiry_date": "2024-08-05T00:05:57.409Z",321"symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3",322"child_brokerage_order_ids": {323"take_profit_order_id": "12345678",324"stop_loss_order_id": "12345678"325}326}327],328"total_value": {329"value": 32600.71,330"currency": "USD"331}332}