For AI agents: the complete documentation index is available at https://docs.snaptrade.com/llms.txt, and the full documentation text is available at https://docs.snaptrade.com/llms-full.txt. Markdown versions of documentation pages are available by appending .md to the URL path.
logo
Book A Demo
Book A Demo
View as Markdown
Account Information

Get the user's AUM percentile

get
https://api.snaptrade.com/aumPercentile

Returns where the user's total assets sit within the distribution of a cohort of comparable users, as a coarse bucket plus an integer percentile.

The cohort is scoped to your own book: a user is only ever compared against your other users, never across SnapTrade customers. (Users on personal-use keys are the exception — they are compared against all other personal-use users, since a personal key has a single user and cannot form a distribution of its own.) The distribution is recomputed monthly, and as_of reports which month's distribution the placement came from.

data is null — a 200, not an error — when SnapTrade declines to place the user. That happens when the cohort is too small to publish a distribution, or when the user's own holdings are incomplete or stale (for example they hold a disabled connection). A placement computed from a partial view of a user's assets would understate them, so none is returned.

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
Request
Installation
GitHubnpm
$
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.accountInformation.getUserAumPercentile(
15
    {
16
      userId: "USER_ID",
17
      userSecret: "USER_SECRET",
18
    },
19
  );
20
console.log(response.data);

Response fields

object

The user's placement within your book, or null when SnapTrade declines to place them

dataobject or null

A user's AUM placement within a single SnapTrade customer's book

1
{
2
  "data": {
3
    "bucket": "TOP_25_PERCENT",
4
    "percentile": 78,
5
    "cohort_size": 24193,
6
    "as_of": "2026-08-01T00:00:00.000Z",
7
    "currency": "USD"
8
  }
9
}