Skip to main content
GET
Get supply-flow detail for a single token by symbol

Authorizations

x-api-key
string
header
required

Path Parameters

symbol
string
required

Token symbol (case-insensitive, e.g. USDT)

Query Parameters

canonicalId
string

Canonical override — pins the response to the row with this canonical id. Use for stable URLs on long-tail symbols that may collide later.

tokenType
enum<string>

Soft disambiguator when canonicalId is not supplied Backing mechanism derived by the pipeline from the upstream peg mechanism.

Available options:
fiat,
crypto,
synthetic,
other
chain
string

Chain of the exact contract to resolve (pair with address). Strongest disambiguator: send chain + address so a same-symbol, different-contract row is never returned.

address
string

Contract address of the exact deployment (pair with chain). When the feed does not track this contract separately, the response is { token: null, address_unmatched: true } (no flows) rather than another same-symbol contract's flows.

Response

Supply-flow row for the resolved token plus envelope. During total outage token is null and degraded is true.

token
object
required

null when degraded is true (total outage, no snapshot to resolve the symbol against) or when address_unmatched is true.

generated_at
string<date-time> | null
required
stale
boolean
required

true when the snapshot is older than 25h or served from the fallback cache during an upstream data outage.

degraded
boolean
required

true only during a total supply-pipeline outage (stale snapshot AND zero tokens). When true, token is null — retry later rather than treating the response as a permanent miss. Same field on SupplyListResponse.

address_unmatched
boolean

Present and true when chain + address was supplied but the feed does not track that exact contract. token is null and no flows are attributed, instead of returning another same-symbol contract's flows. Distinct from an outage (degraded).

collision
boolean

Present and true when the symbol matches more than one distinct token and no pin (canonicalId or chain + address) was supplied. token still resolves to the largest-supply row, but callers should disambiguate via candidates.

candidates
object[]

All same-symbol candidate rows when collision is true.