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

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 networks like "testnet", "sepolia" are test networks.

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.

amount string Required

Representation of the amount of the transaction

recipient string Required

Represents a list of recipient addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.

sender string Required

Represents a sender address with the respective amount. In account-based protocols like Ethereum there is only one address in this list.

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.

exactAmount string Optional

String representation of the exact amount

priority string Required

Enum representation of the fee priority

nonce string Optional

Representation of the nonce value

transactionType string Optional

Representation of the transaction type. For Ethereum-Classic and Binance Smart Chain there is no need to provide "transactionType" in the request.

sequence string Required

String representation of the sequence

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

amount string Required

Representation of the amount of the transaction

0.000003

recipient string Required

Represents a recipient addresses. In account-based protocols like Ethereum there is only one address in this list.

0x041c594a0cc194e826bef5411b29c7f27001b7e3

sender string Required

Represents a sender address with the respective amount. In account-based protocols like Ethereum there is only one address in this list.

0x03654A9E78771442CAdf8DB37ae60D6a12bAEa9f

sigHash string Required

Representation of the hash that should be signed.

40738814e379fd2b1923729c87ac80dddc6810a3f8f02fef05452251972ec83a

blockchainSpecific object Required

dataHex string Required

Representation of the data in hex value

0x0079006f00750072004100640064006900740069006f006e0061006c00440061007400610048006500720065

derivationIndex integer Required

Representation of the derivation index of the xpub address

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.

gasLimit string Required

Represents the amount of gas used by this specific transaction alone.

552020

gasPrice string Required

Represents the price offered to the miner to purchase this amount of gas.

2500000007

maxFeePerGas string Required

Representation of the max fee per gas value

2000000008

maxPriorityFeePerGas string Required

Representation of the max priority fee per gas value

2000000000

nonce string Required

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.

transactionType string Required

Representation of the transaction type

legacy-transaction

unit string Required

Represents the unit of the amount to be sent.

WEI

dataHex string Required

Representation of the data in hex value

0x0079006f00750072004100640064006900740069006f006e0061006c00440061007400610048006500720065

derivationIndex integer Required

Representation of the derivation index of the xpub address

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.

gasLimit string Required

Represents the amount of gas used by this specific transaction alone.

552020

gasPrice string Optional

Represents the price offered to the miner to purchase this amount of gas.

2500000007

nonce string Required

transactionType string Required

Representation of the transaction type

legacy-transaction

unit string Required

Represents the unit of the amount to be sent.

BNB

dataHex string Required

Representation of the data in hex value

0x0079006f00750072004100640064006900740069006f006e0061006c00440061007400610048006500720065

derivationIndex integer Required

Representation of the derivation index of the xpub address

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.

gasLimit string Required

Represents the amount of gas used by this specific transaction alone.

21000

gasPrice string Required

Represents the price offered to the miner to purchase this amount of gas.

2000000000

nonce string Required

transactionType string Required

Representation of the transaction type

legacy-transaction

unit string Required

Represents the unit of the amount to be sent.

WEI

data string Required

String representation of the data

000000000000000000000000b6d4181ff1e6a1c4f9e480b2696576c4c8c2508c0000000000000000000000000000000000000000000000000000000004f27ac0

derivationIndex string Required

Representation of the derivation index of the xpub address

expiration integer Required

Rrepresentation of the expiration value

1666098830000

rawData object Optional

Defines the transactions' raw data information

contract object Required

Defines the contract information

parameter object Required

Defines the contract parameter

amount string Required

String representation of the amount

rawDataHex string Required

Representation of the raw data in hex format

0a029759220830c83aa1c96f007540f0a4b1d9be305a65080112610a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412300a1541d1df5daa4666a5e9f1aae399dc88ec970b23729d121541ede830672838f5096ba2388f2edbeec762f140dc180370ae9ed3b0be30

recipient string Required

Rrepresentation of the recipients' address

TXf9JJVsAoGRHUKyhyKbbgcR6F59AN8tgg

