Get address summary

GET/v1/addresses/{address}/summary

TSCScan API v1.0.0 · Addresses · also at /api/v1/mainnet/addresses/{address}/summary

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

Example

curl 'https://api.tensorcash.org/v1/addresses/tc1qmvalge7mnhct9qj5uua8rn0dmjcyh6fmvrr46j/summary'

Name	In	Type	Required	Description
`address`	path	`string`	Yes	Exact TensorCash address on the selected network; aliases are not accepted here.
`min_height`	query	`integer`	—	Optional minimum serving indexed height. Returns DATA_NOT_READY if no eligible source has reached it.

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

Field	Type	Required	Description
`data`	`AddressSummary`	Yes	The requested resource or collection; its schema is specific to this endpoint.

Field	Type	Required	Description
`address`	`string`	Yes	Chain address text; null represents an unattributed output where allowed.
`alias`	`string \| null`	—	Public address label, or null when the address has no label.
`balance`	`Amount`	Yes	Exact current confirmed balance in the declared smallest units.
`received`	`Amount`	Yes	Exact quantity received by this address in smallest units.
`sent`	`Amount`	Yes	Exact quantity spent by this address in smallest units.
`mempool_effect`	`Amount`	—	Exact net effect of currently observed pending activity, or unknown when prevouts/observation are incomplete.
`rank`	`integer`	Yes	One-based current rank by confirmed balance; equal balances share a rank where specified.
`transaction_count`	`integer`	Yes	Exact number of confirmed transactions/activities represented by this resource; pending activity is excluded unless explicitly stated.
`pending_tx_count`	`integer \| null`	—	Number of observed pending transactions affecting the address; null when the pending projection is unavailable.
`supply_share`	`string \| null`	Yes	Fraction of indexed native supply owned by this address, e.g. '0.01' means 1%; null when indexed supply is zero.
`first_activity`	`object \| null`	Yes	First confirmed address activity height and timestamp; null when none exists.
`last_activity`	`object \| null`	Yes	Latest confirmed address activity height and timestamp; null when none exists.

Exact smallest-unit decimal. Known zero is units '0'.

Field	Type	Required	Description
`units`	`string`	Yes	Exact decimal string in smallest units; signed where the schema permits. Divide by 10^precision only for display.
`precision`	`integer`	Yes	Decimal places for the smallest-unit amount. TSC uses 8; assets use their indexed precision.

Field	Type	Required	Description
`state`	`"unknown"`	Yes	Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero.
`units`	`null`	Yes	Exact decimal string in smallest units; signed where the schema permits. Divide by 10^precision only for display.
`precision`	`integer \| null`	Yes	Decimal places for the smallest-unit amount. TSC uses 8; assets use their indexed precision.

Field	Type	Required	Description
`state`	`"unavailable"`	Yes	Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero.
`units`	`null`	Yes	Exact decimal string in smallest units; signed where the schema permits. Divide by 10^precision only for display.
`precision`	`integer \| null`	Yes	Decimal places for the smallest-unit amount. TSC uses 8; assets use their indexed precision.

Field	Type	Required	Description
`type`	`string`	Yes	Problem type URI; about:blank is used for the current error family.
`title`	`string`	Yes	Short human-readable problem title, normally the stable error code.
`status`	`integer`	Yes	HTTP 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"`	Yes	Stable machine-readable error code; use this instead of matching message text.
`request_id`	`string`	Yes	Identifier also supplied in X-Request-ID; include it when reporting an error.
`detail`	`string`	—	Human-readable explanation of the error.
`retry_after_seconds`	`integer`	—	Suggested wait in seconds before retrying; where present, agrees with Retry-After.