Clarification of the JSON output and object description table of get crypto address details API of Crypto APIs
In this article, I will clarify the object table and JSON output of Crypto APIs' "Get Crypto Address Details" API. Specifically, I will explain the fields and their meanings in the object table and how the information is organized in the JSON output. By understanding these details, the reader will be able to more effectively use and interpret the data provided by this API.
Object and description 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 | |
| transactionsCount | Represents the total number of confirmed coins transactions for this address, both incoming and outgoing. |
| confirmedBalance | Defines the total balance of the address that is confirmed. It doesn't include unconfirmed transactions. |
| amount | Represents the unit of the confirmed balance. |
| unit | Represents the unit of the confirmed balance. |
| totalReceived | |
| amount | Defines the total amount of all coins received to the address, based on confirmed transactions. |
| unit | Represents the unit of the total received amount. |
| totalSpent | |
| amount | Defines the total amount of all spent by this address coins, based on confirmed transactions. |
| unit | Represents the unit of the total spent amount. |
| incomingTransactionsCount | Numeric representation of the received transaction count of the address. |
| outgoingTransactionsCount | Numeric representation of the sent transaction count of the address. |
apiVersion: a string that specifies the version of the API that incorporates this endpoint.
requestId: a string that defines the unique ID of the request, generated by Crypto APIs.
context: a user-specified string that can be used in batch situations to correlate responses with requests. This property is present in all responses, regardless of whether they are successful or returned as an error.
data: an object that contains additional information about the request. The specific properties and their meanings within this object will depend on the API endpoint being used.
item: an object that contains additional information about a specific item related to the request. The specific properties and their meanings within this object will depend on the API endpoint being used.
transactionsCount: an integer that represents the total number of confirmed coin transactions for the addressed specified in the request, both incoming and outgoing.
confirmedBalance: an object that defines the total balance of the address specified in the request that is confirmed. This balance does not include unconfirmed transactions.
amount: a string that represents the unit of the confirmed balance.
unit: a string that represents the unit of the confirmed balance.
totalReceived: an object that defines the total amount of all coins received by the address specified in the request, based on confirmed transactions.
amount: a string that represents the total amount of all coins received by the address.
unit: a string that represents the unit of the total received amount.
totalSpent: an object that defines the total amount of all coins spent by the address specified in the request, based on confirmed transactions.
amount: a string that represents the total amount of all coins spent by the address.
unit: a string that represents the unit of the total spent amount.
incomingTransactionsCount: an integer that represents the number of received transactions for the address specified in the request.
outgoingTransactionsCount: an integer that represents the number of sent transactions for the address specified in the request.
The information in the table is useful for several reasons. First, the apiVersion field allows the user to determine which version of the API is being used, which can be important for ensuring compatibility with their own systems or for troubleshooting purposes. The requestId field can also be useful for tracking and identifying specific requests, particularly in cases where multiple requests are being made at the same time. The context field allows the user to correlate responses with specific requests, which can be particularly useful in batch situations. The data and item fields provide additional information about the request or a specific item related to the request, which can be useful for understanding the context of the response. The remaining fields provide information about the transaction history and balance of the address specified in the request, which can be useful for tracking and managing cryptocurrency assets.
JSON output explained
This JSON output contains information about a specific cryptocurrency address. It includes the apiVersion, which specifies the version of the API being used. The requestId field contains a unique identifier for the request, generated by Crypto APIs. The context field contains a string specified by the user that can be used to correlate this response with a specific request. The data object contains additional information about the request, and within it, the item object provides further details about a specific item related to the request. This item has several properties including transactionsCount, which specifies the total number of confirmed coin transactions for the address, both incoming and outgoing. The confirmedBalance object contains information about the confirmed balance of the address, including the amount in BTC and the unit in which it is expressed. The totalReceived object contains information about the total amount of all coins received by the address, including the amount in BTC and the unit in which it is expressed. The totalSpent object contains information about the total amount of all coins spent by the address, including the amount in BTC and the unit in which it is expressed. The incomingTransactionsCount field specifies the number of received transactions for the address, and the outgoingTransactionsCount field specifies the number of sent transactions for the address.
{
"apiVersion": "2021-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"data": {
"item": {
"transactionsCount": 3,
"confirmedBalance": {
"amount": "",
"unit": "BTC"
},
"totalReceived": {
"amount": "5.6",
"unit": "BTC"
},
"totalSpent": {
"amount": "2.1",
"unit": "BTC"
},
"incomingTransactionsCount": 2,
"outgoingTransactionsCount": 2
}
}
}
In conclusion
In this article, we have discussed the object table and JSON output of Crypto APIs' "Get Crypto Address Details" API. We have clarified the meaning of each field in the object table and how the information is organized in the JSON output. We have also discussed the usefulness of this information for tracking and managing cryptocurrency assets, as well as for identifying and troubleshooting specific requests. Overall, this information is essential for understanding and effectively using the data provided by this API.
Reference
If you would like to access the Crypto APIs "Get Crypto Address Details" API, you can do so through the third party data marketplace of Worldindata. Worldindata is a platform that enables users to discover, evaluate, and purchase high-quality data from a variety of sources. To request access to this API through Worldindata, you will need to create an account and follow the platform's process for obtaining access to a specific API. This may include submitting a request to the API provider and agreeing to any terms and conditions for using the API. Once you have obtained access, you will be able to use the API to retrieve data about cryptocurrency addresses as needed.