openapi: 3.0.3 info: title: Stacks Blockchain API description: Welcome to the API reference overview for the [Stacks Blockchain API](https://docs.hiro.so/stacks-blockchain-api). [Download Postman collection](https://hirosystems.github.io/stacks-blockchain-api/collection.json). version: 9.6.0 components: schemas: {} paths: /extended: get: operationId: get_status summary: API status tags: - Info description: Retrieves the running status of the Stacks Blockchain API, including the server version and current chain tip information. responses: "200": description: Default Response content: application/json: schema: title: Api Status Response type: object required: - server_version - status properties: server_version: description: the server version that is currently running type: string status: description: the current server status type: string chain_tip: anyOf: - type: object required: - block_height - block_hash - index_block_hash - burn_block_height properties: block_height: description: the current block height type: integer block_hash: description: the current block hash type: string index_block_hash: description: the current index block hash type: string burn_block_height: description: the current burn chain block height type: integer - type: "null" 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/blocks/: get: operationId: get_blocks summary: Get blocks tags: - Blocks description: Retrieves a list of recently mined blocks parameters: - schema: minimum: 0 default: 20 maximum: 30 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: default: 0 maximum: 300 minimum: -300 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: pattern: ^0x[a-fA-F0-9]{64}$ type: string in: query name: cursor required: false description: Cursor for block pagination responses: "200": description: Default Response content: application/json: schema: type: object required: - limit - offset - total - next_cursor - prev_cursor - cursor - results properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 next_cursor: anyOf: - description: Next page cursor type: string - type: "null" prev_cursor: anyOf: - description: Previous page cursor type: string - type: "null" cursor: anyOf: - description: Current page cursor type: string - type: "null" results: type: array items: type: object required: - canonical - height - hash - block_time - block_time_iso - tenure_height - index_block_hash - parent_block_hash - parent_index_block_hash - burn_block_time - burn_block_time_iso - burn_block_hash - burn_block_height - miner_txid - tx_count - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length properties: canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean height: description: Height of the block type: integer hash: description: Hash representing the block type: string block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string tenure_height: description: The tenure height (AKA coinbase height) of this block type: integer index_block_hash: description: The only hash that can uniquely identify an anchored block or an unconfirmed state trie type: string parent_block_hash: description: Hash of the parent block type: string parent_index_block_hash: description: Index block hash of the parent block type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_hash: description: Hash of the anchor chain block type: string burn_block_height: description: Height of the anchor chain block type: integer miner_txid: description: Anchor chain transaction ID type: string tx_count: description: Number of transactions included in the block type: integer execution_cost_read_count: description: Execution cost read count. type: integer execution_cost_read_length: description: Execution cost read length. type: integer execution_cost_runtime: description: Execution cost runtime. type: integer execution_cost_write_count: description: Execution cost write count. type: integer execution_cost_write_length: description: Execution cost write length. type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/blocks/average-times: get: operationId: get_average_block_times summary: Get average block times tags: - Blocks description: Retrieves average block times (in seconds) responses: "200": description: Default Response content: application/json: schema: type: object required: - last_1h - last_24h - last_7d - last_30d properties: last_1h: description: Average block times over the last hour (in seconds) type: number last_24h: description: Average block times over the last 24 hours (in seconds) type: number last_7d: description: Average block times over the last 7 days (in seconds) type: number last_30d: description: Average block times over the last 30 days (in seconds) type: number 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/blocks/by-block-time/{timestamp}: get: operationId: get_block_by_block_time summary: Get block by block time tags: - Blocks description: Retrieves the most recent block mined at or before a given Unix timestamp (in seconds) parameters: - schema: minimum: 0 title: Block timestamp type: integer example: 1677731361 in: path name: timestamp required: true description: Unix timestamp (in seconds) responses: "200": description: Default Response content: application/json: schema: type: object required: - canonical - height - hash - block_time - block_time_iso - tenure_height - index_block_hash - parent_block_hash - parent_index_block_hash - burn_block_time - burn_block_time_iso - burn_block_hash - burn_block_height - miner_txid - tx_count - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length properties: canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean height: description: Height of the block type: integer hash: description: Hash representing the block type: string block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string tenure_height: description: The tenure height (AKA coinbase height) of this block type: integer index_block_hash: description: The only hash that can uniquely identify an anchored block or an unconfirmed state trie type: string parent_block_hash: description: Hash of the parent block type: string parent_index_block_hash: description: Index block hash of the parent block type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_hash: description: Hash of the anchor chain block type: string burn_block_height: description: Height of the anchor chain block type: integer miner_txid: description: Anchor chain transaction ID type: string tx_count: description: Number of transactions included in the block type: integer execution_cost_read_count: description: Execution cost read count. type: integer execution_cost_read_length: description: Execution cost read length. type: integer execution_cost_runtime: description: Execution cost runtime. type: integer execution_cost_write_count: description: Execution cost write count. type: integer execution_cost_write_length: description: Execution cost write length. type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/blocks/{height_or_hash}: get: operationId: get_block summary: Get block tags: - Blocks description: Retrieves a single block parameters: - schema: anyOf: - type: string enum: - latest - pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Block hash description: Block hash examples: - daf79950c5e8bb0c620751333967cdd62297137cdaf79950c5e8bb0c62075133 type: string - title: Block height description: Block height examples: - 777678 type: integer in: path name: height_or_hash required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - canonical - height - hash - block_time - block_time_iso - tenure_height - index_block_hash - parent_block_hash - parent_index_block_hash - burn_block_time - burn_block_time_iso - burn_block_hash - burn_block_height - miner_txid - tx_count - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length properties: canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean height: description: Height of the block type: integer hash: description: Hash representing the block type: string block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string tenure_height: description: The tenure height (AKA coinbase height) of this block type: integer index_block_hash: description: The only hash that can uniquely identify an anchored block or an unconfirmed state trie type: string parent_block_hash: description: Hash of the parent block type: string parent_index_block_hash: description: Index block hash of the parent block type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_hash: description: Hash of the anchor chain block type: string burn_block_height: description: Height of the anchor chain block type: integer miner_txid: description: Anchor chain transaction ID type: string tx_count: description: Number of transactions included in the block type: integer execution_cost_read_count: description: Execution cost read count. type: integer execution_cost_read_length: description: Execution cost read length. type: integer execution_cost_runtime: description: Execution cost runtime. type: integer execution_cost_write_count: description: Execution cost write count. type: integer execution_cost_write_length: description: Execution cost write length. type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/blocks/{height_or_hash}/signer-signatures: get: operationId: get_signer_signatures_for_block summary: Get signer signatures for block tags: - Blocks description: Retrieves the signer signatures (an array of signature byte strings) in a single block parameters: - schema: minimum: 0 default: 500 maximum: 1000 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: anyOf: - type: string enum: - latest - pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Block hash description: Block hash examples: - daf79950c5e8bb0c620751333967cdd62297137cdaf79950c5e8bb0c62075133 type: string - title: Block height description: Block height examples: - 777678 type: integer in: path name: height_or_hash required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - limit - offset - total - results properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: description: Array of hex strings representing the block's signer signature type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/burn-blocks/: get: operationId: get_burn_blocks summary: Get burn blocks tags: - Burn Blocks description: Retrieves a list of recent burn blocks parameters: - schema: minimum: 0 default: 20 maximum: 30 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset responses: "200": description: Default Response content: application/json: schema: type: object required: - limit - offset - total - results properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: type: object required: - burn_block_time - burn_block_time_iso - burn_block_hash - burn_block_height - stacks_blocks - avg_block_time - total_tx_count properties: burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_hash: description: Hash of the anchor chain block type: string burn_block_height: description: Height of the anchor chain block type: integer stacks_blocks: description: Hashes of the Stacks blocks included in the burn block type: array items: type: string avg_block_time: description: Average time between blocks in seconds. Returns 0 if there is only one block in the burn block. type: integer total_tx_count: description: Total number of transactions in the Stacks blocks associated with this burn block type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/burn-blocks/{height_or_hash}: get: operationId: get_burn_block summary: Get burn block tags: - Burn Blocks description: Retrieves a single burn block parameters: - schema: anyOf: - type: string enum: - latest - pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Burn block hash description: Burn block hash examples: - 0000000000000000000452773967cdd62297137cdaf79950c5e8bb0c62075133 type: string - title: Burn block height description: Burn block height examples: - 777678 type: integer in: path name: height_or_hash required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - burn_block_time - burn_block_time_iso - burn_block_hash - burn_block_height - stacks_blocks - avg_block_time - total_tx_count properties: burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_hash: description: Hash of the anchor chain block type: string burn_block_height: description: Height of the anchor chain block type: integer stacks_blocks: description: Hashes of the Stacks blocks included in the burn block type: array items: type: string avg_block_time: description: Average time between blocks in seconds. Returns 0 if there is only one block in the burn block. type: integer total_tx_count: description: Total number of transactions in the Stacks blocks associated with this burn block type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/burn-blocks/{height_or_hash}/blocks: get: operationId: get_blocks_by_burn_block summary: Get blocks by burn block tags: - Burn Blocks description: Retrieves a list of blocks confirmed by a specific burn block parameters: - schema: minimum: 0 default: 20 maximum: 30 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: anyOf: - type: string enum: - latest - pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Burn block hash description: Burn block hash examples: - 0000000000000000000452773967cdd62297137cdaf79950c5e8bb0c62075133 type: string - title: Burn block height description: Burn block height examples: - 777678 type: integer in: path name: height_or_hash required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - limit - offset - total - results properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: type: object required: - canonical - height - hash - block_time - block_time_iso - tenure_height - index_block_hash - parent_block_hash - parent_index_block_hash - burn_block_time - burn_block_time_iso - burn_block_hash - burn_block_height - miner_txid - tx_count - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length properties: canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean height: description: Height of the block type: integer hash: description: Hash representing the block type: string block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string tenure_height: description: The tenure height (AKA coinbase height) of this block type: integer index_block_hash: description: The only hash that can uniquely identify an anchored block or an unconfirmed state trie type: string parent_block_hash: description: Hash of the parent block type: string parent_index_block_hash: description: Index block hash of the parent block type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_hash: description: Hash of the anchor chain block type: string burn_block_height: description: Height of the anchor chain block type: integer miner_txid: description: Anchor chain transaction ID type: string tx_count: description: Number of transactions included in the block type: integer execution_cost_read_count: description: Execution cost read count. type: integer execution_cost_read_length: description: Execution cost read length. type: integer execution_cost_runtime: description: Execution cost runtime. type: integer execution_cost_write_count: description: Execution cost write count. type: integer execution_cost_write_length: description: Execution cost write length. type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/burn-blocks/{height_or_hash}/pox-transactions: get: operationId: get_burn_block_pox_transactions summary: Get PoX transactions by burn block tags: - Proof of Transfer description: Retrieves a list of PoX transactions confirmed by a specific burn block parameters: - schema: minimum: 0 default: 20 maximum: 30 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: anyOf: - type: string enum: - latest - pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Burn block hash description: Burn block hash examples: - 0000000000000000000452773967cdd62297137cdaf79950c5e8bb0c62075133 type: string - title: Burn block height description: Burn block height examples: - 777678 type: integer in: path name: height_or_hash required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - limit - offset - total - results properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: type: object required: - burn_block_height - burn_block_hash - tx_id - recipient - utxo_idx - amount properties: burn_block_height: description: Height of the burn block type: integer burn_block_hash: description: Hash of the burn block type: string tx_id: description: Transaction ID type: string recipient: description: Recipient address type: string utxo_idx: description: UTXO index type: integer amount: description: Amount type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/block-tenures/{tenure_height}/blocks: get: operationId: get_tenure_blocks summary: Get blocks by tenure tags: - Blocks description: Retrieves blocks confirmed in a block tenure parameters: - schema: minimum: 0 default: 20 maximum: 30 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: default: 0 maximum: 300 minimum: -300 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: pattern: ^0x[a-fA-F0-9]{64}$ type: string in: query name: cursor required: false description: Cursor for block pagination - schema: minimum: 0 title: Block tenure height type: integer example: 165453 in: path name: tenure_height required: true description: Block tenure height responses: "200": description: Default Response content: application/json: schema: type: object required: - limit - offset - total - next_cursor - prev_cursor - cursor - results properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 next_cursor: anyOf: - description: Next page cursor type: string - type: "null" prev_cursor: anyOf: - description: Previous page cursor type: string - type: "null" cursor: anyOf: - description: Current page cursor type: string - type: "null" results: type: array items: type: object required: - canonical - height - hash - block_time - block_time_iso - tenure_height - index_block_hash - parent_block_hash - parent_index_block_hash - burn_block_time - burn_block_time_iso - burn_block_hash - burn_block_height - miner_txid - tx_count - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length properties: canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean height: description: Height of the block type: integer hash: description: Hash representing the block type: string block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string tenure_height: description: The tenure height (AKA coinbase height) of this block type: integer index_block_hash: description: The only hash that can uniquely identify an anchored block or an unconfirmed state trie type: string parent_block_hash: description: Hash of the parent block type: string parent_index_block_hash: description: Index block hash of the parent block type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_hash: description: Hash of the anchor chain block type: string burn_block_height: description: Height of the anchor chain block type: integer miner_txid: description: Anchor chain transaction ID type: string tx_count: description: Number of transactions included in the block type: integer execution_cost_read_count: description: Execution cost read count. type: integer execution_cost_read_length: description: Execution cost read length. type: integer execution_cost_runtime: description: Execution cost runtime. type: integer execution_cost_write_count: description: Execution cost write count. type: integer execution_cost_write_length: description: Execution cost write length. type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/smart-contracts/status: get: operationId: get_smart_contracts_status summary: Get smart contracts status tags: - Smart Contracts description: Retrieves the deployment status of multiple smart contracts. parameters: - schema: anyOf: - type: array items: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: query name: contract_id required: true responses: "200": description: Default Response content: application/json: schema: type: object additionalProperties: anyOf: - type: object required: - found - result properties: found: type: boolean enum: - true result: type: object required: - status - tx_id - contract_id properties: status: description: Smart contract deployment transaction status type: string tx_id: description: Deployment transaction ID type: string contract_id: description: Smart contract ID type: string block_height: description: Height of the transaction confirmation block type: integer - type: object required: - found properties: found: type: boolean enum: - false 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/smart-contracts/{contract_id}/logs: get: operationId: get_smart_contract_logs summary: Get smart contract logs tags: - Smart Contracts description: Retrieves contract log events for a given smart contract. parameters: - schema: minimum: 0 default: 20 maximum: 100 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: default: 0 maximum: 1000 minimum: -1000 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string in: query name: cursor required: false description: Cursor for transaction event pagination (block_height:microblock_sequence:tx_index:event_index) - schema: type: string example: SP000000000000000000002Q6VF78.pox-3 in: path name: contract_id required: true description: Contract identifier formatted as `.` responses: "200": description: Default Response content: application/json: schema: type: object required: - limit - offset - total - next_cursor - prev_cursor - cursor - results properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 next_cursor: anyOf: - description: Next page cursor type: string - type: "null" prev_cursor: anyOf: - description: Previous page cursor type: string - type: "null" cursor: anyOf: - description: Current page cursor type: string - type: "null" results: type: array items: title: SmartContractLogTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - contract_log properties: event_type: type: string enum: - smart_contract_log tx_id: type: string contract_log: type: object required: - contract_id - topic - value properties: contract_id: type: string topic: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/mempool/fees: get: operationId: get_mempool_fee_priorities summary: Get mempool transaction fee priorities tags: - Mempool description: Returns estimated fee priorities (in micro-STX) for all transactions that are currently in the mempool. Also returns priorities separated by transaction type. responses: "200": description: Default Response content: application/json: schema: type: object required: - all properties: all: type: object required: - no_priority - low_priority - medium_priority - high_priority properties: no_priority: type: integer low_priority: type: integer medium_priority: type: integer high_priority: type: integer token_transfer: type: object required: - no_priority - low_priority - medium_priority - high_priority properties: no_priority: type: integer low_priority: type: integer medium_priority: type: integer high_priority: type: integer contract_call: type: object required: - no_priority - low_priority - medium_priority - high_priority properties: no_priority: type: integer low_priority: type: integer medium_priority: type: integer high_priority: type: integer smart_contract: type: object required: - no_priority - low_priority - medium_priority - high_priority properties: no_priority: type: integer low_priority: type: integer medium_priority: type: integer high_priority: type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/pox/cycles: get: operationId: get_pox_cycles summary: Get PoX cycles tags: - Proof of Transfer description: Retrieves a list of PoX cycles parameters: - schema: minimum: 0 default: 20 maximum: 60 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset responses: "200": description: Default Response content: application/json: schema: type: object required: - limit - offset - total - results properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: type: object required: - block_height - index_block_hash - cycle_number - total_weight - total_stacked_amount - total_signers properties: block_height: type: integer index_block_hash: type: string cycle_number: type: integer total_weight: type: integer total_stacked_amount: type: string total_signers: type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/pox/cycles/{cycle_number}: get: operationId: get_pox_cycle summary: Get PoX cycle tags: - Proof of Transfer description: Retrieves details for a PoX cycle parameters: - schema: type: integer in: path name: cycle_number required: true description: PoX cycle number responses: "200": description: Default Response content: application/json: schema: type: object required: - block_height - index_block_hash - cycle_number - total_weight - total_stacked_amount - total_signers properties: block_height: type: integer index_block_hash: type: string cycle_number: type: integer total_weight: type: integer total_stacked_amount: type: string total_signers: type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/pox/cycles/{cycle_number}/signers: get: operationId: get_pox_cycle_signers summary: Get signers in PoX cycle tags: - Proof of Transfer description: Retrieves a list of signers in a PoX cycle parameters: - schema: minimum: 0 default: 100 maximum: 250 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: type: integer in: path name: cycle_number required: true description: PoX cycle number responses: "200": description: Default Response content: application/json: schema: type: object required: - limit - offset - total - results properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: type: object required: - signing_key - signer_address - weight - stacked_amount - weight_percent - stacked_amount_percent - solo_stacker_count - pooled_stacker_count properties: signing_key: type: string signer_address: description: The Stacks address derived from the signing_key. type: string weight: type: integer stacked_amount: type: string weight_percent: type: number stacked_amount_percent: type: number solo_stacker_count: description: The number of solo stackers associated with this signer. type: integer pooled_stacker_count: description: The number of pooled stackers associated with this signer. type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}: get: operationId: get_pox_cycle_signer summary: Get signer in PoX cycle tags: - Proof of Transfer description: Retrieves details for a signer in a PoX cycle parameters: - schema: type: integer in: path name: cycle_number required: true description: PoX cycle number - schema: type: string example: "0x038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d" in: path name: signer_key required: true description: Signer key responses: "200": description: Default Response content: application/json: schema: type: object required: - signing_key - signer_address - weight - stacked_amount - weight_percent - stacked_amount_percent - solo_stacker_count - pooled_stacker_count properties: signing_key: type: string signer_address: description: The Stacks address derived from the signing_key. type: string weight: type: integer stacked_amount: type: string weight_percent: type: number stacked_amount_percent: type: number solo_stacker_count: description: The number of solo stackers associated with this signer. type: integer pooled_stacker_count: description: The number of pooled stackers associated with this signer. type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers: get: operationId: get_pox_cycle_signer_stackers summary: Get stackers for signer in PoX cycle tags: - Proof of Transfer description: Retrieves a list of stackers for a signer in a PoX cycle parameters: - schema: minimum: 0 default: 100 maximum: 200 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: type: integer in: path name: cycle_number required: true description: PoX cycle number - schema: type: string example: "0x038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d" in: path name: signer_key required: true description: Signer key responses: "200": description: Default Response content: application/json: schema: type: object required: - limit - offset - total - results properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: type: object required: - stacker_address - stacked_amount - pox_address - stacker_type properties: stacker_address: type: string stacked_amount: type: string pox_address: type: string stacker_type: anyOf: - type: string enum: - solo - type: string enum: - pooled 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v2/addresses/{burnchain_address}/pox-transactions: get: operationId: get_burnchain_address_pox_transactions summary: Get PoX transactions for a burnchain address tags: - Proof of Transfer description: Retrieves a list of PoX transactions parameters: - schema: minimum: 0 default: 20 maximum: 30 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: title: Bitcoin Address type: string example: bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq in: path name: burnchain_address required: true description: Bitcoin Address responses: "200": description: Default Response content: application/json: schema: type: object required: - limit - offset - total - results properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: type: object required: - burn_block_height - burn_block_hash - tx_id - recipient - utxo_idx - amount properties: burn_block_height: description: Height of the burn block type: integer burn_block_hash: description: Hash of the burn block type: string tx_id: description: Transaction ID type: string recipient: description: Recipient address type: string utxo_idx: description: UTXO index type: integer amount: description: Amount type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/blocks/{height_or_hash}/transactions: get: operationId: get_block_transactions summary: Get block transactions tags: - Transactions description: Retrieves transactions confirmed in a single block parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string in: query name: cursor required: false description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" - schema: anyOf: - type: string enum: - latest - pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Block hash description: Block hash examples: - "0xdaf79950c5e8bb0c620751333967cdd62297137cdaf79950c5e8bb0c\ 62075133" type: string - title: Block height description: Block height examples: - 777678 type: integer in: path name: height_or_hash required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" previous: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" current: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" results: type: array items: anyOf: - title: TokenTransferTransactionSummary description: Token transfer transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - token_transfer properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - token_transfer token_transfer: type: object required: - recipient - amount - memo properties: recipient: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: anyOf: - type: object required: - hex - repr properties: hex: type: string repr: type: string - type: "null" - title: SmartContractTransactionSummary description: Smart contract transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - smart_contract properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id properties: clarity_version: anyOf: - description: The Clarity version of the contract. Versioned contract transactions declare it; for the rest it is the version the node resolved from the epoch the contract was deployed in. Null only when it could not be determined, which happens for contracts indexed from a chainstate predating the point where the Stacks node began reporting it. type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string - title: ContractCallTransactionSummary description: Contract call transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - contract_call properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string - title: PoisonMicroblockTransactionSummary description: Poison microblock transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - poison_microblock - title: CoinbaseTransactionSummary description: Coinbase transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - coinbase properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - coinbase coinbase: type: object required: - alt_recipient properties: alt_recipient: anyOf: - description: A principal that will receive the miner rewards for this coinbase transaction. Can be either a standard principal or contract principal. Only specified for `coinbase-to-alt-recipient` transaction types, otherwise null. type: string - type: "null" - title: TenureChangeTransactionSummary description: Tenure change transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - tenure_change properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - tenure_change tenure_change: type: object required: - cause properties: cause: description: Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. anyOf: - type: string enum: - block_found - type: string enum: - extended - type: string enum: - extended_runtime - type: string enum: - extended_read_count - type: string enum: - extended_read_length - type: string enum: - extended_write_count - type: string enum: - extended_write_length 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/faucets/btc: post: operationId: get_faucet_btc summary: Get BTC regtest or signet tokens tags: - Faucets description: >- Sends BTC to the specified regtest or signet BTC address. The response reports the amount sent, in satoshis, and the transaction id, which you can use to view the transaction in a regtest or signet Bitcoin block explorer. The tokens are delivered once the transaction has been included in a block. Each request sends a fixed amount configured by the API operator, which the response reports. If you need more for testing (for example, to enroll in a staking bond), reach out to request a custom faucet transaction. **Note:** This is a Bitcoin regtest/signet-only endpoint. This endpoint will not work on Bitcoin mainnet. requestBody: required: true content: application/json: schema: title: FaucetBtcRequest type: object required: - address properties: address: minLength: 1 description: A valid regtest or signet BTC address type: string example: 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts responses: "200": description: Default Response content: application/json: schema: title: FaucetBtcRun type: object required: - transaction - amount properties: transaction: type: object required: - tx_id - chain properties: tx_id: pattern: ^0x[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID, `0x`-prefixed on both chains type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" chain: description: The chain the faucet transaction was broadcast to type: string enum: - bitcoin amount: description: The amount sent by the faucet type: object required: - btc properties: btc: pattern: ^[0-9]+$ title: Amount description: The BTC sent by the faucet, in satoshis type: string example: "10000" 4XX: description: Default Response content: application/json: schema: title: FaucetError type: object required: - error properties: error: description: Error message type: string 5XX: description: Default Response content: application/json: schema: title: FaucetError type: object required: - error properties: error: description: Error message type: string /extended/v3/faucets/stx: post: operationId: get_faucet_stx summary: Get STX testnet tokens tags: - Faucets description: >- Sends STX to the specified testnet address. Testnet STX addresses begin with `ST`. The response reports the amount sent, in µSTX, and the transaction id, which you can use to view the transaction in the [Stacks Explorer](https://explorer.hiro.so/?chain=testnet). The tokens are delivered once the transaction has been included in a block. Each request sends a fixed amount configured by the API operator, which the response reports. If you need more for testing (for example, to enroll in a staking bond), reach out to request a custom faucet transaction. **Note:** This is a testnet only endpoint. This endpoint will not work on mainnet. requestBody: required: true content: application/json: schema: title: FaucetStacksRequest type: object required: - address properties: address: minLength: 1 description: A testnet Stacks address (`ST…` or `SN…`), or a contract principal deployed by one type: string example: ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ responses: "200": description: Default Response content: application/json: schema: title: FaucetStxRun type: object required: - transaction - amount properties: transaction: type: object required: - tx_id - chain properties: tx_id: pattern: ^0x[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID, `0x`-prefixed on both chains type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" chain: description: The chain the faucet transaction was broadcast to type: string enum: - stacks amount: description: The amount sent by the faucet type: object required: - stx properties: stx: pattern: ^[0-9]+$ title: Amount description: The STX sent by the faucet, in µSTX type: string example: "500000000" 4XX: description: Default Response content: application/json: schema: title: FaucetError type: object required: - error properties: error: description: Error message type: string 5XX: description: Default Response content: application/json: schema: title: FaucetError type: object required: - error properties: error: description: Error message type: string /extended/v3/faucets/sbtc: post: operationId: get_faucet_sbtc summary: Get sBTC testnet tokens tags: - Faucets description: >- Sends sBTC to the specified testnet address. The endpoint performs a SIP-010 `transfer` contract call on the configured testnet sBTC token contract. Testnet STX addresses begin with `ST`. The response reports the amount sent, in satoshis, and the transaction id, which you can use to view the transaction in the [Stacks Explorer](https://explorer.hiro.so/?chain=testnet). The tokens are delivered once the transaction has been included in a block. Each request sends a fixed amount configured by the API operator, which the response reports. If you need more for testing (for example, to enroll in a staking bond), reach out to request a custom faucet transaction. **Note:** This is a testnet only endpoint. This endpoint will not work on mainnet. requestBody: required: true content: application/json: schema: title: FaucetStacksRequest type: object required: - address properties: address: minLength: 1 description: A testnet Stacks address (`ST…` or `SN…`), or a contract principal deployed by one type: string example: ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ responses: "200": description: Default Response content: application/json: schema: title: FaucetSbtcRun type: object required: - transaction - amount properties: transaction: type: object required: - tx_id - chain properties: tx_id: pattern: ^0x[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID, `0x`-prefixed on both chains type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" chain: description: The chain the faucet transaction was broadcast to type: string enum: - stacks amount: description: The amount sent by the faucet type: object required: - sbtc properties: sbtc: pattern: ^[0-9]+$ title: Amount description: The sBTC sent by the faucet, in satoshis type: string example: "10000" 4XX: description: Default Response content: application/json: schema: title: FaucetError type: object required: - error properties: error: description: Error message type: string 5XX: description: Default Response content: application/json: schema: title: FaucetError type: object required: - error properties: error: description: Error message type: string /extended/v3/mempool: get: operationId: get_mempool_summary summary: Get mempool summary tags: - Mempool description: "Retrieves a summary of the transactions currently pending in the mempool: how many there are, and the fee, size, and receipt percentiles across them, both overall and broken down by transaction type. Percentiles are discrete: each is a value some pending transaction actually has, not an interpolation between two of them." responses: "200": description: "A summary of the transactions currently pending in the mempool. Top-level metrics cover every pending transaction; `by_type` breaks the same metrics down by transaction type, so the top-level `count` always equals the sum of the per-type counts. Only the types a client can broadcast are reported: coinbase, tenure-change, and poison-microblock transactions are miner-internal or no longer produced, and are excluded throughout." content: application/json: schema: title: MempoolSummary description: "A summary of the transactions currently pending in the mempool. Top-level metrics cover every pending transaction; `by_type` breaks the same metrics down by transaction type, so the top-level `count` always equals the sum of the per-type counts. Only the types a client can broadcast are reported: coinbase, tenure-change, and poison-microblock transactions are miner-internal or no longer produced, and are excluded throughout." type: object required: - count - fee_rate - tx_size - receipt_time - receipt_block_height - by_type properties: count: description: Number of pending transactions in this bucket type: integer example: 1203 fee_rate: description: Transaction fee percentiles, in micro-STX (µSTX). Note that a fee is not a reliable predictor of inclusion on its own, since it does not account for execution cost. type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" p50: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" p75: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" p95: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" tx_size: description: Serialized transaction size percentiles, in bytes. type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - examples: - 241 type: integer - type: "null" p50: anyOf: - examples: - 241 type: integer - type: "null" p75: anyOf: - examples: - 241 type: integer - type: "null" p95: anyOf: - examples: - 241 type: integer - type: "null" receipt_time: description: "Percentiles of the unix timestamp (in seconds) at which the attached Stacks node received each transaction. Subtract from the current time for an age. Note the direction: the oldest pending transactions are at `p25`, not `p95`. These timings differ between API instances, since they reflect p2p propagation to the attached node rather than consensus." type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - examples: - 1789431980 type: integer - type: "null" p50: anyOf: - examples: - 1789431980 type: integer - type: "null" p75: anyOf: - examples: - 1789431980 type: integer - type: "null" p95: anyOf: - examples: - 1789431980 type: integer - type: "null" receipt_block_height: description: Percentiles of the Stacks block height that was the chain tip when the attached Stacks node received each transaction. Subtract from the current chain tip for an age in blocks. As with `receipt_time`, the oldest pending transactions are at `p25`. type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - examples: - 214500 type: integer - type: "null" p50: anyOf: - examples: - 214500 type: integer - type: "null" p75: anyOf: - examples: - 214500 type: integer - type: "null" p95: anyOf: - examples: - 214500 type: integer - type: "null" by_type: description: The same metrics broken down by transaction type. Versioned smart-contract transactions are counted as `smart_contract`. type: object required: - token_transfer - smart_contract - contract_call properties: token_transfer: type: object required: - count - fee_rate - tx_size - receipt_time - receipt_block_height properties: count: description: Number of pending transactions in this bucket type: integer example: 1203 fee_rate: description: Transaction fee percentiles, in micro-STX (µSTX). Note that a fee is not a reliable predictor of inclusion on its own, since it does not account for execution cost. type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" p50: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" p75: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" p95: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" tx_size: description: Serialized transaction size percentiles, in bytes. type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - examples: - 241 type: integer - type: "null" p50: anyOf: - examples: - 241 type: integer - type: "null" p75: anyOf: - examples: - 241 type: integer - type: "null" p95: anyOf: - examples: - 241 type: integer - type: "null" receipt_time: description: "Percentiles of the unix timestamp (in seconds) at which the attached Stacks node received each transaction. Subtract from the current time for an age. Note the direction: the oldest pending transactions are at `p25`, not `p95`. These timings differ between API instances, since they reflect p2p propagation to the attached node rather than consensus." type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - examples: - 1789431980 type: integer - type: "null" p50: anyOf: - examples: - 1789431980 type: integer - type: "null" p75: anyOf: - examples: - 1789431980 type: integer - type: "null" p95: anyOf: - examples: - 1789431980 type: integer - type: "null" receipt_block_height: description: Percentiles of the Stacks block height that was the chain tip when the attached Stacks node received each transaction. Subtract from the current chain tip for an age in blocks. As with `receipt_time`, the oldest pending transactions are at `p25`. type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - examples: - 214500 type: integer - type: "null" p50: anyOf: - examples: - 214500 type: integer - type: "null" p75: anyOf: - examples: - 214500 type: integer - type: "null" p95: anyOf: - examples: - 214500 type: integer - type: "null" smart_contract: type: object required: - count - fee_rate - tx_size - receipt_time - receipt_block_height properties: count: description: Number of pending transactions in this bucket type: integer example: 1203 fee_rate: description: Transaction fee percentiles, in micro-STX (µSTX). Note that a fee is not a reliable predictor of inclusion on its own, since it does not account for execution cost. type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" p50: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" p75: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" p95: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" tx_size: description: Serialized transaction size percentiles, in bytes. type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - examples: - 241 type: integer - type: "null" p50: anyOf: - examples: - 241 type: integer - type: "null" p75: anyOf: - examples: - 241 type: integer - type: "null" p95: anyOf: - examples: - 241 type: integer - type: "null" receipt_time: description: "Percentiles of the unix timestamp (in seconds) at which the attached Stacks node received each transaction. Subtract from the current time for an age. Note the direction: the oldest pending transactions are at `p25`, not `p95`. These timings differ between API instances, since they reflect p2p propagation to the attached node rather than consensus." type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - examples: - 1789431980 type: integer - type: "null" p50: anyOf: - examples: - 1789431980 type: integer - type: "null" p75: anyOf: - examples: - 1789431980 type: integer - type: "null" p95: anyOf: - examples: - 1789431980 type: integer - type: "null" receipt_block_height: description: Percentiles of the Stacks block height that was the chain tip when the attached Stacks node received each transaction. Subtract from the current chain tip for an age in blocks. As with `receipt_time`, the oldest pending transactions are at `p25`. type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - examples: - 214500 type: integer - type: "null" p50: anyOf: - examples: - 214500 type: integer - type: "null" p75: anyOf: - examples: - 214500 type: integer - type: "null" p95: anyOf: - examples: - 214500 type: integer - type: "null" contract_call: type: object required: - count - fee_rate - tx_size - receipt_time - receipt_block_height properties: count: description: Number of pending transactions in this bucket type: integer example: 1203 fee_rate: description: Transaction fee percentiles, in micro-STX (µSTX). Note that a fee is not a reliable predictor of inclusion on its own, since it does not account for execution cost. type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" p50: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" p75: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" p95: anyOf: - pattern: ^[0-9]+$ description: Transaction fee as an integer string of micro-STX (µSTX) examples: - "250" type: string - type: "null" tx_size: description: Serialized transaction size percentiles, in bytes. type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - examples: - 241 type: integer - type: "null" p50: anyOf: - examples: - 241 type: integer - type: "null" p75: anyOf: - examples: - 241 type: integer - type: "null" p95: anyOf: - examples: - 241 type: integer - type: "null" receipt_time: description: "Percentiles of the unix timestamp (in seconds) at which the attached Stacks node received each transaction. Subtract from the current time for an age. Note the direction: the oldest pending transactions are at `p25`, not `p95`. These timings differ between API instances, since they reflect p2p propagation to the attached node rather than consensus." type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - examples: - 1789431980 type: integer - type: "null" p50: anyOf: - examples: - 1789431980 type: integer - type: "null" p75: anyOf: - examples: - 1789431980 type: integer - type: "null" p95: anyOf: - examples: - 1789431980 type: integer - type: "null" receipt_block_height: description: Percentiles of the Stacks block height that was the chain tip when the attached Stacks node received each transaction. Subtract from the current chain tip for an age in blocks. As with `receipt_time`, the oldest pending transactions are at `p25`. type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - examples: - 214500 type: integer - type: "null" p50: anyOf: - examples: - 214500 type: integer - type: "null" p75: anyOf: - examples: - 214500 type: integer - type: "null" p95: anyOf: - examples: - 214500 type: integer - type: "null" 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/mempool/transactions: get: operationId: get_mempool_transactions summary: Get mempool transactions tags: - Mempool description: Retrieves a list of recently broadcasted transactions parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^\d+:(0x)?[a-fA-F0-9]{64}$ type: string in: query name: cursor required: false description: "Cursor for paginating mempool transactions. Format: receipt_time:tx_id" responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - pattern: ^\d+:(0x)?[a-fA-F0-9]{64}$ description: "Cursor for paginating mempool transactions. Format: receipt_time:tx_id" type: string - type: "null" previous: anyOf: - pattern: ^\d+:(0x)?[a-fA-F0-9]{64}$ description: "Cursor for paginating mempool transactions. Format: receipt_time:tx_id" type: string - type: "null" current: anyOf: - pattern: ^\d+:(0x)?[a-fA-F0-9]{64}$ description: "Cursor for paginating mempool transactions. Format: receipt_time:tx_id" type: string - type: "null" results: type: array items: anyOf: - title: TokenTransferMempoolTransactionSummary description: Token transfer mempool transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - type - token_transfer properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic type: type: string enum: - token_transfer token_transfer: type: object required: - recipient - amount - memo properties: recipient: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: anyOf: - type: object required: - hex - repr properties: hex: type: string repr: type: string - type: "null" - title: SmartContractMempoolTransactionSummary description: Smart contract mempool transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - type - smart_contract properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id properties: clarity_version: anyOf: - description: The Clarity version of the contract, only specified for versioned contract transactions, otherwise null. A pending deploy has not been executed, so the version an unversioned one will resolve to is not yet known. type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string - title: ContractCallMempoolTransactionSummary description: Contract call mempool transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - type - contract_call properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string - title: PoisonMicroblockMempoolTransactionSummary description: Poison microblock mempool transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic type: type: string enum: - poison_microblock - title: CoinbaseMempoolTransactionSummary description: Coinbase mempool transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic type: type: string enum: - coinbase - title: TenureChangeMempoolTransactionSummary description: Tenure change mempool transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic type: type: string enum: - tenure_change 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/transactions: get: operationId: get_principal_transactions summary: Get principal transactions tags: - Transactions description: Returns a list of confirmed transactions sent or received by a Stacks principal, including the transaction summary, the involvement of the principal in the transaction, and the balances affected by the transaction. parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string in: query name: cursor required: false description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" previous: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" current: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" results: type: array items: type: object required: - transaction - involvement - balance_changes - affected_balances properties: transaction: anyOf: - title: TokenTransferTransactionSummary description: Token transfer transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - token_transfer properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - token_transfer token_transfer: type: object required: - recipient - amount - memo properties: recipient: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: anyOf: - type: object required: - hex - repr properties: hex: type: string repr: type: string - type: "null" - title: SmartContractTransactionSummary description: Smart contract transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - smart_contract properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id properties: clarity_version: anyOf: - description: The Clarity version of the contract. Versioned contract transactions declare it; for the rest it is the version the node resolved from the epoch the contract was deployed in. Null only when it could not be determined, which happens for contracts indexed from a chainstate predating the point where the Stacks node began reporting it. type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string - title: ContractCallTransactionSummary description: Contract call transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - contract_call properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string - title: PoisonMicroblockTransactionSummary description: Poison microblock transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - poison_microblock - title: CoinbaseTransactionSummary description: Coinbase transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - coinbase properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - coinbase coinbase: type: object required: - alt_recipient properties: alt_recipient: anyOf: - description: A principal that will receive the miner rewards for this coinbase transaction. Can be either a standard principal or contract principal. Only specified for `coinbase-to-alt-recipient` transaction types, otherwise null. type: string - type: "null" - title: TenureChangeTransactionSummary description: Tenure change transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - tenure_change properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - tenure_change tenure_change: type: object required: - cause properties: cause: description: Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. anyOf: - type: string enum: - block_found - type: string enum: - extended - type: string enum: - extended_runtime - type: string enum: - extended_read_count - type: string enum: - extended_read_length - type: string enum: - extended_write_count - type: string enum: - extended_write_length involvement: description: How the principal is involved in the transaction. anyOf: - type: string enum: - sender - type: string enum: - sponsor - type: string enum: - affected balance_changes: type: object required: - stx properties: stx: type: object required: - sent - received - net properties: sent: description: Total sent from the given address, including the tx fee, in micro-STX as an integer string. type: string received: description: Total received by the given address in micro-STX as an integer string. type: string net: description: Net change in the principal's STX balance in micro-STX as an integer string. type: string affected_balances: type: object required: - stx - ft - nft properties: stx: description: Whether the principal's STX balance was affected by the transaction type: boolean ft: description: Whether the principal's FT balance was affected by the transaction type: boolean nft: description: Whether the principal's NFT balance was affected by the transaction type: boolean 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/transfers/stx/inbound: get: operationId: get_principal_inbound_stx_transfers summary: Get inbound STX transfers tags: - Transactions description: Returns the individual inbound STX events crediting a principal. Includes native stx-transfer transactions, `send-many-memo` bulk-send legs, any other STX transfer event crediting the principal, and STX mints (which have a null `sender`), each with its own sender, amount, and memo. A transaction that credits the principal multiple times yields one result per event. parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string in: query name: cursor required: false description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_index" - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" previous: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" current: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" results: type: array items: title: PrincipalStxTransfer type: object required: - sender - recipient - amount - memo - transaction - block properties: sender: anyOf: - anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string - type: "null" recipient: anyOf: - anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string - type: "null" amount: pattern: ^[0-9]+$ title: Amount description: Amount type: string example: "1000000" memo: anyOf: - type: object required: - hex - repr properties: hex: type: string repr: type: string - type: "null" transaction: type: object required: - tx_id - event_index properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" event_index: description: Index of the event within the transaction type: integer block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. type: string example: 2026-10-08T19:18:41.000Z tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/transfers/stx/outbound: get: operationId: get_principal_outbound_stx_transfers summary: Get outbound STX transfers tags: - Transactions description: Returns the individual outbound STX events debiting a principal. Includes native stx-transfer transactions, `send-many-memo` bulk-send legs, any other STX transfer event debiting the principal, and STX burns (which have a null `recipient`), each with its own recipient, amount, and memo. A transaction that debits the principal multiple times yields one result per event. parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string in: query name: cursor required: false description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_index" - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" previous: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" current: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" results: type: array items: title: PrincipalStxTransfer type: object required: - sender - recipient - amount - memo - transaction - block properties: sender: anyOf: - anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string - type: "null" recipient: anyOf: - anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string - type: "null" amount: pattern: ^[0-9]+$ title: Amount description: Amount type: string example: "1000000" memo: anyOf: - type: object required: - hex - repr properties: hex: type: string repr: type: string - type: "null" transaction: type: object required: - tx_id - event_index properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" event_index: description: Index of the event within the transaction type: integer block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. type: string example: 2026-10-08T19:18:41.000Z tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/transfers/ft/{asset_identifier}: get: operationId: get_principal_ft_transfers summary: Get fungible token transfers tags: - Transactions description: Returns a principal's transfer history for a single fungible token as one feed, newest first, combining the events that credit it and the events that debit it. Includes mints (which have a null `sender`) and burns (which have a null `recipient`). A transaction that moves the token several times for this principal yields one result per event. Amounts are in the token's own base units. parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string in: query name: cursor required: false description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_index" - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true - schema: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$ title: Asset Identifier type: string example: SP000000000000000000002Q6VF78.pox-3::stx-token in: path name: asset_identifier required: true description: Asset Identifier responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" previous: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" current: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" results: type: array items: title: PrincipalFtTransfer type: object required: - sender - recipient - amount - transaction - block properties: sender: anyOf: - anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string - type: "null" recipient: anyOf: - anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string - type: "null" amount: pattern: ^[0-9]+$ title: Amount description: Transfer amount, in the token's own base units type: string example: "1000000" transaction: type: object required: - tx_id - event_index properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" event_index: description: Index of the event within the transaction type: integer block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. type: string example: 2026-10-08T19:18:41.000Z tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes: get: operationId: get_principal_transaction_balance_changes summary: Get principal transaction balance changes tags: - Transactions description: Returns the balance changes for a principal's transaction parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0-9]+:\S+$ type: string in: query name: cursor required: false description: "Cursor for paginating principal transaction balance changes. Format: `:` where `asset_type` is a numeric tag (1=STX, 2=FT, 3=NFT) and `asset_identifier` is `` for STX or a fully-qualified Clarity asset id such as `SP000…contract-name::asset-name` for FT/NFT." - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true - schema: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" in: path name: tx_id required: true description: Transaction ID responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - description: "Cursor for paginating principal transaction balance changes. Format: `:` where `asset_type` is a numeric tag (1=STX, 2=FT, 3=NFT) and `asset_identifier` is `` for STX or a fully-qualified Clarity asset id such as `SP000…contract-name::asset-name` for FT/NFT." pattern: ^[0-9]+:\S+$ type: string - type: "null" previous: anyOf: - description: "Cursor for paginating principal transaction balance changes. Format: `:` where `asset_type` is a numeric tag (1=STX, 2=FT, 3=NFT) and `asset_identifier` is `` for STX or a fully-qualified Clarity asset id such as `SP000…contract-name::asset-name` for FT/NFT." pattern: ^[0-9]+:\S+$ type: string - type: "null" current: anyOf: - description: "Cursor for paginating principal transaction balance changes. Format: `:` where `asset_type` is a numeric tag (1=STX, 2=FT, 3=NFT) and `asset_identifier` is `` for STX or a fully-qualified Clarity asset id such as `SP000…contract-name::asset-name` for FT/NFT." pattern: ^[0-9]+:\S+$ type: string - type: "null" results: type: array items: type: object required: - asset - balance_change properties: asset: anyOf: - type: object required: - type properties: type: type: string enum: - stx - type: object required: - type - identifier properties: type: description: The asset type that was affected by the balance change. anyOf: - type: string enum: - ft - type: string enum: - nft identifier: description: The identifier of the asset that was affected by the balance change. type: string balance_change: type: object required: - sent - received - net properties: sent: description: Amount sent by the principal type: string received: description: Amount received by the principal type: string net: description: Net balance change for the principal type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/balance-changes: get: operationId: get_principal_balance_changes summary: Get principal balance changes tags: - Transactions description: Returns the balance changes for a principal across one or more transactions, as a single paginated flat array ordered by chain position descending then by asset. parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+:\S+$ type: string in: query name: cursor required: false description: "Cursor for paginating principal balance changes across multiple transactions. Format: `::::`." - schema: minItems: 1 maxItems: 20 uniqueItems: true type: array items: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd\ 7a91c6" type: string in: query name: tx_id required: true description: Transaction ids to query balance changes for. Provide as repeated querystring values (`?tx_id=A&tx_id=B`) or as a single comma-separated value (`?tx_id=A,B`). - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - description: "Cursor for paginating principal balance changes across multiple transactions. Format: `:::\ :`." pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+:\S+$ type: string - type: "null" previous: anyOf: - description: "Cursor for paginating principal balance changes across multiple transactions. Format: `:::\ :`." pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+:\S+$ type: string - type: "null" current: anyOf: - description: "Cursor for paginating principal balance changes across multiple transactions. Format: `:::\ :`." pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+:\S+$ type: string - type: "null" results: type: array items: type: object required: - tx_id - asset - balance_change properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" asset: anyOf: - type: object required: - type properties: type: type: string enum: - stx - type: object required: - type - identifier properties: type: description: The asset type that was affected by the balance change. anyOf: - type: string enum: - ft - type: string enum: - nft identifier: description: The identifier of the asset that was affected by the balance change. type: string balance_change: type: object required: - sent - received - net properties: sent: description: Amount sent by the principal type: string received: description: Amount received by the principal type: string net: description: Net balance change for the principal type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/staking: get: operationId: get_principal_staking_summary summary: Get principal staking summary tags: - Staking description: "A one-call overview of a principal's staking: its pox-5 STX-staking position (locked STX and its sBTC rewards) plus aggregate totals across all of its bond positions. The per-bond breakdown is paginated at `/principals/:principal/staking/bonds`." parameters: - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - stx - bonds properties: stx: type: object required: - locked - rewards properties: locked: description: The amount of uSTX currently locked in pox-5 STX staking type: string rewards: type: object required: - btc properties: btc: type: object required: - accrued - claimed - claimable properties: accrued: description: The lifetime sBTC reward sats accrued to this position type: string claimed: description: The lifetime sBTC reward sats already claimed against this position type: string claimable: description: The sBTC reward sats currently claimable (accrued minus claimed) type: string bonds: type: object required: - count - locked - rewards properties: count: description: Number of bonds this principal has a position in type: integer locked: type: object required: - btc - stx properties: btc: description: Total BTC locked across all bond positions type: string stx: description: Total STX locked across all bond positions type: string rewards: type: object required: - btc properties: btc: type: object required: - accrued - claimed - claimable properties: accrued: description: The lifetime sBTC reward sats accrued to this position type: string claimed: description: The lifetime sBTC reward sats already claimed against this position type: string claimable: description: The sBTC reward sats currently claimable (accrued minus claimed) type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/staking/bonds: get: operationId: get_principal_bond_positions summary: Get principal bond positions tags: - Staking description: Get a principal's bond positions — its enrollment, lock, status, and sBTC rewards in each bond it participates in. parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^\d+$ type: string in: query name: cursor required: false description: "Cursor for paginating bonds. Format: bond_index" - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - pattern: ^\d+$ description: "Cursor for paginating bonds. Format: bond_index" type: string - type: "null" previous: anyOf: - pattern: ^\d+$ description: "Cursor for paginating bonds. Format: bond_index" type: string - type: "null" current: anyOf: - pattern: ^\d+$ description: "Cursor for paginating bonds. Format: bond_index" type: string - type: "null" results: type: array items: type: object required: - bond_index - status - active - enrollment - locked - rewards properties: bond_index: description: The index of the bond in the PoX-5 bond list type: integer status: anyOf: - type: string enum: - enrolled - type: string enum: - running - type: string enum: - early_exit - type: string enum: - unlocked - type: string enum: - rolled_over active: description: Whether the position is active type: boolean enrollment: type: object required: - tx_id - btc_lockup properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" btc_lockup: type: object required: - amount properties: amount: description: The amount of BTC that is locked up for this principal type: string locked: type: object required: - btc - stx properties: btc: description: The amount of BTC locked in this bond position type: string stx: description: The amount of STX locked in this bond position type: string rewards: type: object required: - btc properties: btc: type: object required: - accrued - claimed - claimable properties: accrued: description: The lifetime sBTC reward sats accrued to this position type: string claimed: description: The lifetime sBTC reward sats already claimed against this position type: string claimable: description: The sBTC reward sats currently claimable (accrued minus claimed) type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/mining: get: operationId: get_principal_mining_summary summary: Get principal mining summary tags: - Accounts description: "A one-call overview of a principal's mining: its lifetime matured miner rewards (coinbase and fees, in µSTX), counting only rewards on the canonical chain. The individual rewards are paginated at `/principals/:principal/mining/rewards`." parameters: - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: title: PrincipalMiningSummary type: object required: - rewards properties: rewards: type: object required: - count - coinbase - fees - total properties: count: description: Number of non-zero matured miner rewards received type: integer coinbase: pattern: ^[0-9]+$ title: Amount description: Amount type: string example: "1000000" fees: pattern: ^[0-9]+$ title: Amount description: Transaction fees included in the reward, in µSTX type: string example: "1000000" total: pattern: ^[0-9]+$ title: Amount description: Amount type: string example: "1000000" 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/mining/rewards: get: operationId: get_principal_mining_rewards summary: Get principal mining rewards tags: - Accounts description: Returns the matured miner rewards credited to a principal, most recent first. Miner rewards are credited to the recipient's STX balance when they mature, without a transaction or STX event, so they don't appear in the principal's transactions or transfers. Each reward reports the `block` it matured (and was credited) in and the `source_block` whose reward matured; a parent-miner share of fees reports the same `source_block` as the miner reward it was paid alongside. Only rewards on the canonical chain are listed; zero-value rewards are left out. parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0-9]+:[0-9]+$ type: string in: query name: cursor required: false description: "Cursor for paginating matured miner rewards. Format: mature_block_height:reward_index" - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - pattern: ^[0-9]+:[0-9]+$ description: "Cursor for paginating matured miner rewards. Format: mature_block_height:reward_index" type: string - type: "null" previous: anyOf: - pattern: ^[0-9]+:[0-9]+$ description: "Cursor for paginating matured miner rewards. Format: mature_block_height:reward_index" type: string - type: "null" current: anyOf: - pattern: ^[0-9]+:[0-9]+$ description: "Cursor for paginating matured miner rewards. Format: mature_block_height:reward_index" type: string - type: "null" results: type: array items: title: PrincipalMinerReward type: object required: - id - recipient - miner - block - source_block - coinbase - fees - total properties: id: pattern: ^0x[0-9a-fA-F]{64}:[0-9]+$ description: "Stable reward identifier: the index block hash of the block the reward matured in, followed by the reward position within that block. A block can mature more than one reward for the same recipient (its own miner reward plus its parent-miner share of fees)." type: string example: 0x6b2c809627f2fd19991d8eb6ae034cb4cce1e1fc714aa77351506b9af1b2eb3b:0 recipient: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string miner: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string block: title: BlockSummary type: object required: - height - hash - index_hash - time - time_iso properties: height: title: Block height description: Block height type: integer example: 777678 hash: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Block hash description: Block hash type: string example: "0xdaf79950c5e8bb0c620751333967cdd62297137cdaf79950c5e8bb0c62075133" index_hash: description: Index block hash of the block type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. type: string example: 2026-10-08T19:18:41.000Z source_block: title: BlockSummary type: object required: - height - hash - index_hash - time - time_iso properties: height: title: Block height description: Block height type: integer example: 777678 hash: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Block hash description: Block hash type: string example: "0xdaf79950c5e8bb0c620751333967cdd62297137cdaf79950c5e8bb0c62075133" index_hash: description: Index block hash of the block type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. type: string example: 2026-10-08T19:18:41.000Z coinbase: pattern: ^[0-9]+$ title: Amount description: Amount type: string example: "1000000" fees: pattern: ^[0-9]+$ title: Amount description: Transaction fees included in the reward, in µSTX type: string example: "1000000" total: pattern: ^[0-9]+$ title: Amount description: Amount type: string example: "1000000" 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/balances/stx: get: operationId: get_principal_balances_stx summary: Get principal STX balance tags: - Accounts description: "Get a principal's STX balance: its total and spendable (available) balance, any locked STX, and the projected balance from pending mempool transactions." parameters: - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: title: PrincipalStxBalance type: object required: - balance - available - locked - mempool properties: balance: description: Total micro-STX balance (available plus locked) type: string available: description: Spendable micro-STX balance (balance minus locked) type: string locked: anyOf: - title: StxLock type: object required: - amount - pox_version - lock_tx_id - stacks_lock_height - burn_lock_height - burn_unlock_height properties: amount: description: The amount of locked micro-STX type: string pox_version: description: The PoX contract version that created the lock (e.g. 4, 5) type: integer lock_tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382\ a7e4b6a13df3dd7a91c6" type: string stacks_lock_height: description: The Stacks block height at which the lock was created type: integer burn_lock_height: description: The burnchain block height at which the lock was created type: integer burn_unlock_height: description: The burnchain block height at which the locked STX unlocks type: integer - type: "null" mempool: anyOf: - title: StxMempoolBalance type: object required: - estimated_balance - inbound - outbound properties: estimated_balance: description: Estimated spendable micro-STX balance once pending mempool txs confirm type: string inbound: description: Pending inbound micro-STX from the mempool type: string outbound: description: Pending outbound micro-STX from the mempool (transfers plus fees) type: string - type: "null" 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/balances/ft: get: operationId: get_principal_balances_ft summary: Get principal FT balances tags: - Accounts description: Get a principal's fungible-token balances, sorted by balance descending. parameters: - schema: minimum: 1 default: 100 maximum: 200 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^\d+:.+$ type: string in: query name: cursor required: false description: "Cursor for paginating FT balances (sorted by balance, descending). Format: balance:asset_identifier" - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 100 maximum: 200 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - pattern: ^\d+:.+$ description: "Cursor for paginating FT balances (sorted by balance, descending). Format: balance:asset_identifier" type: string - type: "null" previous: anyOf: - pattern: ^\d+:.+$ description: "Cursor for paginating FT balances (sorted by balance, descending). Format: balance:asset_identifier" type: string - type: "null" current: anyOf: - pattern: ^\d+:.+$ description: "Cursor for paginating FT balances (sorted by balance, descending). Format: balance:asset_identifier" type: string - type: "null" results: type: array items: title: PrincipalFtPosition type: object required: - asset_identifier - balance properties: asset_identifier: description: Fungible token asset identifier type: string example: SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token balance: description: The principal's balance of this token, as a string-quoted integer in base units type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/balances/ft/{asset_identifier}: get: operationId: get_principal_balance_ft summary: Get principal FT balance tags: - Accounts description: Get a principal's balance of a single fungible token. Returns a zero balance if the principal does not currently hold the token. parameters: - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true - schema: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$ title: Asset Identifier type: string example: SP000000000000000000002Q6VF78.pox-3::stx-token in: path name: asset_identifier required: true description: Asset Identifier responses: "200": description: Default Response content: application/json: schema: title: PrincipalFtPosition type: object required: - asset_identifier - balance properties: asset_identifier: description: Fungible token asset identifier type: string example: SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token balance: description: The principal's balance of this token, as a string-quoted integer in base units type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/balances/nft: get: operationId: get_principal_balances_nft summary: Get principal NFT balances tags: - Accounts description: Get the non-fungible token instances currently owned by a principal, ordered by asset identifier and value. Optionally filtered to a single asset class via `asset_identifier`. parameters: - schema: minimum: 1 default: 100 maximum: 200 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^0x[0-9a-fA-F]*:.+$ type: string in: query name: cursor required: false description: "Cursor for paginating NFT balances (sorted by asset identifier then value). Format: value:asset_identifier" - schema: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$ title: Asset Identifier type: string example: SP000000000000000000002Q6VF78.pox-3::stx-token in: query name: asset_identifier required: false description: Return only the instances of this non-fungible token asset class. For example, BNS names are held as `SP000000000000000000002Q6VF78.bns::names` on mainnet. - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 100 maximum: 200 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - pattern: ^0x[0-9a-fA-F]*:.+$ description: "Cursor for paginating NFT balances (sorted by asset identifier then value). Format: value:asset_identifier" type: string - type: "null" previous: anyOf: - pattern: ^0x[0-9a-fA-F]*:.+$ description: "Cursor for paginating NFT balances (sorted by asset identifier then value). Format: value:asset_identifier" type: string - type: "null" current: anyOf: - pattern: ^0x[0-9a-fA-F]*:.+$ description: "Cursor for paginating NFT balances (sorted by asset identifier then value). Format: value:asset_identifier" type: string - type: "null" results: type: array items: title: PrincipalNftPosition type: object required: - asset_identifier - value properties: asset_identifier: description: Non-fungible token asset identifier type: string example: SP2X0TZ59D5SZ8ACQ6YMCHHNR2ZN51Z32E2CJ173.the-explorer-guild::The-Explorer-Guild value: description: The NFT instance identifier, as a Clarity value type: object required: - hex - repr properties: hex: type: string repr: type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/nonces: get: operationId: get_principal_nonces summary: Get principal nonces tags: - Accounts description: Get a Stacks account's latest nonce state by inspecting its confirmed transactions and the mempool, including the nonce to use for its next transaction. Only standard principals have nonces; contract principals are not valid. parameters: - schema: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address type: string example: SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP in: path name: principal required: true description: Stacks Address responses: "200": description: Default Response content: application/json: schema: title: PrincipalNonces type: object required: - next_nonce - last_confirmed_nonce - mempool properties: next_nonce: description: The nonce to use for this principal's next transaction, derived from the latest confirmed and mempool nonces. May be inaccurate if the API is not fully synchronized. type: integer last_confirmed_nonce: anyOf: - description: Highest nonce among the principal's confirmed transactions, or null if none. type: integer - type: "null" mempool: title: PrincipalMempoolNonces type: object required: - last_nonce - pending_nonces - missing_nonces properties: last_nonce: anyOf: - description: Highest nonce among the principal's pending mempool transactions, or null if none. type: integer - type: "null" pending_nonces: description: Intermediate nonces found in the mempool between the last confirmed nonce and the highest mempool nonce. type: array items: type: integer missing_nonces: description: Expected intermediate nonces between the last confirmed nonce and the highest mempool nonce that are absent from the mempool — likely stalling transactions. type: array items: type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/principals/{principal}/mempool/transactions: get: operationId: get_principal_mempool_transactions summary: Get principal mempool transactions tags: - Transactions description: Returns a list of pending mempool transactions that involve a principal — as the sender, a token-transfer recipient, the deployed contract, or the called contract. parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^\d+:(0x)?[a-fA-F0-9]{64}$ type: string in: query name: cursor required: false description: "Cursor for paginating mempool transactions. Format: receipt_time:tx_id" - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - pattern: ^\d+:(0x)?[a-fA-F0-9]{64}$ description: "Cursor for paginating mempool transactions. Format: receipt_time:tx_id" type: string - type: "null" previous: anyOf: - pattern: ^\d+:(0x)?[a-fA-F0-9]{64}$ description: "Cursor for paginating mempool transactions. Format: receipt_time:tx_id" type: string - type: "null" current: anyOf: - pattern: ^\d+:(0x)?[a-fA-F0-9]{64}$ description: "Cursor for paginating mempool transactions. Format: receipt_time:tx_id" type: string - type: "null" results: type: array items: anyOf: - title: TokenTransferMempoolTransactionSummary description: Token transfer mempool transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - type - token_transfer properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic type: type: string enum: - token_transfer token_transfer: type: object required: - recipient - amount - memo properties: recipient: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: anyOf: - type: object required: - hex - repr properties: hex: type: string repr: type: string - type: "null" - title: SmartContractMempoolTransactionSummary description: Smart contract mempool transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - type - smart_contract properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id properties: clarity_version: anyOf: - description: The Clarity version of the contract, only specified for versioned contract transactions, otherwise null. A pending deploy has not been executed, so the version an unversioned one will resolve to is not yet known. type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string - title: ContractCallMempoolTransactionSummary description: Contract call mempool transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - type - contract_call properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string - title: PoisonMicroblockMempoolTransactionSummary description: Poison microblock mempool transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic type: type: string enum: - poison_microblock - title: CoinbaseMempoolTransactionSummary description: Coinbase mempool transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic type: type: string enum: - coinbase - title: TenureChangeMempoolTransactionSummary description: Tenure change mempool transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic type: type: string enum: - tenure_change 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/search: get: operationId: search summary: Search tags: - Search description: "Searches for the blocks, transactions, addresses, smart contracts, and token assets that a term refers to. The term can be a complete identifier or the beginning of one: a block or transaction hash, a Stacks or Bitcoin block height, an address, a contract id, or an asset identifier. Contract and asset names are matched anywhere in the name, so a term like `arkadiko` finds the contracts and tokens named after it. Names must contain the term; misspellings are not matched. At most 20 results are returned, best match first; there is no pagination, so narrow the term to see something that did not surface. A term that matches nothing returns an empty list rather than an error. Only canonical, mined entities are searched." parameters: - schema: type: string examples: "213377": value: "213377" "0xcf8b233f19f6c07d2dc1963302d2436efd36e9af": value: "0xcf8b233f19f6c07d2dc1963302d2436efd36e9af" arkadiko: value: arkadiko in: query name: q required: true description: The term to search for. Hex terms need at least 8 characters, addresses at least 6, and contract or asset names at least 3; block heights have no minimum. - schema: uniqueItems: true type: array items: title: SearchEntityType description: The kind of entity a search result refers to anyOf: - type: string enum: - block - type: string enum: - bitcoin_block - type: string enum: - transaction - type: string enum: - address - type: string enum: - smart_contract - type: string enum: - token in: query name: type required: false description: Restricts results to these entity types. Provide them as repeated querystring values (`?type=block&type=transaction`) or as a single comma-separated value (`?type=block,transaction`). Defaults to every type the term could match. responses: "200": description: Default Response content: application/json: schema: title: SearchResponse type: object required: - results properties: results: type: array items: title: SearchResult anyOf: - title: BlockSearchResult type: object required: - type - result properties: type: type: string enum: - block result: title: BlockSummary type: object required: - height - hash - index_hash - time - time_iso properties: height: title: Block height description: Block height examples: - 777678 type: integer hash: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Block hash description: Block hash examples: - "0xdaf79950c5e8bb0c620751333967cdd6229713\ 7cdaf79950c5e8bb0c62075133" type: string index_hash: description: Index block hash of the block type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string - title: BitcoinBlockSearchResult type: object required: - type - result properties: type: type: string enum: - bitcoin_block result: title: BitcoinBlockSummary type: object required: - height - hash properties: height: description: Height of the Bitcoin block type: integer hash: description: Hash of the Bitcoin block type: string - title: TransactionSearchResult type: object required: - type - result properties: type: type: string enum: - transaction result: anyOf: - title: TokenTransferTransactionSummary description: Token transfer transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - token_transfer properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - token_transfer token_transfer: type: object required: - recipient - amount - memo properties: recipient: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: anyOf: - type: object required: - hex - repr properties: hex: type: string repr: type: string - type: "null" - title: SmartContractTransactionSummary description: Smart contract transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - smart_contract properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id properties: clarity_version: anyOf: - description: The Clarity version of the contract. Versioned contract transactions declare it; for the rest it is the version the node resolved from the epoch the contract was deployed in. Null only when it could not be determined, which happens for contracts indexed from a chainstate predating the point where the Stacks node began reporting it. type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string - title: ContractCallTransactionSummary description: Contract call transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - contract_call properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string - title: PoisonMicroblockTransactionSummary description: Poison microblock transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - poison_microblock - title: CoinbaseTransactionSummary description: Coinbase transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - coinbase properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - coinbase coinbase: type: object required: - alt_recipient properties: alt_recipient: anyOf: - description: A principal that will receive the miner rewards for this coinbase transaction. Can be either a standard principal or contract principal. Only specified for `coinbase-to-alt-recipient` transaction types, otherwise null. type: string - type: "null" - title: TenureChangeTransactionSummary description: Tenure change transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - tenure_change properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - tenure_change tenure_change: type: object required: - cause properties: cause: description: Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. anyOf: - type: string enum: - block_found - type: string enum: - extended - type: string enum: - extended_runtime - type: string enum: - extended_read_count - type: string enum: - extended_read_length - type: string enum: - extended_write_count - type: string enum: - extended_write_length - title: AddressSearchResult type: object required: - type - result properties: type: type: string enum: - address result: title: AddressSummary type: object required: - principal properties: principal: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - title: SmartContractSearchResult type: object required: - type - result properties: type: type: string enum: - smart_contract result: title: SmartContract type: object required: - contract_id - clarity_version - tx_id - block - bitcoin_block properties: contract_id: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string clarity_version: anyOf: - description: The Clarity version the contract runs under. Contracts deployed with a versioned payload declare their own version; for the rest it is the version the node resolved from the epoch they were deployed in. Null when it could not be determined, which only happens for contracts indexed from a chainstate predating the point where the Stacks node began reporting it. examples: - 3 type: integer - type: "null" tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: ID of the transaction that deployed this contract examples: - "0xf6bd5f4a7b26184a3466340b2e99fd003b4962\ c0e382a7e4b6a13df3dd7a91c6" type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string source_code: description: The Clarity source code of the contract. Only present when requested via the `include=source_code` query param. type: string - title: TokenSearchResult type: object required: - type - result properties: type: type: string enum: - token result: title: TokenAsset type: object required: - asset_identifier - asset_type - contract_id - asset_name properties: asset_identifier: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$ title: Asset Identifier description: Asset Identifier examples: - SP000000000000000000002Q6VF78.pox-3::stx-token type: string asset_type: description: Whether the asset is a fungible or non-fungible token anyOf: - type: string enum: - ft - type: string enum: - nft contract_id: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string asset_name: description: The name the asset is declared with on-chain. This is the identifier from the contract's token definition, not the display name or symbol the contract reports through `get-name` and `get-symbol`. examples: - diko type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/smart-contracts/{contract_id}: get: operationId: get_smart_contract summary: Get smart contract tags: - Smart Contracts description: Retrieves a deployed smart contract, along with the transaction that deployed it. Only successfully deployed contracts are returned; a contract id whose deploy transaction failed is not found. parameters: - schema: uniqueItems: true type: array items: type: string enum: - source_code in: query name: include required: false description: Heavy fields to include in the response. - schema: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID type: string example: SP000000000000000000002Q6VF78.pox-3 in: path name: contract_id required: true description: Smart Contract ID responses: "200": description: Default Response content: application/json: schema: title: SmartContract type: object required: - contract_id - clarity_version - tx_id - block - bitcoin_block properties: contract_id: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID type: string example: SP000000000000000000002Q6VF78.pox-3 clarity_version: anyOf: - description: The Clarity version the contract runs under. Contracts deployed with a versioned payload declare their own version; for the rest it is the version the node resolved from the epoch they were deployed in. Null when it could not be determined, which only happens for contracts indexed from a chainstate predating the point where the Stacks node began reporting it. examples: - 3 type: integer - type: "null" tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: ID of the transaction that deployed this contract type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. type: string example: 2026-10-08T19:18:41.000Z tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. type: string example: 2026-10-08T19:18:41.000Z source_code: description: The Clarity source code of the contract. Only present when requested via the `include=source_code` query param. type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/staking/bonds: get: operationId: get_bonds summary: Get bonds tags: - Staking description: Get bonds parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^\d+$ type: string in: query name: cursor required: false description: "Cursor for paginating bonds. Format: bond_index" responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - pattern: ^\d+$ description: "Cursor for paginating bonds. Format: bond_index" type: string - type: "null" previous: anyOf: - pattern: ^\d+$ description: "Cursor for paginating bonds. Format: bond_index" type: string - type: "null" current: anyOf: - pattern: ^\d+$ description: "Cursor for paginating bonds. Format: bond_index" type: string - type: "null" results: type: array items: type: object required: - index - pox_version - status - parameters - registrations - schedule - balances properties: index: description: The index of the bond in the PoX-5 bond list type: integer pox_version: type: string enum: - pox5 status: anyOf: - type: string enum: - upcoming - type: string enum: - active - type: string enum: - unlocked parameters: type: object required: - target_rate_bps - stx_value_ratio - minimum_stx_ratio - btc_capacity properties: target_rate_bps: description: The target yield rate (APY) in basis points type: integer stx_value_ratio: description: This is a representation of the STXBTC price. The value represents "uSTX per 100 sats" type: integer minimum_stx_ratio: description: The amount of STX that must be locked relative to BTC, in equal-valued terms (ie in USD terms). This value is represented in basis points. type: integer btc_capacity: description: The total capacity of BTC that can be locked up for this bond type: string registrations: type: object required: - allowed_count - registered_count properties: allowed_count: description: The number of entries in the allowlist for this bond type: integer registered_count: description: The number of registrations for this bond type: integer schedule: description: "The bond's lifecycle timeline. Each point is the first Bitcoin height of a new phase: `enrollment_cutoff` is the first height at which `register-for-bond` is rejected (the prepare phase before activation, so enrollment is open strictly before it), `activation` is the first height the bond is active, and `unlock` the first height it is unlocked." type: object required: - enrollment_cutoff - activation - unlock properties: enrollment_cutoff: type: object required: - bitcoin_height - pox_cycle - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point in the bond lifecycle type: integer pox_cycle: description: The PoX cycle of this point in the bond lifecycle type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. anyOf: - type: string - type: "null" example: 2026-10-08T19:18:41.000Z projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. anyOf: - type: string - type: "null" example: 2027-03-01T08:30:00.000Z activation: type: object required: - bitcoin_height - pox_cycle - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point in the bond lifecycle type: integer pox_cycle: description: The PoX cycle of this point in the bond lifecycle type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. anyOf: - type: string - type: "null" example: 2026-10-08T19:18:41.000Z projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. anyOf: - type: string - type: "null" example: 2027-03-01T08:30:00.000Z unlock: type: object required: - bitcoin_height - pox_cycle - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point in the bond lifecycle type: integer pox_cycle: description: The PoX cycle of this point in the bond lifecycle type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. anyOf: - type: string - type: "null" example: 2026-10-08T19:18:41.000Z projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. anyOf: - type: string - type: "null" example: 2027-03-01T08:30:00.000Z balances: type: object required: - locked - rewards - paid_out properties: locked: type: object required: - btc - stx properties: btc: description: The total amount of BTC that is locked up for this bond type: string stx: description: The total amount of STX that is locked up for this bond type: string rewards: type: object required: - btc properties: btc: type: object required: - distributed - accrued - claimed properties: distributed: description: The lifetime sBTC reward sats the contract has distributed into this bond's reward pool type: string accrued: description: An estimate of the lifetime sBTC reward sats credited to this bond's participants. Never more than `distributed`, because each share is floored to whole sats and the rounding remainder stays in the pool. This is computed by flooring each distribution, while the contract floors each settlement interval, so it can under-report by a few sats and may read slightly below `claimed`. Use `distributed` and `claimed` where exactness matters type: string claimed: description: The lifetime sBTC reward sats this bond's participants have already claimed type: string paid_out: type: object required: - btc properties: btc: description: "The total amount of BTC that has been paid out for this bond. **Deprecated**: use `rewards.btc.distributed`, which this mirrors" deprecated: true type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/staking/bonds/{bond_index}: get: operationId: get_bond summary: Get bond tags: - Staking description: Get a bond. A bond that has not been set up yet but still can be (its activation height is ahead of the chain tip) is returned with a `projected` status and only the schedule pox-5 will assign it, which follows from its index. parameters: - schema: type: integer in: path name: bond_index required: true description: The index of the bond in the PoX-5 bond list responses: "200": description: Default Response content: application/json: schema: anyOf: - type: object required: - index - pox_version - status - parameters - registrations - schedule - balances - transaction properties: index: description: The index of the bond in the PoX-5 bond list type: integer pox_version: type: string enum: - pox5 status: anyOf: - type: string enum: - upcoming - type: string enum: - active - type: string enum: - unlocked parameters: type: object required: - target_rate_bps - stx_value_ratio - minimum_stx_ratio - btc_capacity properties: target_rate_bps: description: The target yield rate (APY) in basis points type: integer stx_value_ratio: description: This is a representation of the STXBTC price. The value represents "uSTX per 100 sats" type: integer minimum_stx_ratio: description: The amount of STX that must be locked relative to BTC, in equal-valued terms (ie in USD terms). This value is represented in basis points. type: integer btc_capacity: description: The total capacity of BTC that can be locked up for this bond type: string registrations: type: object required: - allowed_count - registered_count properties: allowed_count: description: The number of entries in the allowlist for this bond type: integer registered_count: description: The number of registrations for this bond type: integer schedule: description: "The bond's lifecycle timeline. Each point is the first Bitcoin height of a new phase: `enrollment_cutoff` is the first height at which `register-for-bond` is rejected (the prepare phase before activation, so enrollment is open strictly before it), `activation` is the first height the bond is active, and `unlock` the first height it is unlocked." type: object required: - enrollment_cutoff - activation - unlock properties: enrollment_cutoff: type: object required: - bitcoin_height - pox_cycle - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point in the bond lifecycle type: integer pox_cycle: description: The PoX cycle of this point in the bond lifecycle type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2026-10-08T19:18:41.000Z anyOf: - type: string - type: "null" projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2027-03-01T08:30:00.000Z anyOf: - type: string - type: "null" activation: type: object required: - bitcoin_height - pox_cycle - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point in the bond lifecycle type: integer pox_cycle: description: The PoX cycle of this point in the bond lifecycle type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2026-10-08T19:18:41.000Z anyOf: - type: string - type: "null" projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2027-03-01T08:30:00.000Z anyOf: - type: string - type: "null" unlock: type: object required: - bitcoin_height - pox_cycle - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point in the bond lifecycle type: integer pox_cycle: description: The PoX cycle of this point in the bond lifecycle type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2026-10-08T19:18:41.000Z anyOf: - type: string - type: "null" projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2027-03-01T08:30:00.000Z anyOf: - type: string - type: "null" balances: type: object required: - locked - rewards - paid_out properties: locked: type: object required: - btc - stx properties: btc: description: The total amount of BTC that is locked up for this bond type: string stx: description: The total amount of STX that is locked up for this bond type: string rewards: type: object required: - btc properties: btc: type: object required: - distributed - accrued - claimed properties: distributed: description: The lifetime sBTC reward sats the contract has distributed into this bond's reward pool type: string accrued: description: An estimate of the lifetime sBTC reward sats credited to this bond's participants. Never more than `distributed`, because each share is floored to whole sats and the rounding remainder stays in the pool. This is computed by flooring each distribution, while the contract floors each settlement interval, so it can under-report by a few sats and may read slightly below `claimed`. Use `distributed` and `claimed` where exactness matters type: string claimed: description: The lifetime sBTC reward sats this bond's participants have already claimed type: string paid_out: type: object required: - btc properties: btc: description: "The total amount of BTC that has been paid out for this bond. **Deprecated**: use `rewards.btc.distributed`, which this mirrors" deprecated: true type: string transaction: type: object required: - tx_id - block - bitcoin_block properties: tx_id: description: The transaction ID that created the bond type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string - description: "A bond that has not been set up yet. Its schedule is projected from its index under the current PoX version's rules (pox-5 starts a new bond every 2 reward cycles), so it carries no `pox_version`: the bond may end up set up under a later version, or never. Its parameters and allowlist are not known until it's set up." type: object required: - index - status - schedule properties: index: description: The index of the bond in the PoX-5 bond list type: integer status: type: string enum: - projected schedule: description: "The bond's lifecycle timeline. Each point is the first Bitcoin height of a new phase: `enrollment_cutoff` is the first height at which `register-for-bond` is rejected (the prepare phase before activation, so enrollment is open strictly before it), `activation` is the first height the bond is active, and `unlock` the first height it is unlocked." type: object required: - enrollment_cutoff - activation - unlock properties: enrollment_cutoff: type: object required: - bitcoin_height - pox_cycle - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point in the bond lifecycle type: integer pox_cycle: description: The PoX cycle of this point in the bond lifecycle type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2026-10-08T19:18:41.000Z anyOf: - type: string - type: "null" projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2027-03-01T08:30:00.000Z anyOf: - type: string - type: "null" activation: type: object required: - bitcoin_height - pox_cycle - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point in the bond lifecycle type: integer pox_cycle: description: The PoX cycle of this point in the bond lifecycle type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2026-10-08T19:18:41.000Z anyOf: - type: string - type: "null" projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2027-03-01T08:30:00.000Z anyOf: - type: string - type: "null" unlock: type: object required: - bitcoin_height - pox_cycle - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point in the bond lifecycle type: integer pox_cycle: description: The PoX cycle of this point in the bond lifecycle type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2026-10-08T19:18:41.000Z anyOf: - type: string - type: "null" projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2027-03-01T08:30:00.000Z anyOf: - type: string - type: "null" 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/staking/bonds/{bond_index}/events: get: operationId: get_bond_events summary: Get bond events tags: - Staking description: "A bond's pox-5 event log, newest first: setup, allowlist additions, registrations and registration updates, early exits (`announce-l1-early-exit`, and `unstake-sbtc` with a `new_amount_sats` of 0), partial sBTC unstakes, reward distributions, and staker reward claims." parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string in: query name: cursor required: false description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_index" - schema: type: integer in: path name: bond_index required: true description: The index of the bond in the PoX-5 bond list responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" previous: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" current: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" results: type: array items: title: BondEvent anyOf: - title: BondSetupEvent type: object required: - name - bond_index - transaction - block - bitcoin_block - data properties: name: type: string enum: - setup-bond bond_index: description: The index of the bond in the PoX-5 bond list type: integer transaction: type: object required: - tx_id - event_index properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - "0xf6bd5f4a7b26184a3466340b2e99fd003b4962\ c0e382a7e4b6a13df3dd7a91c6" type: string event_index: description: Index of the event within the transaction type: integer block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string data: type: object required: - parameters - early_unlock_bytes - schedule properties: parameters: type: object required: - target_rate_bps - stx_value_ratio - minimum_stx_ratio properties: target_rate_bps: description: The target yield rate (APY) in basis points type: integer stx_value_ratio: description: This is a representation of the STXBTC price. The value represents "uSTX per 100 sats" type: integer minimum_stx_ratio: description: The amount of STX that must be locked relative to BTC, in equal-valued terms (ie in USD terms). This value is represented in basis points. type: integer early_unlock_bytes: description: Hex string of the Bitcoin script subscript guarding the early-exit branch of the L1 lockup type: string schedule: description: "The bond's lifecycle timeline. Each point is the first Bitcoin height of a new phase: `enrollment_cutoff` is the first height at which `register-for-bond` is rejected (the prepare phase before activation, so enrollment is open strictly before it), `activation` is the first height the bond is active, and `unlock` the first height it is unlocked." type: object required: - enrollment_cutoff - activation - unlock properties: enrollment_cutoff: type: object required: - bitcoin_height - pox_cycle - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point in the bond lifecycle type: integer pox_cycle: description: The PoX cycle of this point in the bond lifecycle type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2026-10-08T19:18:41.000Z anyOf: - type: string - type: "null" projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2027-03-01T08:30:00.000Z anyOf: - type: string - type: "null" activation: type: object required: - bitcoin_height - pox_cycle - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point in the bond lifecycle type: integer pox_cycle: description: The PoX cycle of this point in the bond lifecycle type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2026-10-08T19:18:41.000Z anyOf: - type: string - type: "null" projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2027-03-01T08:30:00.000Z anyOf: - type: string - type: "null" unlock: type: object required: - bitcoin_height - pox_cycle - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point in the bond lifecycle type: integer pox_cycle: description: The PoX cycle of this point in the bond lifecycle type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2026-10-08T19:18:41.000Z anyOf: - type: string - type: "null" projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. examples: - 2027-03-01T08:30:00.000Z anyOf: - type: string - type: "null" - title: BondAddToAllowlistEvent type: object required: - name - bond_index - transaction - block - bitcoin_block - data properties: name: type: string enum: - add-to-allowlist bond_index: description: The index of the bond in the PoX-5 bond list type: integer transaction: type: object required: - tx_id - event_index properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - "0xf6bd5f4a7b26184a3466340b2e99fd003b4962\ c0e382a7e4b6a13df3dd7a91c6" type: string event_index: description: Index of the event within the transaction type: integer block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string data: type: object required: - staker - max_sats properties: staker: type: string max_sats: type: string - title: BondRegisterEvent type: object required: - name - bond_index - transaction - block - bitcoin_block - data properties: name: type: string enum: - register-for-bond bond_index: description: The index of the bond in the PoX-5 bond list type: integer transaction: type: object required: - tx_id - event_index properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - "0xf6bd5f4a7b26184a3466340b2e99fd003b4962\ c0e382a7e4b6a13df3dd7a91c6" type: string event_index: description: Index of the event within the transaction type: integer block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string data: type: object required: - staker - signer - type - balances properties: staker: type: string signer: type: string type: anyOf: - type: string enum: - l1 - type: string enum: - l2 balances: type: object required: - btc - stx properties: btc: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string stx: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string - title: BondUpdateRegistrationEvent type: object required: - name - bond_index - transaction - block - bitcoin_block - data properties: name: type: string enum: - update-bond-registration bond_index: description: The index of the bond in the PoX-5 bond list type: integer transaction: type: object required: - tx_id - event_index properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - "0xf6bd5f4a7b26184a3466340b2e99fd003b4962\ c0e382a7e4b6a13df3dd7a91c6" type: string event_index: description: Index of the event within the transaction type: integer block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string data: type: object required: - staker - signer - type - balances - old_signer properties: staker: type: string signer: type: string type: anyOf: - type: string enum: - l1 - type: string enum: - l2 balances: type: object required: - btc - stx properties: btc: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string stx: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string old_signer: description: The previous signer of the registration type: string - title: BondAnnounceL1EarlyExitEvent type: object required: - name - bond_index - transaction - block - bitcoin_block - data properties: name: type: string enum: - announce-l1-early-exit bond_index: description: The index of the bond in the PoX-5 bond list type: integer transaction: type: object required: - tx_id - event_index properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - "0xf6bd5f4a7b26184a3466340b2e99fd003b4962\ c0e382a7e4b6a13df3dd7a91c6" type: string event_index: description: Index of the event within the transaction type: integer block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string data: type: object required: - staker - signer - released properties: staker: description: The staker exiting the bond early type: string signer: description: The signer the staker was staked under type: string released: description: The sats released by the early exit type: object required: - btc properties: btc: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string - title: BondUnstakeSbtcEvent type: object required: - name - bond_index - transaction - block - bitcoin_block - data properties: name: type: string enum: - unstake-sbtc bond_index: description: The index of the bond in the PoX-5 bond list type: integer transaction: type: object required: - tx_id - event_index properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - "0xf6bd5f4a7b26184a3466340b2e99fd003b4962\ c0e382a7e4b6a13df3dd7a91c6" type: string event_index: description: Index of the event within the transaction type: integer block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string data: type: object required: - staker - signer - withdrawn - remaining properties: staker: description: The staker withdrawing sBTC from the bond type: string signer: description: The signer the staker was staked under type: string withdrawn: description: The sats withdrawn type: object required: - btc properties: btc: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string remaining: description: The sBTC shares remaining after the withdrawal; 0 indicates a full early exit type: object required: - btc properties: btc: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string - title: BondDistributionEvent type: object required: - name - bond_index - transaction - block - bitcoin_block - data properties: name: type: string enum: - bond-distribution bond_index: description: The index of the bond in the PoX-5 bond list type: integer transaction: type: object required: - tx_id - event_index properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - "0xf6bd5f4a7b26184a3466340b2e99fd003b4962\ c0e382a7e4b6a13df3dd7a91c6" type: string event_index: description: Index of the event within the transaction type: integer block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string data: type: object required: - calculation - target_yield - rewards - staked - accrued_rewards_per_sat - cumulative_rewards_per_sat properties: calculation: description: The `calculate-rewards` call this distribution was emitted by, from the `calculate-rewards` event in the same transaction. type: object required: - bitcoin_height - reward_cycle properties: bitcoin_height: description: "The Bitcoin height the rewards were calculated for: the start of the distribution period, which can differ from the height of the block carrying this event." type: integer reward_cycle: description: The PoX reward cycle the calculation (and this distribution) books to type: integer target_yield: pattern: ^[0-9]+$ description: The bond's target reward for this calculation, in sats type: string rewards: description: The rewards earned by this bond this calculation type: object required: - btc properties: btc: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string staked: description: The sats staked in the bond at calculation time type: object required: - btc properties: btc: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string accrued_rewards_per_sat: pattern: ^[0-9]+$ description: The per-sat rewards accrued this calculation, as a 1e18 fixed-point integer type: string cumulative_rewards_per_sat: pattern: ^[0-9]+$ description: The running per-sat reward total for the bond after this calculation, as a 1e18 fixed-point integer type: string - title: BondClaimStakerRewardsEvent type: object required: - name - bond_index - transaction - block - bitcoin_block - data properties: name: type: string enum: - claim-staker-rewards-for-signer bond_index: description: The index of the bond in the PoX-5 bond list type: integer transaction: type: object required: - tx_id - event_index properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - "0xf6bd5f4a7b26184a3466340b2e99fd003b4962\ c0e382a7e4b6a13df3dd7a91c6" type: string event_index: description: Index of the event within the transaction type: integer block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string data: type: object required: - signer_manager - staker - reward_cycle - claimed properties: signer_manager: description: The signer manager that claimed on behalf of the staker type: string staker: description: The staker the rewards were claimed for type: string reward_cycle: description: The PoX reward cycle claimed type: integer claimed: description: The sats claimed type: object required: - btc properties: btc: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/staking/bonds/{bond_index}/allowlist: get: operationId: get_bond_allowlist_entries summary: Get bond allowlist entries tags: - Staking description: Get bond allowlist entries parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string in: query name: cursor required: false description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" - schema: type: integer in: path name: bond_index required: true description: The index of the bond in the PoX-5 bond list responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" previous: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" current: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" results: type: array items: type: object required: - staker - max_sats properties: staker: type: string max_sats: type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/staking/bonds/{bond_index}/allowlist/{principal}: get: operationId: get_bond_allowlist_entry summary: Get bond allowlist entry tags: - Staking description: Get bond allowlist entry parameters: - schema: type: integer in: path name: bond_index required: true description: The index of the bond in the PoX-5 bond list - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - staker - max_sats properties: staker: type: string max_sats: type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/staking/bonds/{bond_index}/registrations: get: operationId: get_bond_registrations summary: Get bond registrations tags: - Staking description: Get bond registrations parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string in: query name: cursor required: false description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" - schema: type: integer in: path name: bond_index required: true description: The index of the bond in the PoX-5 bond list responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" previous: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" current: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" results: type: array items: type: object required: - staker - signer - type - balances properties: staker: type: string signer: type: string type: anyOf: - type: string enum: - l1 - type: string enum: - l2 balances: type: object required: - btc - stx properties: btc: pattern: ^[0-9]+$ title: Amount description: Amount type: string example: "1000000" stx: pattern: ^[0-9]+$ title: Amount description: Amount type: string example: "1000000" 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/staking/bonds/{bond_index}/registrations/{principal}: get: operationId: get_bond_registration summary: Get bond registration tags: - Staking description: Get bond registration parameters: - schema: type: integer in: path name: bond_index required: true description: The index of the bond in the PoX-5 bond list - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: anyOf: - type: object required: - staker - signer - type - balances - l1_lockup properties: staker: type: string signer: type: string type: anyOf: - type: string enum: - l1 - type: string enum: - l2 balances: type: object required: - btc - stx properties: btc: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string stx: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string l1_lockup: type: object required: - transactions properties: transactions: description: The proven L1 lockup transactions type: array items: type: object required: - tx_id - output_index properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - "0xf6bd5f4a7b26184a3466340b2e99fd003b4962\ c0e382a7e4b6a13df3dd7a91c6" type: string output_index: description: The output index of the proven L1 lockup type: integer - type: object required: - staker - signer - type - balances - l2_lockup properties: staker: type: string signer: type: string type: anyOf: - type: string enum: - l1 - type: string enum: - l2 balances: type: object required: - btc - stx properties: btc: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string stx: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string l2_lockup: type: object required: - tx_id properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382\ a7e4b6a13df3dd7a91c6" type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/staking/cycles/{cycle_number}: get: operationId: get_staking_cycle summary: Get staking cycle tags: - Staking description: A summary of staking for one PoX reward cycle. parameters: - schema: pattern: ^([0-9]{1,9}|current|previous|next)$ type: string examples: "143": value: "143" current: value: current in: path name: cycle_number required: true description: A PoX cycle number (up to nine digits), or one of `current` (the cycle containing the current Bitcoin tip), `previous`, or `next`. The prepare phase at the end of a cycle belongs to that cycle. responses: "200": description: Default Response content: application/json: schema: title: StakingCycle type: object required: - number - status - schedule - locked - participants - bonds - rewards properties: number: description: The PoX reward cycle number type: integer example: 143 status: description: Where the cycle stands relative to the current Bitcoin tip. anyOf: - type: string enum: - upcoming - type: string enum: - reward_phase - type: string enum: - prepare_phase - type: string enum: - finished schedule: description: "The Bitcoin heights delimiting the cycle, inclusive: its first block, the first block of its prepare phase, and its last block." type: object required: - start - prepare_phase_start - end properties: start: type: object required: - bitcoin_height - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. anyOf: - type: string - type: "null" example: 2026-10-08T19:18:41.000Z projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. anyOf: - type: string - type: "null" example: 2027-03-01T08:30:00.000Z prepare_phase_start: type: object required: - bitcoin_height - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. anyOf: - type: string - type: "null" example: 2026-10-08T19:18:41.000Z projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. anyOf: - type: string - type: "null" example: 2027-03-01T08:30:00.000Z end: type: object required: - bitcoin_height - time - time_iso - projected_time - projected_time_iso properties: bitcoin_height: description: The Bitcoin height of this point type: integer time: description: "Unix timestamp (in seconds) of when the Bitcoin block was mined, once it has been. The API learns Bitcoin block times only from the Stacks blocks anchored to them: for a block a Stacks block anchored to, this is the time recorded in its header; for a past block none anchored to (e.g. a missed sortition), it is an estimate, interpolated between the nearest anchored blocks before and after it. `null` for a block that has not been mined yet, and for a past block older than any Stacks block." anyOf: - type: integer - type: "null" time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. anyOf: - type: string - type: "null" example: 2026-10-08T19:18:41.000Z projected_time: description: Unix timestamp (in seconds) of when a future Bitcoin block is projected to be mined, extrapolated from the recent Bitcoin block pace (on mainnet, from the pace of the current difficulty period until its retarget, and the 10-minute target after it). Projections further out are less precise, by days for blocks months away. `null` once the block has been mined, and for a block projected past the end of year 9999. anyOf: - type: integer - type: "null" projected_time_iso: description: The `projected_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp; `null` with it. anyOf: - type: string - type: "null" example: 2027-03-01T08:30:00.000Z locked: description: The assets locked by staking for this cycle type: object required: - stx - btc properties: stx: type: object required: - stx_only - bonds - total properties: stx_only: pattern: ^[0-9]+$ title: Amount description: STX locked in STX-only staking that counts for this cycle, in µSTX. type: string example: "1000000" bonds: pattern: ^[0-9]+$ title: Amount description: STX locked across the bonds covering this cycle, in µSTX. type: string example: "1000000" total: pattern: ^[0-9]+$ title: Amount description: Sum of `stx_only` and `bonds`, in µSTX. type: string example: "1000000" btc: type: object required: - total - native - sbtc properties: total: pattern: ^[0-9]+$ title: Amount description: BTC locked across the bonds covering this cycle, in satoshis (proven Bitcoin L1 lockups and sBTC lockups). For a finished cycle this is the BTC staked per bond at the cycle's latest reward distribution; otherwise the bonds' running locked totals. type: string example: "1000000" native: pattern: ^[0-9]+$ title: Amount description: Of `total`, the satoshis locked through proven Bitcoin L1 lockups. type: string example: "1000000" sbtc: pattern: ^[0-9]+$ title: Amount description: Of `total`, the satoshis locked through sBTC lockups. type: string example: "1000000" participants: description: Who participates in the cycle type: object required: - stakers - signers properties: stakers: type: object required: - stx_only - bonds properties: stx_only: description: Principals whose STX-only stake counts for this cycle. type: integer bonds: description: Principals holding a position in a bond covering this cycle. type: integer signers: anyOf: - description: Signers in the cycle's reward set. `null` until the node has emitted the reward set, which happens during the previous cycle's prepare phase. type: integer - type: "null" bonds: description: The pox-5 bonds active during this cycle type: object required: - total - indexes properties: total: description: Bonds whose term covers this cycle type: integer indexes: description: Their bond indexes, ascending type: array items: description: The index of the bond in the PoX-5 bond list type: integer rewards: description: The rewards generated by this cycle type: object required: - btc properties: btc: type: object required: - total - waterfall - claimed properties: total: pattern: ^[0-9]+$ title: Amount description: sBTC rewards booked to this cycle by the pox-5 reward distributions run so far, in satoshis. Distributions run periodically within a cycle, so this grows while the cycle is active; it equals the sum of the `waterfall` entries. type: string example: "1000000" waterfall: description: How the accrued rewards were split, in payout order type: object required: - bonds - stx_only - reserve_deposit properties: bonds: pattern: ^[0-9]+$ title: Amount description: The share paid to bond participants, in satoshis. type: string example: "1000000" stx_only: pattern: ^[0-9]+$ title: Amount description: The share paid to STX-only stakers, in satoshis. type: string example: "1000000" reserve_deposit: pattern: ^[0-9]+$ title: Amount description: The share deposited into the protocol reserve, in satoshis. type: string example: "1000000" claimed: pattern: ^[0-9]+$ title: Amount description: sBTC claimed from the pox-5 contract by signer managers for this cycle so far, in satoshis. Claims trail distributions and can keep growing after the cycle ends. type: string example: "1000000" 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/staking/cycles/{cycle_number}/signers: get: operationId: get_cycle_signers summary: Get cycle signers tags: - Staking description: Get the signer set of a PoX cycle, including each signer's weight, staked amount, and the signer manager contracts whose registered signing key was this key when the cycle's reward set was calculated. parameters: - schema: minimum: 1 default: 100 maximum: 250 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^(0x)?[0-9a-fA-F]{66}$ type: string in: query name: cursor required: false description: "Cursor for paginating a cycle's signers (sorted by weight descending, then signing key). Format: signing key" - schema: pattern: ^([0-9]{1,9}|current|previous|next)$ type: string examples: "143": value: "143" current: value: current in: path name: cycle_number required: true description: A PoX cycle number (up to nine digits), or one of `current` (the cycle containing the current Bitcoin tip), `previous`, or `next`. The prepare phase at the end of a cycle belongs to that cycle. responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 100 maximum: 250 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - pattern: ^(0x)?[0-9a-fA-F]{66}$ description: "Cursor for paginating a cycle's signers (sorted by weight descending, then signing key). Format: signing key" type: string - type: "null" previous: anyOf: - pattern: ^(0x)?[0-9a-fA-F]{66}$ description: "Cursor for paginating a cycle's signers (sorted by weight descending, then signing key). Format: signing key" type: string - type: "null" current: anyOf: - pattern: ^(0x)?[0-9a-fA-F]{66}$ description: "Cursor for paginating a cycle's signers (sorted by weight descending, then signing key). Format: signing key" type: string - type: "null" results: type: array items: title: CycleSigner type: object required: - signing_key - weight - staked_stx - signer_managers properties: signing_key: description: The signing key in the cycle's reward set, as a `0x`-prefixed hex string type: string example: "0x038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d" weight: description: The signer's voting weight in the cycle type: object required: - amount - percent properties: amount: type: integer percent: description: Percentage of the cycle's total signer weight type: number staked_stx: description: The uSTX staked behind this signer in the cycle type: object required: - amount - percent properties: amount: type: string percent: description: Percentage of the cycle's total staked STX type: number signer_managers: description: The signer manager contracts whose registered signing key (via `register-signer`) was this key when the cycle's reward set was calculated. type: array items: title: CycleSignerManager type: object required: - signer_manager - registered_at - granted_keys - grant_active - pending_key_update properties: signer_manager: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string registered_at: description: The position of the `register-signer` event that bound this key to the manager. type: object required: - block_height - bitcoin_block_height - tx_id properties: block_height: description: Stacks block height of the `register-signer` event type: integer bitcoin_block_height: description: Bitcoin block height of the `register-signer` event type: integer tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" granted_keys: description: The manager's live `grant-signer-key` authorizations (granted and not revoked). A grant authorizes a future `register-signer` for that key but does not rotate the key by itself. type: array items: title: SignerKeyGrant type: object required: - signer_key - auth_id - tx_id properties: signer_key: description: The granted signing key, as a `0x`-prefixed hex string type: string auth_id: description: The grant's auth id as a decimal string type: string tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" grant_active: description: Whether a live `grant-signer-key` authorization currently exists for the registered key. type: boolean pending_key_update: anyOf: - description: The manager's latest key registered after this cycle's reward set was calculated, when it differs from the cycle's signing key. Takes effect next cycle. type: object required: - signer_key - effective_cycle - tx_id properties: signer_key: description: The newly registered signing key, as a `0x`-prefixed hex string type: string effective_cycle: description: The PoX cycle in which the new key takes effect type: integer tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - "0xf6bd5f4a7b26184a3466340b2e99fd00\ 3b4962c0e382a7e4b6a13df3dd7a91c6" type: string - type: "null" 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/staking/rewards: get: operationId: get_staking_rewards summary: Get network staking reward totals tags: - Staking description: Get the total Bitcoin generated by staking on the Stacks network across all history, along with the total BTC burned by block commits. Values are in satoshis and always reflect the latest ingested chain state. responses: "200": description: Default Response content: application/json: schema: title: StakingRewards type: object required: - btc properties: btc: type: object required: - reward_amount - burn_amount - total_amount properties: reward_amount: pattern: ^[0-9]+$ title: Amount description: "Total Bitcoin generated by staking on the Stacks network, in satoshis, counted as the BTC paid by block commits to reward recipients: stacker reward addresses directly through pox-4, and the sBTC peg custody address from pox-5 on (whose inflows fund the sBTC staking rewards distributed through the pox-5 contract)." type: string example: "9232234450122" burn_amount: pattern: ^[0-9]+$ title: Amount description: Total BTC burned by block commits, in satoshis, including pox-1 through pox-4 prepare-phase burns. Excludes the 2.0-era PoX sunset-ramp surcharge (bitcoin blocks ~766050-781551), which the node never reported. pox-5 commits do not burn. type: string example: "184023450122" total_amount: pattern: ^[0-9]+$ title: Amount description: "Sum of `reward_amount` and `burn_amount`, in satoshis: the total BTC block commits have spent toward staking across all history, whether paid to recipients or burned." type: string example: "9416257900244" 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/staking/signers: get: operationId: get_staking_signers summary: Get staking signers tags: - Staking description: "Get the all-time registry of pox-5 staking signers: every signer principal that has ever registered a signer key, with its most recently registered key. Registrants are never removed from this registry, even if they are no longer part of the current cycle's signer set." parameters: - schema: minimum: 1 default: 100 maximum: 250 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}(\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39})?$ type: string in: query name: cursor required: false description: "Cursor for paginating staking signers (sorted by signer). Format: signer principal" responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 100 maximum: 250 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}(\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39})?$ description: "Cursor for paginating staking signers (sorted by signer). Format: signer principal" type: string - type: "null" previous: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}(\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39})?$ description: "Cursor for paginating staking signers (sorted by signer). Format: signer principal" type: string - type: "null" current: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}(\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39})?$ description: "Cursor for paginating staking signers (sorted by signer). Format: signer principal" type: string - type: "null" results: type: array items: title: StakingSigner type: object required: - signer - signer_key properties: signer: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string signer_key: description: The registered compressed secp256k1 public key, as a `0x`-prefixed hex string type: string example: 0x03a0f9e1... 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/staking/signers/{principal}: get: operationId: get_staking_signer summary: Get staking signer tags: - Staking description: Get a registered pox-5 staking signer along with the details of the transaction that registered its current key. parameters: - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: title: StakingSignerDetail type: object required: - signer - signer_key - transaction properties: signer: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string signer_key: description: The registered compressed secp256k1 public key, as a `0x`-prefixed hex string type: string example: 0x03a0f9e1... transaction: type: object required: - tx_id - block - bitcoin_block properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. type: string example: 2026-10-08T19:18:41.000Z tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. type: string example: 2026-10-08T19:18:41.000Z 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/staking/signers/{principal}/stakers: get: operationId: get_staking_signer_stakers summary: Get staking signer stakers tags: - Staking description: List the stakers that belong to a pox-5 signer, across both direct STX staking and BTC/sBTC bond staking. Each entry indicates which staking type(s) the staker participates in under this signer. parameters: - schema: minimum: 1 default: 100 maximum: 200 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}(\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39})?$ type: string in: query name: cursor required: false description: "Cursor for paginating a signer's stakers (sorted by staker). Format: staker principal" - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 100 maximum: 200 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}(\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39})?$ description: "Cursor for paginating a signer's stakers (sorted by staker). Format: staker principal" type: string - type: "null" previous: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}(\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39})?$ description: "Cursor for paginating a signer's stakers (sorted by staker). Format: staker principal" type: string - type: "null" current: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}(\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39})?$ description: "Cursor for paginating a signer's stakers (sorted by staker). Format: staker principal" type: string - type: "null" results: type: array items: title: SignerStaker type: object required: - staker - types properties: staker: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string types: description: "The staking types this staker participates in under this signer: `stx` for direct pox-5 STX staking, `btc` for BTC/sBTC bond staking. A staker doing both has both entries." type: array items: anyOf: - type: string enum: - stx - type: string enum: - btc example: - stx 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/tokens/stx/supply: get: operationId: get_stx_total_supply summary: Get total STX supply tags: - Tokens description: "Retrieves the total liquid STX supply in micro-STX (µSTX) at the current chain tip: all STX minted (including vesting schedule unlocks) plus matured miner coinbase rewards, minus burned STX." responses: "200": description: Default Response content: application/json: schema: title: StxSupply type: object required: - total - projected_total_2050 properties: total: pattern: ^[0-9]+$ title: Amount description: "Total liquid STX supply as a string-quoted integer of micro-STX (µSTX): all STX minted (including vesting schedule unlocks) plus matured miner coinbase rewards, minus burned STX" type: string example: "1470469916700000" projected_total_2050: pattern: ^[0-9]+$ title: Amount description: Projected total STX supply in the year 2050, as a string-quoted integer of micro-STX (µSTX). type: string example: "2318000000000000" 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/tokens/stx/holders: get: operationId: get_stx_holders summary: Get STX holders tags: - Tokens description: Retrieves the principals holding STX, sorted by balance descending. Balances are the total µSTX held, including any STX locked for stacking — they are not the spendable balance reported as `available` by a principal's STX balance. parameters: - schema: minimum: 1 default: 100 maximum: 200 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^\d+:\S+$ type: string in: query name: cursor required: false description: "Cursor for paginating fungible token holders (sorted by balance descending, then holder principal). Format: balance:principal" responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 100 maximum: 200 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - pattern: ^\d+:\S+$ description: "Cursor for paginating fungible token holders (sorted by balance descending, then holder principal). Format: balance:principal" type: string - type: "null" previous: anyOf: - pattern: ^\d+:\S+$ description: "Cursor for paginating fungible token holders (sorted by balance descending, then holder principal). Format: balance:principal" type: string - type: "null" current: anyOf: - pattern: ^\d+:\S+$ description: "Cursor for paginating fungible token holders (sorted by balance descending, then holder principal). Format: balance:principal" type: string - type: "null" results: type: array items: title: FtHolder type: object required: - principal - balance properties: principal: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string balance: pattern: ^[0-9]+$ title: Amount description: The holder's balance, as a string-quoted integer in the token's own base units type: string example: "174823763" 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/tokens/ft/{asset_identifier}/holders: get: operationId: get_fungible_token_holders summary: Get fungible token holders tags: - Tokens description: Retrieves the principals holding a given fungible token, sorted by balance descending. Balances are in the token's own base units. parameters: - schema: minimum: 1 default: 100 maximum: 200 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^\d+:\S+$ type: string in: query name: cursor required: false description: "Cursor for paginating fungible token holders (sorted by balance descending, then holder principal). Format: balance:principal" - schema: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$ title: Asset Identifier type: string example: SP000000000000000000002Q6VF78.pox-3::stx-token in: path name: asset_identifier required: true description: Asset Identifier responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 100 maximum: 200 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - pattern: ^\d+:\S+$ description: "Cursor for paginating fungible token holders (sorted by balance descending, then holder principal). Format: balance:principal" type: string - type: "null" previous: anyOf: - pattern: ^\d+:\S+$ description: "Cursor for paginating fungible token holders (sorted by balance descending, then holder principal). Format: balance:principal" type: string - type: "null" current: anyOf: - pattern: ^\d+:\S+$ description: "Cursor for paginating fungible token holders (sorted by balance descending, then holder principal). Format: balance:principal" type: string - type: "null" results: type: array items: title: FtHolder type: object required: - principal - balance properties: principal: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string balance: pattern: ^[0-9]+$ title: Amount description: The holder's balance, as a string-quoted integer in the token's own base units type: string example: "174823763" 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/tokens/ft/{asset_identifier}/supply: get: operationId: get_ft_total_supply summary: Get total fungible token supply tags: - Tokens description: "Retrieves the total supply of a fungible token: the sum of every holder balance, equivalent to the token's mints minus its burns. Returns a zero supply for a token with no recorded balances." parameters: - schema: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$ title: Asset Identifier type: string example: SP000000000000000000002Q6VF78.pox-3::stx-token in: path name: asset_identifier required: true description: Asset Identifier responses: "200": description: Default Response content: application/json: schema: title: FtSupply type: object required: - asset_identifier - total properties: asset_identifier: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$ title: Asset Identifier description: Asset Identifier type: string example: SP000000000000000000002Q6VF78.pox-3::stx-token total: pattern: ^[0-9]+$ title: Amount description: Total supply of the token, as a string-quoted integer in the token's own base units. type: string example: "5817609278457" 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/tokens/nft/{asset_identifier}/{value}/history: get: operationId: get_nft_instance_history summary: Get non-fungible token history tags: - Tokens description: Retrieves the event history of a single non-fungible token instance, newest first. Useful for determining an asset's ownership history. Mints have a null `sender` and burns a null `recipient`. The instance is addressed by a SIP-009 token id, or by its serialized Clarity value when the collection is not keyed by a `uint`. parameters: - schema: minimum: 1 default: 50 maximum: 200 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string in: query name: cursor required: false description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_index" - schema: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$ title: Asset Identifier type: string example: SP000000000000000000002Q6VF78.pox-3::stx-token in: path name: asset_identifier required: true description: Asset Identifier - schema: pattern: ^(\d+|0x[a-fA-F0-9]+)$ title: NFT instance identifier type: string examples: "2051": value: "2051" "0x0100000000000000000000000000000803": value: "0x0100000000000000000000000000000803" in: path name: value required: true description: The token instance's identifier, either as a plain integer (a SIP-009 token id, which is serialized as a Clarity `uint`) or as a `0x`-prefixed serialized Clarity value. responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 50 maximum: 200 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" previous: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" current: anyOf: - description: "Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_i\ ndex" pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" results: type: array items: title: NftHistoryEvent type: object required: - sender - recipient - transaction - block properties: sender: anyOf: - anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string - type: "null" recipient: anyOf: - anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string - type: "null" transaction: type: object required: - tx_id - event_index properties: tx_id: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" event_index: description: Index of the event within the transaction type: integer block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. type: string example: 2026-10-08T19:18:41.000Z tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/transactions: get: operationId: get_transactions summary: Get transactions tags: - Transactions description: Retrieves a list of recently mined transactions parameters: - schema: minimum: 1 default: 20 maximum: 50 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string in: query name: cursor required: false description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 50 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" previous: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" current: anyOf: - description: "Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index" pattern: ^[0-9]+:[0-9]+:[0-9]+$ type: string - type: "null" results: type: array items: anyOf: - title: TokenTransferTransactionSummary description: Token transfer transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - token_transfer properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - token_transfer token_transfer: type: object required: - recipient - amount - memo properties: recipient: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: anyOf: - type: object required: - hex - repr properties: hex: type: string repr: type: string - type: "null" - title: SmartContractTransactionSummary description: Smart contract transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - smart_contract properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id properties: clarity_version: anyOf: - description: The Clarity version of the contract. Versioned contract transactions declare it; for the rest it is the version the node resolved from the epoch the contract was deployed in. Null only when it could not be determined, which happens for contracts indexed from a chainstate predating the point where the Stacks node began reporting it. type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string - title: ContractCallTransactionSummary description: Contract call transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - contract_call properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string - title: PoisonMicroblockTransactionSummary description: Poison microblock transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - poison_microblock - title: CoinbaseTransactionSummary description: Coinbase transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - coinbase properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - coinbase coinbase: type: object required: - alt_recipient properties: alt_recipient: anyOf: - description: A principal that will receive the miner rewards for this coinbase transaction. Can be either a standard principal or contract principal. Only specified for `coinbase-to-alt-recipient` transaction types, otherwise null. type: string - type: "null" - title: TenureChangeTransactionSummary description: Tenure change transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - tenure_change properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - tenure_change tenure_change: type: object required: - cause properties: cause: description: Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. anyOf: - type: string enum: - block_found - type: string enum: - extended - type: string enum: - extended_runtime - type: string enum: - extended_read_count - type: string enum: - extended_read_length - type: string enum: - extended_write_count - type: string enum: - extended_write_length 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/transactions/batch: get: operationId: get_transactions_batch summary: Get a batch of transactions tags: - Transactions description: "Retrieves the summaries of up to 20 mined transactions in a single call, given their transaction ids. Provide them as repeated querystring values (`?tx_id=A&tx_id=B`) or as a single comma-separated value (`?tx_id=A,B`). Results are returned in canonical chain order (newest first), not in the order the ids were supplied. Only transactions mined in the canonical chain are returned: an id that is unknown, non-canonical, or still in the mempool is absent from `results` rather than reported as an error, so compare the response against the ids you sent to find the ones that did not resolve. Use `GET /extended/v3/transactions/{tx_id}` for a single transaction, which also covers mempool transactions." parameters: - schema: minItems: 1 maxItems: 20 uniqueItems: true type: array items: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd\ 7a91c6" type: string in: query name: tx_id required: true description: Transaction ids to fetch summaries for. Provide as repeated querystring values (`?tx_id=A&tx_id=B`) or as a single comma-separated value (`?tx_id=A,B`). responses: "200": description: Default Response content: application/json: schema: title: TransactionBatchResponse type: object required: - results properties: results: type: array items: anyOf: - title: TokenTransferTransactionSummary description: Token transfer transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - token_transfer properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - token_transfer token_transfer: type: object required: - recipient - amount - memo properties: recipient: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: anyOf: - type: object required: - hex - repr properties: hex: type: string repr: type: string - type: "null" - title: SmartContractTransactionSummary description: Smart contract transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - smart_contract properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id properties: clarity_version: anyOf: - description: The Clarity version of the contract. Versioned contract transactions declare it; for the rest it is the version the node resolved from the epoch the contract was deployed in. Null only when it could not be determined, which happens for contracts indexed from a chainstate predating the point where the Stacks node began reporting it. type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string - title: ContractCallTransactionSummary description: Contract call transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - contract_call properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string - title: PoisonMicroblockTransactionSummary description: Poison microblock transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - poison_microblock - title: CoinbaseTransactionSummary description: Coinbase transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - coinbase properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - coinbase coinbase: type: object required: - alt_recipient properties: alt_recipient: anyOf: - description: A principal that will receive the miner rewards for this coinbase transaction. Can be either a standard principal or contract principal. Only specified for `coinbase-to-alt-recipient` transaction types, otherwise null. type: string - type: "null" - title: TenureChangeTransactionSummary description: Tenure change transaction summary type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - type - tenure_change properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped type: type: string enum: - tenure_change tenure_change: type: object required: - cause properties: cause: description: Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. anyOf: - type: string enum: - block_found - type: string enum: - extended - type: string enum: - extended_runtime - type: string enum: - extended_read_count - type: string enum: - extended_read_length - type: string enum: - extended_write_count - type: string enum: - extended_write_length 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/transactions/{tx_id}: get: operationId: get_transaction summary: Get transaction tags: - Transactions description: Retrieves details for a given transaction, including both mined and mempool transactions parameters: - schema: uniqueItems: true type: array items: anyOf: - type: string enum: - function_args - type: string enum: - source_code - type: string enum: - post_conditions - type: string enum: - result in: query name: include required: false description: Heavy fields to include in the response. Omitted by default to keep the payload lean. Provide as repeated querystring values (`?include=A&include=B`) or as a single comma-separated value (`?include=A,B`). - schema: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" in: path name: tx_id required: true description: Transaction ID responses: "200": description: Default Response content: application/json: schema: anyOf: - anyOf: - type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - parent_block - event_count - execution_cost - vm_error - type - token_transfer properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped parent_block: type: object required: - hash - index_hash properties: hash: description: Hash of the parent block type: string index_hash: description: Index block hash of the parent block type: string post_condition_mode: description: Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: description: Only present when requested via the `include=post_conditions` query param. type: array items: anyOf: - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - stx - type: object required: - principal - condition_code - amount - type - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - fungible asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - type - asset_value - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent - type: string enum: - maybe_sent type: type: string enum: - non_fungible asset_value: type: object required: - hex - repr properties: hex: type: string repr: type: string asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - staking - type: object required: - principal - condition_code - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - not_performed - type: string enum: - maybe_performed - type: string enum: - performed type: type: string enum: - pox event_count: description: Number of events in the transaction type: integer execution_cost: type: object required: - read_count - read_length - runtime - write_count - write_length properties: read_count: description: Number of reads in the transaction type: integer read_length: description: Length of reads in the transaction type: integer runtime: description: Runtime of the transaction type: integer write_count: description: Number of writes in the transaction type: integer write_length: description: Length of writes in the transaction type: integer vm_error: anyOf: - description: VM error of the transaction type: string - type: "null" result: type: object required: - hex - repr properties: hex: type: string repr: type: string type: type: string enum: - token_transfer token_transfer: type: object required: - recipient - amount - memo properties: recipient: description: Recipient of the token transfer type: string amount: description: Amount of the token transfer type: string memo: anyOf: - type: object required: - hex - repr properties: hex: type: string repr: type: string - type: "null" - type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - parent_block - event_count - execution_cost - vm_error - type - smart_contract properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped parent_block: type: object required: - hash - index_hash properties: hash: description: Hash of the parent block type: string index_hash: description: Index block hash of the parent block type: string post_condition_mode: description: Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: description: Only present when requested via the `include=post_conditions` query param. type: array items: anyOf: - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - stx - type: object required: - principal - condition_code - amount - type - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - fungible asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - type - asset_value - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent - type: string enum: - maybe_sent type: type: string enum: - non_fungible asset_value: type: object required: - hex - repr properties: hex: type: string repr: type: string asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - staking - type: object required: - principal - condition_code - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - not_performed - type: string enum: - maybe_performed - type: string enum: - performed type: type: string enum: - pox event_count: description: Number of events in the transaction type: integer execution_cost: type: object required: - read_count - read_length - runtime - write_count - write_length properties: read_count: description: Number of reads in the transaction type: integer read_length: description: Length of reads in the transaction type: integer runtime: description: Runtime of the transaction type: integer write_count: description: Number of writes in the transaction type: integer write_length: description: Length of writes in the transaction type: integer vm_error: anyOf: - description: VM error of the transaction type: string - type: "null" result: type: object required: - hex - repr properties: hex: type: string repr: type: string type: type: string enum: - smart_contract smart_contract: type: object required: - contract_id - clarity_version properties: contract_id: description: Contract ID of the smart contract type: string clarity_version: anyOf: - description: Clarity version of the smart contract type: number - type: "null" source_code: description: Source code of the smart contract. Only present when requested via the `include=source_code` query param. type: string - type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - parent_block - event_count - execution_cost - vm_error - type - contract_call properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped parent_block: type: object required: - hash - index_hash properties: hash: description: Hash of the parent block type: string index_hash: description: Index block hash of the parent block type: string post_condition_mode: description: Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: description: Only present when requested via the `include=post_conditions` query param. type: array items: anyOf: - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - stx - type: object required: - principal - condition_code - amount - type - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - fungible asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - type - asset_value - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent - type: string enum: - maybe_sent type: type: string enum: - non_fungible asset_value: type: object required: - hex - repr properties: hex: type: string repr: type: string asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - staking - type: object required: - principal - condition_code - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - not_performed - type: string enum: - maybe_performed - type: string enum: - performed type: type: string enum: - pox event_count: description: Number of events in the transaction type: integer execution_cost: type: object required: - read_count - read_length - runtime - write_count - write_length properties: read_count: description: Number of reads in the transaction type: integer read_length: description: Length of reads in the transaction type: integer runtime: description: Runtime of the transaction type: integer write_count: description: Number of writes in the transaction type: integer write_length: description: Length of writes in the transaction type: integer vm_error: anyOf: - description: VM error of the transaction type: string - type: "null" result: type: object required: - hex - repr properties: hex: type: string repr: type: string type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name properties: contract_id: description: Contract ID of the contract call type: string function_name: description: Function name of the contract call type: string function_args: description: List of arguments used to invoke the function. Only present when requested via the `include=function_args` query param. type: array items: type: object required: - hex - repr properties: hex: type: string repr: type: string - type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - parent_block - event_count - execution_cost - vm_error - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped parent_block: type: object required: - hash - index_hash properties: hash: description: Hash of the parent block type: string index_hash: description: Index block hash of the parent block type: string post_condition_mode: description: Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: description: Only present when requested via the `include=post_conditions` query param. type: array items: anyOf: - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - stx - type: object required: - principal - condition_code - amount - type - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - fungible asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - type - asset_value - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent - type: string enum: - maybe_sent type: type: string enum: - non_fungible asset_value: type: object required: - hex - repr properties: hex: type: string repr: type: string asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - staking - type: object required: - principal - condition_code - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - not_performed - type: string enum: - maybe_performed - type: string enum: - performed type: type: string enum: - pox event_count: description: Number of events in the transaction type: integer execution_cost: type: object required: - read_count - read_length - runtime - write_count - write_length properties: read_count: description: Number of reads in the transaction type: integer read_length: description: Length of reads in the transaction type: integer runtime: description: Runtime of the transaction type: integer write_count: description: Number of writes in the transaction type: integer write_length: description: Length of writes in the transaction type: integer vm_error: anyOf: - description: VM error of the transaction type: string - type: "null" result: type: object required: - hex - repr properties: hex: type: string repr: type: string type: type: string enum: - poison_microblock - type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - parent_block - event_count - execution_cost - vm_error - type - tenure_change properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped parent_block: type: object required: - hash - index_hash properties: hash: description: Hash of the parent block type: string index_hash: description: Index block hash of the parent block type: string post_condition_mode: description: Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: description: Only present when requested via the `include=post_conditions` query param. type: array items: anyOf: - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - stx - type: object required: - principal - condition_code - amount - type - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - fungible asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - type - asset_value - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent - type: string enum: - maybe_sent type: type: string enum: - non_fungible asset_value: type: object required: - hex - repr properties: hex: type: string repr: type: string asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - staking - type: object required: - principal - condition_code - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - not_performed - type: string enum: - maybe_performed - type: string enum: - performed type: type: string enum: - pox event_count: description: Number of events in the transaction type: integer execution_cost: type: object required: - read_count - read_length - runtime - write_count - write_length properties: read_count: description: Number of reads in the transaction type: integer read_length: description: Length of reads in the transaction type: integer runtime: description: Runtime of the transaction type: integer write_count: description: Number of writes in the transaction type: integer write_length: description: Length of writes in the transaction type: integer vm_error: anyOf: - description: VM error of the transaction type: string - type: "null" result: type: object required: - hex - repr properties: hex: type: string repr: type: string type: type: string enum: - tenure_change tenure_change: type: object required: - tenure_consensus_hash - prev_tenure_consensus_hash - burn_view_consensus_hash - previous_tenure_end - previous_tenure_blocks - cause - pubkey_hash properties: tenure_consensus_hash: description: Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. type: string prev_tenure_consensus_hash: description: Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. type: string burn_view_consensus_hash: description: Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. type: string previous_tenure_end: description: (Hex string) Stacks Block hash type: string previous_tenure_blocks: description: The number of blocks produced in the previous tenure. type: integer cause: description: Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. anyOf: - type: string enum: - block_found - type: string enum: - extended - type: string enum: - extended_runtime - type: string enum: - extended_read_count - type: string enum: - extended_read_length - type: string enum: - extended_write_count - type: string enum: - extended_write_length pubkey_hash: description: (Hex string) The ECDSA public key hash of the current tenure. type: string - type: object required: - tx_id - sender - sponsor - fee_rate - block - bitcoin_block - status - parent_block - event_count - execution_cost - vm_error - type - coinbase properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string block: type: object required: - height - hash - index_hash - time - time_iso - tx_index properties: height: description: Height of the block this transactions was associated with type: integer hash: description: Hash of the blocked this transactions was associated with type: string index_hash: description: Hash of the index block this transactions was associated with type: string time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer bitcoin_block: type: object required: - height - time - time_iso properties: height: description: Height of the anchor burn block. type: integer time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number time_iso: description: The `time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - problematic_skipped parent_block: type: object required: - hash - index_hash properties: hash: description: Hash of the parent block type: string index_hash: description: Index block hash of the parent block type: string post_condition_mode: description: Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: description: Only present when requested via the `include=post_conditions` query param. type: array items: anyOf: - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - stx - type: object required: - principal - condition_code - amount - type - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - fungible asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - type - asset_value - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent - type: string enum: - maybe_sent type: type: string enum: - non_fungible asset_value: type: object required: - hex - repr properties: hex: type: string repr: type: string asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - staking - type: object required: - principal - condition_code - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - not_performed - type: string enum: - maybe_performed - type: string enum: - performed type: type: string enum: - pox event_count: description: Number of events in the transaction type: integer execution_cost: type: object required: - read_count - read_length - runtime - write_count - write_length properties: read_count: description: Number of reads in the transaction type: integer read_length: description: Length of reads in the transaction type: integer runtime: description: Runtime of the transaction type: integer write_count: description: Number of writes in the transaction type: integer write_length: description: Length of writes in the transaction type: integer vm_error: anyOf: - description: VM error of the transaction type: string - type: "null" result: type: object required: - hex - repr properties: hex: type: string repr: type: string type: type: string enum: - coinbase coinbase: type: object required: - payload - alt_recipient - vrf_proof properties: payload: description: Payload of the coinbase transaction type: string alt_recipient: anyOf: - description: Alt recipient of the coinbase transaction type: string - type: "null" vrf_proof: anyOf: - description: VRF proof of the coinbase transaction type: string - type: "null" - anyOf: - type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - replaced_by_tx_id - type - token_transfer properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic post_condition_mode: description: Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: description: Only present when requested via the `include=post_conditions` query param. type: array items: anyOf: - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - stx - type: object required: - principal - condition_code - amount - type - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - fungible asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - type - asset_value - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent - type: string enum: - maybe_sent type: type: string enum: - non_fungible asset_value: type: object required: - hex - repr properties: hex: type: string repr: type: string asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - staking - type: object required: - principal - condition_code - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - not_performed - type: string enum: - maybe_performed - type: string enum: - performed type: type: string enum: - pox replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" type: type: string enum: - token_transfer token_transfer: type: object required: - recipient - amount - memo properties: recipient: description: Recipient of the token transfer type: string amount: description: Amount of the token transfer type: string memo: anyOf: - type: object required: - hex - repr properties: hex: type: string repr: type: string - type: "null" - type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - replaced_by_tx_id - type - smart_contract properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic post_condition_mode: description: Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: description: Only present when requested via the `include=post_conditions` query param. type: array items: anyOf: - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - stx - type: object required: - principal - condition_code - amount - type - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - fungible asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - type - asset_value - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent - type: string enum: - maybe_sent type: type: string enum: - non_fungible asset_value: type: object required: - hex - repr properties: hex: type: string repr: type: string asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - staking - type: object required: - principal - condition_code - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - not_performed - type: string enum: - maybe_performed - type: string enum: - performed type: type: string enum: - pox replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" type: type: string enum: - smart_contract smart_contract: type: object required: - contract_id - clarity_version properties: contract_id: description: Contract ID of the smart contract type: string clarity_version: anyOf: - description: Clarity version of the smart contract type: number - type: "null" source_code: description: Source code of the smart contract. Only present when requested via the `include=source_code` query param. type: string - type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - replaced_by_tx_id - type - contract_call properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic post_condition_mode: description: Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: description: Only present when requested via the `include=post_conditions` query param. type: array items: anyOf: - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - stx - type: object required: - principal - condition_code - amount - type - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - fungible asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - type - asset_value - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent - type: string enum: - maybe_sent type: type: string enum: - non_fungible asset_value: type: object required: - hex - repr properties: hex: type: string repr: type: string asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - staking - type: object required: - principal - condition_code - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - not_performed - type: string enum: - maybe_performed - type: string enum: - performed type: type: string enum: - pox replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name properties: contract_id: description: Contract ID of the contract call type: string function_name: description: Function name of the contract call type: string function_args: description: List of arguments used to invoke the function. Only present when requested via the `include=function_args` query param. type: array items: type: object required: - hex - repr properties: hex: type: string repr: type: string - type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - replaced_by_tx_id - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic post_condition_mode: description: Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: description: Only present when requested via the `include=post_conditions` query param. type: array items: anyOf: - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - stx - type: object required: - principal - condition_code - amount - type - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - fungible asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - type - asset_value - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent - type: string enum: - maybe_sent type: type: string enum: - non_fungible asset_value: type: object required: - hex - repr properties: hex: type: string repr: type: string asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - staking - type: object required: - principal - condition_code - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - not_performed - type: string enum: - maybe_performed - type: string enum: - performed type: type: string enum: - pox replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" type: type: string enum: - poison_microblock - type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - replaced_by_tx_id - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic post_condition_mode: description: Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: description: Only present when requested via the `include=post_conditions` query param. type: array items: anyOf: - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - stx - type: object required: - principal - condition_code - amount - type - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - fungible asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - type - asset_value - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent - type: string enum: - maybe_sent type: type: string enum: - non_fungible asset_value: type: object required: - hex - repr properties: hex: type: string repr: type: string asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - staking - type: object required: - principal - condition_code - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - not_performed - type: string enum: - maybe_performed - type: string enum: - performed type: type: string enum: - pox replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" type: type: string enum: - tenure_change - type: object required: - tx_id - sender - sponsor - fee_rate - receipt_time - receipt_time_iso - receipt_block_height - status - replaced_by_tx_id - type properties: tx_id: description: Transaction ID type: string sender: type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer sponsor: anyOf: - type: object required: - address - nonce properties: address: description: Address of the transaction initiator type: string nonce: description: Nonce of the transaction initiator type: integer - type: "null" fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: The `receipt_time` as an ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) UTC timestamp. examples: - 2026-10-08T19:18:41.000Z type: string receipt_block_height: description: Height of the block this transaction was received by the node type: integer status: description: Status of the mempool transaction anyOf: - type: string enum: - pending - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_stale_garbage_collect - type: string enum: - dropped_problematic post_condition_mode: description: Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: description: Only present when requested via the `include=post_conditions` query param. type: array items: anyOf: - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - stx - type: object required: - principal - condition_code - amount - type - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - fungible asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - type - asset_value - asset properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent - type: string enum: - maybe_sent type: type: string enum: - non_fungible asset_value: type: object required: - hex - repr properties: hex: type: string repr: type: string asset: type: object required: - asset_name - contract_address - contract_name properties: asset_name: type: string contract_address: type: string contract_name: type: string - type: object required: - principal - condition_code - amount - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string type: type: string enum: - staking - type: object required: - principal - condition_code - type properties: principal: anyOf: - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - address - contract_name properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string condition_code: anyOf: - type: string enum: - not_performed - type: string enum: - maybe_performed - type: string enum: - performed type: type: string enum: - pox replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" type: type: string enum: - coinbase 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /extended/v3/transactions/{tx_id}/events: get: operationId: get_transaction_events summary: Get transaction events tags: - Transactions description: Retrieves events for a given transaction ID parameters: - schema: minimum: 1 default: 20 maximum: 100 type: integer in: query name: limit required: false description: Number of results per page - schema: pattern: ^[0-9]+$ type: string in: query name: cursor required: false description: "Cursor for paginating transaction events. Format: event_index" - schema: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID type: string example: "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6" in: path name: tx_id required: true description: Transaction ID responses: "200": description: Default Response content: application/json: schema: type: object required: - total - limit - cursor - results properties: total: type: integer example: 1 limit: minimum: 1 default: 20 maximum: 100 description: Number of results per page type: integer cursor: type: object required: - next - previous - current properties: next: anyOf: - pattern: ^[0-9]+$ description: "Cursor for paginating transaction events. Format: event_index" type: string - type: "null" previous: anyOf: - pattern: ^[0-9]+$ description: "Cursor for paginating transaction events. Format: event_index" type: string - type: "null" current: anyOf: - pattern: ^[0-9]+$ description: "Cursor for paginating transaction events. Format: event_index" type: string - type: "null" results: type: array items: anyOf: - type: object required: - event_index - type - contract_log properties: event_index: type: integer type: type: string enum: - contract_log contract_log: type: object required: - contract_id - topic - value properties: contract_id: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string topic: type: string enum: - print value: type: object required: - hex - repr properties: hex: type: string repr: type: string - type: object required: - event_index - type - stx_lock properties: event_index: type: integer type: type: string enum: - stx_lock stx_lock: type: object required: - amount - unlock_bitcoin_height - address properties: amount: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string unlock_bitcoin_height: title: Block height description: Block height examples: - 777678 type: integer address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string - type: object required: - event_index - type - stx_asset properties: event_index: type: integer type: type: string enum: - stx_asset stx_asset: anyOf: - type: object required: - type - sender - recipient - amount - memo properties: type: type: string enum: - transfer sender: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string recipient: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string amount: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string memo: anyOf: - type: object required: - hex - repr properties: hex: type: string repr: type: string - type: "null" - type: object required: - type - recipient - amount properties: type: type: string enum: - mint recipient: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string amount: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string - type: object required: - type - sender - amount properties: type: type: string enum: - burn sender: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string amount: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string - type: object required: - event_index - type - ft_asset properties: event_index: type: integer type: type: string enum: - ft_asset ft_asset: anyOf: - type: object required: - type - asset_identifier - sender - recipient - amount properties: type: type: string enum: - transfer asset_identifier: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$ title: Asset Identifier description: Asset Identifier examples: - SP000000000000000000002Q6VF78.pox-3::stx-token type: string sender: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string recipient: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string amount: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string - type: object required: - type - recipient - asset_identifier - amount properties: type: type: string enum: - mint recipient: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string asset_identifier: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$ title: Asset Identifier description: Asset Identifier examples: - SP000000000000000000002Q6VF78.pox-3::stx-token type: string amount: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string - type: object required: - type - sender - asset_identifier - amount properties: type: type: string enum: - burn sender: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string asset_identifier: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$ title: Asset Identifier description: Asset Identifier examples: - SP000000000000000000002Q6VF78.pox-3::stx-token type: string amount: pattern: ^[0-9]+$ title: Amount description: Amount examples: - "1000000" type: string - type: object required: - event_index - type - nft_asset properties: event_index: type: integer type: type: string enum: - nft_asset nft_asset: anyOf: - type: object required: - type - asset_identifier - sender - recipient - value properties: type: type: string enum: - transfer asset_identifier: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$ title: Asset Identifier description: Asset Identifier examples: - SP000000000000000000002Q6VF78.pox-3::stx-token type: string sender: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string recipient: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string - type: object required: - type - recipient - asset_identifier - value properties: type: type: string enum: - mint recipient: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string asset_identifier: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$ title: Asset Identifier description: Asset Identifier examples: - SP000000000000000000002Q6VF78.pox-3::stx-token type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string - type: object required: - type - sender - asset_identifier - value properties: type: type: string enum: - burn sender: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ title: Stacks Address description: Stacks Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string asset_identifier: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$ title: Asset Identifier description: Asset Identifier examples: - SP000000000000000000002Q6VF78.pox-3::stx-token type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string servers: - url: https://api.hiro.so/ description: mainnet tags: - name: Accounts description: Read-only endpoints to obtain Stacks account details externalDocs: description: Stacks Documentation - Accounts url: https://docs.stacks.co/network-fundamentals/accounts - name: Blocks description: Read-only endpoints to obtain Stacks block details - name: Burn Blocks description: Read-only endpoints to obtain burn block details - name: Faucets description: Endpoints to request STX or BTC tokens (not possible on Mainnet) - name: Fees description: Read-only endpoints to obtain fee details - name: Info description: Read-only endpoints to obtain network, Proof-of-Transfer, Stacking, STX token, and node information - name: Names description: Read-only endpoints realted to the Blockchain Naming System on Stacks externalDocs: description: Stacks Documentation - Blockchain Naming System url: https://docs.stacks.co/network-fundamentals/bitcoin-name-system - name: Search description: Read-only endpoints to search for accounts, blocks, smart contracts, and transactions - name: Smart Contracts description: Read-only endpoints to obtain Clarity smart contract details externalDocs: description: Stacks Documentation - Clarity Smart Contracts url: https://docs.stacks.co/clarity/overview - name: Stacking Rewards description: Read-only endpoints to obtain Stacking reward details externalDocs: description: Stacks Documentation - Stacking url: https://docs.stacks.co/block-production/stacking - name: Tokens description: Read-only endpoints to obtain STX, fungible token, and non-fungible token details externalDocs: description: Stacks Documentation - Tokens url: https://docs.stacks.co/build/create-tokens - name: Transactions description: Endpoints to obtain transaction details and to broadcast transactions to the network externalDocs: description: Hiro Documentation - Transactions url: https://docs.hiro.so/get-started/transactions - name: Mempool description: Endpoints to obtain Mempool information - name: Proof of Transfer description: Endpoints to get information about the Proof of Transfer consensus mechanism - name: Staking description: "Read-only endpoints to obtain PoX-5 Bitcoin Staking details: bonds, allowlists, registrations, cycles, signers and rewards" externalDocs: url: https://github.com/hirosystems/stacks-blockchain-api description: Source Repository