Create a Request to Fetch Metadata

TODO

Request Body — REQUIRED
network_identifier object — REQUIRED The network_identifier specifies which network a particular object is associated with. blockchain string — REQUIRED Blockchain name network string — REQUIRED If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet. sub_network_identifier object In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains. network string — REQUIRED Network name metadata object Meta data from subnetwork identifier producer string — REQUIRED producer
operations object[] — REQUIRED operation_identifier object — REQUIRED The operation_identifier uniquely identifies an operation within a transaction. index integer — REQUIRED The operation index is used to ensure each operation has a unique identifier within a transaction. This index is only relative to the transaction and NOT GLOBAL. The operations in each transaction should start from index 0. To clarify, there may not be any notion of an operation index in the blockchain being described. network_index integer Some blockchains specify an operation index that is essential for client use. For example, Bitcoin uses a network_index to identify which UTXO was used in a transaction. network_index should not be populated if there is no notion of an operation index in a blockchain (typically most account-based blockchains). related_operations object[] Restrict referenced related_operations to identifier indexes < the current operation_identifier.index. This ensures there exists a clear DAG-structure of relations. Since operations are one-sided, one could imagine relating operations in a single transfer or linking operations in a call tree. index integer — REQUIRED Describes the index of related operation. network_index integer Some blockchains specify an operation index that is essential for client use. network_index should not be populated if there is no notion of an operation index in a blockchain (typically most account-based blockchains). type string — REQUIRED The network-specific type of the operation. Ensure that any type that can be returned here is also specified in the NetworkStatus. This can be very useful to downstream consumers that parse all block data. status string The network-specific status of the operation. Status is not defined on the transaction object because blockchains with smart contracts may have transactions that partially apply. Blockchains with atomic transactions (all operations succeed or all operations fail) will have the same status for each operation. account object The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated). address string — REQUIRED The address may be a cryptographic public key (or some encoding of it) or a provided username. sub_account object An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to. address string — REQUIRED The address may be a cryptographic public key (or some encoding of it) or a provided username. metadata object If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients. metadata object Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata. amount object Amount is some Value of a Currency. It is considered invalid to specify a Value without a Currency. value string — REQUIRED Value of the transaction in atomic units represented as an arbitrary-sized signed integer. For example, 1 BTC would be represented by a value of 100000000. currency object — REQUIRED Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (Satoshis) to standard units (Bitcoins). symbol string — REQUIRED Canonical symbol associated with a currency. decimals integer — REQUIRED Number of decimal places in the standard unit representation of the amount. For example, BTC has 8 decimals. Note that it is not possible to represent the value of some currency in atomic units that is not base 10. metadata object Any additional information related to the currency itself. For example, it would be useful to populate this object with the contract address of an ERC-20 token. metadata object coin_change object CoinChange is used to represent a change in state of a some coin identified by a coin_identifier. This object is part of the Operation model and must be populated for UTXO-based blockchains. Coincidentally, this abstraction of UTXOs allows for supporting both account-based transfers and UTXO-based transfers on the same blockchain (when a transfer is account-based, don't populate this model). coin_identifier object — REQUIRED CoinIdentifier uniquely identifies a Coin. identifier string — REQUIRED Identifier should be populated with a globally unique identifier of a Coin. In Bitcoin, this identifier would be transaction_hash:index. coin_action string — REQUIRED Possible values: [coin_created, coin_spent] CoinActions are different state changes that a Coin can undergo. When a Coin is created, it is coin_created. When a Coin is spent, it is coin_spent. It is assumed that a single Coin cannot be created or spent more than once. metadata object Operations Meta Data
metadata object
max_fee object[] value string — REQUIRED Value of the transaction in atomic units represented as an arbitrary-sized signed integer. For example, 1 BTC would be represented by a value of 100000000. currency object — REQUIRED Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (Satoshis) to standard units (Bitcoins). symbol string — REQUIRED Canonical symbol associated with a currency. decimals integer — REQUIRED Number of decimal places in the standard unit representation of the amount. For example, BTC has 8 decimals. Note that it is not possible to represent the value of some currency in atomic units that is not base 10. metadata object Any additional information related to the currency itself. For example, it would be useful to populate this object with the contract address of an ERC-20 token. metadata object
suggested_fee_multiplier integer The caller can also provide a suggested fee multiplier to indicate that the suggested fee should be scaled. This may be used to set higher fees for urgent transactions or to pay lower fees when there is less urgency. It is assumed that providing a very low multiplier (like 0.0001) will never lead to a transaction being created with a fee less than the minimum network fee (if applicable). In the case that the caller provides both a max fee and a suggested fee multiplier, the max fee will set an upper bound on the suggested fee (regardless of the multiplier provided).

Responses
200 Success Schema — OPTIONAL options object — OPTIONAL The options that will be sent directly to /construction/metadata by the caller. sender_address string — OPTIONAL sender's address type string — OPTIONAL Type of operation e.g transfer status string — OPTIONAL This value indicates the state of the operations token_transfer_recipient_address string — OPTIONAL Recipient's address amount string — OPTIONAL Amount to be transfered. symbol string — OPTIONAL Currency symbol e.g STX decimals integer — OPTIONAL Number of decimal places gas_limit number — OPTIONAL Maximum price a user is willing to pay. gas_price number — OPTIONAL Cost necessary to perform a transaction on the network suggested_fee_multiplier number — OPTIONAL A suggested fee multiplier to indicate that the suggested fee should be scaled. This may be used to set higher fees for urgent transactions or to pay lower fees when there is less urgency. max_fee string — OPTIONAL Maximum fee user is willing to pay fee string — OPTIONAL Fee for this transaction size integer — OPTIONAL Transaction approximative size (used to calculate total fee). memo string — OPTIONAL STX token transfer memo. number_of_cycles integer — OPTIONAL Number of cycles when stacking. contract_address string — OPTIONAL Address of the contract to call. contract_name string — OPTIONAL Name of the contract to call. burn_block_height integer — OPTIONAL Set the burnchain (BTC) block for stacking lock to start. reward_cycle_id integer — OPTIONAL The reward cycle ID for stacking transaction. delegate_to string — OPTIONAL Delegator address for when calling delegate-stacking. pox_addr string — OPTIONAL The reward address for stacking transaction. It should be a valid Bitcoin address signer_key string — OPTIONAL The hex-encoded signer key (buff 33) for PoX. signer_private_key string — OPTIONAL The hex-encoded signer private key for PoX. Specify either this or signer_signature, otherwise the PoX transaction requires allow-listing from the signer. signer_signature string — OPTIONAL The hex-encoded signer signature for PoX. Specify either this or signer_private_key, otherwise the PoX transaction requires allow-listing from the signer. pox_max_amount string — OPTIONAL The maximum amount of STX to stack for PoX. If not specified, the amount will be used as the max-amount for the PoX transaction. pox_auth_id string — OPTIONAL The auth ID for the PoX transaction. If not specified, a random value will be generated. required_public_keys object[] — OPTIONAL address string The address may be a cryptographic public key (or some encoding of it) or a provided username. sub_account object — OPTIONAL An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to. address string The address may be a cryptographic public key (or some encoding of it) or a provided username. metadata object — OPTIONAL If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients. metadata object — OPTIONAL Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata.
400 Error Schema — OPTIONAL code integer Code is a network-specific error code. If desired, this code can be equivalent to an HTTP status code. message string Message is a network-specific error message. The message MUST NOT change for a given code. In particular, this means that any contextual information should be included in the details field. retriable boolean An error is retriable if the same request may succeed if submitted again. details object — OPTIONAL Often times it is useful to return context specific to the request that caused the error (i.e. a sample of the stack trace or impacted account) in addition to the standard error message. address string — OPTIONAL error string — OPTIONAL