Guide to Using the Balance History API

Introduction

Welcome to the Balance History API, an integral part of our blockchain data service. This guide is designed to assist both newcomers and experienced users within our community. Our goal is to facilitate the access to comprehensive transaction histories in an efficient manner.

What is the Balance History API?

This API endpoint provides a convenient method to download the history of balance transfers for a specified blockchain address. It is an essential tool for auditing, accounting, or tracking personal transaction activities, offering detailed transaction information in a user-friendly CSV format.

How to Use the API

Accessing through a Web Browser

1. Open Your Browser: Launch your preferred web browser.
2. Enter the URL: Use the following format to access the balance history: https://tax-server.deeper.network/balance-history?address=[YourBlockchainAddressHere]&year=[DesiredYear]
3. Insert Your Address and Year: Replace [YourBlockchainAddressHere] with the blockchain address you are interested in and [DesiredYear] with the year for which you want the transaction history (e.g., 2021, 2022, or 2023).

Accessing through Curl (Command Line)

1. Open Terminal/Command Prompt: Prepare your terminal or command prompt.
2. Run the Command: Type and execute the following command: bash curl "https://tax-server.deeper.network/balance-history?address=[YourBlockchainAddressHere]&year=[DesiredYear]" Ensure to replace [YourBlockchainAddressHere] with your actual blockchain address and [DesiredYear] with the appropriate year.

Understanding the API Parameters

• address: The blockchain address for which you want to download the transaction history.
• year: The year for which the transaction history is desired. Currently, only 2021, 2022, or 2023 are supported.

Usage Examples

• Via Web Browser: https://tax-server.deeper.network/balance-history?address=5DMNywVCTpuVUkoiitr5fYc9QT8ses5Rk4vTyQjfA5Lma5dr&year=2023
• Via Curl: bash curl "https://tax-server.deeper.network/balance-history?address=5DMNywVCTpuVUkoiitr5fYc9QT8ses5Rk4vTyQjfA5Lma5dr&year=2023"

What to Expect in the Response

Upon a successful request, you will receive a CSV file for download, which includes key transaction details such as: - Block ID - Timestamp - Sender Address - Receiver Address - Transaction Amount

Performance and Efficiency

• First-time Requests: Initially, the system will query the blockchain database. The time taken depends on the volume of transactions and the specific year queried.
• Repeated Requests: For subsequent requests for the same address and year, if a CSV file already exists, it will be sent promptly, significantly speeding up the process.

Tips for a Smooth Experience

• Accuracy is Key: Ensure the blockchain address and year are correct.
• Be Patient: Download times may vary based on the transaction history length, year of transactions, and network speeds.
• Handle Data with Care: As the data is sensitive, ensure it is stored and shared securely.

We hope this guide aids you in navigating the Balance History API smoothly. For any further questions or assistance, feel free to reach out to our supportive community.