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

Methods

attacks

attacks(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<
    PaginatedResponse<FactionAttacksResponse> & FactionAttacksResponse,
>
Get your 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/user.ts:59

attacksfull

attacksfull(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<
    PaginatedResponse<FactionAttacksFullResponse> & FactionAttacksFullResponse,
>
Get your 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/user.ts:83

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

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

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

enlistedcars

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

factionbalance

factionbalance(
params?: { timestamp?: string },
): Promise<UserFactionBalanceResponse>
Get your current faction balance
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<UserFactionBalanceResponse>
- Defined in src/generated/endpoints/user.ts:163

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

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

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

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

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

get

get(
    params?: {
        cat?:
            | PersonalStatsCategoryEnum
            | RacingRaceTypeEnum
            | ReportTypeEnum
            | UserListEnum;
        from?: number;
        id?: string
        | number;
        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;
      from?: number;
      id?: string
      | number;
      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:537

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

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

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

list

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

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

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

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

properties

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

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

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

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

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

revives

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

revivesfull

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

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

withCrimeId

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

withId

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

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,>

bounties

Parameters

Returns Promise<UserBountiesResponse>

calendar

Parameters

Returns Promise<UserCalendarResponse>

education

Parameters

Returns Promise<UserEducationResponse>

enlistedcars

Parameters

Returns Promise<UserEnlistedCarsResponse>

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>

itemmarket

Parameters

Returns Promise<PaginatedResponse<UserItemMarketResponse> & UserItemMarketResponse>

jobranks

Parameters

Returns Promise<UserJobRanksResponse>

list

Parameters

Returns Promise<PaginatedResponse<UserListResponse> & UserListResponse>

lookup

Parameters

Returns Promise<UserLookupResponse>

organizedcrime

Parameters

Returns Promise<UserOrganizedCrimeResponse>

personalstats

Parameters

Returns Promise<UserPersonalStatsResponse>

properties

Parameters

Returns Promise<PaginatedResponse<UserPropertiesResponse> & UserPropertiesResponse>

property

Parameters

Returns Promise<UserPropertyResponse>

races

Parameters

Returns Promise<PaginatedResponse<UserRacesResponse> & UserRacesResponse>

racingrecords

Parameters

Returns Promise<
PaginatedResponse<FactionAttacksFullResponse> & FactionAttacksFullResponse,
>