Fomo API logoFOMO APIDOCS

Documentation

IntroductionAuthenticationQuickstartGETHealthGETLeaderboardGETResolve traderGETTrader balancesGETTrader spotlightGETTrader swapsGETTrader rankingGETAggregated snapshotWSTrade stream

[ API reference ]

Aggregated snapshot

Returns aggregated equity and PnL for a trader at a specific historical snapshot.

GET/api/user-tokens/aggregated-snapshot

This endpoint requires an API key using X-API-Key or Bearer authorization.

01

Request

curl

curl "https://getfomoapi.fun/api/user-tokens/aggregated-snapshot" \
  -H "X-API-Key: YOUR_API_KEY"
02

Parameters

user_idqueryUUIDUnique trader ID returned by the resolve trader endpoint.
snapshot_idqueryintegerUnix timestamp identifying the requested snapshot.
03

Response fields

successbooleanIndicates whether the request succeeded.
responseObject.snapshotIdintegerUnix timestamp identifying the snapshot.
responseObject.pnlnumberAggregated PnL at the snapshot.
responseObject.equitynumberAggregated equity at the snapshot.
statusCodeintegerHTTP status represented in the response.
04

JSON response

A successful request returns the following response structure.

response.json

{
  "success": true,
  "message": "User token snapshot stats found",
  "responseObject": {
    "snapshotId": 1788526800,
    "pnl": -1108800.20,
    "equity": 899144.45
  },
  "statusCode": 200
}

Rate limits and retry

Pro keys allow 5 requests per second. On a 429 response, wait for the Retry-After value before retrying.