openapi: 3.0.3 info: title: Signer Metrics Accounts Search API description: Welcome to the API reference overview for the Signer Metrics API. version: 1.0.3 servers: - url: https://api.hiro.so/ description: mainnet - url: https://api.testnet.hiro.so/ description: testnet tags: - name: Search description: Read-only endpoints to search for accounts, blocks, smart contracts, and transactions paths: /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 properties: found: type: boolean enum: - true result: anyOf: - title: AddressSearchResult description: Address search result type: object 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 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 required: - balance - total_miner_rewards_received - lock_tx_id - locked - lock_height - burnchain_lock_height - burnchain_unlock_height - type: object properties: token_offering_locked: title: AddressTokenOfferingLocked description: Token Offering Locked type: object 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 properties: amount: description: Micro-STX amount locked at this block height. type: string block_height: type: integer required: - amount - block_height required: - total_locked - total_unlocked - unlock_schedule required: - entity_id - entity_type - title: BlockSearchResult description: Block search result type: object properties: entity_id: description: The id used to search this query. type: string entity_type: type: string enum: - block_hash block_data: type: object properties: canonical: type: boolean hash: type: string parent_block_hash: type: string burn_block_time: type: integer height: type: integer required: - canonical - hash - parent_block_hash - burn_block_time - height metadata: title: Block description: A block type: object 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 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 required: - entity_id - entity_type - block_data - title: ContractSearchResult description: Contract search result type: object properties: entity_id: description: The id used to search this query. type: string entity_type: type: string enum: - contract_address tx_data: type: object 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 required: - tx_type - tx_id metadata: anyOf: - anyOf: - title: TokenTransferTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string required: - hex - repr 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 properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - smart_contract_log tx_id: type: string contract_log: type: object properties: contract_id: type: string topic: type: string value: type: object properties: hex: type: string repr: type: string required: - hex - repr required: - contract_id - topic - value required: - event_type - tx_id - contract_log - title: StxLockTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string required: - locked_amount - unlock_height - locked_address required: - event_type - tx_id - stx_lock_event - title: StxAssetTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - sender - recipient - amount required: - event_type - tx_id - asset - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - asset_id - sender - recipient - amount required: - event_type - tx_id - asset - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object 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 properties: hex: type: string repr: type: string required: - hex - repr required: - asset_event_type - asset_id - sender - recipient - value required: - event_type - tx_id - asset tx_type: type: string enum: - token_transfer token_transfer: type: object 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 required: - recipient_address - amount - memo 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 - title: SmartContractTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string required: - hex - repr 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 properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - smart_contract_log tx_id: type: string contract_log: type: object properties: contract_id: type: string topic: type: string value: type: object properties: hex: type: string repr: type: string required: - hex - repr required: - contract_id - topic - value required: - event_type - tx_id - contract_log - title: StxLockTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string required: - locked_amount - unlock_height - locked_address required: - event_type - tx_id - stx_lock_event - title: StxAssetTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - sender - recipient - amount required: - event_type - tx_id - asset - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - asset_id - sender - recipient - amount required: - event_type - tx_id - asset - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object 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 properties: hex: type: string repr: type: string required: - hex - repr required: - asset_event_type - asset_id - sender - recipient - value required: - event_type - tx_id - asset tx_type: type: string enum: - smart_contract smart_contract: type: object 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 required: - clarity_version - contract_id - source_code 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 - title: ContractCallTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string required: - hex - repr 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 properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - smart_contract_log tx_id: type: string contract_log: type: object properties: contract_id: type: string topic: type: string value: type: object properties: hex: type: string repr: type: string required: - hex - repr required: - contract_id - topic - value required: - event_type - tx_id - contract_log - title: StxLockTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string required: - locked_amount - unlock_height - locked_address required: - event_type - tx_id - stx_lock_event - title: StxAssetTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - sender - recipient - amount required: - event_type - tx_id - asset - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - asset_id - sender - recipient - amount required: - event_type - tx_id - asset - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object 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 properties: hex: type: string repr: type: string required: - hex - repr required: - asset_event_type - asset_id - sender - recipient - value required: - event_type - tx_id - asset tx_type: type: string enum: - contract_call contract_call: type: object 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 properties: hex: type: string repr: type: string name: type: string type: type: string required: - hex - repr - name - type required: - contract_id - function_name - function_signature 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 - title: PoisonMicroblockTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string required: - hex - repr 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 properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - smart_contract_log tx_id: type: string contract_log: type: object properties: contract_id: type: string topic: type: string value: type: object properties: hex: type: string repr: type: string required: - hex - repr required: - contract_id - topic - value required: - event_type - tx_id - contract_log - title: StxLockTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string required: - locked_amount - unlock_height - locked_address required: - event_type - tx_id - stx_lock_event - title: StxAssetTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - sender - recipient - amount required: - event_type - tx_id - asset - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - asset_id - sender - recipient - amount required: - event_type - tx_id - asset - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object 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 properties: hex: type: string repr: type: string required: - hex - repr required: - asset_event_type - asset_id - sender - recipient - value required: - event_type - tx_id - asset tx_type: type: string enum: - poison_microblock poison_microblock: type: object properties: microblock_header_1: description: Hex encoded microblock header type: string microblock_header_2: description: Hex encoded microblock header type: string required: - microblock_header_1 - microblock_header_2 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 - title: CoinbaseTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string required: - hex - repr 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 properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - smart_contract_log tx_id: type: string contract_log: type: object properties: contract_id: type: string topic: type: string value: type: object properties: hex: type: string repr: type: string required: - hex - repr required: - contract_id - topic - value required: - event_type - tx_id - contract_log - title: StxLockTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string required: - locked_amount - unlock_height - locked_address required: - event_type - tx_id - stx_lock_event - title: StxAssetTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - sender - recipient - amount required: - event_type - tx_id - asset - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - asset_id - sender - recipient - amount required: - event_type - tx_id - asset - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object 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 properties: hex: type: string repr: type: string required: - hex - repr required: - asset_event_type - asset_id - sender - recipient - value required: - event_type - tx_id - asset tx_type: type: string enum: - coinbase coinbase_payload: type: object 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' required: - data 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 - title: TenureChangeTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string required: - hex - repr 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 properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - smart_contract_log tx_id: type: string contract_log: type: object properties: contract_id: type: string topic: type: string value: type: object properties: hex: type: string repr: type: string required: - hex - repr required: - contract_id - topic - value required: - event_type - tx_id - contract_log - title: StxLockTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string required: - locked_amount - unlock_height - locked_address required: - event_type - tx_id - stx_lock_event - title: StxAssetTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - sender - recipient - amount required: - event_type - tx_id - asset - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - asset_id - sender - recipient - amount required: - event_type - tx_id - asset - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object 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 properties: hex: type: string repr: type: string required: - hex - repr required: - asset_event_type - asset_id - sender - recipient - value required: - event_type - tx_id - asset tx_type: type: string enum: - tenure_change tenure_change_payload: type: object 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 required: - tenure_consensus_hash - prev_tenure_consensus_hash - burn_view_consensus_hash - previous_tenure_end - previous_tenure_blocks - cause - pubkey_hash 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 - anyOf: - title: TokenTransferMempoolTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 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 required: - recipient_address - amount - memo 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 - title: SmartContractMempoolTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 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 required: - clarity_version - contract_id - source_code 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 - title: ContractCallMempoolTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 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 properties: hex: type: string repr: type: string name: type: string type: type: string required: - hex - repr - name - type required: - contract_id - function_name - function_signature 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 - title: PoisonMicroblockMempoolTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 properties: microblock_header_1: description: Hex encoded microblock header type: string microblock_header_2: description: Hex encoded microblock header type: string required: - microblock_header_1 - microblock_header_2 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 - title: CoinbaseMempoolTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 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' required: - data 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 - title: TenureChangeMempoolTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 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 required: - tenure_consensus_hash - prev_tenure_consensus_hash - burn_view_consensus_hash - previous_tenure_end - previous_tenure_blocks - cause - pubkey_hash 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 required: - entity_id - entity_type - title: MempoolTxSearchResult description: Mempool transaction search result type: object 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 properties: tx_type: type: string required: - tx_type metadata: anyOf: - title: TokenTransferMempoolTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 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 required: - recipient_address - amount - memo 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 - title: SmartContractMempoolTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 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 required: - clarity_version - contract_id - source_code 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 - title: ContractCallMempoolTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 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 properties: hex: type: string repr: type: string name: type: string type: type: string required: - hex - repr - name - type required: - contract_id - function_name - function_signature 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 - title: PoisonMicroblockMempoolTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 properties: microblock_header_1: description: Hex encoded microblock header type: string microblock_header_2: description: Hex encoded microblock header type: string required: - microblock_header_1 - microblock_header_2 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 - title: CoinbaseMempoolTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 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' required: - data 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 - title: TenureChangeMempoolTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 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 required: - tenure_consensus_hash - prev_tenure_consensus_hash - burn_view_consensus_hash - previous_tenure_end - previous_tenure_blocks - cause - pubkey_hash 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 required: - entity_id - entity_type - tx_data - title: TxSearchResult description: Transaction search result type: object properties: entity_id: description: The id used to search this query. type: string entity_type: type: string enum: - tx_id tx_data: type: object properties: canonical: type: boolean block_hash: type: string burn_block_time: type: integer block_height: type: integer tx_type: type: string required: - canonical - block_hash - burn_block_time - block_height - tx_type metadata: anyOf: - title: TokenTransferTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string required: - hex - repr 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 properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - smart_contract_log tx_id: type: string contract_log: type: object properties: contract_id: type: string topic: type: string value: type: object properties: hex: type: string repr: type: string required: - hex - repr required: - contract_id - topic - value required: - event_type - tx_id - contract_log - title: StxLockTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string required: - locked_amount - unlock_height - locked_address required: - event_type - tx_id - stx_lock_event - title: StxAssetTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - sender - recipient - amount required: - event_type - tx_id - asset - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - asset_id - sender - recipient - amount required: - event_type - tx_id - asset - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object 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 properties: hex: type: string repr: type: string required: - hex - repr required: - asset_event_type - asset_id - sender - recipient - value required: - event_type - tx_id - asset tx_type: type: string enum: - token_transfer token_transfer: type: object 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 required: - recipient_address - amount - memo 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 - title: SmartContractTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string required: - hex - repr 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 properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - smart_contract_log tx_id: type: string contract_log: type: object properties: contract_id: type: string topic: type: string value: type: object properties: hex: type: string repr: type: string required: - hex - repr required: - contract_id - topic - value required: - event_type - tx_id - contract_log - title: StxLockTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string required: - locked_amount - unlock_height - locked_address required: - event_type - tx_id - stx_lock_event - title: StxAssetTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - sender - recipient - amount required: - event_type - tx_id - asset - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - asset_id - sender - recipient - amount required: - event_type - tx_id - asset - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object 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 properties: hex: type: string repr: type: string required: - hex - repr required: - asset_event_type - asset_id - sender - recipient - value required: - event_type - tx_id - asset tx_type: type: string enum: - smart_contract smart_contract: type: object 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 required: - clarity_version - contract_id - source_code 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 - title: ContractCallTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string required: - hex - repr 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 properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - smart_contract_log tx_id: type: string contract_log: type: object properties: contract_id: type: string topic: type: string value: type: object properties: hex: type: string repr: type: string required: - hex - repr required: - contract_id - topic - value required: - event_type - tx_id - contract_log - title: StxLockTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string required: - locked_amount - unlock_height - locked_address required: - event_type - tx_id - stx_lock_event - title: StxAssetTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - sender - recipient - amount required: - event_type - tx_id - asset - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - asset_id - sender - recipient - amount required: - event_type - tx_id - asset - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object 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 properties: hex: type: string repr: type: string required: - hex - repr required: - asset_event_type - asset_id - sender - recipient - value required: - event_type - tx_id - asset tx_type: type: string enum: - contract_call contract_call: type: object 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 properties: hex: type: string repr: type: string name: type: string type: type: string required: - hex - repr - name - type required: - contract_id - function_name - function_signature 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 - title: PoisonMicroblockTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string required: - hex - repr 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 properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - smart_contract_log tx_id: type: string contract_log: type: object properties: contract_id: type: string topic: type: string value: type: object properties: hex: type: string repr: type: string required: - hex - repr required: - contract_id - topic - value required: - event_type - tx_id - contract_log - title: StxLockTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string required: - locked_amount - unlock_height - locked_address required: - event_type - tx_id - stx_lock_event - title: StxAssetTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - sender - recipient - amount required: - event_type - tx_id - asset - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - asset_id - sender - recipient - amount required: - event_type - tx_id - asset - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object 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 properties: hex: type: string repr: type: string required: - hex - repr required: - asset_event_type - asset_id - sender - recipient - value required: - event_type - tx_id - asset tx_type: type: string enum: - poison_microblock poison_microblock: type: object properties: microblock_header_1: description: Hex encoded microblock header type: string microblock_header_2: description: Hex encoded microblock header type: string required: - microblock_header_1 - microblock_header_2 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 - title: CoinbaseTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string required: - hex - repr 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 properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - smart_contract_log tx_id: type: string contract_log: type: object properties: contract_id: type: string topic: type: string value: type: object properties: hex: type: string repr: type: string required: - hex - repr required: - contract_id - topic - value required: - event_type - tx_id - contract_log - title: StxLockTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string required: - locked_amount - unlock_height - locked_address required: - event_type - tx_id - stx_lock_event - title: StxAssetTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - sender - recipient - amount required: - event_type - tx_id - asset - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - asset_id - sender - recipient - amount required: - event_type - tx_id - asset - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object 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 properties: hex: type: string repr: type: string required: - hex - repr required: - asset_event_type - asset_id - sender - recipient - value required: - event_type - tx_id - asset tx_type: type: string enum: - coinbase coinbase_payload: type: object 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' required: - data 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 - title: TenureChangeTransaction type: object 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 post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name 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 properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - amount - type - asset - type: object properties: principal: anyOf: - type: object properties: type_id: type: string enum: - principal_origin required: - type_id - type: object properties: type_id: type: string enum: - principal_standard address: type: string required: - type_id - address - type: object properties: type_id: type: string enum: - principal_contract address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent type: type: string enum: - non_fungible asset_value: type: object properties: hex: type: string repr: type: string required: - hex - repr asset: type: object properties: asset_name: type: string contract_address: type: string contract_name: type: string required: - asset_name - contract_address - contract_name required: - principal - condition_code - type - asset_value - asset 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 properties: hex: description: Hex string representing the value fo the transaction result type: string repr: description: Readable string of the transaction result type: string required: - hex - repr 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 properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - smart_contract_log tx_id: type: string contract_log: type: object properties: contract_id: type: string topic: type: string value: type: object properties: hex: type: string repr: type: string required: - hex - repr required: - contract_id - topic - value required: - event_type - tx_id - contract_log - title: StxLockTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_lock tx_id: type: string stx_lock_event: type: object properties: locked_amount: type: string unlock_height: type: integer locked_address: type: string required: - locked_amount - unlock_height - locked_address required: - event_type - tx_id - stx_lock_event - title: StxAssetTransactionEvent description: Only present in `smart_contract` and `contract_call` tx types. type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - stx_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - sender - recipient - amount required: - event_type - tx_id - asset - title: FungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - fungible_token_asset tx_id: type: string asset: type: object 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 required: - asset_event_type - asset_id - sender - recipient - amount required: - event_type - tx_id - asset - title: NonFungibleTokenAssetTransactionEvent type: object allOf: - title: AbstractTransactionEvent type: object properties: event_index: type: integer required: - event_index - type: object properties: event_type: type: string enum: - non_fungible_token_asset tx_id: type: string asset: type: object 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 properties: hex: type: string repr: type: string required: - hex - repr required: - asset_event_type - asset_id - sender - recipient - value required: - event_type - tx_id - asset tx_type: type: string enum: - tenure_change tenure_change_payload: type: object 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 required: - tenure_consensus_hash - prev_tenure_consensus_hash - burn_view_consensus_hash - previous_tenure_end - previous_tenure_blocks - cause - pubkey_hash 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 required: - entity_id - entity_type - tx_data required: - found - result '404': description: Default Response content: application/json: schema: type: object properties: found: type: boolean enum: - false result: type: object 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 required: - entity_type error: type: string required: - found - result - error 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object properties: error: type: string message: type: string required: - error externalDocs: url: https://github.com/hirosystems/signer-metrics-api description: Source Repository