Clarification of the JSON output and object table of get crypto address balance API created by Crypto APIs
In this article, I aim to clarify the object table and JSON output specifically of Crypto APIs' get crypto address balance API. The object table and JSON output provide important information about the balance of a crypto address, including the total balance, the balance of each individual token, and any transactions related to the balance. Understanding how to interpret and use this data can be useful for a variety of applications.
Object table
Objects | Description |
apiVersion | Specifies the version of the API that incorporates this endpoint. |
requestId | Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request. |
context | 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. |
data | |
item | |
confirmedBalance | |
amount | Defines the total balance of the address that is confirmed. It doesn't include unconfirmed transactions. |
unit | Represents the unit of the confirmed balance. |
apiVersion
: a string representing the version of the API that incorporates the endpoint for getting the crypto address balance.requestId
: a unique identifier generated by Crypto APIs for every request. This can be used to track and match requests and responses in batch situations.context
: a user-specified value that can be used to correlate responses with requests in batch situations. This property is present in both successful responses and error responses.data
: an object containing information about the balance of a crypto address.item
: an object containing information about a specific token within the address's balance.confirmedBalance
: an object containing information about the confirmed balance of the crypto address.amount
: a numerical value representing the total balance of the address that has been confirmed. This does not include unconfirmed transactions.unit
: a string representing the unit of the confirmed balance, such as "BTC" for Bitcoin or "ETH" for Ethereum.
The information in the table is useful because it provides detailed information about the balance of a crypto address. The apiVersion
and requestId
can be used to track and verify the authenticity of the request and response. The context
property allows the user to correlate responses with specific requests in batch situations. The data
object contains information about the overall balance of the address, including the confirmedBalance
and any individual item
balances for specific tokens. The amount
and unit
properties within the confirmedBalance
object give a precise numerical value and unit of measurement for the confirmed balance of the address. This information can be useful for a variety of purposes, such as tracking the value of an investment or verifying the accuracy of a crypto payment.
JSON REST Output
The JSON output represents the response from a request to the Crypto APIs get crypto address balance API. The response includes the apiVersion
, which specifies the version of the API that was used to fulfill the request. It also includes the requestId
, a unique identifier generated by Crypto APIs for the request. The context
property holds a string value specified by the user in the original request, which can be used to correlate responses with requests in batch situations. The data
object contains information about the balance of the crypto address. Within the data
object, there is an item
object which represents information about the balance of a specific token. The confirmedBalance
object within the item
object includes the amount
and unit
of the confirmed balance for the address. In this case, the confirmed balance is 3.25 units of TRX.
{
"apiVersion": "2021-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"data": {
"item": {
"confirmedBalance": {
"amount": "3.25",
"unit": "TRX"
}
}
}
}
Finishing
In summary, we have discussed the object table and JSON output of the Crypto APIs get crypto address balance API. We have clarified the purpose and properties of each object, including the apiVersion
, requestId
, context
, data
, item
, confirmedBalance
, amount
, and unit
. This information can be used to understand and make use of the response data from the API, which provides details about the balance of a crypto address.
Source
To request access to the Crypto APIs get crypto address balance API, you can use the third party data marketplace provided by Worldindata. This marketplace allows you to browse and purchase access to a variety of data sources, including the Crypto APIs get crypto address balance API. By accessing the API through the marketplace, you can easily obtain the necessary API key and documentation to use the API in your own projects. The marketplace provides a convenient and secure way to access valuable data sources and integrate them into your applications.