Account Information

Get account details

Changed on

Returns the specified account for the authenticated user. The account can be an investment, deposit, line of credit, or annuity account. Use the kind discriminator to determine the schema for the account.

On Pay as you Go / Real-time, this endpoint refreshes the account's opening date and total net value (net_value) live from the institution on each call, along with funding date for investment accounts.

On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the manual refresh endpoint.

Check your API key on the Customer Dashboard billing page to see whether your plan includes real-time data.

If the connection has become disabled, it can no longer access the latest data from the institution, but will continue to return the last available cached state. Please see this guide on how to fix a disabled connection.

get/accounts/{accountId}/details

Request

  • Base URL
    https://api.snaptrade.com
  • URL
    https://api.snaptrade.com/accounts/{accountId}/details
  • Auth
    API key in header Signature and API key in query parameter clientId and API key in query parameter timestamp

Path parameters

accountIdstring uuid required

Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.

Example:917c8734-8470-4a3e-a18f-57c3f2ee6631

Query parameters

userIdstring required

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.

Example:snaptrade-user-123
userSecretstring required

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.

Example:adf2aa34-8219-40f7-a6b3-60156985cc61

Response

OK

OR
OR
OR

Example response

{
  "kind": "investment",
  "id": "917c8734-8470-4a3e-a18f-57c3f2ee6631",
  "connection_id": "87b24961-b51e-4db8-9226-f198f6518a89",
  "display_name": "Robinhood Individual",
  "masked_account_number": "****8443",
  "institution_account_id": "54953432",
  "institution_id": "b6e1a9f0-6e2a-4c37-9b0a-6f1e2d3c4b5a",
  "opening_date": "2024-07-20T09:30:00.000000Z",
  "funding_date": "2024-07-25T12:00:00.000000Z",
  "sync_status": {
    "transactions": {
      "initial_sync_completed": true,
      "last_successful_sync": "2022-01-24",
      "first_transaction_date": "2022-01-24"
    },
    "orders": "2024-06-28 18:42:46.561408+00:00",
    "positions": "2024-06-28 18:42:46.561408+00:00",
    "balances": "2024-06-28 18:42:46.561408+00:00"
  },
  "raw_type": "Margin",
  "cash_or_margin": "margin",
  "net_value": {
    "amount": 84213.55,
    "currency": "USD"
  }
}

Changes

    • breaking

      added to the response body oneOf list for the response status

    • info

      added annuity mapping keys to the response discriminator for the response status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from integer to no type for status