Prepare A Transaction From An Address In HD Wallet (xPub, yPub, zPub)
Through this endpoint users can prepare a transaction for signing from a synced with Crypto APIs address from the specific xPub. This endpoint applies to all supported account-based blockchain protocols, e.g. Ethereum, BSC, etc.
Path Parameters
-
Requiredblockchain string
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
-
Requirednetwork string
Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "goerli" are test networks.
Query parameters
-
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.
Request body schema application/json
-
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user. -
Requireddata object
-
Requireditem object
-
OptionaladditionalData string
Representation of the additional data.
-
Requiredamount string
Representation of the amount of the transaction
-
Requiredrecipient string
Represents a list of recipient addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.
-
Requiredsender string
Represents a sender address with the respective amount. In account-based protocols like Ethereum there is only one address in this list.
-
Requiredxpub string
Defines the account extended publicly known key which is used to derive all child public keys.
-
Requiredfee object
When isConfirmed is True - Defines the amount of the transaction fee When isConfirmed is False - For ETH-based blockchains this attribute represents the max fee value.
-
OptionalexactAmount string
String representation of the exact amount
-
Requiredpriority string
Enum representation of the fee priority
-
-
Optionalnonce string
Representation of the nonce value
-
OptionaltransactionType string
Representation of the transaction type. For Ethereum-Classic and Binance Smart Chain there is no need to provide "transactionType" in the request.
-
Requiredsequence string
String representation of the sequence
-
-
Response schema
Content-Type: application/json
The resource has been successfully submitted.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requireddata object
-
Requireditem object
-
Requiredamount string
Representation of the amount of the transaction
Example : 0.000003 -
Requiredrecipient string
Represents a recipient addresses. In account-based protocols like Ethereum there is only one address in this list.
Example : 0x041c594a0cc194e826bef5411b29c7f27001b7e3 -
Requiredsender string
Represents a sender address with the respective amount. In account-based protocols like Ethereum there is only one address in this list.
Example : 0x03654A9E78771442CAdf8DB37ae60D6a12bAEa9f -
RequiredsigHash string
Representation of the hash that should be signed.
Example : 40738814e379fd2b1923729c87ac80dddc6810a3f8f02fef05452251972ec83a -
RequiredblockchainSpecific object One Ofobject
-
RequireddataHex string
Representation of the data in hex value
Example : 0x0079006f00750072004100640064006900740069006f006e0061006c00440061007400610048006500720065 -
RequiredderivationIndex integer
Representation of the derivation index of the xpub address
Example : 0 -
Requiredfee object
When isConfirmed is True - Defines the amount of the transaction fee When isConfirmed is False - For ETH-based blockchains this attribute represents the max fee value.
-
RequiredgasLimit string
Represents the amount of gas used by this specific transaction alone.
Example : 552020 -
RequiredgasPrice string
Represents the price offered to the miner to purchase this amount of gas.
Example : 2500000007 -
RequiredmaxFeePerGas string
Representation of the max fee per gas value
Example : 2000000008 -
RequiredmaxPriorityFeePerGas string
Representation of the max priority fee per gas value
Example : 2000000000
-
-
Requirednonce string
Represents the sequential running number for an address, starting from 0 for the first transaction. E.g., if the nonce of a transaction is 10, it would be the 11th transaction sent from the sender's address.
Example : 0 -
RequiredtransactionType string
Representation of the transaction type
Example : legacy-transaction -
Requiredunit string
Represents the unit of the amount to be sent.
Example : WEI
-
-
-