Experimental endpoints

List accounts for a connection (discriminated union)

Experimental and subject to change without notice.

Returns the accounts that belong to the specified connection for the authenticated user, using the kind-discriminated account shape.

Each item in the response carries a kind field (investment, deposit, and line_of_credit are implemented) that determines which additional fields are present -- see the ConnectionAccount schema.

On Pay as you Go / Real-time, this endpoint refreshes each 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.

get/connections/{connectionId}/accounts

Path parameters

connectionIdstring uuid required

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

Example:87b24961-b51e-4db8-9226-f198f6518a89

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

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",
    "net_value": {
      "amount": 84213.55,
      "currency": "USD"
    }
  }
]

Changes

Changed in 2 of the 66 revisions of this API.415

  • 5bfb6535c4b3314See the full diff
    • removed the required property ///// from the response with the status

      response-required-property-removed

    • removed the required property ///// from the response with the status

      response-required-property-removed

    • removed the required property ///// from the response with the status

      response-required-property-removed

    • removed the optional property ///// from the response with the status

      response-optional-property-removed

    • added the optional property ///// to the response with the status

      response-optional-property-added

    • added the required property ///// to the response with the status

      response-required-property-added

    • added the required property ///// to the response with the status

      response-required-property-added

    • added the required property ///// to the response with the status

      response-required-property-added

  • 259274f1e84511See the full diff
    • added to the response property oneOf list for the response status

      response-property-one-of-added

    • added line_of_credit discriminator mapping keys to the response property for the response status

      response-property-discriminator-mapping-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog