Giter VIP home page Giter VIP logo

voxyl-api's Introduction

A Voxyl API Client for Node

GitHub | NPM

Installation

npm install --save voxyl-api

Usage

Getting player information

const VoxylAPI = require('voxyl-api')

const client = new VoxylAPI('API-key')

client.getPlayerInfo('name', 'ObamaFootFungus').then((player) => {
	console.log(player)
}).catch((err) => {
	console.error('Error: ' + err)
})

Getting overall player stats

client.getPlayerOverallStats('name', 'ObamaFootFungus').then((player) => {
	console.log(player)
}).catch((err) => {
	console.error('Error: ' + err)
})

Getting player game stats

client.getPlayerGameStats('name', 'ObamaFootFungus').then((player) => {
	console.log(player)
}).catch((err) => {
	console.error('Error: ' + err)
})

Getting info about a guild

client.getGuildInfo('Guild-Tag').then((guild) => {
	console.log(guild)
}).catch((err) => {
	console.error('Error: ' + err)
})

Getting the members of a guild

client.getGuildMembers('Guild-Tag/ID').then((guild) => {
	console.log(guild)
}).catch((err) => {
	console.error('Error: ' + err)
})

Getting the top guilds

// number is the amount of guilds
client.getTopGuilds(number).then((guilds) => {
	console.log(guilds)
}).catch((err) => {
	console.error('Error: ' + err)
})

Getting announcements

client.getAnnouncements().then((announcements) => {
	console.log(announcements)
}).catch((err) => {
	console.error('Error: ' + err)
})

voxyl-api's People

Contributors

obamafootfungus avatar

Stargazers

rozzer avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.