API reference
Avail light client API reference

Avail Light Client API reference

BEFORE WE START

  1. The indiviual behaviour of some methods may differ depending on which mode the light client is runnning in. This will be documented in the individual method descriptions.
  2. It is recommended to use API-v2 over API-v1, although both are supported.
  3. The Avail light client(Avail LC) can run in two modes: Light-client or App-client. We internally maintain a light client instance available for public use running in the Light-client mode. Thus, for all methods that can be called via an LC running in the Light-client mode, we will use the public endpoint.
  4. For methods that require an LC running in the App-client mode, you will need to run a local instance of the Avail LC.
  5. You can check out or docs for instructions on running your own instance of the Avail light client

Setting up the dev environment

Set up your dev enviornment with curl and Rust:

  1. To use the Avail light client API with curl, you just need to have curl installed on your system. You can check if it is installed by running:
curl --version
  1. If this does not work, go to curl's website (opens in a new tab) to install it on your system.