Class FactionResource

constructor

• new FactionResource(http: HttpClient): FactionResource

  Parameters

  • http: HttpClient

  Returns FactionResource

Readonlybudgets

Readonlycreditlog

Readonlycredits

Readonlymembers

Readonlystockholders

get

• get(options?: GetFactionOptions): Promise<Faction>

  Get faction by UID @requires_auth Yes @requires_scope FACTION_READ

  Parameters

  • Optionaloptions: GetFactionOptions

    Optional faction UID. If omitted or uid not provided, returns the authenticated user's primary faction.

  Returns Promise<Faction>

  Example

  // Get a specific faction
  const faction = await client.faction.get({ uid: '20:123' });
  // Get the authenticated user's faction
  const myFaction = await client.faction.get();
  Copy

list

• list(
      options?: { item_count?: number; start_index?: number },
  ): Promise<Faction[]>

  List all factions (paginated) @requires_auth No

  Parameters

  • Optionaloptions: { item_count?: number; start_index?: number }

    Optional pagination parameters

  Returns Promise<Faction[]>

  Example

  const factions = await client.faction.list();
  const moreFactions = await client.faction.list({ start_index: 51, item_count: 50 });
  Copy