For the complete documentation index, see llms.txt. This page is also available as Markdown.

GET /stats/balance-distribution

Aggregate balance distribution

Aggregate balance distribution.

operationId: fetchBalanceDistribution

Not reachable through CCXT. Venue-wide analytics. CCXT models per-market data, not venue aggregates.

Authentication: none — this operation is public.

Account counts per collateral band, plus the total number of accounts the indexer holds a balance projection for.

Aggregate only. Bucket counts and a total — never a per-account balance, address or id. Reserved system accounts are excluded, so the counts are users rather than venue inventory.

network names the chain network this indexer serves and testnet is the same fact as a boolean, both derived from the instance's required auth.network configuration rather than asserted (ENG-12796). note is swapped by network rather than qualified: on a synthetic-funds network it states that balances are faucet-funded, that the projection is in-memory and resets on redeploy, and that the figures are not real funds; on mainnet it states the aggregation and the redeploy reset without those clauses. Never present a synthetic-funds figure as real funds.

Responses

Status
Body
Meaning

200

BalanceDistribution

Current aggregate distribution

Example

curl -X GET 'https://exchange.nexus.xyz/api/exchange/stats/balance-distribution'
import requests


response = requests.get("https://exchange.nexus.xyz/api/exchange/stats/balance-distribution")
response.raise_for_status()
print(response.json())
const response = await fetch("https://exchange.nexus.xyz/api/exchange/stats/balance-distribution", {
  method: "GET",
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
console.log(await response.json());

Generated from eng/apps/exchange/api/openapi.json (spec 0.9.36). Do not edit by hand — regenerate with python3 product/docs/tools/api-reference/generate.py. Hand-authored context lives in the Guides pages.

Last updated