Sign in

v2

latestOpenAPI 3.1.02026-08-0513206146.6 KB
Metrics

Get Aggregate and Per-Chain Metrics

<Callout intent="warning"> The endpoints exposed here are currently in **Beta**! As we continue to build our initial offering, these endpoints may implement breaking changes. Be sure to check back for our change log regularly as a precaution. </Callout>

Returns aggregate and per-chain AUSD supply. A few response-shape details specific to this endpoint:

  • chainId is a CAIP-2 identifier. Real values include eip155:1 (Ethereum), eip155:137 (Polygon), solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp, and sui:mainnet. Use it to cross-reference with DeFi Llama, CoinGecko, or on-chain data.
  • Aggregates are omitted on partial responses. If one or more chains can't be reached, the response sets partial: true and omits the top-level totalSupply / circulatingSupply rather than publishing a silently-truncated figure. The omitted fields are absent — the keys are not present, not null — so guard with 'totalSupply' in response, not response.totalSupply != null. The chains[] array still includes every chain with a recent cached value.
  • Supply values are decimal strings (see the API overview for the precision convention). The plain-text variants /v0/metrics/total-supply and /v0/metrics/circulating-supply return a single decimal string when you don't need the per-chain breakdown.
get/v0/metrics

Response

Aggregate and per-chain AUSD supply breakdown. When one or more chains are temporarily unavailable, the response sets partial: true and omits aggregate totalSupply and circulatingSupply rather than publishing a silently-truncated figure.

circulatingSupplystring

Aggregate circulating AUSD supply across all chains, as a decimal string (e.g. 987654321.654321). This is the sum of all per-chain circulatingSupply values. Omitted when partial is true.

partialboolean required

True when one or more chains are missing from the response (cold start before a chain's first successful fetch, or a persistent chain outage). When true, aggregate totalSupply and circulatingSupply are omitted, since publishing a total that silently excludes chains would look like a large supply drop to market-data consumers.

totalSupplystring

Aggregate total AUSD supply across all chains, as a decimal string (e.g. 1234567890.123456). This is the sum of all per-chain totalSupply values. Omitted when partial is true.