README.md

Askobar Token Supply API

This API fetches Askobar's Token (ASKO) total supply, circulating supply and locked tokens.

Installation

Use the package manager yarn.

To install dependencies:

yarn

Running the project

To start the project:

yarn start

To run the project with nodemon's live reload:

yarn dev

To run the project's tests:

yarn test

Total Supply

You get: ASKO's total supply amount.

Request:

GET /totalSupply HTTP/1.1

Successful Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "value": "123456"
}

Failed Response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "message": "An unexpected error has ocurred",
}

Circulating Supply

You get: ASKO's circulating supply amount.

Request:

GET /circulatingSupply HTTP/1.1

Successful Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "value": "123456"
}

Failed Response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "message": "An unexpected error has ocurred",
}

Locked Tokens

You get: ASKO's locked tokens amount.

Request:

GET /lockedTokens HTTP/1.1

Successful Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "value": "123456"
}

Failed Response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "message": "An unexpected error has ocurred",
}

Response Format

All endpoint responses from this API can be request in different formats.

Decimals

To override the default 0 decimals response format, pass decimals URL parameter with true, and it will format the response to an 18 decimals number string:

GET /circulatingSupply?decimals=true HTTP/1.1

Content Format

To override the default application/json response format, pass format URL parameter with one of the currently supported alternative formats:

GET /circulatingSupply?format=text HTTP/1.1

Valid format values:

• text: text/plain