Sync New HD Wallet (xPub, yPub, zPub)
Through this endpoint users can add a brand new xPub to the Crypto APIs system to be ready for deriving. Unlike our other similar endpoint “Sync HD Wallet (xPub, yPub, zPub)”, this endpoint does not create new addresses nor syncs old data.
Path Parameters
-
Requiredblockchain string
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
Example : bitcoinPossible Values : bitcoin bitcoin-cash litecoin dogecoin dash ethereum zcash ethereum-classic binance-smart-chain xrp tron -
Requirednetwork 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 : testnetPossible Values : mainnet testnet mordor nile goerli
Query parameters
-
Optionalcontext 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
-
Optionalcontext 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 -
Requireddata object
-
Requireditem object
-
RequiredextendedPublicKey string
Defines the account extended publicly known key which is used to derive all child public keys.
Example : upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ
-
-
Response schema
Content-Type: application/json
The resource has been successfully created.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext 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 -
Requireddata object
-
Requireditem object
-
RequiredextendedPublicKey string
Defines the account extended publicly known key which is used to derive all child public keys.
Example : upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ
-
-
Content-Type: application/json
400
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext 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 -
Requirederror object One Ofobject
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : uri_not_found -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The specified URI has not been found. Check the URI and try again. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : limit_greater_than_allowed -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : 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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_pagination -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_blockchain -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : Invalid blockchain! Blockchain MUST be one of: {validBlockchains} -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_network -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The provided network is invalid. The network **must** be a supported one. For the full list of supported networks please see our Documentation. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : xpub_not_synced -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : This xPub is not yet synced, please first use endpoint “Sync HD (xPub, yPub, zPub) wallet” to synchronize it. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_xpub -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The provided Xpub is invalid. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
401
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext 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 -
Requirederror object One Ofobject
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : missing_api_key -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_api_key -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The provided API key is invalid. Please, generate a new one from your Dashboard. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext 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 -
Requirederror object
insufficient_credits
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : insufficient_credits -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
403
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext 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 -
Requirederror object One Ofobject
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : banned_ip_address -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : This IP address has been banned. To check the reason for that, please contact our team via email. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : endpoint_not_allowed_for_plan -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : endpoint_not_allowed_for_api_key -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : This endpoint is not available for your API key. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : feature_mainnets_not_allowed_for_plan -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
409
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext 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 -
Requirederror object One Ofobject
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_data -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The data provided seems to be invalid. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : already_exists -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The specified resource already exists. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
The selected Media Type is unavailable. The Content-Type header should be 'application/json'.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext 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 -
Requirederror object
unsupported_media_type
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : unsupported_media_type -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The selected Media Type is unavailable. The Content-Type header should be 'application/json'. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
422
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext 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 -
Requirederror object One Ofobject
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_request_body_structure -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : Your request body for POST requests must have a structure of { data: { item: [...properties] } } -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : xpub_sync_in_progress -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : Your wallet (xPub, yPub, zPub) is still syncing, it should take few seconds depending on how many transactions it has. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
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.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext 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 -
Requirederror object
request_limit_reached
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : request_limit_reached -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : 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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
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.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext 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 -
Requirederror object
unexpected_server_error
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : unexpected_server_error -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : 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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-