r6-data.js 2.0.0 → 2.1.0

package/README.md

@@ -21,6 +21,8 @@ npm i r6-data.js
 
 ## API Key
 
+> **Notice:** Due to the abuse of the available APIs, it has been decided that from now on, in order to use both the package and the APIs, it is necessary to register on the website and create an API key.
+
 To use this package, you need an **API Key**. 
 You can obtain your API Key by registering on the official website: **[r6data.eu](https://r6data.eu/)**.
 Once registered, you can generate your personal API Key from your account settings.
@@ -299,6 +301,50 @@ The `getSeasonalStats()` function accepts the API Key and an object with the fol
             }
 ```
 
+## Getting Operator Statistics
+
+The `getOperatorStats()` function allows you to get detailed operator statistics for a specific player.
+
+```javascript
+const r6Info = require('r6-data.js');
+
+async function main() {
+  try {
+    const apiKey = 'YOUR_API_KEY';
+
+    // Get operator statistics for a player
+    const operatorStats = await r6Info.getOperatorStats(apiKey, {
+      nameOnPlatform: 'PlayerName',
+      platformType: 'uplay',
+      // seasonYear: 'Y9S4', // Optional
+      // modes: 'ranked'     // Optional, default is 'ranked'
+    });
+
+    console.log('Operator statistics:', operatorStats);
+    return operatorStats;
+    
+  } catch (error) {
+    console.error('Error retrieving operator statistics:', error.message);
+  }
+}
+
+main();
+```
+
+### Parameters
+
+The `getOperatorStats()` function accepts the API Key and an object with the following parameters:
+
+- `apiKey`: (Required) Your API Key from r6data.eu
+- `nameOnPlatform`: (Required) The player's name on the platform
+- `platformType`: (Required) The platform type - "uplay", "psn", or "xbl"
+- `seasonYear`: (Optional) Season year (e.g., Y9S4, Y10S4)
+- `modes`: (Optional) Game mode (ranked, casual, unranked). Default is 'ranked'.
+
+### Operator Statistics Response
+
+The response contains detailed statistics for each operator played by the user.
+
 ## Getting Game Statistics
 
 The `getGameStats()` function allows you to get real-time player count statistics across all platforms including Steam, Ubisoft Connect, PlayStation, Xbox, and total player counts

package/index.js

@@ -13,6 +13,7 @@ const getPlayerStats = require('./methods/getPlayerStats');
 const createDiscordR6Webhook = require('./methods/createDiscordR6Webhook');
 const getGameStats = require('./methods/getGameStats');
 const getSeasonalStats = require('./methods/getSeasonalStats');
+const getOperatorStats = require('./methods/getOperatorStats');
 const getPlayerComparisons = require('./methods/getPlayerComparisons');
 const getIsBanned = require('./methods/getIsBanned');
 
@@ -33,6 +34,7 @@ module.exports = {
   createDiscordR6Webhook,
   getGameStats,
   getSeasonalStats,
+  getOperatorStats,
   getPlayerComparisons,
   getIsBanned,
 };
@@ -53,5 +55,6 @@ module.exports.getPlayerStats = getPlayerStats;
 module.exports.createDiscordR6Webhook = createDiscordR6Webhook;
 module.exports.getGameStats = getGameStats;
 module.exports.getSeasonalStats = getSeasonalStats;
+module.exports.getOperatorStats = getOperatorStats;
 module.exports.getPlayerComparisons = getPlayerComparisons;
 module.exports.getIsBanned = getIsBanned;

package/methods/getOperatorStats.js

@@ -0,0 +1,54 @@
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+/**
+ * Get Rainbow Six Siege operator stats
+ * @param {string} apiKey - Your API Key from r6data.eu
+ * @param {Object} params - Parameters for the request
+ * @param {string} params.nameOnPlatform - Player name on the platform
+ * @param {string} params.platformType - Platform type (uplay, psn, xbl)
+ * @param {string} [params.seasonYear] - Season year (e.g., Y9S4, Y10S4)
+ * @param {string} [params.modes] - Game mode (ranked, casual, unranked). Default is 'ranked'.
+ * @returns {Promise<Object>} - Operator stats
+ */
+async function getOperatorStats(apiKey, { nameOnPlatform, platformType, seasonYear, modes } = {}) {
+  try {
+    // Validate required parameters
+    if (!apiKey) {
+      throw new Error('Missing required parameter: apiKey');
+    }
+    if (!nameOnPlatform || !platformType) {
+      throw new Error('Missing required parameters: nameOnPlatform, platformType');
+    }
+
+    // Build the URL with parameters
+    const params = {
+      type: 'operatorStats',
+      nameOnPlatform,
+      platformType,
+      modes
+    };
+
+    if (seasonYear) {
+      params.seasonYear = seasonYear;
+    }
+
+    const url = buildUrlAndParams('/stats', params);
+
+    const response = await axiosInstance.get(url, {
+      headers: {
+        'api-key': apiKey
+      }
+    });
+    
+    return response.data;
+  } catch (error) {
+    console.error('Error during the getOperatorStats request:', error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('Authentication error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getOperatorStats;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "r6-data.js",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "R6 (Rainbow Six Siege) API wrapper for player stats, operators, maps, ranks, seasons, charms, skins and game datas. Last Updated Y10S4",
   "main": "index.js",
   "module": "index.js",

package/types/function-declarations.d.ts

@@ -5,6 +5,7 @@ import {
   GetIsBannedParams,
   PlayerStatsParams,
   SeasonalStatsParams,
+  OperatorStatsParams,
   PlayerComparisonsParams,
   GetMapsParams,
   GetOperatorsParams,
@@ -27,6 +28,7 @@ export function getAccountInfo(apiKey: string, params: AccountInfoParams): Promi
 export function getIsBanned(apiKey: string, params: GetIsBannedParams): Promise<any>;
 export function getPlayerStats(apiKey: string, params: PlayerStatsParams): Promise<any>;
 export function getSeasonalStats(apiKey: string, params: SeasonalStatsParams): Promise<any>;
+export function getOperatorStats(apiKey: string, params: OperatorStatsParams): Promise<any>;
 export function getServiceStatus(apiKey: string): Promise<any>;
 export function getGameStats(apiKey: string): Promise<GameStats>;
 export function getMaps(apiKey: string, params?: GetMapsParams): Promise<any[]>;

package/types/params-interfaces.d.ts

@@ -16,6 +16,11 @@ export interface PlayerStatsParams extends AccountInfoParams {
 
 export interface SeasonalStatsParams extends AccountInfoParams {}
 
+export interface OperatorStatsParams extends AccountInfoParams {
+  seasonYear?: string;
+  modes?: 'ranked' | 'casual' | 'unranked';
+}
+
 export interface PlayerComparisonsParams {
   players: Array<{
     nameOnPlatform: string;