openapi: 3.0.3 info: title: Stacks Mesh API description: A Mesh API (formerly Rosetta API) implementation for the Stacks blockchain version: 0.2.0 components: schemas: {} paths: /network/list: post: tags: - Network requestBody: required: true content: application/json: schema: type: object properties: metadata: type: object additionalProperties: {} responses: "200": description: Default Response content: application/json: schema: type: object required: - network_identifiers properties: network_identifiers: type: array items: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet /network/status: post: tags: - Network requestBody: required: true content: application/json: schema: type: object required: - network_identifier properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet metadata: type: object additionalProperties: {} responses: "200": description: Default Response content: application/json: schema: type: object required: - current_block_identifier - current_block_timestamp - genesis_block_identifier - peers properties: current_block_identifier: type: object required: - index - hash properties: index: type: integer hash: pattern: ^0x[0-9a-fA-F]+$ type: string current_block_timestamp: type: number genesis_block_identifier: type: object required: - index - hash properties: index: type: integer hash: pattern: ^0x[0-9a-fA-F]+$ type: string oldest_block_identifier: type: object required: - index - hash properties: index: type: integer hash: pattern: ^0x[0-9a-fA-F]+$ type: string sync_status: type: object properties: current_index: type: number target_index: type: number stage: type: string synced: type: boolean peers: type: array items: type: object required: - peer_id - metadata properties: peer_id: type: string metadata: type: object required: - ip - port - peer_version - type properties: ip: type: string port: type: number peer_version: type: number type: type: array items: anyOf: - type: string enum: - bootstrap - type: string enum: - sample - type: string enum: - inbound - type: string enum: - outbound "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /network/options: post: tags: - Network requestBody: required: true content: application/json: schema: type: object required: - network_identifier properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet metadata: type: object additionalProperties: {} responses: "200": description: Default Response content: application/json: schema: type: object required: - version - allow properties: version: type: object required: - rosetta_version - node_version properties: rosetta_version: type: string node_version: type: string middleware_version: type: string metadata: type: object additionalProperties: {} allow: type: object required: - operation_statuses - operation_types - errors - historical_balance_lookup - call_methods - balance_exemptions - mempool_coins properties: operation_statuses: type: array items: type: object required: - status - successful properties: status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect successful: type: boolean operation_types: type: array items: type: string errors: type: array items: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} historical_balance_lookup: type: boolean timestamp_start_index: type: number call_methods: type: array items: type: string balance_exemptions: type: array items: type: object properties: sub_account_address: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft exemption_type: anyOf: - type: string enum: - greater_or_equal - type: string enum: - less_or_equal - type: string enum: - dynamic mempool_coins: type: boolean block_hash_case: anyOf: - type: string enum: - upper_case - type: string enum: - lower_case - type: string enum: - case_sensitive - type: string enum: - "null" transaction_hash_case: anyOf: - type: string enum: - upper_case - type: string enum: - lower_case - type: string enum: - case_sensitive - type: string enum: - "null" "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /block: post: tags: - Block requestBody: required: true content: application/json: schema: type: object required: - network_identifier - block_identifier properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet block_identifier: type: object properties: index: type: integer hash: pattern: ^0x[0-9a-fA-F]+$ type: string responses: "200": description: Default Response content: application/json: schema: type: object properties: block: type: object required: - block_identifier - parent_block_identifier - timestamp - transactions properties: block_identifier: type: object required: - index - hash properties: index: type: integer hash: pattern: ^0x[0-9a-fA-F]+$ type: string parent_block_identifier: type: object required: - index - hash properties: index: type: integer hash: pattern: ^0x[0-9a-fA-F]+$ type: string timestamp: type: integer transactions: type: array items: type: object required: - transaction_identifier - operations - metadata properties: transaction_identifier: type: object required: - hash properties: hash: pattern: ^0x[0-9a-fA-F]+$ type: string operations: type: array items: anyOf: - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - coinbase metadata: type: object required: - alt_recipient - vrf_proof properties: alt_recipient: anyOf: - type: string - type: "null" vrf_proof: anyOf: - type: string - type: "null" - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - contract_call metadata: type: object required: - args - contract_identifier - function_name properties: args: anyOf: - type: array items: type: object required: - hex - repr - type - name properties: hex: type: string repr: type: string type: type: string name: type: string - anyOf: - type: string - type: "null" contract_identifier: type: string function_name: type: string - type: object required: - operation_identifier - status - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect type: type: string enum: - contract_log metadata: type: object required: - contract_identifier - topic - value properties: contract_identifier: type: string topic: type: string value: anyOf: - type: string - type: object required: - hex - repr - type properties: hex: type: string repr: type: string type: type: string - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - delegate_stack_extend metadata: type: object required: - locked - balance - burnchain_unlock_height - extend_count - delegator - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string extend_count: type: integer delegator: type: string start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - delegate_stack_increase metadata: type: object required: - locked - balance - burnchain_unlock_height - delegator - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string delegator: type: string start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - delegate_stack_stx metadata: type: object required: - locked - balance - burnchain_unlock_height - lock_period - delegator - burnchain_start_height - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string lock_period: type: string delegator: type: string burnchain_start_height: anyOf: - type: integer - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - delegate_stx metadata: type: object required: - locked - balance - burnchain_unlock_height - delegate_to - unlock_burn_height - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string delegate_to: type: string unlock_burn_height: anyOf: - type: integer - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - fee metadata: type: object required: - sponsored properties: sponsored: type: boolean - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - handle_unlock metadata: type: object required: - locked - balance - burnchain_unlock_height - first_cycle_locked - first_unlocked_cycle properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string first_cycle_locked: type: integer first_unlocked_cycle: type: integer - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - poison_microblock metadata: type: object required: - microblock_header_1 - microblock_header_2 properties: microblock_header_1: type: string microblock_header_2: type: string - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - revoke_delegate_stx metadata: type: object required: - locked - balance - burnchain_unlock_height - delegate_to - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string delegate_to: type: string start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - contract_deploy metadata: type: object required: - contract_identifier - clarity_version properties: contract_identifier: type: string clarity_version: anyOf: - type: integer - type: "null" source_code: type: string abi: type: string - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_aggregation_commit_indexed metadata: type: object required: - locked - balance - burnchain_unlock_height - reward_cycle - signer_key - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string reward_cycle: type: integer signer_key: anyOf: - type: string - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_aggregation_commit metadata: type: object required: - locked - balance - burnchain_unlock_height - reward_cycle - signer_key - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string reward_cycle: type: integer signer_key: anyOf: - type: string - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_aggregation_increase metadata: type: object required: - locked - balance - burnchain_unlock_height - reward_cycle - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string reward_cycle: type: integer start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - stack_extend metadata: type: object required: - locked - balance - burnchain_unlock_height - extend_count - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string extend_count: type: integer start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_increase metadata: type: object required: - locked - balance - burnchain_unlock_height - signer_key - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string signer_key: anyOf: - type: string - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_stx metadata: type: object required: - locked - balance - burnchain_unlock_height - lock_period - burnchain_start_height - signer_key - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string lock_period: type: integer burnchain_start_height: type: integer signer_key: anyOf: - type: string - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stx_lock metadata: type: object required: - unlock_height - locked_address - contract_name properties: unlock_height: type: integer locked_address: type: string contract_name: type: string - type: object required: - operation_identifier - status - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect type: type: string enum: - tenure_change metadata: type: object required: - tenure_consensus_hash - prev_tenure_consensus_hash - burn_view_consensus_hash - previous_tenure_end - previous_tenure_blocks - cause - pubkey_hash properties: tenure_consensus_hash: type: string prev_tenure_consensus_hash: type: string burn_view_consensus_hash: type: string previous_tenure_end: type: string previous_tenure_blocks: type: integer cause: 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: type: string - type: object required: - operation_identifier - status - account - amount - type properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - token_burn - type: object required: - operation_identifier - status - account - amount - type properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - token_mint - type: object required: - operation_identifier - status - account - amount - type properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - token_transfer metadata: type: object required: - memo properties: memo: anyOf: - type: string - type: "null" metadata: type: object required: - canonical - execution_cost - fee_rate - nonce - type - position - result - sender_address - sponsor_address - sponsored - status - vm_error properties: canonical: type: boolean microblock_canonical: type: boolean execution_cost: type: object required: - read_count - read_length - runtime - write_count - write_length properties: read_count: type: integer read_length: type: integer runtime: type: integer write_count: type: integer write_length: type: integer fee_rate: type: string nonce: type: integer type: anyOf: - type: string enum: - coinbase - type: string enum: - token_transfer - type: string enum: - poison_microblock - type: string enum: - contract_deploy - type: string enum: - tenure_change - type: string enum: - contract_call post_conditions: type: object required: - mode - post_conditions properties: mode: anyOf: - type: string enum: - allow - type: string enum: - deny post_conditions: type: array items: anyOf: - type: object required: - type - condition_code - amount - principal properties: type: type: string enum: - stx condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string principal: anyOf: - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - contract_name - address properties: type_id: type: string enum: - principal_contract contract_name: type: string address: type: string - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type - condition_code - amount - principal - asset properties: type: type: string enum: - fungible condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string principal: anyOf: - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - contract_name - address properties: type_id: type: string enum: - principal_contract contract_name: type: string address: type: string - type: object required: - type_id properties: type_id: type: string enum: - principal_origin asset: type: object required: - contract_name - asset_name - contract_address properties: contract_name: type: string asset_name: type: string contract_address: type: string - type: object required: - type - condition_code - principal - asset - asset_value properties: type: type: string enum: - non_fungible condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent principal: anyOf: - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - contract_name - address properties: type_id: type: string enum: - principal_contract contract_name: type: string address: type: string - type: object required: - type_id properties: type_id: type: string enum: - principal_origin asset: type: object required: - contract_name - asset_name - contract_address properties: contract_name: type: string asset_name: type: string contract_address: type: string asset_value: type: object required: - hex - repr properties: hex: type: string repr: type: string position: type: object required: - index properties: index: type: integer microblock_identifier: type: object required: - index - hash properties: index: type: integer hash: pattern: ^0x[0-9a-fA-F]+$ type: string raw_tx: type: string result: anyOf: - type: string - type: object required: - hex - repr properties: hex: type: string repr: type: string sender_address: type: string sponsor_address: anyOf: - type: string - type: "null" sponsored: type: boolean status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect vm_error: anyOf: - type: string - type: "null" metadata: type: object required: - canonical properties: canonical: type: boolean burn_block_identifier: type: object required: - index - hash properties: index: type: integer hash: pattern: ^0x[0-9a-fA-F]+$ type: string burn_block_timestamp: type: integer parent_microblock_identifier: type: object required: - index - hash properties: index: type: integer hash: pattern: ^0x[0-9a-fA-F]+$ type: string tenure_height: type: integer execution_cost: type: object required: - read_count - read_length - runtime - write_count - write_length properties: read_count: type: integer read_length: type: integer runtime: type: integer write_count: type: integer write_length: type: integer tx_total_size: type: integer tx_count: type: integer signatures: type: object required: - signer_bitvec - signer_signatures properties: signer_bitvec: anyOf: - type: string - type: "null" signer_signatures: anyOf: - type: array items: type: string - type: "null" other_transactions: type: array items: type: object required: - hash properties: hash: pattern: ^0x[0-9a-fA-F]+$ type: string "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /block/transaction: post: tags: - Block requestBody: required: true content: application/json: schema: type: object required: - network_identifier - block_identifier - transaction_identifier properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet block_identifier: type: object properties: index: type: integer hash: pattern: ^0x[0-9a-fA-F]+$ type: string transaction_identifier: type: object required: - hash properties: hash: pattern: ^0x[0-9a-fA-F]+$ type: string responses: "200": description: Default Response content: application/json: schema: type: object required: - transaction properties: transaction: type: object required: - transaction_identifier - operations - metadata properties: transaction_identifier: type: object required: - hash properties: hash: pattern: ^0x[0-9a-fA-F]+$ type: string operations: type: array items: anyOf: - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - coinbase metadata: type: object required: - alt_recipient - vrf_proof properties: alt_recipient: anyOf: - type: string - type: "null" vrf_proof: anyOf: - type: string - type: "null" - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - contract_call metadata: type: object required: - args - contract_identifier - function_name properties: args: anyOf: - type: array items: type: object required: - hex - repr - type - name properties: hex: type: string repr: type: string type: type: string name: type: string - anyOf: - type: string - type: "null" contract_identifier: type: string function_name: type: string - type: object required: - operation_identifier - status - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect type: type: string enum: - contract_log metadata: type: object required: - contract_identifier - topic - value properties: contract_identifier: type: string topic: type: string value: anyOf: - type: string - type: object required: - hex - repr - type properties: hex: type: string repr: type: string type: type: string - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - delegate_stack_extend metadata: type: object required: - locked - balance - burnchain_unlock_height - extend_count - delegator - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string extend_count: type: integer delegator: type: string start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - delegate_stack_increase metadata: type: object required: - locked - balance - burnchain_unlock_height - delegator - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string delegator: type: string start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - delegate_stack_stx metadata: type: object required: - locked - balance - burnchain_unlock_height - lock_period - delegator - burnchain_start_height - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string lock_period: type: string delegator: type: string burnchain_start_height: anyOf: - type: integer - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - delegate_stx metadata: type: object required: - locked - balance - burnchain_unlock_height - delegate_to - unlock_burn_height - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string delegate_to: type: string unlock_burn_height: anyOf: - type: integer - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - fee metadata: type: object required: - sponsored properties: sponsored: type: boolean - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - handle_unlock metadata: type: object required: - locked - balance - burnchain_unlock_height - first_cycle_locked - first_unlocked_cycle properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string first_cycle_locked: type: integer first_unlocked_cycle: type: integer - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - poison_microblock metadata: type: object required: - microblock_header_1 - microblock_header_2 properties: microblock_header_1: type: string microblock_header_2: type: string - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - revoke_delegate_stx metadata: type: object required: - locked - balance - burnchain_unlock_height - delegate_to - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string delegate_to: type: string start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - contract_deploy metadata: type: object required: - contract_identifier - clarity_version properties: contract_identifier: type: string clarity_version: anyOf: - type: integer - type: "null" source_code: type: string abi: type: string - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_aggregation_commit_indexed metadata: type: object required: - locked - balance - burnchain_unlock_height - reward_cycle - signer_key - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string reward_cycle: type: integer signer_key: anyOf: - type: string - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_aggregation_commit metadata: type: object required: - locked - balance - burnchain_unlock_height - reward_cycle - signer_key - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string reward_cycle: type: integer signer_key: anyOf: - type: string - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_aggregation_increase metadata: type: object required: - locked - balance - burnchain_unlock_height - reward_cycle - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string reward_cycle: type: integer start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - stack_extend metadata: type: object required: - locked - balance - burnchain_unlock_height - extend_count - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string extend_count: type: integer start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_increase metadata: type: object required: - locked - balance - burnchain_unlock_height - signer_key - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string signer_key: anyOf: - type: string - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_stx metadata: type: object required: - locked - balance - burnchain_unlock_height - lock_period - burnchain_start_height - signer_key - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string lock_period: type: integer burnchain_start_height: type: integer signer_key: anyOf: - type: string - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stx_lock metadata: type: object required: - unlock_height - locked_address - contract_name properties: unlock_height: type: integer locked_address: type: string contract_name: type: string - type: object required: - operation_identifier - status - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect type: type: string enum: - tenure_change metadata: type: object required: - tenure_consensus_hash - prev_tenure_consensus_hash - burn_view_consensus_hash - previous_tenure_end - previous_tenure_blocks - cause - pubkey_hash properties: tenure_consensus_hash: type: string prev_tenure_consensus_hash: type: string burn_view_consensus_hash: type: string previous_tenure_end: type: string previous_tenure_blocks: type: integer cause: 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: type: string - type: object required: - operation_identifier - status - account - amount - type properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - token_burn - type: object required: - operation_identifier - status - account - amount - type properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - token_mint - type: object required: - operation_identifier - status - account - amount - type properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - token_transfer metadata: type: object required: - memo properties: memo: anyOf: - type: string - type: "null" metadata: type: object required: - canonical - execution_cost - fee_rate - nonce - type - position - result - sender_address - sponsor_address - sponsored - status - vm_error properties: canonical: type: boolean microblock_canonical: type: boolean execution_cost: type: object required: - read_count - read_length - runtime - write_count - write_length properties: read_count: type: integer read_length: type: integer runtime: type: integer write_count: type: integer write_length: type: integer fee_rate: type: string nonce: type: integer type: anyOf: - type: string enum: - coinbase - type: string enum: - token_transfer - type: string enum: - poison_microblock - type: string enum: - contract_deploy - type: string enum: - tenure_change - type: string enum: - contract_call post_conditions: type: object required: - mode - post_conditions properties: mode: anyOf: - type: string enum: - allow - type: string enum: - deny post_conditions: type: array items: anyOf: - type: object required: - type - condition_code - amount - principal properties: type: type: string enum: - stx condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string principal: anyOf: - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - contract_name - address properties: type_id: type: string enum: - principal_contract contract_name: type: string address: type: string - type: object required: - type_id properties: type_id: type: string enum: - principal_origin - type: object required: - type - condition_code - amount - principal - asset properties: type: type: string enum: - fungible condition_code: anyOf: - type: string enum: - sent_equal_to - type: string enum: - sent_greater_than - type: string enum: - sent_greater_than_or_equal_to - type: string enum: - sent_less_than - type: string enum: - sent_less_than_or_equal_to amount: type: string principal: anyOf: - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - contract_name - address properties: type_id: type: string enum: - principal_contract contract_name: type: string address: type: string - type: object required: - type_id properties: type_id: type: string enum: - principal_origin asset: type: object required: - contract_name - asset_name - contract_address properties: contract_name: type: string asset_name: type: string contract_address: type: string - type: object required: - type - condition_code - principal - asset - asset_value properties: type: type: string enum: - non_fungible condition_code: anyOf: - type: string enum: - sent - type: string enum: - not_sent principal: anyOf: - type: object required: - type_id - address properties: type_id: type: string enum: - principal_standard address: type: string - type: object required: - type_id - contract_name - address properties: type_id: type: string enum: - principal_contract contract_name: type: string address: type: string - type: object required: - type_id properties: type_id: type: string enum: - principal_origin asset: type: object required: - contract_name - asset_name - contract_address properties: contract_name: type: string asset_name: type: string contract_address: type: string asset_value: type: object required: - hex - repr properties: hex: type: string repr: type: string position: type: object required: - index properties: index: type: integer microblock_identifier: type: object required: - index - hash properties: index: type: integer hash: pattern: ^0x[0-9a-fA-F]+$ type: string raw_tx: type: string result: anyOf: - type: string - type: object required: - hex - repr properties: hex: type: string repr: type: string sender_address: type: string sponsor_address: anyOf: - type: string - type: "null" sponsored: type: boolean status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect vm_error: anyOf: - type: string - type: "null" "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /account/balance: post: tags: - Account requestBody: required: true content: application/json: schema: type: object required: - network_identifier - account_identifier properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet account_identifier: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} block_identifier: type: object properties: index: type: integer hash: pattern: ^0x[0-9a-fA-F]+$ type: string currencies: type: array items: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft responses: "200": description: Default Response content: application/json: schema: type: object required: - block_identifier - balances properties: block_identifier: type: object required: - index - hash properties: index: type: integer hash: pattern: ^0x[0-9a-fA-F]+$ type: string balances: type: array items: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft metadata: type: object additionalProperties: {} "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /account/coins: post: tags: - Account requestBody: required: true content: application/json: schema: type: object required: - network_identifier - account_identifier - include_mempool properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet account_identifier: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} include_mempool: type: boolean currencies: type: array items: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft responses: "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /mempool: post: tags: - Mempool requestBody: required: true content: application/json: schema: type: object required: - network_identifier properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet responses: "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /mempool/transaction: post: tags: - Mempool requestBody: required: true content: application/json: schema: type: object required: - network_identifier - transaction_identifier properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet transaction_identifier: type: object required: - hash properties: hash: pattern: ^0x[0-9a-fA-F]+$ type: string responses: "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /construction/derive: post: tags: - Construction requestBody: required: true content: application/json: schema: type: object required: - network_identifier - public_key properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet public_key: type: object required: - hex_bytes - curve_type properties: hex_bytes: pattern: ^0x[0-9a-fA-F]+$ type: string curve_type: type: string enum: - secp256k1 responses: "200": description: Default Response content: application/json: schema: type: object properties: address: type: string account_identifier: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /construction/preprocess: post: tags: - Construction requestBody: required: true content: application/json: schema: type: object required: - network_identifier - operations properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet operations: type: array items: anyOf: - type: object required: - operation_identifier - type - account - amount properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer type: type: string enum: - token_transfer account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft metadata: type: object required: - memo properties: memo: anyOf: - type: string - type: "null" - type: object required: - operation_identifier - type - account - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer type: type: string enum: - contract_call account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} metadata: type: object required: - contract_identifier - function_name - args properties: contract_identifier: type: string function_name: type: string args: type: array items: type: string - type: object required: - operation_identifier - type - account - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer type: type: string enum: - contract_deploy account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} metadata: type: object required: - contract_name - source_code properties: contract_name: type: string clarity_version: type: integer source_code: type: string - type: object required: - operation_identifier - type - account - amount properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer type: type: string enum: - fee account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft max_fee: type: array items: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft suggested_fee_multiplier: type: number responses: "200": description: Default Response content: application/json: schema: type: object properties: options: anyOf: - type: object required: - sender_address - type - contract_identifier - function_name - args properties: sender_address: type: string max_fee: type: string suggested_fee_multiplier: type: number type: type: string enum: - contract_call contract_identifier: type: string function_name: type: string args: type: array items: type: string - type: object required: - sender_address - type - recipient_address - amount properties: sender_address: type: string max_fee: type: string suggested_fee_multiplier: type: number type: type: string enum: - token_transfer recipient_address: type: string amount: type: string memo: type: string - type: object required: - sender_address - type - contract_name - source_code properties: sender_address: type: string max_fee: type: string suggested_fee_multiplier: type: number type: type: string enum: - contract_deploy contract_name: type: string clarity_version: type: integer source_code: type: string required_public_keys: type: array items: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /construction/metadata: post: tags: - Construction requestBody: required: true content: application/json: schema: type: object required: - network_identifier - options - public_keys properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet options: anyOf: - type: object required: - sender_address - type - contract_identifier - function_name - args properties: sender_address: type: string max_fee: type: string suggested_fee_multiplier: type: number type: type: string enum: - contract_call contract_identifier: type: string function_name: type: string args: type: array items: type: string - type: object required: - sender_address - type - recipient_address - amount properties: sender_address: type: string max_fee: type: string suggested_fee_multiplier: type: number type: type: string enum: - token_transfer recipient_address: type: string amount: type: string memo: type: string - type: object required: - sender_address - type - contract_name - source_code properties: sender_address: type: string max_fee: type: string suggested_fee_multiplier: type: number type: type: string enum: - contract_deploy contract_name: type: string clarity_version: type: integer source_code: type: string public_keys: minItems: 1 type: array items: type: object required: - hex_bytes - curve_type properties: hex_bytes: pattern: ^0x[0-9a-fA-F]+$ type: string curve_type: type: string enum: - secp256k1 responses: "200": description: Default Response content: application/json: schema: type: object required: - metadata properties: metadata: type: object required: - options - sender_account_info properties: options: anyOf: - type: object required: - sender_address - type - contract_identifier - function_name - args properties: sender_address: type: string max_fee: type: string suggested_fee_multiplier: type: number type: type: string enum: - contract_call contract_identifier: type: string function_name: type: string args: type: array items: type: string - type: object required: - sender_address - type - recipient_address - amount properties: sender_address: type: string max_fee: type: string suggested_fee_multiplier: type: number type: type: string enum: - token_transfer recipient_address: type: string amount: type: string memo: type: string - type: object required: - sender_address - type - contract_name - source_code properties: sender_address: type: string max_fee: type: string suggested_fee_multiplier: type: number type: type: string enum: - contract_deploy contract_name: type: string clarity_version: type: integer source_code: type: string sender_account_info: type: object required: - nonce - balance properties: nonce: type: number balance: type: string suggested_fee: type: array items: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /construction/payloads: post: tags: - Construction requestBody: required: true content: application/json: schema: type: object required: - network_identifier - operations - metadata - public_keys properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet operations: type: array items: anyOf: - type: object required: - operation_identifier - type - account - amount properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer type: type: string enum: - token_transfer account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft metadata: type: object required: - memo properties: memo: anyOf: - type: string - type: "null" - type: object required: - operation_identifier - type - account - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer type: type: string enum: - contract_call account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} metadata: type: object required: - contract_identifier - function_name - args properties: contract_identifier: type: string function_name: type: string args: type: array items: type: string - type: object required: - operation_identifier - type - account - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer type: type: string enum: - contract_deploy account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} metadata: type: object required: - contract_name - source_code properties: contract_name: type: string clarity_version: type: integer source_code: type: string - type: object required: - operation_identifier - type - account - amount properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer type: type: string enum: - fee account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft metadata: type: object required: - options - sender_account_info properties: options: anyOf: - type: object required: - sender_address - type - contract_identifier - function_name - args properties: sender_address: type: string max_fee: type: string suggested_fee_multiplier: type: number type: type: string enum: - contract_call contract_identifier: type: string function_name: type: string args: type: array items: type: string - type: object required: - sender_address - type - recipient_address - amount properties: sender_address: type: string max_fee: type: string suggested_fee_multiplier: type: number type: type: string enum: - token_transfer recipient_address: type: string amount: type: string memo: type: string - type: object required: - sender_address - type - contract_name - source_code properties: sender_address: type: string max_fee: type: string suggested_fee_multiplier: type: number type: type: string enum: - contract_deploy contract_name: type: string clarity_version: type: integer source_code: type: string sender_account_info: type: object required: - nonce - balance properties: nonce: type: number balance: type: string public_keys: minItems: 1 type: array items: type: object required: - hex_bytes - curve_type properties: hex_bytes: pattern: ^0x[0-9a-fA-F]+$ type: string curve_type: type: string enum: - secp256k1 responses: "200": description: Default Response content: application/json: schema: type: object required: - unsigned_transaction - payloads properties: unsigned_transaction: pattern: ^0x[0-9a-fA-F]+$ type: string payloads: type: array items: type: object required: - address - account_identifier - hex_bytes - signature_type properties: address: type: string account_identifier: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} hex_bytes: pattern: ^0x[0-9a-fA-F]+$ type: string signature_type: type: string enum: - ecdsa_recovery "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /construction/combine: post: tags: - Construction requestBody: required: true content: application/json: schema: type: object required: - network_identifier - unsigned_transaction - signatures properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet unsigned_transaction: pattern: ^0x[0-9a-fA-F]+$ type: string signatures: minItems: 1 type: array items: type: object required: - signing_payload - public_key - signature_type - hex_bytes properties: signing_payload: type: object required: - address - account_identifier - hex_bytes - signature_type properties: address: type: string account_identifier: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} hex_bytes: pattern: ^0x[0-9a-fA-F]+$ type: string signature_type: type: string enum: - ecdsa_recovery public_key: type: object required: - hex_bytes - curve_type properties: hex_bytes: pattern: ^0x[0-9a-fA-F]+$ type: string curve_type: type: string enum: - secp256k1 signature_type: type: string enum: - ecdsa_recovery hex_bytes: pattern: ^0x[0-9a-fA-F]+$ type: string responses: "200": description: Default Response content: application/json: schema: type: object required: - signed_transaction properties: signed_transaction: pattern: ^0x[0-9a-fA-F]+$ type: string "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /construction/parse: post: tags: - Construction requestBody: required: true content: application/json: schema: type: object required: - network_identifier - signed - transaction properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet signed: type: boolean transaction: pattern: ^0x[0-9a-fA-F]+$ type: string responses: "200": description: Default Response content: application/json: schema: type: object required: - operations properties: operations: type: array items: anyOf: - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - coinbase metadata: type: object required: - alt_recipient - vrf_proof properties: alt_recipient: anyOf: - type: string - type: "null" vrf_proof: anyOf: - type: string - type: "null" - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - contract_call metadata: type: object required: - args - contract_identifier - function_name properties: args: anyOf: - type: array items: type: object required: - hex - repr - type - name properties: hex: type: string repr: type: string type: type: string name: type: string - anyOf: - type: string - type: "null" contract_identifier: type: string function_name: type: string - type: object required: - operation_identifier - status - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect type: type: string enum: - contract_log metadata: type: object required: - contract_identifier - topic - value properties: contract_identifier: type: string topic: type: string value: anyOf: - type: string - type: object required: - hex - repr - type properties: hex: type: string repr: type: string type: type: string - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - delegate_stack_extend metadata: type: object required: - locked - balance - burnchain_unlock_height - extend_count - delegator - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string extend_count: type: integer delegator: type: string start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - delegate_stack_increase metadata: type: object required: - locked - balance - burnchain_unlock_height - delegator - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string delegator: type: string start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - delegate_stack_stx metadata: type: object required: - locked - balance - burnchain_unlock_height - lock_period - delegator - burnchain_start_height - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string lock_period: type: string delegator: type: string burnchain_start_height: anyOf: - type: integer - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - delegate_stx metadata: type: object required: - locked - balance - burnchain_unlock_height - delegate_to - unlock_burn_height - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string delegate_to: type: string unlock_burn_height: anyOf: - type: integer - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - fee metadata: type: object required: - sponsored properties: sponsored: type: boolean - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - handle_unlock metadata: type: object required: - locked - balance - burnchain_unlock_height - first_cycle_locked - first_unlocked_cycle properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string first_cycle_locked: type: integer first_unlocked_cycle: type: integer - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - poison_microblock metadata: type: object required: - microblock_header_1 - microblock_header_2 properties: microblock_header_1: type: string microblock_header_2: type: string - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - revoke_delegate_stx metadata: type: object required: - locked - balance - burnchain_unlock_height - delegate_to - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string delegate_to: type: string start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - contract_deploy metadata: type: object required: - contract_identifier - clarity_version properties: contract_identifier: type: string clarity_version: anyOf: - type: integer - type: "null" source_code: type: string abi: type: string - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_aggregation_commit_indexed metadata: type: object required: - locked - balance - burnchain_unlock_height - reward_cycle - signer_key - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string reward_cycle: type: integer signer_key: anyOf: - type: string - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_aggregation_commit metadata: type: object required: - locked - balance - burnchain_unlock_height - reward_cycle - signer_key - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string reward_cycle: type: integer signer_key: anyOf: - type: string - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_aggregation_increase metadata: type: object required: - locked - balance - burnchain_unlock_height - reward_cycle - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string reward_cycle: type: integer start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} type: type: string enum: - stack_extend metadata: type: object required: - locked - balance - burnchain_unlock_height - extend_count - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string extend_count: type: integer start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_increase metadata: type: object required: - locked - balance - burnchain_unlock_height - signer_key - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string signer_key: anyOf: - type: string - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stack_stx metadata: type: object required: - locked - balance - burnchain_unlock_height - lock_period - burnchain_start_height - signer_key - start_cycle_id - end_cycle_id properties: locked: type: string balance: type: string burnchain_unlock_height: type: integer pox_addr: type: string pox_addr_raw: type: string lock_period: type: integer burnchain_start_height: type: integer signer_key: anyOf: - type: string - type: "null" start_cycle_id: anyOf: - type: integer - type: "null" end_cycle_id: anyOf: - type: integer - type: "null" - type: object required: - operation_identifier - status - account - amount - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - stx_lock metadata: type: object required: - unlock_height - locked_address - contract_name properties: unlock_height: type: integer locked_address: type: string contract_name: type: string - type: object required: - operation_identifier - status - type - metadata properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect type: type: string enum: - tenure_change metadata: type: object required: - tenure_consensus_hash - prev_tenure_consensus_hash - burn_view_consensus_hash - previous_tenure_end - previous_tenure_blocks - cause - pubkey_hash properties: tenure_consensus_hash: type: string prev_tenure_consensus_hash: type: string burn_view_consensus_hash: type: string previous_tenure_end: type: string previous_tenure_blocks: type: integer cause: 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: type: string - type: object required: - operation_identifier - status - account - amount - type properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - token_burn - type: object required: - operation_identifier - status - account - amount - type properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - token_mint - type: object required: - operation_identifier - status - account - amount - type properties: operation_identifier: type: object required: - index properties: index: type: integer network_index: type: integer status: anyOf: - type: string enum: - pending - type: string enum: - success - type: string enum: - abort_by_response - type: string enum: - abort_by_post_condition - type: string enum: - dropped_replace_by_fee - type: string enum: - dropped_replace_across_fork - type: string enum: - dropped_too_expensive - type: string enum: - dropped_problematic - type: string enum: - dropped_stale_garbage_collect account: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} amount: type: object required: - value - currency properties: value: type: string currency: type: object required: - symbol - decimals properties: symbol: type: string decimals: type: integer metadata: type: object required: - asset_identifier - token_type properties: asset_identifier: anyOf: - type: string - type: "null" name: type: string value: type: string token_type: anyOf: - type: string enum: - ft - type: string enum: - nft type: type: string enum: - token_transfer metadata: type: object required: - memo properties: memo: anyOf: - type: string - type: "null" signers: type: array items: type: string account_identifier_signers: type: array items: type: object required: - address properties: address: anyOf: - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$ type: string - pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}$ type: string sub_account: type: object required: - address properties: address: type: string metadata: type: object additionalProperties: {} metadata: type: object additionalProperties: {} "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /construction/hash: post: tags: - Construction requestBody: required: true content: application/json: schema: type: object required: - network_identifier - signed_transaction properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet signed_transaction: pattern: ^0x[0-9a-fA-F]+$ type: string responses: "200": description: Default Response content: application/json: schema: type: object required: - transaction_identifier properties: transaction_identifier: type: object required: - hash properties: hash: pattern: ^0x[0-9a-fA-F]+$ type: string metadata: type: object additionalProperties: {} "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /construction/submit: post: tags: - Construction requestBody: required: true content: application/json: schema: type: object required: - network_identifier - signed_transaction properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet signed_transaction: pattern: ^0x[0-9a-fA-F]+$ type: string responses: "200": description: Default Response content: application/json: schema: type: object required: - transaction_identifier properties: transaction_identifier: type: object required: - hash properties: hash: pattern: ^0x[0-9a-fA-F]+$ type: string metadata: type: object additionalProperties: {} "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} /call: post: tags: - Call requestBody: required: true content: application/json: schema: anyOf: - type: object required: - network_identifier - method - parameters properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet method: type: string enum: - contract_call_read_only parameters: type: object required: - deployer_address - contract_name - function_name - sender - arguments properties: deployer_address: type: string contract_name: type: string function_name: type: string sender: type: string sponsor: type: string arguments: type: array items: type: string - type: object required: - network_identifier - method - parameters properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet method: type: string enum: - contract_get_interface parameters: type: object required: - deployer_address - contract_name properties: deployer_address: type: string contract_name: type: string - type: object required: - network_identifier - method - parameters properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet method: type: string enum: - contract_get_source parameters: type: object required: - deployer_address - contract_name properties: deployer_address: type: string contract_name: type: string - type: object required: - network_identifier - method - parameters properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet method: type: string enum: - contract_get_constant_val parameters: type: object required: - deployer_address - contract_name - constant_name properties: deployer_address: type: string contract_name: type: string constant_name: type: string - type: object required: - network_identifier - method - parameters properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet method: type: string enum: - contract_get_data_var parameters: type: object required: - deployer_address - contract_name - var_name properties: deployer_address: type: string contract_name: type: string var_name: type: string - type: object required: - network_identifier - method - parameters properties: network_identifier: type: object required: - blockchain - network properties: blockchain: type: string enum: - stacks network: anyOf: - type: string enum: - mainnet - type: string enum: - testnet method: type: string enum: - contract_get_map_entry parameters: type: object required: - deployer_address - contract_name - map_name - key properties: deployer_address: type: string contract_name: type: string map_name: type: string key: type: string responses: "200": description: Default Response content: application/json: schema: anyOf: - type: object required: - idempotent - result properties: idempotent: type: boolean result: type: object required: - hex - repr - type properties: hex: type: string repr: type: string type: type: string - type: object required: - idempotent - result properties: idempotent: type: boolean result: type: object additionalProperties: {} - type: object required: - idempotent - result properties: idempotent: type: boolean result: type: object required: - source - publish_height properties: source: type: string publish_height: type: integer proof: type: string - type: object required: - idempotent - result properties: idempotent: type: boolean result: type: object required: - hex - repr - type properties: hex: type: string repr: type: string type: type: string - type: object required: - idempotent - result properties: idempotent: type: boolean result: type: object required: - okay - result properties: okay: type: boolean enum: - true result: type: object required: - data properties: data: type: string proof: type: string - type: object required: - idempotent - result properties: idempotent: type: boolean result: type: object required: - okay - result properties: okay: type: boolean enum: - true result: type: object required: - data properties: data: type: string proof: type: string "500": description: Default Response content: application/json: schema: type: object required: - code - message - retriable properties: code: type: number message: type: string description: type: string retriable: type: boolean details: type: object additionalProperties: {} servers: - url: http://localhost:3000 description: Local tags: - name: Network description: Network endpoints - name: Block description: Block endpoints - name: Account description: Account endpoints - name: Mempool description: Mempool endpoints - name: Construction description: Construction endpoints - name: Call description: Call endpoints externalDocs: url: https://github.com/stx-labs/stacks-mesh-api description: Source Repository