Skip to main content
GET
curl
The response body shown here is a static example, not live data. After you click Send, your live result appears in a separate panel headed 200 OK. The panel under the status-code tabs is a fixed sample from the spec — its field values (fees, prices, sizes, IDs, timestamps) are placeholders. Use Send, or call the endpoint, for current values.
Returns trading statistics for any Ethereum address, in selectable sections so clients fetch only what they need:
  • feeTier — the current trading fee tier (level + BPS). Cheap; the right shape for frequent polling of fee rates.
  • volumes — notional fill volume and fees paid over the fee-tier rolling window (14 days) and all-time. Backed by analytics storage; fetch on demand (e.g. a rewards/stats page).
Select sections with the include query parameter (e.g. include=feeTier); omitting it returns both. Fixed 24h / 7d / 30d windows are additionally available via the windows query parameter (e.g. windows=24h,7d,30d) and are returned under windowedStats. This endpoint always returns 200 — a brand-new address with no activity yields rollingVolume: 0 and tradingFeeTier at level 0 (Base). No authentication is required.

Query Parameters

address
string
required

Master Ethereum address for this API key (must match address from POST /createApiKey for the same key). Required on REST for account-scoped reads and for place/cancel. Invalid hex → 400; mismatch with key → 403.

20-byte EVM address as hex: optional 0x or 0X prefix and exactly 40 hexadecimal digits. API responses normalize to lowercase af after 0x.

Pattern: ^(0x|0X)?[0-9a-fA-F]{40}$
include
enum<string>[]

Comma-separated response sections to return. Omit for both (backward compatible). Excluding a section also skips its datastore reads server-side, so pass include=feeTier when polling fee rates and include=volumes when only the trading figures are needed.

Available options:
feeTier,
volumes
windows
enum<string>[]

Comma-separated fixed rolling windows to include under windowedStats (e.g. windows=24h,7d,30d). Omit to skip the windowed figures entirely. Independent of include.

Available options:
24h,
7d,
30d

Response

Account stats.

Account statistics for any Ethereum address. Always returns 200 — a fresh address with no activity yields rollingVolume: 0 and tradingFeeTier at level 0 (Base). Never 404s.

The response is sectioned via the include query parameter: the volume/fees fields belong to the volumes section and tradingFeeTier to the feeTier section. Omitting include returns both. When the volumes section is included, its four fields are always present (explicit 0 for a fresh address).

address
string
required

Lower-case 0x-prefixed 20-byte Ethereum address.

rollingVolume
integer<int64>

Notional fill volume over the fee-tier rolling window (14 days), in quote quantums (1e9 = $1). NOTE: this is the 14d fee-tier window — use lifetimeVolume for the all-time figure. Returns 0 if the rollup is temporarily unavailable; the endpoint degrades gracefully rather than failing. Omitted when include excludes the volumes section.

lifetimeVolume
integer<int64>

All-time perps notional fill volume, in quote quantums (1e9 = $1). Read from the hourly volume rollup. 0 if the rollup is temporarily unavailable. Omitted when include excludes the volumes section.

lifetimeFeesPaid
integer<int64>

All-time perps trading fees paid, in quote quantums (1e9 = $1). Read from the hourly fees/PnL rollup. 0 if the rollup is temporarily unavailable. Omitted when include excludes the volumes section.

rollingFeesPaid
integer<int64>

Perps trading fees paid over the fee-tier rolling window (14 days), in quote quantums (1e9 = $1). Same 14d window as rollingVolume. Read from the hourly fees rollup, so it can trail live fills by up to the current partial hour. 0 if the rollup is temporarily unavailable. Omitted when include excludes the volumes section.

windowedStats
object

Fixed-window (24h / 7d / 30d) volume/fees figures. Present only when the client opted in via the windows query parameter, and carries only the requested windows. Independent of include.

tradingFeeTier
object

The account's current trading fee tier (level + maker/taker BPS). Omitted when include excludes the feeTier section, or when the fee-tier store is unavailable.