Account Information

Update details of an investment account

Changed on

Updates various properties of a specified account.

put/accounts/{accountId}

Request

  • Base URL
    https://api.snaptrade.com
  • URL
    https://api.snaptrade.com/accounts/{accountId}
  • 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

The ID of the account to update.

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

Successfully updated details of an investment account

idstring uuid required

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

brokerage_authorizationstring uuid required

Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.

namestring nullable required

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.

numberstring required

The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.

institution_account_idstring nullable

A 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_namestring required

The name of the brokerage that holds the account.

created_datestring date-time required

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 date-time nullable

Timestamp in ISO 8601 format indicating when the account was funded. Only populated for brokerages that expose this data (Tastytrade, eToro, moomoo, Public, and Unlok); null for all other brokerages.

opening_datestring date-time nullable

Timestamp in ISO 8601 format indicating when the account was opened at the brokerage. Only populated for brokerages that expose this data (Tastytrade, eToro, moomoo, Public, and Unlok); null for all other brokerages.

status'open' | 'closed' | 'archived' | 'unavailable' nullable

The 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 nullable

The account type as provided by the brokerage

account_category'INVESTMENT' | 'DEPOSIT' | 'LOC' | 'ANNUITY' nullable

The 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.
  • ANNUITY: An annuity contract account.
metaobject

Additional 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 uuid nullable

Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a use case for it.

cash_restrictionsstring[]

This field is deprecated.

is_paperboolean required

Indicates whether the account is a paper (simulated) trading account.

Example response

[
  {
    "id": "917c8734-8470-4a3e-a18f-57c3f2ee6631",
    "brokerage_authorization": "87b24961-b51e-4db8-9226-f198f6518a89",
    "name": "Robinhood Individual",
    "number": "Q6542138443",
    "institution_account_id": "54953432",
    "institution_name": "Robinhood",
    "created_date": "2024-07-23T22:50:22.761390Z",
    "funding_date": "2024-07-25T12:00:00.000000Z",
    "opening_date": "2024-07-20T09:30:00.000000Z",
    "sync_status": {
      "transactions": {
        "initial_sync_completed": true,
        "last_successful_sync": "2022-01-24",
        "first_transaction_date": "2022-01-24"
      },
      "holdings": {
        "initial_sync_completed": true,
        "last_successful_sync": "2024-06-28 18:42:46.561408+00:00",
        "holdings_unavailable": true
      }
    },
    "balance": {
      "total": {
        "amount": 15363.23,
        "currency": "USD"
      }
    },
    "status": "open",
    "raw_type": "Margin",
    "account_category": "INVESTMENT",
    "meta": {
      "type": "Margin",
      "status": "ACTIVE",
      "institution_name": "Robinhood"
    },
    "portfolio_group": "2bcd7cc3-e922-4976-bce1-9858296801c3",
    "cash_restrictions": []
  }
]

Changes

  • 60be624d75b7Revision changes
    • warning

      added the new ANNUITY enum value to the / response property for the response status

  • efd73af6c911Revision changes
    • 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 object to no type for status

    • breaking

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

    • breaking

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