👋Welcome to Token Supply App

Welcome to the TokenSupply app documentation! This guide will help you understand the TokenSupply app, its architecture, and how to use it to retrieve token supply information across multiple blockchain networks.

TokenSupply is a powerful and versatile tool designed to fetch token supply data from various blockchain networks, such as Ethereum, Binance Smart Chain, Polygon, Arbitrum One, and Avalanche. It simplifies the process of obtaining total token supply, non-circulating supply, and circulating supply for a given token contract address. This information is crucial for developers, analysts, and investors who need accurate and up-to-date token supply data for their applications or projects.


In this documentation, you'll learn about the following topics:

  1. TokenSupply App Architecture: Gain an understanding of the TokenSupply app's structure, including its components and how they interact with each other.

  2. Configuration and Setup: Learn how to configure the TokenSupply app, including setting up the API keys, token contract addresses, and network configurations.

  3. Utility Functions: Discover the utility functions in the src/getSupplyAcrossNetworks.ts file and understand their purpose in fetching token supply data from various blockchain networks.

  4. API Endpoints: Get acquainted with the Express.js server and the API endpoints exposed in the src/server.ts file, including each endpoint's URL path, expected input parameters, and output format.

  5. Usage Examples: Learn how to interact with the TokenSupply app by following step-by-step examples that demonstrate how to fetch token supply data using the API endpoints.

  6. Integration: Understand how to integrate the TokenSupply app into your existing projects or applications, including setting up the server and making API requests from client-side code.

  7. Troubleshooting and FAQ: Find solutions to common issues and answers to frequently asked questions about the TokenSupply app.

By the end of this guide, you will have a solid understanding of the TokenSupply app's architecture and functionalities. You will also know how to configure the app, make API requests to fetch token supply data, and integrate the app into your projects or applications.

Whether you're a developer looking to obtain token supply data for your applications or an investor needing accurate token supply information for decision-making, the TokenSupply app is a valuable tool that simplifies the process and provides reliable data across multiple blockchain networks.

Let's dive in and explore the TokenSupply app!

Last updated