Class UserEndpoint

Access the User API endpoints

Constructors

constructor

new UserEndpoint(requester: Requester): UserEndpoint
Parameters
- requester: Requester
Returns UserEndpoint
- Defined in src/generated/endpoints/user.ts:94

Methods

ammo

ammo(params?: { timestamp?: string | number }): Promise<UserAmmoResponse>
Get your ammo information
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserAmmoResponse>
- Defined in src/generated/endpoints/user.ts:102

attacks

attacks(
    params?: {
        filters?: ApiFiltersAttacksRevivesEnum[];
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string | number;
        to?: number;
    },
): Promise<PaginatedResponse<AttacksResponse> & AttacksResponse>
Get your detailed attacks
Parameters
- Optionalparams: {
      filters?: ApiFiltersAttacksRevivesEnum[];
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string | number;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<AttacksResponse> & AttacksResponse>
- Defined in src/generated/endpoints/user.ts:116

attacksfull

attacksfull(
    params?: {
        filters?: ApiFiltersAttacksRevivesEnum[];
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string | number;
        to?: number;
    },
): Promise<PaginatedResponse<AttacksFullResponse> & AttacksFullResponse>
Get your simplified attacks
Parameters
- Optionalparams: {
      filters?: ApiFiltersAttacksRevivesEnum[];
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string | number;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<AttacksFullResponse> & AttacksFullResponse>
- Defined in src/generated/endpoints/user.ts:140

bars

bars(params?: { timestamp?: string | number }): Promise<UserBarsResponse>
Get your bars information
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserBarsResponse>
- Defined in src/generated/endpoints/user.ts:164

basic

basic(
params?: { striptags?: "true" | "false"; timestamp?: string | number },
): Promise<UserBasicResponse>
Get your basic profile information
Parameters
- Optionalparams: { striptags?: "true" | "false"; timestamp?: string | number }
  Optional query parameters
Returns Promise<UserBasicResponse>
- Defined in src/generated/endpoints/user.ts:178

battlestats

battlestats(
params?: { timestamp?: string | number },
): Promise<UserBattleStatsResponse>
Get your battlestats
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserBattleStatsResponse>
- Defined in src/generated/endpoints/user.ts:194

bounties

bounties(
params?: { timestamp?: string | number },
): Promise<UserBountiesResponse>
Get bounties placed on you
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserBountiesResponse>
- Defined in src/generated/endpoints/user.ts:208

calendar

calendar(
params?: { timestamp?: string | number },
): Promise<UserCalendarResponse>
Get your calendar events start time
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserCalendarResponse>
- Defined in src/generated/endpoints/user.ts:222

casino

casino(params?: { timestamp?: string | number }): Promise<UserCasinoResponse>
Get your casino streak & tokens
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserCasinoResponse>
- Defined in src/generated/endpoints/user.ts:236

competition

competition(
params?: { timestamp?: string | number },
): Promise<UserCompetitionResponse>
Get your competition information
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserCompetitionResponse>
- Defined in src/generated/endpoints/user.ts:250

cooldowns

cooldowns(
params?: { timestamp?: string | number },
): Promise<UserCooldownsResponse>
Get your cooldowns information
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserCooldownsResponse>
- Defined in src/generated/endpoints/user.ts:264

discord

discord(params?: { timestamp?: string | number }): Promise<UserDiscordResponse>
Get your discord information
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserDiscordResponse>
- Defined in src/generated/endpoints/user.ts:278

education

education(
params?: { timestamp?: string | number },
): Promise<UserEducationResponse>
Get your education information
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserEducationResponse>
- Defined in src/generated/endpoints/user.ts:292

enlistedcars

enlistedcars(
params?: { timestamp?: string | number },
): Promise<UserEnlistedCarsResponse>
Get your enlisted cars
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserEnlistedCarsResponse>
- Defined in src/generated/endpoints/user.ts:306

equipment

equipment(
params?: { timestamp?: string | number },
): Promise<UserEquipmentResponse>
Get your equipment & clothing
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserEquipmentResponse>
- Defined in src/generated/endpoints/user.ts:320

events

events(
    params?: {
        from?: number;
        limit?: number;
        striptags?: "true" | "false";
        timestamp?: string | number;
        to?: number;
    },
): Promise<PaginatedResponse<UserEventsResponse> & UserEventsResponse>
Get your events
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      striptags?: "true" | "false";
      timestamp?: string | number;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<UserEventsResponse> & UserEventsResponse>
- Defined in src/generated/endpoints/user.ts:334

faction

faction(params?: { timestamp?: string | number }): Promise<UserFactionResponse>
Get your faction information
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserFactionResponse>
- Defined in src/generated/endpoints/user.ts:356

forumfeed

forumfeed(
params?: { timestamp?: string | number },
): Promise<UserForumFeedResponse>
Get updates on your threads and posts
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserForumFeedResponse>
- Defined in src/generated/endpoints/user.ts:370

forumfriends

forumfriends(
params?: { timestamp?: string | number },
): Promise<UserForumFriendsResponse>
Get updates on your friends' activity
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserForumFriendsResponse>
- Defined in src/generated/endpoints/user.ts:384

forumposts

forumposts(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        striptags?: "true" | "false";
        timestamp?: string | number;
        to?: number;
    },
): Promise<
    PaginatedResponse<UserForumPostsResponse> & UserForumPostsResponse,
>
Get your posts
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      striptags?: "true" | "false";
      timestamp?: string | number;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<UserForumPostsResponse> & UserForumPostsResponse>
- Defined in src/generated/endpoints/user.ts:398

forumsubscribedthreads

forumsubscribedthreads(
params?: { timestamp?: string | number },
): Promise<UserForumSubscribedThreadsResponse>
Get updates on threads you subscribed to
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserForumSubscribedThreadsResponse>
- Defined in src/generated/endpoints/user.ts:424

forumthreads

forumthreads(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string | number;
        to?: number;
    },
): Promise<
    PaginatedResponse<UserForumThreadsResponse> & UserForumThreadsResponse,
