TensorCash
TSC WalletJoin

Choose a language

Read bounded address balances

POST/v1/addresses/balances

TSCScan API v1.0.0 · Addresses · also at /api/v1/mainnet/addresses/balances

Read 1–50 unique address balances in one snapshot. No API key is required. Send application/json.

Example

curl -X POST 'https://api.tensorcash.org/v1/addresses/balances' \
  -H 'Content-Type: application/json' \
  --data '{"addresses":["tc1qmvalge7mnhct9qj5uua8rn0dmjcyh6fmvrr46j"]}'

Parameters

NameInTypeRequiredDescription
min_heightqueryinteger—Optional minimum serving indexed height. Returns DATA_NOT_READY if no eligible source has reached it.

Request body

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

AddressBalanceBatchRequest

FieldTypeRequiredDescription
addressesstring[]YesRequested addresses or address-module availability, as specified by this schema.

AddressBalanceBatchResponse

FieldTypeRequiredDescription
dataAddressBalance[]YesThe requested resource or collection; its schema is specific to this endpoint.

AddressBalance

FieldTypeRequiredDescription
addressstringYesChain address text; null represents an unattributed output where allowed.
confirmed_balanceAmountYesExact confirmed address balance; pending transactions are excluded.
mempool_effectAmountYesExact net effect of currently observed pending activity, or unknown when prevouts/observation are incomplete.

KnownAmount

FieldTypeRequiredDescription
unitsstringYesExact decimal string in smallest units; signed where the schema permits. Divide by 10^precision only for display.
precisionintegerYesDecimal places for the smallest-unit amount. TSC uses 8; assets use their indexed precision.

UnknownAmount

FieldTypeRequiredDescription
state"unknown"YesAvailability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero.
unitsnullYesExact decimal string in smallest units; signed where the schema permits. Divide by 10^precision only for display.
precisioninteger | nullYesDecimal places for the smallest-unit amount. TSC uses 8; assets use their indexed precision.

UnavailableAmount

FieldTypeRequiredDescription
state"unavailable"YesAvailability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero.
unitsnullYesExact decimal string in smallest units; signed where the schema permits. Divide by 10^precision only for display.
precisioninteger | nullYesDecimal places for the smallest-unit amount. TSC uses 8; assets use their indexed precision.

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