@yaelouuu/fortnite-api 8.0.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/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

@@ -1008,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": "8.0.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",