@yaelouuu/fortnite-api 1.3.0 → 2.0.0

package/README.md

@@ -8,6 +8,10 @@ JavaScript/TypeScript SDK for the Fortnite API by Royal Arena.
 npm install @yaelouuu/fortnite-api
 ```
 
+## API Key
+
+Acquire your API Key by creating a Free Account here : https://api-fortnite.com
+
 ## Quick Start
 
 ```typescript

package/dist/resources/tournaments.d.ts

@@ -5,42 +5,62 @@ export declare class TournamentsResource {
     constructor(client: FortniteAPI);
     /**
      * Get current events
+     * No parameters needed - uses API's default account
      */
-    getCurrent(params?: {
-        accountId?: string;
-    }): Promise<any>;
+    getCurrent(): Promise<any>;
     /**
      * Get past events
+     * No parameters needed - uses API's default account
      */
-    getPast(params?: {
-        accountId?: string;
-    }): Promise<any>;
+    getPast(): Promise<any>;
     /**
-     * Get global events
+     * Get global events with metadata
      */
     getGlobal(): Promise<any>;
+    /**
+     * Download events for a specific account
+     * Requires user's own Fortnite token
+     * @param params.accountId - Epic Games Account ID
+     * @param params.region - Region (EU, NAE, NAW, etc.)
+     * @param params.platform - Platform (Windows, PlayStation, etc.)
+     * @param fortniteToken - User's Fortnite access token (from OAuth flow)
+     */
+    download(params: {
+        accountId: string;
+        region: string;
+        platform: string;
+    }, fortniteToken: string): Promise<any>;
     /**
      * Get tournament leaderboard
+     * @param params.eventId - Event ID
+     * @param params.eventWindowId - Event window ID
+     * @param params.page - Page number (default: 0)
+     * @param params.leaderboardDef - Optional leaderboard definition
+     * @param params.accountId - Optional account ID to highlight
+     * @param fortniteToken - Optional user's Fortnite token for personalized view
      */
     getLeaderboard(params: {
         eventId: string;
         eventWindowId: string;
         page?: number;
         leaderboardDef?: string;
-    }): Promise<Leaderboard>;
+        accountId?: string;
+    }, fortniteToken?: string): Promise<Leaderboard>;
     /**
      * Get tournament participation history for a player
-     * GET /tournament-tracker
+     * Requires user's own Fortnite token
      * @param accountId - Epic Games Account ID
      * @param fortniteToken - User's Fortnite access token (from OAuth flow)
      */
     getTracker(accountId: string, fortniteToken: string): Promise<TournamentTrackerResponse>;
     /**
      * Check if a player is eligible for major tournaments
-     * GET /tournament-eligibility
+     * Requires user's own Fortnite token
      * @param accountId - Epic Games Account ID
      * @param fortniteToken - User's Fortnite access token (from OAuth flow)
      * @param options - Optional configuration for eligibility check
+     * @param options.days - Number of days to check (default: 180, max: 365)
+     * @param options.requiredTournaments - Required tournaments for eligibility (default: 14, max: 50)
      */
     checkEligibility(accountId: string, fortniteToken: string, options?: {
         days?: number;

package/dist/resources/tournaments.js

@@ -7,44 +7,78 @@ class TournamentsResource {
     }
     /**
      * Get current events
+     * No parameters needed - uses API's default account
      */
-    async getCurrent(params) {
-        const queryString = params?.accountId
-            ? `?accountId=${params.accountId}`
-            : "";
-        return this.client.request(`/events/data/current${queryString}`);
+    async getCurrent() {
+        return this.client.request("/events/data/current");
     }
     /**
      * Get past events
+     * No parameters needed - uses API's default account
      */
-    async getPast(params) {
-        const queryString = params?.accountId
-            ? `?accountId=${params.accountId}`
-            : "";
-        return this.client.request(`/events/data/past${queryString}`);
+    async getPast() {
+        return this.client.request("/events/data/past");
     }
     /**
-     * Get global events
+     * Get global events with metadata
      */
     async getGlobal() {
         return this.client.request("/events/global");
     }
+    /**
+     * Download events for a specific account
+     * Requires user's own Fortnite token
+     * @param params.accountId - Epic Games Account ID
+     * @param params.region - Region (EU, NAE, NAW, etc.)
+     * @param params.platform - Platform (Windows, PlayStation, etc.)
+     * @param fortniteToken - User's Fortnite access token (from OAuth flow)
+     */
+    async download(params, fortniteToken) {
+        const query = new URLSearchParams({
+            accountId: params.accountId,
+            region: params.region,
+            platform: params.platform,
+        }).toString();
+        return this.client.request(`/events/download?${query}`, {
+            headers: {
+                "x-fortnite-token": fortniteToken,
+            },
+        });
+    }
     /**
      * Get tournament leaderboard
+     * @param params.eventId - Event ID
+     * @param params.eventWindowId - Event window ID
+     * @param params.page - Page number (default: 0)
+     * @param params.leaderboardDef - Optional leaderboard definition
+     * @param params.accountId - Optional account ID to highlight
+     * @param fortniteToken - Optional user's Fortnite token for personalized view
      */
-    async getLeaderboard(params) {
-        const { eventId, eventWindowId, page = 0, leaderboardDef } = params;
+    async getLeaderboard(params, fortniteToken) {
+        const { eventId, eventWindowId, page = 0, leaderboardDef, accountId, } = params;
         const query = new URLSearchParams({
             eventId,
             eventWindowId,
             page: page.toString(),
-            ...(leaderboardDef && { leaderboardDef }),
-        }).toString();
-        return this.client.request(`/events/leaderboard?${query}`);
+        });
+        if (leaderboardDef) {
+            query.append("leaderboardDef", leaderboardDef);
+        }
+        if (accountId) {
+            query.append("accountId", accountId);
+        }
+        const options = fortniteToken
+            ? {
+                headers: {
+                    "x-fortnite-token": fortniteToken,
+                },
+            }
+            : undefined;
+        return this.client.request(`/events/leaderboard?${query.toString()}`, options);
     }
     /**
      * Get tournament participation history for a player
-     * GET /tournament-tracker
+     * Requires user's own Fortnite token
      * @param accountId - Epic Games Account ID
      * @param fortniteToken - User's Fortnite access token (from OAuth flow)
      */
@@ -57,10 +91,12 @@ class TournamentsResource {
     }
     /**
      * Check if a player is eligible for major tournaments
-     * GET /tournament-eligibility
+     * Requires user's own Fortnite token
      * @param accountId - Epic Games Account ID
      * @param fortniteToken - User's Fortnite access token (from OAuth flow)
      * @param options - Optional configuration for eligibility check
+     * @param options.days - Number of days to check (default: 180, max: 365)
+     * @param options.requiredTournaments - Required tournaments for eligibility (default: 14, max: 50)
      */
     async checkEligibility(accountId, fortniteToken, options) {
         const params = new URLSearchParams({ accountId });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@yaelouuu/fortnite-api",
-  "version": "1.3.0",
-  "description": "SDK for Fortnite Tournaments API by Royal Arena - Author : yaelouuu",
+  "version": "2.0.0",
+  "description": "SDK for Fortnite Tournaments API by Royal Arena - Author : Yael Brinkert",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -15,7 +15,7 @@
     "tournaments",
     "sdk"
   ],
-  "author": "Your Name",
+  "author": "Yael BRINKERT",
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^20.0.0",