Skip to main content

UserClient

Sub-client for querying user data.

Hierarchy

Index

Methods

Properties

Methods

__init__

  • __init__(*, base_url, root_client, http_client, resource_id, resource_path, params): None

  • Initialize a new instance.

    Parameters

    • keyword-onlybase_url: str

      Base URL of the API server.

    • keyword-onlyroot_client: ApifyClient

      The ApifyClient instance under which this resource client exists.

    • keyword-onlyhttp_client: HTTPClient

      The HTTPClient instance to be used in this client.

    • optionalkeyword-onlyresource_id: str | None = None

      ID of the manipulated resource, in case of a single-resource client.

    • keyword-onlyresource_path: str

      Path to the resource's endpoint on the API server.

    • optionalkeyword-onlyparams: dict | None = None

      Parameters to include in all requests from this client.

    Returns None

get

  • get(): dict | None

limits

  • limits(): dict | None

monthly_usage

  • monthly_usage(): dict | None

  • Return monthly usage of the user account.

    This includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown of usage. It is the same information which is available on the account's Billing page. The information includes use of storage, data transfer, and request queue usage.

    https://docs.apify.com/api/v2/#/reference/users/monthly-usage

    Returns dict | None

update_limits

  • update_limits(*, max_monthly_usage_usd, data_retention_days): None

  • Update the account's limits manageable on your account's Limits page.

    Parameters

    • optionalkeyword-onlymax_monthly_usage_usd: int | None = None
    • optionalkeyword-onlydata_retention_days: int | None = None

    Returns None

Properties

http_client

http_client: HTTPClient | HTTPClientAsync

params

params: dict

resource_id

resource_id: str | None

root_client

root_client: ApifyClient | ApifyClientAsync

url

url: str
Page Options