@yaelouuu/fortnite-api 7.2.0 → 8.1.0

package/README.md

@@ -446,6 +446,31 @@ const history = await client.map.getHistory();
 
 ---
 
+### Sprites - **NEW**
+
+Seasonal Sprites catalog (Chapter 7 Season 3 extraction mechanic) — every sprite family and variant with rarity, icons, boons, and **live drop rates**. Drop weights include Epic's live hotfix overlay, so Power-Hour / "More Gem Sprites!" rotations show up without waiting for a game update.
+
+```typescript
+// Get the full catalog (families, variants, drop rates, level-up curve, event weight sets)
+const catalog = await client.sprites.getSprites();
+// catalog.data.sprites[0].variants[1].dropChancePercent -> e.g. 2 (% within the family)
+
+// Only Gold variants across all families
+const gold = await client.sprites.getSprites({ variant: "gold" });
+
+// Search by name, filter by rarity
+const ducks = await client.sprites.getSprites({ search: "duck" });
+const legendaries = await client.sprites.getSprites({ rarity: "legendary" });
+
+// One family — by family id, variant id, or display name
+const duck = await client.sprites.getSprite("DuckSprite");
+
+// All SpriteBoons perks with names and descriptions
+const boons = await client.sprites.getBoons();
+```
+
+---
+
 ### Playlists - **NEW**
 
 Fortnite playlists and game modes.

package/dist/client.d.ts

@@ -19,6 +19,7 @@ import { CosmeticsResource } from "./resources/cosmetics";
 import { CrewResource } from "./resources/crew";
 import { MapResource } from "./resources/map";
 import { PlaylistsResource } from "./resources/playlists";
