Jump to
Ctrl
+
/

Prepare A UTXO-Based Transaction From HD Wallet (xPub, yPub, zPub)

POST
/blockchain-data/{blockchain}/{network}/transactions/prepare-utxo-transaction

Through the “Prepare a UTXO-based transaction from xPub” endpoint users can prepare a transaction for signing from all synced with Crypto APIs addresses for the specific xPub. This is based on the selectionStrategy and the addresses’ balances. In the case a user has an address not synced with Crypto APIs, it will not be included. This endpoint applies to all supported UTXO-based blockchain protocols, e.g. Bitcoin, Litecoin, etc.

Path Parameters

blockchain string Required

Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

network string Required

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 network like "testnet" is a test network.

Query Parameters

context string Optional

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

context string Optional

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.

data object Required
item object Required
additionalData string Optional

Representation of the additional data.

locktime integer Optional

Represents the time at which a particular transaction can be added to the blockchain.

xpub string Required

Defines the account extended publicly known key which is used to derive all child public keys.

fee object Required

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.

address string Optional

Representation of the address

exactAmount string Optional

Representation of the exact amount

priority string Optional

Representation of the fee priority

prepareStrategy string Optional

Representation of the transaction's strategy type

recipients array Items (object) Required

Object Array representation of transaction receivers

address string Required

Representation of the receiver address

amount string Required

Representation of the amount

replaceable boolean Optional

Representation of whether the transaction is replaceable. This is an Optional attribute that is not supported for Dogecoin, Dash and Bitcoin-Cash.

Response Schema

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2021-03-20
requestId string Required

Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

601c1710034ed6d407996b30
context string Optional

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.

yourExampleString
data object Required
item object Required
additionalData string Optional

Representation of the additional data

yourAdditionalDataHere
fee string Required

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.

0.0000279
feePerByte string Optional

Defines the fee per byte value

0.00000014
locktime integer Required

Represents the time at which a particular transaction can be added to the blockchain.

1781965
size integer Required

Represents the total size of this transaction.

243
version integer Optional

Representation of the transaction's version

2
blockchainSpecific object Required
replaceable boolean Optional

Representation of whether the transaction is replaceable

false
vin array Items (object) Required

Represents the transaction inputs.

address string Required

Representation of the address

tb1q8wus03xdv3t6aknmsnpd0jmeu7dgh93j34pj5a
change integer Required

Representation of the change value

0
derivationIndex integer Required

Representation of the derivation index of the xpub

1
outputIndex integer Required

Representation of the output index

1
satoshis integer Required

Representation of the satoshis value

10000
script string Required

Representation of the script string

00143bb907c4cd6457aeda7b84c2d7cb79e79a8b9632
sighash string Required

Representation of the hash that should be signed.

90cfeef03b2755586b8e81668d8009b16b34d48abf2968729892279222e8d893
transactionId string Required

Represents the reference transaction identifier.

ff59ac56616ece7498e62c7f9f957cfdd50f6f2a74402058154e3022e7617bf2
vout array Items (object) Required

Represents the transaction outputs.

address string Required

Representation of the address

tb1qvx3fynjuctk475vgecetfck005fxh699mflshv
satoshis integer Required

Representation of the satoshis value

3094
script string Required

Representation of the script

0014a3f1019940ce572681c43fd836db97036a85bc8f

Credits Cost : 5000 Credits for 1 Results

Was this page helpful?
Yes
No
Language
URL

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "additionalData": "yourAdditionalDataHere",
            "fee": "0.0000279",
            "feePerByte": "0.00000014",
            "locktime": 1781965,
            "size": 243,
            "version": 2,
            "blockchainSpecific": {
                "replaceable": false,
                "vin": [
                    {
                        "address": "tb1q8wus03xdv3t6aknmsnpd0jmeu7dgh93j34pj5a",
                        "change": 0,
                        "derivationIndex": 1,
                        "outputIndex": 1,
                        "satoshis": 10000,
                        "script": "00143bb907c4cd6457aeda7b84c2d7cb79e79a8b9632",
                        "sighash": "90cfeef03b2755586b8e81668d8009b16b34d48abf2968729892279222e8d893",
                        "transactionId": "ff59ac56616ece7498e62c7f9f957cfdd50f6f2a74402058154e3022e7617bf2"
                    }
                ],
                "vout": [
                    {
                        "address": "tb1qvx3fynjuctk475vgecetfck005fxh699mflshv",
                        "satoshis": 3094,
                        "script": "0014a3f1019940ce572681c43fd836db97036a85bc8f"
                    }
                ]
            }
        }
    }
}