Get usage stats / SnapTrade

Get usage stats

get

https://api.snaptrade.com/snapTrade/stats

Returns user, connection, and connected asset totals for your SnapTrade Client ID. These are the same numbers shown on the Users & Connections page of the SnapTrade Dashboard.

User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; assets_under_management_calculated_at indicates when it was last calculated.

Execute an API Request

Authentication Method

Use commercial authentication when acting on behalf of your application and passing end-user credentials with requests that require them.

Credentials

clientId

consumerKey

Query

currencystring

ISO 4217 currency code to express connected asset values in. Defaults to USD.

Request

Installation

GitHub npm

npm install snaptrade-typescript-sdk

1
import {
2
  Snaptrade,
3
  SnaptradeAuth,
4
} from "snaptrade-typescript-sdk";
5

6
const snaptrade = new Snaptrade({
7
  auth: SnaptradeAuth.commercialApiKey({
8
    consumerKey: "CONSUMER_KEY",
9
    clientId: "CLIENT_ID",
10
  }),
11
});
12

13
const response =
14
  await snaptrade.management.getStats({
15
    currency: "USD",
16
  });
17
console.log(response.data);

Response fields

object

User, connection, and connected asset totals for your SnapTrade Client ID.

total_usersinteger

Number of users registered with your Client ID.

total_connected_usersinteger

Number of users registered with your Client ID that have at least one connection, active or disabled.

total_active_connectionsinteger

Number of active connections across users registered with your Client ID.

total_disabled_connectionsinteger

Number of disabled connections across users registered with your Client ID.

oauth_total_usersinteger or null

Number of users who have authorized your OAuth application. null if your Client ID has no OAuth application.

oauth_total_connected_usersinteger or null

Number of users who have authorized your OAuth application and have at least one connection, active or disabled. null if your Client ID has no OAuth application.

oauth_total_active_connectionsinteger or null

Number of active connections across users who have authorized your OAuth application. null if your Client ID has no OAuth application.

oauth_total_disabled_connectionsinteger or null

Number of disabled connections across users who have authorized your OAuth application. null if your Client ID has no OAuth application.

assets_under_managementnumber (format: double) or null

Total latest account value across active connections of users registered with your Client ID, in assets_under_management_currency. null until the first daily snapshot has been calculated.

disabled_assets_under_managementnumber (format: double) or null

Total account value across disabled connections of users registered with your Client ID, as of each connection's last sync, in assets_under_management_currency. null until the first daily snapshot has been calculated.

oauth_assets_under_managementnumber (format: double) or null

Total latest account value across active connections of users who have authorized your OAuth application, in assets_under_management_currency. null if your Client ID has no OAuth application, or until the first daily snapshot after it was added.

oauth_disabled_assets_under_managementnumber (format: double) or null

Total account value across disabled connections of users who have authorized your OAuth application, as of each connection's last sync, in assets_under_management_currency. null if your Client ID has no OAuth application, or until the first daily snapshot after it was added.

assets_under_management_currencystring

ISO 4217 currency code the asset values are expressed in.

assets_under_management_calculated_atstring (format: date-time) or null

Timestamp in ISO 8601 format indicating when the connected asset values were last calculated. null until the first daily snapshot has been calculated.

1
{
2
  "total_users": 19528,
3
  "total_connected_users": 2681,
4
  "total_active_connections": 2265,
5
  "total_disabled_connections": 708,
6
  "oauth_total_users": null,
7
  "oauth_total_connected_users": null,
8
  "oauth_total_active_connections": null,
9
  "oauth_total_disabled_connections": null,
10
  "assets_under_management": 104900000,
11
  "disabled_assets_under_management": 159300000,
12
  "oauth_assets_under_management": null,
13
  "oauth_disabled_assets_under_management": null,
14
  "assets_under_management_currency": "USD",
15
  "assets_under_management_calculated_at": "2026-10-08T02:47:00.000Z"
16
}