>
Get your threads
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string | number;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<UserForumThreadsResponse> & UserForumThreadsResponse>
- Defined in src/generated/endpoints/user.ts:438

get

get(
    params?: {
        cat?:
            | PersonalStatsCategoryEnum
            | RacingRaceTypeEnum
            | ReportTypeEnum
            | UserListEnum
            | TornInventoryItemType
            | TradeCategoryEnum;
        filters?: "incoming"
        | "outgoing"
        | "ownedByUser"
        | "ownedBySpouse";
        from?: number;
        id?: UserDiscordPathId;
        legacy?: string[];
        limit?: number;
        offset?: number;
        selections?: string[];
        sort?: "ASC" | "DESC";
        stat?: PersonalStatsStatName[];
        striptags?: "true" | "false";
        timestamp?: string | number;
        to?: number;
    },
): Promise<UserResponse>
Get any User selection
Parameters
- Optionalparams: {
      cat?:
          | PersonalStatsCategoryEnum
          | RacingRaceTypeEnum
          | ReportTypeEnum
          | UserListEnum
          | TornInventoryItemType
          | TradeCategoryEnum;
      filters?: "incoming"
      | "outgoing"
      | "ownedByUser"
      | "ownedBySpouse";
      from?: number;
      id?: UserDiscordPathId;
      legacy?: string[];
      limit?: number;
      offset?: number;
      selections?: string[];
      sort?: "ASC" | "DESC";
      stat?: PersonalStatsStatName[];
      striptags?: "true" | "false";
      timestamp?: string | number;
      to?: number;
  }
  Optional query parameters
Returns Promise<UserResponse>
- Defined in src/generated/endpoints/user.ts:1148

hof

hof(params?: { timestamp?: string | number }): Promise<UserHofResponse>
Get your hall of fame rankings
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserHofResponse>
- Defined in src/generated/endpoints/user.ts:462

honors

honors(params?: { timestamp?: string | number }): Promise<UserHonorsResponse>
Get your achieved honors
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserHonorsResponse>
- Defined in src/generated/endpoints/user.ts:476

icons