refBlockBytes string Required

Representation of the block bytes

988f

refBlockHash string Required

Representation of the block hash refference

ba4cba4757883442

sender string Required

Representation of the sender

41c36a60df8cf3adf2be1d786800db7ea6dba36578

timestamp integer Required

Representation of the timestamp

1666013402728

transactionId string Required

Represents the reference transaction identifier.

aea90d9be36108ed5ef821c840418d03ccc4f9cd7e5be5eb9021d588c172a36d

type string Required

Representation of the transfer type.

TransferContract

typeUrl string Required

Representation of the URL

exampleTypeUrl

unit string Required

Represents the unit of the amount to be sent.

TRX

visible boolean Required

Representation of the address visibility

true

derivationIndex integer Required

Representation of the derivation index of the xpub address

100

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.

feeInDrops string Required

Representation of the fee in drops value

feeInXrp string Required

Representation of the fee in XRP

0.000018

publicKey string Required

Representation of the public key.

03e2f48ffe9b2a3dcdcfe60a308c89fd0658b18a9507f45bd3ab1e152f8b6eb05f

sequence string Required

Representation of the sequence

31715632

unit string Required

Represents the unit of the amount to be sent.

XRP

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

code string Required

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

limit_greater_than_allowed

message string Required

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

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

code string Required

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

invalid_pagination

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 pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.

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.

missing_api_key

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 specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.

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

code string Required

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

invalid_api_key

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 provided API key is invalid. Please, generate a new one from your Dashboard.

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

insufficient_credits

code string Required

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

insufficient_credits

message string Required

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

You have insufficient credits. Please upgrade your plan from your Dashboard or 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

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

code string Required

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

endpoint_not_allowed_for_plan

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 endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.

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

code string Required

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

endpoint_not_allowed_for_api_key

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 endpoint is not available for your API key.

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

code string Required

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

feature_mainnets_not_allowed_for_plan

message string Required

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

Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.

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

invalid_data

code string Required

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

invalid_data

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 data provided seems to be invalid.

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

unsupported_media_type

code string Required

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

unsupported_media_type

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 selected Media Type is unavailable. The Content-Type header should be 'application/json'.

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

invalid_request_body_structure

code string Required

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

invalid_request_body_structure

message string Required

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

Your request body for POST requests must have a structure of { data: { item: [...properties] } }

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

request_limit_reached

code string Required

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

request_limit_reached

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

unexpected_server_error

code string Required

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

unexpected_server_error

