APIs USED
This page discuss the APIs used during development.
Paal Backend API Documentation
Overview
The Paal Backend utilizes a variety of APIs to provide essential functionalities for the Paal ecosystem platform. This documentation provides an overview of the APIs used, along with their respective keys and purposes.
Table of Contents
Introduction
API Keys and Their Purposes
ETHERSCAN_KEY (https://etherscan.io/)
BSCSCAN_KEY (https://bscscan.io/)
BASESCAN_KEY (https://basescan.io/)
CRYPTO_COMPARE_API (https://min-api.cryptocompare.com/)
COVALENT_KEY (https://www.covalenthq.com/)
CHAIN_BASE_API (https://chainbase.com/)
TWITTER_BEARER_TOKEN (https://developer.x.com/)
GOOGLE_CLIENT_ID (OPTIONAL https://cloud.google.com/)
GOOGLE_CLIENT_SECRET (OPTIONAL https://cloud.google.com/)
QUICK NODE RPC URL (https://www.quicknode.com/)
Introduction
The Paal Backend relies on several third-party APIs to integrate various functionalities such as blockchain data retrieval, social media interactions, and user authentication. This documentation provides detailed information about each API, including its purpose and usage.
API Keys and Their Purposes
ETHERSCAN_KEY
Purpose: Access to the Etherscan API for retrieving Ethereum blockchain data.
BSCSCAN_KEY
Purpose: Access to the BscScan API for retrieving Binance Smart Chain data.
BASESCAN_KEY
Purpose: Access to the Basescan API for retrieving Basechain data.
CRYPTO_COMPARE_API
Purpose: Access to the Crypto Compare API for fetching cryptocurrency pricing and historical data.
COVALENT_KEY
Purpose: Access to the Covalent API for fetching blockchain data from various blockchains.
CHAIN_BASE_API
Purpose: Access to the ChainBase API for blockchain data and analytics.
TWITTER_BEARER_TOKEN
Purpose: Access to the Twitter API for integrating Twitter functionalities within the application.
QuickNode APIs ($49/Mo)
I subscribed for only 1 month for development purposes, it would need to be subscribed for actual usage.
Network RPCs:
Ethereum Mainnet (ID: 1)
Purpose: Access to Ethereum Mainnet for blockchain interactions.
Base Mainnet (ID: 8453)
Purpose: Access to Base Mainnet for blockchain interactions.
Binance Smart Chain (ID: 56)
Purpose: Access to Binance Smart Chain for blockchain interactions.
Solana Mainnet (ID: 900)
Purpose: Access to Solana Mainnet for blockchain interactions.
GOOGLE_CLIENT_ID (OPTIONAL IF USING GOOGLE AUTH)
Purpose: Google OAuth 2.0 client ID for authenticating users with their Google accounts.
GOOGLE_CLIENT_SECRET (OPTIONAL IF USING GOOGLE AUTH)
Purpose: Google OAuth 2.0 client secret for authenticating users with their Google accounts.
Conclusion
The Paal Backend integrates several APIs to provide comprehensive functionalities required for the platform. Ensure all API keys are securely stored and configured correctly to maintain the integrity and security of the application.
Last updated