Get asset activity overview

GET/v1/assets/{id}/overview

TSCScan API v1.0.0 · Assets · also at /api/v1/mainnet/assets/{id}/overview

Chain-dependent response; compact chain headers identify the serving snapshot.

Example

curl 'https://api.tensorcash.org/v1/assets/<id>/overview'

Parameters

NameInTypeRequiredDescription
idpathstringYesExact 64-character hexadecimal model or asset identifier; use the corresponding list to discover IDs.
min_heightqueryinteger—Optional minimum serving indexed height. Returns DATA_NOT_READY if no eligible source has reached it.

Responses

StatusDescriptionBody
200Successful read from one Indexer snapshot
400Invalid argument or page conditions
401Authentication required
403Permission denied
404Absent in a ready indexed range
409Verified chain continuity invalidation
422Bounded response would exceed byte budget
429Quota exceeded; Retry-After supplied
503Data or eligible source not ready
504Bounded upstream query timed out

Schemas

AssetOverviewResponse

FieldTypeRequiredDescription
dataAssetOverviewYesThe requested resource or collection; its schema is specific to this endpoint.

AssetOverview

Lifetime asset activity and current holder count. Events are asset/transaction pairs with unit movements, including mint, transfer and burn; counts are not token quantities.

FieldTypeRequiredDescription
totalintegerYesLifetime event total for this exact entity; equals the sum of series counts.
through_heightintegerYesIndexed canonical height covered by the full history.
bucket_sizeintegerYesNumber of block heights per interval, selected automatically to bound the series to at most 101 entries.
seriesRegistryHistoryBucket[]YesChronological activity-chart buckets for the selected window.
asset_idstringYesAsset identifier from the indexed protocol registration.
first_heightinteger | nullYesFirst indexed transaction height for this asset; null without unit movements.
last_heightinteger | nullYesLatest indexed transaction height for this asset; null without unit movements.
holder_countintegerYesCurrent addresses with a strictly positive balance of this asset; not a count of people.

RegistryHistoryBucket

Nonempty height bucket. Missing intervals have zero events.

FieldTypeRequiredDescription
from_heightintegerYesInclusive first block height of the interval.
to_heightintegerYesInclusive last block height, clipped to through_height for the newest interval.
countintegerYesCanonical model blocks or asset/transaction pairs in this interval, according to the resource.

Problem

FieldTypeRequiredDescription
typestringYesProblem type URI; about:blank is used for the current error family.
titlestringYesShort human-readable problem title, normally the stable error code.
statusintegerYesHTTP status code for this problem response.
code"INVALID_ARGUMENT" | "UNAUTHORIZED" | "FORBIDDEN" | "RESOURCE_NOT_FOUND" | "CHAIN_ANCHOR_INVALIDATED" | "RATE_LIMITED" | "DATA_NOT_READY" | "SERVICE_UNAVAILABLE" | "UPSTREAM_TIMEOUT" | "RESPONSE_TOO_LARGE" | "CORE_UNAVAILABLE" | "CORE_METHOD_UNAVAILABLE" | "CORE_DATA_NOT_READY" | "CORE_CAPACITY" | "TRANSACTION_CAPACITY" | "TRANSACTION_STATE_CHANGED" | "TRANSACTION_REJECTED" | "BROADCAST_OUTCOME_UNKNOWN" | "UNSUPPORTED_ASSET_POLICY"YesStable machine-readable error code; use this instead of matching message text.
request_idstringYesIdentifier also supplied in X-Request-ID; include it when reporting an error.
detailstring—Human-readable explanation of the error.
retry_after_secondsinteger—Suggested wait in seconds before retrying; where present, agrees with Retry-After.
Source
TSCScan public API v1.0.0 (12f98c5) · rHuhu · MIT