Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 3.5 KB

README.md

File metadata and controls

67 lines (45 loc) · 3.5 KB
Raw

AVALANCHE_PLATFORM

2.0.23 v3

This document was generated automatically. Please see README Generator for more info.

Known Issues

MAX_PAYLOAD_SIZE_LIMIT configuration

The MAX_PAYLOAD_SIZE_LIMIT environment variable is used for controlling the maximum size of the incoming request body that the EA can handle. If you decide to customize this value it's essential to ensure that any reverse proxy or web server in front of the EA, such as Nginx, is also configured with a corresponding limit. This alignment prevents scenarios where Nginx rejects a request for exceeding its payload size limit before it reaches the EA.

Environment Variables

Required? Name Description Type Options Default
✅ P_CHAIN_RPC_URL Full RPC URL for the avalanche platform chain (e.g. https://api.avax.network/ext/bc/P) string

Data Provider Rate Limits

Name Requests/credits per second Requests/credits per minute Requests/credits per hour Note
default 6 Considered unlimited tier, but setting reasonable limits

Input Parameters

Required? Name Description Type Options Default
endpoint The endpoint to use string balance balance

Balance Endpoint

balance is the only supported name for this endpoint.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ addresses result An array of addresses to get the balances of (as an object with string address as an attribute) object[]
✅ addresses.address an address to get the balance of string
addresses.network the name of the network protocol string avalanche

Example

Request:

{
  "data": {
    "endpoint": "balance",
    "addresses": [
      {
        "address": "P-fuji1vd9sddlllrlk9fvj9lhntpw8t00lmvtnqkl2jt",
        "network": "avalanche-fuji"
      }
    ]
  }
}

MIT License