openapi: 3.0.3 info: title: Signer Metrics Accounts Transactions 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: Transactions description: Endpoints to obtain transaction details and to broadcast transactions to the network externalDocs: description: Hiro Documentation - Transactions url: https://docs.hiro.so/get-started/transactions paths: /extended/v1/tx/: get: operationId: get_transaction_list summary: Get recent transactions tags: - Transactions description: Retrieves all recently mined transactions parameters: - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: minimum: 0 default: 20 maximum: 50 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: type: array items: anyOf: - type: string enum: - coinbase - type: string enum: - token_transfer - type: string enum: - smart_contract - type: string enum: - contract_call - type: string enum: - poison_microblock - type: string enum: - tenure_change in: query name: type required: false - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: anyOf: - type: string enum: - asc - type: string enum: - desc in: query name: order required: false - schema: default: block_height anyOf: - type: string enum: - block_height - type: string enum: - burn_block_time - type: string enum: - fee in: query name: sort_by required: false description: Option to sort results by block height, timestamp, or fee - schema: type: string in: query name: from_address required: false description: Option to filter results by sender address - schema: type: string in: query name: to_address required: false description: Option to filter results by recipient address - schema: type: integer example: 1704067200 in: query name: start_time required: false description: Filter by transactions after this timestamp (unix timestamp in seconds) - schema: type: integer example: 1706745599 in: query name: end_time required: false description: Filter by transactions before this timestamp (unix timestamp in seconds) - schema: type: string example: SP000000000000000000002Q6VF78.pox-4 in: query name: contract_id required: false description: Option to filter results by contract ID - schema: type: string example: delegate-stx in: query name: function_name required: false description: Filter by contract call transactions involving this function name - schema: minimum: 0 maximum: 9007199254740991 type: integer example: 123 in: query name: nonce required: false description: Filter by transactions with this nonce - schema: default: false type: boolean examples: 'true': value: true 'false': value: false in: query name: exclude_function_args required: false description: Exclude function_args from contract call responses for smaller transaction sizes. responses: '200': description: List of transactions content: application/json: schema: description: List of transactions type: object properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: 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: - limit - offset - total - results 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object properties: error: type: string message: type: string required: - error /extended/v1/tx/multiple: get: operationId: get_tx_list_details summary: Get list of details for transactions tags: - Transactions description: Retrieves a list of transactions for a given list of transaction IDs parameters: - schema: type: array items: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID description: Transaction ID examples: - '0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6' type: string in: query name: tx_id required: true - schema: minimum: 0 default: 20 maximum: 100 title: Limit type: integer in: query name: event_limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: event_offset required: false description: Result offset - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: default: false type: boolean examples: 'true': value: true 'false': value: false in: query name: exclude_function_args required: false description: Exclude function_args from contract call responses for smaller transaction sizes. responses: '200': description: Default Response content: application/json: schema: type: object additionalProperties: anyOf: - title: TransactionFound description: This object returns transaction for found true type: object properties: found: const: true type: boolean result: 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: - const: allow type: string - const: deny type: string post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: stx type: string required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: fungible type: string 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: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent type: string - const: not_sent type: string type: const: non_fungible type: string 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: - const: on_chain_only type: string - const: off_chain_only type: string - const: any type: string 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: - const: success type: string - const: abort_by_response type: string - const: abort_by_post_condition type: string 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: const: smart_contract_log type: string 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: const: stx_lock type: string 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: const: stx_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: fungible_token_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: non_fungible_token_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: token_transfer type: string 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: - const: allow type: string - const: deny type: string post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: stx type: string required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: fungible type: string 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: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent type: string - const: not_sent type: string type: const: non_fungible type: string 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: - const: on_chain_only type: string - const: off_chain_only type: string - const: any type: string 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: - const: success type: string - const: abort_by_response type: string - const: abort_by_post_condition type: string 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: const: smart_contract_log type: string 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: const: stx_lock type: string 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: const: stx_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: fungible_token_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: non_fungible_token_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: smart_contract type: string 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: - const: allow type: string - const: deny type: string post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: stx type: string required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: fungible type: string 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: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent type: string - const: not_sent type: string type: const: non_fungible type: string 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: - const: on_chain_only type: string - const: off_chain_only type: string - const: any type: string 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: - const: success type: string - const: abort_by_response type: string - const: abort_by_post_condition type: string 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: const: smart_contract_log type: string 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: const: stx_lock type: string 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: const: stx_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: fungible_token_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: non_fungible_token_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: contract_call type: string 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: - const: allow type: string - const: deny type: string post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: stx type: string required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: fungible type: string 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: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent type: string - const: not_sent type: string type: const: non_fungible type: string 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: - const: on_chain_only type: string - const: off_chain_only type: string - const: any type: string 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: - const: success type: string - const: abort_by_response type: string - const: abort_by_post_condition type: string 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: const: smart_contract_log type: string 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: const: stx_lock type: string 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: const: stx_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: fungible_token_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: non_fungible_token_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: poison_microblock type: string 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: - const: allow type: string - const: deny type: string post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: stx type: string required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: fungible type: string 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: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent type: string - const: not_sent type: string type: const: non_fungible type: string 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: - const: on_chain_only type: string - const: off_chain_only type: string - const: any type: string 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: - const: success type: string - const: abort_by_response type: string - const: abort_by_post_condition type: string 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: const: smart_contract_log type: string 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: const: stx_lock type: string 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: const: stx_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: fungible_token_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: non_fungible_token_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: coinbase type: string 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: - const: allow type: string - const: deny type: string post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: stx type: string required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: fungible type: string 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: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent type: string - const: not_sent type: string type: const: non_fungible type: string 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: - const: on_chain_only type: string - const: off_chain_only type: string - const: any type: string 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: - const: success type: string - const: abort_by_response type: string - const: abort_by_post_condition type: string 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: const: smart_contract_log type: string 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: const: stx_lock type: string 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: const: stx_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: fungible_token_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: non_fungible_token_asset type: string tx_id: type: string asset: type: object properties: asset_event_type: anyOf: - const: transfer type: string - const: mint type: string - const: burn type: string 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: const: tenure_change type: string 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: - const: block_found type: string - const: extended type: string - const: extended_runtime type: string - const: extended_read_count type: string - const: extended_read_length type: string - const: extended_write_count type: string - const: extended_write_length type: string 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: - const: allow type: string - const: deny type: string post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: stx type: string required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: fungible type: string 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: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent type: string - const: not_sent type: string type: const: non_fungible type: string 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: - const: on_chain_only type: string - const: off_chain_only type: string - const: any type: string tx_status: description: Status of the transaction anyOf: - const: pending type: string - const: dropped_replace_by_fee type: string - const: dropped_replace_across_fork type: string - const: dropped_too_expensive type: string - const: dropped_stale_garbage_collect type: string - const: dropped_problematic type: string 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: const: token_transfer type: string 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: - const: allow type: string - const: deny type: string post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: stx type: string required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: fungible type: string 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: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent type: string - const: not_sent type: string type: const: non_fungible type: string 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: - const: on_chain_only type: string - const: off_chain_only type: string - const: any type: string tx_status: description: Status of the transaction anyOf: - const: pending type: string - const: dropped_replace_by_fee type: string - const: dropped_replace_across_fork type: string - const: dropped_too_expensive type: string - const: dropped_stale_garbage_collect type: string - const: dropped_problematic type: string 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: const: smart_contract type: string 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: - const: allow type: string - const: deny type: string post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: stx type: string required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: fungible type: string 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: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent type: string - const: not_sent type: string type: const: non_fungible type: string 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: - const: on_chain_only type: string - const: off_chain_only type: string - const: any type: string tx_status: description: Status of the transaction anyOf: - const: pending type: string - const: dropped_replace_by_fee type: string - const: dropped_replace_across_fork type: string - const: dropped_too_expensive type: string - const: dropped_stale_garbage_collect type: string - const: dropped_problematic type: string 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: const: contract_call type: string 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: - const: allow type: string - const: deny type: string post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: stx type: string required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: fungible type: string 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: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent type: string - const: not_sent type: string type: const: non_fungible type: string 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: - const: on_chain_only type: string - const: off_chain_only type: string - const: any type: string tx_status: description: Status of the transaction anyOf: - const: pending type: string - const: dropped_replace_by_fee type: string - const: dropped_replace_across_fork type: string - const: dropped_too_expensive type: string - const: dropped_stale_garbage_collect type: string - const: dropped_problematic type: string 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: const: poison_microblock type: string 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: - const: allow type: string - const: deny type: string post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: stx type: string required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: fungible type: string 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: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent type: string - const: not_sent type: string type: const: non_fungible type: string 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: - const: on_chain_only type: string - const: off_chain_only type: string - const: any type: string tx_status: description: Status of the transaction anyOf: - const: pending type: string - const: dropped_replace_by_fee type: string - const: dropped_replace_across_fork type: string - const: dropped_too_expensive type: string - const: dropped_stale_garbage_collect type: string - const: dropped_problematic type: string 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: const: coinbase type: string 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: - const: allow type: string - const: deny type: string post_conditions: type: array items: anyOf: - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: stx type: string required: - principal - condition_code - amount - type - type: object properties: principal: anyOf: - type: object properties: type_id: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent_equal_to type: string - const: sent_greater_than type: string - const: sent_greater_than_or_equal_to type: string - const: sent_less_than type: string - const: sent_less_than_or_equal_to type: string amount: type: string type: const: fungible type: string 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: const: principal_origin type: string required: - type_id - type: object properties: type_id: const: principal_standard type: string address: type: string required: - type_id - address - type: object properties: type_id: const: principal_contract type: string address: type: string contract_name: type: string required: - type_id - address - contract_name condition_code: anyOf: - const: sent type: string - const: not_sent type: string type: const: non_fungible type: string 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: - const: on_chain_only type: string - const: off_chain_only type: string - const: any type: string tx_status: description: Status of the transaction anyOf: - const: pending type: string - const: dropped_replace_by_fee type: string - const: dropped_replace_across_fork type: string - const: dropped_too_expensive type: string - const: dropped_stale_garbage_collect type: string - const: dropped_problematic type: string 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: const: tenure_change type: string 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: - const: block_found type: string - const: extended type: string - const: extended_runtime type: string - const: extended_read_count type: string - const: extended_read_length type: string - const: extended_write_count type: string - const: extended_write_length type: string 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: - found - result - title: TransactionNotFound description: This object returns the id for not found transaction type: object properties: found: const: false type: boolean result: type: object properties: tx_id: type: string required: - tx_id required: - found - result 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object properties: error: type: string message: type: string required: - error /extended/v1/tx/mempool: get: operationId: get_mempool_transaction_list summary: Get mempool transactions tags: - Transactions description: "Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.\n\n If you need to monitor new transactions, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates." parameters: - schema: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41} title: STX Address type: string example: SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP in: query name: sender_address required: false description: STX Address - schema: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41} title: STX Address type: string example: SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP in: query name: recipient_address required: false description: STX Address - schema: pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41} title: STX Address type: string example: SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP in: query name: address required: false description: STX Address - schema: title: Order By anyOf: - type: string enum: - age - type: string enum: - size - type: string enum: - fee in: query name: order_by required: false description: Option to sort results by transaction age, size, or fee rate. - schema: title: Order anyOf: - type: string enum: - asc - type: string enum: - desc in: query name: order required: false description: Results order - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: minimum: 0 default: 20 maximum: 50 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: default: false type: boolean examples: 'true': value: true 'false': value: false in: query name: exclude_function_args required: false description: Exclude function_args from contract call responses for smaller transaction sizes. responses: '200': description: List of mempool transactions content: application/json: schema: description: List of mempool transactions type: object properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: 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: - limit - offset - total - results 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object properties: error: type: string message: type: string required: - error /extended/v1/tx/mempool/stats: get: operationId: get_mempool_transaction_stats summary: Get statistics for mempool transactions tags: - Transactions description: "Queries for transactions counts, age (by block height), fees (simple average), and size.\n All results broken down by transaction type and percentiles (p25, p50, p75, p95)." responses: '200': description: GET request that returns stats on mempool transactions content: application/json: schema: title: MempoolTransactionStatsResponse description: GET request that returns stats on mempool transactions type: object properties: tx_type_counts: additionalProperties: type: integer description: Number of tranasction in the mempool, broken down by transaction type. type: object tx_simple_fee_averages: description: The simple mean (average) transaction fee, broken down by transaction type. Note that this does not factor in actual execution costs. The average fee is not a reliable metric for calculating a fee for a new transaction. type: object additionalProperties: additionalProperties: true type: object properties: p25: anyOf: - type: number - type: 'null' p50: anyOf: - type: number - type: 'null' p75: anyOf: - type: number - type: 'null' p95: anyOf: - type: number - type: 'null' required: - p25 - p50 - p75 - p95 tx_ages: description: The average time (in blocks) that transactions have lived in the mempool. The start block height is simply the current chain-tip of when the attached Stacks node receives the transaction. This timing can be different across Stacks nodes / API instances due to propagation timing differences in the p2p network. type: object additionalProperties: additionalProperties: true type: object properties: p25: anyOf: - type: number - type: 'null' p50: anyOf: - type: number - type: 'null' p75: anyOf: - type: number - type: 'null' p95: anyOf: - type: number - type: 'null' required: - p25 - p50 - p75 - p95 tx_byte_sizes: description: The average byte size of transactions in the mempool, broken down by transaction type. type: object additionalProperties: additionalProperties: true type: object properties: p25: anyOf: - type: number - type: 'null' p50: anyOf: - type: number - type: 'null' p75: anyOf: - type: number - type: 'null' p95: anyOf: - type: number - type: 'null' required: - p25 - p50 - p75 - p95 required: - tx_type_counts - tx_simple_fee_averages - tx_ages - tx_byte_sizes 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object properties: error: type: string message: type: string required: - error /extended/v1/tx/events: get: operationId: get_filtered_events summary: Transaction Events tags: - Transactions description: "Retrieves the list of events filtered by principal (STX address or Smart Contract ID), transaction id or event types.\n The list of event types is ('smart_contract_log', 'stx_lock', 'stx_asset', 'fungible_token_asset', 'non_fungible_token_asset')." parameters: - schema: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID type: string example: '0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6' in: query name: tx_id required: false description: Transaction ID - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41} title: STX Address description: STX Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: query name: address required: false - schema: type: array items: anyOf: - type: string enum: - smart_contract_log - type: string enum: - stx_lock - type: string enum: - stx_asset - type: string enum: - fungible_token_asset - type: string enum: - non_fungible_token_asset in: query name: type required: false - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: minimum: 0 default: 20 maximum: 100 title: Limit type: integer in: query name: limit required: false description: Results per page responses: '200': description: Default Response content: application/json: schema: title: List of events type: object properties: limit: type: integer example: 20 offset: type: integer example: 0 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 required: - limit - offset - events 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object properties: error: type: string message: type: string required: - error /extended/v1/tx/{tx_id}: get: operationId: get_transaction_by_id summary: Get transaction tags: - Transactions description: Retrieves transaction details for a given transaction ID parameters: - schema: minimum: 0 default: 20 maximum: 100 title: Limit type: integer in: query name: event_limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: event_offset required: false description: Result offset - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: default: false type: boolean examples: 'true': value: true 'false': value: false in: query name: exclude_function_args required: false description: Exclude function_args from contract call responses for smaller transaction sizes. - schema: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID type: string example: '0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6' in: path name: tx_id required: true description: Transaction ID responses: '200': description: Default Response content: application/json: schema: anyOf: - anyOf: - 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 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object properties: error: type: string message: type: string required: - error /extended/v1/tx/{tx_id}/raw: get: operationId: get_raw_transaction_by_id summary: Get raw transaction tags: - Transactions description: Retrieves a hex encoded serialized transaction for a given ID parameters: - schema: minimum: 0 default: 20 maximum: 100 title: Limit type: integer in: query name: event_limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: event_offset required: false description: Result offset - schema: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID type: string example: '0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6' in: path name: tx_id required: true description: Transaction ID responses: '200': description: GET raw transaction content: application/json: schema: title: GetRawTransactionResult description: GET raw transaction type: object properties: raw_tx: type: string required: - raw_tx 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object properties: error: type: string message: type: string required: - error /extended/v1/tx/block/{block_hash}: get: operationId: get_transactions_by_block_hash summary: Transactions by block hash tags: - Transactions description: "**NOTE:** This endpoint is deprecated in favor of [Get transactions by block](/api/get-transactions-by-block).\n\n Retrieves a list of all transactions within a block for a given block hash." parameters: - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: minimum: 0 default: 20 maximum: 200 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: default: false type: boolean examples: 'true': value: true 'false': value: false in: query name: exclude_function_args required: false description: Exclude function_args from contract call responses for smaller transaction sizes. - schema: type: string in: path name: block_hash required: true deprecated: true responses: '200': description: List of transactions content: application/json: schema: description: List of transactions type: object properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: 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: - limit - offset - total - results 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object properties: error: type: string message: type: string required: - error /extended/v1/tx/block_height/{height}: get: operationId: get_transactions_by_block_height summary: Transactions by block height tags: - Transactions description: "**NOTE:** This endpoint is deprecated in favor of [Get transactions by block](/api/get-transactions-by-block).\n\n Retrieves all transactions within a block at a given height" parameters: - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: minimum: 0 default: 20 maximum: 50 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: default: false type: boolean examples: 'true': value: true 'false': value: false in: query name: exclude_function_args required: false description: Exclude function_args from contract call responses for smaller transaction sizes. - schema: minimum: 0 title: Block height type: integer example: 777678 in: path name: height required: true description: Block height deprecated: true responses: '200': description: List of transactions content: application/json: schema: description: List of transactions type: object properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: 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: - limit - offset - total - results 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object properties: error: type: string message: type: string required: - error /extended/v1/address/{principal}/mempool: get: operationId: get_address_mempool_transactions summary: Transactions for address tags: - Transactions description: Retrieves all transactions for a given address that are currently in mempool parameters: - schema: minimum: 0 default: 20 maximum: 50 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: default: false type: boolean example: true in: query name: unanchored required: false description: Include data from unanchored (i.e. unconfirmed) microblocks - schema: default: false type: boolean examples: 'true': value: true 'false': value: false in: query name: exclude_function_args required: false description: Exclude function_args from contract call responses for smaller transaction sizes. - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41} title: STX Address description: STX Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: principal required: true responses: '200': description: List of mempool transactions content: application/json: schema: description: List of mempool transactions type: object properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: 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: - limit - offset - total - results 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object properties: error: type: string message: type: string required: - error /extended/v2/blocks/{height_or_hash}/transactions: get: operationId: get_transactions_by_block summary: Get transactions by block tags: - Transactions description: Retrieves transactions confirmed in a single block parameters: - schema: minimum: 0 default: 20 maximum: 50 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: anyOf: - type: string enum: - latest - pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Block hash description: Block hash examples: - daf79950c5e8bb0c620751333967cdd62297137cdaf79950c5e8bb0c62075133 type: string - title: Block height description: Block height examples: - 777678 type: integer in: path name: height_or_hash required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: 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: - limit - offset - total - results 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object properties: error: type: string message: type: string required: - error /extended/v2/addresses/{address}/transactions: get: operationId: get_address_transactions summary: Get address transactions tags: - Transactions description: "Retrieves a paginated list of confirmed transactions sent or received by a STX address or Smart Contract ID, alongside the total amount of STX sent or received and the number of STX, FT and NFT transfers contained within each transaction.\n\n More information on Transaction types can be found [here](https://docs.stacks.co/transactions/how-transactions-work#types)." parameters: - schema: minimum: 0 default: 20 maximum: 50 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: default: false type: boolean examples: 'true': value: true 'false': value: false in: query name: exclude_function_args required: false description: Exclude function_args from contract call responses for smaller transaction sizes. - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41} title: STX Address description: STX Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: address required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: title: AddressTransaction description: Address transaction with STX, FT and NFT transfer summaries type: object properties: tx: 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 stx_sent: description: Total sent from the given address, including the tx fee, in micro-STX as an integer string. type: string stx_received: description: Total received by the given address in micro-STX as an integer string. type: string events: type: object properties: stx: type: object properties: transfer: type: integer mint: type: integer burn: type: integer required: - transfer - mint - burn ft: type: object properties: transfer: type: integer mint: type: integer burn: type: integer required: - transfer - mint - burn nft: type: object properties: transfer: type: integer mint: type: integer burn: type: integer required: - transfer - mint - burn required: - stx - ft - nft required: - tx - stx_sent - stx_received - events required: - limit - offset - total - results 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object properties: error: type: string message: type: string required: - error /extended/v2/addresses/{address}/transactions/{tx_id}/events: get: operationId: get_address_transaction_events summary: Get events for an address transaction tags: - Transactions description: Retrieves a paginated list of all STX, FT and NFT events concerning a STX address or Smart Contract ID within a specific transaction. parameters: - schema: minimum: 0 default: 20 maximum: 50 title: Limit type: integer in: query name: limit required: false description: Results per page - schema: minimum: 0 default: 0 title: Offset type: integer in: query name: offset required: false description: Result offset - schema: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41} title: STX Address description: STX Address examples: - SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ title: Smart Contract ID description: Smart Contract ID examples: - SP000000000000000000002Q6VF78.pox-3 type: string in: path name: address required: true - schema: pattern: ^(0x)?[a-fA-F0-9]{64}$ title: Transaction ID type: string example: '0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6' in: path name: tx_id required: true description: Transaction ID responses: '200': description: Default Response content: application/json: schema: type: object properties: limit: type: integer example: 20 offset: type: integer example: 0 total: type: integer example: 1 results: type: array items: title: AddressTransactionEvent description: Address Transaction Event anyOf: - type: object properties: type: type: string enum: - stx event_index: type: integer data: type: object properties: type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn amount: description: Amount transferred in micro-STX as an integer string. type: string sender: description: Principal that sent STX. This is unspecified if the STX were minted. type: string recipient: description: Principal that received STX. This is unspecified if the STX were burned. type: string required: - type - amount required: - type - event_index - data - type: object properties: type: type: string enum: - ft event_index: type: integer data: type: object properties: type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn amount: description: Amount transferred as an integer string. This balance does not factor in possible SIP-010 decimals. type: string asset_identifier: description: Fungible Token asset identifier. type: string sender: description: Principal that sent the asset. type: string recipient: description: Principal that received the asset. type: string required: - type - amount - asset_identifier required: - type - event_index - data - type: object properties: type: type: string enum: - nft event_index: type: integer data: type: object properties: type: anyOf: - type: string enum: - transfer - type: string enum: - mint - type: string enum: - burn asset_identifier: description: Non Fungible Token asset identifier. type: string value: type: object properties: hex: type: string repr: type: string required: - hex - repr sender: description: Principal that sent the asset. type: string recipient: description: Principal that received the asset. type: string required: - type - asset_identifier - value required: - type - event_index - data required: - limit - offset - total - results 4XX: description: Default Response content: application/json: schema: title: Error Response additionalProperties: true type: object properties: error: type: string message: type: string required: - error /v2/transactions: post: summary: Broadcast raw transaction tags: - Transactions security: [] description: 'Broadcast raw transactions on the network. You can use the [@stacks/transactions](https://github.com/blockstack/stacks.js) project to generate a raw transaction payload. The node performs static validation checks on transactions before accepting them into the mempool, including: - Transaction format validation - Signature verification - Nonce checking - Fee validation - Size limits ' operationId: broadcastTransaction requestBody: required: true content: application/octet-stream: schema: type: string format: binary minLength: 1 example: binary format of 00000000010400bed38c2aadffa348931bcb542880ff79d607afec000000000000000000000000000000c800012b0b1fff6cccd0974966dcd665835838f0985be508e1322e09fb3d751eca132c492bda720f9ef1768d14fdabed6127560ba52d5e3ac470dcb60b784e97dc88c9030200000000000516df0ba3e79792be7be5e50a370289accfc8c9e032000000000000303974657374206d656d6f00000000000000000000000000000000000000000000000000 application/json: schema: type: object required: - tx properties: tx: type: string pattern: ^[0-9a-f]+$ description: Hex-encoded transaction attachment: type: string pattern: ^[0-9a-f]+$ description: Optional hex-encoded attachment for contract-call transactions example: tx: 00000000010400bed38c2aadffa348931bcb542880ff79d607afec000000000000000000000000000000c800012b0b1fff6cccd0974966dcd665835838f0985be508e1322e09fb3d751eca132c492bda720f9ef1768d14fdabed6127560ba52d5e3ac470dcb60b784e97dc88c9030200000000000516df0ba3e79792be7be5e50a370289accfc8c9e032000000000000303974657374206d656d6f00000000000000000000000000000000000000000000000000 attachment: 68656c6c6f20776f726c64 responses: '200': description: Transaction ID of successful post of a raw tx to the node's mempool. content: application/json: schema: type: string pattern: ^[0-9a-f]{64}$ example: e161978626f216b2141b156ade10501207ae535fa365a13ef5d7a7c9310a09f2 '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/TransactionSubmissionError' examples: transaction-submission-error: $ref: ./components/examples/transaction-submission-error.example.json text/plain: schema: type: string example: Failed to decode transaction '500': $ref: '#/components/responses/InternalServerError' /v3/transaction/{txid}: get: summary: Retrieve transaction details by TXID tags: - Transactions security: [] description: 'Get a JSON with the transaction details including the `index_block_hash`, the hex-encoded transaction body, and the `result`. ' operationId: getTransactionById parameters: - name: txid in: path required: true description: Transaction ID (64 hexadecimal characters) schema: type: string pattern: ^[0-9a-f]{64}$ responses: '200': description: Transaction JSON with index_block_hash, transaction body and result content: application/json: schema: $ref: '#/components/schemas/TransactionInfo' examples: transaction-info: $ref: ./components/examples/get-transaction.example.json '400': $ref: '#/components/responses/BadRequest' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' '501': description: Transaction indexing not enabled content: text/plain: schema: type: string example: Transaction indexing is not enabled /v2/transactions/unconfirmed/{txid}: get: summary: Get unconfirmed transaction tags: - Transactions security: [] operationId: getUnconfirmedTransactionById description: 'Get an unconfirmed transaction by its transaction ID. This looks in both the mempool and unconfirmed microblock stream. ' parameters: - name: txid in: path required: true description: Transaction ID (64 hexadecimal characters) schema: type: string pattern: ^[0-9a-f]{64}$ responses: '200': description: Unconfirmed transaction details content: application/json: schema: $ref: '#/components/schemas/UnconfirmedTransaction' examples: unconfirmed-transaction: summary: Unconfirmed transaction in mempool value: tx: 800000000004... status: Mempool '400': $ref: '#/components/responses/BadRequest' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' /v2/mempool/query: post: summary: Query mempool for missing transactions tags: - Transactions security: [] operationId: queryMempool description: 'Query the mempool for transactions that might be missing from the requesting node. This endpoint supports pagination and streaming of transaction data. ' parameters: - name: page_id in: query description: Transaction ID to start pagination from schema: type: string pattern: ^[0-9a-f]{64}$ requestBody: required: true content: application/octet-stream: schema: type: string format: binary minLength: 1 description: 'Binary SIP-003 encoding of `MemPoolSyncData` (`BloomFilter` or `TxTags` variants). ' responses: '200': description: Stream of missing transactions content: application/octet-stream: schema: type: string format: binary description: 'Binary stream of transactions and pagination data. The stream contains serialized transactions followed by a page ID for continuation. ' '400': $ref: '#/components/responses/BadRequest' '500': $ref: '#/components/responses/InternalServerError' components: schemas: UnconfirmedTransaction: $ref: ./components/schemas/unconfirmed-transaction.schema.yaml TransactionInfo: $ref: ./components/schemas/get-transaction.schema.yaml TransactionSubmissionError: $ref: ./components/schemas/transaction-submission-error.schema.yaml responses: NotFound: description: Not found content: text/plain: schema: type: string example: Not found InternalServerError: description: Internal Server Error content: text/plain: schema: type: string example: Internal Server Error BadRequest: description: Bad request content: text/plain: schema: type: string example: Bad request externalDocs: url: https://github.com/hirosystems/signer-metrics-api description: Source Repository