Giter VIP home page Giter VIP logo

valorant-api's Introduction

valorant-wrapper

A wrapper for the third-party valorant-api

How to Use

All endpoints can be accessed off the ValAPI class.

import { ValAPI } from 'valorant-wrapper'; // TS
const { ValAPI } = require('valorant-wrapper'); // JS

This class is static, and thus does not need to be instantiated to access the endpoints. All individual endpoint classes under ValAPI can be imported. To retrieve data from a specific endpoint, specify the class to fetch from in within ValAPI. Within each class exists the available endpoints to call the API. All methods support an optional language and uuid parameter.

Examples

Get a list of all maps

await ValAPI.maps.get();
// Expected Return: Map Array

Get a list of all playable agents

await ValAPI.agents.get({ isPlayableCharacter: true });
// Expected Return: Playable Agent Array

Get a Weapon for a given Weapon UUID

await ValAPI.weapons.get({ uuid: 'WEAPON_UUID' });
// Expected Return: Weapon Object

Get a list of Weapon Skin Chromas

await ValAPI.weapons.getSkinChromas();
// Expected Return: Weapon Skin Chroma Array

Check when a given Event ends

(await ValAPI.get({ uuid: 'EVENT_UUID' })).endTime
// Expected Return: Date

Documentation

Full documentation for the available endpoints and their respective return types can be found on the Valorant API Docs. Type declarations have been included in this package.

valorant-api's People

Contributors

aircraftoverviewer avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  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.