icons(params?: { timestamp?: string | number }): Promise<UserIconsResponse>
Get your icons information
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserIconsResponse>
- Defined in src/generated/endpoints/user.ts:490

inventory

inventory(
    params?: {
        cat?: TornInventoryItemType;
        limit?: number;
        offset?: number;
        timestamp?: string | number;
    },
): Promise<PaginatedResponse<UserInventoryResponse> & UserInventoryResponse>
Get your inventory
Parameters
- Optionalparams: {
      cat?: TornInventoryItemType;
      limit?: number;
      offset?: number;
      timestamp?: string | number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<UserInventoryResponse> & UserInventoryResponse>
- Defined in src/generated/endpoints/user.ts:504

itemmarket

itemmarket(
params?: { offset?: number; timestamp?: string | number },
): Promise<
PaginatedResponse<UserItemMarketResponse> & UserItemMarketResponse,
>
Get your item market listings
Parameters
- Optionalparams: { offset?: number; timestamp?: string | number }
  Optional query parameters
Returns Promise<PaginatedResponse<UserItemMarketResponse> & UserItemMarketResponse>
- Defined in src/generated/endpoints/user.ts:526

itemmods

itemmods(
params?: { timestamp?: string | number },
): Promise<UserItemModsResponse>
Get your information about available item mods
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserItemModsResponse>
- Defined in src/generated/endpoints/user.ts:544

job

job(params?: { timestamp?: string | number }): Promise<UserJobResponse>
Get your job information
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserJobResponse>
- Defined in src/generated/endpoints/user.ts:558

jobpoints

jobpoints(
params?: { timestamp?: string | number },
): Promise<UserJobPointsResponse>
Get your jobpoints
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserJobPointsResponse>
- Defined in src/generated/endpoints/user.ts:572

jobranks

jobranks(
params?: { timestamp?: string | number },
): Promise<UserJobRanksResponse>
Get your starter job positions
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserJobRanksResponse>
- Defined in src/generated/endpoints/user.ts:586

list

list(
    params?: {
        cat?: UserListEnum;
        limit?: number;
        offset?: number;
        sort?: "ASC" | "DESC";
        striptags?: "true" | "false";
        timestamp?: string | number;
    },
): Promise<PaginatedResponse<UserListResponse> & UserListResponse>
Get your friends, enemies or targets list
Parameters
- Optionalparams: {
      cat?: UserListEnum;
      limit?: number;
      offset?: number;
      sort?: "ASC" | "DESC";
      striptags?: "true" | "false";
      timestamp?: string | number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<UserListResponse> & UserListResponse>
- Defined in src/generated/endpoints/user.ts:600

log

log(
    params?: {
        cat?: number;
        from?: number;
        limit?: number;
        log?: number[];
        target?: number;
        timestamp?: string | number;
        to?: number;
    },
): Promise<PaginatedResponse<UserLogsResponse> & UserLogsResponse>
Get your logs
Parameters
- Optionalparams: {
      cat?: number;
      from?: number;
      limit?: number;
      log?: number[];
      target?: number;
      timestamp?: string | number;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<UserLogsResponse> & UserLogsResponse>
- Defined in src/generated/endpoints/user.ts:624

lookup

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

medals

medals(params?: { timestamp?: string | number }): Promise<UserMedalsResponse>
Get your achieved medals
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserMedalsResponse>
- Defined in src/generated/endpoints/user.ts:650

merits

merits(params?: { timestamp?: string | number }): Promise<UserMeritsResponse>
Get your merits
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserMeritsResponse>
- Defined in src/generated/endpoints/user.ts:664

messages

messages(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string | number;
        to?: number;
    },
): Promise<PaginatedResponse<UserMessagesResponse> & UserMessagesResponse>
Get your messages
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string | number;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<UserMessagesResponse> & UserMessagesResponse>
- Defined in src/generated/endpoints/user.ts:678

missions

missions(
params?: { timestamp?: string | number },
): Promise<UserMissionsResponse>
Get your current missions information
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserMissionsResponse>
- Defined in src/generated/endpoints/user.ts:700

money

money(params?: { timestamp?: string | number }): Promise<UserMoneyResponse>
Get your current wealth
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserMoneyResponse>
- Defined in src/generated/endpoints/user.ts:714

newevents

newevents(
params?: { striptags?: "true" | "false"; timestamp?: string | number },
): Promise<UserNewEventsResponse>
Get your unseen events
Parameters
- Optionalparams: { striptags?: "true" | "false"; timestamp?: string | number }
  Optional query parameters
Returns Promise<UserNewEventsResponse>
- Defined in src/generated/endpoints/user.ts:728

newmessages

newmessages(
params?: { timestamp?: string | number },
): Promise<UserNewMessagesResponse>
Get your unseen messages
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserNewMessagesResponse>
- Defined in src/generated/endpoints/user.ts:744

notifications

notifications(
params?: { timestamp?: string | number },
): Promise<UserNotificationsResponse>
Get your notifications
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserNotificationsResponse>
- Defined in src/generated/endpoints/user.ts:758

organizedcrime

organizedcrime(
params?: { timestamp?: string | number },
): Promise<UserOrganizedCrimeResponse>
Get your current ongoing organized crime
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserOrganizedCrimeResponse>
- Defined in src/generated/endpoints/user.ts:772

organizedcrimes

organizedcrimes(
params?: { timestamp?: string | number },
): Promise<UserOrganizedCrimesResponse>
Get your available slots for organized crimes with status 'Recruiting'
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserOrganizedCrimesResponse>
- Defined in src/generated/endpoints/user.ts:786

personalstats

personalstats(
    params?: {
        cat?: PersonalStatsCategoryEnum;
        stat?: PersonalStatsStatName[];
        timestamp?: number;
    },
): Promise<UserPersonalStatsResponse>
Get your personal stats
Parameters
- Optionalparams: {
      cat?: PersonalStatsCategoryEnum;
      stat?: PersonalStatsStatName[];
      timestamp?: number;
  }
  Optional query parameters
Returns Promise<UserPersonalStatsResponse>
- Defined in src/generated/endpoints/user.ts:800

profile

profile(
params?: { striptags?: "true" | "false"; timestamp?: string | number },
): Promise<UserProfileResponse>
Get your own profile
Parameters
- Optionalparams: { striptags?: "true" | "false"; timestamp?: string | number }
  Optional query parameters
Returns Promise<UserProfileResponse>
- Defined in src/generated/endpoints/user.ts:818

properties

properties(
    params?: {
        filters?: "ownedByUser" | "ownedBySpouse";
        limit?: number;
        offset?: number;
        timestamp?: string | number;
    },
): Promise<
    PaginatedResponse<UserPropertiesResponse> & UserPropertiesResponse,
>
Get your own properties
Parameters
- Optionalparams: {
      filters?: "ownedByUser" | "ownedBySpouse";
      limit?: number;
      offset?: number;
      timestamp?: string | number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<UserPropertiesResponse> & UserPropertiesResponse>
- Defined in src/generated/endpoints/user.ts:834

property

property(
params?: { timestamp?: string | number },
): Promise<UserPropertyResponse>
Get your current property
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserPropertyResponse>
- Defined in src/generated/endpoints/user.ts:856

races

races(
    params?: {
        cat?: RacingRaceTypeEnum;
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string | number;
        to?: number;
    },
): Promise<PaginatedResponse<UserRacesResponse> & UserRacesResponse>
Get your races
Parameters
- Optionalparams: {
      cat?: RacingRaceTypeEnum;
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string | number;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<UserRacesResponse> & UserRacesResponse>
- Defined in src/generated/endpoints/user.ts:870

racingrecords

racingrecords(
params?: { timestamp?: string | number },
): Promise<UserRacingRecordsResponse>
Get your current racing records
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserRacingRecordsResponse>
- Defined in src/generated/endpoints/user.ts:894

refills

refills(params?: { timestamp?: string | number }): Promise<UserRefillsResponse>
Get your refills information
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserRefillsResponse>
- Defined in src/generated/endpoints/user.ts:908

reports

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

revives

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

revivesfull

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

skills

skills(params?: { timestamp?: string | number }): Promise<UserSkillsResponse>
Get your skills
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserSkillsResponse>
- Defined in src/generated/endpoints/user.ts:998

snapshot

snapshot(params?: { timestamp?: string | number }): Promise<unknown>
Get daily active players snapshot CSV
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<unknown>
- Defined in src/generated/endpoints/user.ts:1012

stocks

stocks(params?: { timestamp?: string | number }): Promise<UserStocksResponse>
Get your stocks
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserStocksResponse>
- Defined in src/generated/endpoints/user.ts:1026

timestamp

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

trades

trades(
    params?: {
        cat?: TradeCategoryEnum;
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string | number;
        to?: number;
    },
): Promise<PaginatedResponse<UserTradesResponse> & UserTradesResponse>
Get your trades
Parameters
- Optionalparams: {
      cat?: TradeCategoryEnum;
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string | number;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<UserTradesResponse> & UserTradesResponse>
- Defined in src/generated/endpoints/user.ts:1040

travel

travel(params?: { timestamp?: string | number }): Promise<UserTravelResponse>
Get your travel information
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserTravelResponse>
- Defined in src/generated/endpoints/user.ts:1064

virus

virus(params?: { timestamp?: string | number }): Promise<UserVirusResponse>
Get your virus coding information
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserVirusResponse>
- Defined in src/generated/endpoints/user.ts:1078

weaponexp

weaponexp(
params?: { timestamp?: string | number },
): Promise<UserWeaponExpResponse>
Get your weapon experience information
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserWeaponExpResponse>
- Defined in src/generated/endpoints/user.ts:1092

withCrimeId

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

withId

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

withTradeId

withTradeId(tradeId: string | number): UserTradeIdContext
Parameters
- tradeId: string | number
  The ID for this context
Returns UserTradeIdContext
- Defined in src/generated/endpoints/user.ts:1199

workstats

workstats(
params?: { timestamp?: string | number },
): Promise<UserWorkStatsResponse>
Get your working stats
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<UserWorkStatsResponse>
- Defined in src/generated/endpoints/user.ts:1106

Class UserEndpoint

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns UserEndpoint

Methods

ammo

Parameters

Returns Promise<UserAmmoResponse>

attacks

Parameters

Returns Promise<PaginatedResponse<AttacksResponse> & AttacksResponse>

attacksfull

Parameters

Returns Promise<PaginatedResponse<AttacksFullResponse> & AttacksFullResponse>

bars

Parameters

Returns Promise<UserBarsResponse>

basic

Parameters

Returns Promise<UserBasicResponse>

battlestats

Parameters

Returns Promise<UserBattleStatsResponse>

bounties

Parameters

Returns Promise<UserBountiesResponse>

calendar

Parameters

Returns Promise<UserCalendarResponse>

casino

Parameters

Returns Promise<UserCasinoResponse>

competition

Parameters

Returns Promise<UserCompetitionResponse>

cooldowns

Parameters

Returns Promise<UserCooldownsResponse>

discord

Parameters

Returns Promise<UserDiscordResponse>

education

Parameters

Returns Promise<UserEducationResponse>

enlistedcars

Parameters

Returns Promise<UserEnlistedCarsResponse>

equipment

Parameters

Returns Promise<UserEquipmentResponse>

events

Parameters

Returns Promise<PaginatedResponse<UserEventsResponse> & UserEventsResponse>

faction

Parameters

Returns Promise<UserFactionResponse>

forumfeed

Parameters

Returns Promise<UserForumFeedResponse>

forumfriends

Parameters

Returns Promise<UserForumFriendsResponse>

forumposts

Parameters

Returns Promise<PaginatedResponse<UserForumPostsResponse> & UserForumPostsResponse>

forumsubscribedthreads

Parameters

Returns Promise<UserForumSubscribedThreadsResponse>

forumthreads

Parameters

Returns Promise<PaginatedResponse<UserForumThreadsResponse> & UserForumThreadsResponse>

get

Parameters

Returns Promise<UserResponse>

hof

Parameters