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.0.1 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 microblock_hash: description: the current microblock hash type: string microblock_sequence: description: the current microblock sequence number type: integer 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/v1/tx/multiple: get: operationId: get_tx_list_details summary: Get list of details for transactions tags: - Transactions description: Retrieves a list of transactions for a given list of transaction IDs parameters: - schema: 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 - schema: minimum: 0 default: 20 maximum: 100 title: Limit type: integer in: query name: event_limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: event_offset required: false description: Result offset - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: default: false type: boolean examples: "true": value: true "false": value: false in: query name: exclude_function_args required: false description: Exclude function_args from contract call responses for smaller transaction sizes. responses: "200": description: Default Response content: application/json: schema: type: object additionalProperties: anyOf: - title: TransactionFound description: This object returns transaction for found true type: object required: - found - result properties: found: type: boolean enum: - true result: anyOf: - anyOf: - title: TokenTransferTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - token_transfer properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - token_transfer token_transfer: type: object required: - recipient_address - amount - memo properties: recipient_address: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: description: Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) type: string - title: SmartContractTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - smart_contract properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id - source_code properties: clarity_version: anyOf: - description: The Clarity version of the contract, only specified for versioned contract transactions, otherwise null type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string source_code: description: Clarity code of the smart contract being deployed type: string - title: ContractCallTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - contract_call properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name - function_signature properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string function_signature: description: Function definition, including function name and type as well as parameter names and types type: string function_args: type: array items: additionalProperties: false description: List of arguments used to invoke the function type: object required: - hex - repr - name - type properties: hex: type: string repr: type: string name: type: string type: type: string - title: PoisonMicroblockTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - poison_microblock properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - poison_microblock poison_microblock: type: object required: - microblock_header_1 - microblock_header_2 properties: microblock_header_1: description: Hex encoded microblock header type: string microblock_header_2: description: Hex encoded microblock header type: string - title: CoinbaseTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - coinbase_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - coinbase coinbase_payload: type: object required: - data properties: data: type: string description: Hex encoded 32-byte scratch space for block leader's use 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" vrf_proof: anyOf: - description: Hex encoded 80-byte VRF proof type: string - type: "null" - title: TenureChangeTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - tenure_change_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - tenure_change tenure_change_payload: 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 - anyOf: - title: TokenTransferMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - token_transfer properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - token_transfer token_transfer: type: object required: - recipient_address - amount - memo properties: recipient_address: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: description: Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) type: string - title: SmartContractMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - smart_contract properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id - source_code properties: clarity_version: anyOf: - description: The Clarity version of the contract, only specified for versioned contract transactions, otherwise null type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string source_code: description: Clarity code of the smart contract being deployed type: string - title: ContractCallMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - contract_call properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name - function_signature properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string function_signature: description: Function definition, including function name and type as well as parameter names and types type: string function_args: type: array items: additionalProperties: false description: List of arguments used to invoke the function type: object required: - hex - repr - name - type properties: hex: type: string repr: type: string name: type: string type: type: string - title: PoisonMicroblockMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - poison_microblock properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - poison_microblock poison_microblock: type: object required: - microblock_header_1 - microblock_header_2 properties: microblock_header_1: description: Hex encoded microblock header type: string microblock_header_2: description: Hex encoded microblock header type: string - title: CoinbaseMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - coinbase_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - coinbase coinbase_payload: type: object required: - data properties: data: type: string description: Hex encoded 32-byte scratch space for block leader's use 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" vrf_proof: anyOf: - description: Hex encoded 80-byte VRF proof type: string - type: "null" - title: TenureChangeMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - tenure_change_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - tenure_change tenure_change_payload: 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 - title: TransactionNotFound description: This object returns the id for not found transaction type: object required: - found - result properties: found: type: boolean enum: - false result: type: object required: - tx_id properties: tx_id: 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/v1/tx/mempool/stats: get: operationId: get_mempool_transaction_stats summary: Get statistics for mempool transactions tags: - Transactions description: >- Queries for transactions counts, age (by block height), fees (simple average), and size. All results broken down by transaction type and percentiles (p25, p50, p75, p95). responses: "200": description: GET request that returns stats on mempool transactions content: application/json: schema: title: MempoolTransactionStatsResponse description: GET request that returns stats on mempool transactions type: object required: - tx_type_counts - tx_simple_fee_averages - tx_ages - tx_byte_sizes properties: tx_type_counts: additionalProperties: type: integer description: Number of tranasction in the mempool, broken down by transaction type. type: object tx_simple_fee_averages: description: The simple mean (average) transaction fee, broken down by transaction type. Note that this does not factor in actual execution costs. The average fee is not a reliable metric for calculating a fee for a new transaction. type: object additionalProperties: additionalProperties: true type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - type: number - type: "null" p50: anyOf: - type: number - type: "null" p75: anyOf: - type: number - type: "null" p95: anyOf: - type: number - type: "null" tx_ages: description: The average time (in blocks) that transactions have lived in the mempool. The start block height is simply the current chain-tip of when the attached Stacks node receives the transaction. This timing can be different across Stacks nodes / API instances due to propagation timing differences in the p2p network. type: object additionalProperties: additionalProperties: true type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - type: number - type: "null" p50: anyOf: - type: number - type: "null" p75: anyOf: - type: number - type: "null" p95: anyOf: - type: number - type: "null" tx_byte_sizes: description: The average byte size of transactions in the mempool, broken down by transaction type. type: object additionalProperties: additionalProperties: true type: object required: - p25 - p50 - p75 - p95 properties: p25: anyOf: - type: number - type: "null" p50: anyOf: - type: number - type: "null" p75: anyOf: - type: number - type: "null" p95: anyOf: - type: number - 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/v1/stx_supply/: get: operationId: get_stx_supply summary: Get total and unlocked STX supply tags: - Info description: Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/block-production/stacking). parameters: - schema: minimum: 0 title: Block height type: integer example: 777678 in: query name: height required: false description: Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value. Note that the `block height` is referred to the stacks blockchain. - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks responses: "200": description: GET request that returns network target block times content: application/json: schema: title: GetStxSupplyResponse description: GET request that returns network target block times type: object required: - unlocked_percent - total_stx - total_stx_year_2050 - unlocked_stx - block_height properties: unlocked_percent: description: String quoted decimal number of the percentage of STX that have unlocked type: string total_stx: description: String quoted decimal number of the total circulating number of STX (at the input block height if provided, otherwise the current block height) type: string total_stx_year_2050: description: String quoted decimal number of total circulating STX supply in year 2050. STX supply grows approx 0.3% annually thereafter in perpetuity. type: string unlocked_stx: description: String quoted decimal number of the STX that have been mined or unlocked type: string block_height: description: The block height at which this information was queried 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/v1/info/network_block_times: get: operationId: get_network_block_times summary: Get the network target block time tags: - Info description: Retrieves the target block times for mainnet and testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet. responses: "200": description: GET request that returns network target block times content: application/json: schema: title: NetworkBlockTimesResponse description: GET request that returns network target block times type: object required: - mainnet - testnet properties: mainnet: type: object required: - target_block_time properties: target_block_time: type: integer testnet: type: object required: - target_block_time properties: target_block_time: 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/v1/info/network_block_time/{network}: get: operationId: get_network_block_time_by_network summary: Get a given network's target block time tags: - Info description: Retrieves the target block time for a given network. The network can be mainnet or testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet. parameters: - schema: anyOf: - type: string enum: - testnet - type: string enum: - mainnet in: path name: network required: true responses: "200": description: GET request that target block time for a given network content: application/json: schema: title: NetworkBlockTimeResponse description: GET request that target block time for a given network type: object required: - target_block_time properties: target_block_time: 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/v1/tokens/nft/history: get: operationId: get_nft_history summary: Non-Fungible Token history tags: - Non-Fungible Tokens description: >- Retrieves all events relevant to a Non-Fungible Token. Useful to determine the ownership history of a particular asset. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft). parameters: - schema: type: string example: SP2X0TZ59D5SZ8ACQ6YMCHHNR2ZN51Z32E2CJ173.the-explorer-guild::The-Explorer-Guild in: query name: asset_identifier required: true description: asset class identifier - schema: type: string example: "0x0100000000000000000000000000000803" in: query name: value required: true description: hex representation of the token's unique value - schema: minimum: 0 default: 50 maximum: 200 title: Limit type: integer in: query name: limit required: false description: max number of events to fetch - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: index of first event to fetch - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: default: false type: boolean in: query name: tx_metadata required: true description: whether or not to include the complete transaction metadata instead of just `tx_id`. Enabling this option can affect performance and response times. responses: "200": description: List of Non-Fungible Token history events content: application/json: schema: description: List of Non-Fungible Token history events 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: title: NonFungibleTokenHistoryEvent description: Describes an event from the history of a Non-Fungible Token anyOf: - title: NonFungibleTokenHistoryEventWithTxId description: Non-Fungible Token history event with transaction id type: object required: - event_index - asset_event_type - tx_id properties: sender: anyOf: - type: string - type: "null" recipient: type: string event_index: type: integer asset_event_type: type: string tx_id: type: string - title: NonFungibleTokenHistoryEventWithTxMetadata description: Non-Fungible Token history event with transaction metadata type: object required: - event_index - asset_event_type - tx properties: sender: anyOf: - type: string - type: "null" recipient: type: string event_index: type: integer asset_event_type: type: string tx: anyOf: - title: TokenTransferTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - token_transfer properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - token_transfer token_transfer: type: object required: - recipient_address - amount - memo properties: recipient_address: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: description: Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) type: string - title: SmartContractTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - smart_contract properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id - source_code properties: clarity_version: anyOf: - description: The Clarity version of the contract, only specified for versioned contract transactions, otherwise null type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string source_code: description: Clarity code of the smart contract being deployed type: string - title: ContractCallTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - contract_call properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name - function_signature properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string function_signature: description: Function definition, including function name and type as well as parameter names and types type: string function_args: type: array items: additionalProperties: false description: List of arguments used to invoke the function type: object required: - hex - repr - name - type properties: hex: type: string repr: type: string name: type: string type: type: string - title: PoisonMicroblockTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - poison_microblock properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - poison_microblock poison_microblock: type: object required: - microblock_header_1 - microblock_header_2 properties: microblock_header_1: description: Hex encoded microblock header type: string microblock_header_2: description: Hex encoded microblock header type: string - title: CoinbaseTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - coinbase_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - coinbase coinbase_payload: type: object required: - data properties: data: type: string description: Hex encoded 32-byte scratch space for block leader's use 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" vrf_proof: anyOf: - description: Hex encoded 80-byte VRF proof type: string - type: "null" - title: TenureChangeTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - tenure_change_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - tenure_change tenure_change_payload: 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 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/v1/tokens/nft/mints: get: operationId: get_nft_mints summary: Non-Fungible Token mints tags: - Non-Fungible Tokens description: >- Retrieves all mint events for a Non-Fungible Token asset class. Useful to determine which NFTs of a particular collection have been claimed. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft). parameters: - schema: type: string example: SP2X0TZ59D5SZ8ACQ6YMCHHNR2ZN51Z32E2CJ173.the-explorer-guild::The-Explorer-Guild in: query name: asset_identifier required: true description: asset class identifier - schema: minimum: 0 default: 50 maximum: 200 title: Limit type: integer in: query name: limit required: false description: max number of events to fetch - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: index of first event to fetch - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: default: false type: boolean in: query name: tx_metadata required: true description: whether or not to include the complete transaction metadata instead of just `tx_id`. Enabling this option can affect performance and response times. responses: "200": description: List of Non-Fungible Token mint events for an asset identifier content: application/json: schema: title: NonFungibleTokenMintList description: List of Non-Fungible Token mint events for an asset identifier 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: title: NonFungibleTokenMint description: Describes the minting of a Non-Fungible Token anyOf: - title: NonFungibleTokenMintWithTxId description: Non-Fungible Token mint event with transaction id type: object required: - event_index - value - tx_id properties: recipient: type: string event_index: type: integer value: description: Non-Fungible Token value type: object required: - hex - repr properties: hex: description: Hex string representing the identifier of the Non-Fungible Token type: string repr: description: Readable string of the Non-Fungible Token identifier type: string tx_id: type: string - type: object required: - event_index - value - tx properties: recipient: type: string event_index: type: integer value: description: Non-Fungible Token value type: object required: - hex - repr properties: hex: description: Hex string representing the identifier of the Non-Fungible Token type: string repr: description: Readable string of the Non-Fungible Token identifier type: string tx: anyOf: - title: TokenTransferTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - token_transfer properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - token_transfer token_transfer: type: object required: - recipient_address - amount - memo properties: recipient_address: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: description: Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) type: string - title: SmartContractTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - smart_contract properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id - source_code properties: clarity_version: anyOf: - description: The Clarity version of the contract, only specified for versioned contract transactions, otherwise null type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string source_code: description: Clarity code of the smart contract being deployed type: string - title: ContractCallTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - contract_call properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name - function_signature properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string function_signature: description: Function definition, including function name and type as well as parameter names and types type: string function_args: type: array items: additionalProperties: false description: List of arguments used to invoke the function type: object required: - hex - repr - name - type properties: hex: type: string repr: type: string name: type: string type: type: string - title: PoisonMicroblockTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - poison_microblock properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - poison_microblock poison_microblock: type: object required: - microblock_header_1 - microblock_header_2 properties: microblock_header_1: description: Hex encoded microblock header type: string microblock_header_2: description: Hex encoded microblock header type: string - title: CoinbaseTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - coinbase_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - coinbase coinbase_payload: type: object required: - data properties: data: type: string description: Hex encoded 32-byte scratch space for block leader's use 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" vrf_proof: anyOf: - description: Hex encoded 80-byte VRF proof type: string - type: "null" - title: TenureChangeTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - tenure_change_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - tenure_change tenure_change_payload: 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 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/v1/tokens/ft/{token}/holders: get: operationId: get_ft_holders summary: Fungible token holders tags: - Fungible Tokens description: Retrieves the list of Fungible Token holders for a given token ID. Specify `stx` for the `token` parameter to get the list of STX holders. parameters: - schema: minimum: 0 default: 100 maximum: 200 title: Limit type: integer in: query name: limit required: false description: max number of holders to fetch - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: index of first holder to fetch - schema: type: string examples: stx: value: stx SP3Y2ZSH8P7D50B0VBTSX11S7XSG24M1VB9YFQA4K.token-aeusdc::aeUSDC: value: SP3Y2ZSH8P7D50B0VBTSX11S7XSG24M1VB9YFQA4K.token-aeusdc::aeUSDC in: path name: token required: true description: fungible token identifier responses: "200": description: Default Response content: application/json: schema: type: object required: - total_supply - limit - offset - total - results properties: total_supply: description: The total supply of the token (the sum of all balances) type: string example: "5817609278457" limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: title: FtHolderEntry type: object required: - address - balance properties: address: description: Principal of the token holder type: string example: SP3G2QZHYDZPJ2FBN2V2MB74T5ZQ6FQK2P5QJ2K6 balance: description: The balance of the token held by the address 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/v1/contract/by_trait: get: operationId: get_contracts_by_trait summary: Get contracts by trait tags: - Smart Contracts description: Retrieves a list of contracts based on the following traits listed in JSON format - functions, variables, maps, fungible tokens and non-fungible tokens parameters: - schema: type: string in: query name: trait_abi required: true description: JSON abi of the trait. - schema: minimum: 0 default: 20 maximum: 50 title: Limit type: integer in: query name: limit required: false description: max number of contracts fetch - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: index of first contract event to fetch responses: "200": description: GET list of contracts content: application/json: schema: title: ContractListResponse description: GET list of contracts type: object required: - limit - offset - results properties: limit: type: integer example: 20 offset: type: integer example: 0 results: type: array items: title: SmartContract description: A Smart Contract Detail type: object required: - tx_id - canonical - contract_id - block_height - clarity_version - source_code - abi properties: tx_id: type: string canonical: type: boolean contract_id: type: string block_height: type: integer clarity_version: anyOf: - type: integer - type: "null" source_code: type: string abi: 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/v1/contract/{contract_id}: get: operationId: get_contract_by_id summary: Get contract info tags: - Smart Contracts description: Retrieves details of a contract with a given `contract_id` parameters: - schema: type: string example: SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C.satoshibles in: path name: contract_id required: true description: Contract identifier formatted as `.` responses: "200": description: A Smart Contract Detail content: application/json: schema: title: SmartContract description: A Smart Contract Detail type: object required: - tx_id - canonical - contract_id - block_height - clarity_version - source_code - abi properties: tx_id: type: string canonical: type: boolean contract_id: type: string block_height: type: integer clarity_version: anyOf: - type: integer - type: "null" source_code: type: string abi: 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/v1/burnchain/reward_slot_holders: get: operationId: get_burnchain_reward_slot_holders summary: Get recent reward slot holders tags: - Stacking Rewards description: Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments. parameters: - schema: minimum: 0 default: 96 maximum: 250 title: Limit type: integer in: query name: limit required: false description: max number of items to fetch - 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: title: List of burnchain reward recipients and amounts 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: title: BurnchainRewardSlotHolder description: Reward slot holder on the burnchain type: object required: - canonical - burn_block_hash - burn_block_height - address - slot_index properties: canonical: description: Set to `true` if block corresponds to the canonical burchchain tip type: boolean burn_block_hash: description: The hash representing the burnchain block type: string burn_block_height: description: Height of the burnchain block type: integer address: description: The recipient address that validly received PoX commitments, in the format native to the burnchain (e.g. B58 encoded for Bitcoin) type: string slot_index: description: The index position of the reward entry, useful for ordering when there's more than one slot per burnchain 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/v1/burnchain/reward_slot_holders/{address}: get: operationId: get_burnchain_reward_slot_holders_by_address summary: Get recent reward slot holder entries for the given address tags: - Stacking Rewards description: Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address. parameters: - schema: minimum: 0 default: 96 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: string example: 36hQtSEXBMevo5chpxhfAGiCTSC34QKgda in: path name: address required: true description: Reward slot holder recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format responses: "200": description: List of burnchain reward recipients and amounts content: application/json: schema: title: BurnchainRewardSlotHolderListResponse description: List of burnchain reward recipients and amounts 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: title: BurnchainRewardSlotHolder description: Reward slot holder on the burnchain type: object required: - canonical - burn_block_hash - burn_block_height - address - slot_index properties: canonical: description: Set to `true` if block corresponds to the canonical burchchain tip type: boolean burn_block_hash: description: The hash representing the burnchain block type: string burn_block_height: description: Height of the burnchain block type: integer address: description: The recipient address that validly received PoX commitments, in the format native to the burnchain (e.g. B58 encoded for Bitcoin) type: string slot_index: description: The index position of the reward entry, useful for ordering when there's more than one slot per burnchain 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/v1/burnchain/rewards: get: operationId: get_burnchain_reward_list summary: Get recent burnchain reward recipients tags: - Stacking Rewards description: Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info parameters: - schema: minimum: 0 default: 96 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 responses: "200": description: List of burnchain reward recipients and amounts content: application/json: schema: description: List of burnchain reward recipients and amounts type: object required: - limit - offset - results properties: limit: type: integer offset: type: integer results: type: array items: title: BurnchainReward description: Reward payment made on the burnchain type: object required: - canonical - burn_block_hash - burn_block_height - burn_amount - reward_recipient - reward_amount - reward_index properties: canonical: description: Set to `true` if block corresponds to the canonical burchchain tip type: boolean burn_block_hash: description: The hash representing the burnchain block type: string burn_block_height: description: Height of the burnchain block type: integer burn_amount: description: The total amount of burnchain tokens burned for this burnchain block, in the smallest unit (e.g. satoshis for Bitcoin) type: string reward_recipient: description: The recipient address that received the burnchain rewards, in the format native to the burnchain (e.g. B58 encoded for Bitcoin) type: string reward_amount: description: The amount of burnchain tokens rewarded to the recipient, in the smallest unit (e.g. satoshis for Bitcoin) type: string reward_index: description: The index position of the reward entry, useful for ordering when there's more than one recipient per burnchain 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/v1/burnchain/rewards/{address}: get: operationId: get_burnchain_reward_list_by_address summary: Get recent burnchain reward for the given recipient tags: - Stacking Rewards description: Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info parameters: - schema: minimum: 0 default: 96 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: string example: 36hQtSEXBMevo5chpxhfAGiCTSC34QKgda in: path name: address required: true description: Reward recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format responses: "200": description: List of burnchain reward recipients and amounts content: application/json: schema: description: List of burnchain reward recipients and amounts type: object required: - limit - offset - results properties: limit: type: integer offset: type: integer results: type: array items: title: BurnchainReward description: Reward payment made on the burnchain type: object required: - canonical - burn_block_hash - burn_block_height - burn_amount - reward_recipient - reward_amount - reward_index properties: canonical: description: Set to `true` if block corresponds to the canonical burchchain tip type: boolean burn_block_hash: description: The hash representing the burnchain block type: string burn_block_height: description: Height of the burnchain block type: integer burn_amount: description: The total amount of burnchain tokens burned for this burnchain block, in the smallest unit (e.g. satoshis for Bitcoin) type: string reward_recipient: description: The recipient address that received the burnchain rewards, in the format native to the burnchain (e.g. B58 encoded for Bitcoin) type: string reward_amount: description: The amount of burnchain tokens rewarded to the recipient, in the smallest unit (e.g. satoshis for Bitcoin) type: string reward_index: description: The index position of the reward entry, useful for ordering when there's more than one recipient per burnchain 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/v1/burnchain/rewards/{address}/total: get: operationId: get_burnchain_rewards_total_by_address summary: Get total burnchain rewards for the given recipient tags: - Stacking Rewards description: Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient `address` parameters: - schema: type: string example: 36hQtSEXBMevo5chpxhfAGiCTSC34QKgda in: path name: address required: true description: Reward recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format responses: "200": description: Total burnchain rewards made to a recipient content: application/json: schema: title: BurnchainRewardsTotal description: Total burnchain rewards made to a recipient type: object required: - reward_recipient - reward_amount properties: reward_recipient: description: The recipient address that received the burnchain rewards, in the format native to the burnchain (e.g. B58 encoded for Bitcoin) type: string reward_amount: description: The total amount of burnchain tokens rewarded to the recipient, in the smallest unit (e.g. satoshis for Bitcoin) 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/v1/search/{id}: get: operationId: search_by_id summary: Search tags: - Search description: Search blocks, transactions, contracts, or accounts by hash/ID parameters: - schema: default: false type: boolean in: query name: include_metadata required: false description: This includes the detailed data for purticular hash in the response - schema: type: string example: "0xcf8b233f19f6c07d2dc1963302d2436efd36e9afac127bf6582824a13961c06d" in: path name: id required: true description: The hex hash string for a block or transaction, account address, or contract address responses: "200": description: Default Response content: application/json: schema: type: object required: - found - result properties: found: type: boolean enum: - true result: anyOf: - title: AddressSearchResult description: Address search result type: object required: - entity_id - entity_type properties: entity_id: description: The id used to search this query. type: string entity_type: type: string enum: - standard_address metadata: title: AddressStxBalance description: GET request that returns address balances type: object allOf: - title: StxBalance type: object required: - balance - total_miner_rewards_received - lock_tx_id - locked - lock_height - burnchain_lock_height - burnchain_unlock_height properties: balance: type: string estimated_balance: description: Total STX balance considering pending mempool transactions type: string pending_balance_inbound: description: Inbound STX balance from pending mempool transactions type: string pending_balance_outbound: description: Outbound STX balance from pending mempool transactions type: string total_sent: type: string total_received: type: string total_fees_sent: type: string total_miner_rewards_received: type: string lock_tx_id: description: The transaction where the lock event occurred. Empty if no tokens are locked. type: string locked: description: The amount of locked STX, as string quoted micro-STX. Zero if no tokens are locked. type: string lock_height: description: The STX chain block height of when the lock event occurred. Zero if no tokens are locked. type: integer burnchain_lock_height: description: The burnchain block height of when the lock event occurred. Zero if no tokens are locked. type: integer burnchain_unlock_height: description: The burnchain block height of when the tokens unlock. Zero if no tokens are locked. type: integer - type: object properties: token_offering_locked: title: AddressTokenOfferingLocked description: Token Offering Locked type: object required: - total_locked - total_unlocked - unlock_schedule properties: total_locked: description: Micro-STX amount still locked at current block height. type: string total_unlocked: description: Micro-STX amount unlocked at current block height. type: string unlock_schedule: type: array items: title: AddressUnlockSchedule description: Unlock schedule amount and block height type: object required: - amount - block_height properties: amount: description: Micro-STX amount locked at this block height. type: string block_height: type: integer - title: BlockSearchResult description: Block search result type: object required: - entity_id - entity_type - block_data properties: entity_id: description: The id used to search this query. type: string entity_type: type: string enum: - block_hash block_data: type: object required: - canonical - hash - parent_block_hash - burn_block_time - height properties: canonical: type: boolean hash: type: string parent_block_hash: type: string burn_block_time: type: integer height: type: integer metadata: title: Block description: A block type: object required: - canonical - height - hash - block_time - block_time_iso - tenure_height - index_block_hash - parent_block_hash - burn_block_time - burn_block_time_iso - burn_block_hash - burn_block_height - miner_txid - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - txs - parent_microblock_hash - parent_microblock_sequence - microblocks_accepted - microblocks_streamed - microblock_tx_count 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: number 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 burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number 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 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 txs: description: List of transactions included in the block type: array items: description: Transaction ID type: string parent_microblock_hash: description: The hash of the last streamed block that precedes this block to which this block is to be appended. Not every anchored block will have a parent microblock stream. An anchored block that does not have a parent microblock stream has the parent microblock hash set to an empty string, and the parent microblock sequence number set to -1. type: string parent_microblock_sequence: description: The hash of the last streamed block that precedes this block to which this block is to be appended. Not every anchored block will have a parent microblock stream. An anchored block that does not have a parent microblock stream has the parent microblock hash set to an empty string, and the parent microblock sequence number set to -1. type: integer microblocks_accepted: description: List of microblocks that were accepted in this anchor block. Not every anchored block will have a accepted all (or any) of the previously streamed microblocks. Microblocks that were orphaned are not included in this list. type: array items: description: Microblock hash type: string microblocks_streamed: description: List of microblocks that were streamed/produced by this anchor block's miner. This list only includes microblocks that were accepted in the following anchor block. Microblocks that were orphaned are not included in this list. type: array items: description: Microblock hash type: string microblock_tx_count: description: List of txs counts in each accepted microblock type: object additionalProperties: type: integer - title: ContractSearchResult description: Contract search result type: object required: - entity_id - entity_type properties: entity_id: description: The id used to search this query. type: string entity_type: type: string enum: - contract_address tx_data: type: object required: - tx_type - tx_id properties: canonical: type: boolean block_hash: type: string burn_block_time: type: integer block_height: type: integer tx_type: type: string tx_id: type: string metadata: anyOf: - anyOf: - title: TokenTransferTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - token_transfer properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - token_transfer token_transfer: type: object required: - recipient_address - amount - memo properties: recipient_address: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: description: Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) type: string - title: SmartContractTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - smart_contract properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id - source_code properties: clarity_version: anyOf: - description: The Clarity version of the contract, only specified for versioned contract transactions, otherwise null type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string source_code: description: Clarity code of the smart contract being deployed type: string - title: ContractCallTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - contract_call properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name - function_signature properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string function_signature: description: Function definition, including function name and type as well as parameter names and types type: string function_args: type: array items: additionalProperties: false description: List of arguments used to invoke the function type: object required: - hex - repr - name - type properties: hex: type: string repr: type: string name: type: string type: type: string - title: PoisonMicroblockTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - poison_microblock properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - poison_microblock poison_microblock: type: object required: - microblock_header_1 - microblock_header_2 properties: microblock_header_1: description: Hex encoded microblock header type: string microblock_header_2: description: Hex encoded microblock header type: string - title: CoinbaseTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - coinbase_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - coinbase coinbase_payload: type: object required: - data properties: data: type: string description: Hex encoded 32-byte scratch space for block leader's use 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" vrf_proof: anyOf: - description: Hex encoded 80-byte VRF proof type: string - type: "null" - title: TenureChangeTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - tenure_change_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - tenure_change tenure_change_payload: 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 - anyOf: - title: TokenTransferMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - token_transfer properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - token_transfer token_transfer: type: object required: - recipient_address - amount - memo properties: recipient_address: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: description: Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) type: string - title: SmartContractMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - smart_contract properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id - source_code properties: clarity_version: anyOf: - description: The Clarity version of the contract, only specified for versioned contract transactions, otherwise null type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string source_code: description: Clarity code of the smart contract being deployed type: string - title: ContractCallMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - contract_call properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name - function_signature properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string function_signature: description: Function definition, including function name and type as well as parameter names and types type: string function_args: type: array items: additionalProperties: false description: List of arguments used to invoke the function type: object required: - hex - repr - name - type properties: hex: type: string repr: type: string name: type: string type: type: string - title: PoisonMicroblockMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - poison_microblock properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - poison_microblock poison_microblock: type: object required: - microblock_header_1 - microblock_header_2 properties: microblock_header_1: description: Hex encoded microblock header type: string microblock_header_2: description: Hex encoded microblock header type: string - title: CoinbaseMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - coinbase_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - coinbase coinbase_payload: type: object required: - data properties: data: type: string description: Hex encoded 32-byte scratch space for block leader's use 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" vrf_proof: anyOf: - description: Hex encoded 80-byte VRF proof type: string - type: "null" - title: TenureChangeMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - tenure_change_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - tenure_change tenure_change_payload: 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 - title: MempoolTxSearchResult description: Mempool transaction search result type: object required: - entity_id - entity_type - tx_data properties: entity_id: description: The id used to search this query. type: string entity_type: type: string enum: - mempool_tx_id tx_data: type: object required: - tx_type properties: tx_type: type: string metadata: anyOf: - title: TokenTransferMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - token_transfer properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - token_transfer token_transfer: type: object required: - recipient_address - amount - memo properties: recipient_address: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: description: Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) type: string - title: SmartContractMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - smart_contract properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id - source_code properties: clarity_version: anyOf: - description: The Clarity version of the contract, only specified for versioned contract transactions, otherwise null type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string source_code: description: Clarity code of the smart contract being deployed type: string - title: ContractCallMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - contract_call properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name - function_signature properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string function_signature: description: Function definition, including function name and type as well as parameter names and types type: string function_args: type: array items: additionalProperties: false description: List of arguments used to invoke the function type: object required: - hex - repr - name - type properties: hex: type: string repr: type: string name: type: string type: type: string - title: PoisonMicroblockMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - poison_microblock properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - poison_microblock poison_microblock: type: object required: - microblock_header_1 - microblock_header_2 properties: microblock_header_1: description: Hex encoded microblock header type: string microblock_header_2: description: Hex encoded microblock header type: string - title: CoinbaseMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - coinbase_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - coinbase coinbase_payload: type: object required: - data properties: data: type: string description: Hex encoded 32-byte scratch space for block leader's use 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" vrf_proof: anyOf: - description: Hex encoded 80-byte VRF proof type: string - type: "null" - title: TenureChangeMempoolTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - tx_status - replaced_by_tx_id - receipt_time - receipt_time_iso - tx_type - tenure_change_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any tx_status: description: Status of the 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 replaced_by_tx_id: anyOf: - description: ID of another transaction which replaced this one type: string - type: "null" receipt_time: description: A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. type: integer receipt_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. type: string tx_type: type: string enum: - tenure_change tenure_change_payload: 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 - title: TxSearchResult description: Transaction search result type: object required: - entity_id - entity_type - tx_data properties: entity_id: description: The id used to search this query. type: string entity_type: type: string enum: - tx_id tx_data: type: object required: - canonical - block_hash - burn_block_time - block_height - tx_type properties: canonical: type: boolean block_hash: type: string burn_block_time: type: integer block_height: type: integer tx_type: type: string metadata: anyOf: - title: TokenTransferTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - token_transfer properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - token_transfer token_transfer: type: object required: - recipient_address - amount - memo properties: recipient_address: type: string amount: description: Transfer amount as Integer string (64-bit unsigned integer) type: string memo: description: Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) type: string - title: SmartContractTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - smart_contract properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - smart_contract smart_contract: type: object required: - clarity_version - contract_id - source_code properties: clarity_version: anyOf: - description: The Clarity version of the contract, only specified for versioned contract transactions, otherwise null type: number - type: "null" contract_id: description: Contract identifier formatted as `.` type: string source_code: description: Clarity code of the smart contract being deployed type: string - title: ContractCallTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - contract_call properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - contract_call contract_call: type: object required: - contract_id - function_name - function_signature properties: contract_id: description: Contract identifier formatted as `.` type: string function_name: description: Name of the Clarity function to be invoked type: string function_signature: description: Function definition, including function name and type as well as parameter names and types type: string function_args: type: array items: additionalProperties: false description: List of arguments used to invoke the function type: object required: - hex - repr - name - type properties: hex: type: string repr: type: string name: type: string type: type: string - title: PoisonMicroblockTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - poison_microblock properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - poison_microblock poison_microblock: type: object required: - microblock_header_1 - microblock_header_2 properties: microblock_header_1: description: Hex encoded microblock header type: string microblock_header_2: description: Hex encoded microblock header type: string - title: CoinbaseTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - coinbase_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - coinbase coinbase_payload: type: object required: - data properties: data: type: string description: Hex encoded 32-byte scratch space for block leader's use 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" vrf_proof: anyOf: - description: Hex encoded 80-byte VRF proof type: string - type: "null" - title: TenureChangeTransaction type: object required: - tx_id - nonce - fee_rate - sender_address - sponsored - post_condition_mode - post_conditions - anchor_mode - block_hash - block_height - block_time - block_time_iso - burn_block_time - burn_block_height - burn_block_time_iso - parent_burn_block_time - parent_burn_block_time_iso - canonical - tx_index - tx_status - tx_result - event_count - parent_block_hash - is_unanchored - microblock_hash - microblock_sequence - microblock_canonical - execution_cost_read_count - execution_cost_read_length - execution_cost_runtime - execution_cost_write_count - execution_cost_write_length - vm_error - events - tx_type - tenure_change_payload properties: tx_id: description: Transaction ID type: string nonce: description: Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. type: integer fee_rate: description: Transaction fee as Integer string (64-bit unsigned integer). type: string sender_address: description: Address of the transaction initiator type: string sponsor_nonce: type: integer sponsored: description: Denotes whether the originating account is the same as the paying account type: boolean sponsor_address: type: string post_condition_mode: anyOf: - type: string enum: - allow - type: string enum: - deny - type: string enum: - originator post_conditions: 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 anchor_mode: description: "`on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction." anyOf: - type: string enum: - on_chain_only - type: string enum: - off_chain_only - type: string enum: - any block_hash: description: Hash of the blocked this transactions was associated with type: string block_height: description: Height of the block this transactions was associated with type: integer block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: number block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. type: string burn_block_time: description: Unix timestamp (in seconds) indicating when this block was mined. type: integer burn_block_height: description: Height of the anchor burn block. type: integer burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. type: string parent_burn_block_time: description: Unix timestamp (in seconds) indicating when this parent block was mined type: integer parent_burn_block_time_iso: description: An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. type: string canonical: description: Set to `true` if block corresponds to the canonical chain tip type: boolean tx_index: description: Index of the transaction, indicating the order. Starts at `0` and increases with each transaction type: integer tx_status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition tx_result: description: Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. additionalProperties: false type: object required: - hex - repr properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string event_count: description: Number of transaction events type: integer parent_block_hash: description: Hash of the previous block. type: string is_unanchored: description: True if the transaction is included in a microblock that has not been confirmed by an anchor block. type: boolean microblock_hash: description: The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. type: string microblock_sequence: description: The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). type: integer microblock_canonical: description: Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. type: boolean 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 vm_error: anyOf: - description: Clarity VM error produced by this transaction type: string - type: "null" events: type: array items: anyOf: - 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 - title: StxLockTransactionEvent 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 - stx_lock_event properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object required: - locked_amount - unlock_height - locked_address properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string - title: StxAssetTransactionEvent 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 - asset properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object required: - asset_event_type - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn sender: type: string recipient: type: string amount: type: string memo: type: string - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - amount properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string amount: type: string - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object required: - event_index properties: event_index: type: integer - type: object required: - event_type - tx_id - asset properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object required: - asset_event_type - asset_id - sender - recipient - value properties: asset_event_type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_id: type: string sender: type: string recipient: type: string value: type: object required: - hex - repr properties: hex: type: string repr: type: string tx_type: type: string enum: - tenure_change tenure_change_payload: 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 "404": description: Default Response content: application/json: schema: type: object required: - found - result - error properties: found: type: boolean enum: - false result: type: object required: - entity_type properties: entity_type: anyOf: - type: string enum: - tx_id - type: string enum: - mempool_tx_id - type: string enum: - block_hash - type: string enum: - standard_address - type: string enum: - contract_address - type: string enum: - unknown_hash - type: string enum: - invalid_term error: 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/v1/{pox}/events: get: summary: Get latest PoX events tags: - Stacking parameters: - schema: minimum: 0 default: 96 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: anyOf: - type: string enum: - pox2 - type: string enum: - pox3 - type: string enum: - pox4 in: path name: pox required: true responses: "200": description: Default Response /extended/v1/{pox}/tx/{tx_id}: get: summary: Get PoX events for a transaction tags: - Stacking parameters: - schema: anyOf: - type: string enum: - pox2 - type: string enum: - pox3 - type: string enum: - pox4 in: path name: pox required: true - schema: type: string in: path name: tx_id required: true responses: "200": description: Default Response /extended/v1/{pox}/stacker/{principal}: get: summary: Get events for a stacking address tags: - Stacking parameters: - schema: anyOf: - type: string enum: - pox2 - type: string enum: - pox3 - type: string enum: - pox4 in: path name: pox required: true - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41} title: STX Address description: STX 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 /extended/v1/{pox}/{pool_principal}/delegations: get: operationId: get_pool_delegations summary: Stacking pool members tags: - Stacking description: Retrieves the list of stacking pool members for a given delegator principal. 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: minimum: 1 type: integer in: query name: after_block required: false description: If specified, only delegation events after the given block will be included - schema: minimum: 1 type: integer in: query name: height required: false - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: anyOf: - type: string enum: - pox2 - type: string enum: - pox3 - type: string enum: - pox4 in: path name: pox required: true - schema: type: string example: SPSCWDV3RKV5ZRN1FQD84YE1NQFEDJ9R1F4DYQ11 in: path name: pool_principal required: true description: Address principal of the stacking pool delegator 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 - amount_ustx - block_height - tx_id properties: stacker: description: The principal of the pool member that issued the delegation type: string pox_addr: description: The pox-addr value specified by the stacker in the delegation operation type: string amount_ustx: description: The amount of uSTX delegated by the stacker type: string burn_block_unlock_height: description: The optional burnchain block unlock height that the stacker may have specified type: integer block_height: description: The block height at which the stacker delegation transaction was mined at type: integer tx_id: description: The tx_id of the stacker delegation operation 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/v1/faucets/btc: post: operationId: run_faucet_btc summary: Get BTC regtest tokens tags: - Faucets description: >- Add 0.01 BTC token to the specified regtest BTC address. The endpoint returns the transaction ID, which you can use to view the transaction in a regtest Bitcoin block explorer. The tokens are delivered once the transaction has been included in a block. **Note:** This is a Bitcoin regtest-only endpoint. This endpoint will not work on the Bitcoin mainnet. requestBody: required: true content: application/json: schema: anyOf: - type: object properties: address: description: A valid regtest BTC address examples: - 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts type: string - type: "null" parameters: - schema: type: string example: 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts in: query name: address required: false description: A valid regtest BTC address - schema: default: false type: boolean in: query name: large required: false description: Request a large amount of regtest BTC than the default - schema: default: false type: boolean in: query name: xlarge required: false description: Request an extra large amount of regtest BTC than the default responses: "200": description: POST request that initiates a transfer of tokens to a specified Bitcoin regtest address content: application/json: schema: title: RunFaucetResponse description: POST request that initiates a transfer of tokens to a specified Bitcoin regtest address type: object required: - success - txid - raw_tx properties: success: description: Indicates if the faucet call was successful type: boolean enum: - true txid: description: The transaction ID for the faucet call type: string raw_tx: description: Raw transaction in hex string representation type: string 4XX: description: Default Response content: application/json: schema: type: object required: - success - error properties: success: type: boolean enum: - false error: description: Error message type: string /extended/v1/faucets/stx: post: operationId: run_faucet_stx summary: Get STX testnet tokens tags: - Faucets description: >- Add 500 STX tokens to the specified testnet address. Testnet STX addresses begin with `ST`. If the `stacking` parameter is set to `true`, the faucet will add the required number of tokens for individual stacking to the specified testnet address. The endpoint returns 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 an anchor block. A common reason for failed faucet transactions is that the faucet has run out of tokens. If you are experiencing failed faucet transactions to a testnet address, you can get help in [Discord](https://stacks.chat). **Note:** This is a testnet only endpoint. This endpoint will not work on the mainnet. requestBody: required: true content: application/json: schema: anyOf: - type: object properties: address: description: "[Deprecated -- use query param rather than POST body] A valid testnet STX address" examples: - ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ type: string - type: "null" parameters: - schema: type: string example: ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ in: query name: address required: false description: A valid testnet STX address - schema: default: false type: boolean in: query name: stacking required: false description: Request the amount of STX tokens needed for individual address stacking responses: "200": description: POST request that initiates a transfer of tokens to a specified testnet address content: application/json: schema: title: RunFaucetResponse description: POST request that initiates a transfer of tokens to a specified testnet address type: object required: - success - txId - txRaw properties: success: description: Indicates if the faucet call was successful type: boolean enum: - true txId: description: The transaction ID for the faucet call type: string txRaw: description: Raw transaction in hex string representation type: string 4XX: description: Default Response content: application/json: schema: type: object required: - success - error properties: success: description: Indicates if the faucet call was successful type: boolean enum: - false error: description: Error message type: string help: type: string /extended/v1/faucets/sbtc: post: operationId: run_faucet_sbtc summary: Get sBTC testnet tokens tags: - Faucets description: >- Add sBTC tokens 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 endpoint returns 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. **Note:** This is a testnet only endpoint. This endpoint will not work on mainnet. parameters: - schema: type: string example: ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ in: query name: address required: false description: A valid testnet STX address responses: "200": description: POST request that initiates a transfer of tokens to a specified testnet address content: application/json: schema: title: RunFaucetResponse description: POST request that initiates a transfer of tokens to a specified testnet address type: object required: - success - txId - txRaw properties: success: description: Indicates if the faucet call was successful type: boolean enum: - true txId: description: The transaction ID for the faucet call type: string txRaw: description: Raw transaction in hex string representation type: string 4XX: description: Default Response content: application/json: schema: type: object required: - success - error properties: success: description: Indicates if the faucet call was successful type: boolean enum: - false error: description: Error 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 - 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 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 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 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: 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 - 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 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 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 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: 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 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 - 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 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 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 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: 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 - 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 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 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 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: 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 - 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 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 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 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: 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 - 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 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 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 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: 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/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_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_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_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_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 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_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_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_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_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_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_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_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_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 - 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 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 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 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: 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 - 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 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 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 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: 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 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 - 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 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 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 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: 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 - 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 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 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 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: 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 - 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 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 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 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: 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 - 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 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 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 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: 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}/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 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 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}/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-]+$ 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. 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: 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 (anchored + microblock) 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 (anchored + microblock) 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_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_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_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_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 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_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_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_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_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_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_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_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_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/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: type: object required: - activation - unlock properties: activation: type: object required: - bitcoin_height - pox_cycle properties: bitcoin_height: description: The height at which the bond was activated type: integer pox_cycle: description: The POX cycle at which the bond was activated type: integer unlock: type: object required: - bitcoin_height - pox_cycle properties: bitcoin_height: description: The height at which the bond can be unlocked type: integer pox_cycle: description: The POX cycle at which the bond can be unlocked type: integer balances: type: object required: - locked - 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 paid_out: type: object required: - btc properties: btc: description: The total amount of BTC that has been paid out for this bond 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 bond 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: 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: type: object required: - activation - unlock properties: activation: type: object required: - bitcoin_height - pox_cycle properties: bitcoin_height: description: The height at which the bond was activated type: integer pox_cycle: description: The POX cycle at which the bond was activated type: integer unlock: type: object required: - bitcoin_height - pox_cycle properties: bitcoin_height: description: The height at which the bond can be unlocked type: integer pox_cycle: description: The POX cycle at which the bond can be unlocked type: integer balances: type: object required: - locked - 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 paid_out: type: object required: - btc properties: btc: description: The total amount of BTC that has been paid out for this bond 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 - 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 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 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 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/signers: get: operationId: get_staking_signers summary: Get staking signers tags: - Staking description: Get the registered pox-5 staking signers and their current signing keys. 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 - 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 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 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 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/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 - 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 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 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 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: 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 - 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 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 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 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: 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 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 - 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 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 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 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: 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 - 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 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 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 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: 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 - 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 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 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 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: 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 - 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 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 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 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: 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 - 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 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 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 status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition 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_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 - 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 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 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 status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition 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_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 - 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 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 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 status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition 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_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 - 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 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 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 status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition 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_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 - 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 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 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 status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition 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_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 - 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 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 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 status: description: Status of the transaction anyOf: - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition 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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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-]+$ 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-]+$ 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-]+$ 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-]+$ 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-]+$ 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-]+$ 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 /v1/names/{name}/zonefile/{zoneFileHash}: get: operationId: get_historical_zone_file summary: Get Historical Zone File tags: - Names description: Retrieves the historical zonefile specified by the username and zone hash. parameters: - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: type: string example: muneeb.id in: path name: name required: true description: fully-qualified name - schema: type: string example: b100a68235244b012854a95f9114695679002af9 in: path name: zoneFileHash required: true description: zone file hash responses: "200": description: Fetches the historical zonefile specified by the username and zone hash. content: application/json: schema: title: BnsFetchHistoricalZoneFileResponse description: Fetches the historical zonefile specified by the username and zone hash. type: object required: - zonefile properties: zonefile: type: string 4XX: description: Error content: application/json: schema: title: BnsError description: Error type: object required: - error properties: error: type: string /v1/names/{name}/subdomains: get: operationId: fetch_subdomains_list_for_name summary: Get Name Subdomains tags: - Names description: Retrieves the list of subdomains for a specific name parameters: - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: type: string example: id.blockstack in: path name: name required: true description: fully-qualified name responses: "200": description: Fetch a list of subdomains in a name. content: application/json: schema: title: GetAllSubdomainsInName description: Fetch a list of subdomains in a name. type: array items: type: string example: - address_test.id.blockstack - previous_subdomain.id.blockstack - subdomain.id.blockstack - zonefile_test.id.blockstack - zone_test.id.blockstack 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /v1/names/{name}/zonefile: get: operationId: fetch_zone_file summary: Get Zone File tags: - Names description: Retrieves a user's raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files. parameters: - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: type: string example: bar.test in: path name: name required: true description: fully-qualified name responses: "200": description: Fetch a user's raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files. content: application/json: schema: title: BnsFetchFileZoneResponse description: Fetch a user's raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files. type: object required: - zonefile properties: zonefile: type: string example: > $ORIGIN bar.test $TTL 3600 _https._tcp URI 10 1 "https://gaia.blockstack.org/hub/17Zijx61Sp7SbVfRTdETo7PhizJHYEUxbY/profile.json" 4XX: description: Error content: application/json: schema: title: BnsError description: Error type: object required: - error properties: error: type: string example: Invalid name or subdomain /v1/names/: get: operationId: get_all_names summary: Get All Names tags: - Names description: Retrieves a list of all names known to the node. parameters: - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: minimum: 0 default: 0 type: integer in: query name: page required: false description: names are defaulted to page 1 with 100 results. You can query specific page results by using the 'page' query parameter. responses: "200": description: Fetch a list of all names known to the node. content: application/json: schema: title: BnsGetAllNamesResponse description: Fetch a list of all names known to the node. type: array items: type: string examples: aldenquimby.id: value: aldenquimby.id aldeoryn.id: value: aldeoryn.id alderete.id: value: alderete.id aldert.id: value: aldert.id aldi.id: value: aldi.id aldighieri.id: value: aldighieri.id 4XX: description: Error content: application/json: schema: title: BnsError description: Error type: object required: - error properties: error: type: string /v1/names/{name}: get: operationId: get_name_info summary: Get Name Details tags: - Names description: Retrieves details of a given name including the `address`, `status` and last transaction id - `last_txid`. parameters: - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: type: string example: muneeb.id in: path name: name required: true description: fully-qualified name responses: "200": description: Get name details content: application/json: schema: title: BnsGetNameInfoResponse description: Get name details type: object required: - address - blockchain - last_txid - status - zonefile_hash properties: address: type: string blockchain: type: string example: stacks expire_block: minimum: 0 type: integer grace_period: minimum: 0 type: integer last_txid: type: string resolver: type: string status: type: string zonefile: type: string zonefile_hash: type: string example: address: 1J3PUxY5uDShUnHRrMyU6yKtoHEUPhKULs blockchain: stacks expire_block: 599266 grace_period: false last_txid: 1edfa419f7b83f33e00830bc9409210da6c6d1db60f99eda10c835aa339cad6b renewal_deadline: 604266 resolver: null status: registered zonefile: > $ORIGIN muneeb.id $TTL 3600 _http._tcp IN URI 10 1 "https://gaia.blockstack.org/hub/1J3PUxY5uDShUnHRrMyU6yKtoHEUPhKULs/0/profile.json" zonefile_hash: 37aecf837c6ae9bdc9dbd98a268f263dacd00361 4XX: description: Default Response content: application/json: schema: type: object additionalProperties: type: string /v1/namespaces/: get: operationId: get_all_namespaces summary: Get All Namespaces tags: - Names description: Retrieves a list of all namespaces known to the node. parameters: - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks responses: "200": description: Default Response content: application/json: schema: type: object required: - namespaces properties: namespaces: title: BnsGetAllNamespacesResponse description: Fetch a list of all namespaces known to the node. type: array items: 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 /v1/namespaces/{tld}/names: get: operationId: get_namespace_names summary: Get Namespace Names tags: - Names description: Retrieves a list of names within a given namespace. parameters: - schema: type: number example: 22 in: query name: page required: false description: namespace values are defaulted to page 1 with 100 results. You can query specific page results by using the 'page' query parameter. - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: type: string example: id in: path name: tld required: true description: the namespace to fetch names from. responses: "200": description: Fetch a list of names from the namespace. content: application/json: schema: title: BnsGetAllNamespacesNamesResponse description: Fetch a list of names from the namespace. type: array items: type: string example: - aldenquimby.id - aldeoryn.id - alderete.id - aldert.id - aldi.id - aldighieri.id 4XX: description: Default Response content: application/json: schema: type: object additionalProperties: type: string /v1/addresses/{blockchain}/{address}: get: operationId: get_names_owned_by_address summary: Get Names Owned by Address tags: - Names description: Retrieves a list of names owned by the address provided. parameters: - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: type: string example: stacks in: path name: blockchain required: true description: the layer-1 blockchain for the address - schema: type: string example: SP2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKNRV9EJ7 in: path name: address required: true description: the address to lookup responses: "200": description: Retrieves a list of names owned by the address provided. content: application/json: schema: title: BnsNamesOwnByAddressResponse description: Retrieves a list of names owned by the address provided. type: object required: - names properties: names: type: array items: type: string example: muneeb.id 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object required: - error properties: error: type: string message: type: string /v2/prices/namespaces/{tld}: get: operationId: get_namespace_price summary: Get Namespace Price tags: - Names description: Retrieves the price of a namespace. The `amount` given will be in the smallest possible units of the currency. parameters: - schema: type: string example: id in: path name: tld required: true description: the namespace to fetch price for responses: "200": description: Fetch price for namespace. content: application/json: schema: title: BnsGetNamespacePriceResponse description: Fetch price for namespace. type: object required: - units - amount properties: units: type: string amount: type: string "400": description: Error content: application/json: schema: title: BnsError description: Error type: object required: - error properties: error: 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 /v2/prices/names/{name}: get: operationId: get_name_price summary: Get Name Price tags: - Names description: Retrieves the price of a name. The `amount` given will be in the smallest possible units of the currency. parameters: - schema: type: string example: muneeb.id in: path name: name required: true description: the name to query price information for responses: "200": description: Fetch price for name. content: application/json: schema: title: BnsGetNamePriceResponse description: Fetch price for name. type: object required: - units - amount properties: units: type: string amount: type: string "400": description: Error content: application/json: schema: title: BnsError description: Error type: object required: - error properties: error: 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: Microblocks description: Read-only endpoints to obtain microblocks details externalDocs: description: Stacks Documentation - Microblocks url: https://docs.stacks.co/understand-stacks/microblocks - 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: Non-Fungible Tokens description: Read-only endpoints to obtain non-fungible token details externalDocs: description: Stacks Documentation - Tokens url: https://docs.stacks.co/build/create-tokens - 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: 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 externalDocs: url: https://github.com/hirosystems/stacks-blockchain-api description: Source Repository