{ "openapi": "3.1.1", "info": { "title": "TSCScan Public API", "version": "1.0.0", "description": "Use /v1 resources on the selected network's API host. The host determines mainnet or testnet; there is no network path or query parameter. Community read and non-custodial transaction API for mainnet and testnet. No API key is required. Dynamic reads use no-store. Default page 25, maximum 100, address batch maximum 50. The mempool feed returns the entire observed pool without pagination; other reads have a 1 MiB response budget. Integer amounts use decimal strings and explicit precision. Coverage is reported by status/capabilities; incomplete modules return DATA_NOT_READY. Proof multipliers, work rates, shares and average intervals are readable decimal strings, finite values remain exact and only repeating decimals are rounded half away from zero to 12 places. Money and asset quantities remain exact smallest-unit strings with precision. Known values omit the redundant state marker; unknown/unavailable values and meaningful lifecycle states remain explicit. On api.tensorcash.org the /v1 resources are mainnet and are also served under /api/v1/mainnet.", "x-tensorcash-source": { "product": "TSCScan public API", "author": "rHuhu", "license": "MIT", "homepage": "https://tscscan.xyz", "repository": "rHuhu/tscscan (git.tensorcash.org)", "tag": "v1.0.0", "commit": "12f98c54f6dfb5d2d15c60cc0a0f958beebc35a1", "file": "docs/site/openapi.json", "sha256": "d75997cd83e7b760c1276bd2104b83a2df303d7a913ed60fe2135bc3eee55cac", "filtered_by": { "file": "scripts/api-docs/nginx-api-server.conf", "sha256": "2a7dc40dd1ae885832e00337a0f5736f7a01fad8e2f399c6c869b967424d6b9f" }, "upstream_operations": 71, "published_operations": 53, "removed": [ { "method": "POST", "path": "/v1/wallet/overview", "reason": "404: TSCScan wallet-development route, not public on this host" }, { "method": "POST", "path": "/v1/transactions/test", "reason": "404: TSCScan wallet-development route, not public on this host" }, { "method": "GET", "path": "/v1/addresses/{address}/utxos", "reason": "404: TSCScan wallet-development route, not public on this host" }, { "method": "GET", "path": "/v1/blocks/height/{height}", "reason": "404: TSCScan wallet-development route, not public on this host" }, { "method": "GET", "path": "/v1/transactions/{txid}/raw", "reason": "404: TSCScan wallet-development route, not public on this host" }, { "method": "GET", "path": "/v1/fees/estimate", "reason": "404: TSCScan wallet-development route, not public on this host" }, { "method": "POST", "path": "/v1/transactions/broadcast", "reason": "405: write method; the host is read-only apart from four POST routes" }, { "method": "POST", "path": "/v1/assets/create", "reason": "405: write method; the host is read-only apart from four POST routes" }, { "method": "POST", "path": "/v1/assets/mint", "reason": "405: write method; the host is read-only apart from four POST routes" }, { "method": "POST", "path": "/v1/assets/burn", "reason": "405: write method; the host is read-only apart from four POST routes" }, { "method": "POST", "path": "/v1/assets/transfer", "reason": "405: write method; the host is read-only apart from four POST routes" }, { "method": "POST", "path": "/v1/assets/redeem", "reason": "405: write method; the host is read-only apart from four POST routes" }, { "method": "POST", "path": "/v1/models/register", "reason": "405: write method; the host is read-only apart from four POST routes" }, { "method": "POST", "path": "/v1/models/commit", "reason": "405: write method; the host is read-only apart from four POST routes" }, { "method": "POST", "path": "/v1/models/reclaim", "reason": "405: write method; the host is read-only apart from four POST routes" }, { "method": "POST", "path": "/v1/models/burn", "reason": "405: write method; the host is read-only apart from four POST routes" }, { "method": "POST", "path": "/v1/models/challenge", "reason": "405: write method; the host is read-only apart from four POST routes" }, { "method": "POST", "path": "/v1/models/challenge-commit", "reason": "405: write method; the host is read-only apart from four POST routes" } ] } }, "servers": [ { "url": "https://api.tensorcash.org", "description": "TensorCash mainnet chain API" } ], "paths": { "/v1/status": { "get": { "operationId": "Getnetworkstatus", "summary": "Get network status", "parameters": [], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Network" ] } }, "/v1/capabilities": { "get": { "operationId": "Getcapabilities", "summary": "Get capabilities", "parameters": [], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapabilitiesResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Network" ] } }, "/v1/blocks": { "get": { "operationId": "Listblocks", "summary": "List blocks", "parameters": [ { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockSummaryPage" }, "example": { "data": [ { "height": 123456, "hash": "0000000000000000000000000000000000000000000000000000000000000001", "time": 1790640000, "tx_count": 12, "size_bytes": 1024, "difficulty": "1.234567890123456789", "proof": { "version": 4, "price_multiplier": "2" }, "miner_address": "tc1qexample", "miner_reward": { "units": "5000000000", "precision": 8 } } ], "page": { "number": 1, "total": 123457, "total_pages": 4939, "limit": 25 } } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Blocks" ] } }, "/v1/stats/chain": { "get": { "operationId": "Getchainstatistics", "summary": "Get chain statistics", "parameters": [ { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChainStatisticsResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Statistics" ] } }, "/v1/stats/proof": { "get": { "operationId": "GetProofpricestatistics", "summary": "Get Proof price statistics", "parameters": [ { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProofStatisticsResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Statistics" ] } }, "/v1/stats/miners": { "get": { "operationId": "Getrecentminerblockdistribution", "summary": "Get recent miner block distribution", "parameters": [ { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/BlocksWindow" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MinerStatisticsResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Statistics" ] } }, "/v1/stats/pool": { "get": { "operationId": "Getwork-weightedPoolstatistics", "summary": "Get work-weighted Pool statistics", "parameters": [ { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/PoolRange" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoolStatisticsResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Statistics" ] } }, "/v1/stats/mining": { "get": { "operationId": "Getexactfixed-windowminingstatistics", "summary": "Get exact fixed-window mining statistics", "parameters": [ { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MiningStatisticsResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Statistics" ] } }, "/v1/stats/mining/series": { "get": { "operationId": "Getboundedexactminingchartseries", "summary": "Get bounded exact mining chart series", "parameters": [ { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/MiningSeriesRange" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MiningSeriesResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Statistics" ] } }, "/v1/stats/reward": { "get": { "operationId": "GetexactTensorCashsubsidyepoch", "summary": "Get exact TensorCash subsidy epoch", "parameters": [ { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RewardStatisticsResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Statistics" ] } }, "/v1/mempool/summary": { "get": { "operationId": "Getnetwork-localmempoolobservation", "summary": "Get network-local mempool observation", "parameters": [ { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MempoolSummaryResponse" }, "example": { "data": { "state": "available", "transactions": 3, "bytes": 1000, "observed_at_unix": 1790640000 } } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Network-local, independently timed Core mempool observation with canonical snapshot headers. API response cache has a maximum 500 ms lifetime and verified chain-source checks. Failed or stale observation returns state unavailable with null values, while a real empty mempool returns available with zeros.", "tags": [ "Mempool" ] } }, "/v1/mempool/feed": { "get": { "operationId": "Getcompletenetwork-localmempool", "summary": "Get complete network-local mempool", "parameters": [ { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MempoolFeedResponse" }, "example": { "data": { "state": "available", "observed_at_unix": 1790640000, "transactions": 1, "items": [ { "txid": "0000000000000000000000000000000000000000000000000000000000000001", "time": 1790640000, "vsize": 200, "total_output": { "units": "175000000", "precision": 8 } } ] } } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Complete network-local Core observation, refreshed every five seconds, newest first. Every observed ID is returned without pagination. Missing total output is unavailable, never zero. Failed or stale observation is unavailable with null data. API response cache has a maximum 500 ms lifetime when the complete feed fits the cache item budget; oversized feeds bypass it without truncation. This feed is separate from confirmed history.", "tags": [ "Mempool" ] } }, "/v1/transactions": { "get": { "operationId": "Listrecenttransactions", "summary": "List recent transactions", "parameters": [ { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/TransactionKind" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecentTransactionPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Transactions" ] } }, "/v1/addresses": { "get": { "operationId": "Listfundedaddresses", "summary": "List funded addresses", "parameters": [ { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundedAddressPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Current funded-address ranking by exact descending balance and ascending address. Each row contains confirmed activity count and latest activity, plus nullable signed rolling 7/30-day net flows. Null means no activity in that window; known zero means activity netted to zero. Numbered pages use the current indexed chain state. Numbered pages and first pages can advance from a valid canonical ancestor; summary contains their current funded count and supply. Only limit, page and min_height are accepted. Chart distribution and optional Market conversion are separate reads.", "tags": [ "Addresses" ] } }, "/v1/blocks/{hash}": { "get": { "operationId": "Getblock", "summary": "Get block", "parameters": [ { "$ref": "#/components/parameters/Hash" }, { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockDetailResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Blocks" ] } }, "/v1/blocks/{hash}/transactions": { "get": { "operationId": "Listblocktransactions", "summary": "List block transactions", "parameters": [ { "$ref": "#/components/parameters/Hash" }, { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockTransactionPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Blocks" ] } }, "/v1/blocks/{hash}/proof": { "get": { "operationId": "Getblockproof", "summary": "Get block proof", "parameters": [ { "$ref": "#/components/parameters/Hash" }, { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProofResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Blocks" ] } }, "/v1/transactions/{txid}": { "get": { "operationId": "Gettransaction", "summary": "Get transaction", "parameters": [ { "$ref": "#/components/parameters/Txid" }, { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetailResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Transactions" ] } }, "/v1/transactions/{txid}/inputs": { "get": { "operationId": "Listtransactioninputs", "summary": "List transaction inputs", "parameters": [ { "$ref": "#/components/parameters/Txid" }, { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InputSummaryPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Transactions" ] } }, "/v1/transactions/{txid}/outputs": { "get": { "operationId": "Listtransactionoutputs", "summary": "List transaction outputs", "parameters": [ { "$ref": "#/components/parameters/Txid" }, { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputSummaryPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Transactions" ] } }, "/v1/addresses/{address}/balance": { "get": { "operationId": "Getaddressbalance", "summary": "Get address balance", "parameters": [ { "$ref": "#/components/parameters/Address" }, { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressBalanceResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Addresses" ] } }, "/v1/addresses/{address}/transactions": { "get": { "operationId": "Listaddresstransactions", "summary": "List address transactions", "parameters": [ { "$ref": "#/components/parameters/Address" }, { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressActivityPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Addresses" ] } }, "/v1/addresses/{address}/summary": { "get": { "operationId": "Getaddresssummary", "summary": "Get address summary", "parameters": [ { "$ref": "#/components/parameters/Address" }, { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressSummaryResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Addresses" ] } }, "/v1/addresses/{address}/balance-history": { "get": { "operationId": "Getaddressbalancehistory", "summary": "Get address balance history", "parameters": [ { "$ref": "#/components/parameters/Address" }, { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceHistoryResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Addresses" ] } }, "/v1/addresses/aliases": { "get": { "operationId": "Getpublicaddresslabels", "summary": "Get public address labels", "parameters": [ { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressAliasesResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Addresses" ] } }, "/v1/mempool/transactions/{txid}": { "get": { "operationId": "Getpendingtransaction", "summary": "Get pending transaction", "parameters": [ { "$ref": "#/components/parameters/Txid" }, { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetailResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Mempool" ] } }, "/v1/mempool/transactions/{txid}/inputs": { "get": { "operationId": "Listpendinginputs", "summary": "List pending inputs", "parameters": [ { "$ref": "#/components/parameters/Txid" }, { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InputSummaryPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Mempool" ] } }, "/v1/mempool/transactions/{txid}/outputs": { "get": { "operationId": "Listpendingoutputs", "summary": "List pending outputs", "parameters": [ { "$ref": "#/components/parameters/Txid" }, { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputSummaryPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Mempool" ] } }, "/v1/mempool/addresses/{address}/transactions": { "get": { "operationId": "Listpendingaddressactivity", "summary": "List pending address activity", "parameters": [ { "$ref": "#/components/parameters/Address" }, { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PendingAddressActivityPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Mempool" ] } }, "/v1/stats/activity": { "get": { "operationId": "Getconfirmedactivitystatistics", "summary": "Get confirmed activity statistics", "parameters": [ { "$ref": "#/components/parameters/MinHeight" }, { "name": "range", "in": "query", "schema": { "type": "string", "enum": [ "24h", "7d", "30d" ], "default": "24h" }, "description": "Requested time window; defaults to 24h." } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityStatisticsResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Statistics" ] } }, "/v1/stats/large-transfers": { "get": { "operationId": "Listconfirmedwhaletransfers", "summary": "List confirmed whale transfers", "parameters": [ { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" }, { "name": "range", "in": "query", "schema": { "type": "string", "enum": [ "24h", "7d", "30d" ], "default": "24h" }, "description": "Requested time window; defaults to 24h." } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LargeTransferPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Statistics" ] } }, "/v1/stats/mining/history": { "get": { "operationId": "Listdailymininghistory", "summary": "List daily mining history", "parameters": [ { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MiningDayPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Statistics" ] } }, "/v1/addresses/{address}/assets": { "get": { "operationId": "Listpositiveaddressassetholdings", "summary": "List positive address asset holdings", "parameters": [ { "$ref": "#/components/parameters/Address" }, { "$ref": "#/components/parameters/HeldAssetId" }, { "$ref": "#/components/parameters/HeldAssetSearch" }, { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressAssetPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Addresses" ] } }, "/v1/stats/registries": { "get": { "operationId": "Getregistryoverview", "summary": "Get registry overview", "parameters": [ { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistryOverviewResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Statistics" ] } }, "/v1/models/{id}/production": { "get": { "operationId": "Getlifetimemodelblockproduction", "summary": "Get lifetime model block production", "parameters": [ { "$ref": "#/components/parameters/Id" }, { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelProductionResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Models" ] } }, "/v1/assets/{id}/overview": { "get": { "operationId": "Getassetactivityoverview", "summary": "Get asset activity overview", "parameters": [ { "$ref": "#/components/parameters/Id" }, { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetOverviewResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Assets" ] } }, "/v1/models": { "get": { "operationId": "Listmodels", "summary": "List models", "parameters": [ { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelSummaryPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Models" ] } }, "/v1/models/{id}": { "get": { "operationId": "Getmodel", "summary": "Get model", "parameters": [ { "$ref": "#/components/parameters/Id" }, { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelDetailResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Models" ] } }, "/v1/models/{id}/events": { "get": { "operationId": "Listmodelevents", "summary": "List model events", "parameters": [ { "$ref": "#/components/parameters/Id" }, { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelEventPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Models" ] } }, "/v1/models/{id}/blocks": { "get": { "operationId": "Listblocksproducedwiththismodel", "summary": "List blocks produced with this model", "parameters": [ { "$ref": "#/components/parameters/Id" }, { "$ref": "#/components/parameters/FromHeight" }, { "$ref": "#/components/parameters/ToHeight" }, { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelBlockPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Models" ] } }, "/v1/assets/{id}/supply": { "get": { "operationId": "Getexactassetsupply", "summary": "Get exact asset supply", "parameters": [ { "$ref": "#/components/parameters/Id" }, { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetSupplyResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Assets" ] } }, "/v1/assets/{id}/policy": { "get": { "operationId": "Getpublicassetregistrationrules", "summary": "Get public asset registration rules", "parameters": [ { "$ref": "#/components/parameters/Id" }, { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetPolicyResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Assets" ] } }, "/v1/assets/{id}/document": { "get": { "operationId": "Readcommittedpublicissuerdocument", "summary": "Read committed public issuer document", "parameters": [ { "$ref": "#/components/parameters/Id" }, { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDocumentResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Assets" ] } }, "/v1/assets/{id}/children": { "get": { "operationId": "Listregisteredchildassets", "summary": "List registered child assets", "parameters": [ { "$ref": "#/components/parameters/Id" }, { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetSummaryPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Assets" ] } }, "/v1/assets/{id}/activity": { "get": { "operationId": "Listissuance,transferandburntransactions", "summary": "List issuance, transfer and burn transactions", "parameters": [ { "$ref": "#/components/parameters/Id" }, { "$ref": "#/components/parameters/FromHeight" }, { "$ref": "#/components/parameters/ToHeight" }, { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetActivityPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Assets" ] } }, "/v1/assets": { "get": { "operationId": "Listassets", "summary": "List assets", "parameters": [ { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetSummaryPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Assets" ] } }, "/v1/assets/{id}": { "get": { "operationId": "Getasset", "summary": "Get asset", "parameters": [ { "$ref": "#/components/parameters/Id" }, { "$ref": "#/components/parameters/MinHeight" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDetailResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Assets" ] } }, "/v1/assets/{id}/transfers": { "get": { "operationId": "Listassettransfers", "summary": "List asset transfers", "parameters": [ { "$ref": "#/components/parameters/Id" }, { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetTransferPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Assets" ] } }, "/v1/assets/{id}/holders": { "get": { "operationId": "Listassetholders", "summary": "List asset holders", "parameters": [ { "$ref": "#/components/parameters/Id" }, { "$ref": "#/components/parameters/MinHeight" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Page" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." }, "X-Cache-Status": { "schema": { "type": "string", "enum": [ "hit", "miss", "bypass" ] }, "description": "Whether the API's in-memory projection cache was used." }, "Server-Timing": { "schema": { "type": "string", "maxLength": 256 }, "description": "API, internal call, Indexer DB-path, cache, and JSON serialization wall times in milliseconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetHolderPage" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "description": "Chain-dependent response; compact chain headers identify the serving snapshot.", "tags": [ "Assets" ] } }, "/v1/addresses/balances": { "post": { "operationId": "BatchAddressBalances", "summary": "Read bounded address balances", "parameters": [ { "$ref": "#/components/parameters/MinHeight" } ], "security": [], "description": "Read 1–50 unique address balances in one snapshot. No API key is required. Send application/json.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressBalanceBatchRequest" } } } }, "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressBalanceBatchResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Addresses" ] } }, "/v1/network/overview": { "get": { "operationId": "Getnetworkoverview", "summary": "Get network overview", "description": "One bounded indexed snapshot, at most 51 block rows. Shared cached payload, 500 ms maximum age, invalidated by committed tip/reorg changes. Equivalent concurrent misses coalesce. Market refresh runs independently. No query parameters.", "security": [], "parameters": [], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkOverviewResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Network" ] } }, "/v1/transactions/{txid}/status": { "get": { "operationId": "Getlivetransactionstatus", "summary": "Get live transaction status", "description": "Indexed confirmed transactions reuse compact inclusion metadata for at most 300 seconds within configured cache budgets; confirmations are derived from the latest verified indexed checkpoint identified by optional X-Chain-Height/X-Chain-Hash headers. After a rollback, reuse requires the inclusion height to survive every intervening bounded rollback fence; fork suffixes, missing/pruned history, rebuild gaps, restart/routing changes and unhealthy probes revoke reuse. Read-only requests may wait within the configured original-request recovery grace; mutations are never retried. An indexed miss falls back to live Core mempool then confirmed txindex without waiting for indexing; Core results omit indexed chain headers and are cached at most 500 ms. Core failure, blocks behind known headers, initial block download or unsynchronized txindex returns 503, never false not_found.", "security": [], "parameters": [ { "$ref": "#/components/parameters/Txid" } ], "responses": { "200": { "description": "Successful read from one Indexer snapshot", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 }, "description": "Request identifier for diagnostics." }, "X-Chain-Height": { "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Indexed height of the actual serving snapshot." }, "X-Chain-Hash": { "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Canonical hash at the serving indexed height." }, "X-Network-Generation": { "schema": { "type": "string", "maxLength": 128 }, "description": "Dataset generation; never combine pages from different generations." }, "Cache-Control": { "schema": { "const": "no-store" }, "description": "Responses are not stored by browser/intermediary caches." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStateResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Transactions" ] } }, "/health/live": { "get": { "operationId": "GetApiLiveness", "summary": "Get API liveness", "description": "Process liveness only; use network status for data readiness.", "parameters": [], "responses": { "200": { "description": "Successful control or status response", "headers": { "X-Request-ID": { "schema": { "type": "string", "maxLength": 128 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveResponse" }, "example": { "live": true } } } } }, "tags": [ "Health" ] } } }, "components": { "parameters": { "Address": { "name": "address", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9]{1,256}$", "maxLength": 256 }, "description": "Exact TensorCash address on the selected network; aliases are not accepted here." }, "BlocksWindow": { "name": "blocks", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 300, "default": 100 }, "description": "Recent canonical block window; default 100, maximum 300.", "required": false }, "FromHeight": { "name": "from_height", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Inclusive lower block height, default zero. Preserve when changing page.", "required": false }, "Hash": { "name": "hash", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Exact 64-character hexadecimal canonical block hash." }, "HeldAssetId": { "name": "asset_id", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Select one exact asset held by this address. Omit to list all positive asset holdings. Retain when changing page.", "required": false }, "HeldAssetSearch": { "name": "q", "in": "query", "schema": { "type": "string", "maxLength": 256 }, "description": "Case-insensitive literal substring of a held asset ticker. Searches all holdings of this address. Retain when changing page.", "required": false }, "Id": { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Exact 64-character hexadecimal model or asset identifier; use the corresponding list to discover IDs." }, "Limit": { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 }, "description": "Default 25; server may apply a smaller resource cap.", "required": false }, "MinHeight": { "name": "min_height", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "required": false, "description": "Optional minimum serving indexed height. Returns DATA_NOT_READY if no eligible source has reached it." }, "MiningSeriesRange": { "name": "range", "in": "query", "schema": { "type": "string", "enum": [ "24h", "7d", "30d", "all" ], "default": "24h" }, "description": "Existing TSCScan Home chart ranges only.", "required": false }, "Page": { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 9223372036854776000, "default": 1 }, "description": "One-based page number, default 1. Responses include number, limit, total and total_pages. Preserve the filters and limit when changing page." }, "PoolRange": { "name": "range", "in": "query", "schema": { "type": "string", "enum": [ "12h", "24h", "48h", "7d" ], "default": "24h" }, "description": "Existing TSCScan Pool ranges only.", "required": false }, "ToHeight": { "name": "to_height", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "description": "Inclusive upper block height, default serving indexed tip. Must not be below from_height. Preserve when changing page.", "required": false }, "TransactionKind": { "name": "kind", "in": "query", "schema": { "type": "string", "enum": [ "all", "transfer", "reward" ], "default": "all" }, "description": "Confirmed transaction type; reward is coinbase and transfer is non-coinbase.", "required": false }, "Txid": { "name": "txid", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, "description": "Exact 64-character hexadecimal transaction ID." } }, "responses": { "Error400": { "description": "Invalid argument or page conditions", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Error401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Error403": { "description": "Permission denied", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Error404": { "description": "Absent in a ready indexed range", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Error409": { "description": "Verified chain continuity invalidation", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Error422": { "description": "Bounded response would exceed byte budget", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Error429": { "description": "Quota exceeded; Retry-After supplied", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 }, "description": "Seconds until a retry is reasonable." } } }, "Error503": { "description": "Data or eligible source not ready", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Error504": { "description": "Bounded upstream query timed out", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "schemas": { "ActivityPoint": { "type": "object", "required": [ "blocks", "transactions", "transfers", "output_units", "fee_units" ], "properties": { "blocks": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of blocks, or block-module availability/coverage, as specified by the enclosing schema." }, "transactions": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Complete observed mempool count, confirmed transaction count or transaction-module availability/coverage, according to this schema." }, "transfers": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of confirmed non-coinbase transactions in the selected activity bucket/window." }, "output_units": { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80, "description": "Exact sum of confirmed non-coinbase outputs in TSC smallest units." }, "fee_units": { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80, "description": "Exact sum of confirmed non-coinbase fees in TSC smallest units." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." } }, "additionalProperties": false }, "ActivityStatistics": { "type": "object", "required": [ "range", "start_time", "end_time", "bucket_seconds", "coverage_start_time", "current", "previous", "active_addresses", "produced_units", "produced_blocks", "series" ], "properties": { "range": { "type": "string", "enum": [ "24h", "7d", "30d" ], "description": "Selected named time range; the supported values are endpoint-specific." }, "start_time": { "type": "integer", "minimum": -9223372036854776000, "maximum": 9223372036854776000, "description": "Start of the selected time window in Unix seconds." }, "end_time": { "type": "integer", "minimum": -9223372036854776000, "maximum": 9223372036854776000, "description": "End of the selected window in Unix seconds." }, "coverage_start_time": { "type": "integer", "minimum": -9223372036854776000, "maximum": 9223372036854776000, "description": "Timestamp of the first canonical indexed block, in Unix seconds." }, "bucket_seconds": { "type": "integer", "minimum": 1, "maximum": 9223372036854776000, "description": "Duration in seconds of each activity-chart bucket." }, "current": { "$ref": "#/components/schemas/ActivityTotals", "description": "Totals for the selected current activity window." }, "previous": { "oneOf": [ { "$ref": "#/components/schemas/ActivityTotals" }, { "type": "null" } ], "description": "Totals for the preceding equal-length activity window, or null when unavailable." }, "active_addresses": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Distinct addresses with confirmed activity in the selected period." }, "produced_units": { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80, "description": "Exact cumulative base subsidy issuance in TSC smallest units." }, "produced_blocks": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of canonical blocks used to calculate cumulative subsidy issuance." }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityPoint" }, "maxItems": 1500, "description": "Chronological activity-chart buckets for the selected window." } }, "additionalProperties": false }, "ActivityStatisticsResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ActivityStatistics", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "ActivityTotals": { "type": "object", "required": [ "blocks", "transactions", "transfers", "output_units", "fee_units" ], "properties": { "blocks": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of blocks, or block-module availability/coverage, as specified by the enclosing schema." }, "transactions": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Complete observed mempool count, confirmed transaction count or transaction-module availability/coverage, according to this schema." }, "transfers": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of confirmed non-coinbase transactions in the selected activity bucket/window." }, "output_units": { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80, "description": "Exact sum of confirmed non-coinbase outputs in TSC smallest units." }, "fee_units": { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80, "description": "Exact sum of confirmed non-coinbase fees in TSC smallest units." } }, "additionalProperties": false }, "AddressActivity": { "type": "object", "required": [ "txid", "block_height", "block_hash", "position", "delta" ], "properties": { "txid": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal transaction ID; searches accept either case." }, "block_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based height of the containing canonical block; null for pending activity where allowed." }, "block_hash": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "Hash of the containing canonical block." }, "position": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based transaction position in its containing block." }, "delta": { "$ref": "#/components/schemas/Amount", "description": "Signed received-minus-sent quantity in smallest units." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." }, "is_coinbase": { "type": "boolean", "description": "Whether this transaction or input is a coinbase reward." }, "fee": { "$ref": "#/components/schemas/Amount", "description": "Exact input total minus output total; null for coinbase where specified, otherwise unknown if prevouts are unavailable." }, "received": { "$ref": "#/components/schemas/Amount", "description": "Exact quantity received by this address in smallest units." }, "sent": { "$ref": "#/components/schemas/Amount", "description": "Exact quantity spent by this address in smallest units." }, "from_addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AddressFlow" }, "maxItems": 2, "description": "At most two source-address summaries; the current address is shown first when present." }, "to_addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AddressFlow" }, "maxItems": 2, "description": "At most two destination-address summaries; the current address is shown first when present." }, "from_address_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of distinct attributed source addresses, including those omitted from the compact summary." }, "to_address_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of distinct attributed destination addresses, including those omitted from the compact summary." } }, "additionalProperties": false, "description": "Historical membership and delta; no changing balance or confirmation count." }, "AddressActivityPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AddressActivity" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "AddressAliases": { "type": "object", "required": [ "aliases" ], "properties": { "aliases": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 256 }, "description": "Map from chain address to its public label." } }, "additionalProperties": false }, "AddressAliasesResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AddressAliases", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "AddressAsset": { "type": "object", "required": [ "asset_id", "balance", "symbol", "parent_id" ], "properties": { "asset_id": { "type": "string", "maxLength": 128, "description": "Asset identifier from the indexed protocol registration." }, "balance": { "$ref": "#/components/schemas/Amount", "description": "Exact current confirmed balance in the declared smallest units." }, "parent_id": { "$ref": "#/components/schemas/ObservedOptionalId", "description": "Root asset identifier for a child; state none for a root asset." }, "symbol": { "$ref": "#/components/schemas/ObservedField", "description": "Observed asset ticker; unsupported or unavailable states are explicit." } }, "additionalProperties": false }, "AddressAssetPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AddressAsset" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "AddressBalance": { "type": "object", "required": [ "address", "confirmed_balance", "mempool_effect" ], "properties": { "address": { "type": "string", "maxLength": 256, "description": "Chain address text; null represents an unattributed output where allowed." }, "confirmed_balance": { "$ref": "#/components/schemas/Amount", "description": "Exact confirmed address balance; pending transactions are excluded." }, "mempool_effect": { "$ref": "#/components/schemas/Amount", "description": "Exact net effect of currently observed pending activity, or unknown when prevouts/observation are incomplete." } }, "additionalProperties": false }, "AddressBalanceBatchRequest": { "type": "object", "required": [ "addresses" ], "properties": { "addresses": { "type": "array", "items": { "type": "string", "maxLength": 256 }, "minItems": 1, "maxItems": 50, "uniqueItems": true, "description": "Requested addresses or address-module availability, as specified by this schema." } }, "additionalProperties": false }, "AddressBalanceBatchResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AddressBalance" }, "maxItems": 50, "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "AddressBalanceResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AddressBalance", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "AddressFlow": { "type": "object", "required": [ "address", "value" ], "properties": { "address": { "type": "string", "maxLength": 256, "description": "Chain address text; null represents an unattributed output where allowed." }, "value": { "$ref": "#/components/schemas/Amount", "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false }, "AddressRankingSummary": { "type": "object", "required": [ "funded_addresses", "indexed_supply" ], "properties": { "funded_addresses": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Exact number of indexed addresses with a positive confirmed balance." }, "indexed_supply": { "$ref": "#/components/schemas/IndexedSupply", "description": "Exact sum of indexed address balances in TSC smallest units; not a fiat value or an estimate of unassigned outputs." } }, "additionalProperties": false, "description": "Counters from the same current database snapshot as the ranking rows." }, "AddressSummary": { "type": "object", "required": [ "address", "balance", "received", "sent", "rank", "transaction_count", "supply_share", "first_activity", "last_activity" ], "properties": { "address": { "type": "string", "maxLength": 256, "description": "Chain address text; null represents an unattributed output where allowed." }, "alias": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "description": "Public address label, or null when the address has no label." }, "balance": { "$ref": "#/components/schemas/Amount", "description": "Exact current confirmed balance in the declared smallest units." }, "received": { "$ref": "#/components/schemas/Amount", "description": "Exact quantity received by this address in smallest units." }, "sent": { "$ref": "#/components/schemas/Amount", "description": "Exact quantity spent by this address in smallest units." }, "mempool_effect": { "$ref": "#/components/schemas/Amount", "description": "Exact net effect of currently observed pending activity, or unknown when prevouts/observation are incomplete." }, "rank": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "One-based current rank by confirmed balance; equal balances share a rank where specified." }, "transaction_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Exact number of confirmed transactions/activities represented by this resource; pending activity is excluded unless explicitly stated." }, "pending_tx_count": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Number of observed pending transactions affecting the address; null when the pending projection is unavailable." }, "supply_share": { "oneOf": [ { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "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": "null" } ], "description": "Fraction of indexed native supply owned by this address, e.g. '0.01' means 1%; null when indexed supply is zero." }, "first_activity": { "oneOf": [ { "type": "object", "required": [ "height", "time" ], "properties": { "height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based canonical block height." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." } }, "additionalProperties": false }, { "type": "null" } ], "description": "First confirmed address activity height and timestamp; null when none exists." }, "last_activity": { "oneOf": [ { "type": "object", "required": [ "height", "time" ], "properties": { "height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based canonical block height." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." } }, "additionalProperties": false }, { "type": "null" } ], "description": "Latest confirmed address activity height and timestamp; null when none exists." } }, "additionalProperties": false }, "AddressSummaryResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AddressSummary", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "Amount": { "oneOf": [ { "$ref": "#/components/schemas/KnownAmount" }, { "$ref": "#/components/schemas/UnknownAmount" }, { "$ref": "#/components/schemas/UnavailableAmount" } ], "description": "Exact smallest-unit decimal. Known zero is units '0'." }, "AssetActivity": { "type": "object", "required": [ "asset_id", "block_height", "position", "txid", "kind", "inputs", "outputs", "minted", "burned" ], "properties": { "asset_id": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "Asset identifier from the indexed protocol registration." }, "block_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based height of the containing canonical block; null for pending activity where allowed." }, "position": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based transaction position in its containing block." }, "txid": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal transaction ID; searches accept either case." }, "kind": { "type": "string", "enum": [ "mint", "burn", "transfer" ], "description": "Resolved resource type or observed protocol event type, as specified by this schema." }, "inputs": { "$ref": "#/components/schemas/Amount", "description": "Sum of this asset's units consumed by the transaction." }, "outputs": { "$ref": "#/components/schemas/Amount", "description": "Sum of this asset's output units, including sender change." }, "minted": { "$ref": "#/components/schemas/Amount", "description": "Net units minted by this asset transaction." }, "burned": { "$ref": "#/components/schemas/Amount", "description": "Cumulative asset units burned; for an activity row, the transaction's net burn." } }, "additionalProperties": false, "description": "One asset/transaction row. Net output increase is mint, decrease is burn, equal quantities are transfer. Outputs include change and are not a claimed payment amount." }, "AssetActivityPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssetActivity" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "AssetDetail": { "type": "object", "required": [ "id", "symbol", "precision", "parent_id", "governance", "coverage" ], "properties": { "id": { "type": "string", "maxLength": 128, "description": "Canonical identifier of the requested or resolved resource." }, "symbol": { "$ref": "#/components/schemas/ObservedField", "description": "Observed asset ticker; unsupported or unavailable states are explicit." }, "precision": { "$ref": "#/components/schemas/ObservedPrecision", "description": "Decimal places for the smallest-unit amount. TSC uses 8; assets use their indexed precision." }, "parent_id": { "$ref": "#/components/schemas/ObservedOptionalId", "description": "Resolved root asset identifier for a child ticker, or explicit unknown/unsupported state." }, "governance": { "$ref": "#/components/schemas/ObservedField", "description": "Observed asset policy bitmask; unsupported or unavailable values are explicit." }, "coverage": { "$ref": "#/components/schemas/ModuleCoverage", "description": "Indexed coverage for this module or sampled chart series; incomplete data is explicit." }, "policy_bits": { "type": "integer", "minimum": 0, "maximum": 4294967295, "description": "Raw on-chain asset permission bitmask." }, "first_seen_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "First indexed issuer registration height; null if unavailable." }, "registration_txid": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "Latest issuer registration transaction." }, "updated_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Height of the latest indexed asset registration." } }, "additionalProperties": false }, "AssetDetailResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AssetDetail", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "AssetDocument": { "type": "object", "required": [ "asset_id", "registration_txid", "state", "plaintext", "plaintext_commit", "ciphertext_commit", "commit_verified" ], "properties": { "asset_id": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "Asset identifier from the indexed protocol registration." }, "registration_txid": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "Indexed issuer registration used to select the document commitments." }, "state": { "type": "string", "enum": [ "public", "holder_only", "none", "unavailable", "unverified" ], "description": "public: verified readable text; holder_only: private or encrypted; none: no payload commitment; unavailable: fetch temporarily failed; unverified: payload or text could not be verified." }, "plaintext": { "oneOf": [ { "type": "string", "maxLength": 102400 }, { "type": "null" } ], "description": "Normalized original issuer text, only for a public document whose ciphertext and plaintext commitments both match. Never HTML or a browser-generated interpretation." }, "plaintext_commit": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "description": "Declared icu_plain_commit from the indexed registration, in Core display byte order; null while metadata is unavailable." }, "ciphertext_commit": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "description": "Declared icu_ctxt_commit from the indexed registration, in Core display byte order; null while metadata is unavailable." }, "commit_verified": { "type": "boolean", "description": "True only when the public payload and normalized text match both indexed on-chain commitments. Does not certify an issuer's claims or legal rights." } }, "additionalProperties": false, "description": "Read-only public ICU document. Resolves the indexed registration transaction and fetches its explicit historical commitment without loading a wallet. Private ciphertext, keywraps, witnesses and decryption material are never returned." }, "AssetDocumentResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AssetDocument", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "AssetHolder": { "type": "object", "required": [ "address", "balance" ], "properties": { "address": { "type": "string", "maxLength": 256, "description": "Chain address text; null represents an unattributed output where allowed." }, "balance": { "$ref": "#/components/schemas/Amount", "description": "Exact current confirmed balance in the declared smallest units." } }, "additionalProperties": false, "description": "Live set ordered by address; members and balances may change between numbered pages." }, "AssetHolderPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssetHolder" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "AssetOverview": { "type": "object", "required": [ "asset_id", "holder_count", "total", "through_height", "bucket_size", "series", "first_height", "last_height" ], "properties": { "total": { "type": "integer", "minimum": 0, "description": "Lifetime event total for this exact entity; equals the sum of series counts.", "maximum": 9223372036854776000 }, "through_height": { "type": "integer", "minimum": 0, "description": "Indexed canonical height covered by the full history.", "maximum": 9223372036854776000 }, "bucket_size": { "type": "integer", "minimum": 1, "description": "Number of block heights per interval, selected automatically to bound the series to at most 101 entries.", "maximum": 9223372036854776000 }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/RegistryHistoryBucket" }, "maxItems": 101, "description": "Chronological activity-chart buckets for the selected window." }, "asset_id": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "Asset identifier from the indexed protocol registration." }, "first_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "First indexed transaction height for this asset; null without unit movements." }, "last_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Latest indexed transaction height for this asset; null without unit movements." }, "holder_count": { "type": "integer", "minimum": 0, "description": "Current addresses with a strictly positive balance of this asset; not a count of people.", "maximum": 9223372036854776000 } }, "additionalProperties": false, "description": "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." }, "AssetOverviewResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AssetOverview", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "AssetPolicy": { "type": "object", "required": [ "asset_id", "policy_bits", "mint_allowed", "burn_allowed", "burn_requires_icu", "burn_requires_joint_authorization", "kyc_required", "policy_epoch", "quorum_bps", "delegate_asset_id", "documents_available" ], "properties": { "asset_id": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "Asset identifier from the indexed protocol registration." }, "policy_bits": { "type": "integer", "minimum": 0, "maximum": 4294967295, "description": "Raw on-chain asset permission bitmask." }, "mint_allowed": { "type": "boolean", "description": "Whether the asset registration permits minting." }, "burn_allowed": { "type": "boolean", "description": "Whether the asset registration permits burning." }, "burn_requires_icu": { "type": "boolean", "description": "Whether burning requires issuer ICU authorization." }, "burn_requires_joint_authorization": { "type": "boolean", "description": "Whether burning requires joint authorization." }, "kyc_required": { "type": "boolean", "description": "Whether the registration carries the KYC-required permission bit; not a full compliance evaluation." }, "documents_available": { "type": "boolean", "description": "Whether this API supports the separate read-only public document route. Use that route's state to distinguish public, holder-only, missing, unavailable and unverified documents." }, "policy_epoch": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 255 }, { "type": "null" } ], "description": "Registered policy version counter." }, "quorum_bps": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 10000 }, { "type": "null" } ], "description": "Registered governance quorum in basis points; zero means immutable from registration." }, "delegate_asset_id": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "description": "Delegated compliance asset identifier, or null; distinct from the parent asset." } }, "additionalProperties": false, "description": "Public registration policy. The document route serves verified public ICU text; private documents, complete witness evaluation, fees and advanced compliance state are not exposed." }, "AssetPolicyResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AssetPolicy", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "AssetSummary": { "type": "object", "required": [ "id", "symbol", "precision", "parent_id" ], "properties": { "id": { "type": "string", "maxLength": 128, "description": "Canonical identifier of the requested or resolved resource." }, "symbol": { "$ref": "#/components/schemas/ObservedField", "description": "Observed asset ticker; unsupported or unavailable states are explicit." }, "precision": { "$ref": "#/components/schemas/ObservedPrecision", "description": "Decimal places for the smallest-unit amount. TSC uses 8; assets use their indexed precision." }, "parent_id": { "$ref": "#/components/schemas/ObservedOptionalId", "description": "Resolved root asset identifier for a child ticker, or explicit unknown/unsupported state." }, "policy_bits": { "type": "integer", "minimum": 0, "maximum": 4294967295, "description": "Raw on-chain asset permission bitmask." }, "first_seen_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "First indexed issuer registration height; null if unavailable." }, "current_supply": { "$ref": "#/components/schemas/Amount", "description": "Outstanding asset quantity: cumulative minted minus cumulative burned." } }, "additionalProperties": false }, "AssetSummaryPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssetSummary" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "AssetSupply": { "type": "object", "required": [ "asset_id", "issued", "burned", "current", "issuance_cap", "unlimited" ], "properties": { "asset_id": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "Asset identifier from the indexed protocol registration." }, "issued": { "$ref": "#/components/schemas/Amount", "description": "Cumulative asset units minted, before burns." }, "burned": { "$ref": "#/components/schemas/Amount", "description": "Cumulative asset units burned; for an activity row, the transaction's net burn." }, "current": { "$ref": "#/components/schemas/Amount", "description": "Outstanding asset quantity: cumulative minted minus cumulative burned." }, "issuance_cap": { "oneOf": [ { "$ref": "#/components/schemas/Amount" }, { "type": "null" } ], "description": "Maximum permitted live asset supply. Zero means unlimited; null means unknown." }, "unlimited": { "type": "boolean", "description": "Whether the registered issuance cap is zero (unlimited)." } }, "additionalProperties": false, "description": "Exact Core-style cumulative mint/burn and outstanding units. The cap applies to live supply, not gross lifetime issuance; zero means unlimited." }, "AssetSupplyResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AssetSupply", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "AssetTransfer": { "type": "object", "required": [ "txid", "block_height", "position", "asset_id", "amount" ], "properties": { "txid": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal transaction ID; searches accept either case." }, "block_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based height of the containing canonical block; null for pending activity where allowed." }, "position": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based transaction position in its containing block." }, "asset_id": { "type": "string", "maxLength": 128, "description": "Asset identifier from the indexed protocol registration." }, "amount": { "$ref": "#/components/schemas/Amount", "description": "Exact asset quantity in the asset's smallest units." } }, "additionalProperties": false }, "AssetTransferPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssetTransfer" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "AveragePriceRatio": { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "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." }, "BalanceCandle": { "type": "object", "required": [ "start_height", "end_height", "activity_height", "time", "open", "close", "high", "low", "transaction_count" ], "properties": { "start_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "First inclusive canonical height represented by the window or candle." }, "end_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Final inclusive canonical height represented by the window or candle." }, "activity_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Height of the last balance-changing activity within this candle." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." }, "transaction_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Exact number of confirmed transactions/activities represented by this resource; pending activity is excluded unless explicitly stated." }, "open": { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80, "description": "Confirmed balance immediately before the interval's first activity, in smallest units." }, "close": { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80, "description": "Confirmed balance after the final activity in the interval, in smallest units." }, "high": { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80, "description": "Highest confirmed balance in the interval, including its opening balance." }, "low": { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80, "description": "Lowest confirmed balance in the interval, including its opening balance." } }, "additionalProperties": false }, "BalanceHistory": { "type": "object", "required": [ "first_height", "last_activity_height", "tip_height", "tip_time", "bucket_size", "current_balance", "ledger_balance", "candles" ], "properties": { "first_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "First indexed or selected height represented by this resource." }, "first_time": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Unix timestamp of the first confirmed address activity; null when none exists." }, "last_activity_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Latest confirmed address activity height; null when none exists." }, "last_activity_time": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Latest confirmed address activity timestamp in Unix seconds; null when none exists." }, "tip_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Canonical height at the serving snapshot's watermark." }, "tip_time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp of the watermark block." }, "bucket_size": { "type": "integer", "minimum": 1, "maximum": 9223372036854776000, "description": "Number of block heights in each balance-history candle interval." }, "current_balance": { "$ref": "#/components/schemas/Amount", "description": "Current confirmed address balance in smallest units." }, "ledger_balance": { "$ref": "#/components/schemas/Amount", "description": "Confirmed balance reconstructed from indexed address activity, in smallest units." }, "candles": { "type": "array", "items": { "$ref": "#/components/schemas/BalanceCandle" }, "maxItems": 160, "description": "Chronological exact balance candles; at most 160 nonempty intervals." } }, "additionalProperties": false }, "BalanceHistoryResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/BalanceHistory", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "BlockDetail": { "type": "object", "required": [ "height", "hash", "time", "tx_count", "previous_hash", "size_bytes" ], "properties": { "height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based canonical block height." }, "hash": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal block hash." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." }, "tx_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of transactions in this canonical block, including coinbase." }, "miner_address": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "description": "Address of the attributed coinbase payout, or null when unattributed." }, "miner_reward": { "$ref": "#/components/schemas/Amount", "description": "Exact attributed coinbase payout in TSC smallest units." }, "previous_hash": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "description": "Previous canonical block hash, or null for genesis." }, "size_bytes": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Serialized block or transaction size in bytes." }, "weight": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Core block/transaction weight; null or omitted where the exact value is unavailable." }, "merkle_root": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "description": "64-character hexadecimal transaction Merkle root." }, "target": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "description": "Exact base target decoded from Core's compact bits." }, "adjusted_target": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "description": "Exact integer target decoded from the adjusted compact bits." }, "effective_target": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "description": "Exact priced target used for effective-difficulty calculation." }, "chainwork": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "description": "Core's exact cumulative chain-work value as a hexadecimal string." }, "bits": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}$" }, { "type": "null" } ], "description": "Core's base compact target bits as an exact hexadecimal string." }, "adjusted_bits": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}$" }, { "type": "null" } ], "description": "Core model-adjusted compact difficulty bits, as an exact hexadecimal string." }, "base_difficulty": { "oneOf": [ { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80 }, { "type": "null" } ], "description": "Exact target-derived base difficulty before model adjustment and Proof pricing." }, "model_adjusted_difficulty": { "oneOf": [ { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80 }, { "type": "null" } ], "description": "Exact target-derived difficulty after model adjustment and before Proof pricing." }, "effective_difficulty": { "oneOf": [ { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80 }, { "type": "null" } ], "description": "Exact difficulty after model adjustment and Proof pricing." }, "nonce": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Core's exact block-header nonce representation." }, "version": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Exact Core header/transaction version or indexed Proof version, according to the enclosing resource." }, "median_time": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Core's median block time in Unix seconds." } }, "additionalProperties": false, "description": "Weight is included only when an exact value has been indexed; it is never estimated from size." }, "BlockDetailResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/BlockDetail", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "BlockListItem": { "type": "object", "required": [ "height", "hash", "time", "tx_count", "size_bytes", "difficulty", "proof", "miner_address", "miner_reward" ], "properties": { "height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based canonical block height." }, "hash": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal block hash." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." }, "tx_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of transactions in this canonical block, including coinbase." }, "miner_address": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "description": "Address of the attributed coinbase payout, or null when unattributed." }, "miner_reward": { "$ref": "#/components/schemas/Amount", "description": "Exact attributed coinbase payout in TSC smallest units." }, "size_bytes": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Serialized block or transaction size in bytes." }, "difficulty": { "oneOf": [ { "type": "string", "pattern": "^[0-9]+(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", "maxLength": 64 }, { "type": "null" } ], "description": "Exact indexed effective difficulty as a decimal string; null when unavailable." }, "proof": { "oneOf": [ { "$ref": "#/components/schemas/BlockProofSummary" }, { "type": "null" } ], "description": "Compact Proof facts, or Proof-module availability/coverage, as specified by this schema." } }, "additionalProperties": false, "description": "Compact indexed fields for the existing Blocks table. Confirmations derive from the response watermark." }, "BlockProofSummary": { "type": "object", "required": [ "version", "price_multiplier" ], "properties": { "version": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 255 }, { "type": "null" } ], "description": "Exact Core header/transaction version or indexed Proof version, according to the enclosing resource." }, "price_multiplier": { "oneOf": [ { "$ref": "#/components/schemas/ExactPriceRatio" }, { "type": "null" } ], "description": "Protocol Proof price multiplier, e.g. '2' means 2x. Separate from Market prices; null means unavailable. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places." } }, "additionalProperties": false, "description": "A missing price is null; no multiplier is inferred from the Proof version." }, "BlockSummary": { "type": "object", "required": [ "height", "hash", "time", "tx_count" ], "properties": { "height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based canonical block height." }, "hash": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal block hash." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." }, "tx_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of transactions in this canonical block, including coinbase." }, "miner_address": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "description": "Address of the attributed coinbase payout, or null when unattributed." }, "miner_reward": { "$ref": "#/components/schemas/Amount", "description": "Exact attributed coinbase payout in TSC smallest units." } }, "additionalProperties": false, "description": "Miner fields are present when supported by the Indexer; unknown means no addressed coinbase payout." }, "BlockSummaryPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BlockListItem" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "BlockTransaction": { "type": "object", "required": [ "txid", "position", "is_coinbase", "input_count", "output_count", "total_output", "fee" ], "properties": { "txid": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal transaction ID; searches accept either case." }, "position": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based transaction position in its containing block." }, "is_coinbase": { "type": "boolean", "description": "Whether this transaction or input is a coinbase reward." }, "input_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of transaction inputs." }, "output_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of transaction outputs." }, "total_output": { "$ref": "#/components/schemas/Amount", "description": "Exact sum of all outputs of this transaction in TSC smallest units; never a fiat value." }, "fee": { "oneOf": [ { "$ref": "#/components/schemas/Amount" }, { "type": "null" } ], "description": "Exact input total minus output total; null for coinbase where specified, otherwise unknown if prevouts are unavailable." }, "block_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based height of the containing canonical block; null for pending activity where allowed." }, "block_hash": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "Hash of the containing canonical block." } }, "additionalProperties": false }, "BlockTransactionPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BlockTransaction" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "Capabilities": { "type": "object", "required": [ "blocks", "transactions", "addresses", "models", "assets", "proof", "faucet", "market" ], "properties": { "blocks": { "type": "boolean", "description": "Number of blocks, or block-module availability/coverage, as specified by the enclosing schema." }, "transactions": { "type": "boolean", "description": "Complete observed mempool count, confirmed transaction count or transaction-module availability/coverage, according to this schema." }, "addresses": { "type": "boolean", "description": "Requested addresses or address-module availability, as specified by this schema." }, "models": { "type": "boolean", "description": "Availability or indexed coverage of the Models module." }, "assets": { "type": "boolean", "description": "Availability or indexed coverage of the Assets module." }, "proof": { "type": "boolean", "description": "Compact Proof facts, or Proof-module availability/coverage, as specified by this schema." }, "faucet": { "type": "boolean", "description": "Whether a Faucet API is enabled. It is currently false." }, "market": { "type": "boolean", "description": "Whether Market data is enabled. Chain API resources never require Market data." } }, "additionalProperties": false }, "CapabilitiesResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Capabilities", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "ChainPoint": { "type": "object", "required": [ "height", "hash" ], "properties": { "height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based canonical block height." }, "hash": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal block hash." } }, "additionalProperties": false }, "ChainStatistics": { "type": "object", "required": [ "block_count", "transaction_count", "funded_addresses", "indexed_supply", "latest_block" ], "properties": { "block_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of blocks represented by this resource or group." }, "transaction_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Exact number of confirmed transactions/activities represented by this resource; pending activity is excluded unless explicitly stated." }, "funded_addresses": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Exact number of indexed addresses with a positive confirmed balance." }, "indexed_supply": { "$ref": "#/components/schemas/IndexedSupply", "description": "Exact sum of indexed address balances in TSC smallest units; not a fiat value or an estimate of unassigned outputs." }, "latest_block": { "$ref": "#/components/schemas/BlockSummary", "description": "Compact facts about the canonical block at this snapshot's watermark." } }, "additionalProperties": false, "description": "Snapshot counters maintained during canonical block commits and reversals. Indexed supply is the sum of indexed address balances in 8-decimal base units." }, "ChainStatisticsResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ChainStatistics", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "ExactPriceRatio": { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "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." }, "FundedAddress": { "type": "object", "required": [ "address", "balance", "transaction_count", "last_activity", "net_flow_7d", "net_flow_30d" ], "properties": { "address": { "type": "string", "maxLength": 256, "description": "Chain address text; null represents an unattributed output where allowed." }, "balance": { "$ref": "#/components/schemas/KnownAmount", "description": "Exact current confirmed balance in the declared smallest units." }, "transaction_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Exact number of confirmed transactions/activities represented by this resource; pending activity is excluded unless explicitly stated." }, "last_activity": { "oneOf": [ { "type": "object", "required": [ "height", "time" ], "properties": { "height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based canonical block height." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." } }, "additionalProperties": false }, { "type": "null" } ], "description": "Latest confirmed address activity height and timestamp; null when none exists." }, "net_flow_7d": { "oneOf": [ { "$ref": "#/components/schemas/KnownAmount" }, { "type": "null" } ], "description": "Signed confirmed net flow over the preceding 7 x 86400 seconds; null means no activity, known zero means activity netted to zero." }, "net_flow_30d": { "oneOf": [ { "$ref": "#/components/schemas/KnownAmount" }, { "type": "null" } ], "description": "Signed confirmed net flow over the preceding 30 x 86400 seconds; null means no activity, known zero means activity netted to zero." } }, "additionalProperties": false, "description": "Current funded balance and compact confirmed activity. Flows use rolling 7/30-day windows of 86400-second days from read time; null means no observed activity in that window, while known zero means activity netted to zero. Numbered pages describe the current indexed state." }, "FundedAddressPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FundedAddress" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." }, "summary": { "$ref": "#/components/schemas/AddressRankingSummary", "description": "Compact exact counters from the same snapshot as the ranked address page." } }, "additionalProperties": false }, "IndexedSupply": { "type": "object", "required": [ "units", "precision" ], "properties": { "units": { "type": "string", "pattern": "^[0-9]+$", "maxLength": 80, "description": "Exact decimal string in smallest units; signed where the schema permits. Divide by 10^precision only for display." }, "precision": { "const": 8, "description": "Decimal places for the smallest-unit amount. TSC uses 8; assets use their indexed precision." } }, "additionalProperties": false, "description": "Exact sum of indexed address balances in TSC base units; not an estimate of unassigned outputs." }, "InputSummary": { "type": "object", "required": [ "index", "previous_txid", "previous_output_index", "value" ], "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based input or output index within its transaction." }, "previous_txid": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "description": "Previous transaction referenced by this input; null for coinbase." }, "previous_output_index": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Zero-based output index referenced by this input; null for coinbase." }, "value": { "$ref": "#/components/schemas/Amount", "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." }, "address": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "description": "Chain address text; null represents an unattributed output where allowed." }, "is_coinbase": { "type": "boolean", "description": "Whether this transaction or input is a coinbase reward." } }, "additionalProperties": false }, "InputSummaryPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InputSummary" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "KnownAmount": { "type": "object", "required": [ "units", "precision" ], "properties": { "units": { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80, "description": "Exact decimal string in smallest units; signed where the schema permits. Divide by 10^precision only for display." }, "precision": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Decimal places for the smallest-unit amount. TSC uses 8; assets use their indexed precision." } }, "additionalProperties": false }, "LargeTransfer": { "type": "object", "required": [ "txid", "block_height", "block_hash", "time", "total_output", "input_count", "output_count" ], "properties": { "txid": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal transaction ID; searches accept either case." }, "block_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based height of the containing canonical block; null for pending activity where allowed." }, "block_hash": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "Hash of the containing canonical block." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." }, "total_output": { "$ref": "#/components/schemas/Amount", "description": "Exact sum of all outputs of this transaction in TSC smallest units; never a fiat value." }, "input_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of transaction inputs." }, "output_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of transaction outputs." } }, "additionalProperties": false }, "LargeTransferPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LargeTransfer" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "LiveResponse": { "type": "object", "required": [ "live" ], "properties": { "live": { "type": "boolean", "description": "Whether the API process is running; does not assert Indexer readiness." } }, "additionalProperties": false }, "MempoolFeed": { "oneOf": [ { "type": "object", "required": [ "state", "observed_at_unix", "transactions", "items" ], "properties": { "state": { "const": "available", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "observed_at_unix": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Time of the successful Core mempool snapshot, in Unix seconds. It is independent of the chain watermark." }, "transactions": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Complete observed mempool count, confirmed transaction count or transaction-module availability/coverage, according to this schema." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MempoolFeedItem" }, "description": "Resource items in the ordering specified by the endpoint." } }, "additionalProperties": false }, { "type": "object", "required": [ "state", "observed_at_unix", "transactions", "items" ], "properties": { "state": { "const": "unavailable", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "observed_at_unix": { "type": "null", "description": "Time of the successful Core mempool snapshot, in Unix seconds. It is independent of the chain watermark." }, "transactions": { "type": "null", "description": "Complete observed mempool count, confirmed transaction count or transaction-module availability/coverage, according to this schema." }, "items": { "type": "null", "description": "Resource items in the ordering specified by the endpoint." } }, "additionalProperties": false } ], "description": "Complete network-local Core mempool observation, refreshed every five seconds and timed separately from confirmed chain state. All observed transaction IDs are included, newest first; transactions equals items.length. No pagination or sampling." }, "MempoolFeedItem": { "type": "object", "required": [ "txid", "time", "vsize", "total_output" ], "properties": { "txid": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal transaction ID; searches accept either case." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." }, "vsize": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Core virtual transaction size in bytes." }, "total_output": { "$ref": "#/components/schemas/MempoolOutput", "description": "Exact sum of all outputs of this transaction in TSC smallest units; never a fiat value." } }, "additionalProperties": false, "description": "One unconfirmed Core transaction. An unavailable output is not zero." }, "MempoolFeedResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MempoolFeed", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "MempoolOutput": { "oneOf": [ { "type": "object", "required": [ "units", "precision" ], "properties": { "units": { "type": "string", "pattern": "^[0-9]+$", "maxLength": 80, "description": "Exact decimal string in smallest units; signed where the schema permits. Divide by 10^precision only for display." }, "precision": { "const": 8, "description": "Decimal places for the smallest-unit amount. TSC uses 8; assets use their indexed precision." } }, "additionalProperties": false }, { "type": "object", "required": [ "state", "units", "precision" ], "properties": { "state": { "const": "unavailable", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "units": { "type": "null", "description": "Exact decimal string in smallest units; signed where the schema permits. Divide by 10^precision only for display." }, "precision": { "const": 8, "description": "Decimal places for the smallest-unit amount. TSC uses 8; assets use their indexed precision." } }, "additionalProperties": false } ] }, "MempoolSummary": { "oneOf": [ { "type": "object", "required": [ "state", "transactions", "bytes", "observed_at_unix" ], "properties": { "state": { "const": "available", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "transactions": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Complete observed mempool count, confirmed transaction count or transaction-module availability/coverage, according to this schema." }, "bytes": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Core's observed serialized mempool size in bytes; null when the observation is unavailable." }, "observed_at_unix": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Time of the successful Core mempool snapshot, in Unix seconds. It is independent of the chain watermark." } }, "additionalProperties": false, "description": "Fresh, network-local Core observation. A genuine empty mempool has zero count and bytes." }, { "type": "object", "required": [ "state", "transactions", "bytes", "observed_at_unix" ], "properties": { "state": { "const": "unavailable", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "transactions": { "type": "null", "description": "Complete observed mempool count, confirmed transaction count or transaction-module availability/coverage, according to this schema." }, "bytes": { "type": "null", "description": "Core's observed serialized mempool size in bytes; null when the observation is unavailable." }, "observed_at_unix": { "type": "null", "description": "Time of the successful Core mempool snapshot, in Unix seconds. It is independent of the chain watermark." } }, "additionalProperties": false, "description": "Failed or stale Core observation; no count is inferred from canonical chain data." } ], "description": "Mempool data is an independently timed observation from the selected Indexer's Core, not confirmed chain state. Different Indexers may report different observations." }, "MempoolSummaryResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MempoolSummary", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "MinerStatistics": { "type": "object", "required": [ "requested_blocks", "observed_blocks", "unknown_blocks", "start_height", "end_height", "share_basis", "items" ], "properties": { "requested_blocks": { "type": "integer", "minimum": 1, "maximum": 300, "description": "Requested size of the recent canonical block window." }, "observed_blocks": { "type": "integer", "minimum": 0, "maximum": 300, "description": "Actual number of canonical blocks found in the selected bounded window." }, "unknown_blocks": { "type": "integer", "minimum": 0, "maximum": 300, "description": "Observed blocks lacking required indexed work evidence." }, "start_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "First inclusive canonical height represented by the window or candle." }, "end_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Final inclusive canonical height represented by the window or candle." }, "share_basis": { "const": "blocks", "description": "Basis used for miner shares; the enum documents whether work or block count is used." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MinerStatisticsItem" }, "maxItems": 301, "description": "Resource items in the ordering specified by the endpoint." } }, "additionalProperties": false, "description": "Recent block-count distribution, not work-weighted Pool share." }, "MinerStatisticsItem": { "type": "object", "required": [ "address", "block_count", "payout", "last_height" ], "properties": { "address": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "description": "Chain address text; null represents an unattributed output where allowed." }, "block_count": { "type": "integer", "minimum": 1, "maximum": 300, "description": "Number of blocks represented by this resource or group." }, "payout": { "$ref": "#/components/schemas/Amount", "description": "Exact attributed coinbase payout sum in TSC smallest units." }, "last_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Last height represented by this group or series." } }, "additionalProperties": false, "description": "Payout sums the attributed addressed coinbase output; null address means unknown miner." }, "MinerStatisticsResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MinerStatistics", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "MiningDay": { "type": "object", "required": [ "timestamp", "entries" ], "properties": { "timestamp": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "UTC day-start Unix timestamp for this daily mining row." }, "entries": { "type": "array", "items": { "type": "array", "prefixItems": [ { "type": "string", "description": "Miner payout address.", "maxLength": 256 }, { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80, "description": "Exact summed effective work as a decimal integer string; missing work is counted separately." }, { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of canonical blocks attributed to this address in the interval." }, { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of those blocks whose effective work is unavailable." } ], "minItems": 4, "maxItems": 4 }, "maxItems": 10000, "description": "Miner tuples [payout address, exact effective work, block count, blocks missing work]; an empty address means unattributed." } }, "additionalProperties": false }, "MiningDayPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiningDay" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." }, "live_window": { "$ref": "#/components/schemas/MiningLiveWindow", "description": "Separately computed rolling 24-hour miner totals." } }, "additionalProperties": false }, "MiningLiveWindow": { "type": "object", "required": [ "start_timestamp", "end_timestamp", "entries" ], "properties": { "start_timestamp": { "type": "integer", "minimum": -9223372036854776000, "maximum": 9223372036854776000, "description": "Start of the rolling live window in Unix seconds." }, "end_timestamp": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "End of the rolling live window in Unix seconds." }, "entries": { "type": "array", "items": { "type": "array", "prefixItems": [ { "type": "string", "description": "Miner payout address.", "maxLength": 256 }, { "type": "string", "pattern": "^-?[0-9]+$", "maxLength": 80, "description": "Exact summed effective work as a decimal integer string; missing work is counted separately." }, { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of canonical blocks attributed to this address in the interval." }, { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of those blocks whose effective work is unavailable." } ], "minItems": 4, "maxItems": 4 }, "maxItems": 10000, "description": "Miner tuples [payout address, exact effective work, block count, blocks missing work]; an empty address means unattributed." } }, "additionalProperties": false }, "MiningMedian": { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "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." }, "MiningRate": { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "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." }, "MiningSeries": { "type": "object", "required": [ "range", "first_height", "last_height", "source_blocks", "coverage", "items" ], "properties": { "range": { "type": "string", "enum": [ "24h", "7d", "30d", "all" ], "description": "Selected named time range; the supported values are endpoint-specific." }, "first_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "First indexed or selected height represented by this resource." }, "last_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Last height represented by this group or series." }, "source_blocks": { "type": "integer", "minimum": 1, "maximum": 9223372036854776000, "description": "Number of canonical blocks represented by the sampled mining series." }, "coverage": { "$ref": "#/components/schemas/MiningSeriesCoverage", "description": "Indexed coverage for this module or sampled chart series; incomplete data is explicit." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MiningSeriesPoint" }, "maxItems": 360, "minItems": 1, "description": "Resource items in the ordering specified by the endpoint." } }, "additionalProperties": false, "description": "Fixed-range, height-sampled exact work series. First and last relevant heights are retained; at most 360 points are returned." }, "MiningSeriesCoverage": { "type": "object", "required": [ "sampled_points", "work_complete_points", "rate_available_points" ], "properties": { "sampled_points": { "type": "integer", "minimum": 1, "maximum": 360, "description": "Number of height-sampled chart points in this response; chart data, not the mempool." }, "work_complete_points": { "type": "integer", "minimum": 0, "maximum": 360, "description": "Number of sampled mining-series points with complete indexed work." }, "rate_available_points": { "type": "integer", "minimum": 0, "maximum": 360, "description": "Number of sampled chart points with a valid exact work rate." } }, "additionalProperties": false, "description": "Coverage counts apply to sampled points, not every block between samples." }, "MiningSeriesPoint": { "type": "object", "required": [ "height", "time", "base_work", "effective_work", "proof_price_multiplier", "work_rate_50", "work_window_blocks", "work_complete", "observed_seconds", "difficulty_trend_7", "block_interval_seconds" ], "properties": { "height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based canonical block height." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." }, "base_work": { "oneOf": [ { "type": "string", "pattern": "^[0-9]+$", "maxLength": 100 }, { "type": "null" } ], "description": "Exact target-derived work before Proof pricing, encoded as a decimal string." }, "effective_work": { "oneOf": [ { "type": "string", "pattern": "^[0-9]+$", "maxLength": 100 }, { "type": "null" } ], "description": "Exact Proof-priced work as a decimal string; null when required evidence is unavailable." }, "proof_price_multiplier": { "oneOf": [ { "$ref": "#/components/schemas/MiningSeriesPrice" }, { "type": "null" } ], "description": "Protocol Proof price multiplier at the sampled block; null means unavailable. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places." }, "work_rate_50": { "oneOf": [ { "$ref": "#/components/schemas/MiningRate" }, { "type": "null" } ], "description": "Effective work per observed second over the recent 50-block window; null means unavailable. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places." }, "work_window_blocks": { "type": "integer", "minimum": 0, "maximum": 50, "description": "Number of canonical blocks used in this chart point's rate window." }, "work_complete": { "type": "boolean", "description": "Whether every block needed for this work calculation has exact indexed work." }, "observed_seconds": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Observed timestamp span used as the work-rate denominator; zero cannot produce a valid rate." }, "difficulty_trend_7": { "oneOf": [ { "$ref": "#/components/schemas/MiningMedian" }, { "type": "null" } ], "description": "Median effective work across up to seven recent blocks as a decimal string; null means unavailable. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places." }, "block_interval_seconds": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Observed difference between this block's timestamp and its predecessor." } }, "additionalProperties": false, "description": "Canonical height sample for the existing Home chart. Null values mean missing work or invalid observation, never zero.", "allOf": [ { "if": { "properties": { "work_complete": { "const": false } } }, "then": { "properties": { "work_rate_50": { "type": "null" } } } }, { "if": { "properties": { "observed_seconds": { "const": 0 } } }, "then": { "properties": { "work_rate_50": { "type": "null" } } } }, { "if": { "properties": { "effective_work": { "type": "null" } } }, "then": { "properties": { "difficulty_trend_7": { "type": "null" } } } } ] }, "MiningSeriesPrice": { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "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." }, "MiningSeriesResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MiningSeries", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "MiningStatistics": { "type": "object", "required": [ "current_50", "previous_50", "recent_24h", "tip_effective_work", "average_interval_seconds_50" ], "properties": { "current_50": { "$ref": "#/components/schemas/MiningWindow50", "description": "Exact current 50-block work-rate window, shortened only near genesis." }, "previous_50": { "oneOf": [ { "$ref": "#/components/schemas/MiningWindow50" }, { "type": "null" } ], "description": "50-block comparison window ending near the prior 24-hour boundary; null without a usable boundary." }, "recent_24h": { "$ref": "#/components/schemas/MiningWindow", "description": "Exact work and block totals over the recent 86400-second window." }, "tip_effective_work": { "oneOf": [ { "type": "string", "pattern": "^[0-9]+$", "maxLength": 100 }, { "type": "null" } ], "description": "Exact effective work of the watermark block, or null when unavailable." }, "average_interval_seconds_50": { "oneOf": [ { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "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": "null" } ], "description": "Mean observed block interval in seconds for the recent 50-block window; null means unavailable. The current_50.blocks field gives the interval sample count. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places." } }, "additionalProperties": false, "description": "Fixed current and prior 50-block and recent 24-hour work-rate windows for existing Home metrics. No arbitrary interval or chart series." }, "MiningStatisticsResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MiningStatistics", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "MiningWindow": { "type": "object", "required": [ "blocks", "observed_seconds", "work_complete", "rate" ], "properties": { "blocks": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of blocks, or block-module availability/coverage, as specified by the enclosing schema." }, "observed_seconds": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Observed timestamp span used as the work-rate denominator; zero cannot produce a valid rate." }, "work_complete": { "type": "boolean", "description": "Whether every block needed for this work calculation has exact indexed work." }, "rate": { "oneOf": [ { "$ref": "#/components/schemas/MiningRate" }, { "type": "null" } ], "description": "Effective work per observed second as a decimal string; null means incomplete work or zero elapsed seconds. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places." } }, "additionalProperties": false, "description": "Null rate means work is incomplete or the observed span is zero.", "allOf": [ { "if": { "properties": { "work_complete": { "const": false } } }, "then": { "properties": { "rate": { "type": "null" } } } }, { "if": { "properties": { "observed_seconds": { "const": 0 } } }, "then": { "properties": { "rate": { "type": "null" } } } } ] }, "MiningWindow50": { "type": "object", "required": [ "blocks", "observed_seconds", "work_complete", "rate" ], "properties": { "blocks": { "type": "integer", "minimum": 0, "maximum": 50, "description": "Number of blocks, or block-module availability/coverage, as specified by the enclosing schema." }, "observed_seconds": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Observed timestamp span used as the work-rate denominator; zero cannot produce a valid rate." }, "work_complete": { "type": "boolean", "description": "Whether every block needed for this work calculation has exact indexed work." }, "rate": { "oneOf": [ { "$ref": "#/components/schemas/MiningRate" }, { "type": "null" } ], "description": "Effective work per observed second as a decimal string; null means incomplete work or zero elapsed seconds. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places." } }, "additionalProperties": false, "description": "At most 50 measured block intervals ending at the selected fixed-window tip.", "allOf": [ { "if": { "properties": { "work_complete": { "const": false } } }, "then": { "properties": { "rate": { "type": "null" } } } }, { "if": { "properties": { "observed_seconds": { "const": 0 } } }, "then": { "properties": { "rate": { "type": "null" } } } } ] }, "ModelBlock": { "type": "object", "required": [ "height", "hash", "time", "tx_count" ], "properties": { "height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based canonical block height." }, "hash": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal block hash." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." }, "tx_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of transactions in this canonical block, including coinbase." } }, "additionalProperties": false, "description": "Canonical block whose Proof identifies this exact model name and revision." }, "ModelBlockPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ModelBlock" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "ModelDetail": { "type": "object", "required": [ "id", "name", "registration_height", "owner", "verifiable_state", "coverage" ], "properties": { "id": { "type": "string", "maxLength": 128, "description": "Canonical identifier of the requested or resolved resource." }, "name": { "$ref": "#/components/schemas/ObservedField", "description": "Observed model name; unavailable and unsupported states are explicit." }, "registration_height": { "$ref": "#/components/schemas/ObservedHeight", "description": "Observed model registration height; unsupported or unavailable states are explicit." }, "owner": { "$ref": "#/components/schemas/ObservedField", "description": "Observed model owner; unsupported or unavailable values are explicit." }, "verifiable_state": { "$ref": "#/components/schemas/ObservedField", "description": "Observed model verification status; unsupported or unavailable states are explicit." }, "coverage": { "$ref": "#/components/schemas/ModuleCoverage", "description": "Indexed coverage for this module or sampled chart series; incomplete data is explicit." }, "commit": { "type": "string", "description": "Official model revision identifier." }, "difficulty": { "type": "string", "pattern": "^[0-9]+$", "description": "Exact integer model difficulty parameter from registration." }, "is_default": { "type": "boolean", "description": "Built-in genesis model, with no registration deposit transaction." }, "cid": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered content reference, or null." }, "registration": { "type": "object", "required": [ "deposit_height", "deposit_txid", "deposit_amount", "successful_commits", "verdict_height", "burn_height" ], "properties": { "deposit_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Canonical block height carrying the model registration deposit." }, "deposit_txid": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "description": "Registration or challenge deposit transaction; null when none applies." }, "deposit_amount": { "$ref": "#/components/schemas/Amount", "description": "Exact registration bond in TSC base units; unavailable for default models." }, "successful_commits": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Indexed successful model verification commits." }, "verdict_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Pending verification or challenge verdict height; null outside that window." }, "burn_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Block height of a recognized model deposit burn, or null." } }, "additionalProperties": false, "description": "Observed registration lifecycle. Default models have no deposit; verdict_height is null after the pending window closes." }, "challenge": { "type": "object", "required": [ "block_hash", "deposit_txid", "commit_count", "verdict_height" ], "properties": { "block_hash": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "description": "Hash of the containing canonical block." }, "deposit_txid": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "description": "Registration or challenge deposit transaction; null when none applies." }, "commit_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Current challenge commit count." }, "verdict_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Pending verification or challenge verdict height; null outside that window." } }, "additionalProperties": false, "description": "Current challenge window. Resolved challenges remain visible in event history." } }, "additionalProperties": false }, "ModelDetailResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ModelDetail", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "ModelEvent": { "type": "object", "required": [ "model_id", "txid", "block_height", "position", "kind" ], "properties": { "model_id": { "type": "string", "maxLength": 128, "description": "Protocol identifier of the affected model." }, "txid": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal transaction ID; searches accept either case." }, "block_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based height of the containing canonical block; null for pending activity where allowed." }, "position": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based transaction position in its containing block." }, "kind": { "$ref": "#/components/schemas/ObservedField", "description": "Resolved resource type or observed protocol event type, as specified by this schema." }, "failure_reason": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Core failure code carried by this event, or null." } }, "additionalProperties": false, "description": "Confirmed event membership only; completeness is reported by module coverage." }, "ModelEventPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ModelEvent" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "ModelProduction": { "type": "object", "required": [ "model_id", "total", "through_height", "bucket_size", "series", "first_height", "last_height" ], "properties": { "total": { "type": "integer", "minimum": 0, "description": "Lifetime event total for this exact entity; equals the sum of series counts.", "maximum": 9223372036854776000 }, "through_height": { "type": "integer", "minimum": 0, "description": "Indexed canonical height covered by the full history.", "maximum": 9223372036854776000 }, "bucket_size": { "type": "integer", "minimum": 1, "description": "Number of block heights per interval, selected automatically to bound the series to at most 101 entries.", "maximum": 9223372036854776000 }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/RegistryHistoryBucket" }, "maxItems": 101, "description": "Chronological activity-chart buckets for the selected window." }, "model_id": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "Protocol identifier of the affected model." }, "first_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "First indexed block using this exact model revision; null if never used." }, "last_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Latest indexed block using this exact model revision; null if never used." } }, "additionalProperties": false, "description": "Complete indexed production history, read from incrementally maintained multiresolution counters. Canonical rollbacks reverse both totals and buckets." }, "ModelProductionResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ModelProduction", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "ModelSummary": { "type": "object", "required": [ "id", "name", "registration_height" ], "properties": { "id": { "type": "string", "maxLength": 128, "description": "Canonical identifier of the requested or resolved resource." }, "name": { "$ref": "#/components/schemas/ObservedField", "description": "Observed model name; unavailable and unsupported states are explicit." }, "registration_height": { "$ref": "#/components/schemas/ObservedHeight", "description": "Observed model registration height; unsupported or unavailable states are explicit." }, "commit": { "type": "string", "description": "Official model revision identifier." }, "difficulty": { "type": "string", "pattern": "^[0-9]+$", "description": "Exact integer model difficulty parameter from registration." }, "verifiable_state": { "$ref": "#/components/schemas/ObservedField", "description": "Observed model verification status; unsupported or unavailable states are explicit." }, "is_default": { "type": "boolean", "description": "Built-in genesis model, with no registration deposit transaction." }, "latest_block": { "oneOf": [ { "$ref": "#/components/schemas/ModelBlock" }, { "type": "null" } ], "description": "Latest indexed canonical block produced with this exact model revision; null when none is indexed." }, "block_count": { "type": "integer", "minimum": 0, "description": "Lifetime number of indexed canonical blocks using this exact model revision.", "maximum": 9223372036854776000 } }, "additionalProperties": false }, "ModelSummaryPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ModelSummary" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "ModuleCoverage": { "type": "object", "required": [ "state", "through_height", "scope" ], "properties": { "state": { "type": "string", "enum": [ "complete", "partial", "unsupported" ], "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "through_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Highest canonical height covered by this module; -1 means no indexed coverage." }, "scope": { "type": "string", "enum": [ "chain_wide", "current_state", "wallet_scoped", "none" ], "description": "Coverage scope. chain_wide means every required block from genesis through the reported height." } }, "additionalProperties": false }, "NetworkOverview": { "type": "object", "required": [ "network", "status", "height", "hash", "core_height", "latest_block_time", "base_difficulty", "effective_difficulty", "confirmed_transactions", "inference", "hashrate", "average_block_time_50", "reward", "latest_blocks", "time_since_last_block_seconds", "as_of_unix", "market" ], "properties": { "network": { "type": "string", "description": "Selected deployment network.", "enum": [ "mainnet", "testnet" ] }, "status": { "type": "string", "description": "Synchronization relative to a fresh Core observation. upstream_unavailable means Core height is unknown; indexed chain data remains valid at height/hash.", "enum": [ "ready", "catching_up", "upstream_unavailable" ] }, "height": { "type": "integer", "description": "Committed indexed height used by all chain fields.", "minimum": 0 }, "hash": { "type": "string", "description": "Indexed tip hash.", "pattern": "^[0-9a-f]{64}$" }, "core_height": { "oneOf": [ { "type": "integer", "description": "Fresh observed Core height; null when the upstream observation has expired or failed.", "minimum": 0 }, { "type": "null" } ], "description": "Fresh observed Core height; null when the upstream observation has expired or failed. Null when unavailable." }, "latest_block_time": { "type": "integer", "description": "Indexed tip timestamp in Unix seconds.", "minimum": 0 }, "base_difficulty": { "oneOf": [ { "type": "string", "description": "Latest block base target-derived work, in expected proofs.", "pattern": "^[0-9]+$", "maxLength": 78 }, { "type": "null" } ], "description": "Latest block base target-derived work, in expected proofs. Null when unavailable." }, "effective_difficulty": { "oneOf": [ { "type": "string", "description": "Latest block effective target-derived work after model/Proof adjustments.", "pattern": "^[0-9]+$", "maxLength": 78 }, { "type": "null" } ], "description": "Latest block effective target-derived work after model/Proof adjustments. Null when unavailable." }, "confirmed_transactions": { "type": "integer", "description": "Confirmed transaction count, including coinbases.", "minimum": 0 }, "inference": { "type": "object", "required": [ "tokens_per_second", "basis" ], "properties": { "tokens_per_second": { "oneOf": [ { "$ref": "#/components/schemas/OverviewRatio", "description": "Qt-equivalent estimated inference throughput: base work × 256 / 600. Not measured miner telemetry." }, { "type": "null" } ], "description": "Qt-equivalent estimated inference throughput: base work × 256 / 600. Not measured miner telemetry. Null when unavailable." }, "basis": { "type": "string", "description": "Explicit estimation formula.", "enum": [ "qt_base_difficulty_256_tokens_600_seconds" ] } }, "additionalProperties": false, "description": "Inference speed estimate." }, "hashrate": { "type": "object", "required": [ "proofs_per_second", "window_blocks", "work_complete" ], "properties": { "proofs_per_second": { "oneOf": [ { "$ref": "#/components/schemas/OverviewRatio", "description": "Effective work / observed seconds over up to 50 intervals." }, { "type": "null" } ], "description": "Effective work / observed seconds over up to 50 intervals. Null when unavailable." }, "window_blocks": { "type": "integer", "description": "Actual interval count.", "minimum": 0, "maximum": 50 }, "work_complete": { "type": "boolean", "description": "All sampled block work is available." } }, "additionalProperties": false, "description": "Network effective proof rate." }, "average_block_time_50": { "type": "object", "required": [ "seconds", "sample_intervals" ], "properties": { "seconds": { "oneOf": [ { "$ref": "#/components/schemas/OverviewRatio", "description": "Tip-to-oldest timestamp span divided by the interval count." }, { "type": "null" } ], "description": "Tip-to-oldest timestamp span divided by the interval count. Null when unavailable." }, "sample_intervals": { "type": "integer", "description": "Actual interval count, at most 50.", "minimum": 0, "maximum": 50 } }, "additionalProperties": false, "description": "50-block average interval." }, "reward": { "$ref": "#/components/schemas/RewardStatistics", "description": "Current base subsidy schedule; next reduction uses Core 3/5 recurrence, not a literal 50% halving." }, "latest_blocks": { "type": "array", "description": "At most ten latest canonical blocks from the same committed snapshot.", "items": { "$ref": "#/components/schemas/OverviewBlock" }, "maxItems": 10 }, "time_since_last_block_seconds": { "type": "integer", "description": "Seconds since latest indexed block at as_of_unix.", "minimum": 0 }, "as_of_unix": { "type": "integer", "description": "Overview assembly time; clock-derived fields cached for at most 500 ms.", "minimum": 0 }, "market": { "oneOf": [ { "$ref": "#/components/schemas/OverviewMarket", "description": "Optional separate market adapter snapshot; null if disabled, unavailable or expired." }, { "type": "null" } ], "description": "Optional separate market adapter snapshot; null if disabled, unavailable or expired. Null when unavailable." } }, "additionalProperties": false }, "NetworkOverviewResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NetworkOverview", "description": "Operation result." } }, "additionalProperties": false }, "NetworkStatus": { "type": "object", "required": [ "network", "sync_state", "observed_core_height", "observed_header_height", "core_initial_block_download", "last_core_poll_at", "coverage" ], "properties": { "network": { "type": "string", "enum": [ "mainnet", "testnet" ], "description": "Network selected by this API deployment." }, "observed_header_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Fresh Core header height. Headers ahead of blocks indicate that Core itself has not caught up, even when the Indexer matches Core." }, "core_initial_block_download": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Fresh Core initial-block-download flag. Null when unavailable; wallet clients must not assume synchronized spending." }, "sync_state": { "type": "string", "enum": [ "ready", "catching_up", "upstream_unavailable", "maintenance", "unavailable" ], "description": "Indexer state: ready, catching_up, upstream_unavailable, maintenance or unavailable. upstream_unavailable keeps the committed indexed snapshot readable while current Core height is unknown." }, "observed_core_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Last successfully observed Core chain height; null while Core cannot be observed." }, "last_core_poll_at": { "oneOf": [ { "type": "string", "format": "date-time", "maxLength": 35, "description": "UTC RFC 3339 timestamp" }, { "type": "null" } ], "description": "UTC RFC 3339 timestamp of the last successful Core observation; null when unavailable." }, "coverage": { "type": "object", "required": [ "blocks", "transactions", "addresses", "models", "assets", "proof" ], "properties": { "blocks": { "$ref": "#/components/schemas/ModuleCoverage", "description": "Number of blocks, or block-module availability/coverage, as specified by the enclosing schema." }, "transactions": { "$ref": "#/components/schemas/ModuleCoverage", "description": "Complete observed mempool count, confirmed transaction count or transaction-module availability/coverage, according to this schema." }, "addresses": { "$ref": "#/components/schemas/ModuleCoverage", "description": "Requested addresses or address-module availability, as specified by this schema." }, "models": { "$ref": "#/components/schemas/ModuleCoverage", "description": "Availability or indexed coverage of the Models module." }, "assets": { "$ref": "#/components/schemas/ModuleCoverage", "description": "Availability or indexed coverage of the Assets module." }, "proof": { "$ref": "#/components/schemas/ModuleCoverage", "description": "Compact Proof facts, or Proof-module availability/coverage, as specified by this schema." } }, "additionalProperties": false, "description": "Indexed coverage for this module or sampled chart series; incomplete data is explicit." } }, "additionalProperties": false }, "ObservedField": { "oneOf": [ { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "maxLength": 4096, "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false }, { "type": "object", "required": [ "state", "value" ], "properties": { "state": { "const": "unsupported", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "value": { "type": "null", "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false }, { "type": "object", "required": [ "state", "value" ], "properties": { "state": { "const": "unavailable", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "value": { "type": "null", "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false } ], "description": "Explicit status for protocol/Core-derived fields pending source validation." }, "ObservedHeight": { "oneOf": [ { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false }, { "type": "object", "required": [ "state", "value" ], "properties": { "state": { "const": "unsupported", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "value": { "type": "null", "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false }, { "type": "object", "required": [ "state", "value" ], "properties": { "state": { "const": "unavailable", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "value": { "type": "null", "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false } ] }, "ObservedNumericField": { "oneOf": [ { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "maxLength": 128, "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false }, { "type": "object", "required": [ "state", "value" ], "properties": { "state": { "const": "unsupported", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "value": { "type": "null", "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false }, { "type": "object", "required": [ "state", "value" ], "properties": { "state": { "const": "unavailable", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "value": { "type": "null", "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false } ], "description": "Exact Core/protocol number encoded as a decimal string." }, "ObservedOptionalId": { "oneOf": [ { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "maxLength": 128, "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false }, { "type": "object", "required": [ "state", "value" ], "properties": { "state": { "const": "none", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "value": { "type": "null", "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false }, { "type": "object", "required": [ "state", "value" ], "properties": { "state": { "const": "unsupported", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "value": { "type": "null", "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false }, { "type": "object", "required": [ "state", "value" ], "properties": { "state": { "const": "unavailable", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "value": { "type": "null", "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false } ], "description": "No parent is distinct from an unknown or unavailable parent source." }, "ObservedPrecision": { "oneOf": [ { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false }, { "type": "object", "required": [ "state", "value" ], "properties": { "state": { "const": "unsupported", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "value": { "type": "null", "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false }, { "type": "object", "required": [ "state", "value" ], "properties": { "state": { "const": "unavailable", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "value": { "type": "null", "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." } }, "additionalProperties": false } ] }, "OutputSummary": { "type": "object", "required": [ "index", "address", "value", "spend_state" ], "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based input or output index within its transaction." }, "address": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "description": "Chain address text; null represents an unattributed output where allowed." }, "value": { "$ref": "#/components/schemas/Amount", "description": "Exact observed value or attributed input/output quantity. Null accompanies an unknown, unavailable or unsupported state where declared." }, "spend_state": { "type": "string", "enum": [ "unspent", "spent", "unknown", "unavailable", "unconfirmed" ], "description": "Output state: spent, unspent or unconfirmed; pending spends are not treated as confirmed spends." }, "spent_by_txid": { "oneOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "description": "Confirmed spending transaction ID, or null when no confirmed spend exists." } }, "additionalProperties": false, "description": "Spend state is at the serving response snapshot, independently of pagination." }, "OutputSummaryPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OutputSummary" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "OverviewBlock": { "type": "object", "required": [ "height", "hash", "time", "tx_count", "miner", "age_seconds" ], "properties": { "height": { "type": "integer", "description": "Canonical block height.", "minimum": 0 }, "hash": { "type": "string", "description": "Canonical block hash.", "pattern": "^[0-9a-f]{64}$" }, "time": { "type": "integer", "description": "Header time in Unix seconds.", "minimum": 0 }, "tx_count": { "type": "integer", "description": "Block transactions including coinbase.", "minimum": 0 }, "miner": { "oneOf": [ { "type": "string", "description": "Attributed coinbase payout address." }, { "type": "null" } ], "description": "Attributed coinbase payout address. Null when unavailable." }, "age_seconds": { "type": "integer", "description": "Seconds since header timestamp at as_of_unix, clamped to zero.", "minimum": 0 } }, "additionalProperties": false }, "OverviewMarket": { "type": "object", "required": [ "pair", "price_usdt", "price_change_percent_24h", "volume_24h_usdt", "volume_24h_tsc", "source", "observed_at_unix" ], "properties": { "pair": { "type": "string", "description": "Trading pair.", "enum": [ "TSC/USDT" ] }, "price_usdt": { "type": "string", "description": "Exact observed market price in USDT per TSC." }, "price_change_percent_24h": { "oneOf": [ { "type": "string", "description": "Reported 24-hour percentage change." }, { "type": "null" } ], "description": "Reported 24-hour percentage change. Null when unavailable." }, "volume_24h_usdt": { "oneOf": [ { "type": "string", "description": "Reported 24-hour quote volume." }, { "type": "null" } ], "description": "Reported 24-hour quote volume. Null when unavailable." }, "volume_24h_tsc": { "oneOf": [ { "type": "string", "description": "Reported 24-hour base volume." }, { "type": "null" } ], "description": "Reported 24-hour base volume. Null when unavailable." }, "source": { "oneOf": [ { "type": "string", "description": "Market adapter source label." }, { "type": "null" } ], "description": "Market adapter source label. Null when unavailable." }, "observed_at_unix": { "type": "integer", "description": "Source price observation time.", "minimum": 0 } }, "additionalProperties": false }, "OverviewRatio": { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "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." }, "PageInfo": { "type": "object", "required": [ "limit", "number", "total", "total_pages" ], "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Requested maximum number of rows in this page." }, "number": { "type": "integer", "minimum": 1, "maximum": 9223372036854776000, "description": "One-based requested page number, default 1." }, "total": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Exact number of rows in the collection at the selected snapshot." }, "total_pages": { "type": "integer", "minimum": 1, "maximum": 9223372036854776000, "description": "Number of numbered pages, with a minimum of 1 for an empty collection." } }, "additionalProperties": false, "description": "Numbered pagination. Page defaults to 1. Totals and rows belong to the same database snapshot; current-state collections may move between requests. Empty collections have one page." }, "PendingAddressActivity": { "type": "object", "required": [ "txid", "state", "time", "received", "sent", "delta" ], "properties": { "txid": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal transaction ID; searches accept either case." }, "state": { "const": "pending", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." }, "block_height": { "type": "null", "description": "Zero-based height of the containing canonical block; null for pending activity where allowed." }, "is_coinbase": { "const": false, "description": "Whether this transaction or input is a coinbase reward." }, "received": { "$ref": "#/components/schemas/Amount", "description": "Exact quantity received by this address in smallest units." }, "sent": { "$ref": "#/components/schemas/Amount", "description": "Exact quantity spent by this address in smallest units." }, "delta": { "$ref": "#/components/schemas/Amount", "description": "Signed received-minus-sent quantity in smallest units." }, "from_addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AddressFlow" }, "maxItems": 2, "description": "At most two source-address summaries; the current address is shown first when present." }, "to_addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AddressFlow" }, "maxItems": 2, "description": "At most two destination-address summaries; the current address is shown first when present." }, "from_address_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of distinct attributed source addresses, including those omitted from the compact summary." }, "to_address_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of distinct attributed destination addresses, including those omitted from the compact summary." } }, "additionalProperties": false }, "PendingAddressActivityPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PendingAddressActivity" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "PoolMiner": { "type": "object", "required": [ "address", "block_count", "base_work", "effective_work", "work_share", "last_height", "last_time", "average_price_multiplier" ], "properties": { "address": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "description": "Chain address text; null represents an unattributed output where allowed." }, "block_count": { "type": "integer", "minimum": 1, "maximum": 9223372036854776000, "description": "Number of blocks represented by this resource or group." }, "base_work": { "oneOf": [ { "type": "string", "pattern": "^[0-9]+$", "maxLength": 100 }, { "type": "null" } ], "description": "Exact target-derived work before Proof pricing, encoded as a decimal string." }, "effective_work": { "oneOf": [ { "type": "string", "pattern": "^[0-9]+$", "maxLength": 100 }, { "type": "null" } ], "description": "Exact Proof-priced work as a decimal string; null when required evidence is unavailable." }, "work_share": { "oneOf": [ { "$ref": "#/components/schemas/WorkShare" }, { "type": "null" } ], "description": "Fraction 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_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Last height represented by this group or series." }, "last_time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp of this miner group's latest observed block." }, "average_price_multiplier": { "oneOf": [ { "$ref": "#/components/schemas/AveragePriceRatio" }, { "type": "null" } ], "description": "Mean 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." } }, "additionalProperties": false }, "PoolRemainder": { "type": "object", "required": [ "group_count", "block_count", "base_work", "effective_work", "work_share" ], "properties": { "group_count": { "type": "integer", "minimum": 1, "maximum": 9223372036854776000, "description": "Number of miner groups combined into the remainder." }, "block_count": { "type": "integer", "minimum": 1, "maximum": 9223372036854776000, "description": "Number of blocks represented by this resource or group." }, "base_work": { "oneOf": [ { "type": "string", "pattern": "^[0-9]+$", "maxLength": 100 }, { "type": "null" } ], "description": "Exact target-derived work before Proof pricing, encoded as a decimal string." }, "effective_work": { "oneOf": [ { "type": "string", "pattern": "^[0-9]+$", "maxLength": 100 }, { "type": "null" } ], "description": "Exact Proof-priced work as a decimal string; null when required evidence is unavailable." }, "work_share": { "oneOf": [ { "$ref": "#/components/schemas/WorkShare" }, { "type": "null" } ], "description": "Fraction 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." } }, "additionalProperties": false, "description": "Combined remainder when more than 100 miner groups are in the range." }, "PoolStatistics": { "type": "object", "required": [ "range", "start_time", "end_time", "start_height", "end_height", "observed_seconds", "total_blocks", "active_miners", "unknown_blocks", "work_complete", "base_work_complete", "total_work", "base_total_work", "known_work_share", "items", "remainder" ], "properties": { "range": { "type": "string", "enum": [ "12h", "24h", "48h", "7d" ], "description": "Selected named time range; the supported values are endpoint-specific." }, "start_time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Start of the selected time window in Unix seconds." }, "end_time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "End of the selected window in Unix seconds." }, "start_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "First inclusive canonical height represented by the window or candle." }, "end_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Final inclusive canonical height represented by the window or candle." }, "observed_seconds": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Observed timestamp span used as the work-rate denominator; zero cannot produce a valid rate." }, "total_blocks": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Total observed canonical blocks in the selected miner window." }, "active_miners": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of payout-address groups with observed blocks in the window." }, "unknown_blocks": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Observed blocks lacking required indexed work evidence." }, "work_complete": { "type": "boolean", "description": "Whether every block needed for this work calculation has exact indexed work." }, "base_work_complete": { "type": "boolean", "description": "Whether every block in the window has indexed base work." }, "total_work": { "oneOf": [ { "type": "string", "pattern": "^[0-9]+$", "maxLength": 100 }, { "type": "null" } ], "description": "Exact summed effective work in the selected window as a decimal string." }, "base_total_work": { "oneOf": [ { "type": "string", "pattern": "^[0-9]+$", "maxLength": 100 }, { "type": "null" } ], "description": "Exact summed base work for the selected window, encoded as a decimal string." }, "known_work_share": { "oneOf": [ { "$ref": "#/components/schemas/WorkShare" }, { "type": "null" } ], "description": "Fraction 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." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PoolMiner" }, "maxItems": 100, "description": "Resource items in the ordering specified by the endpoint." }, "remainder": { "oneOf": [ { "$ref": "#/components/schemas/PoolRemainder" }, { "type": "null" } ], "description": "Other miner groups combined without losing their exact work/count totals." } }, "additionalProperties": false, "description": "Exact work-weighted Pool totals for a fixed recent range. Incomplete work yields null total and share fields; never infer zero or 1x.", "allOf": [ { "if": { "properties": { "work_complete": { "const": false } } }, "then": { "properties": { "total_work": { "type": "null" }, "known_work_share": { "type": "null" } } } }, { "if": { "properties": { "base_work_complete": { "const": false } } }, "then": { "properties": { "base_total_work": { "type": "null" } } } } ] }, "PoolStatisticsResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PoolStatistics", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "Problem": { "type": "object", "required": [ "type", "title", "status", "code", "request_id" ], "properties": { "type": { "type": "string", "maxLength": 256, "description": "Problem type URI; about:blank is used for the current error family." }, "title": { "type": "string", "maxLength": 256, "description": "Short human-readable problem title, normally the stable error code." }, "status": { "type": "integer", "minimum": 400, "maximum": 599, "description": "HTTP status code for this problem response." }, "code": { "type": "string", "enum": [ "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" ], "description": "Stable machine-readable error code; use this instead of matching message text." }, "request_id": { "type": "string", "maxLength": 128, "description": "Identifier also supplied in X-Request-ID; include it when reporting an error." }, "detail": { "type": "string", "maxLength": 2048, "description": "Human-readable explanation of the error." }, "retry_after_seconds": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Suggested wait in seconds before retrying; where present, agrees with Retry-After." } }, "additionalProperties": false }, "Proof": { "type": "object", "required": [ "block_hash", "protocol_version", "numeric_value", "coverage", "price_multiplier", "price_source", "near_pin_count", "price_components" ], "properties": { "block_hash": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "Hash of the containing canonical block." }, "protocol_version": { "$ref": "#/components/schemas/ObservedField", "description": "Observed Proof protocol version; unavailable and unsupported states are explicit." }, "numeric_value": { "$ref": "#/components/schemas/ObservedNumericField", "description": "Core's exact decimal difficulty string; unknown/unavailable state is explicit." }, "coverage": { "$ref": "#/components/schemas/ModuleCoverage", "description": "Indexed coverage for this module or sampled chart series; incomplete data is explicit." }, "price_multiplier": { "oneOf": [ { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "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": "null" } ], "description": "Protocol Proof price multiplier, e.g. '2' means 2x. Separate from Market prices; null means unavailable." }, "price_source": { "oneOf": [ { "const": "computed_from_raw_proof" }, { "type": "null" } ], "description": "Origin of the indexed Proof calculation; null for unpriced legacy Proof." }, "near_pin_count": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 256 }, { "type": "null" } ], "description": "Observed near-pin count used in Proof pricing, or null when unavailable." }, "price_components": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "profile", "late", "pin", "state" ], "properties": { "profile": { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "Profile factor contributing to the Proof multiplier." }, "late": { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "Late factor contributing to the Proof multiplier." }, "pin": { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "Pin factor contributing to the Proof multiplier." }, "state": { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "State factor contributing to the Proof multiplier." } } }, { "type": "null" } ], "description": "Individual Proof multiplier factors; null for unpriced legacy Proof." } }, "additionalProperties": false, "description": "numeric_value is Core's exact decimal difficulty spelling, not the optional price ratio." }, "ProofResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Proof", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "ProofStatistics": { "type": "object", "required": [ "coverage", "priced_blocks", "v3_blocks", "v4_blocks", "above_2x", "average_price_multiplier", "median_price_multiplier", "max_price_multiplier", "latest" ], "properties": { "coverage": { "type": "object", "required": [ "through_height", "complete" ], "properties": { "through_height": { "type": "integer", "minimum": -1, "maximum": 9223372036854776000, "description": "Highest canonical height covered by this module; -1 means no indexed coverage." }, "complete": { "type": "boolean", "description": "Whether indexed data covers every required canonical block through the stated height." } }, "additionalProperties": false, "description": "Indexed coverage for this module or sampled chart series; incomplete data is explicit." }, "priced_blocks": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of blocks with exact indexed Proof price evidence." }, "v3_blocks": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of indexed blocks with Proof protocol version 3." }, "v4_blocks": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of indexed blocks with Proof protocol version 4." }, "above_2x": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of priced blocks whose exact Proof price exceeds 2." }, "average_price_multiplier": { "oneOf": [ { "$ref": "#/components/schemas/AveragePriceRatio" }, { "type": "null" } ], "description": "Mean 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." }, "median_price_multiplier": { "oneOf": [ { "$ref": "#/components/schemas/ExactPriceRatio" }, { "type": "null" } ], "description": "Median protocol Proof price multiplier; null means unavailable. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places." }, "max_price_multiplier": { "oneOf": [ { "$ref": "#/components/schemas/ExactPriceRatio" }, { "type": "null" } ], "description": "Maximum protocol Proof price multiplier; null means unavailable. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places." }, "latest": { "oneOf": [ { "type": "object", "required": [ "height", "version", "price_multiplier" ], "properties": { "height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based canonical block height." }, "version": { "type": "integer", "minimum": 3, "maximum": 255, "description": "Exact Core header/transaction version or indexed Proof version, according to the enclosing resource." }, "price_multiplier": { "$ref": "#/components/schemas/ExactPriceRatio", "description": "Protocol Proof price multiplier, e.g. '2' means 2x. Separate from Market prices; null means unavailable. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places." } }, "additionalProperties": false }, { "type": "null" } ], "description": "Latest indexed priced block and its Proof version/ratio; null when no priced block exists." } }, "additionalProperties": false, "description": "A partial coverage flag means these statistics include observed priced blocks only. Null prices never imply 1x." }, "ProofStatisticsResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProofStatistics", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "RecentTransaction": { "type": "object", "required": [ "txid", "block", "position", "time", "is_coinbase", "input_count", "output_count", "total_output", "fee" ], "properties": { "txid": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal transaction ID; searches accept either case." }, "block": { "$ref": "#/components/schemas/ChainPoint", "description": "Containing canonical block, or null for an unconfirmed transaction." }, "position": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based transaction position in its containing block." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." }, "is_coinbase": { "type": "boolean", "description": "Whether this transaction or input is a coinbase reward." }, "input_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of transaction inputs." }, "output_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of transaction outputs." }, "total_output": { "$ref": "#/components/schemas/Amount", "description": "Exact sum of all outputs of this transaction in TSC smallest units; never a fiat value." }, "fee": { "oneOf": [ { "$ref": "#/components/schemas/Amount" }, { "type": "null" } ], "description": "Exact input total minus output total; null for coinbase where specified, otherwise unknown if prevouts are unavailable." } }, "additionalProperties": false, "description": "Compact confirmed transaction feed; null fee means coinbase reward." }, "RecentTransactionPage": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RecentTransaction" }, "maxItems": 100, "description": "The requested resource or collection; its schema is specific to this endpoint." }, "page": { "$ref": "#/components/schemas/PageInfo", "description": "Pagination metadata separate from resource rows." } }, "additionalProperties": false }, "RegistryHistoryBucket": { "type": "object", "required": [ "from_height", "to_height", "count" ], "properties": { "from_height": { "type": "integer", "minimum": 0, "description": "Inclusive first block height of the interval.", "maximum": 9223372036854776000 }, "to_height": { "type": "integer", "minimum": 0, "description": "Inclusive last block height, clipped to through_height for the newest interval.", "maximum": 9223372036854776000 }, "count": { "type": "integer", "minimum": 0, "description": "Canonical model blocks or asset/transaction pairs in this interval, according to the resource.", "maximum": 9223372036854776000 } }, "additionalProperties": false, "description": "Nonempty height bucket. Missing intervals have zero events." }, "RegistryOverview": { "type": "object", "required": [ "model_count", "mining_model_count", "asset_count", "root_asset_count", "child_asset_count", "asset_transaction_count" ], "properties": { "model_count": { "type": "integer", "minimum": 0, "description": "Number of currently registered model identities, including pending, locked and banned registrations.", "maximum": 9223372036854776000 }, "mining_model_count": { "type": "integer", "minimum": 0, "description": "Models whose current status is registered and eligible for mining.", "maximum": 9223372036854776000 }, "asset_count": { "type": "integer", "minimum": 0, "description": "Number of current asset identifiers; quantities are never summed across assets.", "maximum": 9223372036854776000 }, "root_asset_count": { "type": "integer", "minimum": 0, "description": "Assets with a root ticker, without a parent namespace.", "maximum": 9223372036854776000 }, "child_asset_count": { "type": "integer", "minimum": 0, "description": "Assets whose ticker belongs to a parent namespace.", "maximum": 9223372036854776000 }, "asset_transaction_count": { "type": "integer", "minimum": 0, "description": "Lifetime asset/transaction pairs. One transaction involving two assets counts twice; registrations without unit movements are excluded.", "maximum": 9223372036854776000 } }, "additionalProperties": false, "description": "Incremental registry counts at the response snapshot. Requires complete model and basic asset coverage." }, "RegistryOverviewResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/RegistryOverview", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "RewardEpochProgress": { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "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." }, "RewardStatistics": { "type": "object", "required": [ "height", "terminal", "current_reward_units", "next_reward_units", "epoch_start_height", "epoch_length_blocks", "epoch_progress", "next_reduction_height", "blocks_remaining" ], "properties": { "height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Zero-based canonical block height." }, "terminal": { "type": "boolean", "description": "Whether the subsidy has reached zero and no future reward epoch exists." }, "current_reward_units": { "type": "string", "pattern": "^[0-9]+$", "maxLength": 20, "description": "Exact base block subsidy at this height, in TSC smallest units; transaction fees are excluded." }, "next_reward_units": { "type": "string", "pattern": "^[0-9]+$", "maxLength": 20, "description": "Exact next-epoch base subsidy in TSC smallest units." }, "epoch_start_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "First height in the current reward epoch; null in the terminal state." }, "epoch_length_blocks": { "oneOf": [ { "type": "integer", "minimum": 715, "maximum": 732160 }, { "type": "null" } ], "description": "Length of the current reward epoch; null in the terminal zero-subsidy state." }, "epoch_progress": { "oneOf": [ { "$ref": "#/components/schemas/RewardEpochProgress" }, { "type": "null" } ], "description": "Elapsed fraction of the current reward epoch, e.g. '0.5' means 50%; null in the terminal state. Finite ratios are exact; only repeating decimals are rounded half away from zero to 12 places." }, "next_reduction_height": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Height at which the next subsidy epoch begins; null in the terminal state." }, "blocks_remaining": { "oneOf": [ { "type": "integer", "minimum": 1, "maximum": 732160 }, { "type": "null" } ], "description": "Blocks until the next subsidy reduction; null after the subsidy becomes zero." } }, "additionalProperties": false, "description": "TensorCash Core subsidy recurrence at the indexed tip. Amounts are exact 8-decimal TSC base-unit strings; terminal zero has no next epoch or time estimate.", "allOf": [ { "if": { "properties": { "terminal": { "const": true } } }, "then": { "properties": { "current_reward_units": { "const": "0" }, "next_reward_units": { "const": "0" }, "epoch_start_height": { "type": "null" }, "epoch_length_blocks": { "type": "null" }, "epoch_progress": { "type": "null" }, "next_reduction_height": { "type": "null" }, "blocks_remaining": { "type": "null" } } }, "else": { "properties": { "current_reward_units": { "type": "string", "pattern": "^[1-9][0-9]*$", "maxLength": 20 }, "epoch_start_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "epoch_length_blocks": { "type": "integer", "minimum": 715, "maximum": 732160 }, "epoch_progress": { "$ref": "#/components/schemas/RewardEpochProgress" }, "next_reduction_height": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "blocks_remaining": { "type": "integer", "minimum": 1, "maximum": 732160 } } } } ] }, "RewardStatisticsResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/RewardStatistics", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "StatusResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NetworkStatus", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "TransactionDetail": { "type": "object", "required": [ "txid", "state", "block", "size_bytes", "input_count", "output_count", "fee" ], "properties": { "txid": { "type": "string", "pattern": "^[0-9a-fA-F]{64}$", "description": "64-character hexadecimal transaction ID; searches accept either case." }, "state": { "type": "string", "enum": [ "confirmed", "unconfirmed", "pending" ], "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "block": { "oneOf": [ { "$ref": "#/components/schemas/ChainPoint" }, { "type": "null" } ], "description": "Containing canonical block, or null for an unconfirmed transaction." }, "size_bytes": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Serialized block or transaction size in bytes." }, "input_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of transaction inputs." }, "output_count": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Number of transaction outputs." }, "fee": { "$ref": "#/components/schemas/Amount", "description": "Exact input total minus output total; null for coinbase where specified, otherwise unknown if prevouts are unavailable." }, "time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Unix timestamp in seconds; mempool items use Core arrival time and confirmed items use block time." }, "version": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Exact Core header/transaction version or indexed Proof version, according to the enclosing resource." }, "lock_time": { "type": "integer", "minimum": 0, "maximum": 9223372036854776000, "description": "Core transaction lock-time value; values below 500000000 denote block height, otherwise Unix time." }, "weight": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, { "type": "null" } ], "description": "Core block/transaction weight; null or omitted where the exact value is unavailable." }, "total_output": { "$ref": "#/components/schemas/Amount", "description": "Exact sum of all outputs of this transaction in TSC smallest units; never a fiat value." } }, "additionalProperties": false, "allOf": [ { "if": { "properties": { "state": { "const": "confirmed" } } }, "then": { "properties": { "block": { "$ref": "#/components/schemas/ChainPoint" } } }, "else": { "properties": { "block": { "type": "null" } } } } ] }, "TransactionDetailResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/TransactionDetail", "description": "The requested resource or collection; its schema is specific to this endpoint." } }, "additionalProperties": false }, "TransactionState": { "type": "object", "required": [ "txid", "state", "confirmations", "block", "mempool_time", "observed_at_unix" ], "properties": { "txid": { "type": "string", "description": "Queried transaction identifier.", "pattern": "^[0-9a-f]{64}$" }, "state": { "type": "string", "description": "Confirmed inclusion at a verified indexed checkpoint, or live Core observation for unindexed/pending/unknown transactions. not_found requires synchronized Core txindex and does not prove the transaction never existed.", "enum": [ "pending", "confirmed", "not_found" ] }, "confirmations": { "type": "integer", "description": "Confirmations at X-Chain-Height when indexed chain headers are present; otherwise the live Core observation. Zero if pending/not found. Indexed counts never use an unverified observed Core height.", "minimum": 0 }, "block": { "oneOf": [ { "type": "object", "required": [ "hash", "time" ], "properties": { "hash": { "type": "string", "description": "Containing canonical block.", "pattern": "^[0-9a-f]{64}$" }, "time": { "type": "integer", "description": "Block timestamp in Unix seconds.", "minimum": 0 } }, "additionalProperties": false, "description": "Confirmed block." }, { "type": "null" } ], "description": "Confirmed block. Null when unavailable." }, "mempool_time": { "oneOf": [ { "type": "integer", "description": "Core mempool entry time in Unix seconds.", "minimum": 0 }, { "type": "null" } ], "description": "Core mempool entry time in Unix seconds. Null when unavailable." }, "observed_at_unix": { "type": "integer", "description": "Status projection/observation time in Unix seconds. Core observations may be reused for at most 500 ms; indexed confirmation counts are derived from the current verified checkpoint.", "minimum": 0 } }, "additionalProperties": false }, "TransactionStateResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/TransactionState", "description": "Operation result." } }, "additionalProperties": false }, "UnavailableAmount": { "type": "object", "required": [ "state", "units", "precision" ], "properties": { "state": { "const": "unavailable", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "units": { "type": "null", "description": "Exact decimal string in smallest units; signed where the schema permits. Divide by 10^precision only for display." }, "precision": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 30 }, { "type": "null" } ], "description": "Decimal places for the smallest-unit amount. TSC uses 8; assets use their indexed precision." } }, "additionalProperties": false }, "UnknownAmount": { "type": "object", "required": [ "state", "units", "precision" ], "properties": { "state": { "const": "unknown", "description": "Availability or confirmation state. Use the declared enum/constant; unknown or unavailable never means numeric zero." }, "units": { "type": "null", "description": "Exact decimal string in smallest units; signed where the schema permits. Divide by 10^precision only for display." }, "precision": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 30 }, { "type": "null" } ], "description": "Decimal places for the smallest-unit amount. TSC uses 8; assets use their indexed precision." } }, "additionalProperties": false }, "WorkShare": { "type": "string", "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$", "description": "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." } } }, "security": [] }