@r6index/sdk
v0.1.1
Published
NodeJS kit for working with our Rainbow Six Siege API.
Downloads
6
Readme
NodeJS kit for working with our Rainbow Six Siege API.
About
R6Index is a reliable API service for Rainbow Six Siege. We make it easy to fetch stats - you don't need to store any data; we do it for you!
- Fetch seasonal player stats
- Query for platform-connected profiles
- Access a player's match history, including the datacenter and gamemode
- Retrieve a player's ban history
- Lifetime stats
Install
# NPM
> npm i @r6index/sdk
# YARN
> yarn add @r6index/sdk
# PNPM
> pnpm add @r6index/sdk
Usage
Client
import { Client } from "@r6index/sdk";
const client = new Client({
key: "your api key",
});
Methods
// Get extended profile by id
await client.getProfileById("f2f38d39-4a5d-4425-bdc1-f74c9a0c9da7");
// Get extended profile by username
await client.getProfileByUsername("head", "uplay");
// Get connected extended profiles by user id
await client.getConnectedProfiles("f2f38d39-4a5d-4425-bdc1-f74c9a0c9da7");
// Get battlepass by profile id
await client.getBattlepassByProfileId("f2f38d39-4a5d-4425-bdc1-f74c9a0c9da7");
// Get recent bans
await client.getBans();
// Get game status
await client.getGameStatus();