Class TornEndpoint

Access the Torn API endpoints

Constructors

constructor

new TornEndpoint(requester: Requester): TornEndpoint
Parameters
- requester: Requester
Returns TornEndpoint
- Defined in src/generated/endpoints/torn.ts:55

Methods

attacklog

attacklog(
    params?: {
        log?: string;
        offset?: number;
        sort?: "ASC" | "DESC";
        striptags?: "true" | "false";
        timestamp?: string;
    },
): Promise<PaginatedResponse<AttackLogResponse> & AttackLogResponse>
Get attack log details
Parameters
- Optionalparams: {
      log?: string;
      offset?: number;
      sort?: "ASC" | "DESC";
      striptags?: "true" | "false";
      timestamp?: string;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<AttackLogResponse> & AttackLogResponse>
- Defined in src/generated/endpoints/torn.ts:63

bounties

bounties(
params?: { limit?: number; offset?: number; timestamp?: string },
): Promise<PaginatedResponse<TornBountiesResponse> & TornBountiesResponse>
Get bounties
Parameters
- Optionalparams: { limit?: number; offset?: number; timestamp?: string }
  Optional query parameters
Returns Promise<PaginatedResponse<TornBountiesResponse> & TornBountiesResponse>
- Defined in src/generated/endpoints/torn.ts:85

calendar

calendar(params?: { timestamp?: string }): Promise<TornCalendarResponse>
Get calendar information
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornCalendarResponse>
- Defined in src/generated/endpoints/torn.ts:103

crimes

crimes(params?: { timestamp?: string }): Promise<TornCrimesResponse>
Get crimes information
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornCrimesResponse>
- Defined in src/generated/endpoints/torn.ts:117

education

education(params?: { timestamp?: string }): Promise<TornEducationResponse>
Get education information
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornEducationResponse>
- Defined in src/generated/endpoints/torn.ts:131

elimination

elimination(
params?: { timestamp?: string },
): Promise<TornEliminationTeamsResponse>
Get current standings for all elimination teams
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornEliminationTeamsResponse>
- Defined in src/generated/endpoints/torn.ts:145

factionhof

factionhof(
    params?: {
        cat?: TornFactionHofCategory;
        limit?: number;
        offset?: number;
        timestamp?: string;
    },
): Promise<
    PaginatedResponse<TornFactionHofResponse> & TornFactionHofResponse,
>
Get faction hall of fame positions for a specific category
Parameters
- Optionalparams: {
      cat?: TornFactionHofCategory;
      limit?: number;
      offset?: number;
      timestamp?: string;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<TornFactionHofResponse> & TornFactionHofResponse>
- Defined in src/generated/endpoints/torn.ts:159

factiontree

factiontree(params?: { timestamp?: string }): Promise<TornFactionTreeResponse>
Get full faction tree
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornFactionTreeResponse>
- Defined in src/generated/endpoints/torn.ts:181

get

get(
    params?: {
        cat?:
            | "Special"
            | "Alcohol"
            | "Armor"
            | "Artifact"
            | "Book"
            | "Booster"
            | "Candy"
            | "Car"
            | "Clothing"
            | "Collectible"
            | "Drug"
            | "Energy Drink"
            | "Enhancer"
            | "Flower"
            | "Jewelry"
            | "Material"
            | "Medical"
            | "Other"
            | "Plushie"
            | "Supply Pack"
            | "Tool"
            | "Unused"
            | "Weapon"
            | "attacks"
            | "chains"
            | "revives"
            | "busts"
            | "traveltime"
            | "level"
            | "workstats"
            | "networth"
            | "Defensive"
            | "Melee"
            | "Primary"
            | "Secondary"
            | "Temporary"
            | "rank"
            | "racingskill"
            | "awards"
            | "respect"
            | "defends"
            | "offences"
            | "racingwins"
            | "racingpoints"
            | "All";
        from?: number;
        id?: number
        | number[]
        | FactionTerritoryEnum[];
        legacy?: string[];
        limit?: number;
        offset?: number;
        selections?: string[];
        sort?: "ASC" | "DESC";
        striptags?: "true" | "false";
        timestamp?: string;
        to?: number;
    },
): Promise<TornResponse>
Get any Torn selection
Parameters
- Optionalparams: {
      cat?:
          | "Special"
          | "Alcohol"
          | "Armor"
          | "Artifact"
          | "Book"
          | "Booster"
          | "Candy"
          | "Car"
          | "Clothing"
          | "Collectible"
          | "Drug"
          | "Energy Drink"
          | "Enhancer"
          | "Flower"
          | "Jewelry"
          | "Material"
          | "Medical"
          | "Other"
          | "Plushie"
          | "Supply Pack"
          | "Tool"
          | "Unused"
          | "Weapon"
          | "attacks"
          | "chains"
          | "revives"
          | "busts"
          | "traveltime"
          | "level"
          | "workstats"
          | "networth"
          | "Defensive"
          | "Melee"
          | "Primary"
          | "Secondary"
          | "Temporary"
          | "rank"
          | "racingskill"
          | "awards"
          | "respect"
          | "defends"
          | "offences"
          | "racingwins"
          | "racingpoints"
          | "All";
      from?: number;
      id?: number
      | number[]
      | FactionTerritoryEnum[];
      legacy?: string[];
      limit?: number;
      offset?: number;
      selections?: string[];
      sort?: "ASC" | "DESC";
      striptags?: "true" | "false";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<TornResponse>
- Defined in src/generated/endpoints/torn.ts:429

hof

hof(
    params?: {
        cat?: TornHofCategory;
        limit?: number;
        offset?: number;
        timestamp?: string;
    },
): Promise<PaginatedResponse<TornHofResponse> & TornHofResponse>
Get player hall of fame positions for a specific category
Parameters
- Optionalparams: { cat?: TornHofCategory; limit?: number; offset?: number; timestamp?: string }
  Optional query parameters
Returns Promise<PaginatedResponse<TornHofResponse> & TornHofResponse>
- Defined in src/generated/endpoints/torn.ts:215

honors

honors(
    params?: {
        limit?: number;
        offset?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
    },
): Promise<TornHonorsResponse>
Get all honors
Parameters
- Optionalparams: { limit?: number; offset?: number; sort?: "ASC" | "DESC"; timestamp?: string }
  Optional query parameters
Returns Promise<TornHonorsResponse>
- Defined in src/generated/endpoints/torn.ts:195

itemammo

itemammo(params?: { timestamp?: string }): Promise<TornItemAmmoResponse>
Get information about ammo
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornItemAmmoResponse>
- Defined in src/generated/endpoints/torn.ts:235

itemmods

itemmods(params?: { timestamp?: string }): Promise<TornItemModsResponse>
Get information about weapon upgrades
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornItemModsResponse>
- Defined in src/generated/endpoints/torn.ts:249

items

items(
    params?: {
        cat?: TornItemCategory;
        sort?: "ASC" | "DESC";
        timestamp?: string;
    },
): Promise<TornItemsResponse>
Get information about items
Parameters
- Optionalparams: { cat?: TornItemCategory; sort?: "ASC" | "DESC"; timestamp?: string }
  Optional query parameters
Returns Promise<TornItemsResponse>
- Defined in src/generated/endpoints/torn.ts:263

logcategories

logcategories(
params?: { timestamp?: string },
): Promise<TornLogCategoriesResponse>
Get available log categories
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornLogCategoriesResponse>
- Defined in src/generated/endpoints/torn.ts:281

logtypes

logtypes(params?: { timestamp?: string }): Promise<TornLogTypesResponse>
Get all available log ids
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornLogTypesResponse>
- Defined in src/generated/endpoints/torn.ts:295

lookup

lookup(params?: { timestamp?: string }): Promise<TornLookupResponse>
Get all available torn selections
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornLookupResponse>
- Defined in src/generated/endpoints/torn.ts:401

medals

medals(params?: { timestamp?: string }): Promise<TornMedalsResponse>
Get all medals
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornMedalsResponse>
- Defined in src/generated/endpoints/torn.ts:309

merits

merits(params?: { timestamp?: string }): Promise<TornMeritsResponse>
Get all merits
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornMeritsResponse>
- Defined in src/generated/endpoints/torn.ts:323

organizedcrimes

organizedcrimes(
params?: { timestamp?: string },
): Promise<TornOrganizedCrimeResponse>
Get organized crimes information
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornOrganizedCrimeResponse>
- Defined in src/generated/endpoints/torn.ts:337

properties

properties(params?: { timestamp?: string }): Promise<TornProperties>
Get properties details
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornProperties>
- Defined in src/generated/endpoints/torn.ts:351

stocks

stocks(params?: { timestamp?: string }): Promise<TornStocksResponse>
Get all stocks
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TornStocksResponse>
- Defined in src/generated/endpoints/torn.ts:365

territory

territory(
    params?: {
        ids?: FactionTerritoryEnum[];
        limit?: number;
        offset?: number;
        timestamp?: string;
    },
): Promise<
    PaginatedResponse<TornTerritoriesResponse> & TornTerritoriesResponse,
>
Get territory details
Parameters
- Optionalparams: {
      ids?: FactionTerritoryEnum[];
      limit?: number;
      offset?: number;
      timestamp?: string;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<TornTerritoriesResponse> & TornTerritoriesResponse>
- Defined in src/generated/endpoints/torn.ts:379

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/torn.ts:415

withCrimeId

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

withId

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

withIds

withIds(ids: string | number): TornIdsContext
Parameters
- ids: string | number
  The ID for this context
Returns TornIdsContext
- Defined in src/generated/endpoints/torn.ts:474

withLogCategoryId

withLogCategoryId(logCategoryId: string | number): TornLogCategoryIdContext
Parameters
- logCategoryId: string | number
  The ID for this context
Returns TornLogCategoryIdContext
- Defined in src/generated/endpoints/torn.ts:479

withStockId

withStockId(stockId: string | number): TornStockIdContext
Parameters
- stockId: string | number
  The ID for this context
Returns TornStockIdContext
- Defined in src/generated/endpoints/torn.ts:486

Class TornEndpoint

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TornEndpoint

Methods

attacklog

Parameters

Returns Promise<PaginatedResponse<AttackLogResponse> & AttackLogResponse>

bounties

Parameters

Returns Promise<PaginatedResponse<TornBountiesResponse> & TornBountiesResponse>

calendar

Parameters

Returns Promise<TornCalendarResponse>

crimes

Parameters

Returns Promise<TornCrimesResponse>

education

Parameters

Returns Promise<TornEducationResponse>

elimination

Parameters

Returns Promise<TornEliminationTeamsResponse>

factionhof

Parameters

Returns Promise<PaginatedResponse<TornFactionHofResponse> & TornFactionHofResponse>

factiontree

Parameters

Returns Promise<TornFactionTreeResponse>

get

Parameters

Returns Promise<TornResponse>

hof

Parameters

Returns Promise<PaginatedResponse<TornHofResponse> & TornHofResponse>

honors

Parameters

Returns Promise<TornHonorsResponse>

itemammo

Parameters

Returns Promise<TornItemAmmoResponse>

itemmods

Parameters

Returns Promise<TornItemModsResponse>

items

Parameters

Returns Promise<TornItemsResponse>

logcategories

Parameters

Returns Promise<TornLogCategoriesResponse>

logtypes

Parameters

Returns Promise<TornLogTypesResponse>

lookup

Parameters

Returns Promise<TornLookupResponse>

medals

Parameters

Returns Promise<TornMedalsResponse>

merits

Parameters

Returns Promise<TornMeritsResponse>

organizedcrimes

Parameters

Returns Promise<TornOrganizedCrimeResponse>

properties

Parameters

Returns Promise<TornProperties>

stocks

Parameters

Returns Promise<TornStocksResponse>

territory

Parameters

Returns Promise<PaginatedResponse<TornTerritoriesResponse> & TornTerritoriesResponse>

timestamp

Parameters