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

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.

Single Result - This endpoint returns only one single result. POST /blockchain-data/{blockchain}/{network}/transactions/prepare-utxo-transaction

Path Parameters

Required
blockchain string

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

Example : bitcoin

Possible Values : bitcoin bitcoin-cash litecoin dogecoin dash zcash
Required
network 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", "ropsten" are test networks.

Example : testnet

Possible Values : testnet mainnet

Query parameters

Optional
context 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

Request body schema application/json

Optional
context 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
Required
data object
- Required
  item object
  - Optional
    additionalData string
    
    Representation of the additional data.
    
    Example : yourAdditionalDataHere
  - Optional
    locktime integer
    
    Represents the time at which a particular transaction can be added to the blockchain.
    
    Example : 1659001055
  - Required
    xpub string
    
    Defines the account extended publicly known key which is used to derive all child public keys.
    
    Example : tpubDCNoSqt3HF32yq8VU6mgapTuW1FzENZa3C5dKUF6WCQzubWz2nA1yxUhMQWkhhkD58Uc8YiuD8cmB3y5tihqAv4zT2GNyqKTNLchHJmsvt9
  - Required
    fee 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.
    
    Optional
    address string
    
    Representation of the address
    
    Example : tmG2WnrxrpfXxPf5Phk6yPZffqQhezhcUsz
    
    Optional
    exactAmount string
    
    Representation of the exact amount
    
    Example : 0.00458
    
    Optional
    priority string
    
    Representation of the fee priority
    
    Example : standard
    
    Possible Values : slow standard fast
  - Optional
    prepareStrategy string
    
    Representation of the transaction's strategy type
    
    Example : minimize-dust
    
    Possible Values : none minimize-dust optimize-size
  - Required
    recipients array
    Items (object)
    
    Object Array representation of transaction receivers
    
    Required
    address string
    
    Representation of the receiver address
    
    Example : tmHb1bHWAvK6hHDZEq57cbEz2wgxYEMqdbd
    
    Required
    amount string
    
    Representation of the amount
    
    Example : 0.00458
  - Optional
    replaceable boolean
    
    Representation of whether the transaction is replaceable. This is an Optional attribute that is not supported for Dogecoin, Dash and Bitcoin-Cash.
    
    Example : True

Response schema

200 400 401 402 403 409 415 422 429 500

HTTP Status Code: 200
Content-Type: application/json

The resource has been successfully submitted.

Object :
Required
apiVersion string

Specifies the version of the API that incorporates this endpoint.

Example : 2023-04-25
Required
requestId string

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

