### AvaCloud SDK - Getting Started Source: https://developers.avacloud.io/data-api Guides on how to get started with the AvaCloud SDK, including setup, authentication, and basic usage for accessing multi-chain data. ```markdown ## Getting Started with AvaCloud SDK The AvaCloud SDK provides web3 application developers with multi-chain data related to Avalanche’s primary network, Avalanche L1s, and Ethereum. This guide covers installation, authentication, and initial setup. ### Installation ```bash npm install avacloud-sdk ``` ### Authentication To use the SDK, you need an API key. Obtain your API key from the AvaCloud dashboard. ```javascript import AvaCloudSDK from 'avacloud-sdk'; const sdk = new AvaCloudSDK('YOUR_API_KEY'); ``` ### Global Parameters Understand how to configure global parameters like network and chain IDs. ### Retries & Pagination Learn about the SDK's built-in retry mechanisms and pagination strategies for handling large datasets and network issues. ### Error Handling Implement robust error handling for API requests and SDK operations. ``` -------------------------------- ### Metrics API: Get Started Source: https://developers.avacloud.io/data-api Introduction and setup guide for the Metrics API, covering overview, getting started, usage guidelines, and rate limits. ```APIDOC Metrics API - Get Started: overview - General introduction to the Metrics API. getting-started - Guide to begin using the Metrics API. usage-guide - Instructions on how to effectively use the API for metrics retrieval. rate-limits - Information on rate limits for the Metrics API. ``` -------------------------------- ### Data API - Getting Started Source: https://developers.avacloud.io/data-api Guides users through the initial steps of using the Data API, including setup and making the first requests. ```APIDOC Page: /data-api/getting-started Description: Step-by-step guide to begin using the Data API. Content: - Prerequisites - Authentication setup - Making your first API call ``` -------------------------------- ### Webhooks API - Get Started Source: https://developers.avacloud.io/webhooks-api/webhooks/list-webhooks Guides for getting started with the Webhooks API, covering overview, setup, signature handling, supported chains, WSS vs Webhooks, retries, and rate limits. ```APIDOC webhooks-api/overview Description: Overview of the Webhooks API. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC webhooks-api/getting-started Description: Step-by-step guide to getting started. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC webhooks-api/signature Description: Information on webhook signature verification. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC webhooks-api/supported-chains Description: Lists supported chains for webhooks. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC webhooks-api/wss-vs-webhooks Description: Comparison between WSS and Webhooks. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC webhooks-api/retries Description: Details on webhook retry mechanisms. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC webhooks-api/rate-limits Description: Information on rate limits for the Webhooks API. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` -------------------------------- ### AvaCloud SDK - Getting Started Source: https://developers.avacloud.io/data-api Guides for setting up and using the AvaCloud SDK. Covers initial setup, authentication, and fundamental concepts for interacting with the Avalanche ecosystem. ```APIDOC Page: /avacloud-sdk/getting-started Description: Introduction to the AvaCloud SDK, including installation and basic usage. Content: - SDK installation instructions - First steps for integration ``` ```APIDOC Page: /avacloud-sdk/authentication Description: Details on how to authenticate your requests using the AvaCloud SDK. Content: - API key management - Authentication methods (e.g., OAuth, API keys) ``` ```APIDOC Page: /avacloud-sdk/global-parameters Description: Explanation of global parameters applicable to all SDK requests. Content: - Common headers and query parameters - Environment configuration ``` ```APIDOC Page: /avacloud-sdk/retries Description: Information on the SDK's built-in retry mechanisms for handling transient errors. Content: - Retry strategy configuration - Exponential backoff details ``` ```APIDOC Page: /avacloud-sdk/pagination Description: Guidance on how to handle paginated responses from the SDK. Content: - Pagination parameters (e.g., limit, offset) - Iterating through results ``` ```APIDOC Page: /avacloud-sdk/error Description: Details on error handling and common error types encountered with the SDK. Content: - Error codes and messages - Exception handling patterns ``` ```APIDOC Page: /avacloud-sdk/custom-http Description: Instructions for customizing HTTP client behavior within the SDK. Content: - Interceptors and middleware - Custom HTTP client configuration ``` -------------------------------- ### Avalanche Data API Getting Started Source: https://developers.avacloud.io/data-api/evm-balances/get-native-token-balance Guides users through the initial steps required to start using the Avalanche Data API. This includes setup, authentication, and making the first API calls. ```APIDOC Data API Getting Started: - Prerequisites: API key, understanding of RESTful APIs. - Steps: 1. Obtain an API key from the developer portal. 2. Configure your application to include the API key in requests. 3. Make GET requests to specified endpoints. - Example Request: GET /v1/chains Headers: Authorization: Bearer YOUR_API_KEY ``` -------------------------------- ### Webhooks API: Get Started Source: https://developers.avacloud.io/data-api/primary-network-balances/get-balances Guides and information for getting started with the Webhooks API, including setup, authentication, and best practices. ```APIDOC webhooks-api/overview Description: Provides a general overview of the Webhooks API functionality and use cases. ``` ```APIDOC webhooks-api/getting-started Description: Step-by-step guide to setting up and using the Webhooks API. ``` ```APIDOC webhooks-api/signature Description: Details on how to generate and verify webhook signatures for security. ``` ```APIDOC webhooks-api/supported-chains Description: Lists the blockchain chains supported by the Webhooks API. ``` ```APIDOC webhooks-api/wss-vs-webhooks Description: Explains the differences and use cases between WebSocket (WSS) and Webhooks. ``` ```APIDOC webhooks-api/retries Description: Information on the retry mechanisms for webhook delivery failures. ``` ```APIDOC webhooks-api/rate-limits Description: Outlines the rate limits applicable to the Webhooks API. ``` -------------------------------- ### AvaCloud SDK: Getting Started Source: https://developers.avacloud.io/webhooks-api/webhooks/list-adresses-by-webhook Guides on how to install, authenticate, and begin using the AvaCloud SDK for programmatic access. ```APIDOC avacloud-sdk/getting-started - Installation and initial setup guide for the AvaCloud SDK. avacloud-sdk/authentication - Details on how to authenticate your requests using the SDK. avacloud-sdk/global-parameters - Explanation of global parameters applicable across SDK methods. avacloud-sdk/retries - Configuration and strategy for automatic retries in SDK requests. avacloud-sdk/pagination - How to handle paginated results when fetching large datasets. avacloud-sdk/error - Information on error handling and common error codes. avacloud-sdk/custom-http - Guide on customizing HTTP client behavior within the SDK. ``` -------------------------------- ### Webhooks API: Get Started & Core Concepts Source: https://developers.avacloud.io/data-api Guides users through the initial setup and fundamental concepts of the Webhooks API. Covers overview, getting started procedures, signature verification, supported chains, differences between WSS and Webhooks, retry mechanisms, and rate limits. ```APIDOC webhooks-api/overview webhooks-api/getting-started webhooks-api/signature webhooks-api/supported-chains webhooks-api/wss-vs-webhooks webhooks-api/retries webhooks-api/rate-limits ``` -------------------------------- ### Metrics API: Get Started Source: https://developers.avacloud.io/data-api/primary-network-balances/get-balances Guides for using the Metrics API, covering overview, setup, usage, and rate limits. ```APIDOC metrics-api/overview Description: Provides a general overview of the Metrics API and its capabilities. ``` ```APIDOC metrics-api/getting-started Description: Step-by-step guide to begin using the Metrics API. ``` ```APIDOC metrics-api/usage-guide Description: Detailed guide on how to query and interpret metrics. ``` ```APIDOC metrics-api/rate-limits Description: Information on the rate limits for the Metrics API. ``` -------------------------------- ### Metrics API: Get Started and Overview Source: https://developers.avacloud.io/webhooks-api/webhooks/list-adresses-by-webhook Guides users through the Metrics API, covering overview, getting started, usage guide, and rate limits for monitoring service performance. ```APIDOC metrics-api/overview - Provides a general introduction to the Metrics API. - Content: API purpose, data available. ``` ```APIDOC metrics-api/getting-started - Step-by-step guide to begin using the Metrics API. - Content: Authentication, initial queries. ``` ```APIDOC metrics-api/usage-guide - Detailed guide on how to query and interpret metrics. - Content: Query parameters, data formats. ``` ```APIDOC metrics-api/rate-limits - Outlines the rate limits imposed on the Metrics API. - Content: Request limits, burst limits. ``` -------------------------------- ### Webhooks API - Get Started Source: https://developers.avacloud.io/data-api/etna Guides and foundational information for using the Webhooks API, including overview, setup, signature verification, supported chains, and retry mechanisms. ```APIDOC GET /webhooks-api/overview Description: Provides a general overview of the Webhooks API capabilities. GET /webhooks-api/getting-started Description: Step-by-step guide to setting up and using the Webhooks API. GET /webhooks-api/signature Description: Details on how to verify webhook signatures to ensure authenticity. GET /webhooks-api/supported-chains Description: Lists all blockchain chains supported by the Webhooks API. GET /webhooks-api/wss-vs-webhooks Description: Explains the differences and use cases between WebSockets (WSS) and Webhooks. GET /webhooks-api/retries Description: Information on the retry strategy for failed webhook deliveries. GET /webhooks-api/rate-limits Description: Outlines the rate limits applicable to the Webhooks API. ``` -------------------------------- ### AvaCloud SDK: Get Started Source: https://developers.avacloud.io/data-api/primary-network-blocks/list-latest-blocks Guides for the AvaCloud SDK, covering initial setup, authentication, global parameters, retries, pagination, error handling, and custom HTTP client configuration. ```markdown ## AvaCloud SDK Guides ### Get Started - **Getting Started**: Initial setup and installation of the SDK. - **Authentication**: How to authenticate your requests with the SDK. - **Global Parameters**: Understanding and using global parameters. - **Retries**: Configuration for automatic request retries. - **Pagination**: How to handle paginated results. - **Error Handling**: Strategies for managing errors returned by the SDK. - **Custom HTTP**: Using a custom HTTP client with the SDK. ``` -------------------------------- ### Metrics API - Get Started Source: https://developers.avacloud.io/webhooks-api/webhooks/list-webhooks Guides for getting started with the Metrics API, including overview, usage guide, and rate limits. ```APIDOC metrics-api/overview Description: Overview of the Metrics API. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC metrics-api/getting-started Description: Step-by-step guide to getting started with the Metrics API. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC metrics-api/usage-guide Description: Guide on how to use the Metrics API. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC metrics-api/rate-limits Description: Information on rate limits for the Metrics API. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` -------------------------------- ### Webhooks API: Get Started Source: https://developers.avacloud.io/data-api Guides and foundational information for using the Webhooks API, including overview, setup, signature verification, supported chains, and retry mechanisms. ```APIDOC Webhooks API - Get Started: overview - Provides a general introduction to the Webhooks API. getting-started - Step-by-step guide to setting up and using webhooks. signature - Details on how to verify webhook signatures for security. supported-chains - Lists the blockchains supported by the Webhooks API. wss-vs-webhooks - Explains the differences and use cases between WebSockets and Webhooks. retries - Information on the webhook retry policy and mechanism. rate-limits - Details on the rate limits applicable to the Webhooks API. ``` -------------------------------- ### Webhooks API - Get Started Source: https://developers.avacloud.io/data-api Guides for getting started with the Webhooks API, including overview, signature verification, supported chains, and retry mechanisms. ```APIDOC Overview Description: Provides a general introduction to the Webhooks API. Content: - Purpose and use cases of Webhooks. - Key concepts. ``` ```APIDOC Getting Started Description: Step-by-step guide to begin using the Webhooks API. Content: - Setup and configuration. - First webhook subscription. ``` ```APIDOC Webhook Signature Description: Details on verifying the signature of incoming webhook payloads. Content: - Signature generation process. - Verification algorithm. - Security best practices. ``` ```APIDOC Supported EVM Chains Description: Lists the EVM-compatible chains supported by the Webhooks API. Content: - Chain identifiers. - Network details. ``` ```APIDOC WebSockets vs Webhooks Description: Compares and contrasts WebSockets and Webhooks for real-time data delivery. Content: - Use cases for each technology. - Advantages and disadvantages. ``` ```APIDOC Retry mechanism Description: Explains how the Webhooks API handles delivery retries for failed events. Content: - Retry policy. - Exponential backoff strategy. ``` ```APIDOC Rate Limits Description: Information on the rate limits imposed on Webhooks API usage. Content: - Limits for subscriptions and events. - Strategies for managing rate limits. ``` -------------------------------- ### Metrics API - Get Started Source: https://developers.avacloud.io/data-api/evm-chains/list-latest-transactions-for-all-supported-evm-chains Guides users through the initial setup and concepts for the Metrics API, covering overview, getting started, usage guide, and rate limits. ```APIDOC metrics-api/overview metrics-api/getting-started metrics-api/usage-guide metrics-api/rate-limits ``` -------------------------------- ### AvaCloud SDK - Getting Started Source: https://developers.avacloud.io/metrics-api Guides for setting up and using the AvaCloud SDK. Covers initial setup, authentication, global parameters, retries, pagination, error handling, and custom HTTP configurations. ```markdown ## Getting Started with AvaCloud SDK This section provides essential information to begin using the AvaCloud SDK for interacting with Avalanche network services. ### Key Topics: * **Getting Started**: Initial setup and project configuration. * **Authentication**: How to authenticate your requests using API keys or other credentials. * **Global Parameters**: Understanding and setting common parameters across SDK calls. * **Retries**: Implementing retry logic for transient network failures. * **Pagination**: Handling paginated responses from API endpoints. * **Error Handling**: Strategies for managing and responding to API errors. * **Custom HTTP**: Configuring custom HTTP clients or settings for advanced use cases. ``` -------------------------------- ### AvaCloud SDK Getting Started Source: https://developers.avacloud.io/metrics-api Instructions for setting up and beginning to use the AvaCloud SDK. Covers installation, initialization, and basic configuration for development. ```APIDOC AvaCloud SDK: Getting Started: - Installation: [e.g., npm install avacloud-sdk] - Initialization: [Code snippet to initialize the SDK client] - Configuration: [How to set up API keys, network, etc.] ``` -------------------------------- ### Webhooks API - Get Started Source: https://developers.avacloud.io/data-api/signature-aggregator/aggregate-signatures Guides and information for getting started with the Webhooks API, including setup, signatures, and supported chains. ```APIDOC APIDOC: Group: Webhooks API - Get Started Pages: - webhooks-api/overview: General overview of the Webhooks API. - webhooks-api/getting-started: Step-by-step guide to using the Webhooks API. - webhooks-api/signature: Information on webhook signature verification. - webhooks-api/supported-chains: List of chains supported by the Webhooks API. - webhooks-api/wss-vs-webhooks: Comparison between WebSockets and Webhooks. - webhooks-api/retries: Details on webhook retry mechanisms. - webhooks-api/rate-limits: Information on API rate limits for webhooks. ``` -------------------------------- ### Webhooks API: Get Started Source: https://developers.avacloud.io/data-api/primary-network/get-subnet-details-by-id Documentation and guides for getting started with the Webhooks API, covering overview, setup, signature verification, supported chains, WSS vs Webhooks, retries, and rate limits. ```APIDOC webhooks-api/overview webhooks-api/getting-started webhooks-api/signature webhooks-api/supported-chains webhooks-api/wss-vs-webhooks webhooks-api/retries webhooks-api/rate-limits ``` -------------------------------- ### AvaCloud SDK - Get Started Source: https://developers.avacloud.io/data-api/getting-started Guides for using the AvaCloud SDK, covering essential aspects like getting started, authentication methods, understanding global parameters, handling retries, implementing pagination, managing errors, and configuring custom HTTP clients. ```APIDOC AvaCloud SDK: Getting Started: Description: Initial steps to set up and begin using the AvaCloud SDK. Covers: Installation, basic configuration. Authentication: Description: Details on how to authenticate your requests with the AvaCloud API using the SDK. Methods: API keys, OAuth, etc. Global Parameters: Description: Explanation of parameters that apply across multiple SDK calls. Examples: Network selection, versioning. Retries: Description: How the SDK handles transient network errors and retries requests. Configuration: Retry strategies, backoff policies. Pagination: Description: Methods for handling paginated API responses to retrieve large datasets. Techniques: Cursor-based, offset-based pagination. Error Handling: Description: Strategies for catching and managing errors returned by the API or SDK. Error types: API errors, network errors, validation errors. Custom HTTP Client: Description: How to configure a custom HTTP client for advanced use cases like custom headers or interceptors. ``` -------------------------------- ### AvaCloud SDK: Get Started Source: https://developers.avacloud.io/data-api/primary-network-balances/get-balances Guides for setting up and using the AvaCloud SDK, covering authentication, global parameters, and error handling. ```APIDOC avacloud-sdk/getting-started Description: Initial steps to install and set up the AvaCloud SDK. ``` ```APIDOC avacloud-sdk/authentication Description: How to authenticate your requests using the SDK. ``` ```APIDOC avacloud-sdk/global-parameters Description: Explanation of global parameters that can be applied to SDK calls. ``` ```APIDOC avacloud-sdk/retries Description: Information on the SDK's retry mechanisms for failed requests. ``` ```APIDOC avacloud-sdk/pagination Description: How to handle paginated results when using the SDK. ``` ```APIDOC avacloud-sdk/error Description: Details on error handling and common error codes in the SDK. ``` ```APIDOC avacloud-sdk/custom-http Description: Guide on customizing HTTP client configurations for the SDK. ``` -------------------------------- ### AvaCloud SDK - Getting Started Source: https://developers.avacloud.io/data-api/evm-transactions/list-erc-20-transfers Guides users through the initial setup and authentication process for the AvaCloud SDK. It covers essential steps for integrating the SDK into projects and establishing secure connections. ```APIDOC AvaCloud SDK Setup: - Getting Started: Provides an overview of the SDK and its capabilities. - Authentication: Details on how to authenticate with the AvaCloud API using API keys or other credentials. Example: ```python from avacloud_sdk import AvaCloudClient client = AvaCloudClient(api_key='YOUR_API_KEY') ``` - Global Parameters: Explains common parameters applicable across multiple SDK methods. - Retries: Information on the SDK's retry mechanisms for handling transient network issues. - Pagination: Describes how to handle paginated results from API calls. - Error Handling: Details on how the SDK reports and handles errors. - Custom HTTP Client: Instructions on how to configure a custom HTTP client for advanced use cases. ``` -------------------------------- ### Webhooks API: Overview and Setup Source: https://developers.avacloud.io/data-api/primary-network-blocks/list-latest-blocks Guides on getting started with the Webhooks API, including setup, signature verification, supported chains, and retry mechanisms. ```markdown ## Webhooks API Guides ### Get Started - **Overview**: Introduction to the Webhooks API. - **Getting Started**: Initial steps to use the API. - **Signature**: How to verify webhook signatures. - **Supported Chains**: List of blockchains supported by webhooks. - **WSS vs Webhooks**: Comparison between WebSocket and Webhooks. - **Retries**: Explanation of the retry mechanism for failed deliveries. - **Rate Limits**: Information on API rate limits. ``` -------------------------------- ### Metrics API: Get Started Source: https://developers.avacloud.io/data-api/primary-network-blocks/list-blocks-proposed-by-node Guides and foundational information for using the Metrics API. Covers overview, setup, usage guide, and rate limits. ```APIDOC GET /metrics-api/overview Description: Provides an overview of the Metrics API. GET /metrics-api/getting-started Description: Guides users through the initial setup of the Metrics API. GET /metrics-api/usage-guide Description: Explains how to use the Metrics API for monitoring. GET /metrics-api/rate-limits Description: Details on the rate limits applicable to the Metrics API. ``` -------------------------------- ### Webhooks API: Get Started Source: https://developers.avacloud.io/data-api/getting-started Guides and information for getting started with the Webhooks API, including overview, signature generation, supported chains, and retry mechanisms. ```APIDOC Webhooks API: Get Started: overview GET /webhooks-api/overview Description: Provides a general overview of the Webhooks API. getting-started GET /webhooks-api/getting-started Description: Step-by-step guide to start using the Webhooks API. signature GET /webhooks-api/signature Description: Details on how to generate and verify webhook signatures. supported-chains GET /webhooks-api/supported-chains Description: Lists all EVM chains supported by the Webhooks API. wss-vs-webhooks GET /webhooks-api/wss-vs-webhooks Description: Compares WebSockets (WSS) and Webhooks for real-time data delivery. retries GET /webhooks-api/retries Description: Information on the webhook retry mechanism and policies. rate-limits GET /webhooks-api/rate-limits Description: Details on the rate limits applicable to the Webhooks API. ``` -------------------------------- ### AvaCloud SDK - Getting Started Source: https://developers.avacloud.io/data-api/getting-started Provides an overview and initial steps for integrating the AvaCloud SDK into your web3 applications. The SDK offers multi-chain data for Avalanche and Ethereum networks. ```javascript // Example of initializing the AvaCloud SDK (conceptual) // import { AvaCloudSDK } from '@avacloud/sdk'; // const sdk = new AvaCloudSDK({ // apiKey: 'YOUR_API_KEY', // network: 'avalanche' // }); // console.log('AvaCloud SDK initialized'); ``` -------------------------------- ### Webhooks API - Get Started Source: https://developers.avacloud.io/data-api/evm-chains/list-latest-transactions-for-all-supported-evm-chains Guides users through the initial setup and concepts for the Webhooks API, covering overview, getting started, signature verification, supported chains, webhook vs. WSS, retries, and rate limits. ```APIDOC webhooks-api/overview webhooks-api/getting-started webhooks-api/signature webhooks-api/supported-chains webhooks-api/wss-vs-webhooks webhooks-api/retries webhooks-api/rate-limits ``` -------------------------------- ### Avalanche Data API Getting Started Source: https://developers.avacloud.io/data-api/primary-network/get-subnet-details-by-id Guides users through the initial steps required to start using the Avalanche Data API. This includes setup, authentication, and making your first API calls. ```APIDOC data-api/getting-started - Initial setup and configuration - Authentication methods - First API request examples ``` -------------------------------- ### Avalanche Data API: Get Started Source: https://developers.avacloud.io/webhooks-api/webhooks/list-adresses-by-webhook Guides and overviews for users beginning with the Avalanche Data API. Includes general overview, getting started steps, usage guidelines, comparisons with RPC, and rate limit information. ```APIDOC APIDOC: Group: Get Started Topics: - overview: General introduction to the Data API. - getting-started: Initial steps to use the Data API. - usage-guide: Guidelines on how to effectively use the API. - data-api-vs-rpc: Comparison between Data API and RPC methods. - rate-limits: Information on API request rate limits. - etna: Details related to Etna. - snowflake: Details related to Snowflake. ``` -------------------------------- ### Webhooks API: Get Started & Concepts Source: https://developers.avacloud.io/data-api/primary-network-transactions/get-transaction Guides users through the initial setup and core concepts of the Webhooks API, including overview, getting started, signature verification, supported chains, WSS vs. Webhooks, retries, and rate limits. ```APIDOC Webhooks API: Get Started & Concepts - overview: Introduction to the Webhooks API. - getting-started: Step-by-step guide to begin using the Webhooks API. - signature: Information on webhook signature verification for security. - supported-chains: Lists the blockchain chains supported by the Webhooks API. - wss-vs-webhooks: Explanation of differences between WebSockets (WSS) and Webhooks. - retries: Details on the webhook retry mechanism. - rate-limits: Information on API rate limits for webhook operations. ``` -------------------------------- ### AvaCloud SDK - Get Started Source: https://developers.avacloud.io/data-api/primary-network-balances/get-balances Guides for initiating development with the AvaCloud SDK, covering essential topics like authentication, global parameters, and error handling. ```APIDOC AvaCloud SDK Guides: - getting-started - authentication - global-parameters - retries - pagination - error - custom-http Description: This section provides comprehensive documentation for developers looking to integrate with the AvaCloud SDK. It covers the foundational aspects required for successful integration, from initial setup and authentication to advanced topics like error management and custom HTTP configurations. ``` -------------------------------- ### Avalanche Data API Overview and Getting Started Source: https://developers.avacloud.io/data-api/getting-started Provides an introduction to the Avalanche Data API, its capabilities, and how to get started with development. Covers essential concepts like usage guides, the difference between Data API and RPC, and rate limits. ```APIDOC API Endpoint: /data-api/overview Description: Provides a general overview of the Avalanche Data API. API Endpoint: /data-api/getting-started Description: Step-by-step guide to begin using the Avalanche Data API. API Endpoint: /data-api/usage-guide Description: Detailed guide on how to effectively use the Data API for various development tasks. API Endpoint: /data-api/data-api-vs-rpc Description: Explains the differences and use cases between the Data API and traditional RPC methods. API Endpoint: /data-api/rate-limits Description: Information on the API's rate limits and usage policies. API Endpoint: /data-api/etna Description: Details specific to the Etna feature or service within the Data API. API Endpoint: /data-api/snowflake Description: Details specific to the Snowflake feature or service within the Data API. ``` -------------------------------- ### Webhooks API - Get Started Source: https://developers.avacloud.io/data-api/primary-network-blocks/get-block Guides and foundational information for using the Webhooks API, including setup, signature verification, supported chains, and retry mechanisms. ```APIDOC webhooks-api/overview - Provides a general overview of the Webhooks API. webhooks-api/getting-started - Step-by-step guide to start using the Webhooks API. webhooks-api/signature - Details on how to verify webhook signatures. webhooks-api/supported-chains - Lists the chains supported by the Webhooks API. webhooks-api/wss-vs-webhooks - Explains the differences and use cases between WebSockets (WSS) and Webhooks. webhooks-api/retries - Information on the retry mechanism for webhook delivery. webhooks-api/rate-limits - Details on the rate limits applicable to the Webhooks API. ``` -------------------------------- ### Metrics API: Get Started & Usage Source: https://developers.avacloud.io/data-api Introduces the Metrics API, covering its overview, initial setup, and usage guidelines. Also details the API's rate limits. ```APIDOC metrics-api/overview metrics-api/getting-started metrics-api/usage-guide metrics-api/rate-limits ``` -------------------------------- ### Webhooks API - Getting Started and Core Concepts Source: https://developers.avacloud.io/metrics-api Guides users through the initial setup and fundamental concepts of the Webhooks API, including overview, getting started, signature verification, supported chains, webhook vs. WSS, retry mechanisms, and rate limits. ```APIDOC webhooks-api/overview webhooks-api/getting-started webhooks-api/signature webhooks-api/supported-chains webhooks-api/wss-vs-webhooks webhooks-api/retries webhooks-api/rate-limits ``` -------------------------------- ### Metrics API: Get Started Source: https://developers.avacloud.io/data-api/primary-network/get-subnet-details-by-id Guides for using the Metrics API, including overview, getting started, usage guide, and rate limits. ```APIDOC metrics-api/overview metrics-api/getting-started metrics-api/usage-guide metrics-api/rate-limits ``` -------------------------------- ### AvaCloud SDK - Get Started Source: https://developers.avacloud.io/webhooks-api/webhooks/list-webhooks Guides for getting started with the AvaCloud SDK, covering authentication, global parameters, retries, pagination, error handling, and custom HTTP configurations. ```APIDOC avacloud-sdk/getting-started Description: Initial steps to set up and use the AvaCloud SDK. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC avacloud-sdk/authentication Description: Details on authenticating with the AvaCloud SDK. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC avacloud-sdk/global-parameters Description: Explanation of global parameters applicable to SDK requests. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC avacloud-sdk/retries Description: Information on configuring retry mechanisms for SDK requests. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC avacloud-sdk/pagination Description: Details on handling pagination for SDK responses. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC avacloud-sdk/error Description: Information on error handling within the AvaCloud SDK. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` ```APIDOC avacloud-sdk/custom-http Description: Guide on customizing HTTP client configurations for the SDK. Parameters: (Details not provided in source) Returns: (Details not provided in source) ``` -------------------------------- ### Metrics API: Get Started Source: https://developers.avacloud.io/data-api/primary-network-transactions/list-latest-transactions Guides for the Metrics API, covering overview, getting started, usage guide, and rate limits. ```APIDOC metrics-api/overview metrics-api/getting-started metrics-api/usage-guide metrics-api/rate-limits ``` -------------------------------- ### Data API Getting Started Source: https://developers.avacloud.io/metrics-api Guides users through the initial steps to start using the Data API, including authentication and making the first requests. It outlines prerequisites and basic usage patterns. ```APIDOC Data API: Getting Started: - Prerequisites: [List of requirements, e.g., API key] - Authentication: [Details on how to authenticate requests] - First Request: [Example of a simple API call] - Response Format: [Description of typical response structure] ``` -------------------------------- ### Webhooks API - Get Started Source: https://developers.avacloud.io/data-api/primary-network-transactions/list-latest-transactions Guides users through the initial setup and concepts of the Webhooks API. Covers essential topics like overview, getting started, signature verification, supported chains, webhook vs. WebSocket differences, retry mechanisms, and rate limits. ```APIDOC APIDOC: Group: Webhooks API - Get Started Endpoints: - GET /webhooks-api/overview - GET /webhooks-api/getting-started - GET /webhooks-api/signature - GET /webhooks-api/supported-chains - GET /webhooks-api/wss-vs-webhooks - GET /webhooks-api/retries - GET /webhooks-api/rate-limits ``` -------------------------------- ### AvaCloud SDK - Getting Started & Core Concepts Source: https://developers.avacloud.io/data-api/evm-chains/get-chains-for-address Guides for setting up and using the AvaCloud SDK. Covers initial setup, authentication methods, handling global parameters, implementing retries, managing pagination, and error handling strategies. ```SDK ## Getting Started Provides an overview and initial steps to integrate the AvaCloud SDK into your web3 applications. ## Authentication Details on how to authenticate your requests to the AvaCloud API, typically involving API keys or other credentials. ## Global Parameters Information on common parameters that can be applied across multiple API requests to customize behavior or filter results. ## Retries Strategies and configurations for handling transient network errors or API rate limits by automatically retrying failed requests. ## Pagination Methods for efficiently retrieving large datasets by implementing pagination, including cursor-based or offset-based approaches. ## Error Handling Guidance on how to interpret and respond to various error codes and messages returned by the AvaCloud API. ``` -------------------------------- ### AvaCloud SDK: Getting Started Source: https://developers.avacloud.io/data-api/evm-chains/get-chains-for-address Guides for setting up and beginning to use the AvaCloud SDK. ```APIDOC avacloud-sdk/getting-started - Provides initial steps for integrating the AvaCloud SDK into your project. - Includes installation instructions and basic usage examples. avacloud-sdk/authentication - Details on how to authenticate your requests using API keys or other credentials. avacloud-sdk/global-parameters - Explains common parameters applicable across multiple SDK methods. avacloud-sdk/retries - Information on the SDK's retry mechanisms for handling transient network issues. avacloud-sdk/pagination - Guidance on how to paginate through large result sets returned by the SDK. avacloud-sdk/error - Documentation on error handling and common error codes returned by the SDK. avacloud-sdk/custom-http - Instructions for customizing HTTP client configurations within the SDK. ``` -------------------------------- ### Metrics API - Get Started Source: https://developers.avacloud.io/data-api/evm-transactions/list-erc-transfers Guides for using the Metrics API, covering overview, getting started, usage guide, and rate limits. ```APIDOC metrics-api/overview metrics-api/getting-started metrics-api/usage-guide metrics-api/rate-limits ``` -------------------------------- ### AvaCloud SDK: Getting Started Source: https://developers.avacloud.io/webhooks-api/webhooks/list-adresses-by-webhook Provides an introduction to the AvaCloud SDK, detailing its purpose, installation, and basic usage for interacting with Avalanche networks. ```markdown ## Getting Started with AvaCloud SDK Welcome to the AvaCloud SDK! This SDK simplifies your development experience by providing a unified interface to interact with Avalanche subnets and the broader Avalanche ecosystem. ### Installation Install the SDK using npm or yarn: ```bash npm install avacloud-sdk # or yarn add avacloud-sdk ``` ### Basic Usage Initialize the SDK and make your first call: ```javascript import AvaCloudSDK from 'avacloud-sdk'; const sdk = new AvaCloudSDK({ apiKey: 'YOUR_API_KEY', apiSecret: 'YOUR_API_SECRET' }); async function getSubnets() { try { const subnets = await sdk.getSubnets(); console.log('Available Subnets:', subnets); } catch (error) { console.error('Error fetching subnets:', error); } } getSubnets(); ``` This guide covers installation, authentication, and basic SDK operations. ``` -------------------------------- ### Avalanche Data API - Getting Started Source: https://developers.avacloud.io/data-api/evm-chains/list-latest-transactions-for-all-supported-evm-chains Guides new users through the initial steps of setting up and making their first calls to the Avalanche Data API. ```APIDOC Avalanche Data API - Getting Started: - getting-started: Initial setup and first API calls. ```