Fortnite-API

/**
 * FortniteAPI - generated by OmniStream from Fortnite-API's OpenAPI spec.
 * One typed method per endpoint. A single Omni key reaches the API.
 */
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/fortnite";

export class FortniteAPIError extends Error {
  status: number;
  code?: string;
  constructor(status: number, code: string | undefined, message?: string) {
    super(message || `FortniteAPI error ${status}`);
    this.name = "FortniteAPIError";
    this.status = status;
    this.code = code;
  }
}

export interface FortniteAPIOptions {
  baseUrl?: string;
  fetch?: typeof fetch;
  timeoutMs?: number;
}

export class FortniteAPI {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: FortniteAPIOptions = {}) {
    if (!token) throw new Error("FortniteAPI: token is required");
  }
  rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;

  private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
    const f = this.opts.fetch ?? globalThis.fetch;
    const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
    if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
    const headers: Record<string, string> = { "x-omni-key": this.token };
    if (body !== undefined) headers["content-type"] = "application/json";
    const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
    this.rateLimit = {
      remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
      remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
    };
    const data = await res.json().catch(() => ({}));
    if (!res.ok) throw new FortniteAPIError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** Current AES keys */
  aesKeys(params: { "keyFormat"?: string }): Promise<any> {
    return this._request("GET", "/v2/aes", { params });
  }

  /** All banners */
  banners(params: { "language"?: string }): Promise<any> {
    return this._request("GET", "/v1/banners", { params });
  }

  /** All banner colors */
  bannerColors(): Promise<any> {
    return this._request("GET", "/v1/banners/colors", {});
  }

  /** All cosmetics */
  allCosmetics(params: { "language"?: string }): Promise<any> {
    return this._request("GET", "/v2/cosmetics", { params });
  }

  /** Most recently added cosmetics */
  newCosmetics(): Promise<any> {
    return this._request("GET", "/v2/cosmetics/new", {});
  }

  /** All battle royale cosmetics */
  brCosmeticsList(params: { "language"?: string }): Promise<any> {
    return this._request("GET", "/v2/cosmetics/br", { params });
  }

  /** All track (Festival) cosmetics */
  trackCosmeticsList(): Promise<any> {
    return this._request("GET", "/v2/cosmetics/tracks", {});
  }

  /** All instrument cosmetics */
  instrumentCosmeticsList(): Promise<any> {
    return this._request("GET", "/v2/cosmetics/instruments", {});
  }

  /** All car cosmetics */
  carCosmeticsList(): Promise<any> {
    return this._request("GET", "/v2/cosmetics/cars", {});
  }

  /** All LEGO cosmetics */
  legoCosmeticsList(): Promise<any> {
    return this._request("GET", "/v2/cosmetics/lego", {});
  }

  /** All LEGO kit cosmetics */
  legoKitCosmeticsList(): Promise<any> {
    return this._request("GET", "/v2/cosmetics/lego/kits", {});
  }

  /** All Fall Guys ("bean") cosmetics */
  beanCosmeticsList(): Promise<any> {
    return this._request("GET", "/v2/cosmetics/beans", {});
  }

  /** A single battle royale cosmetic by id */
  brCosmeticByID(params: { "cosmeticId": string; "language"?: string }): Promise<any> {
    return this._request("GET", "/v2/cosmetics/br/{cosmeticId}", { params });
  }

  /** First battle royale cosmetic matching the search filters */
  brCosmeticSearch(params: { "language"?: string; "searchLanguage"?: string; "matchMethod"?: string; "name"?: string; "type"?: string }): Promise<any> {
    return this._request("GET", "/v2/cosmetics/br/search", { params });
  }

  /** All battle royale cosmetics matching the search filters */
  brCosmeticsSearch(params: { "language"?: string; "searchLanguage"?: string; "matchMethod"?: string; "name"?: string; "type"?: string }): Promise<any> {
    return this._request("GET", "/v2/cosmetics/br/search/all", { params });
  }

  /** Battle royale cosmetics by a list of ids */
  brCosmeticsSearchByIDs(params: { "id": unknown[]; "language"?: string }): Promise<any> {
    return this._request("GET", "/v2/cosmetics/br/search/ids", { params });
  }

  /** Creator code details by name */
  creatorCode(params: { "name": string }): Promise<any> {
    return this._request("GET", "/v2/creatorcode", { params });
  }

  /** Battle royale map + POI images */
  brMap(params: { "language"?: string }): Promise<any> {
    return this._request("GET", "/v1/map", { params });
  }

  /** Current battle royale, save the world, and creative news */
  news(params: { "language"?: string }): Promise<any> {
    return this._request("GET", "/v2/news", { params });
  }

  /** Current battle royale news */
  brNews(params: { "language"?: string }): Promise<any> {
    return this._request("GET", "/v2/news/br", { params });
  }

  /** Current save the world news */
  stwNews(params: { "language"?: string }): Promise<any> {
    return this._request("GET", "/v2/news/stw", { params });
  }

  /** Current creative news */
  creativeNews(params: { "language"?: string }): Promise<any> {
    return this._request("GET", "/v2/news/creative", { params });
  }

  /** All playlists */
  playlists(params: { "language"?: string }): Promise<any> {
    return this._request("GET", "/v1/playlists", { params });
  }

  /** A single playlist by id */
  playlistByID(params: { "playlistId": string; "language"?: string }): Promise<any> {
    return this._request("GET", "/v1/playlists/{playlistId}", { params });
  }

  /** Current item shop */
  shop(params: { "language"?: string }): Promise<any> {
    return this._request("GET", "/v2/shop", { params });
  }

  /** Battle royale stats for an account by name */
  brStats(params: { "name": string; "accountType"?: string; "timeWindow"?: string; "image"?: string }): Promise<any> {
    return this._request("GET", "/v2/stats/br/v2", { params });
  }

  /** Battle royale stats for an account by Epic account id */
  brStatsByAccountID(params: { "accountId": string; "timeWindow"?: string; "image"?: string }): Promise<any> {
    return this._request("GET", "/v2/stats/br/v2/{accountId}", { params });
  }
}

export default FortniteAPI;