Example : 601c1710034ed6d407996b30
Optional
context 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
Required
data
object
- Required
  item object
  
  Optional
  additionalData string
  
  Representation of the additional data
  
  Example : yourAdditionalDataHere
  
  Required
  fee string
  
  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.
  
  Example : 0.0000279
  
  Optional
  feePerByte string
  
  Defines the fee per byte value
  
  Example : 0.00000014
  
  Required
  locktime integer
  
  Represents the time at which a particular transaction can be added to the blockchain.
  
  Example : 1781965
  
  Required
  size integer
  
  Represents the total size of this transaction.
  
  Example : 243
  
  Optional
  version integer
  
  Representation of the transaction's version
  
  Example : 2
  
  Required
  blockchainSpecific object One Of
  
  object
  
  Optional
  replaceable boolean
  
  Representation of whether the transaction is replaceable
  
  Example : False
  
  Required
  vin array
  
  Represents the transaction inputs.
  
  Required
  address string
  
  Representation of the address
  
  Example : tb1q8wus03xdv3t6aknmsnpd0jmeu7dgh93j34pj5a
  
  Required
  change integer
  
  Representation of the change value
  
  Example : 0
  
  Required
  derivationIndex integer
  
  Representation of the derivation index of the xpub
  
  Example : 1
  
  Required
  outputIndex integer
  
  Representation of the output index
  
  Example : 1
  
  Required
  satoshis integer
  
  Representation of the satoshis value
  
  Example : 10000
  
  Required
  script string
  
  Representation of the script string
  
  Example : 00143bb907c4cd6457aeda7b84c2d7cb79e79a8b9632
  
  Required
  sighash string
  
  Representation of the hash that should be signed.
  
  Example : 90cfeef03b2755586b8e81668d8009b16b34d48abf2968729892279222e8d893
  
  Required
  transactionId string
  
  Represents the reference transaction identifier.
  
  Example : ff59ac56616ece7498e62c7f9f957cfdd50f6f2a74402058154e3022e7617bf2
  
  Required
  vout array
  
  Represents the transaction outputs.
  
  Required
  address string
  
  Representation of the address
  
  Example : tb1qvx3fynjuctk475vgecetfck005fxh699mflshv
  
  Required
  satoshis integer
  
  Representation of the satoshis value
  
  Example : 3094
  
  Required
  script string
  
  Representation of the script
  
  Example : 0014a3f1019940ce572681c43fd836db97036a85bc8f
  
  object
  
  Required
  vin array
  
  Represents the transaction inputs.
  
  Required
  address string
  
  Representation of the address
  
  Example : bchtest:qqelmepfue2vs2ahmqwd26en6s5uern2duw0v0f8cr
  
  Required
  change integer
  
  Representation of the change value
  
  Example : 0
  
  Required
  derivationIndex integer
  
  Representation of the derivation index of the xpub address.
  
  Example : 0
  
  Required
  outputIndex integer
  
  Representation of the output index
  
  Example : 0
  
  Required
  satoshis integer
  
  Representation of the satoshis value
  
  Example : 10000
  
  Required
  script string
  
  Representation of the script string
  
  Example : 76a91433fde429e654c82bb7d81cd56b33d429cc8e6a6f88ac
  
  Required
  sighash string
  
  Representation of the hash that should be signed.
  
  Example : 73c0e09da473d0fd28715cce2ec6eb0a1c5a72d84e46acd1a02942454d5f1dd1
  
  Required
  transactionId string
  
  Represents the reference transaction identifier.
  
  Example : d4eb833c3e75f8c8f11bcac592c6c31143a0509115e4a5526cedeba76a239bcd
  
  Required
  vout array
  
  Represents the transaction outputs.
  
  Required
  address string
  
  Representation of the address
  
  Example : bchtest:qzhksklst5p5qeer64gf70ssk69st0q3vcpvplqhny
  
  Required
  satoshis integer
  
  Representation of the satoshis value
  
  Example : 5904
  
  Required
  script string
  
  Representation of the script
  
  Example : 76a914af685bf05d03406723d5509f3e10b68b05bc116688ac
  
  object
  
  Optional
  replaceable boolean
  
  Representation of whether the transaction is replaceable
  
  Example : True
  
  Required
  vin array
  
  Represents the transaction inputs.
  
  Required
  address string
  
  Representation of the address
  
  Example : tltc1qky8qd86dtha5l4daspec2cauf2ew58z8gfw6y2
  
  Required
  change integer
  
  Representation of the change value
  
  Example : 0
  
  Required
  derivationIndex integer
  
  Representation of the derivation index of the xpub address.
  
  Example : 0
  
  Required
  outputIndex integer
  
  Representation of the output index
  
  Example : 1
  
  Required
  satoshis integer
  
  Representation of the satoshis value
  
  Example : 10000
  
  Required
  script string
  
  Representation of the script string
  
  Example : 0014b10e069f4d5dfb4fd5bd80738563bc4ab2ea1c47
  
  Required
  sighash string
  
  Representation of the hash that should be signed.
  
  Example : deddbe2c247b054d00f8ab03987ea576171953445e28041b09e732fc0bedcd4e
  
  Required
  transactionId string
  
  Represents the reference transaction identifier.
  
  Example : 9b9cf1d240dcf38c2946dc6c4671993cc7e38bf1d08b084b31332e11b1806683
  
  Required
  vout array
  
  Represents the transaction outputs.
  
  Required
  address string
  
  Representation of the address
  
  Example : n1TynBMCAKzjCDGLnPCRZJXV5DGkij1nro
  
  Required
  satoshis integer
  
  Representation of the satoshis value
  
  Example : 2000
  
  Required
  script string
  
  Representation of the script
  
  Example : 76a914dad281e0d3dab241704ccf86467b8bf7cd77067b88ac
  
  object
  
  Required
  vin array
  
  Represents the transaction inputs.
  
  Required
  address string
  
  Representation of the address
  
  Example : neBSn1hmh62R5gzdwbBf4z8nEVrKtqJkpx
  
  Required
  change integer
  
  Representation of the change value
  
  Example : 1
  
  Required
  derivationIndex integer
  
  Representation of the derivation index of the xpub address.
  
  Example : 100
  
  Required
  outputIndex integer
  
  Representation of the output index
  
  Example : 1
  
  Required
  satoshis integer
  
  Representation of the satoshis value
  
  Example : 100000000
  
  Required
  script string
  
  Representation of the script string
  
  Example : 76a9146d8ea0455263c2589f08ef450dc3759cebd671ba88ac
  
  Required
  sighash string
  
  Representation of the hash that should be signed.
  
  Example : 77ce11bc9a94a17c2361cc3b9d91e871a468df3a7c4d588c82ed790f37fbe2be
  
  Required
  transactionId string
  
  Represents the reference transaction identifier.
  
  Example : 26d90b7d57fd5590a6296360744dc6b21c3c938de3fd5594be9f6f9c9cffa35f
  
  Required
  vout array
  
  Represents the transaction outputs.
  
  Required
  address string
  
  Representation of the address
  
  Example : niDY7k4YsHPpLLF3rWwzmDpsu52j2UTgqS
  
  Required
  satoshis integer
  
  Representation of the satoshis value
  
  Example : 100000000
  
  Required
  script string
  
  Representation of the script
  
  Example : 76a9146d8ea0455263c2589f08ef450dc3759cebd671ba88ac
  
  object
  
  Required
  vin array
  
  Represents the transaction inputs.
  
  Required
  address string
  
  Representation of the address
  
  Example : yLML6bW4d4gF5n3MzYwBNZag5CFaphqVmG
  
  Required
  change integer
  
  Representation of the change value
  
  Example : 0
  
  Required
  derivationIndex integer
  
  Representation of the derivation index of the xpub address.
  
  Example : 1
  
  Required
  outputIndex integer
  
  Representation of the output index
  
  Example : 1
  
  Required
  satoshis integer
  
  Representation of the satoshis value
  
  Example : 912300000
  
  Required
  script string
  
  Representation of the script string
  
  Example : 76a914005b321d7019768e887f604630a4d6b0bdcff5ef88ac
  
  Required
  sighash string
  
  Representation of the hash that should be signed.
  
  Example : ce34bad636f22a18d8712d7d74cfd10fca1888fda1d6d4dcc8f1baf81e266d67
  
  Required
  transactionId string
  
  Represents the reference transaction identifier.
  
  Example : 69612cd50be51af0ad5d3ae2ee30de7d59db45dc9453018f91de7e4ee023ef5d
  
  Required
  vout array
  
  Represents the transaction outputs.
  
  Required
  address string
  
  Representation of the address
  
  Example : yiEkTwAaWxawCF6PA1f1zamxYdYAyooTM1
  
  Required
  satoshis integer
  
  Representation of the satoshis value
  
  Example : 912296178
  
  Required
  script string
  
  Representation of the script
  
  Example : 76a914f06f64804efee250cb9d3702d82203eb48c5a5ae88ac
  
  object
  
  Optional
  replaceable boolean
  
  Representation of whether the transaction is replaceable
  
  Example : False
  
  Required
  vin array
  
  Represents the transaction inputs.
  
  Required
  address string
  
  Representation of the address
  
  Example : tmHb1bHWAvK6hHDZEq57cbEz2wgxYEMqdbd
  
  Required
  change integer
  
  Representation of the change value
  
  Example : 0
  
  Required
  derivationIndex integer
  
  Representation of the derivation index of the xpub address.
  
  Example : 100
  
  Required
  outputIndex integer
  
  Representation of the output index
  
  Example : 1
  
  Required
  satoshis integer
  
  Representation of the satoshis value
  
  Example : 100000000
  
  Required
  script string
  
  Representation of the script string
  
  Example : 76a914565d9ded3c1b02611d94efa1edfd4a65fd4132a588ac
  
  Required
  sighash string
  
  Representation of the hash that should be signed.
  
  Example : c6616518a5b4dd01a9c76d021fafda817d3ea22d2e8f09f7fbae71ad83596e5c
  
  Required
  transactionId string
  
  Represents the reference transaction identifier.
  
  Example : f27ac39bec0e620fc0d5a25b1a3f5d1fd8e8f023234a615c79101db9cc8c58c1
  
  Required
  vout array
  
  Represents the transaction outputs.
  
  Required
  address string
  
  Representation of the address
  
  Example : tmG2WnrxrpfXxPf5Phk6yPZffqQhezhcUsz
  
  Required
  satoshis integer
  
  Representation of the satoshis value
  
  Example : 1000
  
  Required
  script string
  
  Representation of the script
  
  Example : 76a9144540239415ca840c496f146859374125a1ad6f6188ac

