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

    Class SovereigntyClient

    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 getSovereigntyCampaigns getSovereigntySystems
    api: ClientMethods<T>

    Protected_client

    _client: ApiClient

    Protected_endpoints

    _endpoints: {
        getSovereigntyCampaigns: {
            path: "sovereignty/campaigns";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodArray<
                ZodObject<
                    {
                        campaign_id: ZodNumber;
                        structure_id: ZodNumber;
                        solar_system_id: ZodNumber;
                        constellation_id: ZodNumber;
                        event_type: ZodType<
                            | string & {}
                            | "tcu_defense"
                            | "ihub_defense"
                            | "station_defense"
                            | "station_freeport",
                            unknown,
                            $ZodTypeInternals<
                                | string & {}
                                | "tcu_defense"
                                | "ihub_defense"
                                | "station_defense"
                                | "station_freeport",
                                unknown,
                            >,
                        >;
                        start_time: ZodString;
                        defender_id: ZodOptional<ZodNumber>;
                        defender_score: ZodOptional<ZodNumber>;
                        attackers_score: ZodOptional<ZodNumber>;
                        participants: ZodOptional<
                            ZodArray<
                                ZodObject<{ alliance_id: ZodNumber; score: ZodNumber }, $loose>,
                            >,
                        >;
                    },
                    $loose,
                >,
            >;
        };
        getSovereigntySystems: {
            path: "sovereignty/systems";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodObject<
                {
                    solar_systems: ZodArray<
                        ZodObject<
                            {
                                solar_system_id: ZodNumber;
                                claim: ZodObject<
                                    {
                                        alliance: ZodOptional<ZodObject<(...), (...)>>;
                                        faction: ZodOptional<ZodObject<(...), (...)>>;
                                        unclaimed: ZodOptional<ZodBoolean>;
                                    },
                                    $loose,
                                >;
                            },
                            $loose,
                        >,
                    >;
                },
                $loose,
            >;
        };
    }

    • Type Parameters

      • R

      Parameters

      • endpointName: "getSovereigntyCampaigns" | "getSovereigntySystems"
      • ...args: unknown[]

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

    • Type Parameters

      • R

      Parameters

      • endpointName: "getSovereigntyCampaigns" | "getSovereigntySystems"
      • args: unknown[]
      • Optionalconcurrency: number

      Returns Promise<R[]>

    • Retrieves all active sovereignty campaigns, including command node contests and station freeports.

      Returns Promise<
          {
              campaign_id: number;
              structure_id: number;
              solar_system_id: number;
              constellation_id: number;
              event_type: | string & {}
              | "tcu_defense"
              | "ihub_defense"
              | "station_defense"
              | "station_freeport";
              start_time: string;
              defender_id?: number;
              defender_score?: number;
              attackers_score?: number;
              participants?: {
                  alliance_id: number;
                  score: number;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          }[],
      >

      A list of active sovereignty campaigns

    • Retrieves the combined sovereignty systems data including occupancy, structures, and separate ADM indices (military, industry, strategic).

      Returns Promise<
          {
              solar_systems: {
                  solar_system_id: number;
                  claim: {
                      alliance?: {
                          alliance_id: number;
                          corporation_id?: number;
                          claimed_since?: string;
                          sovereignty_hub?: {
                              id: number;
                              vulnerability_window?: { start: ...; end: ...; [key: ...]: ... };
                              [key: string]: unknown;
                          };
                          is_capital_system?: boolean;
                          development?: {
                              activity_defense_multiplier?: number;
                              military_level?: number;
                              industrial_level?: number;
                              strategic_level?: number;
                              [key: string]: unknown;
                          };
                          [key: string]: unknown;
                      };
                      faction?: { faction_id: number; [key: string]: unknown };
                      unclaimed?: boolean;
                      [key: string]: unknown;
                  };
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

      A list of sovereignty systems with ownership, ADM indices, and anchored structures

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods