UserClient

Sub-client for querying user data.

Index

Methods

• get
• limits
• monthly_usage
• update_limits

Methods

get

• get(): dict | None

• Return information about user account.

  You receive all or only public info based on your token permissions.

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

  ---

  Returns dict | None

limits

• limits(): dict | None

• Return a complete summary of the user account's limits.

  It is the same information which is available on the account's Limits page. The returned data includes the current usage cycle, a summary of the account's limits, and the current usage.

  https://docs.apify.com/api/v2#/reference/request-queues/request/get-request

  ---

  Returns 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