Credits Cost : 5000 Credits For 1 Result(s)

Try it out

Request Example

Http Java C# PHP Python Ruby Node.js Go

POST

https://rest.cryptoapis.io/blockchain-data/bitcoin/testnet/transactions/prepare-utxo-transaction?context=yourExampleString

Headers

Content-Type: application/json

X-API-Key: my-api-key

Request Body

{
    "context": "yourExampleString",
    "data": {
        "item": {
            "additionalData": "yourAdditionalDataHere",
            "locktime": 1659001055,
            "xpub": "tpubDCNoSqt3HF32yq8VU6mgapTuW1FzENZa3C5dKUF6WCQzubWz2nA1yxUhMQWkhhkD58Uc8YiuD8cmB3y5tihqAv4zT2GNyqKTNLchHJmsvt9",
            "fee": {
                "address": "tmG2WnrxrpfXxPf5Phk6yPZffqQhezhcUsz",
                "exactAmount": "0.00458",
                "priority": "standard"
            },
            "prepareStrategy": "minimize-dust",
            "recipients": [
                {
                    "address": "tmHb1bHWAvK6hHDZEq57cbEz2wgxYEMqdbd",
                    "amount": "0.00458"
                }
            ],
            "replaceable": true
        }
    }
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"additionalData\": \"yourAdditionalDataHere\",
            \"locktime\": 1659001055,
            \"xpub\": \"tpubDCNoSqt3HF32yq8VU6mgapTuW1FzENZa3C5dKUF6WCQzubWz2nA1yxUhMQWkhhkD58Uc8YiuD8cmB3y5tihqAv4zT2GNyqKTNLchHJmsvt9\",
            \"fee\": {
                \"address\": \"tmG2WnrxrpfXxPf5Phk6yPZffqQhezhcUsz\",
                \"exactAmount\": \"0.00458\",
                \"priority\": \"standard\"
            },
            \"prepareStrategy\": \"minimize-dust\",
            \"recipients\": [
                {
                    \"address\": \"tmHb1bHWAvK6hHDZEq57cbEz2wgxYEMqdbd\",
                    \"amount\": \"0.00458\"
                }
            ],
            \"replaceable\": true
        }
    }
}");
Request request = new Request.Builder()
  .url("https://rest.cryptoapis.io/blockchain-data/bitcoin/testnet/transactions/prepare-utxo-transaction?context=yourExampleString")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("X-API-Key", "my-api-key")
  .build();

