@lgriffin/esi.ts - EVE Online ESI API Client - v12.3.0
    Preparing search index...

    Class FactionClient

    The base of the custom domain clients: an endpoint map turned into methods, plus the stream*/fetchAll* page helpers and withMetadata/withSafeMode. Extend it for a custom domain client of your own.

    Hierarchy (View Summary)

    Index
    constructor
    api _client _endpoints
    streamEndpoint fetchAllEndpoint withMetadata withSafeMode getLeaderboardsCharacters getLeaderboardsCorporations getLeaderboardsOverall getStats getCharacterStats getCorporationStats getSystems getWars
    api: ClientMethods<T>

    Protected_client

    _client: ApiClient

    Protected_endpoints

    _endpoints: {
        getCharacterStats: {
            path: "characters/{characterId}/fw/stats";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            responseSchema: ZodObject<
                {
                    faction_id: ZodOptional<ZodNumber>;
                    enlisted_on: ZodOptional<ZodString>;
                    current_rank: ZodOptional<ZodNumber>;
                    highest_rank: ZodOptional<ZodNumber>;
                    kills: ZodObject<
                        { yesterday: ZodNumber; last_week: ZodNumber; total: ZodNumber },
                        $loose,
                    >;
                    victory_points: ZodObject<
                        { yesterday: ZodNumber; last_week: ZodNumber; total: ZodNumber },
                        $loose,
                    >;
                },
                $loose,
            >;
        };
        getCorporationStats: {
            path: "corporations/{corporationId}/fw/stats";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["corporationId"];
            responseSchema: ZodObject<
                {
                    faction_id: ZodOptional<ZodNumber>;
                    enlisted_on: ZodOptional<ZodString>;
                    pilots: ZodOptional<ZodNumber>;
                    kills: ZodObject<
                        { yesterday: ZodNumber; last_week: ZodNumber; total: ZodNumber },
                        $loose,
                    >;
                    victory_points: ZodObject<
                        { yesterday: ZodNumber; last_week: ZodNumber; total: ZodNumber },
                        $loose,
                    >;
                },
                $loose,
            >;
        };
        getOverall: {
            path: "fw/leaderboards";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodObject<
                {
                    kills: ZodObject<
                        {
                            yesterday: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        faction_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                            last_week: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        faction_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                            active_total: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        faction_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                        },
                        $loose,
                    >;
                    victory_points: ZodObject<
                        {
                            yesterday: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        faction_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                            last_week: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        faction_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                            active_total: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        faction_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                        },
                        $loose,
                    >;
                },
                $loose,
            >;
        };
        getCharacters: {
            path: "fw/leaderboards/characters";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodObject<
                {
                    kills: ZodObject<
                        {
                            yesterday: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        character_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                            last_week: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        character_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                            active_total: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        character_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                        },
                        $loose,
                    >;
                    victory_points: ZodObject<
                        {
                            yesterday: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        character_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                            last_week: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        character_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                            active_total: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        character_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                        },
                        $loose,
                    >;
                },
                $loose,
            >;
        };
        getCorporations: {
            path: "fw/leaderboards/corporations";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodObject<
                {
                    kills: ZodObject<
                        {
                            yesterday: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        corporation_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                            last_week: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        corporation_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                            active_total: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        corporation_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                        },
                        $loose,
                    >;
                    victory_points: ZodObject<
                        {
                            yesterday: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        corporation_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                            last_week: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        corporation_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                            active_total: ZodArray<
                                ZodObject<
                                    {
                                        amount: ZodOptional<ZodNumber>;
                                        corporation_id: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                        },
                        $loose,
                    >;
                },
                $loose,
            >;
        };
        getStats: {
            path: "fw/stats";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodArray<
                ZodObject<
                    {
                        faction_id: ZodNumber;
                        pilots: ZodNumber;
                        systems_controlled: ZodNumber;
                        kills: ZodObject<
                            { yesterday: ZodNumber; last_week: ZodNumber; total: ZodNumber },
                            $loose,
                        >;
                        victory_points: ZodObject<
                            { yesterday: ZodNumber; last_week: ZodNumber; total: ZodNumber },
                            $loose,
                        >;
                    },
                    $loose,
                >,
            >;
        };
        getSystems: {
            path: "fw/systems";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodArray<
                ZodObject<
                    {
                        solar_system_id: ZodNumber;
                        owner_faction_id: ZodNumber;
                        occupier_faction_id: ZodNumber;
                        contested: ZodType<
                            | string & {}
                            | "contested"
                            | "captured"
                            | "uncontested"
                            | "vulnerable",
                            unknown,
                            $ZodTypeInternals<
                                | string & {}
                                | "contested"
                                | "captured"
                                | "uncontested"
                                | "vulnerable",
                                unknown,
                            >,
                        >;
                        victory_points: ZodNumber;
                        victory_points_threshold: ZodNumber;
                    },
                    $loose,
                >,
            >;
        };
        getWars: {
            path: "fw/wars";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodArray<
                ZodObject<{ faction_id: ZodNumber; against_id: ZodNumber }, $loose>,
            >;
        };
    }

    • Type Parameters

      • R

      Parameters

      • endpointName:
            | "getCorporations"
            | "getCharacterStats"
            | "getCorporationStats"
            | "getOverall"
            | "getCharacters"
            | "getStats"
            | "getSystems"
            | "getWars"
      • ...args: unknown[]

      Returns AsyncGenerator<PageResult<R>, void, undefined>

    • Type Parameters

      • R

      Parameters

      • endpointName:
            | "getCorporations"
            | "getCharacterStats"
            | "getCorporationStats"
            | "getOverall"
            | "getCharacters"
            | "getStats"
            | "getSystems"
            | "getWars"
      • args: unknown[]
      • Optionalconcurrency: number

      Returns Promise<R[]>

    • Retrieves the top characters in faction warfare leaderboards.

      Returns Promise<
          {
              kills: {
                  yesterday: {
                      amount?: number;
                      character_id?: number;
                      [key: string]: unknown;
                  }[];
                  last_week: {
                      amount?: number;
                      character_id?: number;
                      [key: string]: unknown;
                  }[];
                  active_total: {
                      amount?: number;
                      character_id?: number;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              victory_points: {
                  yesterday: {
                      amount?: number;
                      character_id?: number;
                      [key: string]: unknown;
                  }[];
                  last_week: {
                      amount?: number;
                      character_id?: number;
                      [key: string]: unknown;
                  }[];
                  active_total: {
                      amount?: number;
                      character_id?: number;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

      Faction warfare character leaderboard rankings

    • Retrieves the top corporations in faction warfare leaderboards.

      Returns Promise<
          {
              kills: {
                  yesterday: {
                      amount?: number;
                      corporation_id?: number;
                      [key: string]: unknown;
                  }[];
                  last_week: {
                      amount?: number;
                      corporation_id?: number;
                      [key: string]: unknown;
                  }[];
                  active_total: {
                      amount?: number;
                      corporation_id?: number;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              victory_points: {
                  yesterday: {
                      amount?: number;
                      corporation_id?: number;
                      [key: string]: unknown;
                  }[];
                  last_week: {
                      amount?: number;
                      corporation_id?: number;
                      [key: string]: unknown;
                  }[];
                  active_total: {
                      amount?: number;
                      corporation_id?: number;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

      Faction warfare corporation leaderboard rankings

    • Retrieves the overall faction warfare leaderboards across all factions.

      Returns Promise<
          {
              kills: {
                  yesterday: {
                      amount?: number;
                      faction_id?: number;
                      [key: string]: unknown;
                  }[];
                  last_week: {
                      amount?: number;
                      faction_id?: number;
                      [key: string]: unknown;
                  }[];
                  active_total: {
                      amount?: number;
                      faction_id?: number;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              victory_points: {
                  yesterday: {
                      amount?: number;
                      faction_id?: number;
                      [key: string]: unknown;
                  }[];
                  last_week: {
                      amount?: number;
                      faction_id?: number;
                      [key: string]: unknown;
                  }[];
                  active_total: {
                      amount?: number;
                      faction_id?: number;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

      Overall faction warfare leaderboard rankings

    • Retrieves faction warfare statistics for all factions, including kill and victory point totals.

      Returns Promise<
          {
              faction_id: number;
              pilots: number;
              systems_controlled: number;
              kills: {
                  yesterday: number;
                  last_week: number;
                  total: number;
                  [key: string]: unknown;
              };
              victory_points: {
                  yesterday: number;
                  last_week: number;
                  total: number;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          }[],
      >

      An array of per-faction warfare statistics

    • Retrieves faction warfare statistics for a specific character, including enlistment info and kill counts.

      Parameters

      • characterId: number

        The ID of the character

      Returns Promise<
          {
              faction_id?: number;
              enlisted_on?: string;
              current_rank?: number;
              highest_rank?: number;
              kills: {
                  yesterday: number;
                  last_week: number;
                  total: number;
                  [key: string]: unknown;
              };
              victory_points: {
                  yesterday: number;
                  last_week: number;
                  total: number;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

      Faction warfare statistics for the character

      Authentication

    • Retrieves faction warfare statistics for a specific corporation, including kill counts and victory points.

      Parameters

      • corporationId: number

        The ID of the corporation

      Returns Promise<
          {
              faction_id?: number;
              enlisted_on?: string;
              pilots?: number;
              kills: {
                  yesterday: number;
                  last_week: number;
                  total: number;
                  [key: string]: unknown;
              };
              victory_points: {
                  yesterday: number;
                  last_week: number;
                  total: number;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

      Faction warfare statistics for the corporation

      Authentication

    • Retrieves the current ownership and contested status of all faction warfare systems.

      Returns Promise<
          {
              solar_system_id: number;
              owner_faction_id: number;
              occupier_faction_id: number;
              contested: | string & {}
              | "contested"
              | "captured"
              | "uncontested"
              | "vulnerable";
              victory_points: number;
              victory_points_threshold: number;
              [key: string]: unknown;
          }[],
      >

      An array of faction warfare system statuses

    • Retrieves the list of active faction warfare wars, showing which factions are fighting each other.

      Returns Promise<{ faction_id: number; against_id: number; [key: string]: unknown }[]>

      An array of active faction warfare wars

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods