Class FactionEndpoint

Access the Faction API endpoints

Constructors

constructor

new FactionEndpoint(requester: Requester): FactionEndpoint
Parameters
- requester: Requester
Returns FactionEndpoint
- Defined in src/generated/endpoints/faction.ts:64

Methods

applications

applications(
params?: { timestamp?: string },
): Promise<FactionApplicationsResponse>
Get your faction's applications
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionApplicationsResponse>
- Defined in src/generated/endpoints/faction.ts:72

attacks

attacks(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<
    PaginatedResponse<FactionAttacksResponse> & FactionAttacksResponse,
>
Get your faction's detailed attacks
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<FactionAttacksResponse> & FactionAttacksResponse>
- Defined in src/generated/endpoints/faction.ts:86

attacksfull

attacksfull(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<
    PaginatedResponse<FactionAttacksFullResponse> & FactionAttacksFullResponse,
>
Get your faction's simplified attacks
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<
PaginatedResponse<FactionAttacksFullResponse> & FactionAttacksFullResponse,
>
- Defined in src/generated/endpoints/faction.ts:110

balance

balance(params?: { timestamp?: string }): Promise<FactionBalanceResponse>
Get your faction's & member's balance details
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionBalanceResponse>
- Defined in src/generated/endpoints/faction.ts:134

basic

basic(params?: { timestamp?: string }): Promise<FactionBasicResponse>
Get your faction's basic details
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionBasicResponse>
- Defined in src/generated/endpoints/faction.ts:148

chain

chain(params?: { timestamp?: string }): Promise<FactionOngoingChainResponse>
Get your faction's current chain
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionOngoingChainResponse>
- Defined in src/generated/endpoints/faction.ts:162

chainreport

chainreport(
params?: { timestamp?: string },
): Promise<FactionChainReportResponse>
Get your faction's latest chain report
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionChainReportResponse>
- Defined in src/generated/endpoints/faction.ts:200

chains

chains(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<PaginatedResponse<FactionChainsResponse> & FactionChainsResponse>
Get a list of your faction's completed chains
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<FactionChainsResponse> & FactionChainsResponse>
- Defined in src/generated/endpoints/faction.ts:176

contributors

contributors(
    params?: {
        cat?: "all" | "current";
        stat?: FactionStatEnum;
        timestamp?: string;
    },
): Promise<FactionContributorsResponse>
Get your faction's challenge contributors
Parameters
- Optionalparams: { cat?: "all" | "current"; stat?: FactionStatEnum; timestamp?: string }
  Optional query parameters
Returns Promise<FactionContributorsResponse>
- Defined in src/generated/endpoints/faction.ts:214

crimes

crimes(
    params?: {
        cat?:
            | "all"
            | "recruiting"
            | "planning"
            | "failure"
            | "successful"
            | "expired"
            | "available"
            | "completed";
        filters?: "created_at"
        | "executed_at"
        | "ready_at"
        | "expired_at";
        from?: number;
        offset?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<PaginatedResponse<FactionCrimesResponse> & FactionCrimesResponse>
Get your faction's organized crimes
Parameters
- Optionalparams: {
      cat?:
          | "all"
          | "recruiting"
          | "planning"
          | "failure"
          | "successful"
          | "expired"
          | "available"
          | "completed";
      filters?: "created_at"
      | "executed_at"
      | "ready_at"
      | "expired_at";
      from?: number;
      offset?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<FactionCrimesResponse> & FactionCrimesResponse>
- Defined in src/generated/endpoints/faction.ts:232

get

get(
    params?: {
        cat?:
            | "chain"
            | "crime"
            | "stats"
            | "territory"
            | "main"
            | "attack"
            | "armoryDeposit"
            | "armoryAction"
            | "territoryWar"
            | "rankedWar"
            | "territoryGain"
            | "membership"
            | "depositFunds"
            | "giveFunds"
            | "all"
            | "ongoing"
            | "finsihed"
            | "ranked"
            | "raid"
            | "db"
            | "money"
            | "recruiting"
            | "mostwanted"
            | "references"
            | "friendorfoe"
            | "companyfinancials"
            | "truelevel"
            | "stockanalysis"
            | "anonymousbounties"
            | "investment"
            | "current"
            | "planning"
            | "failure"
            | "successful"
            | "expired"
            | "available"
            | "completed";
        filters?: "created_at"
        | "executed_at"
        | "ready_at"
        | "expired_at";
        from?: number;
        id?: number;
        limit?: number;
        offset?: number;
        selections?: string[];
        sort?: "ASC" | "DESC";
        stat?: FactionStatEnum;
        striptags?: "true" | "false";
        timestamp?: string;
        to?: number;
    },
): Promise<FactionResponse>
Get any Faction selection
Parameters
- Optionalparams: {
      cat?:
          | "chain"
          | "crime"
          | "stats"
          | "territory"
          | "main"
          | "attack"
          | "armoryDeposit"
          | "armoryAction"
          | "territoryWar"
          | "rankedWar"
          | "territoryGain"
          | "membership"
          | "depositFunds"
          | "giveFunds"
          | "all"
          | "ongoing"
          | "finsihed"
          | "ranked"
          | "raid"
          | "db"
          | "money"
          | "recruiting"
          | "mostwanted"
          | "references"
          | "friendorfoe"
          | "companyfinancials"
          | "truelevel"
          | "stockanalysis"
          | "anonymousbounties"
          | "investment"
          | "current"
          | "planning"
          | "failure"
          | "successful"
          | "expired"
          | "available"
          | "completed";
      filters?: "created_at"
      | "executed_at"
      | "ready_at"
      | "expired_at";
      from?: number;
      id?: number;
      limit?: number;
      offset?: number;
      selections?: string[];
      sort?: "ASC" | "DESC";
      stat?: FactionStatEnum;
      striptags?: "true" | "false";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<FactionResponse>
- Defined in src/generated/endpoints/faction.ts:648

hof

hof(params?: { timestamp?: string }): Promise<FactionHofResponse>
Get your faction's hall of fame rankings.
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionHofResponse>
- Defined in src/generated/endpoints/faction.ts:268

lookup

lookup(params?: { timestamp?: string }): Promise<FactionLookupResponse>
No summary available
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionLookupResponse>
- Defined in src/generated/endpoints/faction.ts:620

members

members(
params?: { striptags?: "true" | "false"; timestamp?: string },
): Promise<FactionMembersResponse>
Get a list of your faction's members
Parameters
- Optionalparams: { striptags?: "true" | "false"; timestamp?: string }
  Optional query parameters
Returns Promise<FactionMembersResponse>
- Defined in src/generated/endpoints/faction.ts:282

news

news(
    params?: {
        cat?: FactionNewsCategory;
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        striptags?: "true" | "false";
        timestamp?: string;
        to?: number;
    },
): Promise<PaginatedResponse<FactionNewsResponse> & FactionNewsResponse>
Get your faction's news details
Parameters
- Optionalparams: {
      cat?: FactionNewsCategory;
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      striptags?: "true" | "false";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<FactionNewsResponse> & FactionNewsResponse>
- Defined in src/generated/endpoints/faction.ts:298

positions

positions(params?: { timestamp?: string }): Promise<FactionPositionsResponse>
Get your faction's positions details
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionPositionsResponse>
- Defined in src/generated/endpoints/faction.ts:324

rackets

rackets(params?: { timestamp?: string }): Promise<FactionRacketsResponse>
Get a list of current rackets
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionRacketsResponse>
- Defined in src/generated/endpoints/faction.ts:338

raids

raids(
    params?: {
        from?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<PaginatedResponse<FactionRaidsResponse> & FactionRaidsResponse>
Get raids history for your faction
Parameters
- Optionalparams: { from?: number; sort?: "ASC" | "DESC"; timestamp?: string; to?: number }
  Optional query parameters
Returns Promise<PaginatedResponse<FactionRaidsResponse> & FactionRaidsResponse>
- Defined in src/generated/endpoints/faction.ts:352

rankedwars

rankedwars(
    params?: {
        cat?: FactionRankedWarsCategoryEnum;
        from?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<
    PaginatedResponse<FactionRankedWarResponse> & FactionRankedWarResponse,
>
Get ranked wars history for your faction
Parameters
- Optionalparams: {
      cat?: FactionRankedWarsCategoryEnum;
      from?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<FactionRankedWarResponse> & FactionRankedWarResponse>
- Defined in src/generated/endpoints/faction.ts:372

reports

reports(
    params?: {
        cat?: ReportTypeEnum;
        limit?: number;
        offset?: number;
        target?: number;
        timestamp?: string;
    },
): Promise<PaginatedResponse<ReportsResponse> & ReportsResponse>
Get faction reports
Parameters
- Optionalparams: {
      cat?: ReportTypeEnum;
      limit?: number;
      offset?: number;
      target?: number;
      timestamp?: string;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<ReportsResponse> & ReportsResponse>
- Defined in src/generated/endpoints/faction.ts:396

revives

revives(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        striptags?: "true" | "false";
        timestamp?: string;
        to?: number;
    },
): Promise<PaginatedResponse<RevivesResponse> & RevivesResponse>
Get your faction's detailed revives
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      striptags?: "true" | "false";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<RevivesResponse> & RevivesResponse>
- Defined in src/generated/endpoints/faction.ts:418

revivesfull

revivesfull(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        striptags?: "true" | "false";
        timestamp?: string;
        to?: number;
    },
): Promise<PaginatedResponse<RevivesFullResponse> & RevivesFullResponse>
Get your faction's simplified revives
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      striptags?: "true" | "false";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<RevivesFullResponse> & RevivesFullResponse>
- Defined in src/generated/endpoints/faction.ts:442

search

search(
    params?: {
        filters?: string[];
        limit?: number;
        name?: string;
        offset?: number;
        timestamp?: string;
    },
): Promise<PaginatedResponse<FactionSearchResponse> & FactionSearchResponse>
Search factions by name or other criteria
Parameters
- Optionalparams: {
      filters?: string[];
      limit?: number;
      name?: string;
      offset?: number;
      timestamp?: string;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<FactionSearchResponse> & FactionSearchResponse>
- Defined in src/generated/endpoints/faction.ts:466

stats

stats(params?: { timestamp?: string }): Promise<FactionStatsResponse>
Get your faction's challenges stats
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionStatsResponse>
- Defined in src/generated/endpoints/faction.ts:496

territory

territory(params?: { timestamp?: string }): Promise<FactionTerritoriesResponse>
Get a list of your faction's territories
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionTerritoriesResponse>
- Defined in src/generated/endpoints/faction.ts:510

territoryownership

territoryownership(
params?: { limit?: number; offset?: number; timestamp?: string },
): Promise<FactionTerritoriesOwnershipResponse>
Get a list of your faction's territories
Parameters
- Optionalparams: { limit?: number; offset?: number; timestamp?: string }
  Optional query parameters
Returns Promise<FactionTerritoriesOwnershipResponse>
- Defined in src/generated/endpoints/faction.ts:524

territorywars

territorywars(
    params?: {
        cat?: FactionTerritoryWarsCategoryEnum;
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<FactionTerritoryWarsResponse>
Get territory wars history for your faction
Parameters
- Optionalparams: {
      cat?: FactionTerritoryWarsCategoryEnum;
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<FactionTerritoryWarsResponse>
- Defined in src/generated/endpoints/faction.ts:542

timestamp

timestamp(params?: { timestamp?: string }): Promise<TimestampResponse>
Get current server time
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TimestampResponse>
- Defined in src/generated/endpoints/faction.ts:634

upgrades

upgrades(params?: { timestamp?: string }): Promise<FactionUpgradesResponse>
Get your faction's upgrades
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionUpgradesResponse>
- Defined in src/generated/endpoints/faction.ts:566

warfare

warfare(
    params?: {
        cat?: FactionWarfareTypeEnum;
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<
    PaginatedResponse<FactionWarfareResponse> & FactionWarfareResponse,
>
Get faction warfare
Parameters
- Optionalparams: {
      cat?: FactionWarfareTypeEnum;
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<FactionWarfareResponse> & FactionWarfareResponse>
- Defined in src/generated/endpoints/faction.ts:580

wars

wars(params?: { timestamp?: string }): Promise<FactionWarsResponse>
Get your faction's wars & pacts details
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionWarsResponse>
- Defined in src/generated/endpoints/faction.ts:606

withChainId

withChainId(chainId: string | number): FactionChainIdContext
Parameters
- chainId: string | number
  The ID for this context
Returns FactionChainIdContext
- Defined in src/generated/endpoints/faction.ts:707

withCrimeId

withCrimeId(crimeId: string | number): FactionCrimeIdContext
Parameters
- crimeId: string | number
  The ID for this context
Returns FactionCrimeIdContext
- Defined in src/generated/endpoints/faction.ts:712

withId

withId(id: string | number): FactionIdContext
Parameters
- id: string | number
  The ID for this context
Returns FactionIdContext
- Defined in src/generated/endpoints/faction.ts:702

withRaidWarId

withRaidWarId(raidWarId: string | number): FactionRaidWarIdContext
Parameters
- raidWarId: string | number
  The ID for this context
Returns FactionRaidWarIdContext
- Defined in src/generated/endpoints/faction.ts:717

withRankedWarId

withRankedWarId(rankedWarId: string | number): FactionRankedWarIdContext
Parameters
- rankedWarId: string | number
  The ID for this context
Returns FactionRankedWarIdContext
- Defined in src/generated/endpoints/faction.ts:722

withTerritoryWarId

withTerritoryWarId(
territoryWarId: string | number,
): FactionTerritoryWarIdContext
Parameters
- territoryWarId: string | number
  The ID for this context
Returns FactionTerritoryWarIdContext
- Defined in src/generated/endpoints/faction.ts:729

Class FactionEndpoint

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FactionEndpoint

Methods

applications

Parameters

Returns Promise<FactionApplicationsResponse>

attacks

Parameters

Returns Promise<PaginatedResponse<FactionAttacksResponse> & FactionAttacksResponse>

attacksfull

Parameters

Returns Promise< PaginatedResponse<FactionAttacksFullResponse> & FactionAttacksFullResponse,>

balance

Parameters

Returns Promise<FactionBalanceResponse>

basic

Parameters

Returns Promise<FactionBasicResponse>

chain

Parameters

Returns Promise<FactionOngoingChainResponse>

chainreport

Parameters

Returns Promise<FactionChainReportResponse>

chains

Parameters

Returns Promise<PaginatedResponse<FactionChainsResponse> & FactionChainsResponse>

contributors

Parameters

Returns Promise<FactionContributorsResponse>

crimes

Parameters

Returns Promise<PaginatedResponse<FactionCrimesResponse> & FactionCrimesResponse>

get

Parameters

Returns Promise<FactionResponse>

hof

Parameters

Returns Promise<FactionHofResponse>

lookup

Parameters

Returns Promise<FactionLookupResponse>

members

Parameters

Returns Promise<FactionMembersResponse>

news

Parameters

Returns Promise<PaginatedResponse<FactionNewsResponse> & FactionNewsResponse>

positions

Parameters

Returns Promise<FactionPositionsResponse>

rackets

Parameters

Returns Promise<FactionRacketsResponse>

raids

Parameters

Returns Promise<PaginatedResponse<FactionRaidsResponse> & FactionRaidsResponse>

rankedwars

Parameters

Returns Promise<PaginatedResponse<FactionRankedWarResponse> & FactionRankedWarResponse>

reports

Parameters

Returns Promise<PaginatedResponse<ReportsResponse> & ReportsResponse>

revives

Parameters

Returns Promise<PaginatedResponse<RevivesResponse> & RevivesResponse>

revivesfull

Parameters

Returns Promise<PaginatedResponse<RevivesFullResponse> & RevivesFullResponse>

search

Parameters

Returns Promise<PaginatedResponse<FactionSearchResponse> & FactionSearchResponse>

stats

Parameters

Returns Promise<
PaginatedResponse<FactionAttacksFullResponse> & FactionAttacksFullResponse,
>