Response response = client.newCall(request).execute();

var client = new RestClient("https://rest.cryptoapis.io/blockchain-data/bitcoin/testnet/transactions/prepare-utxo-transaction?context=yourExampleString");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader(""X-API-Key", "my-api-key");
request.AddParameter("application/json", "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"additionalData\": \"yourAdditionalDataHere\",
            \"locktime\": 1659001055,
            \"xpub\": \"tpubDCNoSqt3HF32yq8VU6mgapTuW1FzENZa3C5dKUF6WCQzubWz2nA1yxUhMQWkhhkD58Uc8YiuD8cmB3y5tihqAv4zT2GNyqKTNLchHJmsvt9\",
            \"fee\": {
                \"address\": \"tmG2WnrxrpfXxPf5Phk6yPZffqQhezhcUsz\",
                \"exactAmount\": \"0.00458\",
                \"priority\": \"standard\"
            },
            \"prepareStrategy\": \"minimize-dust\",
            \"recipients\": [
                {
                    \"address\": \"tmHb1bHWAvK6hHDZEq57cbEz2wgxYEMqdbd\",
                    \"amount\": \"0.00458\"
                }
            ],
            \"replaceable\": true
        }
    }
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

$request = new HttpRequest();
$request->setUrl('https://rest.cryptoapis.io/blockchain-data/bitcoin/testnet/transactions/prepare-utxo-transaction?context=yourExampleString');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
    'Content-Type' => 'application/json',
    'X-API-Key' => 'my-api-key'
));

