Get HD Wallet (xPub, yPub, zPub) Details XRP
HD wallet details is useful endpoint to get the most important data about HD wallet without the need to do a lot of calculations, once the HD Wallet is synced using Sync endpoint we keep it up to date and we calculate these details in advance.
Path Parameters
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
Defines the account extended publicly known key which is used to derive all child public keys.
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
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.
The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.
Response Schema
-
200Content-Type: application/json
The request has been successful.
-
400Content-Type: application/json
400
-
401Content-Type: application/json
401
-
402Content-Type: application/json
You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.
-
403Content-Type: application/json
403
-
409Content-Type: application/json
The data provided seems to be invalid.
-
415Content-Type: application/json
The selected Media Type is unavailable. The Content-Type header should be 'application/json'.
-
422Content-Type: application/json
422
-
429Content-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.
-
500Content-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.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
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.
Specifies the confirmed coins balance of the Wallet.
Defines the total currency received to the Wallet.
Defines the total currency spent from the Wallet.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
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.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
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.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
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.
insufficient_credits
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
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.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
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.
invalid_data
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
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.
unsupported_media_type
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
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.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
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_limit_reached
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
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.
unexpected_server_error
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Credits Cost : 10000 Credits for 1 Results
API Key
-
200Content-Type: application/json
The request has been successful.
-
400Content-Type: application/json
400
-
401Content-Type: application/json
401
-
402Content-Type: application/json
You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.
-
403Content-Type: application/json
403
-
409Content-Type: application/json
The data provided seems to be invalid.
-
415Content-Type: application/json
The selected Media Type is unavailable. The Content-Type header should be 'application/json'.
-
422Content-Type: application/json
422
-
429Content-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.
-
500Content-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.
{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"data": {
"item": {
"confirmedBalance": "0.0021",
"totalReceived": "0.0002",
"totalSpent": "0.0001",
"unit": "XRP"
}
}
}{
"apiVersion": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "invalid_blockchain",
"message": "The provided blockchain is invalid. The blockchain **must** be a supported one. For the full list of supported blockchains please see our Documentation.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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": "2024-12-12",
"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"
}
]
}
}