Skip to content

Latest commit

 

History

History
62 lines (52 loc) · 980 Bytes

README.md

File metadata and controls

62 lines (52 loc) · 980 Bytes

coincap

coincap NPM module

Installation

npm install coincap

Example & Structure

All methods return a result in the following object structure

{
    result: boolean // indicates if call returned 200 or not
    statusCode: number // indicates statusCode number returned by call
    data: response // contains respose body. If result is set to true, this is a JSON object otherwise string
}
const result = await coincap.getCoins();
if (result.result) {
    console.log(result.data);
}

Usage

###getCoins

coincap.getCoins().then(result => {
    //do something
});

###map

coincap.map().then(result => {
    //do something
});

###front

coincap.front().then(result => {
    //do something
});

###global

coincap.global().then(result => {
    //do something
});

###getCoin(coin)

coincap.getCoin('BTC').then(result => {
    //do something
});