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

Sync HD Wallet (xPub, yPub, zPub)

POST

/blockchain-data/{blockchain}/{network}/hd/sync

HD wallets usually have a lot of addresses and transactions, getting the data on demand is a heavy operation. That's why we have created this feature, to be able to get HD wallet details or transactions this HD wallet must be synced first. In addition to the initial sync we keep updating the synced HD wallets all the time.

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

extendedPublicKey string Required

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

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

extendedPublicKey string Required

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

upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ

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

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.

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

Credits Cost : 500 Credits for 1 Results

Was this page helpful?

Yes

Language

URL

               {
    "context": "yourExampleString",
    "data": {
        "item": {
            "extendedPublicKey": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ"
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "extendedPublicKey": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ"
        }
    }
}

{
    "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": "invalid_blockchain",
        "message": "Invalid blockchain! Blockchain MUST be one of: {validBlockchains}",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_network",
        "message": "The provided network is invalid. The network **must** be a supported one. For the full list of supported networks please see 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": "xpub_not_synced",
        "message": "This xPub is not yet synced, please first use endpoint \u201cSync HD (xPub, yPub, zPub) wallet\u201d to synchronize 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_xpub",
        "message": "The provided Xpub is invalid.",
        "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": "already_exists",
        "message": "The specified resource already exists.",
        "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": "xpub_sync_in_progress",
        "message": "Your wallet (xPub, yPub, zPub) is still syncing, it should take few seconds depending on how many transactions it has.",
        "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"
            }
        ]
    }
}

Sync HD Wallet (xPub, yPub, zPub)

Path Parameters

Query Parameters

Request Body Schema application/json

Response Schema

Credits Cost : 500 Credits for 1 Results

Security schema

URL Schema

Request