Using Yarn:
yarn add @proton/light-api
or using NPM:
npm install --save @proton/light-api
CommonJS
const { JsonRpc } = require("@proton/light-api")
const rpc = new JsonRpc("proton")
TypeScript
import { JsonRpc } from "@proton/light-api"
const rpc = new JsonRpc("proton")
- LIGHT API HTTP Javascript library
- Installation
- Quick Start
- API
- Table of Contents
- JsonRpc
- Error
JsonRpc
endpoint
string LIGHT API endpoint
const rpc = new JsonRpc("proton")
[GET /api/account]
Retrieve all token balances, resources and authorization information for an account:
accountName
string name of account
Returns Promise<GetAccount> account
[GET /api/accinfo]
Retrieve all resources and authorization information for an account:
accountName
string name of account
Returns Promise<GetAccountInfo> account
[GET /api/balances]
Retrieve only token balances for an account
accountName
string name of account
Returns Promise<GetBalances> balances
[GET /api/key]
Retrieve all accounts in all known EOS networks dependent on a public key:
key
string public key
Returns Promise<Array<GetKeyAccounts>> accounts per network
[GET /api/key]
Retrieve all accounts in network
key
string public key
Returns Promise<GetKeyAccounts> accounts
[GET /api/networks]
Retrieve all accounts in all known EOS networks dependent on a public key:
Returns Promise<GetNetworks> accounts
[GET /api/sync]
returns a plain text with delay in seconds that this server's blockchain database is behind the real time, and a status: OK if the delay is within 180 seconds, or 'OUT_OF_SYNC' otherwise.
Returns Promise<string> get sync
[GET /api/tokenbalance]
returns a plain text with numeric output indicating the token balance. Zero is returned if the token is not present or does not exist.
Returns Promise<string> token balance
[GET /api/topholders]
returns top NUM holders of a specified token in a JSON array containing arrays of (account, amount) pairs. NUM must not be less than 10 or more than 1000.
contract
string token contracttoken
string token symbolnum
string number of top holders (min 10, max 1000)
Returns Promise<string> token balance
[GET /api/usercount]
returns a plain text with total number of accounts in the network.
Returns Promise<string> token balance
[GET /api/topram]
returns top NUM RAM buyers in a JSON array containing arrays of (account, bytes) pairs. NUM must not be less than 10 or more than 1000.
num
string number of top holders (min 10, max 1000)
Returns Promise<GetTopRam> top ram holders
[GET /api/topstake]
returns top NUM RAM buyers in a JSON array containing arrays of (account, bytes) pairs. NUM must not be less than 10 or more than 1000.
num
string returns top NUM stake holders by sum of CPU and Net stakes, in a JSON array containing arrays of (account, cpu_weight, net_weight) tuples. NUM must not be less than 10 or more than 1000.
Returns Promise<GetTopStake> top stake holders
[GET /api/codehash]
retrieves all accounts in all known EOS networks by contract hash.
hash
num
string returns top NUM stake holders by sum of CPU and Net stakes, in a JSON array containing arrays of (account, cpu_weight, net_weight) tuples. NUM must not be less than 10 or more than 1000.
Returns Promise<GetCodehash> accounts
[GET /api/holdercount]
returns a plaintext integer indicating the number of accounts with positive balance for a specified token.
[WS get_token_holders]
Get all token holders of a contract and symbol
contract
token contracttoken
token symbol
[WS get_accounts_from_keys]
Get all token holders of a contract and symbol
keys
keys[]
array of keys