$request->setBody('{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"additionalData\": \"yourAdditionalDataHere\",
            \"locktime\": 1659001055,
            \"xpub\": \"tpubDCNoSqt3HF32yq8VU6mgapTuW1FzENZa3C5dKUF6WCQzubWz2nA1yxUhMQWkhhkD58Uc8YiuD8cmB3y5tihqAv4zT2GNyqKTNLchHJmsvt9\",
            \"fee\": {
                \"address\": \"tmG2WnrxrpfXxPf5Phk6yPZffqQhezhcUsz\",
                \"exactAmount\": \"0.00458\",
                \"priority\": \"standard\"
            },
            \"prepareStrategy\": \"minimize-dust\",
            \"recipients\": [
                {
                    \"address\": \"tmHb1bHWAvK6hHDZEq57cbEz2wgxYEMqdbd\",
                    \"amount\": \"0.00458\"
                }
            ],
            \"replaceable\": true
        }
    }
}');

try {
    $response = $request->send();

    echo $response->getBody();
} catch (HttpException $ex) {
    echo $ex;
}

import http.client

conn = http.client.HTTPConnection("https://rest.cryptoapis.io")

payload = "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"additionalData\": \"yourAdditionalDataHere\",
            \"locktime\": 1659001055,
            \"xpub\": \"tpubDCNoSqt3HF32yq8VU6mgapTuW1FzENZa3C5dKUF6WCQzubWz2nA1yxUhMQWkhhkD58Uc8YiuD8cmB3y5tihqAv4zT2GNyqKTNLchHJmsvt9\",
            \"fee\": {
                \"address\": \"tmG2WnrxrpfXxPf5Phk6yPZffqQhezhcUsz\",
                \"exactAmount\": \"0.00458\",
                \"priority\": \"standard\"
            },
            \"prepareStrategy\": \"minimize-dust\",
            \"recipients\": [
                {
                    \"address\": \"tmHb1bHWAvK6hHDZEq57cbEz2wgxYEMqdbd\",
                    \"amount\": \"0.00458\"
                }
            ],
            \"replaceable\": true
        }
    }
}"
    querystring = {"context":"yourExampleString"}
headers = {
  'Content-Type': "application/json",
  'X-API-Key': "my-api-key"
}

conn.request("POST", "blockchain-data,bitcoin,testnet,transactions,prepare-utxo-transaction",payload, headers=headers  , params=querystring )

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
}

require 'uri'
require 'net/http'

url = URI("https://rest.cryptoapis.io/blockchain-data/bitcoin/testnet/transactions/prepare-utxo-transaction?context=yourExampleString")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["X-API-Key"] = 'my-api-key'
request.body = "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"additionalData\": \"yourAdditionalDataHere\",
            \"locktime\": 1659001055,
            \"xpub\": \"tpubDCNoSqt3HF32yq8VU6mgapTuW1FzENZa3C5dKUF6WCQzubWz2nA1yxUhMQWkhhkD58Uc8YiuD8cmB3y5tihqAv4zT2GNyqKTNLchHJmsvt9\",
            \"fee\": {
                \"address\": \"tmG2WnrxrpfXxPf5Phk6yPZffqQhezhcUsz\",
                \"exactAmount\": \"0.00458\",
                \"priority\": \"standard\"
            },
            \"prepareStrategy\": \"minimize-dust\",
            \"recipients\": [
                {
                    \"address\": \"tmHb1bHWAvK6hHDZEq57cbEz2wgxYEMqdbd\",
                    \"amount\": \"0.00458\"
                }
            ],
            \"replaceable\": true
        }
    }
}"

response = http.request(request)
puts response.read_body

var https = require("https");