+import { SpritesResource } from "./resources/sprites";
 export interface ClientOptions {
     apiKey: string;
     baseUrl?: string;
@@ -47,6 +48,7 @@ export declare class FortniteAPI {
     crew: CrewResource;
     map: MapResource;
     playlists: PlaylistsResource;
+    sprites: SpritesResource;
     constructor(options: ClientOptions);
     /**
      * Internal method to make HTTP requests

package/dist/client.js

@@ -23,6 +23,7 @@ const cosmetics_1 = require("./resources/cosmetics");
 const crew_1 = require("./resources/crew");
 const map_1 = require("./resources/map");
 const playlists_1 = require("./resources/playlists");
+const sprites_1 = require("./resources/sprites");
 class FortniteAPI {
     constructor(options) {
         this.apiKey = options.apiKey;
@@ -50,6 +51,7 @@ class FortniteAPI {
         this.crew = new crew_1.CrewResource(this);
         this.map = new map_1.MapResource(this);
         this.playlists = new playlists_1.PlaylistsResource(this);
+        this.sprites = new sprites_1.SpritesResource(this);
     }
     /**
      * Internal method to make HTTP requests

package/dist/resources/map.d.ts

@@ -4,16 +4,26 @@ export declare class MapResource {
     private client;
     constructor(client: FortniteAPI);
     /**
-     * Get current Fortnite map with POIs
-     * @param version - Optional map version (patch number); defaults to current
-     * @param lang - Language code for POI labels (default: en)
+     * Get a Fortnite map with its POIs and minimap metadata.
+     * @param version - Map version (patch number); defaults to the current version.
+     * @param mode - Which map to return: `br` (default), `og`, or `rotating:<codename>`.
+     *   The available values are listed in the response's `data.modes`.
+     * @param lang - Language code for POI labels (default: `en`).
+     *
+     * @example
+     * const br = await client.map.getCurrent();
+     * const og = await client.map.getCurrent(undefined, "og");
+     * const reload = await client.map.getCurrent(undefined, "rotating:blastberry");
+     * const old = await client.map.getCurrent("33.00");
      */
-    getCurrent(version?: string, lang?: string): Promise<MapResponse>;
+    getCurrent(version?: string, mode?: string, lang?: string): Promise<MapResponse>;
     /**
-     * Get current map image URL
-     * @param version - Optional specific map version to retrieve
+     * Get the map image (302 redirect to the raw image).
+     * Prefer reading `getCurrent().data.imageUrl`, which is the direct URL.
+     * @param version - Map version; defaults to current.
+     * @param mode - Which image: `br` (default), `og`, or `rotating:<codename>`.
      */
-    getImage(version?: string): Promise<MapImageResponse>;
+    getImage(version?: string, mode?: string): Promise<MapImageResponse>;
     /**
      * Get historical map data
      * @param options.chapter - Filter by chapter number

package/dist/resources/map.js

@@ -6,25 +6,42 @@ class MapResource {
         this.client = client;
     }
     /**
-     * Get current Fortnite map with POIs
-     * @param version - Optional map version (patch number); defaults to current
-     * @param lang - Language code for POI labels (default: en)
+     * Get a Fortnite map with its POIs and minimap metadata.
+     * @param version - Map version (patch number); defaults to the current version.
+     * @param mode - Which map to return: `br` (default), `og`, or `rotating:<codename>`.
+     *   The available values are listed in the response's `data.modes`.
+     * @param lang - Language code for POI labels (default: `en`).
+     *
+     * @example
+     * const br = await client.map.getCurrent();
+     * const og = await client.map.getCurrent(undefined, "og");
+     * const reload = await client.map.getCurrent(undefined, "rotating:blastberry");
+     * const old = await client.map.getCurrent("33.00");
      */
-    async getCurrent(version, lang) {
+    async getCurrent(version, mode, lang) {
         const params = new URLSearchParams();
         if (version)
             params.set("version", version);
+        if (mode)
+            params.set("mode", mode);
         if (lang)
             params.set("lang", lang);
         const query = params.toString() ? `?${params.toString()}` : "";
         return this.client.request(`/map${query}`);
     }
     /**
-     * Get current map image URL
-     * @param version - Optional specific map version to retrieve
+     * Get the map image (302 redirect to the raw image).
+     * Prefer reading `getCurrent().data.imageUrl`, which is the direct URL.
+     * @param version - Map version; defaults to current.
+     * @param mode - Which image: `br` (default), `og`, or `rotating:<codename>`.
      */
-    async getImage(version) {
-        const query = version ? `?version=${encodeURIComponent(version)}` : "";
+    async getImage(version, mode) {
+        const params = new URLSearchParams();
+        if (version)
+            params.set("version", version);
+        if (mode)
+            params.set("mode", mode);
+        const query = params.toString() ? `?${params.toString()}` : "";
         return this.client.request(`/map/image${query}`);
     }
     /**

package/dist/resources/parsing.d.ts

@@ -4,7 +4,6 @@ export declare class ParsingResource {
     private client;
     constructor(client: FortniteAPI);
     private buildFormData;
-    private buildMultiFormData;
     /**
      * Parse a single Fortnite replay file — full parse.
      * Subject to per-plan parsing quota limits (5 credits).
@@ -69,35 +68,4 @@ export declare class ParsingResource {
      * @param filename - Filename (required in Node.js)
      */
     parseReplayBroadcast(file: File | Blob, filename?: string): Promise<ParsedReplayData>;
-    /**
-     * Parse multiple replay files in batch — full parse.
-     * All files are processed in parallel.
-     * Subject to per-plan parsing quota limits (10 credits).
-     * @param files - Array of File objects or Blobs
-     * @param filenames - Filenames (required in Node.js when passing Blobs)
-     */
-    parseMultipleReplays(files: (File | Blob)[], filenames?: string[]): Promise<ParsedReplayData[]>;
-    /**
-     * Parse multiple replay files — stats only.
-     * Faster than full parse — skips movement, zones, and kill feed.
-     * Subject to per-plan parsing quota limits (5 credits).
-     * @param files - Array of File objects or Blobs
-     * @param filenames - Filenames (required in Node.js)
-     */
-    parseMultipleReplaysStats(files: (File | Blob)[], filenames?: string[]): Promise<ParsedReplayData[]>;
-    /**
-     * Parse multiple replay files — map context for each.
-     * Returns bus path, storm circles, supply drops, llamas, reboot vans per file.
-     * Subject to per-plan parsing quota limits (10 credits).
-     * @param files - Array of File objects or Blobs
-     * @param filenames - Filenames (required in Node.js)
-     */
-    parseMultipleReplaysMap(files: (File | Blob)[], filenames?: string[]): Promise<ParsedReplayData[]>;
-    /**
-     * Parse multiple replay files — ground loot data for each.
-     * Subject to per-plan parsing quota limits (10 credits).
-     * @param files - Array of File objects or Blobs
-     * @param filenames - Filenames (required in Node.js)
-     */
-    parseMultipleReplaysLoot(files: (File | Blob)[], filenames?: string[]): Promise<ParsedReplayData[]>;
 }

package/dist/resources/parsing.js

@@ -15,18 +15,6 @@ class ParsingResource {
         }
         return formData;
     }
-    buildMultiFormData(files, filenames) {
-        const formData = new FormData();
-        files.forEach((file, index) => {
-            if (file instanceof File) {
-                formData.append("files", file);
-            }
-            else {
-                formData.append("files", file, filenames?.[index] || `replay-${index}.replay`);
-            }
-        });
-        return formData;
-    }
     /**
      * Parse a single Fortnite replay file — full parse.
      * Subject to per-plan parsing quota limits (5 credits).
@@ -139,60 +127,5 @@ class ParsingResource {
         }
         return response.data;
     }
-    /**
-     * Parse multiple replay files in batch — full parse.
-     * All files are processed in parallel.
-     * Subject to per-plan parsing quota limits (10 credits).
-     * @param files - Array of File objects or Blobs
-     * @param filenames - Filenames (required in Node.js when passing Blobs)
-     */
-    async parseMultipleReplays(files, filenames) {
-        const response = await this.client.requestMultipart("/parsing/multiple", this.buildMultiFormData(files, filenames));
-        if (!response.success || !response.results) {
-            throw new Error(response.error || "Failed to parse replays");
-        }
-        return response.results;
-    }
-    /**
-     * Parse multiple replay files — stats only.
-     * Faster than full parse — skips movement, zones, and kill feed.
-     * Subject to per-plan parsing quota limits (5 credits).
-     * @param files - Array of File objects or Blobs
-     * @param filenames - Filenames (required in Node.js)
-     */
-    async parseMultipleReplaysStats(files, filenames) {
-        const response = await this.client.requestMultipart("/parsing/multiple/stats", this.buildMultiFormData(files, filenames));
-        if (!response.success || !response.results) {
-            throw new Error(response.error || "Failed to parse replays stats");
-        }
-        return response.results;
-    }
-    /**
-     * Parse multiple replay files — map context for each.
-     * Returns bus path, storm circles, supply drops, llamas, reboot vans per file.
-     * Subject to per-plan parsing quota limits (10 credits).
-     * @param files - Array of File objects or Blobs
-     * @param filenames - Filenames (required in Node.js)
-     */
-    async parseMultipleReplaysMap(files, filenames) {
-        const response = await this.client.requestMultipart("/parsing/multiple/map", this.buildMultiFormData(files, filenames));
-        if (!response.success || !response.results) {
-            throw new Error(response.error || "Failed to parse replays map");
-        }
-        return response.results;
-    }
-    /**
-     * Parse multiple replay files — ground loot data for each.
-     * Subject to per-plan parsing quota limits (10 credits).
-     * @param files - Array of File objects or Blobs
-     * @param filenames - Filenames (required in Node.js)
-     */
-    async parseMultipleReplaysLoot(files, filenames) {
-        const response = await this.client.requestMultipart("/parsing/multiple/loot", this.buildMultiFormData(files, filenames));
-        if (!response.success || !response.results) {
-            throw new Error(response.error || "Failed to parse replays loot");
-        }
-        return response.results;
-    }
 }
 exports.ParsingResource = ParsingResource;

package/dist/resources/replays.d.ts

@@ -72,10 +72,8 @@ export declare class ReplaysResource {
      */
     parseTimeline(matchId: string): Promise<ParsedReplayData>;
     /**
-     * Download and parse a tournament replay — full broadcast payload.
-     * Combines all data: stats, full lobby, storm zones, map objects, ground loot, and timeline.
-     * Equivalent to calling all parse endpoints in one request.
-     * Subject to per-plan parsing quota limits (20 credits).
+     * @deprecated Use parse() instead. This compatibility route returns the
+     * same combined payload and shares parse()'s 5-credit quota.
      * @param matchId - Match ID from Epic's tournament events API
      */
     parseBroadcast(matchId: string): Promise<ParsedReplayData>;

package/dist/resources/replays.js

@@ -92,10 +92,8 @@ class ReplaysResource {
         return this.client.request(`/replays/${encodeURIComponent(matchId)}/parse/timeline`, {}, "v1");
     }
     /**
-     * Download and parse a tournament replay — full broadcast payload.
-     * Combines all data: stats, full lobby, storm zones, map objects, ground loot, and timeline.
-     * Equivalent to calling all parse endpoints in one request.
-     * Subject to per-plan parsing quota limits (20 credits).
+     * @deprecated Use parse() instead. This compatibility route returns the
+     * same combined payload and shares parse()'s 5-credit quota.
      * @param matchId - Match ID from Epic's tournament events API
      */
     async parseBroadcast(matchId) {

package/dist/resources/sprites.d.ts

@@ -0,0 +1,29 @@
+import { FortniteAPI } from "../client";
+import { SpritesResponse, SpriteResponse, SpriteBoonsResponse } from "../types";
+export declare class SpritesResource {
+    private client;
+    constructor(client: FortniteAPI);
+    /**
+     * Get the full sprite catalog: families with nested variants, current + PAK-base
+     * drop weights, normalized drop chances, rarity, icons, boons, the level-up XP
+     * curve, and alternate event weight sets. Drop weights include Epic's live hotfix
+     * overlay, so Power-Hour / event rotations are reflected without a game update.
+     * @param options.search - Filter by sprite name or id (family or variant, contains match)
+     * @param options.rarity - Filter by rarity (e.g. epic, legendary)
+     * @param options.variant - Filter to one variant label across families (base, gold, candy, galaxy, gem, holofoil, cube)
+     */
+    getSprites(options?: {
+        search?: string;
+        rarity?: string;
+        variant?: string;
+    }): Promise<SpritesResponse>;
+    /**
+     * Get a single sprite family by family id (e.g. "DuckSprite"), variant id
+     * (e.g. "DuckSprite_Variant_Gold"), or display name (e.g. "Duck Sprite").
+     */
+    getSprite(id: string): Promise<SpriteResponse>;
+    /**
+     * Get all SpriteBoons perks with names and descriptions.
+     */
+    getBoons(): Promise<SpriteBoonsResponse>;
+}

package/dist/resources/sprites.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpritesResource = void 0;
+class SpritesResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Get the full sprite catalog: families with nested variants, current + PAK-base
+     * drop weights, normalized drop chances, rarity, icons, boons, the level-up XP
+     * curve, and alternate event weight sets. Drop weights include Epic's live hotfix
+     * overlay, so Power-Hour / event rotations are reflected without a game update.
+     * @param options.search - Filter by sprite name or id (family or variant, contains match)
+     * @param options.rarity - Filter by rarity (e.g. epic, legendary)
+     * @param options.variant - Filter to one variant label across families (base, gold, candy, galaxy, gem, holofoil, cube)
+     */
+    async getSprites(options) {
+        const params = new URLSearchParams();
+        if (options?.search)
+            params.set("search", options.search);
+        if (options?.rarity)
+            params.set("rarity", options.rarity);
+        if (options?.variant)
+            params.set("variant", options.variant);
+        const query = params.toString() ? `?${params.toString()}` : "";
+        return this.client.request(`/sprites${query}`, {}, "v2");
+    }
+    /**
+     * Get a single sprite family by family id (e.g. "DuckSprite"), variant id
+     * (e.g. "DuckSprite_Variant_Gold"), or display name (e.g. "Duck Sprite").
+     */
+    async getSprite(id) {
+        return this.client.request(`/sprites/${encodeURIComponent(id)}`, {}, "v2");
+    }
+    /**
+     * Get all SpriteBoons perks with names and descriptions.
+     */
+    async getBoons() {
+        return this.client.request("/sprites/boons", {}, "v2");
+    }
+}
+exports.SpritesResource = SpritesResource;

package/dist/types/index.d.ts

@@ -900,23 +900,80 @@ export interface CrewHistoryResponse {
         lastModified: string;
     };
 }
+/** Game mode a map response describes. `br`, `og`, or `rotating:<codename>` (e.g. `rotating:blastberry`). */
+export type MapMode = "br" | "og" | (string & {});
+/**
+ * World-space extent of the minimap image, in Unreal units (cm). Combine with
+ * `imageWidth`/`imageHeight` to plot a POI onto the image:
+ * `px = (x - minX) / (maxX - minX) * imageWidth` (and likewise y/height).
+ */
+export interface MapWorldBounds {
+    minX: number;
+    maxX: number;
+    minY: number;
+    maxY: number;
+}
+/** A single point of interest on the map. */
+export interface MapPoi {
+    /** Display name, e.g. "TILTED TOWERS". Empty string when the game ships the POI unnamed. */
+    name: string;
+    /** Source gameplay tag, e.g. `Athena.Location.POI.TiltedTowers`. Stable across patches. */
+    tag?: string | null;
+    /** `named`, `landmark`, `generic`, or `unnamed`. */
+    type?: "named" | "landmark" | "generic" | "unnamed" | (string & {}) | null;
+    /** World X (Unreal units / cm). */
+    x?: number | null;
+    /** World Y (Unreal units / cm). */
+    y?: number | null;
+    /** World Z (Unreal units / cm). */
+    z?: number | null;
+}
+/** Map data for one version + mode. */
+export interface MapData {
+    version: string;
+    chapter?: number | null;
+    season?: number | null;
+    patch?: string | null;
+    releaseDate?: string | null;
+    /** Which map this response describes: `br`, `og`, or `rotating:<codename>`. */
+    mode: MapMode;
+    /** Direct URL to the minimap image (raw GitHub). Prefer this over `map.getImage()`. */
+    imageUrl?: string | null;
+    /** Minimap image pixel dimensions — pair with `worldBounds` to plot POIs. */
+    imageWidth?: number | null;
+    imageHeight?: number | null;
+    worldBounds?: MapWorldBounds | null;
+    pois: MapPoi[];
+    /** Every mode available for this version — valid values for the `mode` query parameter. */
+    modes: MapMode[];
+}
 export interface MapResponse {
     status: number;
-    data: {
-        [key: string]: any;
-    };
+    data: MapData;
 }
+/** `map.getImage()` hits a 302 redirect to the raw image. Prefer `getCurrent().data.imageUrl`. */
 export interface MapImageResponse {
     status: number;
     data: {
         [key: string]: any;
     };
 }
+/** One entry in the map history list. */
+export interface MapHistoryEntry {
+    version: string;
+    chapter?: number | null;
+    season?: number | null;
+    patch?: string | null;
+    releaseDate?: string | null;
+    hasImage: boolean;
+    imageUrl?: string | null;
+    hasPois: boolean;
+    /** Modes available for this version (`br`, `og`, `rotating:<codename>`). */
+    modes: MapMode[];
+}
 export interface MapHistoryResponse {
     status: number;
-    data: {
-        [key: string]: any;
-    };
+    data: MapHistoryEntry[];
 }
 export interface PlaylistsResponse {
     status: number;
@@ -951,3 +1008,78 @@ export interface Playlist {
     lastModified?: string;
     [key: string]: any;
 }
+export interface SpriteImages {
+    icon?: string | null;
+    iconLarge?: string | null;
+}
+export interface SpriteBoonRef {
+    id: string;
+    chance?: number | null;
+}
+export interface SpriteVariant {
+    id: string;
+    /** Variant label: Base, Gold, Candy, Galaxy, Gem, Holofoil, Cube, ... */
+    variant: string;
+    name?: string | null;
+    rarity?: string | null;
+    /** False when the current hotfix disables the variant. */
+    enabled: boolean;
+    images?: SpriteImages | null;
+    /** Weight as cooked in the game files (PAK). */
+    baseWeight?: number | null;
+    /** Weight after Epic's live hotfix overlay — what the game currently uses. */
+    weight?: number | null;
+    /** Current weight normalized within the family, percentage 0-100. */
+    dropChancePercent?: number | null;
+    boons: SpriteBoonRef[];
+}
+export interface SpriteFamily {
+    id: string;
+    name?: string | null;
+    description?: string | null;
+    /** Epic's own sprite-dex ordering number. */
+    dexNumber?: number | null;
+    rarity?: string | null;
+    acquisitionHint?: string | null;
+    extractRewardLootTier?: string | null;
+    images?: SpriteImages | null;
+    tags: string[];
+    boons: SpriteBoonRef[];
+    variants: SpriteVariant[];
+}
+export interface SpriteLevel {
+    level: number;
+    xp: number;
+}
+export interface SpriteEvent {
+    name: string;
+    weights: Record<string, number>;
+}
+export interface SpritesData {
+    gameVersion: string;
+    generated: string;
+    /** True when the drop weights include the live CloudStorage hotfix overlay. */
+    hotfixApplied: boolean;
+    sprites: SpriteFamily[];
+    /** Cumulative Sprite Dust thresholds per sprite level. */
+    levelUpCurve: SpriteLevel[];
+    /** Alternate weight sets from event hotfixes (Power Hours etc.). */
+    events: SpriteEvent[];
+}
+export interface SpritesResponse {
+    status: number;
+    data: SpritesData;
+}
+export interface SpriteResponse {
+    status: number;
+    data: SpriteFamily;
+}
+export interface SpriteBoon {
+    id: string;
+    name?: string | null;
+    description?: string | null;
+}
+export interface SpriteBoonsResponse {
+    status: number;
+    data: SpriteBoon[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaelouuu/fortnite-api",
-  "version": "7.2.0",
+  "version": "8.1.0",
   "description": "SDK for Fortnite API - api-fortnite.com - Author : Yael Brinkert",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",