v1 .2023-04-25

Jump to

Ctrl

General Information

REST APIs

Wallet as a Service

Generating

Transactions

Informative

Blockchain Data

Unified Endpoints

Tokens

Internal

HD Wallets

Solana

XRP (Ripple)

Blockchain Events

Create Subscriptions for

Manage Subscriptions

Blockchain Automations

Automatic Coins Forwarding

Delete Automatic Coins Forwarding

DELETE

Automatic Tokens Forwarding

Blockchain Tools

Features

Market Data

Metadata

List Supported Assets

GET

Exchange Rates

Assets

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

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.

2023-04-25

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

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

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

derivationIndex integer Required

Representation of the derivation index of the xpub

outputIndex integer Required

Representation of the output index

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

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2023-04-25

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

yourExampleString

error object Required

code string Required

Specifies an error code, e.g. error 404.

uri_not_found

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

The specified URI has not been found. Check the URI and try again.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2023-04-25

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

yourExampleString

error object Required

code string Required

Specifies an error code, e.g. error 404.

banned_ip_address

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

This IP address has been banned. To check the reason for that, please contact our team via email.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

Credits Cost : 2500 Credits for 1 Results

Was this page helpful?

Yes

Language

URL

               {
    "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
        }
    }
}

{
    "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"
            }
        ]
    }
}

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

Path Parameters

Query Parameters

Request Body Schema application/json

Response Schema

Credits Cost : 2500 Credits for 1 Results

Security schema

URL Schema

Request