Avail Light Client API reference
BEFORE WE START
- The indiviual behaviour of some methods may differ depending on which mode the light client is runnning in.
- It is recommended to use
API-v2
overAPI-v1
, although both are supported. - The Avail light client(Avail LC) can run in two modes:
Light-client
orApp-client
. We internally maintain a light client instance available for public use running in theLight-client
mode. Thus, for all methods that can be called via an LC running in theLight-client
mode, devs can use our public endpoint. - For methods that require an LC running in the
App-client
mode, you will need to run a local instance of the Avail LC. - You can check out or docs for instructions on running your own instance of the Avail light client
- The LC API is exposed by default through
localhost:7007
by default.
Setting up the dev environment
Set up your dev enviornment with curl
and Rust
:
- To use the Avail light client API with
curl
, you just need to havecurl
installed on your system. You can check if it is installed by running:
curl --version
- If this does not work, go to curl's website (opens in a new tab) to install it on your system.