Get work-weighted Pool statistics

GET/v1/stats/pool

TSCScan API v1.0.0 · Statistics · also at /api/v1/mainnet/stats/pool

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

Example

curl 'https://api.tensorcash.org/v1/stats/pool'

Parameters

NameInTypeRequiredDescription
min_heightqueryinteger—Optional minimum serving indexed height. Returns DATA_NOT_READY if no eligible source has reached it.
rangequery"12h" | "24h" | "48h" | "7d"—Existing TSCScan Pool ranges only.

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

PoolStatisticsResponse

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

PoolStatistics

Exact work-weighted Pool totals for a fixed recent range. Incomplete work yields null total and share fields; never infer zero or 1x.

FieldTypeRequiredDescription
range"12h" | "24h" | "48h" | "7d"YesSelected named time range; the supported values are endpoint-specific.
start_timeintegerYesStart of the selected time window in Unix seconds.
end_timeintegerYesEnd of the selected window in Unix seconds.
start_heightinteger | nullYesFirst inclusive canonical height represented by the window or candle.
end_heightintegerYesFinal inclusive canonical height represented by the window or candle.
observed_secondsintegerYesObserved timestamp span used as the work-rate denominator; zero cannot produce a valid rate.
total_blocksintegerYesTotal observed canonical blocks in the selected miner window.
active_minersintegerYesNumber of payout-address groups with observed blocks in the window.
unknown_blocksintegerYesObserved blocks lacking required indexed work evidence.
work_completebooleanYesWhether every block needed for this work calculation has exact indexed work.
base_work_completebooleanYesWhether every block in the window has indexed base work.
total_workstring | nullYesExact summed effective work in the selected window as a decimal string.
base_total_workstring | nullYesExact summed base work for the selected window, encoded as a decimal string.
known_work_shareWorkShare | nullYesFraction of work with indexed evidence; null means incomplete work. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places.
itemsPoolMiner[]YesResource items in the ordering specified by the endpoint.
remainderPoolRemainder | nullYesOther miner groups combined without losing their exact work/count totals.

WorkShare

Readable decimal string. Finite ratios retain all digits; only repeating decimals are rounded half away from zero to 12 places. Trailing zeroes are omitted. No floating-point intermediate is used.

Type: string

PoolMiner

FieldTypeRequiredDescription
addressstring | nullYesChain address text; null represents an unattributed output where allowed.
block_countintegerYesNumber of blocks represented by this resource or group.
base_workstring | nullYesExact target-derived work before Proof pricing, encoded as a decimal string.
effective_workstring | nullYesExact Proof-priced work as a decimal string; null when required evidence is unavailable.
work_shareWorkShare | nullYesFraction of total effective work, e.g. '0.25' means 25%; null means incomplete work. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places.
last_heightintegerYesLast height represented by this group or series.
last_timeintegerYesUnix timestamp of this miner group's latest observed block.
average_price_multiplierAveragePriceRatio | nullYesMean protocol Proof price multiplier for this block or work window; null means unavailable. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places.

AveragePriceRatio

Readable decimal string. Finite ratios retain all digits; only repeating decimals are rounded half away from zero to 12 places. Trailing zeroes are omitted. No floating-point intermediate is used.

Type: string

PoolRemainder

Combined remainder when more than 100 miner groups are in the range.

FieldTypeRequiredDescription
group_countintegerYesNumber of miner groups combined into the remainder.
block_countintegerYesNumber of blocks represented by this resource or group.
base_workstring | nullYesExact target-derived work before Proof pricing, encoded as a decimal string.
effective_workstring | nullYesExact Proof-priced work as a decimal string; null when required evidence is unavailable.
work_shareWorkShare | nullYesFraction of total effective work, e.g. '0.25' means 25%; null means incomplete work. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places.

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