Response envelope

A successful response wraps its payload in data:
List endpoints that page add a pagination object next to data, and some add a summary.

Pagination

Two styles are used, depending on the endpoint. Each endpoint’s reference page says which.
Used by /wallet/discover and /cohorts/positions. Send page (starting at 1) and limit. The response tells you how many pages there are:

Time ranges

Wallet analytics take a range: Leaderboard metrics come pre-computed in three windows, named by prefix: 7d_, 30d_ and total_ (all time).

Units and formats

  • Money is in USD as a number (for example 1523.42), whatever the venue settles in.
  • Ratios such as win_rate and drawdown are fractions (0.62 is 62%). Fields that are already percentages say so in their description, for example winRate in asset performance (0 to 100).
  • Dates are UTC. Daily series use YYYY-MM-DD; timestamps are ISO 8601 or Unix seconds, as named (block_time is Unix seconds, time is ISO 8601).
  • Sides are long and short.

Freshness and caching

Analytics are updated continuously from each venue’s trade stream and cached for a short time: most wallet endpoints for 1 to 5 minutes, leaderboards for 10 minutes, venue rankings for a few hours. Leaderboard and cohort responses carry an asOf timestamp telling you how fresh the underlying data is. There is no benefit to polling faster than the cache.