v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0175184292.5 KB
Account Information

List all accounts for the user, plus balances, positions, and orders for each account.

Deprecated. Use the account-specific holdings endpoint instead.

This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.

List all accounts for the user, plus balances, positions, and orders for each account.

get/holdings

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
brokerage_authorizationsstring uuid
Example:917c8734-8470-4a3e-a18f-57c3f2ee6631

Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).

Response

Returns list of accounts and holdings

Example response

[
  {
    "account": {
      "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
      "brokerage_authorization": {
        "id": "87b24961-b51e-4db8-9226-f198f6518a89",
        "created_date": "2024-08-20T21:56:19.123935Z",
        "brokerage": {
          "id": "ebf91a5b-0920-4266-9e36-f6cfe8c40946",
          "slug": "ROBINHOOD",
          "name": "Robinhood",
          "display_name": "Robinhood",
          "description": "Robinhood is an American multinational financial services corporation based in Menlo Park, California.",
          "aws_s3_logo_url": "https://passiv-brokerage-logos.s3.ca-central-1.amazonaws.com/robinhood-logo.png",
          "aws_s3_square_logo_url": "https://passiv-brokerage-logos.s3.ca-central-1.amazonaws.com/robinhood-logo-square.png",
          "url": "https://robinhood.com",
          "enabled": true,
          "maintenance_mode": true,
          "is_degraded": true,
          "allows_trading": true,
          "allows_fractional_units": true,
          "has_reporting": true,
          "is_real_time_connection": true,
          "brokerage_type": {
            "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
            "name": "Traditional Brokerage"
          },
          "exchanges": [
            "2bcd7cc3-e922-4976-bce1-9858296801c3",
            "4bcd8cc3-c122-4974-dc21-1858296801f4"
          ]
        },
        "name": "Connection-1",
        "type": "trade",
        "disabled_date": "2022-01-21T15:11:19.217000-05:00",
        "meta": {
          "identifier": 123456
        },
        "updated_date": "2024-08-20T21:56:20.057224Z",
        "is_eligible_for_payout": true,
        "data_freshness_mode": "realtime"
      },
      "portfolio_group": "2bcd7cc3-e922-4976-bce1-9858296801c3",
      "name": "Registered Retirement Savings Account",
      "number": "Q6542138443",
      "institution_name": "Alpaca",
      "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
        }
      },
      "meta": {
        "type": "Margin",
        "status": "ACTIVE",
        "institution_name": "Alpaca"
      }
    },
    "balances": [
      {
        "currency": {
          "id": "87b24961-b51e-4db8-9226-f198f6518a89",
          "code": "USD",
          "name": "US Dollar"
        },
        "cash": 300.71,
        "buying_power": 410.71
      }
    ],
    "positions": [
      {
        "symbol": {
          "symbol": {
            "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
            "symbol": "VAB.TO",
            "raw_symbol": "VAB",
            "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
            "currency": {
              "id": "87b24961-b51e-4db8-9226-f198f6518a89",
              "code": "USD",
              "name": "US Dollar"
            },
            "exchange": {
              "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
              "code": "TSX",
              "mic_code": "XTSE",
              "name": "Toronto Stock Exchange",
              "timezone": "America/New_York",
              "start_time": "09:30:00",
              "close_time": "16:00:00",
              "suffix": ".TO"
            },
            "type": {
              "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
              "code": "cs",
              "description": "Common Stock",
              "is_supported": true
            },
            "figi_code": "BBG000B9XRY4",
            "figi_instrument": {
              "figi_code": "BBG000B9Y5X2",
              "figi_share_class": "BBG001S5N8V8"
            },
            "currencies": [
              {
                "id": "87b24961-b51e-4db8-9226-f198f6518a89",
                "code": "USD",
                "name": "US Dollar"
              }
            ]
          },
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
          "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
          "local_id": "3291231",
          "is_quotable": true,
          "is_tradable": true
        },
        "units": 40,
        "price": 113.15,
        "open_pnl": 0.44,
        "average_purchase_price": 108.3353,
        "fractional_units": 1.44,
        "currency": {
          "id": "87b24961-b51e-4db8-9226-f198f6518a89",
          "code": "USD",
          "name": "US Dollar"
        },
        "tax_lots": [
          {
            "original_purchase_date": "2022-01-15T10:30:00Z",
            "quantity": "10",
            "purchased_price": "100.50",
            "cost_basis": "1005.00",
            "current_value": "1200.00",
            "position_type": "LONG",
            "lot_id": "12345678"
          }
        ]
      }
    ],
    "total_value": {
      "value": 32600.71,
      "currency": "USD"
    }
  }
]