Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bladelist/bbl-api

That's the official npm module which provide a easy method to post how many servers your bot have easly on the bladebotlist's API !
https://github.com/bladelist/bbl-api

bbl-api bladebotlist botlist discordbotlist nodejs servers-count

Last synced: about 1 month ago
JSON representation

That's the official npm module which provide a easy method to post how many servers your bot have easly on the bladebotlist's API !

Awesome Lists containing this project

README

        

Welcome to bbl-api 👋




Version


Documentation


Maintenance


License: mit


Twitter: bladebotlist

> The official bladebotlist.xyz's api to post your server count easly and interact with the bladebotlist api

### 🏠 [Homepage](https://docs.bladebotlist.xyz)

## Install

```sh
npm install bbl-api
```

## Usage

```js
const BBL = require("bbl-api");
const client = new BBL(
"BOT ID", // BOT_ID
"THE API KEY", // API_KEY, use bbl!key gen on the discord server
{
server_count: "2",
interval: 300000,
});

client.on("ready", () => console.log("Client is started !")); // when the module is loaded and ready to post data

client.on("debug", (log) => console.log(log))

client.on("update", () => console.log("Stats updated !")); // autopost or manual post

client.on("error", (error) => console.log(`Something was wrong when the module has posted stats: ${error}`)); // complete reports about errors like invalid api key or bot id
```

you can also checkout the exemples directory where you can see some examples :P

## Author

👤 ****

* Website: http://hiizun.codes
* Twitter: [@HiiZunfr](https://twitter.com/HiiZunfr)
* Github: [@hiizun](https://github.com/hiizun)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/bladebotlist/bbl-api/issues). You can also take a look at the [contributing guide](https://github.com/bladebotlist/bbl-api/blob/master/CONTRIBUTING.md).

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2020 [NaoismyWaifu](https://github.com/Naoismywaifu).

This project is [MIT](https://github.com/bladebotlist/bbl-api/blob/master/LICENSE) licensed.