var options = {
  "method": "POST",
  "hostname": "rest.cryptoapis.io",
  "path": "/v2/blockchain-data/bitcoin/testnet/transactions/prepare-utxo-transaction",
  "qs": {"context":"yourExampleString"},
  "headers": {
    "Content-Type": "application/json",
    "X-API-Key": "my-api-key"
  }
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
    "context": "yourExampleString",
    "data": {
        "item": {
            "additionalData": "yourAdditionalDataHere",
            "locktime": 1659001055,
            "xpub": "tpubDCNoSqt3HF32yq8VU6mgapTuW1FzENZa3C5dKUF6WCQzubWz2nA1yxUhMQWkhhkD58Uc8YiuD8cmB3y5tihqAv4zT2GNyqKTNLchHJmsvt9",
            "fee": {
                "address": "tmG2WnrxrpfXxPf5Phk6yPZffqQhezhcUsz",
                "exactAmount": "0.00458",
                "priority": "standard"
            },
            "prepareStrategy": "minimize-dust",
            "recipients": [
                {
                    "address": "tmHb1bHWAvK6hHDZEq57cbEz2wgxYEMqdbd",
                    "amount": "0.00458"
                }
            ],
            "replaceable": true
        }
    }
}));

req.end();

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://rest.cryptoapis.io/blockchain-data/bitcoin/testnet/transactions/prepare-utxo-transaction?context=yourExampleString"

  payload := strings.NewReader("{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"additionalData\": \"yourAdditionalDataHere\",
            \"locktime\": 1659001055,
            \"xpub\": \"tpubDCNoSqt3HF32yq8VU6mgapTuW1FzENZa3C5dKUF6WCQzubWz2nA1yxUhMQWkhhkD58Uc8YiuD8cmB3y5tihqAv4zT2GNyqKTNLchHJmsvt9\",
            \"fee\": {
                \"address\": \"tmG2WnrxrpfXxPf5Phk6yPZffqQhezhcUsz\",
                \"exactAmount\": \"0.00458\",
                \"priority\": \"standard\"
            },
            \"prepareStrategy\": \"minimize-dust\",
            \"recipients\": [
                {
                    \"address\": \"tmHb1bHWAvK6hHDZEq57cbEz2wgxYEMqdbd\",
                    \"amount\": \"0.00458\"
                }
            ],
            \"replaceable\": true
        }
    }
}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-API-Key", "my-api-key")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

200 400 401 402 403 409 415 422 429 500

Response Example

