Response fields
array of objects
object
A transaction or activity from an institution
id
string
Unique identifier for the transaction. This is the ID used to reference the transaction in SnapTrade.
Please note that this ID can change if the transaction is deleted and re-added. Under normal circumstances, SnapTrade does not delete transactions. The only time this would happen is if SnapTrade re-fetches and reprocesses the data from the brokerage, which is rare. If you require a stable ID, please let us know and we can work with you to provide one.
account
object
A single account at a brokerage.
id
string (format: uuid)
Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
name
string
A 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.
number
string
The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
sync_status
object
Contains status update for the account sync process between SnapTrade and the brokerage.
transactions
object
Status 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_completed
boolean
Indicates 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_sync
string (format: date) or null
All 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_date
string (format: date) or null
The 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.
holdings
object
Status 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_completed
boolean
Indicates 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_sync
string (format: date-time) or null
The last time holdings were successfully synced by SnapTrade.
symbol
object or null
The security for the transaction. The field is null
if the transaction is not related to a security (like a deposit, withdrawal, fee, etc). SnapTrade does a best effort to map the brokerage's symbol. In cases where the brokerage symbol is not recognized, the field will be set to null
.
id
string (format: uuid)
Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
symbol
string
The 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_symbol
string
The raw symbol is symbol
with the exchange suffix removed. For example, if symbol
is "VAB.TO", then raw_symbol
is "VAB".
description
string or null
A human-readable description of the security. This is usually the company name or ETF name.
currency
object
The currency in which the security is traded.
id
string (format: uuid)
Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
code
string
The ISO-4217 currency code for the currency.
name
string
A human-friendly name of the currency.
exchange
object
The exchange on which the security is listed and traded.
id
string (format: uuid)
Unique ID for the exchange in SnapTrade.
code
string
A short name for the exchange. For standardized exchange code, please us the mic_code
field.
mic_code
string
The Market Identifier Code (MIC) for the exchange.
name
string
The full name of the exchange.
timezone
string
The timezone for the trading hours (start_time
and close_time
) of the exchange.
start_time
string
The time when the exchange opens for trading.
close_time
string
The time when the exchange closes for trading.
suffix
string or null
The 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.
type
object
The type of security. For example, "Common Stock" or "ETF".
id
string (format: uuid)
Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
code
string
A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: ad - ADR bnd - Bond cs - Common Stock cef - Closed End Fund et - ETF oef - Open Ended Fund ps - Preferred Stock rt - Right struct - Structured Product ut - Unit wi - When Issued wt - Warrant
description
string
A human-readable description of the security type. For example, "Common Stock" or "ETF".
is_supported
boolean
This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
figi_code
string or null
This 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_instrument
object or null
Financial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.
figi_code
string or null
This identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information.
figi_share_class
string or null
This 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.
option_symbol
object or null
The option security for the transaction. The field is null
if the transaction is not related to an option security (like a deposit, withdrawal, fee, etc). SnapTrade does a best effort to map the brokerage's option symbol. In cases where the brokerage option symbol is not recognized, the field will be set to null
.
id
string (format: uuid)
Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
ticker
string
The OCC symbol for the option.
option_type
string
The type of option. Either "CALL" or "PUT".
strike_price
number
The option strike price.
expiration_date
string (format: date)
The option expiration date.
is_mini_option
boolean
Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
underlying_symbol
object
Symbol object for the underlying security of an option.
id
string (format: uuid)
Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
symbol
string
The 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_symbol
string
The raw symbol is symbol
with the exchange suffix removed. For example, if symbol
is "VAB.TO", then raw_symbol
is "VAB".
description
string or null
A human-readable description of the security. This is usually the company name or ETF name.
currency
object
The currency in which the security is traded.
id
string (format: uuid)
Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
code
string
The ISO-4217 currency code for the currency.
name
string
A human-friendly name of the currency.
exchange
object
The exchange on which the security is listed and traded.
id
string (format: uuid)
code
string
mic_code
string
name
string
timezone
string
start_time
string
close_time
string
suffix
string or null
allows_cryptocurrency_symbols
boolean
type
object
The type of security. For example, "Common Stock" or "ETF".
id
string (format: uuid)
Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
code
string
A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: ad - ADR bnd - Bond cs - Common Stock cef - Closed End Fund et - ETF oef - Open Ended Fund ps - Preferred Stock rt - Right struct - Structured Product ut - Unit wi - When Issued wt - Warrant
description
string
A human-readable description of the security type. For example, "Common Stock" or "ETF".
is_supported
boolean
This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
currencies
array of objects
This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
id
string (format: uuid)
Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
code
string
The ISO-4217 currency code for the currency.
name
string
A human-friendly name of the currency.
figi_code
string or null
This 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_instrument
object or null
Financial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.
figi_code
string or null
This identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information.
figi_share_class
string or null
This 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.
price
number
The price of the security for the transaction. This is mostly applicable to BUY
, SELL
, and DIVIDEND
transactions.
units
number
The number of units of the security for the transaction. This is mostly applicable to BUY
, SELL
, and DIVIDEND
transactions.
amount
number or null
The amount of the transaction denominated in currency
. This can be positive or negative. In general, transactions that positively affect the account balance (like sell, deposits, dividends, etc) will have a positive amount, while transactions that negatively affect the account balance (like buy, withdrawals, fees, etc) will have a negative amount.
currency
object
The currency in which the transaction price
and amount
is denominated.
id
string (format: uuid)
Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
code
string
The ISO-4217 currency code for the currency.
name
string
A human-friendly name of the currency.
type
string
A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values:
BUY
- Asset bought.SELL
- Asset sold.DIVIDEND
- Dividend payout.CONTRIBUTION
- Cash contribution.WITHDRAWAL
- Cash withdrawal.REI
- Dividend reinvestment.INTEREST
- Interest deposited into the account.FEE
- Fee withdrawn from the account.
option_type
string
If an option BUY
or SELL
transaction, this further specifies the type of action. The possible values are:
- BUY_TO_OPEN
- BUY_TO_CLOSE
- SELL_TO_OPEN
- SELL_TO_CLOSE
description
string
A human-readable description of the transaction. This is usually the brokerage's description of the transaction.
trade_date
string (format: date-time) or null
The recorded time for the transaction. The granularity of this timestamp depends on the brokerage. Some brokerages provide the exact time of the transaction, while others provide only the date. Please check the integrations page for the specific brokerage to see the granularity of the timestamps. Note that even though the field is named trade_date
, it can represent any type of transaction, not just trades.
settlement_date
string (format: date-time)
The date on which the transaction is settled.
fee
number
Any fee associated with the transaction if provided by the brokerage.
fx_rate
number or null
The forex conversion rate involved in the transaction if provided by the brokerage. Used in cases where securities of one currency are purchased in a different currency, and the forex conversion is automatic. In those cases, price, amount and fee will be in the top level currency (activity -> currency)
institution
string
The institution that the transaction is associated with. This is usually the brokerage name.
external_reference_id
string or null
Reference ID from brokerage used to identify related transactions. For example if an order comprises of several transactions (buy, fee, fx), they can be grouped if they share the same external_reference_id
1[2{3"id": "2f7dc9b3-5c33-4668-3440-2b31e056ebe6",4"account": {5"id": "917c8734-8470-4a3e-a18f-57c3f2ee6631",6"name": "Robinhood Individual",7"number": "Q6542138443",8"sync_status": {9"transactions": {10"initial_sync_completed": true,11"last_successful_sync": "2022-01-24",12"first_transaction_date": "2022-01-24"13},14"holdings": {15"initial_sync_completed": true,16"last_successful_sync": "2024-06-28 18:42:46.561408+00:00"17}18}19},20"symbol": {21"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",22"symbol": "VAB.TO",23"raw_symbol": "VAB",24"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",25"currency": {26"id": "87b24961-b51e-4db8-9226-f198f6518a89",27"code": "USD",28"name": "US Dollar"29},30"exchange": {31"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",32"code": "TSX",33"mic_code": "XTSE",34"name": "Toronto Stock Exchange",35"timezone": "America/New_York",36"start_time": "09:30:00",37"close_time": "16:00:00",38"suffix": ".TO"39},40"type": {41"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",42"code": "cs",43"description": "Common Stock",44"is_supported": true45},46"figi_code": "BBG000B9XRY4",47"figi_instrument": {48"figi_code": "BBG000B9Y5X2",49"figi_share_class": "BBG001S5N8V8"50}51},52"option_symbol": {53"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",54"ticker": "AAPL 261218C00240000",55"option_type": "CALL",56"strike_price": 240,57"expiration_date": "2026-12-18",58"is_mini_option": false,59"underlying_symbol": {60"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",61"symbol": "SPY",62"raw_symbol": "VAB",63"description": "SPDR S&P 500 ETF Trust",64"currency": {65"id": "87b24961-b51e-4db8-9226-f198f6518a89",66"code": "USD",67"name": "US Dollar"68},69"exchange": {70"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",71"code": "ARCX",72"mic_code": "ARCA",73"name": "NYSE ARCA",74"timezone": "America/New_York",75"start_time": "09:30:00",76"close_time": "16:00:00",77"suffix": "None",78"allows_cryptocurrency_symbols": false79},80"type": {81"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",82"code": "cs",83"description": "Common Stock",84"is_supported": true85},86"currencies": [87{88"id": "87b24961-b51e-4db8-9226-f198f6518a89",89"code": "USD",90"name": "US Dollar"91}92],93"figi_code": "BBG000B9XRY4",94"figi_instrument": {95"figi_code": "BBG000B9Y5X2",96"figi_share_class": "BBG001S5N8V8"97}98}99},100"price": 0.4,101"units": 5.2,102"amount": 263.82,103"currency": {104"id": "87b24961-b51e-4db8-9226-f198f6518a89",105"code": "USD",106"name": "US Dollar"107},108"type": "string",109"option_type": "BUY_TO_OPEN",110"description": "WALT DISNEY UNIT DIST ON 21 SHS REC 12/31/21 PAY 01/06/22",111"trade_date": "2024-03-22T16:27:55.000Z",112"settlement_date": "2024-03-26T00:00:00.000Z",113"fee": 0,114"fx_rate": 1.032,115"institution": "Robinhood",116"external_reference_id": "2f7dc9b3-5c33-4668-3440-2b31e056ebe6"117}118]