Response fields
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 (brokerage_authorization_id). 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_account_idstring or nullA stable and unique account identifier provided by the institution. Will be set to null if not provided. When present, can be used to check if a user has connected the same brokerage account across multiple connections.
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.
funding_datestring (format: date-time) or nullTimestamp in ISO 8601 format indicating when the account was funded.
opening_datestring (format: date-time) or nullTimestamp in ISO 8601 format indicating when the account was opened 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 trigger an incremental sync of transactions with the transactions sync 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.
holdings_unavailablebooleanIndicates that the brokerage does not expose this account's holdings to SnapTrade, so the
empty positions and balances reported for it do not mean the account is empty. This is set
for accounts served by a separate brokerage system that we cannot read, such as Vanguard
employer-sponsored retirement plans. When this is true, prefer the account's total value
over the sum of its positions and cash, and note that initial_sync_completed and
last_successful_sync may still reflect an earlier sync.
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.
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
account_categorystring or nullThe category of the account, normalized across institutions.
Returns null if the category could not be determined. Use this field to filter out non-investment accounts if your integration only supports trading / holdings flows. See Filtering Accounts by Category for more information.
INVESTMENT: A brokerage / investment account (equities, options, crypto, etc.).DEPOSIT: A bank deposit account (checking, savings).LOC: A line of credit account.
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) or nullPortfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a use case for it.
cash_restrictionsarray of stringsThis field is deprecated.
is_paperbooleanIndicates whether the account is a paper (simulated) trading account.
1[2{3"id": "917c8734-8470-4a3e-a18f-57c3f2ee6631",4"brokerage_authorization": "87b24961-b51e-4db8-9226-f198f6518a89",5"name": "Robinhood Individual",6"number": "Q6542138443",7"institution_account_id": "54953432",8"institution_name": "Robinhood",9"created_date": "2024-07-23T22:50:22.761Z",10"funding_date": "2024-07-25T12:00:00.000Z",11"opening_date": "2024-07-20T09:30:00.000Z",12"sync_status": {13"transactions": {14"initial_sync_completed": true,15"last_successful_sync": "2022-01-24T00:00:00.000Z",16"first_transaction_date": "2022-01-24T00:00:00.000Z"17},18"holdings": {19"initial_sync_completed": true,20"last_successful_sync": "2024-06-28T18:42:46.561Z",21"holdings_unavailable": true22}23},24"balance": {25"total": {26"amount": 15363.23,27"currency": "USD"28}29},30"status": "open",31"raw_type": "Margin",32"account_category": "INVESTMENT",33"meta": {34"type": "Margin",35"status": "ACTIVE",36"institution_name": "Robinhood"37},38"portfolio_group": "2bcd7cc3-e922-4976-bce1-9858296801c3",39"cash_restrictions": [],40"is_paper": false41}42]