{
    "apiVersion": "2023-04-25",
    "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"
                    }
                ]
            }
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "additionalData": "yourAdditionalDataHere",
            "fee": "0.0000279",
            "feePerByte": "0.00000014",
            "locktime": 1781965,
            "size": 243,
            "version": 2,
            "blockchainSpecific": {
                "vin": [
                    {
                        "address": "bchtest:qqelmepfue2vs2ahmqwd26en6s5uern2duw0v0f8cr",
                        "change": 0,
                        "derivationIndex": 0,
                        "outputIndex": 0,
                        "satoshis": 10000,
                        "script": "76a91433fde429e654c82bb7d81cd56b33d429cc8e6a6f88ac",
                        "sighash": "73c0e09da473d0fd28715cce2ec6eb0a1c5a72d84e46acd1a02942454d5f1dd1",
                        "transactionId": "d4eb833c3e75f8c8f11bcac592c6c31143a0509115e4a5526cedeba76a239bcd"
                    }
                ],
                "vout": [
                    {
                        "address": "bchtest:qzhksklst5p5qeer64gf70ssk69st0q3vcpvplqhny",
                        "satoshis": 5904,
                        "script": "76a914af685bf05d03406723d5509f3e10b68b05bc116688ac"
                    }
                ]
            }
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "additionalData": "yourAdditionalDataHere",
            "fee": "0.0000279",
            "feePerByte": "0.00000014",
            "locktime": 1781965,
            "size": 243,
            "version": 2,
            "blockchainSpecific": {
                "replaceable": true,
                "vin": [
                    {
                        "address": "tltc1qky8qd86dtha5l4daspec2cauf2ew58z8gfw6y2",
                        "change": 0,
                        "derivationIndex": 0,
                        "outputIndex": 1,
                        "satoshis": 10000,
                        "script": "0014b10e069f4d5dfb4fd5bd80738563bc4ab2ea1c47",
                        "sighash": "deddbe2c247b054d00f8ab03987ea576171953445e28041b09e732fc0bedcd4e",
                        "transactionId": "9b9cf1d240dcf38c2946dc6c4671993cc7e38bf1d08b084b31332e11b1806683"
                    }
                ],
                "vout": [
                    {
                        "address": "n1TynBMCAKzjCDGLnPCRZJXV5DGkij1nro",
                        "satoshis": 2000,
                        "script": "76a914dad281e0d3dab241704ccf86467b8bf7cd77067b88ac"
                    }
                ]
            }
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "additionalData": "yourAdditionalDataHere",
            "fee": "0.0000279",
            "feePerByte": "0.00000014",
            "locktime": 1781965,
            "size": 243,
            "version": 2,
            "blockchainSpecific": {
                "vin": [
                    {
                        "address": "neBSn1hmh62R5gzdwbBf4z8nEVrKtqJkpx",
                        "change": 1,
                        "derivationIndex": 100,
                        "outputIndex": 1,
                        "satoshis": 100000000,
                        "script": "76a9146d8ea0455263c2589f08ef450dc3759cebd671ba88ac",
                        "sighash": "77ce11bc9a94a17c2361cc3b9d91e871a468df3a7c4d588c82ed790f37fbe2be",
                        "transactionId": "26d90b7d57fd5590a6296360744dc6b21c3c938de3fd5594be9f6f9c9cffa35f"
                    }
                ],
                "vout": [
                    {
                        "address": "niDY7k4YsHPpLLF3rWwzmDpsu52j2UTgqS",
                        "satoshis": 100000000,
                        "script": "76a9146d8ea0455263c2589f08ef450dc3759cebd671ba88ac"
                    }
                ]
            }
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "additionalData": "yourAdditionalDataHere",
            "fee": "0.0000279",
            "feePerByte": "0.00000014",
            "locktime": 1781965,
            "size": 243,
            "version": 2,
            "blockchainSpecific": {
                "vin": [
                    {
                        "address": "yLML6bW4d4gF5n3MzYwBNZag5CFaphqVmG",
                        "change": 0,
                        "derivationIndex": 1,
                        "outputIndex": 1,
                        "satoshis": 912300000,
                        "script": "76a914005b321d7019768e887f604630a4d6b0bdcff5ef88ac",
                        "sighash": "ce34bad636f22a18d8712d7d74cfd10fca1888fda1d6d4dcc8f1baf81e266d67",
                        "transactionId": "69612cd50be51af0ad5d3ae2ee30de7d59db45dc9453018f91de7e4ee023ef5d"
                    }
                ],
                "vout": [
                    {
                        "address": "yiEkTwAaWxawCF6PA1f1zamxYdYAyooTM1",
                        "satoshis": 912296178,
                        "script": "76a914f06f64804efee250cb9d3702d82203eb48c5a5ae88ac"
                    }
                ]
            }
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "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": "tmHb1bHWAvK6hHDZEq57cbEz2wgxYEMqdbd",
                        "change": 0,
                        "derivationIndex": 100,
                        "outputIndex": 1,
                        "satoshis": 100000000,
                        "script": "76a914565d9ded3c1b02611d94efa1edfd4a65fd4132a588ac",
                        "sighash": "c6616518a5b4dd01a9c76d021fafda817d3ea22d2e8f09f7fbae71ad83596e5c",
                        "transactionId": "f27ac39bec0e620fc0d5a25b1a3f5d1fd8e8f023234a615c79101db9cc8c58c1"
                    }
                ],
                "vout": [
                    {
                        "address": "tmG2WnrxrpfXxPf5Phk6yPZffqQhezhcUsz",
                        "satoshis": 1000,
                        "script": "76a9144540239415ca840c496f146859374125a1ad6f6188ac"
                    }
                ]
            }
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "uri_not_found",
        "message": "The specified URI has not been found. Check the URI and try again.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "limit_greater_than_allowed",
        "message": "You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_pagination",
        "message": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "missing_api_key",
        "message": "The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_api_key",
        "message": "The provided API key is invalid. Please, generate a new one from your Dashboard.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "insufficient_credits",
        "message": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "banned_ip_address",
        "message": "This IP address has been banned. To check the reason for that, please contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_plan",
        "message": "This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_api_key",
        "message": "This endpoint is not available for your API key.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "feature_mainnets_not_allowed_for_plan",
        "message": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_data",
        "message": "The data provided seems to be invalid.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unsupported_media_type",
        "message": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_request_body_structure",
        "message": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "request_limit_reached",
        "message": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unexpected_server_error",
        "message": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

Key	Value

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

Path Parameters

Query parameters

Request body schema application/json

Response schema

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Credits Cost : 5000 Credits For 1 Result(s)

Request Example

Response Example

Try It Out API Endpoint