Class FactionResource

constructor

• new FactionResource(http: HttpClient): FactionResource

  Parameters

  • http: HttpClient

  Returns FactionResource

Readonlybudgets

Readonlycreditlog

Readonlycredits

Readonlymembers

Readonlystockholders

get

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

  Get faction by UID.

  Returns the FactionDetail object directly — not wrapped in a Page.

  @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<FactionDetail>

  The FactionDetail entity.

  Example

  // Get a specific faction
  const faction = await client.faction.get({ uid: '20:123' });
  console.log(faction.name); // access properties directly, not faction.data
  
  // Get the authenticated user's faction
  const myFaction = await client.faction.get();
  Copy

list

• list(options?: ListFactionsOptions): Promise<Page<FactionListItem>>

  List all factions (paginated) @requires_auth No

  Parameters

  • Optionaloptions: ListFactionsOptions

    Optional pagination parameters

  Returns Promise<Page<FactionListItem>>

  Example

  const page = await client.faction.list();
  console.log(page.total);
  console.log(page.data[0]?.value);
  
  // Iterate all pages:
  for await (const faction of page) { console.log(faction); }
  Copy