1.0.0 • Published 7 years ago

boat-list-api v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
7 years ago

https://boat-list.glitch.me API!

The following are the available functions for this api:

Making the client:

const blClient = require('boat-list-api');

Getting a bot by id:

blClient.getBot('BOT ID').then(bot => {
    console.log(bot); //This logs something like this:
    {
        id: 'BOT ID',
        name: 'Bots username#discriminator',
        prefix: 'Bots prefix',
        hc: 'Bots help command',
        owner: {
            id: 'owners id',
            tag: 'Owners username#discriminator'
        },
        desc: 'Bots description'
        }
})

Getting all bots:

blClient.getAllBots().then(bots => {
    console.log(bots); //this returns an array of data similar to get bot BUT: the owner value is only the id
});

Getting bot count:

blClient.botCount().then(botCount => {
    console.log(botCount); //Returns number of bots currently in the list.
});

Getting a users tag (unrelated):

blClient.getTag('USER ID').then(tag => {
    console.log(tag); //returns the users tag, (Why?).
});