# @r6index/sdk

> NodeJS kit for working with our Rainbow Six Siege API.

Latest version **0.1.1** (published 2023-03-21) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @r6index/sdk
pnpm add @r6index/sdk
yarn add @r6index/sdk
bun add @r6index/sdk
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2023-03-21 |
| First published | 2023-03-21 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 46.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | t3ned-oss |
| Keywords | api, sdk, siege, r6, node |

## Links

- npm: https://www.npmjs.com/package/@r6index/sdk
- Repository: https://github.com/R6IndexAPI/r6index-sdk-nodejs
- Homepage: https://github.com/R6IndexAPI/r6index-sdk-nodejs#readme
- Issues: https://github.com/R6IndexAPI/r6index-sdk-nodejs/issues
- npm.io page: https://npm.io/package/@r6index/sdk

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^1.3.2
- [tiny-typed-emitter](https://npm.io/package/tiny-typed-emitter.md) ^2.1.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2023-03-21
- 0.1.0 — 2023-03-21

## README

<div align="center">
<!-- <img src="" align="center" width="80%" alt="banner"> -->
<br>
<br>
<img src="https://img.shields.io/github/package-json/v/R6IndexAPI/r6index-sdk-nodejs" align="center" alt="">
<img src="https://img.shields.io/npm/dm/@r6indexapi/sdk" align="center" alt="">
<img src="https://img.shields.io/github/license/R6IndexAPI/r6index-sdk-nodejs" align="center" alt="">
<img src="https://img.shields.io/github/issues/R6IndexAPI/r6index-sdk-nodejs" align="center" alt="">
<img src="https://img.shields.io/github/issues-pr/R6IndexAPI/r6index-sdk-nodejs" align="center" alt="">
<br>
<br>

**_NodeJS kit for working with our Rainbow Six Siege API._**

</div>

## 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

```sh
# NPM
> npm i @r6index/sdk

# YARN
> yarn add @r6index/sdk

# PNPM
> pnpm add @r6index/sdk
```

## Usage

#### Client

```ts
import { Client } from "@r6index/sdk";

const client = new Client({
	key: "your api key",
});
```

#### Methods

```ts
// 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();
```

---
_Source: https://npm.io/package/@r6index/sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._