message string Required

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

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 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",
            "amount": "0.000003",
            "recipient": "0x041c594a0cc194e826bef5411b29c7f27001b7e3",
            "sender": "0x03654A9E78771442CAdf8DB37ae60D6a12bAEa9f",
            "xpub": "xpub6CsGdqTDEVRnLmpWN218HBwJqfhqSx46iA8ByzEA5Bz9jfwU3TSg9U7ambKgJyykvCraHQ6sAFAddMGFdPzhXrRanKbHnnkbDTyRPyn5gRJ",
            "fee": {
                "exactAmount": "0.00045",
                "priority": "standard"
            },
            "nonce": "0",
            "transactionType": "access-list-transaction",
            "sequence": "31715632"
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "amount": "0.000003",
            "recipient": "0x041c594a0cc194e826bef5411b29c7f27001b7e3",
            "sender": "0x03654A9E78771442CAdf8DB37ae60D6a12bAEa9f",
            "sigHash": "40738814e379fd2b1923729c87ac80dddc6810a3f8f02fef05452251972ec83a",
            "blockchainSpecific": {
                "dataHex": "0x0079006f00750072004100640064006900740069006f006e0061006c00440061007400610048006500720065",
                "derivationIndex": 0,
                "fee": {
                    "gasLimit": "552020",
                    "gasPrice": "2500000007",
                    "maxFeePerGas": "2000000008",
                    "maxPriorityFeePerGas": "2000000000"
                },
                "nonce": "0",
                "transactionType": "legacy-transaction",
                "unit": "WEI"
            }
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "amount": "0.000003",
            "recipient": "0x041c594a0cc194e826bef5411b29c7f27001b7e3",
            "sender": "0x03654A9E78771442CAdf8DB37ae60D6a12bAEa9f",
            "sigHash": "40738814e379fd2b1923729c87ac80dddc6810a3f8f02fef05452251972ec83a",
            "blockchainSpecific": {
                "dataHex": "0x0079006f00750072004100640064006900740069006f006e0061006c00440061007400610048006500720065",
                "derivationIndex": 0,
                "fee": {
                    "gasLimit": "552020",
                    "gasPrice": "2500000007"
                },
                "nonce": "0",
                "transactionType": "legacy-transaction",
                "unit": "BNB"
            }
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "amount": "0.000003",
            "recipient": "0x041c594a0cc194e826bef5411b29c7f27001b7e3",
            "sender": "0x03654A9E78771442CAdf8DB37ae60D6a12bAEa9f",
            "sigHash": "40738814e379fd2b1923729c87ac80dddc6810a3f8f02fef05452251972ec83a",
            "blockchainSpecific": {
                "dataHex": "0x0079006f00750072004100640064006900740069006f006e0061006c00440061007400610048006500720065",
                "derivationIndex": 0,
                "fee": {
                    "gasLimit": "21000",
                    "gasPrice": "2000000000"
                },
                "nonce": "0",
                "transactionType": "legacy-transaction",
                "unit": "WEI"
            }
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "amount": "0.000003",
            "recipient": "0x041c594a0cc194e826bef5411b29c7f27001b7e3",
            "sender": "0x03654A9E78771442CAdf8DB37ae60D6a12bAEa9f",
            "sigHash": "40738814e379fd2b1923729c87ac80dddc6810a3f8f02fef05452251972ec83a",
            "blockchainSpecific": {
                "data": "000000000000000000000000b6d4181ff1e6a1c4f9e480b2696576c4c8c2508c0000000000000000000000000000000000000000000000000000000004f27ac0",
                "derivationIndex": "0",
                "expiration": 1666098830000,
                "rawData": {
                    "contract": {
                        "parameter": {
                            "amount": "3"
                        }
                    }
                },
                "rawDataHex": "0a029759220830c83aa1c96f007540f0a4b1d9be305a65080112610a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412300a1541d1df5daa4666a5e9f1aae399dc88ec970b23729d121541ede830672838f5096ba2388f2edbeec762f140dc180370ae9ed3b0be30",
                "recipient": "TXf9JJVsAoGRHUKyhyKbbgcR6F59AN8tgg",
                "refBlockBytes": "988f",
                "refBlockHash": "ba4cba4757883442",
                "sender": "41c36a60df8cf3adf2be1d786800db7ea6dba36578",
                "timestamp": 1666013402728,
                "transactionId": "aea90d9be36108ed5ef821c840418d03ccc4f9cd7e5be5eb9021d588c172a36d",
                "type": "TransferContract",
                "typeUrl": "exampleTypeUrl",
                "unit": "TRX",
                "visible": true
            }
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "amount": "0.000003",
            "recipient": "0x041c594a0cc194e826bef5411b29c7f27001b7e3",
            "sender": "0x03654A9E78771442CAdf8DB37ae60D6a12bAEa9f",
            "sigHash": "40738814e379fd2b1923729c87ac80dddc6810a3f8f02fef05452251972ec83a",
            "blockchainSpecific": {
                "derivationIndex": 100,
                "fee": {
                    "feeInDrops": "18",
                    "feeInXrp": "0.000018"
                },
                "publicKey": "03e2f48ffe9b2a3dcdcfe60a308c89fd0658b18a9507f45bd3ab1e152f8b6eb05f",
                "sequence": "31715632",
                "unit": "XRP"
            }
        }
    }
}

{
    "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 Transaction From An Address In 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