Skip to main content
Version: Next

UserClient

Client for managing user account information.

Provides methods to retrieve user details, monthly usage statistics, and account limits. When using an API token, you can access your own user information or public information about other users.

Hierarchy

  • ResourceClient
    • UserClient
const client = new ApifyClient({ token: 'my-token' });
const userClient = client.user('my-user-id');

// Get user information
const user = await userClient.get();

// Get monthly usage
const usage = await userClient.monthlyUsage();

// Get account limits
const limits = await userClient.limits();

See more at https://docs.apify.com/platform/actors/running

Index

Properties

Methods

Properties

inheritedapifyClient

apifyClient: ApifyClient

inheritedbaseUrl

baseUrl: string

inheritedhttpClient

httpClient: HttpClient

optionalinheritedid

id?: string

optionalinheritedparams

params?: Record<string, unknown>

inheritedpublicBaseUrl

publicBaseUrl: string

Added in 2.17.0

inheritedresourcePath

resourcePath: string

optionalinheritedsafeId

safeId?: string

inheritedurl

url: string

Methods

get

  • Retrieves the user data.

    Depending on whether ApifyClient was created with a token, the method will either return public or private user data.

    Parameters

    Returns Promise<undefined | UserPrivateInfo>

    The user object, or undefined if it does not exist.

    See more at https://docs.apify.com/api/v2/user-get

limits

monthlyUsage

updateLimits

  • updateLimits(newLimits, options): Promise<void>
Page Options