# API client for Python | Apify Documentation


## api

- [Search the documentation](https://docs.apify.com/api/client/python/search.md)
- [Overview](https://docs.apify.com/api/client/python/docs.md): The official Python library to access the Apify API, with automatic retries, async support, and comprehensive API coverage.
- [Changelog](https://docs.apify.com/api/client/python/docs/changelog.md): All notable changes to this project will be documented in this file.
- [Asyncio support](https://docs.apify.com/api/client/python/docs/concepts/asyncio-support.md): Use the async client for non-blocking API calls with Python asyncio.
- [Convenience methods](https://docs.apify.com/api/client/python/docs/concepts/convenience-methods.md): Use high-level methods for running Actors, waiting for results, and accessing data.
- [HTTP clients](https://docs.apify.com/api/client/python/docs/concepts/custom-http-clients.md): Understand the built-in HTTP clients and the custom client interface.
- [Error handling](https://docs.apify.com/api/client/python/docs/concepts/error-handling.md): Handle API errors with the ApifyApiError exception and automatic data parsing.
- [HTTP compression](https://docs.apify.com/api/client/python/docs/concepts/http-compression.md): The client compresses request bodies automatically using gzip by default, with optional brotli via an explicit opt-in.
- [Logging](https://docs.apify.com/api/client/python/docs/concepts/logging.md): Configure debug logging to inspect API requests and responses.
- [Nested clients](https://docs.apify.com/api/client/python/docs/concepts/nested-clients.md): Access related resources directly through nested client methods.
- [Pagination](https://docs.apify.com/api/client/python/docs/concepts/pagination.md): Paginate through large result sets using page models or generator-based iteration.
- [Retries](https://docs.apify.com/api/client/python/docs/concepts/retries.md): Configure automatic retries with exponential backoff for failed requests.
- [Single and collection clients](https://docs.apify.com/api/client/python/docs/concepts/single-and-collection-clients.md): Understand the two types of resource clients, single-resource and collection clients.
- [Streaming resources](https://docs.apify.com/api/client/python/docs/concepts/streaming-resources.md): Stream large datasets, key-value store records, and logs in both directions without loading them into memory.
- [Timeouts](https://docs.apify.com/api/client/python/docs/concepts/timeouts.md): Configure the tiered timeout system for controlling how long API requests can take.
- [Typed models](https://docs.apify.com/api/client/python/docs/concepts/typed-models.md): Resource client methods return Pydantic models generated from the Apify OpenAPI spec, with IDE autocomplete, runtime validation, and forward-compatible field access.
- [Build a custom HTTP client](https://docs.apify.com/api/client/python/docs/guides/custom-http-client.md): Implement the HTTP client contract with aiohttp and requests.
- [Integrate with data libraries](https://docs.apify.com/api/client/python/docs/guides/integration-with-data-libraries.md): Load Apify dataset items into Pandas DataFrames for analysis.
- [Manage tasks for reusable input](https://docs.apify.com/api/client/python/docs/guides/manage-tasks-for-reusable-input.md): Create and manage tasks with reusable input configurations.
- [Pass input to an Actor](https://docs.apify.com/api/client/python/docs/guides/passing-input-to-actor.md): Run an Actor with custom input data and retrieve results.
- [Retrieve Actor data](https://docs.apify.com/api/client/python/docs/guides/retrieve-actor-data.md): Fetch, paginate, and merge datasets from Actor runs.
- [Quick start](https://docs.apify.com/api/client/python/docs/introduction/quick-start.md): Get started with the Apify API client for Python by running an Actor and retrieving results from its dataset.
- [Upgrading to v2](https://docs.apify.com/api/client/python/docs/upgrading/upgrading-to-v2.md): Breaking changes and migration guide from v1 to v2.
- [Upgrading to v3](https://docs.apify.com/api/client/python/docs/upgrading/upgrading-to-v3.md): Breaking changes and migration guide from v2 to v3.
- [apify-client](https://docs.apify.com/api/client/python/reference.md)
- [_ContextInjectingFilter](https://docs.apify.com/api/client/python/reference/class/_ContextInjectingFilter.md): Filter that injects current log context into all log records.
- [AccountLimits](https://docs.apify.com/api/client/python/reference/class/AccountLimits.md)
- [AccountLimitsResponse](https://docs.apify.com/api/client/python/reference/class/AccountLimitsResponse.md)
- [ActorChargeEvent](https://docs.apify.com/api/client/python/reference/class/ActorChargeEvent.md): Definition of a single chargeable event for a pay-per-event Actor. Each event is either flat-priced
- [ActorClient](https://docs.apify.com/api/client/python/reference/class/ActorClient.md): Sub-client for managing a specific Actor.
- [ActorClientAsync](https://docs.apify.com/api/client/python/reference/class/ActorClientAsync.md): Sub-client for managing a specific Actor.
- [ActorCollectionClient](https://docs.apify.com/api/client/python/reference/class/ActorCollectionClient.md): Sub-client for the Actor collection.
- [ActorCollectionClientAsync](https://docs.apify.com/api/client/python/reference/class/ActorCollectionClientAsync.md): Sub-client for the Actor collection.
- [ActorDefinition](https://docs.apify.com/api/client/python/reference/class/ActorDefinition.md): The definition of the Actor, the full specification of this field can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/actor-json).
- [ActorEnvVarClient](https://docs.apify.com/api/client/python/reference/class/ActorEnvVarClient.md): Sub-client for managing a specific Actor environment variable.
- [ActorEnvVarClientAsync](https://docs.apify.com/api/client/python/reference/class/ActorEnvVarClientAsync.md): Sub-client for managing a specific Actor environment variable.
- [ActorEnvVarCollectionClient](https://docs.apify.com/api/client/python/reference/class/ActorEnvVarCollectionClient.md): Sub-client for the Actor environment variable collection.
- [ActorEnvVarCollectionClientAsync](https://docs.apify.com/api/client/python/reference/class/ActorEnvVarCollectionClientAsync.md): Sub-client for the Actor environment variable collection.
- [ActorListItem](https://docs.apify.com/api/client/python/reference/class/ActorListItem.md)
- [ActorResource](https://docs.apify.com/api/client/python/reference/class/ActorResource.md)
- [ActorResponse](https://docs.apify.com/api/client/python/reference/class/ActorResponse.md): Response containing Actor data.
- [ActorStandby](https://docs.apify.com/api/client/python/reference/class/ActorStandby.md)
- [ActorStats](https://docs.apify.com/api/client/python/reference/class/ActorStats.md): Usage statistics and Apify Store metrics for the Actor.
- [ActorVersionClient](https://docs.apify.com/api/client/python/reference/class/ActorVersionClient.md): Sub-client for managing a specific Actor version.
- [ActorVersionClientAsync](https://docs.apify.com/api/client/python/reference/class/ActorVersionClientAsync.md): Sub-client for managing a specific Actor version.
- [ActorVersionCollectionClient](https://docs.apify.com/api/client/python/reference/class/ActorVersionCollectionClient.md): Sub-client for the Actor version collection.
- [ActorVersionCollectionClientAsync](https://docs.apify.com/api/client/python/reference/class/ActorVersionCollectionClientAsync.md): Sub-client for the Actor version collection.
- [ActVersion](https://docs.apify.com/api/client/python/reference/class/ActVersion.md): Snapshot of the Actor version that this build was created from.
- [AddedRequest](https://docs.apify.com/api/client/python/reference/class/AddedRequest.md): Information about a request that was successfully added to a request queue.
- [AddRequestResponse](https://docs.apify.com/api/client/python/reference/class/AddRequestResponse.md): Response containing the result of adding a request to the request queue.
- [ApifyApiError](https://docs.apify.com/api/client/python/reference/class/ApifyApiError.md): Error raised when the Apify API returns an error response.
- [ApifyClient](https://docs.apify.com/api/client/python/reference/class/ApifyClient.md): Synchronous client for the Apify API.
- [ApifyClientAsync](https://docs.apify.com/api/client/python/reference/class/ApifyClientAsync.md): Asynchronous client for the Apify API.
- [ApifyClientError](https://docs.apify.com/api/client/python/reference/class/ApifyClientError.md): Base class for all Apify API client errors.
- [BatchAddResponse](https://docs.apify.com/api/client/python/reference/class/BatchAddResponse.md): Response containing the result of a batch add operation.
- [BatchAddResult](https://docs.apify.com/api/client/python/reference/class/BatchAddResult.md): Result of a batch add operation containing successfully processed and failed requests.
- [BatchDeleteResponse](https://docs.apify.com/api/client/python/reference/class/BatchDeleteResponse.md): Response containing the result of a batch delete operation.
- [BatchDeleteResult](https://docs.apify.com/api/client/python/reference/class/BatchDeleteResult.md): Result of a batch delete operation containing successfully deleted and failed requests.
- [BrotliHttpCompressor](https://docs.apify.com/api/client/python/reference/class/BrotliHttpCompressor.md): Compresses request bodies using brotli.
- [BrowserInfoResponse](https://docs.apify.com/api/client/python/reference/class/BrowserInfoResponse.md)
- [Build](https://docs.apify.com/api/client/python/reference/class/Build.md)
- [BuildClient](https://docs.apify.com/api/client/python/reference/class/BuildClient.md): Sub-client for managing a specific Actor build.
- [BuildClientAsync](https://docs.apify.com/api/client/python/reference/class/BuildClientAsync.md): Sub-client for managing a specific Actor build.
- [BuildCollectionClient](https://docs.apify.com/api/client/python/reference/class/BuildCollectionClient.md): Sub-client for the Actor build collection.
- [BuildCollectionClientAsync](https://docs.apify.com/api/client/python/reference/class/BuildCollectionClientAsync.md): Sub-client for the Actor build collection.
- [BuildListItem](https://docs.apify.com/api/client/python/reference/class/BuildListItem.md)
- [BuildMeta](https://docs.apify.com/api/client/python/reference/class/BuildMeta.md)
- [BuildOptions](https://docs.apify.com/api/client/python/reference/class/BuildOptions.md)
- [BuildResponse](https://docs.apify.com/api/client/python/reference/class/BuildResponse.md): Response containing Actor build data.
- [BuildStats](https://docs.apify.com/api/client/python/reference/class/BuildStats.md)
- [BuildUsage](https://docs.apify.com/api/client/python/reference/class/BuildUsage.md)
- [Call](https://docs.apify.com/api/client/python/reference/class/Call.md)
- [ChargeRunRequest](https://docs.apify.com/api/client/python/reference/class/ChargeRunRequest.md)
- [ClientRegistry](https://docs.apify.com/api/client/python/reference/class/ClientRegistry.md): Bundle of all sync client classes for dependency injection.
- [ClientRegistryAsync](https://docs.apify.com/api/client/python/reference/class/ClientRegistryAsync.md): Bundle of all async client classes for dependency injection.
- [ClientStatistics](https://docs.apify.com/api/client/python/reference/class/ClientStatistics.md): Statistics about API client usage and rate limit errors.
- [CommonActorPricingInfo](https://docs.apify.com/api/client/python/reference/class/CommonActorPricingInfo.md)
- [ConflictError](https://docs.apify.com/api/client/python/reference/class/ConflictError.md): Raised when the Apify API returns an HTTP 409 Conflict response.
- [CreateActorRequest](https://docs.apify.com/api/client/python/reference/class/CreateActorRequest.md)
- [CreateOrUpdateScheduleRequest](https://docs.apify.com/api/client/python/reference/class/CreateOrUpdateScheduleRequest.md)
- [CreateOrUpdateVersionRequest](https://docs.apify.com/api/client/python/reference/class/CreateOrUpdateVersionRequest.md)
- [CreateTaskRequest](https://docs.apify.com/api/client/python/reference/class/CreateTaskRequest.md)
- [CreateWebhookRequest](https://docs.apify.com/api/client/python/reference/class/CreateWebhookRequest.md)
- [CreateWebhookRequestCamelDict](https://docs.apify.com/api/client/python/reference/class/CreateWebhookRequestCamelDict.md)
- [CreateWebhookRequestDict](https://docs.apify.com/api/client/python/reference/class/CreateWebhookRequestDict.md)
- [CurrentPricingInfo](https://docs.apify.com/api/client/python/reference/class/CurrentPricingInfo.md)
- [CurrentUsage](https://docs.apify.com/api/client/python/reference/class/CurrentUsage.md)
- [DailyServiceUsage](https://docs.apify.com/api/client/python/reference/class/DailyServiceUsage.md)
- [DatasetClient](https://docs.apify.com/api/client/python/reference/class/DatasetClient.md): Sub-client for managing a specific dataset.
- [DatasetClientAsync](https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync.md): Sub-client for managing a specific dataset.
- [DatasetCollectionClient](https://docs.apify.com/api/client/python/reference/class/DatasetCollectionClient.md): Sub-client for the dataset collection.
- [DatasetCollectionClientAsync](https://docs.apify.com/api/client/python/reference/class/DatasetCollectionClientAsync.md): Sub-client for the dataset collection.
- [DatasetFieldStatistics](https://docs.apify.com/api/client/python/reference/class/DatasetFieldStatistics.md)
- [DatasetItemsPage](https://docs.apify.com/api/client/python/reference/class/DatasetItemsPage.md): A page of dataset items returned by the `list_items` method.
- [DatasetItemValidationError](https://docs.apify.com/api/client/python/reference/class/DatasetItemValidationError.md)
- [DatasetListItem](https://docs.apify.com/api/client/python/reference/class/DatasetListItem.md)
- [DatasetResource](https://docs.apify.com/api/client/python/reference/class/DatasetResource.md)
- [DatasetResponse](https://docs.apify.com/api/client/python/reference/class/DatasetResponse.md): Response containing dataset metadata.
- [Datasets](https://docs.apify.com/api/client/python/reference/class/Datasets.md): Aliased dataset IDs for this run.
- [DatasetSchemaValidationError](https://docs.apify.com/api/client/python/reference/class/DatasetSchemaValidationError.md)
- [DatasetSchemaValidationErrorData](https://docs.apify.com/api/client/python/reference/class/DatasetSchemaValidationErrorData.md)
- [DatasetStatistics](https://docs.apify.com/api/client/python/reference/class/DatasetStatistics.md)
- [DatasetStatisticsResponse](https://docs.apify.com/api/client/python/reference/class/DatasetStatisticsResponse.md)
- [DatasetStats](https://docs.apify.com/api/client/python/reference/class/DatasetStats.md)
- [DecodeAndVerifyRequest](https://docs.apify.com/api/client/python/reference/class/DecodeAndVerifyRequest.md)
- [DecodeAndVerifyResponse](https://docs.apify.com/api/client/python/reference/class/DecodeAndVerifyResponse.md)
- [DecodeAndVerifyResult](https://docs.apify.com/api/client/python/reference/class/DecodeAndVerifyResult.md)
- [DefaultRunOptions](https://docs.apify.com/api/client/python/reference/class/DefaultRunOptions.md): The default settings applied to an Actor run. Can be overridden elsewhere.
- [DeletedRequestById](https://docs.apify.com/api/client/python/reference/class/DeletedRequestById.md): Confirmation of a request that was successfully deleted, identified by its ID.
- [DeletedRequestByUniqueKey](https://docs.apify.com/api/client/python/reference/class/DeletedRequestByUniqueKey.md): Confirmation of a request that was successfully deleted, identified by its unique key.
- [EffectivePlatformFeature](https://docs.apify.com/api/client/python/reference/class/EffectivePlatformFeature.md)
- [EffectivePlatformFeatures](https://docs.apify.com/api/client/python/reference/class/EffectivePlatformFeatures.md)
- [EncodeAndSignResponse](https://docs.apify.com/api/client/python/reference/class/EncodeAndSignResponse.md)
- [EncodeAndSignResult](https://docs.apify.com/api/client/python/reference/class/EncodeAndSignResult.md)
- [EnvVar](https://docs.apify.com/api/client/python/reference/class/EnvVar.md)
- [EnvVarRequest](https://docs.apify.com/api/client/python/reference/class/EnvVarRequest.md)
- [EnvVarResponse](https://docs.apify.com/api/client/python/reference/class/EnvVarResponse.md)
- [ErrorDetail](https://docs.apify.com/api/client/python/reference/class/ErrorDetail.md)
- [ErrorResponse](https://docs.apify.com/api/client/python/reference/class/ErrorResponse.md)
- [EventData](https://docs.apify.com/api/client/python/reference/class/EventData.md)
- [ExampleRunInput](https://docs.apify.com/api/client/python/reference/class/ExampleRunInput.md)
- [FailedImport](https://docs.apify.com/api/client/python/reference/class/FailedImport.md): Represent a placeholder for a failed import.
- [FlatPricePerMonthActorPricingInfo](https://docs.apify.com/api/client/python/reference/class/FlatPricePerMonthActorPricingInfo.md)
- [ForbiddenError](https://docs.apify.com/api/client/python/reference/class/ForbiddenError.md): Raised when the Apify API returns an HTTP 403 Forbidden response.
- [FreeActorPricingInfo](https://docs.apify.com/api/client/python/reference/class/FreeActorPricingInfo.md)
- [GzipHttpCompressor](https://docs.apify.com/api/client/python/reference/class/GzipHttpCompressor.md): Compresses request bodies using gzip.
- [HasItems](https://docs.apify.com/api/client/python/reference/class/HasItems.md): Structural contract for a single page of results from a paginated API endpoint.
- [HttpClient](https://docs.apify.com/api/client/python/reference/class/HttpClient.md): Base class for synchronous HTTP clients used by `ApifyClient`.
- [HttpClientAsync](https://docs.apify.com/api/client/python/reference/class/HttpClientAsync.md): Base class for asynchronous HTTP clients used by `ApifyClientAsync`.
- [HttpClientBase](https://docs.apify.com/api/client/python/reference/class/HttpClientBase.md): Shared configuration and utilities for HTTP clients.
- [HttpCompressor](https://docs.apify.com/api/client/python/reference/class/HttpCompressor.md): Strategy for compressing HTTP request bodies.
- [HttpResponse](https://docs.apify.com/api/client/python/reference/class/HttpResponse.md): Protocol for HTTP response objects returned by HTTP clients.
- [Httpx2HttpClient](https://docs.apify.com/api/client/python/reference/class/Httpx2HttpClient.md): Synchronous HTTP client for the Apify API built on top of [HTTPX2](https://github.com/pydantic/httpx2).
- [Httpx2HttpClientAsync](https://docs.apify.com/api/client/python/reference/class/Httpx2HttpClientAsync.md): Asynchronous HTTP client for the Apify API built on top of [HTTPX2](https://github.com/pydantic/httpx2).
- [ImpitHttpClient](https://docs.apify.com/api/client/python/reference/class/ImpitHttpClient.md): Synchronous HTTP client for the Apify API built on top of [Impit](https://github.com/apify/impit).
- [ImpitHttpClientAsync](https://docs.apify.com/api/client/python/reference/class/ImpitHttpClientAsync.md): Asynchronous HTTP client for the Apify API built on top of [Impit](https://github.com/apify/impit).
- [ImportState](https://docs.apify.com/api/client/python/reference/class/ImportState.md): Describe whether an optional import succeeded.
- [ImportWrapper](https://docs.apify.com/api/client/python/reference/class/ImportWrapper.md): A wrapper class for modules to handle attribute access for failed imports.
- [InvalidDatasetItem](https://docs.apify.com/api/client/python/reference/class/InvalidDatasetItem.md)
- [InvalidRequestError](https://docs.apify.com/api/client/python/reference/class/InvalidRequestError.md): Raised when the Apify API returns an HTTP 400 Bad Request response.
- [InvalidResponseBodyError](https://docs.apify.com/api/client/python/reference/class/InvalidResponseBodyError.md): Error raised when a response body cannot be parsed.
- [KeyValueStoreClient](https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClient.md): Sub-client for managing a specific key-value store.
- [KeyValueStoreClientAsync](https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync.md): Sub-client for managing a specific key-value store.
- [KeyValueStoreCollectionClient](https://docs.apify.com/api/client/python/reference/class/KeyValueStoreCollectionClient.md): Sub-client for the key-value store collection.
- [KeyValueStoreCollectionClientAsync](https://docs.apify.com/api/client/python/reference/class/KeyValueStoreCollectionClientAsync.md): Sub-client for the key-value store collection.
- [KeyValueStoreKey](https://docs.apify.com/api/client/python/reference/class/KeyValueStoreKey.md)
- [KeyValueStoreResource](https://docs.apify.com/api/client/python/reference/class/KeyValueStoreResource.md)
- [KeyValueStoreResponse](https://docs.apify.com/api/client/python/reference/class/KeyValueStoreResponse.md): Response containing key-value store data.
- [KeyValueStores](https://docs.apify.com/api/client/python/reference/class/KeyValueStores.md): Aliased key-value store IDs for this run.
- [KeyValueStoreStats](https://docs.apify.com/api/client/python/reference/class/KeyValueStoreStats.md)
- [Limits](https://docs.apify.com/api/client/python/reference/class/Limits.md)
- [ListOfActors](https://docs.apify.com/api/client/python/reference/class/ListOfActors.md)
- [ListOfActorsResponse](https://docs.apify.com/api/client/python/reference/class/ListOfActorsResponse.md)
- [ListOfBuilds](https://docs.apify.com/api/client/python/reference/class/ListOfBuilds.md)
- [ListOfBuildsResponse](https://docs.apify.com/api/client/python/reference/class/ListOfBuildsResponse.md)
- [ListOfDatasets](https://docs.apify.com/api/client/python/reference/class/ListOfDatasets.md)
- [ListOfDatasetsResponse](https://docs.apify.com/api/client/python/reference/class/ListOfDatasetsResponse.md)
- [ListOfEnvVars](https://docs.apify.com/api/client/python/reference/class/ListOfEnvVars.md)
- [ListOfEnvVarsResponse](https://docs.apify.com/api/client/python/reference/class/ListOfEnvVarsResponse.md)
- [ListOfKeys](https://docs.apify.com/api/client/python/reference/class/ListOfKeys.md)
- [ListOfKeysResponse](https://docs.apify.com/api/client/python/reference/class/ListOfKeysResponse.md)
- [ListOfKeyValueStores](https://docs.apify.com/api/client/python/reference/class/ListOfKeyValueStores.md)
- [ListOfKeyValueStoresResponse](https://docs.apify.com/api/client/python/reference/class/ListOfKeyValueStoresResponse.md)
- [ListOfRequestQueues](https://docs.apify.com/api/client/python/reference/class/ListOfRequestQueues.md): A paginated list of request queues.
- [ListOfRequestQueuesResponse](https://docs.apify.com/api/client/python/reference/class/ListOfRequestQueuesResponse.md): Response containing a list of request queues.
- [ListOfRequests](https://docs.apify.com/api/client/python/reference/class/ListOfRequests.md): A paginated list of requests from the request queue.
- [ListOfRequestsResponse](https://docs.apify.com/api/client/python/reference/class/ListOfRequestsResponse.md): Response containing a list of requests from the request queue.
- [ListOfRuns](https://docs.apify.com/api/client/python/reference/class/ListOfRuns.md)
- [ListOfRunsResponse](https://docs.apify.com/api/client/python/reference/class/ListOfRunsResponse.md)
- [ListOfSchedules](https://docs.apify.com/api/client/python/reference/class/ListOfSchedules.md)
- [ListOfSchedulesResponse](https://docs.apify.com/api/client/python/reference/class/ListOfSchedulesResponse.md)
- [ListOfStoreActors](https://docs.apify.com/api/client/python/reference/class/ListOfStoreActors.md)
- [ListOfStoreActorsResponse](https://docs.apify.com/api/client/python/reference/class/ListOfStoreActorsResponse.md)
- [ListOfTasks](https://docs.apify.com/api/client/python/reference/class/ListOfTasks.md)
- [ListOfTasksResponse](https://docs.apify.com/api/client/python/reference/class/ListOfTasksResponse.md)
- [ListOfVersions](https://docs.apify.com/api/client/python/reference/class/ListOfVersions.md)
- [ListOfVersionsResponse](https://docs.apify.com/api/client/python/reference/class/ListOfVersionsResponse.md)
- [ListOfWebhookDispatches](https://docs.apify.com/api/client/python/reference/class/ListOfWebhookDispatches.md)
- [ListOfWebhookDispatchesResponse](https://docs.apify.com/api/client/python/reference/class/ListOfWebhookDispatchesResponse.md)
- [ListOfWebhooks](https://docs.apify.com/api/client/python/reference/class/ListOfWebhooks.md)
- [ListOfWebhooksResponse](https://docs.apify.com/api/client/python/reference/class/ListOfWebhooksResponse.md)
- [LockedRequestQueueHead](https://docs.apify.com/api/client/python/reference/class/LockedRequestQueueHead.md): A batch of locked requests from the request queue head.
- [LockedRequestQueueHeadItem](https://docs.apify.com/api/client/python/reference/class/LockedRequestQueueHeadItem.md): A request from the request queue head that has been locked for processing.
- [LockedRequestQueueHeadResponse](https://docs.apify.com/api/client/python/reference/class/LockedRequestQueueHeadResponse.md): Response containing locked requests from the request queue head.
- [LogClient](https://docs.apify.com/api/client/python/reference/class/LogClient.md): Sub-client for managing a specific log.
- [LogClientAsync](https://docs.apify.com/api/client/python/reference/class/LogClientAsync.md): Sub-client for managing a specific log.
- [LogContext](https://docs.apify.com/api/client/python/reference/class/LogContext.md): Request context details for logging (attempt, client method, HTTP method, resource ID, URL).
- [LoggerOnce](https://docs.apify.com/api/client/python/reference/class/LoggerOnce.md): Emits each log message at most once, keyed by an explicit string.
- [MonthlyUsage](https://docs.apify.com/api/client/python/reference/class/MonthlyUsage.md)
- [MonthlyUsageResponse](https://docs.apify.com/api/client/python/reference/class/MonthlyUsageResponse.md)
- [NotFoundError](https://docs.apify.com/api/client/python/reference/class/NotFoundError.md): Raised when the Apify API returns an HTTP 404 Not Found response.
- [Notifications](https://docs.apify.com/api/client/python/reference/class/Notifications.md): Notification settings for this schedule.
- [PaginationResponse](https://docs.apify.com/api/client/python/reference/class/PaginationResponse.md): Common pagination fields for list responses.
- [PayPerEventActorPricingInfo](https://docs.apify.com/api/client/python/reference/class/PayPerEventActorPricingInfo.md)
- [PricePerDatasetItemActorPricingInfo](https://docs.apify.com/api/client/python/reference/class/PricePerDatasetItemActorPricingInfo.md)
- [PriceTier](https://docs.apify.com/api/client/python/reference/class/PriceTier.md)
- [PricingPerEvent](https://docs.apify.com/api/client/python/reference/class/PricingPerEvent.md)
- [ProlongRequestLockResponse](https://docs.apify.com/api/client/python/reference/class/ProlongRequestLockResponse.md): Response containing updated lock information after prolonging a request lock.
- [ProxyGroup](https://docs.apify.com/api/client/python/reference/class/ProxyGroup.md)
- [ProxyResource](https://docs.apify.com/api/client/python/reference/class/ProxyResource.md)
- [PublicActorRunStats30Days](https://docs.apify.com/api/client/python/reference/class/PublicActorRunStats30Days.md): Run status counts from the last 30 days. Only for public Actors.
- [PutItemsErrorResponse](https://docs.apify.com/api/client/python/reference/class/PutItemsErrorResponse.md)
- [PutItemsRequest](https://docs.apify.com/api/client/python/reference/class/PutItemsRequest.md): The request body containing the item(s) to add to the dataset. Can be a single
- [PutRecordRequest](https://docs.apify.com/api/client/python/reference/class/PutRecordRequest.md): The request body contains the value to store in the record. The content type
- [RateLimitError](https://docs.apify.com/api/client/python/reference/class/RateLimitError.md): Raised when the Apify API returns an HTTP 429 Too Many Requests response.
- [RecordResponse](https://docs.apify.com/api/client/python/reference/class/RecordResponse.md): The response body contains the value of the record. The content type of the response
- [RedirectLogFormatter](https://docs.apify.com/api/client/python/reference/class/RedirectLogFormatter.md): Log formatter that prepends colored logger name to messages.
- [RequestBase](https://docs.apify.com/api/client/python/reference/class/RequestBase.md)
- [RequestBaseCamelDict](https://docs.apify.com/api/client/python/reference/class/RequestBaseCamelDict.md)
- [RequestBaseDict](https://docs.apify.com/api/client/python/reference/class/RequestBaseDict.md)
- [RequestLockInfo](https://docs.apify.com/api/client/python/reference/class/RequestLockInfo.md): Information about a request lock.
- [RequestQueueClient](https://docs.apify.com/api/client/python/reference/class/RequestQueueClient.md): Sub-client for managing a specific request queue.
- [RequestQueueClientAsync](https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync.md): Sub-client for managing a specific request queue.
- [RequestQueueCollectionClient](https://docs.apify.com/api/client/python/reference/class/RequestQueueCollectionClient.md): Sub-client for the request queue collection.
- [RequestQueueCollectionClientAsync](https://docs.apify.com/api/client/python/reference/class/RequestQueueCollectionClientAsync.md): Sub-client for the request queue collection.
- [RequestQueueHead](https://docs.apify.com/api/client/python/reference/class/RequestQueueHead.md): A batch of requests from the request queue head without locking.
- [RequestQueueHeadItem](https://docs.apify.com/api/client/python/reference/class/RequestQueueHeadItem.md): A request from the request queue head without lock information.
- [RequestQueueHeadResponse](https://docs.apify.com/api/client/python/reference/class/RequestQueueHeadResponse.md): Response containing requests from the request queue head without locking.
- [RequestQueueListItem](https://docs.apify.com/api/client/python/reference/class/RequestQueueListItem.md): A shortened request queue object for list responses.
- [RequestQueueResource](https://docs.apify.com/api/client/python/reference/class/RequestQueueResource.md): A request queue object containing metadata and statistics.
- [RequestQueueResponse](https://docs.apify.com/api/client/python/reference/class/RequestQueueResponse.md): Response containing request queue data.
- [RequestQueues](https://docs.apify.com/api/client/python/reference/class/RequestQueues.md): Aliased request queue IDs for this run.
- [RequestQueueStats](https://docs.apify.com/api/client/python/reference/class/RequestQueueStats.md): Statistics about request queue operations and storage.
- [RequestRegistration](https://docs.apify.com/api/client/python/reference/class/RequestRegistration.md): Result of registering a request in the request queue, either by adding a new request or updating an existing one.
- [RequestResource](https://docs.apify.com/api/client/python/reference/class/RequestResource.md): A request stored in the request queue, including its metadata and processing state.
- [RequestResourceCamelDict](https://docs.apify.com/api/client/python/reference/class/RequestResourceCamelDict.md): A request stored in the request queue, including its metadata and processing state.
- [RequestResourceDict](https://docs.apify.com/api/client/python/reference/class/RequestResourceDict.md): A request stored in the request queue, including its metadata and processing state.
- [RequestResponse](https://docs.apify.com/api/client/python/reference/class/RequestResponse.md): Response containing a single request from the request queue.
- [RequestToDelete](https://docs.apify.com/api/client/python/reference/class/RequestToDelete.md)
- [RequestToDeleteById](https://docs.apify.com/api/client/python/reference/class/RequestToDeleteById.md): A request that should be deleted, identified by its ID.
- [RequestToDeleteByIdCamelDict](https://docs.apify.com/api/client/python/reference/class/RequestToDeleteByIdCamelDict.md): A request that should be deleted, identified by its ID.
- [RequestToDeleteByIdDict](https://docs.apify.com/api/client/python/reference/class/RequestToDeleteByIdDict.md): A request that should be deleted, identified by its ID.
- [RequestToDeleteByUniqueKey](https://docs.apify.com/api/client/python/reference/class/RequestToDeleteByUniqueKey.md): A request that should be deleted, identified by its unique key.
- [RequestToDeleteByUniqueKeyCamelDict](https://docs.apify.com/api/client/python/reference/class/RequestToDeleteByUniqueKeyCamelDict.md): A request that should be deleted, identified by its unique key.
- [RequestToDeleteByUniqueKeyDict](https://docs.apify.com/api/client/python/reference/class/RequestToDeleteByUniqueKeyDict.md): A request that should be deleted, identified by its unique key.
- [RequestUserData](https://docs.apify.com/api/client/python/reference/class/RequestUserData.md): Custom user data attached to the request. Can contain arbitrary fields.
- [RequestWithoutId](https://docs.apify.com/api/client/python/reference/class/RequestWithoutId.md): A request stored in the request queue, including its metadata and processing state, without the assigned ID.
- [RequestWithoutIdCamelDict](https://docs.apify.com/api/client/python/reference/class/RequestWithoutIdCamelDict.md): A request stored in the request queue, including its metadata and processing state, without the assigned ID.
- [RequestWithoutIdDict](https://docs.apify.com/api/client/python/reference/class/RequestWithoutIdDict.md): A request stored in the request queue, including its metadata and processing state, without the assigned ID.
- [ResourceClient](https://docs.apify.com/api/client/python/reference/class/ResourceClient.md): Base class for synchronous resource clients.
- [ResourceClientAsync](https://docs.apify.com/api/client/python/reference/class/ResourceClientAsync.md): Base class for asynchronous resource clients.
- [ResourceClientBase](https://docs.apify.com/api/client/python/reference/class/ResourceClientBase.md): Base class with shared implementation for sync and async resource clients.
- [Run](https://docs.apify.com/api/client/python/reference/class/Run.md): Represents an Actor run and its associated data.
- [RunClient](https://docs.apify.com/api/client/python/reference/class/RunClient.md): Sub-client for managing a specific Actor run.
- [RunClientAsync](https://docs.apify.com/api/client/python/reference/class/RunClientAsync.md): Sub-client for managing a specific Actor run.
- [RunCollectionClient](https://docs.apify.com/api/client/python/reference/class/RunCollectionClient.md): Sub-client for the Actor run collection.
- [RunCollectionClientAsync](https://docs.apify.com/api/client/python/reference/class/RunCollectionClientAsync.md): Sub-client for the Actor run collection.
- [RunListItem](https://docs.apify.com/api/client/python/reference/class/RunListItem.md)
- [RunMeta](https://docs.apify.com/api/client/python/reference/class/RunMeta.md)
- [RunMetamorphEvent](https://docs.apify.com/api/client/python/reference/class/RunMetamorphEvent.md): Information about a metamorph event that occurred during the run.
- [RunOptions](https://docs.apify.com/api/client/python/reference/class/RunOptions.md)
- [RunResponse](https://docs.apify.com/api/client/python/reference/class/RunResponse.md)
- [RunStats](https://docs.apify.com/api/client/python/reference/class/RunStats.md)
- [RunUsage](https://docs.apify.com/api/client/python/reference/class/RunUsage.md)
- [RunUsageUsd](https://docs.apify.com/api/client/python/reference/class/RunUsageUsd.md): Resource usage costs in USD. All values are monetary amounts in US dollars.
- [Schedule](https://docs.apify.com/api/client/python/reference/class/Schedule.md)
- [ScheduleActionRunActor](https://docs.apify.com/api/client/python/reference/class/ScheduleActionRunActor.md)
- [ScheduleActionRunActorTask](https://docs.apify.com/api/client/python/reference/class/ScheduleActionRunActorTask.md)
- [ScheduleActionRunInput](https://docs.apify.com/api/client/python/reference/class/ScheduleActionRunInput.md)
- [ScheduleBase](https://docs.apify.com/api/client/python/reference/class/ScheduleBase.md)
- [ScheduleClient](https://docs.apify.com/api/client/python/reference/class/ScheduleClient.md): Sub-client for managing a specific schedule.
- [ScheduleClientAsync](https://docs.apify.com/api/client/python/reference/class/ScheduleClientAsync.md): Sub-client for managing a specific schedule.
- [ScheduleCollectionClient](https://docs.apify.com/api/client/python/reference/class/ScheduleCollectionClient.md): Sub-client for the schedule collection.
- [ScheduleCollectionClientAsync](https://docs.apify.com/api/client/python/reference/class/ScheduleCollectionClientAsync.md): Sub-client for the schedule collection.
- [ScheduleCreateActionRunActor](https://docs.apify.com/api/client/python/reference/class/ScheduleCreateActionRunActor.md)
- [ScheduleCreateActionRunActorTask](https://docs.apify.com/api/client/python/reference/class/ScheduleCreateActionRunActorTask.md)
- [ScheduleListItem](https://docs.apify.com/api/client/python/reference/class/ScheduleListItem.md)
- [ScheduleListItemActionRunActor](https://docs.apify.com/api/client/python/reference/class/ScheduleListItemActionRunActor.md)
- [ScheduleListItemActionRunActorTask](https://docs.apify.com/api/client/python/reference/class/ScheduleListItemActionRunActorTask.md)
- [ScheduleLogEntry](https://docs.apify.com/api/client/python/reference/class/ScheduleLogEntry.md)
- [ScheduleLogResponse](https://docs.apify.com/api/client/python/reference/class/ScheduleLogResponse.md)
- [ScheduleResponse](https://docs.apify.com/api/client/python/reference/class/ScheduleResponse.md)
- [ServerError](https://docs.apify.com/api/client/python/reference/class/ServerError.md): Raised when the Apify API returns an HTTP 5xx response.
- [SourceCodeFile](https://docs.apify.com/api/client/python/reference/class/SourceCodeFile.md): Represents a single file in the Actor's source code.
- [SourceCodeFolder](https://docs.apify.com/api/client/python/reference/class/SourceCodeFolder.md): Represents a folder in the Actor's source code structure. Distinguished from
- [StatusMessageWatcher](https://docs.apify.com/api/client/python/reference/class/StatusMessageWatcher.md): Polls and logs Actor run status messages in a background thread.
- [StatusMessageWatcherAsync](https://docs.apify.com/api/client/python/reference/class/StatusMessageWatcherAsync.md): Polls and logs Actor run status messages in an asyncio task.
- [StatusMessageWatcherBase](https://docs.apify.com/api/client/python/reference/class/StatusMessageWatcherBase.md): Base class for polling and logging Actor run status messages.
- [StorageIds](https://docs.apify.com/api/client/python/reference/class/StorageIds.md): A map of aliased storage IDs associated with this run, grouped by storage type.
- [Storages](https://docs.apify.com/api/client/python/reference/class/Storages.md)
- [StoreActor](https://docs.apify.com/api/client/python/reference/class/StoreActor.md)
- [StoreCollectionClient](https://docs.apify.com/api/client/python/reference/class/StoreCollectionClient.md): Sub-client for the Apify store collection.
- [StoreCollectionClientAsync](https://docs.apify.com/api/client/python/reference/class/StoreCollectionClientAsync.md): Sub-client for the Apify store collection.
- [StreamedLog](https://docs.apify.com/api/client/python/reference/class/StreamedLog.md): Streams Actor run log output to a Python logger in a background thread.
- [StreamedLogAsync](https://docs.apify.com/api/client/python/reference/class/StreamedLogAsync.md): Streams Actor run log output to a Python logger in an asyncio task.
- [StreamedLogBase](https://docs.apify.com/api/client/python/reference/class/StreamedLogBase.md): Base class for streaming and buffering chunked Actor run logs.
- [StreamedRequestBody](https://docs.apify.com/api/client/python/reference/class/StreamedRequestBody.md): A request body sent from its source in chunks, so the body is never held in memory whole.
- [SupportsRead](https://docs.apify.com/api/client/python/reference/class/SupportsRead.md): A file-like object that is not an `io.IOBase` stream, read whole with a single `read()` call.
- [TaggedBuildInfo](https://docs.apify.com/api/client/python/reference/class/TaggedBuildInfo.md): Information about a tagged build.
- [Task](https://docs.apify.com/api/client/python/reference/class/Task.md)
- [TaskClient](https://docs.apify.com/api/client/python/reference/class/TaskClient.md): Sub-client for managing a specific task.
- [TaskClientAsync](https://docs.apify.com/api/client/python/reference/class/TaskClientAsync.md): Sub-client for managing a specific task.
- [TaskCollectionClient](https://docs.apify.com/api/client/python/reference/class/TaskCollectionClient.md): Sub-client for the task collection.
- [TaskCollectionClientAsync](https://docs.apify.com/api/client/python/reference/class/TaskCollectionClientAsync.md): Sub-client for the task collection.
- [TaskInput](https://docs.apify.com/api/client/python/reference/class/TaskInput.md): The input configuration for the Actor task. This is a user-defined JSON object
- [TaskListItem](https://docs.apify.com/api/client/python/reference/class/TaskListItem.md)
- [TaskOptions](https://docs.apify.com/api/client/python/reference/class/TaskOptions.md)
- [TaskPublicConfig](https://docs.apify.com/api/client/python/reference/class/TaskPublicConfig.md): Public-facing configuration of a published task, used by the task's public landing page.
- [TaskResponse](https://docs.apify.com/api/client/python/reference/class/TaskResponse.md): Response containing Actor task data.
- [TaskStats](https://docs.apify.com/api/client/python/reference/class/TaskStats.md)
- [TieredPricingPerDatasetItemEntry](https://docs.apify.com/api/client/python/reference/class/TieredPricingPerDatasetItemEntry.md): A single tier's price-per-dataset-item entry.
- [TieredPricingPerEventEntry](https://docs.apify.com/api/client/python/reference/class/TieredPricingPerEventEntry.md): A single tier's price-per-event entry.
- [UnauthorizedError](https://docs.apify.com/api/client/python/reference/class/UnauthorizedError.md): Raised when the Apify API returns an HTTP 401 Unauthorized response.
- [UnlockRequestsResponse](https://docs.apify.com/api/client/python/reference/class/UnlockRequestsResponse.md): Response containing the result of unlocking requests.
- [UnlockRequestsResult](https://docs.apify.com/api/client/python/reference/class/UnlockRequestsResult.md): Result of unlocking requests in the request queue.
- [UnprocessedRequest](https://docs.apify.com/api/client/python/reference/class/UnprocessedRequest.md): A request that failed to be processed during a request queue operation and can be retried.
- [UpdateActorRequest](https://docs.apify.com/api/client/python/reference/class/UpdateActorRequest.md)
- [UpdateDatasetRequest](https://docs.apify.com/api/client/python/reference/class/UpdateDatasetRequest.md)
- [UpdatedBuildProperty](https://docs.apify.com/api/client/python/reference/class/UpdatedBuildProperty.md): The name of the build tag.
- [UpdateKeyValueStoreRequest](https://docs.apify.com/api/client/python/reference/class/UpdateKeyValueStoreRequest.md)
- [UpdateLimitsRequest](https://docs.apify.com/api/client/python/reference/class/UpdateLimitsRequest.md)
- [UpdateRequestQueueRequest](https://docs.apify.com/api/client/python/reference/class/UpdateRequestQueueRequest.md): Request object for updating a request queue.
- [UpdateRequestResponse](https://docs.apify.com/api/client/python/reference/class/UpdateRequestResponse.md): Response containing the result of updating a request in the request queue.
- [UpdateRunRequest](https://docs.apify.com/api/client/python/reference/class/UpdateRunRequest.md)
- [UpdateTaskRequest](https://docs.apify.com/api/client/python/reference/class/UpdateTaskRequest.md)
- [UpdateWebhookRequest](https://docs.apify.com/api/client/python/reference/class/UpdateWebhookRequest.md)
- [UsageCycle](https://docs.apify.com/api/client/python/reference/class/UsageCycle.md)
- [UsageItem](https://docs.apify.com/api/client/python/reference/class/UsageItem.md)
- [UserClient](https://docs.apify.com/api/client/python/reference/class/UserClient.md): Sub-client for managing user account information.
- [UserClientAsync](https://docs.apify.com/api/client/python/reference/class/UserClientAsync.md): Sub-client for managing user account information.
- [UserPlan](https://docs.apify.com/api/client/python/reference/class/UserPlan.md)
- [UserPrivateInfo](https://docs.apify.com/api/client/python/reference/class/UserPrivateInfo.md)
- [UserPrivateInfoResponse](https://docs.apify.com/api/client/python/reference/class/UserPrivateInfoResponse.md)
- [UserProfile](https://docs.apify.com/api/client/python/reference/class/UserProfile.md)
- [UserPublicInfo](https://docs.apify.com/api/client/python/reference/class/UserPublicInfo.md)
- [UserPublicInfoResponse](https://docs.apify.com/api/client/python/reference/class/UserPublicInfoResponse.md)
- [Version](https://docs.apify.com/api/client/python/reference/class/Version.md)
- [VersionResponse](https://docs.apify.com/api/client/python/reference/class/VersionResponse.md)
- [WebhookClient](https://docs.apify.com/api/client/python/reference/class/WebhookClient.md): Sub-client for managing a specific webhook.
- [WebhookClientAsync](https://docs.apify.com/api/client/python/reference/class/WebhookClientAsync.md): Sub-client for managing a specific webhook.
- [WebhookCollectionClient](https://docs.apify.com/api/client/python/reference/class/WebhookCollectionClient.md): Sub-client for the webhook collection.
- [WebhookCollectionClientAsync](https://docs.apify.com/api/client/python/reference/class/WebhookCollectionClientAsync.md): Sub-client for the webhook collection.
- [WebhookCondition](https://docs.apify.com/api/client/python/reference/class/WebhookCondition.md)
- [WebhookConditionCamelDict](https://docs.apify.com/api/client/python/reference/class/WebhookConditionCamelDict.md)
- [WebhookConditionDict](https://docs.apify.com/api/client/python/reference/class/WebhookConditionDict.md)
- [WebhookDispatch](https://docs.apify.com/api/client/python/reference/class/WebhookDispatch.md)
- [WebhookDispatchClient](https://docs.apify.com/api/client/python/reference/class/WebhookDispatchClient.md): Sub-client for managing a specific webhook dispatch.
- [WebhookDispatchClientAsync](https://docs.apify.com/api/client/python/reference/class/WebhookDispatchClientAsync.md): Sub-client for managing a specific webhook dispatch.
- [WebhookDispatchCollectionClient](https://docs.apify.com/api/client/python/reference/class/WebhookDispatchCollectionClient.md): Sub-client for the webhook dispatch collection.
- [WebhookDispatchCollectionClientAsync](https://docs.apify.com/api/client/python/reference/class/WebhookDispatchCollectionClientAsync.md): Sub-client for the webhook dispatch collection.
- [WebhookDispatchResponse](https://docs.apify.com/api/client/python/reference/class/WebhookDispatchResponse.md)
- [WebhookDispatchWebhookSummary](https://docs.apify.com/api/client/python/reference/class/WebhookDispatchWebhookSummary.md): A summary of the webhook that triggered this dispatch.
- [WebhookLastDispatch](https://docs.apify.com/api/client/python/reference/class/WebhookLastDispatch.md)
- [WebhookListItem](https://docs.apify.com/api/client/python/reference/class/WebhookListItem.md)
- [WebhookRepresentation](https://docs.apify.com/api/client/python/reference/class/WebhookRepresentation.md): Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the
- [WebhookRepresentationCamelDict](https://docs.apify.com/api/client/python/reference/class/WebhookRepresentationCamelDict.md): Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the
- [WebhookRepresentationDict](https://docs.apify.com/api/client/python/reference/class/WebhookRepresentationDict.md): Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the
- [WebhookResource](https://docs.apify.com/api/client/python/reference/class/WebhookResource.md)
- [WebhookResponse](https://docs.apify.com/api/client/python/reference/class/WebhookResponse.md): Response containing webhook data.
- [WebhookStats](https://docs.apify.com/api/client/python/reference/class/WebhookStats.md)
- [WithLogDetailsClient](https://docs.apify.com/api/client/python/reference/class/WithLogDetailsClient.md): Metaclass that wraps public methods to inject client details into log context.
- [ActorNotice](https://docs.apify.com/api/client/python/reference/enum/ActorNotice.md): A warning displayed on the Actor's page in Apify Store and Console. Can be set by the Actor's developer or automatically by Apify's quality checks.