# icowatchlist

> A simple Node.js API wrapper for icowatchlist.com

Latest version **1.1.0** (published 2022-04-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install icowatchlist
pnpm add icowatchlist
yarn add icowatchlist
bun add icowatchlist
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2022-04-04 |
| First published | 2018-02-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | Ziv Eli |
| Maintainers | zbone3 |
| Keywords | ico, cryptocurrency, api, icowatchlist |

## Links

- npm: https://www.npmjs.com/package/icowatchlist
- Repository: https://github.com/zbone3/icowatchlist
- Homepage: https://github.com/zbone3/icowatchlist#readme
- Issues: https://github.com/zbone3/icowatchlist/issues
- npm.io page: https://npm.io/package/icowatchlist

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.26.1

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2022-04-04
- 1.0.1 — 2019-10-24
- 1.0.0 — 2018-02-13

## README

# icowatchlist
A simple Node.js API wrapper for icowatchlist.com 

## Installation
`npm install icowatchlist`


## Usage
### Initializing
 ```js 
 
const ICOWatchlist = require('icowatchlist');

```

### API Examples
The wrapper returns a promise for all request types, so you can use `Promise.then()` or `async/await` to get the results
```js
// Get all ICOs
ICOWatchlist.getAll();

// Get Live ICOs only
ICOWatchlist.getLive();

// Get Upcoming ICOs only
ICOWatchlist.getUpcoming();

// Get Finished ICOs only
ICOWatchlist.getFinished();


// Use with Promise.then()

ICOWatchlist.getLive().then(function(response) {
  // print name of first Live ICO
  console.log(response[0].name);
});


// Use with async function 

(async function() {
  let allICOs =  await ICOWatchlist.getAll();
  // Print array of the upcoming ICOs 
  console.log(allICOs.upcoming);
})();


```

### API Reference
This table maps the original API to the wrapper functions and their results.  


| Original API        | Wrapper                      | Result                 |
|---------------------|------------------------------|------------------------|
| /public/v1/         | ICOWatchlist.getAll          | Object: {"live": [...], "upcoming": [...], "finished": [...]}               |
| /public/v1/live     | ICOWatchlist.getLive         | Array                  |
| /public/v1/upcoming     | ICOWatchlist.getUpcoming | Array                  |    
| /public/v1/finished      | ICOWatchlist.getFinished| Array|				  |

---
_Source: https://npm.io/package/icowatchlist · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._