UserClientAsync
Hierarchy
- ResourceClientAsync
- UserClientAsync
Index
Methods
__init__
Initialize a new instance.
Parameters
keyword-onlybase_url: str
Base URL of the API server.
keyword-onlyroot_client: ApifyClientAsync
The ApifyClientAsync instance under which this resource client exists.
keyword-onlyhttp_client: HTTPClientAsync
The HTTPClientAsync 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
Return information about user account.
You receive all or only public info based on your token permissions.
Returns dict | None
limits
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
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 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
Async sub-client for querying user data.