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:78

Methods

attacks

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

attacksfull

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

bars

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

basic

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

battlestats

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

bounties

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

calendar

calendar(params?: { timestamp?: string }): Promise<UserCalendarResponse>
Get your competition's event start time
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<UserCalendarResponse>
- Defined in src/generated/endpoints/user.ts:196

competition

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

cooldowns

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

education

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

enlistedcars

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

events

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

faction

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

factionbalance

factionbalance(
params?: { timestamp?: string },
): Promise<UserFactionBalanceResponse>
Deprecated. Use user/money instead
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<UserFactionBalanceResponse>
- Defined in src/generated/endpoints/user.ts:302

forumfeed

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

forumfriends

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

forumposts

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

forumsubscribedthreads

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

forumthreads

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

get

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

hof

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

honors

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

icons

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

itemmarket

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

job

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

jobpoints

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

jobranks

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

list

list(
    params?: {
        cat?: UserListEnum;
        limit?: number;
        offset?: number;
        sort?: "ASC" | "DESC";
        striptags?: "true" | "false";
        timestamp?: string;
    },
): 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;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<UserListResponse> & UserListResponse>
- Defined in src/generated/endpoints/user.ts:506

log

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

lookup

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

medals

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

merits

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

messages

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

money

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

newevents

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

newmessages

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

notifications

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

organizedcrime

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

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:676

profile

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

properties

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

property

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

races

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

racingrecords

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

refills

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

reports

reports(
    params?: {
        cat?: ReportTypeEnum;
        limit?: number;
        offset?: number;
        target?: number;
        timestamp?: string;
    },
): Promise<PaginatedResponse<ReportsResponse> & ReportsResponse>
Get your 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/user.ts:798

revives

revives(
    params?: {
        filters?: "incoming" | "outgoing";
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        striptags?: "true" | "false";
        timestamp?: string;
        to?: number;
    },
): Promise<PaginatedResponse<RevivesResponse> & RevivesResponse>
Get your detailed revives
Parameters
- Optionalparams: {
      filters?: "incoming" | "outgoing";
      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/user.ts:820

revivesfull

revivesfull(
    params?: {
        filters?: "incoming" | "outgoing";
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        striptags?: "true" | "false";
        timestamp?: string;
        to?: number;
    },
): Promise<PaginatedResponse<RevivesFullResponse> & RevivesFullResponse>
Get your simplified revives
Parameters
- Optionalparams: {
      filters?: "incoming" | "outgoing";
      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/user.ts:846

skills

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

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/user.ts:942

travel

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

virus

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

withCrimeId

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

withId

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

workstats

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

Class UserEndpoint

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns UserEndpoint

Methods

attacks

Parameters

Returns Promise<PaginatedResponse<FactionAttacksResponse> & FactionAttacksResponse>

attacksfull

Parameters

Returns Promise< PaginatedResponse<FactionAttacksFullResponse> & FactionAttacksFullResponse,>

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>

competition

Parameters

Returns Promise<UserCompetitionResponse>

cooldowns

Parameters

Returns Promise<UserCooldownsResponse>

education

Parameters

Returns Promise<UserEducationResponse>

enlistedcars

Parameters

Returns Promise<UserEnlistedCarsResponse>

events

Parameters

Returns Promise<PaginatedResponse<UserEventsResponse> & UserEventsResponse>

faction

Parameters

Returns Promise<UserFactionResponse>

factionbalance

Parameters

Returns Promise<UserFactionBalanceResponse>

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

Returns Promise<UserHofResponse>

honors

Parameters

Returns Promise<UserHonorsResponse>

icons

Parameters

Returns Promise<UserIconsResponse>

itemmarket

Parameters

Returns Promise<
PaginatedResponse<FactionAttacksFullResponse> & FactionAttacksFullResponse,
>