ethplorer-js
TypeScript icon, indicating that this package has built-in type declarations

0.0.7 • Public • Published

#ethplorer-js

A promise based Nodejs library to interface with the Ethplorer API

##Usage Import the Libary:

import { Ethplorer } from 'ethplorer-js';
// or
let Ethplorer = require('ethplorer-js').Ethplorer

To initialize:

let api = new Ethplorer('<Your Key Here>'); 
// or
let api = new Ethplorer(); // will use freekey instead

Then use any of the methods, described here. e.g

api.getTokenInfo(address)
    .then(data => {
    /*
     data is the object returned by the api,
    */
})

Any optional parameters can be passed as an optional argument. e.g

api.getTokenPriceHistoryGrouped(address,{ period: 30 })
    .then(data => {

})

// getTop doesn't have an initial argument so the first argument is the optional parameters
api.getTop({limit: 10})
    .then(data => {

})

Errors

The response object from the functions can be the error object from the Ethplorer API, you can either handle it manually like so:

api.getTokenInfo(address)
.then(data => {
    if("error" in data){
        // handle the error object
    }
    else {
        // ethplorer data returned from response
    }
})

Alternatively

function handleEthplorerError(response){
    if("error" in data){
        throw data;
    }
    return data;
}

api.getTokenInfo(address)
.then(handleEthplorerError)
.then(data => {

})
.catch(err => {
    // the error here is either the axios error or the error object from ethplorer
})

Typescript

If you're using Typescript all requests and responses are fully typed according to the Ethplorer API.

Note: If you have any trouble with the typescript autocomplete from the response, you may need to check if the result is an error or not for typehinting to come back, as shown above.

Readme

Keywords

none

Package Sidebar

Install

npm i ethplorer-js

Weekly Downloads

6

Version

0.0.7

License

ISC

Unpacked Size

23.7 kB

Total Files

7

Last publish

Collaborators

  • laquasicinque