Response fields
array of objects
object
A transaction or activity from an institution
id
string
account
object
SnapTradeUser Investment Account
id
string (format: uuid)
name
string
number
string
sync_status
object
Status of account
transactions
object
Status of account transaction sync
initial_sync_completed
boolean
last_successful_sync
string (format: date) or null
Date in YYYY-MM-DD format or null
first_transaction_date
string (format: date) or null
Date in YYYY-MM-DD format or null
holdings
object
Status of account holdings sync
initial_sync_completed
boolean
last_successful_sync
string (format: datetime) or null
Date in ISO 8601 format or null (YYYY-MM-DD HH:MM:SS.mmmmmmTZ)
amount
number or null
currency
object
Currency
id
string (format: uuid)
code
string
name
string
description
string
fee
number
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
option_type
string
If an option transaction, then it's type (BUY_TO_OPEN, SELL_TO_CLOSE, etc), otherwise empty string
price
number
settlement_date
string
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
symbol
object
Symbol
id
string (format: uuid)
symbol
string
raw_symbol
string
name
string
currency
object
Currency
id
string (format: uuid)
code
string
name
string
exchange
object
Stock Exchange
id
string (format: uuid)
code
string
mic_code
string
name
string
timezone
string
start_time
string
close_time
string
suffix
string or null
type
object
Security Type
id
string (format: uuid)
code
string
description
string
is_supported
boolean
figi_code
string or null
figi_instrument
object or null
Open FIGI Identifiers
figi_code
string or null
figi_share_class
string or null
option_symbol
object
Options Symbol
id
string (format: uuid)
ticker
string
option_type
string
strike_price
number
expiration_date
string (format: datetime)
is_mini_option
boolean
underlying_symbol
object
Underlying Symbol
id
string (format: uuid)
symbol
string
description
string or null
currency
object
Currency
id
string (format: uuid)
code
string
name
string
exchange
object
US Stock Exchange
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
Security Type
id
string (format: uuid)
code
string
description
string
is_supported
boolean
currencies
array of objects
id
string (format: uuid)
code
string
name
string
figi_code
string or null
figi_instrument
object or null
Open FIGI Identifiers
figi_code
string or null
figi_share_class
string or null
local_id
string
exchange_id
string (format: uuid)
trade_date
string or null
type
string
Potential values include (but are not limited to) - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
units
number
Usually but not necessarily an integer
1[2{3"id": "2f7dc9b3-5c33-4668-3440-2b31e056ebe6",4"account": {5"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",6"name": "Registered Retirement Savings Account",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"amount": 263.82,21"currency": {22"id": "87b24961-b51e-4db8-9226-f198f6518a89",23"code": "USD",24"name": "US Dollar"25},26"description": "WALT DISNEY UNIT DIST ON 21 SHS REC 12/31/21 PAY 01/06/22",27"fee": 0,28"fx_rate": 1.032,29"institution": "SnapTrade Investr",30"option_type": "BUY_TO_OPEN",31"price": 0.4,32"settlement_date": "2022-01-06T05:00:00.000Z",33"external_reference_id": "2f7dc9b3-5c33-4668-3440-2b31e056ebe6",34"symbol": {35"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",36"symbol": "VAB.TO",37"raw_symbol": "VAB",38"name": "Vanguard Canadian Aggregate Bond Index ETF",39"currency": {40"id": "87b24961-b51e-4db8-9226-f198f6518a89",41"code": "USD",42"name": "US Dollar"43},44"exchange": {45"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",46"code": "TSX",47"mic_code": "XTSE",48"name": "Toronto Stock Exchange",49"timezone": "America/New_York",50"start_time": "09:30:00",51"close_time": "16:00:00",52"suffix": ".TO"53},54"type": {55"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",56"code": "cs",57"description": "Common Stock",58"is_supported": true59},60"figi_code": "BBG000B9XRY4",61"figi_instrument": {62"figi_code": "BBG000B9Y5X2",63"figi_share_class": "BBG001S5N8V8"64}65},66"option_symbol": {67"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",68"ticker": "SPY 220819P00200000",69"option_type": "CALL",70"strike_price": 200,71"expiration_date": "2017-07-17T15:13:07.177712+00:00",72"is_mini_option": false,73"underlying_symbol": {74"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",75"symbol": "SPY",76"description": "SPDR S&P 500 ETF Trust",77"currency": {78"id": "87b24961-b51e-4db8-9226-f198f6518a89",79"code": "USD",80"name": "US Dollar"81},82"exchange": {83"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",84"code": "ARCX",85"mic_code": "ARCA",86"name": "NYSE ARCA",87"timezone": "America/New_York",88"start_time": "09:30:00",89"close_time": "16:00:00",90"suffix": "None",91"allows_cryptocurrency_symbols": false92},93"type": {94"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",95"code": "cs",96"description": "Common Stock",97"is_supported": true98},99"currencies": [100{101"id": "87b24961-b51e-4db8-9226-f198f6518a89",102"code": "USD",103"name": "US Dollar"104}105],106"figi_code": "BBG000B9XRY4",107"figi_instrument": {108"figi_code": "BBG000B9Y5X2",109"figi_share_class": "BBG001S5N8V8"110}111},112"local_id": "40817960",113"exchange_id": "6e73ee7b-fdf3-44c2-947d-260c3ee72506"114},115"trade_date": "2022-01-06T05:00:00.000Z",116"type": "string",117"units": 5118}119]