logo
Book A Demo
Book A Demo
Account Information

List account balances

get
https://api.snaptrade.com/api/v1/accounts/{accountId}/balances

Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade allows holding multiple currencies in the same account.

Check your API key on the Customer Dashboard billing page to see if you have real-time data access:

  • If you do, this endpoint returns real-time data.
  • If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the manual refresh endpoint.

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

Execute an API Request

Path
accountIdstring (format: uuid)required

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

Query
userIdstringrequired

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.

userSecretstringrequired

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.

Authorization
Request
Installation
GitHubnpm
$
npm install snaptrade-typescript-sdk
1
import { Snaptrade } from "snaptrade-typescript-sdk";
2


3
const snaptrade = new Snaptrade({
4
  clientId: "PARTNER_CLIENT_ID",
5
  consumerKey: "CONSUMER_KEY",
6
});
7


8
const response =
9
  await snaptrade.accountInformation.getUserAccountBalance(
10
    {
11
      accountId:
12
        "917c8734-8470-4a3e-a18f-57c3f2ee6631",
13
      userId: "snaptrade-user-123",
14
      userSecret:
15
        "adf2aa34-8219-40f7-a6b3-60156985cc61",
16
    },
17
  );
18
console.log(response.data);

Response fields

array of objects
object

Holds balance information for a single currency in an account.

1
[
2
  {
3
    "currency": {
4
      "id": "87b24961-b51e-4db8-9226-f198f6518a89",
5
      "code": "USD",
6
      "name": "US Dollar"
7
    },
8
    "cash": 300.71,
9
    "buying_power": 410.71
10
  }
11
]
Made with Konfig