# Apify > * **statusMessage ## Pages - [AbortOptions](abortoptions.md): * RunAbortOptions - [AbortingEvent](abortingevent.md): * [**data](https://docs.apify.com/sdk/python/sdk/python/reference/class/AbortingEvent.md#data) - [AccountAndUsageLimits](accountandusagelimits.md): * **current - [Actor](actor.md): Represents an Actor in the Apify platform. - [ActorBuildOptions](actorbuildoptions.md): Options for building an Actor. - [ActorCallOptions](actorcalloptions.md): Options for calling an Actor and waiting for it to finish. - [ActorChargeEvent](actorchargeevent.md): Definition of a chargeable event for pay-per-event Actors. - [ActorClient](actorclient.md): Client for managing a specific Actor. - [ActorClientAsync](actorclientasync.md): Async sub-client for manipulating a single Actor. - [ActorCollectionClient](actorcollectionclient.md): Client for managing the collection of Actors in your account. - [ActorCollectionClientAsync](actorcollectionclientasync.md): Async sub-client for manipulating Actors. - [ActorCollectionCreateOptions](actorcollectioncreateoptions.md): * **actorStandby - [ActorCollectionListItem](actorcollectionlistitem.md): * **createdAt - [ActorCollectionListOptions](actorcollectionlistoptions.md): * PaginationOptions - [ActorDatasetPushPipeline](actordatasetpushpipeline.md): A Scrapy pipeline for pushing items to an Actor's default dataset. - [ActorDefaultRunOptions](actordefaultrunoptions.md): Default configuration options for Actor runs. - [ActorDefinition](actordefinition.md): Actor definition from the`.actor/actor.json`file. - [ActorEnvVarClient](actorenvvarclient.md): Client for managing a specific Actor environment variable. - [ActorEnvVarClientAsync](actorenvvarclientasync.md): Async sub-client for manipulating a single Actor environment variable. - [ActorEnvVarCollectionClient](actorenvvarcollectionclient.md): Client for managing the collection of environment variables for an Actor version. - [ActorEnvVarCollectionClientAsync](actorenvvarcollectionclientasync.md): Async sub-client for manipulating actor env vars. - [ActorEnvVarCollectionListOptions](actorenvvarcollectionlistoptions.md): * **@deprecated** - [ActorEnvironmentVariable](actorenvironmentvariable.md): * **isSecret - [ActorExampleRunInput](actorexampleruninput.md): Example input data to demonstrate Actor usage. - [ActorJobBaseClient](actorjobbaseclient.md): Base sub-client class for Actor runs and Actor builds. - [ActorJobBaseClientAsync](actorjobbaseclientasync.md): Base async sub-client class for Actor runs and Actor builds. - [ActorLastRunOptions](actorlastrunoptions.md): Options for filtering the last run of an Actor. - [ActorListSortBy](actorlistsortby.md): * **CREATED\_AT - [ActorLogFormatter](actorlogformatter.md) - [ActorPricingInfo](actorpricinginfo.md): * **isPayPerEvent - [ActorRun](actorrun.md): Complete Actor run information including statistics and usage details. - [ActorRunListItem](actorrunlistitem.md): Simplified Actor run information used in list results. - [ActorRunMeta](actorrunmeta.md): Metadata about how an Actor run was initiated. - [ActorRunOptions](actorrunoptions.md): Configuration options used for an Actor run. - [ActorRunStats](actorrunstats.md): Runtime statistics for an Actor run. - [ActorRunUsage](actorrunusage.md): Resource usage metrics for an Actor run. - [ActorSourceType](actorsourcetype.md): * **GitHubGist - [ActorStandby](actorstandby.md): Configuration for Actor standby mode. - [ActorStartOptions](actorstartoptions.md): * **build - [ActorStats](actorstats.md): Statistics about Actor usage and activity. - [ActorStoreList](actorstorelist.md): * **currentPricingInfo - [ActorTaggedBuild](actortaggedbuild.md): Information about a specific tagged build. - [ActorVersionClient](actorversionclient.md): Client for managing a specific Actor version. - [ActorVersionClientAsync](actorversionclientasync.md): Async sub-client for manipulating a single Actor version. - [ActorVersionCollectionClient](actorversioncollectionclient.md): Client for managing the collection of Actor versions. - [ActorVersionCollectionClientAsync](actorversioncollectionclientasync.md): Async sub-client for manipulating Actor versions. - [ActorVersionCollectionListOptions](actorversioncollectionlistoptions.md): * **@deprecated** - [ActorVersionGitHubGist](actorversiongithubgist.md): * [BaseActorVersion](https://docs.apify.com/api/client/js/api/client/js/reference/interface/BaseActorVersion.md)\](actorversiongitrepo.md): * [BaseActorVersion](https://docs.apify.com/api/client/js/api/client/js/reference/interface/BaseActorVersion.md)\](actorversionsourcefile.md): * **content - [ActorVersionSourceFiles](actorversionsourcefiles.md): * [BaseActorVersion](https://docs.apify.com/api/client/js/api/client/js/reference/interface/BaseActorVersion.md)\](actorversiontarball.md): * [BaseActorVersion](https://docs.apify.com/api/client/js/api/client/js/reference/interface/BaseActorVersion.md)\](addrequestsresponse.md): Model for a response to add requests to a queue. - [AliasResolver](aliasresolver.md): Class for handling aliases. - [ApifyApiError](apifyapierror.md): An`ApifyApiError`is thrown for successful HTTP requests that reach the API, but the API responds with an error resp... - [ApifyCacheStorage](apifycachestorage.md): A Scrapy cache storage that uses the Apify`KeyValueStore`to store responses. - [ApifyClient](apifyclient.md): The official JavaScript client for the Apify API. - [ApifyClientAsync](apifyclientasync.md): The asynchronous version of the Apify API client. - [ApifyClientError](apifyclienterror.md): Base class for errors specific to the Apify API Client. - [ApifyClientOptions](apifyclientoptions.md): Configuration options for ApifyClient. - [ApifyDatasetClient](apifydatasetclient.md): An Apify platform implementation of the dataset client. - [ApifyEnv](apifyenv.md): Parsed representation of the Apify environment variables. This object is returned by the [Actor.getEnv](https://docs.... - [ApifyEventManager](apifyeventmanager.md): Event manager for the Apify platform. - [ApifyFileSystemKeyValueStoreClient](apifyfilesystemkeyvaluestoreclient.md): Apify-specific implementation of the`FileSystemKeyValueStoreClient`. - [ApifyFileSystemStorageClient](apifyfilesystemstorageclient.md): Apify-specific implementation of the file system storage client. - [ApifyHttpProxyMiddleware](apifyhttpproxymiddleware.md): Apify HTTP proxy middleware for Scrapy. - [ApifyKeyValueStoreClient](apifykeyvaluestoreclient.md): An Apify platform implementation of the key-value store client. - [ApifyKeyValueStoreMetadata](apifykeyvaluestoremetadata.md): Extended key-value store metadata model for Apify platform. - [ApifyRequestList](apifyrequestlist.md): Extends crawlee RequestList. - [ApifyRequestQueueClient](apifyrequestqueueclient.md): Request queue client for the Apify platform. - [ApifyRequestQueueMetadata](apifyrequestqueuemetadata.md): * [**stats](https://docs.apify.com/sdk/python/sdk/python/reference/class/ApifyRequestQueueMetadata.md#stats) - [ApifyRequestQueueSharedClient](apifyrequestqueuesharedclient.md): Internal request queue client implementation for multi-consumer scenarios on the Apify platform. - [ApifyRequestQueueSingleClient](apifyrequestqueuesingleclient.md): Internal request queue client implementation for single-consumer scenarios on the Apify platform. - [ApifyScheduler](apifyscheduler.md): A Scrapy scheduler that uses the Apify`RequestQueue`to manage requests. - [ApifyStorageClient](apifystorageclient.md): Apify platform implementation of the storage client. - [AsyncThread](asyncthread.md): Class for running an asyncio event loop in a separate thread. - [BaseActorVersion \](baseactorversion.md): * *BaseActorVersion* - [BaseClient](baseclient.md): Base class for sub-clients. - [BaseClientAsync](baseclientasync.md): Base class for async sub-clients. - [BatchAddRequestsResult](batchaddrequestsresult.md): Result of the batch add requests operation. - [Build](build.md): Represents an Actor build. - [BuildClient](buildclient.md): Client for managing a specific Actor build. - [BuildClientAsync](buildclientasync.md): Async sub-client for manipulating a single Actor build. - [BuildClientGetOptions](buildclientgetoptions.md): Options for getting a Build. - [BuildClientWaitForFinishOptions](buildclientwaitforfinishoptions.md): Options for waiting for a Build to finish. - [BuildCollectionClient](buildcollectionclient.md): Client for managing the collection of Actor builds. - [BuildCollectionClientAsync](buildcollectionclientasync.md): Async sub-client for listing Actor builds. - [BuildCollectionClientListOptions](buildcollectionclientlistoptions.md): * PaginationOptions - [BuildMeta](buildmeta.md): Metadata about how a Build was initiated. - [BuildOptions](buildoptions.md): Configuration options used for an Actor build. - [BuildStats](buildstats.md): Runtime statistics for an Actor build. - [BuildUsage](buildusage.md): Resource usage for an Actor build. - [CachedRequest](cachedrequest.md): Pydantic model for cached request information. - [CallOptions](calloptions.md): * ActorCallOptions - [CallTaskOptions](calltaskoptions.md): * TaskCallOptions - [ChargeOptions](chargeoptions.md): * **count - [ChargeResult](chargeresult.md): * **eventChargeLimitReached - [ChargingManager](chargingmanager.md): Handles pay-per-event charging. - [ChargingManagerImplementation](chargingmanagerimplementation.md): Implementation of the`ChargingManager`Protocol - this is only meant to be instantiated internally. - [ChargingStateItem](chargingstateitem.md): * [**charge\_count](https://docs.apify.com/sdk/python/sdk/python/reference/class/ChargingStateItem.md#charge_count) - [Configuration](configuration.md): `Configuration`is a value object holding the SDK configuration. We can use it in two ways: - [ConfigurationOptions](configurationoptions.md): * ConfigurationOptions - [Current](current.md): * **activeActorJobCount - [Dataset](dataset.md): Represents a dataset storage on the Apify platform. - [DatasetClient \](datasetclient.md): Client for managing a specific Dataset. - [DatasetClientAsync](datasetclientasync.md): Async sub-client for manipulating a single dataset. - [DatasetClientCreateItemsUrlOptions](datasetclientcreateitemsurloptions.md): Options for creating a public URL to access dataset items. - [DatasetClientDownloadItemsOptions](datasetclientdownloaditemsoptions.md): Options for downloading dataset items in a specific format. - [DatasetClientListItemOptions](datasetclientlistitemoptions.md): Options for listing items from a dataset. - [DatasetClientUpdateOptions](datasetclientupdateoptions.md): Options for updating a dataset. - [DatasetCollectionClient](datasetcollectionclient.md): Client for managing the collection of datasets in your account. - [DatasetCollectionClientAsync](datasetcollectionclientasync.md): Async sub-client for manipulating datasets. - [DatasetCollectionClientGetOrCreateOptions](datasetcollectionclientgetorcreateoptions.md): * **schema - [DatasetCollectionClientListOptions](datasetcollectionclientlistoptions.md): * PaginationOptions - [externalDatasetConsumer \](datasetconsumer.md): User-function used in the`Dataset.forEach()`API. - [externalDatasetContent \](datasetcontent.md): * **count - [externalDatasetDataOptions](datasetdataoptions.md): * **clean - [DatasetItemsListPage](datasetitemslistpage.md): Model for a single page of dataset items returned from a collection list method. - [externalDatasetIteratorOptions](datasetiteratoroptions.md): * Omit<[DatasetDataOptions](https://docs.apify.com/sdk/js/sdk/js/reference/interface/DatasetDataOptions.md), offset |... - [externalDatasetMapper \](datasetmapper.md): User-function used in the`Dataset.map()`API. - [DatasetMetadata](datasetmetadata.md): Model for a dataset metadata. - [externalDatasetOptions](datasetoptions.md): * **client - [externalDatasetReducer \](datasetreducer.md): User-function used in the`Dataset.reduce()`API. - [DatasetStatistics](datasetstatistics.md): Statistical information about dataset fields. - [DatasetStats](datasetstats.md): Statistics about dataset usage and storage. - [DeprecatedEvent](deprecatedevent.md): * [**data](https://docs.apify.com/sdk/python/sdk/python/reference/class/DeprecatedEvent.md#data) - [DownloadItemsFormat](downloaditemsformat.md): Supported formats for downloading dataset items. - [Event](event.md): Names of all possible events that can be emitted using an`EventManager`. - [EventAbortingData](eventabortingdata.md): Data for the aborting event. - [EventExitData](eventexitdata.md): Data for the exit event. - [EventManager](eventmanager.md): Manage events and their listeners, enabling registration, emission, and execution control. - [EventMigratingData](eventmigratingdata.md): Data for the migrating event. - [EventPersistStateData](eventpersiststatedata.md): Data for the persist state event. - [EventSystemInfoData](eventsysteminfodata.md): Data for the system info event. - [EventWithoutData](eventwithoutdata.md): * [**data](https://docs.apify.com/sdk/python/sdk/python/reference/class/EventWithoutData.md#data) - [ExitEvent](exitevent.md): * [**data](https://docs.apify.com/sdk/python/sdk/python/reference/class/ExitEvent.md#data) - [ExitOptions](exitoptions.md): * *ExitOptions* - [FieldStatistics](fieldstatistics.md): Statistics for a single field in a dataset. - [FileSystemStorageClient](filesystemstorageclient.md): File system implementation of the storage client. - [FlatPricePerMonthActorPricingInfo](flatpricepermonthactorpricinginfo.md): Pricing information for Actors with a flat monthly subscription fee. - [FreeActorPricingInfo](freeactorpricinginfo.md): Pricing information for free Actors. - [GetStreamedLogOptions](getstreamedlogoptions.md): Options for getting a streamed log. - [HTTPClient](httpclient.md): * [\_BaseHTTPClient](https://docs.apify.com/api/client/python/api/client/python/reference/class/_BaseHTTPClient.md) - [HTTPClientAsync](httpclientasync.md): * [\_BaseHTTPClient](https://docs.apify.com/api/client/python/api/client/python/reference/class/_BaseHTTPClient.md) - [InitOptions](initoptions.md): * *InitOptions* - [InvalidResponseBodyError](invalidresponsebodyerror.md): This error exists for the quite common situation, where only a partial JSON response is received and an attempt to pa... - [externalKeyConsumer](keyconsumer.md): User-function used in the [KeyValueStore.forEachKey](https://docs.apify.com/sdk/js/sdk/js/reference/class/KeyValueSto... - [KeyValueClientCreateKeysUrlOptions](keyvalueclientcreatekeysurloptions.md): Options for creating a public URL to list keys in a Key-Value Store. - [KeyValueClientGetRecordOptions](keyvalueclientgetrecordoptions.md): Options for retrieving a record from a Key-Value Store. - [KeyValueClientListKeysOptions](keyvalueclientlistkeysoptions.md): Options for listing keys in a Key-Value Store. - [KeyValueClientListKeysResult](keyvalueclientlistkeysresult.md): Result of listing keys in a Key-Value Store. - [KeyValueClientUpdateOptions](keyvalueclientupdateoptions.md): Options for updating a Key-Value Store. - [KeyValueListItem](keyvaluelistitem.md): Metadata about a single key in a Key-Value Store. - [KeyValueStore](keyvaluestore.md): Represents a Key-Value Store storage on the Apify platform. - [KeyValueStoreClient](keyvaluestoreclient.md): Client for managing a specific key-value store. - [KeyValueStoreClientAsync](keyvaluestoreclientasync.md): Async sub-client for manipulating a single key-value store. - [KeyValueStoreCollectionClient](keyvaluestorecollectionclient.md): Client for managing the collection of Key-value stores in your account. - [KeyValueStoreCollectionClientAsync](keyvaluestorecollectionclientasync.md): Async sub-client for manipulating key-value stores. - [KeyValueStoreCollectionClientGetOrCreateOptions](keyvaluestorecollectionclientgetorcreateoptions.md): * **schema - [KeyValueStoreCollectionClientListOptions](keyvaluestorecollectionclientlistoptions.md): * PaginationOptions - [externalKeyValueStoreIteratorOptions](keyvaluestoreiteratoroptions.md): * **exclusiveStartKey - [KeyValueStoreKeyInfo](keyvaluestorekeyinfo.md): Model for a key-value store key info. - [KeyValueStoreListKeysPage](keyvaluestorelistkeyspage.md): Model for listing keys in the key-value store. - [KeyValueStoreMetadata](keyvaluestoremetadata.md): Model for a key-value store metadata. - [externalKeyValueStoreOptions](keyvaluestoreoptions.md): * **client - [KeyValueStoreRecord \](keyvaluestorerecord.md): Represents a record (key-value pair) in a Key-Value Store. - [KeyValueStoreRecordMetadata](keyvaluestorerecordmetadata.md): Model for a key-value store record metadata. - [KeyValueStoreRecordOptions](keyvaluestorerecordoptions.md): Options for storing a record in a Key-Value Store. - [KeyValueStoreStats](keyvaluestorestats.md): Statistics about Key-Value Store usage and storage. - [Limits](limits.md): * **dataRetentionDays - [ListPage](listpage.md): A single page of items returned from a list() method. - [LocalEventManager](localeventmanager.md): Event manager for local environments. - [externalLog](log.md): The log instance enables level aware logging of messages and we advise to use it instead of`console.log()`and its a... - [LogClient](logclient.md): Client for accessing Actor run or build logs. - [LogClientAsync](logclientasync.md): Async sub-client for manipulating logs. - [LogContext](logcontext.md): * [**attempt](https://docs.apify.com/api/client/python/api/client/python/reference/class/LogContext.md#attempt) - [externalLogLevel](loglevel.md): * **DEBUG - [LogOptions](logoptions.md): * **raw - [externalLogger](logger.md): This is an abstract class that should be extended by custom logger classes. - [LoggerActorRedirect](loggeractorredirect.md): Logger for redirected actor logs. - [externalLoggerJson](loggerjson.md): This is an abstract class that should be extended by custom logger classes. - [externalLoggerOptions](loggeroptions.md): * **data - [externalLoggerText](loggertext.md): This is an abstract class that should be extended by custom logger classes. - [MainOptions](mainoptions.md): * [ExitOptions](https://docs.apify.com/sdk/js/sdk/js/reference/interface/ExitOptions.md) - [MemoryStorageClient](memorystorageclient.md): Memory implementation of the storage client. - [MetamorphOptions](metamorphoptions.md): * **build - [MigratingEvent](migratingevent.md): * [**data](https://docs.apify.com/sdk/python/sdk/python/reference/class/MigratingEvent.md#data) - [MonthlyUsage](monthlyusage.md): * **dailyServiceUsages - [MonthlyUsageCycle](monthlyusagecycle.md): * **endAt - [OpenApiDefinition](openapidefinition.md): OpenAPI specification for an Actor. - [OpenStorageOptions](openstorageoptions.md): * **forceCloud - [PaginatedList \](paginatedlist.md): Paginated list with detailed pagination information. - [PayPerEventActorPricingInfo](paypereventactorpricinginfo.md): * [**minimal\_max\_total\_charge\_usd](https://docs.apify.com/sdk/python/sdk/python/reference/class/PayPerEventActorP... - [PersistStateEvent](persiststateevent.md): * [**data](https://docs.apify.com/sdk/python/sdk/python/reference/class/PersistStateEvent.md#data) - [PlatformEventManager](platformeventmanager.md): Gets an instance of a Node.js' [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) class tha... - [PlatformFeature](platformfeature.md): * **Actors - [PricePerDatasetItemActorPricingInfo](priceperdatasetitemactorpricinginfo.md): Pricing information for pay-per-result Actors. - [PricePerEventActorPricingInfo](pricepereventactorpricinginfo.md): Pricing information for pay-per-event Actors. - [PricingInfo](pricinginfo.md): * **pricingModel - [PricingInfoItem](pricinginfoitem.md): * [**price](https://docs.apify.com/sdk/python/sdk/python/reference/class/PricingInfoItem.md#price) - [PricingPerEvent](pricingperevent.md): * [**actor\_charge\_events](https://docs.apify.com/sdk/python/sdk/python/reference/class/PricingPerEvent.md#actor_cha... - [ProcessedRequest](processedrequest.md): Represents a processed request. - [ProlongRequestLockResponse](prolongrequestlockresponse.md): Response to prolong request lock calls. - [ProxyConfiguration](proxyconfiguration.md): Configures connection to a proxy server with the provided options. Proxy servers are used to prevent target websites ... - [ProxyConfigurationOptions](proxyconfigurationoptions.md): * ProxyConfigurationOptions - [ProxyGroup](proxygroup.md): * **availableCount - [ProxyInfo](proxyinfo.md): The main purpose of the ProxyInfo object is to provide information about the current proxy connection used by the cra... - [externalQueueOperationInfo](queueoperationinfo.md): A helper class that is used to report results from various [RequestQueue](https://docs.apify.com/sdk/js/sdk/js/refere... - [RebootOptions](rebootoptions.md) - [externalRecordOptions](recordoptions.md): * **contentType - [RedirectLogFormatter](redirectlogformatter.md): Formatter applied to default redirect logger. - [Request](request.md): Represents a request in the Crawlee framework, containing the necessary information for crawling operations. - [RequestLoader](requestloader.md): An abstract class defining the interface for classes that provide access to a read-only stream of requests. - [RequestManager](requestmanager.md): Base class that extends`RequestLoader`with the capability to enqueue new requests and reclaim failed ones. - [RequestManagerTandem](requestmanagertandem.md): Implements a tandem behaviour for a pair of`RequestLoader`and`RequestManager`. - [RequestQueue](requestqueue.md): Represents a Request Queue storage on the Apify platform. - [RequestQueueClient](requestqueueclient.md): Client for managing a specific Request queue. - [RequestQueueClientAddRequestOptions](requestqueueclientaddrequestoptions.md): * **forefront - [RequestQueueClientAddRequestResult](requestqueueclientaddrequestresult.md): Result of adding a request to the queue. - [RequestQueueClientAsync](requestqueueclientasync.md): Async sub-client for manipulating a single request queue. - [RequestQueueClientBatchAddRequestWithRetriesOptions](requestqueueclientbatchaddrequestwithretriesoptions.md): * **forefront - [RequestQueueClientBatchRequestsOperationResult](requestqueueclientbatchrequestsoperationresult.md): Result of a batch operation on requests. - [RequestQueueClientDeleteRequestLockOptions](requestqueueclientdeleterequestlockoptions.md): * **forefront - [RequestQueueClientListAndLockHeadOptions](requestqueueclientlistandlockheadoptions.md): Options for listing and locking requests from the queue head. - [RequestQueueClientListAndLockHeadResult](requestqueueclientlistandlockheadresult.md): Result of listing and locking requests from the queue head. - [RequestQueueClientListHeadOptions](requestqueueclientlistheadoptions.md): Options for listing requests from the queue head. - [RequestQueueClientListHeadResult](requestqueueclientlistheadresult.md): Result of listing requests from the queue head. - [RequestQueueClientListItem](requestqueueclientlistitem.md): Simplified request information used in list results. - [RequestQueueClientListRequestsOptions](requestqueueclientlistrequestsoptions.md): Options for listing all requests in the queue. - [RequestQueueClientListRequestsResult](requestqueueclientlistrequestsresult.md): Result of listing all requests in the queue. - [RequestQueueClientPaginateRequestsOptions](requestqueueclientpaginaterequestsoptions.md): Options for paginating through requests in the queue. - [RequestQueueClientProlongRequestLockOptions](requestqueueclientprolongrequestlockoptions.md): * **forefront - [RequestQueueClientProlongRequestLockResult](requestqueueclientprolongrequestlockresult.md): * **lockExpiresAt - [RequestQueueClientRequestSchema](requestqueueclientrequestschema.md): Complete schema for a request in the queue. - [RequestQueueClientUnlockRequestsResult](requestqueueclientunlockrequestsresult.md): * **unlockedCount - [RequestQueueClientUpdateOptions](requestqueueclientupdateoptions.md): Options for updating a Request Queue. - [RequestQueueCollectionClient](requestqueuecollectionclient.md): Client for managing the collection of Request queues in your account. - [RequestQueueCollectionClientAsync](requestqueuecollectionclientasync.md): Async sub-client for manipulating request queues. - [RequestQueueCollectionListOptions](requestqueuecollectionlistoptions.md): * PaginationOptions - [RequestQueueHead](requestqueuehead.md): Model for request queue head. - [RequestQueueMetadata](requestqueuemetadata.md): Model for a request queue metadata. - [externalRequestQueueOperationOptions](requestqueueoperationoptions.md): * **forefront - [externalRequestQueueOptions](requestqueueoptions.md): * **@deprecated** - [RequestQueueStats](requestqueuestats.md): Statistics about Request Queue usage and storage. - [RequestQueueUserOptions](requestqueueuseroptions.md): User-specific options for RequestQueueClient. - [ResourceClient](resourceclient.md): Base class for sub-clients manipulating a single resource. - [ResourceClientAsync](resourceclientasync.md): Base class for async sub-clients manipulating a single resource. - [ResourceCollectionClient](resourcecollectionclient.md): Base class for sub-clients manipulating a resource collection. - [ResourceCollectionClientAsync](resourcecollectionclientasync.md): Base class for async sub-clients manipulating a resource collection. - [RunAbortOptions](runabortoptions.md): Options for aborting a Run. - [RunChargeOptions](runchargeoptions.md): Options for charging events in a pay-per-event Actor run. - [RunClient](runclient.md): Client for managing a specific Actor run. - [RunClientAsync](runclientasync.md): Async sub-client for manipulating a single Actor run. - [RunCollectionClient](runcollectionclient.md): Client for managing the collection of Actor runs. - [RunCollectionClientAsync](runcollectionclientasync.md): Async sub-client for listing Actor runs. - [RunCollectionListOptions](runcollectionlistoptions.md): * PaginationOptions - [RunGetOptions](rungetoptions.md): Options for getting a Run. - [RunMetamorphOptions](runmetamorphoptions.md): Options for metamorphing a Run into another Actor. - [RunResurrectOptions](runresurrectoptions.md): Options for resurrecting a finished Run. - [RunUpdateOptions](runupdateoptions.md): Options for updating a Run. - [RunWaitForFinishOptions](runwaitforfinishoptions.md): Options for waiting for a Run to finish. - [Schedule](schedule.md): Represents a schedule for automated Actor or Task runs. - [ScheduleActionRunActor](scheduleactionrunactor.md): Scheduled action to run an Actor. - [ScheduleActionRunActorTask](scheduleactionrunactortask.md): Scheduled action to run an Actor task. - [ScheduleActions](scheduleactions.md): Types of actions that can be scheduled. - [ScheduleClient](scheduleclient.md): Client for managing a specific Schedule. - [ScheduleClientAsync](scheduleclientasync.md): Async sub-client for manipulating a single schedule. - [ScheduleCollectionClient](schedulecollectionclient.md): Client for managing the collection of Schedules in your account. - [ScheduleCollectionClientAsync](schedulecollectionclientasync.md): Async sub-client for manipulating schedules. - [ScheduleCollectionListOptions](schedulecollectionlistoptions.md): * PaginationOptions - [ScheduledActorRunInput](scheduledactorruninput.md): Input configuration for a scheduled Actor run. - [ScheduledActorRunOptions](scheduledactorrunoptions.md): Run options for a scheduled Actor run. - [SitemapRequestLoader](sitemaprequestloader.md): A request loader that reads URLs from sitemap(s). - [SmartApifyStorageClient](smartapifystorageclient.md): Storage client that automatically selects cloud or local storage client based on the environment. - [SqlStorageClient](sqlstorageclient.md): SQL implementation of the storage client. - [Statistics](statistics.md): Statistics about API client usage and rate limit errors. - [StatusMessageWatcher](statusmessagewatcher.md): Utility class for logging status messages from another Actor run. - [StatusMessageWatcherAsync](statusmessagewatcherasync.md): Async variant of`StatusMessageWatcher`that is logging in task. - [StatusMessageWatcherSync](statusmessagewatchersync.md): Sync variant of`StatusMessageWatcher`that is logging in thread. - [Storage](storage.md): Base class for storages. - [StorageClient](storageclient.md): Base class for storage clients. - [StorageMetadata](storagemetadata.md): Represents the base model for storage metadata. - [StoreCollectionClient](storecollectionclient.md): Client for browsing Actors in the Apify Store. - [StoreCollectionClientAsync](storecollectionclientasync.md): Async sub-client for Apify store. - [StoreCollectionListOptions](storecollectionlistoptions.md): * PaginationOptions - [StreamedLog](streamedlog.md): Helper class for redirecting streamed Actor logs to another log. - [StreamedLogAsync](streamedlogasync.md): Async variant of`StreamedLog`that is logging in tasks. - [StreamedLogOptions](streamedlogoptions.md): * **fromStart - [StreamedLogSync](streamedlogsync.md): Sync variant of`StreamedLog`that is logging in threads. - [SystemInfoEvent](systeminfoevent.md): * [**data](https://docs.apify.com/sdk/python/sdk/python/reference/class/SystemInfoEvent.md#data) - [SystemInfoEventData](systeminfoeventdata.md): * [**to\_crawlee\_format](https://docs.apify.com/sdk/python/sdk/python/reference/class/SystemInfoEventData.md#to_craw... - [Task](task.md): Represents an Actor task. - [TaskCallOptions](taskcalloptions.md): Options for calling a Task and waiting for it to finish. - [TaskClient](taskclient.md): Client for managing a specific Actor task. - [TaskClientAsync](taskclientasync.md): Async sub-client for manipulating a single task. - [TaskCollectionClient](taskcollectionclient.md): Client for managing the collection of Actor tasks in your account. - [TaskCollectionClientAsync](taskcollectionclientasync.md): Async sub-client for manipulating tasks. - [TaskCollectionListOptions](taskcollectionlistoptions.md): * PaginationOptions - [TaskCreateData](taskcreatedata.md): Fields that can be updated when modifying a Task. - [TaskLastRunOptions](tasklastrunoptions.md): Options for filtering the last run of a Task. - [TaskOptions](taskoptions.md): Configuration options for an Actor task. - [TaskStats](taskstats.md): Statistics about Actor task usage. - [UnknownEvent](unknownevent.md): * [**data](https://docs.apify.com/sdk/python/sdk/python/reference/class/UnknownEvent.md#data) - [UsageCycle](usagecycle.md): * **endAt - [User](user.md): * **createdAt - [UserClient](userclient.md): Client for managing user account information. - [UserClientAsync](userclientasync.md): Async sub-client for querying user data. - [UserPlan](userplan.md): * **availableAddOns - [UserProxy](userproxy.md): * **groups - [Webhook](webhook.md): Represents a webhook for receiving notifications about Actor events. - [WebhookAnyRunOfActorCondition](webhookanyrunofactorcondition.md): * **actorId - [WebhookAnyRunOfActorTaskCondition](webhookanyrunofactortaskcondition.md): * **actorTaskId - [WebhookCertainRunCondition](webhookcertainruncondition.md): * **actorRunId - [WebhookClient](webhookclient.md): Client for managing a specific webhook. - [WebhookClientAsync](webhookclientasync.md): Async sub-client for manipulating a single webhook. - [WebhookCollectionClient](webhookcollectionclient.md): Client for managing the collection of Webhooks. - [WebhookCollectionClientAsync](webhookcollectionclientasync.md): Async sub-client for manipulating webhooks. - [WebhookCollectionListOptions](webhookcollectionlistoptions.md): * PaginationOptions - [WebhookDispatch](webhookdispatch.md): * **calls - [WebhookDispatchCall](webhookdispatchcall.md): * **errorMessage - [WebhookDispatchClient](webhookdispatchclient.md): Client for managing a specific webhook dispatch. - [WebhookDispatchClientAsync](webhookdispatchclientasync.md): Async sub-client for querying information about a webhook dispatch. - [WebhookDispatchCollectionClient](webhookdispatchcollectionclient.md): Client for managing the collection of webhook dispatches. - [WebhookDispatchCollectionClientAsync](webhookdispatchcollectionclientasync.md): Async sub-client for listing webhook dispatches. - [WebhookDispatchCollectionListOptions](webhookdispatchcollectionlistoptions.md): * PaginationOptions - [WebhookDispatchEventData](webhookdispatcheventdata.md): * **actorBuildId - [WebhookDispatchStatus](webhookdispatchstatus.md): * **Active - [WebhookIdempotencyKey](webhookidempotencykey.md): * **idempotencyKey - [WebhookOptions](webhookoptions.md): * **eventTypes - [WebhookStats](webhookstats.md): Statistics about webhook usage. - [WithLogDetailsClient](withlogdetailsclient.md): * [**\_\_new\_\_](https://docs.apify.com/api/client/python/api/client/python/reference/class/WithLogDetailsClient.md#... - [\_BaseApifyClient](baseapifyclient.md): * *\_BaseApifyClient* - [\_BaseBaseClient](basebaseclient.md): * *\_BaseBaseClient* - [\_BaseHTTPClient](basehttpclient.md): * *\_BaseHTTPClient* - [\_ContextInjectingFilter](contextinjectingfilter.md): * [**filter](https://docs.apify.com/api/client/python/api/client/python/reference/class/_ContextInjectingFilter.md#fi... - [\_DebugLogFormatter](debuglogformatter.md): * [**format](https://docs.apify.com/api/client/python/api/client/python/reference/class/_DebugLogFormatter.md#format) - [\_FetchedPricingInfoDict](fetchedpricinginfodict.md): * [**charged\_event\_counts](https://docs.apify.com/sdk/python/sdk/python/reference/class/_FetchedPricingInfoDict.md#... - [\_RequestDetails](requestdetails.md): * *\_RequestDetails* - [\_RequestsFromUrlInput](requestsfromurlinput.md): * [\_RequestDetails](https://docs.apify.com/sdk/python/sdk/python/reference/class/_RequestDetails.md) - [\_SimpleUrlInput](simpleurlinput.md): * [\_RequestDetails](https://docs.apify.com/sdk/python/sdk/python/reference/class/_RequestDetails.md) - [Apify Academy](academy.md): Learn everything about web scraping and automation with our free courses that will turn you into an expert scraper de... - [Accept user input](accept-user-input.md): Copy for LLM - [Apify Acceptable Use Policy](acceptable-use-policy.md): Apify Technologies s.r.o., with its registered seat at Vodičkova 704/36, Nové Město, 110 00 Prague 1, Czech Republic,... - [Accessing Apify API](access-apify-api.md): Copy for LLM - [Access rights](access-rights.md): **Manage permissions for your private resources such as Actors, Actor runs, and storages. Allow other users to read, ... - [Abort build](act-build-abort-post.md): POST - [Get default build](act-build-default-get.md): GET - [Get build](act-build-get.md): GET - [Get list of builds](act-builds-get.md): GET - [Build Actor](act-builds-post.md): POST - [Delete Actor](act-delete.md): DELETE - [Get Actor](act-get.md): GET - [Get OpenAPI definition](act-openapi-json-get.md): GET - [Update Actor](act-put.md): PUT - [Abort run](act-run-abort-post.md): POST - [Get run](act-run-get.md): GET - [Metamorph run](act-run-metamorph-post.md): POST - [Resurrect run](act-run-resurrect-post.md): POST - [Run Actor synchronously without input and get dataset items](act-run-sync-get-dataset-items-get.md): GET - [Run Actor synchronously with input and get dataset items](act-run-sync-get-dataset-items-post.md): POST - [Without input](act-run-sync-get.md): GET - [Run Actor synchronously with input and return output](act-run-sync-post.md): POST - [Get list of runs](act-runs-get.md): GET - [Get last run](act-runs-last-get.md): GET - [Run Actor](act-runs-post.md): POST - [Delete version](act-version-delete.md): DELETE - [Delete environment variable](act-version-env-var-delete.md): DELETE - [Get environment variable](act-version-env-var-get.md): GET - [Update environment variable](act-version-env-var-put.md): PUT - [Get list of environment variables](act-version-env-vars-get.md): GET - [Create environment variable](act-version-env-vars-post.md): POST - [Get version](act-version-get.md): GET - [Update version](act-version-put.md): PUT - [Get list of versions](act-versions-get.md): GET - [Create version](act-versions-post.md): POST - [Get list of webhooks](act-webhooks-get.md): GET - [Webhook actions](actions.md): **Send notifications when specific events occur in your Actor/task run or build. Dynamically add data to the notifica... - [Abort build](actor-build-abort-post.md): POST - [Delete build](actor-build-delete.md): DELETE - [Get build](actor-build-get.md): GET - [Get log](actor-build-log-get.md): GET - [Get OpenAPI definition](actor-build-openapi-json-get.md): GET - [Get user builds list](actor-builds-get.md): GET - [Actor builds - Introduction](actor-builds.md): The API endpoints described in this section enable you to manage, and delete Apify Actor builds. - [Actor bundles](actor-bundles.md): **Learn what an Actor bundle is, explore existing examples, and discover how to promote them.** - [Actor configuration](actor-configuration.md): Copy for LLM - [Actor definition](actor-definition.md): **Learn how to turn your arbitrary code into an Actor simply by adding an Actor definition directory.** - [Actor description & SEO description](actor-description.md): Learn about Actor description and meta description. Where to set them and best practices for both content and length. - [Actor events & state persistence](actor-events.md): Copy for LLM - [Actor input](actor-input.md): Copy for LLM - [actor.json](actor-json.md): **Learn how to write the main Actor configuration in the`.actor/actor.json`file.** - [Actor lifecycle](actor-lifecycle.md): Copy for LLM - [Abort run](actor-run-abort-post.md): POST - [Delete run](actor-run-delete.md): DELETE - [Get run](actor-run-get.md): GET - [Metamorph run](actor-run-metamorph-post.md): POST - [Update run](actor-run-put.md): PUT - [Reboot run](actor-run-reboot-post.md): POST - [Get user runs list](actor-runs-get.md): GET - [Actor runs - Introduction](actor-runs.md): The API endpoints described in this section enable you to manage, and delete Apify Actor runs. - [Actor structure](actor-structure.md): Copy for LLM - [Delete task](actor-task-delete.md): DELETE - [Get task](actor-task-get.md): GET - [Get task input](actor-task-input-get.md): GET - [Update task input](actor-task-input-put.md): PUT - [Update task](actor-task-put.md): PUT - [Run task synchronously and get dataset items](actor-task-run-sync-get-dataset-items-get.md): GET - [Run task synchronously and get dataset items](actor-task-run-sync-get-dataset-items-post.md): POST - [Run task synchronously](actor-task-run-sync-get.md): GET - [Run task synchronously](actor-task-run-sync-post.md): POST - [Get list of task runs](actor-task-runs-get.md): GET - [Get last run](actor-task-runs-last-get.md): GET - [Run task](actor-task-runs-post.md): POST - [Get list of webhooks](actor-task-webhooks-get.md): GET - [Get list of tasks](actor-tasks-get.md): GET - [Create task](actor-tasks-post.md): POST - [Actor tasks - Introduction](actor-tasks.md): The API endpoints described in this section enable you to create, manage, delete, and run Apify Actor tasks. For more... - [Actor Terms and Conditions](actor-terms-and-conditions.md): Effective date: January 12, 2026 - [Validate your Actor idea](actor-validation.md): Before investing time into building an Actor, validate that people actually need it. This guide shows you how to asse... - [Wrap open-source as an Actor](actorization.md): Apify is a cloud platform with a [marketplace](https://apify.com/store) of 6,000+ web scraping and automation tools c... - [Actor builds - Introduction](actors-actor-builds.md): The API endpoints in this section allow you to manage your Apify Actors builds. - [Actor runs - Introduction](actors-actor-runs.md): The API endpoints in this section allow you to manage your Apify Actors runs. - [Actor versions - Introduction](actors-actor-versions.md): The API endpoints in this section allow you to manage your Apify Actors versions. - [Actors and emojis](actors-and-emojis.md): Using emojis in Actors is a science on its own. Learn how emojis enhance the user experience in Actors by grabbing at... - [Actors in Store](actors-in-store.md): **[Apify Store](https://apify.com/store) is home to thousands of public Actors available to the Apify community. It's... - [Webhook collection - Introduction](actors-webhook-collection.md): The API endpoint in this section allows you to get a list of webhooks of a specific Actor. - [Webhooks & advanced Actor overview](actors-webhooks.md): **Learn more advanced details about Actors, how they work, and the default configurations they can take. Also, learn ... - [Actors - Introduction](actors.md): The API endpoints in this section allow you to manage Apify Actors. For more details about Actors, refer to the [Acto... - [Get list of Actors](acts-get.md): GET - [Create Actor](acts-post.md): POST - [Ad-hoc webhooks](ad-hoc-webhooks.md): **Set up one-time webhooks for Actor runs initiated through the Apify API or from the Actor's code. Trigger events wh... - [Add data to dataset](add-data-to-dataset.md): Copy for LLM - [How to add external libraries to Web Scraper](add-external-libraries-web-scraper.md): Sometimes you need to use some extra JavaScript in your [Web Scraper](https://apify.com/apify/web-scraper) page funct... - [Adding your RapidAPI project to Apify](adding-rapidapi-project.md): If you've published an API project on [RapidAPI](https://rapidapi.com/), you can expand your project's visibility by ... - [Advanced web scraping](advanced-web-scraping.md): In the [Web scraping basics for JavaScript devs](https://docs.apify.com/academy/scraping-basics-javascript.md) course... - [Apify Affiliate Program Terms and Conditions](affiliate-program-terms-and-conditions.md): Effective date: May 14, 2024 - [Affiliates](affiliates.md): The Apify Affiliate Program offers you a way to earn recurring commissions while helping others discover automation a... - [Agno Integration](agno.md): **Integrate Apify with Agno to power AI agents with web scraping, automation, and data insights.** - [AI agent tutorial](ai-agents.md): **In this section of the Apify Academy, we show you how to build an AI agent with the CrewAI Python framework. You’ll... - [Make - AI crawling Actor integration](ai-crawling.md): Apify Scraper for AI Crawling from [Apify](https://apify.com/) lets you extract text content from websites to feed AI... - [Airbyte integration](airbyte.md): **Learn how to integrate your Apify datasets with Airbyte.** - [Airtable integration](airtable.md): **Learn how to integrate Apify with Airtable. This article shows you how to use the Apify extension on Airtable.** - [Make - Amazon Actor integration](amazon.md): The Amazon Scraper module from [Apify](https://apify.com) allows you to extract product, search, or category data fro... - [How to analyze and fix errors when scraping a website](analyzing-pages-and-fixing-errors.md): **Learn how to deal with random crashes in your web-scraping and automation jobs. Find out the essentials of debuggin... - [Anti-scraping protections](anti-scraping.md): **Understand the various anti-scraping measures different sites use to prevent bots from accessing them, and how to a... - [API scraping](api-scraping.md): **Learn all about how the professionals scrape various types of APIs with various configurations, parameters, and req... - [Apify API documentation](api.md) - [Tutorials on Apify Actors](apify-actors.md): **Learn how to deploy your API project to the Apify platform.** - [Apify API & client](apify-api-and-client.md): **Gain an in-depth understanding of the two main ways of programmatically interacting with the Apify platform - throu... - [The Apify API](apify-api.md): **Learn how to use the Apify API to programmatically call your Actors, retrieve data stored on the platform, view Act... - [The Apify CLI](apify-cli.md): **Learn about, install, and log into the Apify CLI - your best friend for interacting with the Apify platform via you... - [Apify client](apify-client.md): **Interact with the Apify API in your code by using the apify-client package, which is available for both JavaScript ... - [Apify's free Google SERP API](apify-free-google-serp-api.md): You need to regularly grab SERP data about your target keywords? Apify provides a free SERP API that includes organic... - [Introduction to the Apify platform](apify-platform.md): **Learn all about the Apify platform, all of the tools it offers, and how it can improve your overall development exp... - [Tutorials on ready-made Apify scrapers](apify-scrapers.md): **Discover Apify's ready-made web scraping and automation tools. Compare Web Scraper, Cheerio Scraper and Puppeteer S... - [Asyncio support](asyncio-support.md): Copy for LLM - [Automated tests for Actors](automated-tests.md): **Learn how to automate ongoing testing and make sure your Actors perform over time. See code examples for configurin... - [Avoid EACCES error in Actor builds with a custom Dockerfile](avoid-eacces-error-in-actor-builds.md): Sometimes when building an Actor using a custom Dockerfile, you might receive errors like: - [Amazon Bedrock integrations](aws-bedrock.md): **Learn how to integrate Apify with Amazon Bedrock Agents to provide web data for AI agents.** - [Basic commands](basic-commands.md): **Learn how to use basic commands of the Apify SDK for both JavaScript and Python.** - [Basic crawler](basic-crawler.md): Copy for LLM - [Using BeautifulSoup with HTTPX](beautifulsoup-httpx.md): Copy for LLM - [Best practices when writing scrapers](best-practices.md): **Understand the standards and best practices that we here at Apify abide by to write readable, scalable, and maintai... - [Billing](billing.md): **The Billings page is the central place for all information regarding your invoices, billing information regarding u... - [Block requests in Puppeteer](block-requests-puppeteer.md): Improve Performance: Use`blockRequests` - [Blogs and blog resources](blogs-and-blog-resources.md): **Blogs remain a powerful tool for promoting your Actors and establishing authority in the field. With social media, ... - [Browser challenges](browser-challenges.md): Learn how to navigate browser challenges like Cloudflare's to effectively scrape data from protected websites. - [VI - Creating multiple browser contexts](browser-contexts.md): **Learn what a browser context is, how to create one, how to emulate devices, and how to use browser contexts to auto... - [Starting with browser DevTools](browser-devtools.md): **Learn about browser DevTools, a valuable tool in the world of web scraping, and how you can use them to extract dat... - [I - Launching a browser](browser.md): **Understand what the Browser object is in Puppeteer/Playwright, how to create one, and a bit about how to interact w... - [Bubble integration](bubble.md): **Learn how to integrate your Apify Actors with Bubble for automated workflows and notifications.** - [Build Actors with AI](build-with-ai.md): **Learn how to develop new Actors or improve existing ones using AI code generation and vibe coding tools.** - [Builds and runs](builds-and-runs.md): **Learn about Actor builds and runs, their lifecycle, versioning, and other properties.** - [Builds](builds.md): **Learn about Actor build numbers, versioning, and how to use specific Actor version in runs. Understand an Actor's l... - [Bypassing anti-scraping methods](bypassing-anti-scraping.md): **Learn about bypassing anti-scraping methods using proxies and proxy/session rotation together with Crawlee and the ... - [How to optimize Puppeteer by caching responses](caching-responses-in-puppeteer.md): **Learn why it is important for performance to cache responses in memory when intercepting requests in Puppeteer and ... - [Call actor](call-actor.md): Copy for LLM - [Apify Candidate Referral Program](candidate-referral-program-terms.md): Last Updated: April 14, 2025 - [Captchas](captchas.md): **Learn about the reasons a bot might be presented a captcha, the best ways to avoid CAPTCHASs in the first place, an... - [Capture a screenshot using Puppeteer](capture-screenshot.md): Copy for LLM - [Apify $1M Challenge Terms and Conditions](challenge-terms-and-conditions.md): Effective date: November 3, 2025 - [Challenge](challenge.md): **Test your knowledge acquired in the previous sections of this course by building an Amazon scraper using Crawlee's ... - [Changelog](changelog.md): * **actor:** Add 'taggedBuilds' to ActorUpdateOptions ([#830](https://github.com/apify/apify-client-js/pull/830)) ([c... - [ChatGPT integration](chatgpt.md): **Learn how to integrate Apify Actors with ChatGPT to provide web context in real-time.** - [Marketing checklist](checklist.md): You're a developer, not a marketer. You built something awesome, and now you need people to find it. This checklist b... - [Cheerio crawler](cheerio-crawler.md): Copy for LLM - [This scraping tutorial will go into the nitty gritty details of extracting data from **https://apify.com/store** using **Cheerio Scraper** (apify/cheerio-scraper). If you arrived here from the Getting started with Apify scrapers, tutorial, great! You are ready to continue where we left off. If you haven't seen the Getting started yet, check it out, it will help you learn about Apify and scraping in general and set you up for this tutorial, because this one builds on topics and code examples discussed there.](cheerio-scraper.md): This scraping tutorial will go into the nitty gritty details of extracting data from **[ - [How to choose the right scraper for the job](choosing-the-right-scraper.md): **Learn basic web scraping concepts to help you analyze a website and choose the best scraper for your particular use... - [Bypassing Cloudflare browser check](cloudflare-challengemd.md): **Learn how to bypass Cloudflare browser challenge with Crawlee.** - [Collaboration](collaboration.md): **Learn how to collaborate with other users and manage permissions for organizations or private resources such as Act... - [Extracting data](collecting-data.md): **Learn how to extract data from a page with evaluate functions, then how to parse it by using a second library calle... - [Common use cases](common-use-cases.md): **Learn about some of the most common use cases of Playwright and Puppeteer, and how to handle these use cases when y... - [Apify Community Code of Conduct](community-code-of-conduct.md): Effective Date: August 18, 2025 - [Prepare your computer for programming](computer-preparation.md): **Set up your computer to be able to code scrapers with Node.js and JavaScript. Download Node.js and npm and run a He... - [Concepts](concepts.md): **Learn about some common yet tricky concepts and terms that are used frequently within the academy, as well as in th... - [Apify Console](console.md): **Learn about Apify Console's easy account creation and user-friendly homepage for efficient web scraping management.** - [Container web server](container-web-server.md): **Learn about how to run a web server inside your Actor to enable communication with the outside world through both U... - [Continuous integration for Actors](continuous-integration.md): **Learn how to set up automated builds, deploys, and testing for your Actors.** - [Convenience methods](convenience-methods.md): Copy for LLM - [Apify Cookie Policy](cookie-policy.md): **Apify Technologies s.r.o.**, with its registered seat at Vodičkova 704/36, 110 00 Prague 1, Czech Republic, Company... - [Dealing with headers, cookies, and tokens](cookies-headers-tokens.md): **Learn about how some APIs require certain cookies, headers, and/or tokens to be present in a request in order for d... - [Crawl all links on a website](crawl-all-links.md): Copy for LLM - [Crawl multiple URLs](crawl-multiple-urls.md): Copy for LLM - [Crawl a website with relative links](crawl-relative-links.md): Copy for LLM - [Crawl a single URL](crawl-single-url.md): Copy for LLM - [Crawl a sitemap](crawl-sitemap.md): Copy for LLM - [Crawl some links on a website](crawl-some-links.md): Copy for LLM - [Using Crawlee](crawlee.md): Copy for LLM - [Crawling sitemaps](crawling-sitemaps.md): In the previous lesson, we learned what is the utility (and dangers) of crawling sitemaps. In this lesson, we will go... - [Crawling with search](crawling-with-search.md): In this lesson, we will start with a simpler example of scraping HTML based websites with limited pagination. - [Crawling websites with Node.js](crawling.md): **In this lesson, we'll follow links to individual product pages. We'll use the Fetch API to download them and Cheeri... - [Creating Actors](creating-actors.md): **This lesson offers hands-on experience in building and running Actors in Apify Console using a template. By the end... - [🤖🚀 CrewAI integration](crewai.md): **Learn how to build AI Agents with Apify and CrewAI.** - [CSS selectors](css-selectors.md): CSS selectors are patterns used to select on a web page. The... - [Custom error messages](custom-error-messages.md): **Learn how to define custom error messages for input validation in your Actor's input schema. Make validation feedba... - [Custom queries](custom-queries.md): **Learn how to write custom GraphQL queries, how to pass input values into GraphQL requests as variables, and how to ... - [EU Data Act Addendum](data-act-addendum.md): Effective date: January 12, 2026 - [Basics of data extraction](data-extraction.md): **Learn about HTML, CSS, and JavaScript, the basic building blocks of a website, and how to use them in web scraping ... - [Apify Data Processing Addendum](data-processing-addendum.md): Last Updated: January 13, 2025 - [Datacenter proxy](datacenter-proxy.md): **Learn how to reduce blocking when web scraping using IP address rotation. See proxy parameters and learn to impleme... - [Delete dataset](dataset-delete.md): DELETE - [Get dataset](dataset-get.md): GET - [Get dataset items](dataset-items-get.md): GET - [Store items](dataset-items-post.md): POST - [Update dataset](dataset-put.md): PUT - [Creating dataset schema](dataset-schema.md): **Learn how to generate an appealing Overview table interface to preview your Actor results in real time on the Apify... - [Get dataset statistics](dataset-statistics-get.md): GET - [Get list of datasets](datasets-get.md): GET - [Create dataset](datasets-post.md): POST - [How to scrape from dynamic pages](dealing-with-dynamic-pages.md): **Learn about dynamic pages and dynamic content. How can we find out if a page is dynamic? How do we programmatically... - [Debugging your Web Scraper pageFunction in browser's console](debugging-web-scraper.md): A lot of beginners struggle through trial and error while scraping a simple site. They write some code that might wor... - [Deploying your code to Apify](deploying-your-code.md): **In this course learn how to take an existing project of yours and deploy it to the Apify platform as an Actor.** - [Publishing your Actor](deploying.md): **Push local code to the platform, or create an Actor and integrate it with a Git repository for automatic rebuilds.** - [Deployment](deployment.md): **Learn how to deploy your Actors to the Apify platform and build them.** - [Actor development](development.md): **Read about the technical part of building Apify Actors. Learn to define Actor inputs, build new versions, persist A... - [Extracting data with DevTools](devtools-continued.md): **Continue learning how to extract data from a website using browser DevTools, CSS selectors, and JavaScript via the ... - [Extracting data from a web page with browser DevTools](devtools-extracting-data.md): **In this lesson we'll use the browser tools for developers to manually extract product data from an e-commerce websi... - [Inspecting web pages with browser DevTools](devtools-inspecting.md): **In this lesson we'll use the browser tools for developers to inspect and manipulate the structure of a website.** - [Locating HTML elements on a web page with browser DevTools](devtools-locating-elements.md): **In this lesson we'll use the browser tools for developers to manually find products on an e-commerce website.** - [Creating Actor Dockerfile](docker-file.md): **Learn to write a Dockerfile for your project so it can run in a Docker container on the Apify platform.** - [Running in Docker](docker-images.md): Copy for LLM - [Dockerfile](dockerfile.md): **Learn about the available Docker images you can use as a base for your Apify Actors. Choose the right base image ba... - [Apify API client for JavaScript](docs.md): Copy for LLM - [Downloading files](downloading-files.md): **Learn how to automatically download and save files to the disk using two of the most popular web automation librari... - [Downloading HTML with Node.js](downloading-html.md): **In this lesson we'll start building a Node.js application for watching prices. As a first step, we'll use the Fetch... - [Google Drive integration](drive.md): **Learn how to integrate your Apify Actors with Google Drive. This article shows you how to automatically save result... - [Dynamic Actor memory](dynamic-actor-memory.md): **Learn how to automatically adjust your Actor's memory based on input size and run options, so you can optimize perf... - [Dynamic pages and single-page applications](dynamic-pages.md): **Understand what makes a page dynamic, and how a page being dynamic might change your approach when writing a scrape... - [EditThisCookie](edit-this-cookie.md): **Learn how to add, delete, and modify different cookies in your browser for testing purposes using the EditThisCooki... - [Emails to Actor users](emails-to-actor-users.md): **Getting users is one thing, but keeping them is another. While emailing your users might not seem like a typical ma... - [Actor environment variables](environment-variables.md): **Learn how to provide your Actor with context that determines its behavior through a plethora of pre-defined environ... - [Error handling](error-handling.md): Copy for LLM - [Apify Event Terms and Conditions](event-terms-and-conditions.md): Effective date: November 3, 2025 - [Events types for webhooks](events.md): **Specify the types of events that trigger a webhook in an Actor or task run. Trigger an action on Actor or task run ... - [Code examples](examples.md): Copy for LLM - [III - Executing scripts](executing-scripts.md): **Understand the two different contexts which your code can be run in, and how to run custom scripts in the context o... - [Expert scraping with Apify](expert-scraping-with-apify.md): **After learning the basics of Actors and Apify, learn to develop pro-level scrapers on the Apify platform with this ... - [Exporting data](exporting-data.md): **Learn how to export the data you scraped using Crawlee to CSV or JSON.** - [Extracting data from HTML with Node.js](extracting-data.md): **In this lesson we'll finish extracting product data from the downloaded HTML. With help of basic string manipulatio... - [Make - Facebook Actor integration](facebook.md): The Facebook Scraper modules from [Apify](https://apify.com/) allow you to extract posts, comments, and profile data ... - [Apify Open Source Fair Share Program Terms and Conditions](fair-share-program-terms-and-conditions.md): You are reading terms and conditions that are no longer effective. - [Filter out blocked proxies using sessions](filter-blocked-requests-using-sessions.md): *This article explains how the problem was solved before the [SessionPool](https://docs.apify.com/sdk/js/docs/api/ses... - [Filtering links](filtering-links.md): **When you extract links from a web page, you often end up with a lot of irrelevant URLs. Learn how to filter the lin... - [Find ideas for new Actors](find-actor-ideas.md): Learn what kind of software tools are suitable to be packaged and published as Actors on Apify, and where you can fin... - [Finding links](finding-links.md): **Learn what a link looks like in HTML and how to find and extract their URLs when web scraping using both DevTools a... - [Fingerprinting](fingerprinting.md): **Understand browser fingerprinting, an advanced technique used by browsers to track user data and even block bots fr... - [Firewalls](firewalls.md): **Understand what a web-application firewall is, how they work, and the various common techniques for avoiding them a... - [Your first crawl](first-crawl.md): **Learn how to crawl the web using Node.js, Cheerio and an HTTP client. Extract URLs from pages and use them to visit... - [Flowise integration](flowise.md): **Learn how to integrate Apify with Flowise.** - [Forms](forms.md): Copy for LLM - [Using a scraping framework with Node.js](framework.md): **In this lesson, we'll rework our application for watching prices so that it builds on top of a scraping framework. ... - [Apify GDPR Information](gdpr-information.md): The European Union (“**EU**”) General Data Protection Regulation (“**GDPR**”) replaces the 1995 EU Data Protection Di... - [General API scraping](general-api-scraping.md): **Learn the benefits and drawbacks of API scraping, how to locate an API, how to utilize its features, and how to wor... - [General resource access](general-resource-access.md): Some resources, like storages, Actor runs or Actor builds, can be shared simply by sending their unique resource ID o... - [Apify General Terms and Conditions](general-terms-and-conditions-2024.md): Effective date: May 14, 2024 - [Apify General Terms and Conditions October 2022](general-terms-and-conditions-october-2022.md): You are reading terms and conditions that are no longer effective. If you're a new user, the [latest terms](https://d... - [Apify General Terms and Conditions](general-terms-and-conditions.md): Effective date: January 12, 2026 - [Generating fingerprints](generating-fingerprints.md): **Learn how to use two super handy npm libraries to generate fingerprints and inject them into a Playwright or Puppet... - [Geolocation](geolocation.md): **Learn about the geolocation techniques to determine where requests are coming from, and a bit about how to avoid be... - [Getting links from HTML with Node.js](getting-links.md): **In this lesson, we'll locate and extract links to individual product pages. We'll use Cheerio to find the relevant ... - [Getting started with Apify API](getting-started.md): The Apify API provides programmatic access to the [Apify platform](https://docs.apify.com). The API is organized arou... - [GitHub integration](github.md): **Learn how to integrate your Apify Actors with GitHub. This article shows you several possible integrations.** - [Why a glossary?](glossary.md): **Browse important web scraping concepts, tools and topics in succinct articles explaining common web development ter... - [Gmail integration](gmail.md): **Learn how to integrate your Apify Actors with Gmail. This article shows you how to automatically send an email with... - [Google ADK integration](google-adk.md): **Learn how to integrate Apify Actors as tools for AI with Agent Development Kit (ADK).** - [Google SERP proxy](google-serp-proxy.md): **Learn how to collect search results from Google Search-powered tools. Get search results from localized domains in ... - [GraphQL scraping](graphql-scraping.md): **Dig into the topic of scraping APIs which use the latest and greatest API technology - GraphQL. GraphQL APIs are ve... - [Gumloop integration](gumloop.md): With the Gumloop Apify integration you can retrieve key data for your AI-powered workflows in a flash. - [How to handle blocked requests in PuppeteerCrawler](handle-blocked-requests-puppeteer.md): One of the main defense mechanisms websites use to ensure they are not scraped by bots is allowing only a limited num... - [Handling migrations](handling-migrations.md): **Get real-world experience of maintaining a stateful object stored in memory, which will be persisted through migrat... - [Handling pagination](handling-pagination.md): **Learn about the three most popular API pagination techniques and how to handle each of them when scraping an API wi... - [Haystack integration](haystack.md): **Learn how to integrate Apify with Haystack to work with web data in the Haystack ecosystem.** - [Headless browsers](headless-browser.md): **Learn how to scrape the web with a headless browser using only a few lines of code. Chrome, Firefox, Safari, Edge -... - [How Actor monetization works](how-actor-monetization-works.md): **You can turn your web scrapers into a source of income by publishing them on Apify Store. Learn how it's done and w... - [How Apify Store works](how-store-works.md): **Out of thousands of Actors on [Apify Store](https://apify.com/store) marketplace, most of them were created by deve... - [How to build Actors](how-to-build-actors.md): At Apify, we try to make building web scraping and automation straightforward. You can customize our universal scrape... - [How to create a great input schema](how-to-create-a-great-input-schema.md): Optimizing your input schema. Learn to design and refine your input schema with best practices for a better user expe... - [How to create an Actor README](how-to-create-an-actor-readme.md): **Learn how to write a comprehensive README to help users better navigate, understand and run public Actors in Apify ... - [How to save screenshots from puppeteer](how-to-save-screenshots-puppeteer.md): A good way to debug your puppeteer crawler in Apify Actors is to save a screenshot of a browser window to the Apify k... - [Using the organization account](how-to-use.md): **Learn to use and manage your organization account using the Apify Console or API. View the organizations you are in... - [How to fix 'Target closed' error in Puppeteer and Playwright](how-to-fix-target-closed.md): **Learn about common causes for the 'Target closed' error in browser automation and what you can do to fix it.** - [HTML elements](html-elements.md): An HTML element is a building block of an HTML document. It is used to represent a piece of content on a web page, su... - [HTTP cookies](http-cookies.md): **Learn a bit about what cookies are, and how they are utilized in scrapers to appear logged-in, view specific data, ... - [HTTP headers](http-headers.md): **Understand what HTTP headers are, what they're used for, and three of the biggest differences between HTTP/1.1 and ... - [IFTTT integration](ifttt.md): **Connect Apify Actors with IFTTT to automate workflows using Actor run events, data queries, and task actions.** - [Importance of Actor URL](importance-of-actor-url.md): **Actor URL (or technical name, as we call it), is the page URL of the Actor shown on the web. When you're creating a... - [Apify API client for JavaScript](index.md): * [Reference](https://docs.apify.com/api/v2) - [Initialization and setting up](initializing-and-setting-up.md): **When you extract links from a web page, you often end up with a lot of irrelevant URLs. Learn how to filter the lin... - [Injecting code](injecting-code.md): **Learn how to inject scripts prior to a page's load (pre-injecting), as well as how to expose functions to be run at... - [Input and output](input-and-output.md): **Configure your Actor's input parameters using Apify Console, locally or via API. Access parameters in key-value sto... - [How to write Actor input schema](input-schema.md): **Learn how to generate a user interface on the platform for your Actor's input with a single file - the INPUT\_SCHEM... - [Managing Actor inputs and outputs](inputs-outputs.md): **Learn to accept input into your Actor, process it, and return output. This concept applies to Actors in any languag... - [Insomnia](insomnia.md): **Learn about Insomnia, a valuable tool for testing requests and proxies when building scalable web scrapers.** - [Gumloop - Instagram Actor integration](instagram.md): Get Instagram profile posts, details, stories, reels, post comments and hashtags, users, and tagged posts in Gumloop. - [Installation](installation.md): Copy for LLM - [Integrate with Apify](integrate.md): If you are building a service and your users could benefit from integrating with Apify or vice versa, we would love t... - [Integrating Actors via API](integrating-actors-via-api.md): **Learn how to integrate with other Actors and tasks using the Apify API.** - [Integrating Scrapy projects](integrating-scrapy.md): Copy for LLM - [Integrating webhooks](integrating-webhooks.md): **Learn how to integrate webhooks into your Actors. Webhooks are a super powerful tool, and can be used to do almost ... - [Creating integration Actors](integration-ready-actors.md): **Learn how to create Actors that are ready to be integrated with other Actors and tasks.** - [Integration with data libraries](integration-with-data-libraries.md): Copy for LLM - [Integrations](integrations.md): **Learn how to integrate the Apify platform with other services, your systems, data pipelines, and other web automati... - [Interacting with a page](interacting-with-a-page.md): **Learn how to programmatically do actions on a page such as clicking, typing, and pressing keys. Also, discover a co... - [Interacting with other Actors](interacting-with-other-actors.md): Copy for LLM - [Introduction](introduction.md): **Start learning about web scraping, web crawling, data extraction, and popular tools to start developing your own sc... - [Introspection](introspection.md): **Understand what introspection is, and how it can help you understand a GraphQL API to take advantage of the feature... - [Handle Actor issues](issues-tab.md): **Once you publish your Actor in Apify Store, it opens the door to new users, feedback, and… issue reports. Users can... - [How to scrape hidden JavaScript objects in HTML](js-in-html.md): **Learn about "hidden" data found within the JavaScript of certain pages, which can increase the scraper reliability ... - [Keboola integration](keboola.md): **Integrate your Apify Actors with Keboola, a cloud-based data integration platform that consolidates data from vario... - [Kestra integration](kestra.md): **Connect Apify with Kestra to orchestrate workflows — run flows, extract structured data, and react to Actor or task... - [Delete store](key-value-store-delete.md): DELETE - [Get store](key-value-store-get.md): GET - [Get list of keys](key-value-store-keys-get.md): GET - [Update store](key-value-store-put.md): PUT - [Delete record](key-value-store-record-delete.md): DELETE - [Get record](key-value-store-record-get.md): GET - [Check if a record exists](key-value-store-record-head.md): HEAD - [Store record](key-value-store-record-put.md): PUT - [Key-value store schema specification](key-value-store-schema.md): **Learn how to define and present your key-value store schema to organize records into collections.** - [Key-value store](key-value-store.md): **Store anything from Actor or task run results, JSON documents, or images. Learn how to access and manage key-value ... - [Get list of key-value stores](key-value-stores-get.md): GET - [Create key-value store](key-value-stores-post.md): POST - [🦜🔗 LangChain integration](langchain.md): **Learn how to integrate Apify with LangChain, in order to feed vector databases and LLMs with data crawled from the ... - [Langflow integration](langflow.md): **Learn how to integrate Apify with Langflow to run complex AI agent workflows.** - [🦜🔘➡️ LangGraph integration](langgraph.md): **Learn how to build AI Agents with Apify and LangGraph.** - [Web scraping basics for JavaScript devs (old)](legacy.md): **Learn how to develop web scrapers with this comprehensive and practical course. Go from beginner to expert, all in ... - [Apify Legal](legal.md): **Apify Technologies s.r.o.**Registered seat: Vodickova 704/36, 110 00 Prague 1, Czech RepublicVAT ID: CZ... - [Lindy integration](lindy.md): **Learn how to integrate your Apify Actors with Lindy.** - [List of permissions](list-of-permissions.md): **Learn about the access rights you can grant to other users. See a list of all access options for Apify resources su... - [LlamaIndex integration](llama-index.md): **Learn how to integrate Apify with LlamaIndex to feed vector databases and LLMs with data crawled from the web.** - [Make - LLMs Actor integration](llm.md): Apify Scraper for LLMs from [Apify](https://apify.com) is a web browsing module for OpenAI Assistants, RAG pipelines,... - [Local Actor development](locally.md): **Create your first Actor locally on your machine, deploy it to the Apify platform, and run it in the cloud.** - [Locating API endpoints](locating-and-learning.md): **Learn how to effectively locate a website's API endpoints, and learn how to use them to get the data you want faste... - [Locating HTML elements with Node.js](locating-elements.md): **In this lesson we'll locate product data in the downloaded HTML. We'll use Cheerio to find those HTML elements whic... - [Get log](log-get.md): GET - [Logging into a website](logging-into-a-website.md): **Understand the "login flow" - logging into a website, then maintaining a logged in status within different browser ... - [Logging](logging.md): Copy for LLM - [Logs - Introduction](logs.md): The API endpoints described in this section are used the download the logs generated by Actor builds and runs. Note t... - [Make integration](make.md): **Learn how to integrate your Apify Actors with Make.** - [Manage tasks for reusable input](manage-tasks-for-reusable-input.md): Copy for LLM - [Managing source code](managing-source-code.md): **Learn how to manage your Actor's source code more efficiently by integrating it with a GitHub repository. This is s... - [Managing source](managing-source.md): **View in-depth answers for all three of the quiz questions that were provided in the corresponding lesson about mana... - [Dataset Map and Reduce methods](map-and-reduce.md): Copy for LLM - [Gumloop - Google maps Actor integration](maps.md): Search, extract, and enrich business data from Google Maps in Gumloop. - [Mastra MCP integration](mastra.md): **Learn how to build AI agents with Mastra and Apify Actors MCP Server.** - [Apify MCP server](mcp.md): The Apify's MCP server ([mcp.apify.com](https://mcp.apify.com)) allows AI applications and agents to interact with th... - [Metamorph](metamorph.md): **The metamorph operation transforms an Actor run into the run of another Actor with a new input.** - [Migration guide](migration-guide.md): **Migrate your Actor to limited permissions, review common migration paths, code examples, and solutions to common is... - [Migrations & maintaining state](migrations-maintaining-state.md): **Learn about what Actor migrations are and how to handle them properly so that the state is not lost and runs can sa... - [Milvus integration](milvus.md): **Learn how to integrate Apify with Milvus (Zilliz) to save data scraped from websites into the Milvus vector databas... - [Anti-scraping mitigation](mitigation.md): **After learning about the various different anti-scraping techniques websites use, learn how to mitigate them with a... - [ModHeader](modheader.md): **Discover a super useful Chrome extension called ModHeader, which allows you to modify your browser's HTTP request h... - [Modifying variables](modifying-variables.md): **Learn how to modify the variables of a JSON format GraphQL query to use the API without needing to write any GraphQ... - [Modularity](modularity.md): **Before you build your first web scraper with Crawlee, it is important to understand the concept of modularity in pr... - [Monetize your Actor](monetize.md): **Learn how you can monetize your web scraping and automation projects by publishing Actors to users in Apify Store.** - [Monetizing your Actor](monetizing-your-actor.md): **Learn how you can monetize your web scraping and automation projects by publishing Actors to users in Apify Store.** - [Monitoring](monitoring.md): **Learn how to continuously make sure that your Actors and tasks perform as expected and retrieve correct results. Re... - [Scrape website in parallel with multiple Actor runs](multiple-runs-scrape.md): **Learn how to run multiple instances of an Actor to scrape a website faster. This tutorial will guide you through th... - [n8n integration](n8n.md): **Connect Apify with n8n to automate workflows by running Actors, extracting structured data, and responding to Actor... - [Name your Actor](name-your-actor.md): **Apify's standards for Actor naming. Learn how to choose the right name for scraping and automation Actors and how t... - [Nested clients](nested-clients.md): Copy for LLM - [Extracting data with Node.js](node-continued.md): **Continue learning how to create a web scraper with Node.js and Cheerio. Learn how to parse HTML and print the resul... - [Scraping with Node.js](node-js-scraper.md): **Learn how to use JavaScript and Node.js to create a web scraper, plus take advantage of the Cheerio and Got-scrapin... - [Tutorials on scraping with Node.js](node-js.md): **A collection of various Node.js tutorials on scraping sitemaps, optimizing your scrapers, using popular Node.js web... - [Apify open source](open-source.md) - [OpenAI Agents SDK integration](openai-agents.md): The *OpenAI Agents Python SDK* enables you to build AI agents powered by OpenAI's language models that can use tools,... - [OpenAI Assistants integration](openai-assistants.md): **Learn how to integrate Apify with OpenAI Assistants to provide real-time search data and to save them into OpenAI V... - [How to optimize and speed up your web scraper](optimizing-scrapers.md): **We all want our scrapers to run as cost-effective as possible. Learn how to think about performance in the context ... - [Organization account](organization-account.md): **Create a specialized account for your organization to encourage collaboration and manage permissions. Convert an ex... - [Actor output schema](output-schema.md): **Learn how to define and present the output of your Actor.** - [Overview](overview.md): Copy for LLM - [Page methods](page-methods.md): **Understand that the Page object has many different methods to offer, and learn how to use two of them to capture a ... - [II - Opening & controlling a page](page.md): **Learn how to create and open a Page with a Browser, and how to use it to visit and programmatically interact with a... - [Paginating through results](paginating-through-results.md): **Learn how to paginate through results on websites that use either pagination based on page numbers or dynamic lazy ... - [Pagination](pagination.md): Copy for LLM - [Parasite SEO](parasite-seo.md): **Do you want to attract more users to your Actors? Consider parasite SEO, a non-conventional method of ranking that ... - [Using Parsel with Impit](parsel-impit.md): Copy for LLM - [Parsing HTML with Node.js](parsing-html.md): **In this lesson we'll look for products in the downloaded HTML. We'll use Cheerio to turn the HTML into objects whic... - [Passing input to Actor](passing-input-to-actor.md): Copy for LLM - [Pay per event](pay-per-event.md): **Learn how to monetize your Actor with pay-per-event (PPE) pricing, charging users for specific actions like Actor s... - [Pay per result](pay-per-result.md): **Learn how to monetize your Actor with pay-per-result (PPR) pricing, charging users based on the number of results p... - [Performance](performance.md): **Learn how to get the maximum value out of your Actors, minimize costs, and maximize results.** - [Permissions](permissions.md): **Learn how to declare and manage permissions for your Actor, what permission levels mean, and how to build secure, t... - [Pinecone integration](pinecone.md): **Learn how to integrate Apify with Pinecone to feed data crawled from the web into the Pinecone vector database.** - [Using a scraping platform with Node.js](platform.md): **In this lesson, we'll deploy our application to a scraping platform that automatically runs it daily. We'll also us... - [Playwright crawler](playwright-crawler.md): Copy for LLM - [Using Playwright](playwright.md): Copy for LLM - [Charge events in run](post-charge-run.md): POST - [Resurrect run](post-resurrect-run.md): POST - [Postman](postman.md): **Learn about Postman, a valuable tool for testing requests and proxies when building scalable web scrapers.** - [Pricing and costs](pricing-and-costs.md): **Learn how to set Actor pricing and calculate your costs, including platform usage rates, discount tiers, and profit... - [Apify Privacy Policy](privacy-policy.md): Last Updated: February 10, 2025 - [Professional scraping](pro-scraping.md): **Learn how to build scrapers quicker and get better and more robust results by using Crawlee, an open-source library... - [How to process data in Python using Pandas](process-data-using-python.md): **Learn how to process the resulting data of a web scraper in Python using the Pandas library, and how to visualize t... - [Processing the same page multiple times with different setups in Web Scraper](processing-multiple-pages-web-scraper.md): Sometimes you need to process the same URL several times, but each time with a different setup. For example, you may ... - [Product Hunt](product-hunt.md): Product Hunt is one of the best platforms for introducing new tools, especially in the tech community. It attracts a ... - [Programming interface](programming-interface.md): **Learn about the programming interface of Apify Actors, important commands and features provided by the Apify SDK, a... - [Setting up your project](project-setup.md): **Create a new project with npm and Node.js. Install necessary libraries, and test that everything works before start... - [Proxies](proxies.md): **Learn all about proxies, how they work, and how they can be leveraged in a scraper to avoid blocking and other anti... - [Proxy Management](proxy-management.md): Copy for LLM - [Proxy](proxy.md): **Learn to anonymously access websites in scraping/automation jobs. Improve data outputs and efficiency of bots, and ... - [Proxyman](proxyman.md): **Learn about Proxyman, a tool for viewing all network requests that are coming through your system. Filter by respon... - [Publish your Actor](publish.md): **Prepare your Actor for Apify Store with a description and README file, and learn how to make your Actor available t... - [Publishing and monetization](publishing.md): **Apify provides a platform for developing, publishing, and monetizing web automation solutions called Actors. This g... - [Puppeteer crawler](puppeteer-crawler.md): Copy for LLM - [Puppeteer and Playwright course](puppeteer-playwright.md): **Learn in-depth how to use two of the most popular Node.js libraries for controlling a headless browser - Puppeteer ... - [Puppeteer recursive crawl](puppeteer-recursive-crawl.md): Copy for LLM - [This scraping tutorial will go into the nitty gritty details of extracting data from **https://apify.com/store** using **Puppeteer Scraper** (apify/puppeteer-scraper). If you arrived here from the Getting started with Apify scrapers, tutorial, great! You are ready to continue where we left off. If you haven't seen the Getting started yet, check it out, it will help you learn about Apify and scraping in general and set you up for this tutorial, because this one builds on topics and code examples discussed there.](puppeteer-scraper.md): This scraping tutorial will go into the nitty gritty details of extracting data from **[ - [Puppeteer with proxy](puppeteer-with-proxy.md): Copy for LLM - [Tutorials on scraping with Python](python.md): **A collection of various Python tutorials to aid you in your journey to becoming a master web scraping and automatio... - [Qdrant integration](qdrant.md): **Learn how to integrate Apify with Qdrant to transfer crawled data into the Qdrant vector database.** - [Actor quality score](quality-score.md): The Actor quality score is a metric that evaluates your Actor's performance across multiple dimensions, including rel... - [Querying elements](querying-css-selectors.md): `document.querySelector()`and`document.querySelectorAll()`are JavaScript functions that allow you to select elemen... - [Quick JavaScript Switcher](quick-javascript-switcher.md): **Discover a handy tool for disabling JavaScript on a certain page to determine how it should be scraped. Great for d... - [Actor development quick start](quick-start.md): **Create your first Actor using the Apify Web IDE or locally in your IDE.** - [Rate-limiting](rate-limiting.md): **Learn about rate-limiting, a common tactic used by websites to avoid a large and non-human rate of requests coming ... - [IV - Reading & intercepting requests](reading-intercepting-requests.md): **You can use DevTools, but did you know that you can do all the same stuff (plus more) programmatically? Read and in... - [Recap of data extraction basics](recap-extraction-basics.md): **Review our e-commerce website scraper and refresh our memory about its code and the programming techniques we used ... - [apify-client](reference.md): * [**ActorListSortBy](https://docs.apify.com/api/client/js/api/client/js/reference/enum/ActorListSortBy.md) - [Relative URLs](relative-urls.md): **Learn about absolute and relative URLs used on web pages and how to work with them when parsing HTML with Cheerio i... - [Rental pricing model](rental.md): **Learn how to monetize your Actor with the rental pricing model, offering users a free trial and a flat monthly fee,... - [Request labels and how to pass data to other requests](request-labels-in-apify-actors.md): Are you trying to use Actors for the first time and don't know how to deal with the request label or how to pass data... - [Delete request queue](request-queue-delete.md): DELETE - [Get request queue](request-queue-get.md): GET - [Get head](request-queue-head-get.md): GET - [Get head and lock](request-queue-head-lock-post.md): POST - [Update request queue](request-queue-put.md): PUT - [Delete request](request-queue-request-delete.md): DELETE - [Get request](request-queue-request-get.md): GET - [Delete request lock](request-queue-request-lock-delete.md): DELETE - [Prolong request lock](request-queue-request-lock-put.md): PUT - [Update request](request-queue-request-put.md): PUT - [Delete requests](request-queue-requests-batch-delete.md): DELETE - [Add requests](request-queue-requests-batch-post.md): POST - [List requests](request-queue-requests-get.md): GET - [Add request](request-queue-requests-post.md): POST - [Unlock requests](request-queue-requests-unlock-post.md): POST - [Request queue](request-queue.md): **Queue URLs for an Actor to visit in its run. Learn how to share your queues between Actor runs. Access and manage r... - [Get list of request queues](request-queues-get.md): GET - [Create request queue](request-queues-post.md): POST - [Request Storage](request-storage.md): Copy for LLM - [Residential proxy](residential-proxy.md): **Achieve a higher level of anonymity using IP addresses from human users. Access a wider pool of proxies and reduce ... - [Result Storage](result-storage.md): Copy for LLM - [Retries](retries.md): Copy for LLM - [Retrieve Actor data](retrieve-actor-data.md): Copy for LLM - [How to retry failed requests](retry-failed-requests.md): **Learn how to re-scrape only failed requests in your run.** - [Robotic process automation](robotic-process-automation.md): **Learn the basics of robotic process automation. Make your processes on the web and other software more efficient by... - [Rotating proxies/sessions](rotating-proxies.md): **Learn firsthand how to rotate proxies and sessions in order to avoid the majority of the most common anti-scraping ... - [Run Actor and retrieve data via API](run-actor-and-retrieve-data-via-api.md): **Learn how to run an Actor/task via the Apify API, wait for the job to finish, and retrieve its output data. Your ke... - [Run a web server on the Apify platform](running-a-web-server.md): **A web server running in an Actor can act as a communication channel with the outside world. Learn how to set one up... - [Running Actors locally](running-actors-locally.md): Copy for LLM - [Running webserver in your Actor](running-webserver.md): Copy for LLM - [Running Actors](running.md): **In this section, you learn how to run Apify Actors using Apify Console or programmatically. You will learn about th... - [Runs and builds](runs-and-builds.md): **Learn about Actor builds and runs, their lifecycle, sharing, and data retention policy.** - [Runs](runs.md): **Learn about Actor runs, how to start them, and how to manage them.** - [Saving results to CSV](save-to-csv.md): **Learn how to save the results of your scraper's collected data to a CSV file that can be opened in Excel, Google Sh... - [Saving data with Node.js](saving-data.md): **In this lesson, we'll save the data we scraped in the popular formats, such as CSV or JSON. We'll use the json2csv ... - [Saving run stats](saving-stats.md): **Implement the saving of general statistics about an Actor's run, as well as adding request-specific statistics to d... - [Saving useful run statistics](saving-useful-stats.md): **Understand how to save statistics about an Actor's run, what types of statistics you can save, and why you might wa... - [Delete schedule](schedule-delete.md): DELETE - [Get schedule](schedule-get.md): GET - [Get schedule log](schedule-log-get.md): GET - [Update schedule](schedule-put.md): PUT - [Get list of schedules](schedules-get.md): GET - [Create schedule](schedules-post.md): POST - [Schedules - Introduction](schedules.md): This section describes API endpoints for managing schedules. - [How to scrape data in Python using Beautiful Soup](scrape-data-python.md): **Learn how to create a Python Actor and use Python libraries to scrape, process and visualize data extracted from th... - [Scraping Amazon](scraping-amazon.md): **Build your first web scraper with Crawlee. Let's extract product information from Amazon to give you an idea of wha... - [Web scraping basics for JavaScript devs](scraping-basics-javascript.md): **Learn how to use JavaScript to extract information from websites in this practical course, starting from the absolu... - [Web scraping basics for JavaScript devs](scraping-basics-javascript2.md): **Learn how to use JavaScript to extract information from websites in this practical course, starting from the absolu... - [Web scraping basics for Python devs](scraping-basics-python.md): **Learn how to use Python to extract information from websites in this practical course, starting from the absolute b... - [How to scrape from sitemaps](scraping-from-sitemaps.md): Processing sitemaps automatically with Crawlee - [Scraping iFrames](scraping-iframes.md): **Extracting data from iFrames can be frustrating. In this tutorial, we will learn how to scrape information from iFr... - [How to scrape sites with a shadow DOM](scraping-shadow-doms.md): **The shadow DOM enables isolation of web components, but causes problems for those building web scrapers. Here's a w... - [Scraping data](scraping-the-data.md): **Learn how to add data extraction logic to your crawler, which will allow you to extract data from all the websites ... - [Scraping a list of URLs from a Google Sheets document](scraping-urls-list-from-google-sheets.md): You can export URLs from [Google Sheets](https://workspace.google.com/products/sheets/) such as [this one](https://do... - [Scraping product variants with Node.js](scraping-variants.md): **In this lesson, we'll scrape the product detail pages to represent each product variant as a separate item in our d... - [Using Scrapy](scrapy.md): Copy for LLM - [Apify SDK](sdk.md) - [Search the documentation](search.md) - [Secret input](secret-input.md): **Learn about making some Actor input fields secret and encrypted. Ideal for passing passwords, API tokens, or login ... - [Security](security.md): **Learn more about Apify's security practices and data protection measures that are used to protect your Actors, thei... - [Using Selenium](selenium.md): Copy for LLM - [SEO](seo.md): SEO means optimizing your content to rank high for your target queries in search engines such as Google, Bing, etc. S... - [Session Management](session-management.md): Copy for LLM - [Setting up](setting-up.md): Copy for LLM - [Account settings](settings.md): **Learn how to manage your Apify account, configure integrations, create and manage organizations, and set notificati... - [Setup](setup.md): **Configure your organization account by inviting new members and assigning their roles. Manage team members' access ... - [Single and collection clients](single-and-collection-clients.md): Copy for LLM - [Sitemaps vs search](sitemaps-vs-search.md): The core crawling problem comes to down to ensuring that we reliably find all detail pages on the target website or i... - [Agentic payments with Skyfire](skyfire.md): Agentic payments enable AI agents to autonomously run Apify Actors using third-party payment providers, without requi... - [Slack integration](slack.md): **Learn how to integrate your Apify Actors with Slack. This article guides you from installation through to automatin... - [Social media](social-media.md): **Social media is a powerful way to connect with your Actor users and potential users. Whether your tool focuses on w... - [Solutions](solutions.md): **View all of the solutions for all of the activities and tasks of this course. Please try to complete each task on y... - [Source code](source-code.md): **Learn about the Actor's source code placement and its structure.** - [Source types](source-types.md): **Learn about Apify Actor source types and how to deploy an Actor from GitHub using CLI or Gist.** - [Standby mode](standby.md): **Use Actors as an API server for fast response times.** - [State persistence](state-persistence.md): **Learn how to maintain an Actor's state to prevent data loss during unexpected restarts. Includes code examples for ... - [Actor status badge](status-badge.md): The Actor status badge can be embedded in the README or documentation to show users the current status and usage of y... - [Status messages](status-messages.md): **Learn how to use custom status messages to inform users about an Actor's progress.** - [Datasets - Introduction](storage-datasets.md): This section describes API endpoints to manage Datasets. - [Key-value stores - Introduction](storage-key-value-stores.md): This section describes API endpoints to manage Key-value stores. Key-value store is a simple storage for saving and r... - [Requests locks - Introduction](storage-request-queues-requests-locks.md): This section describes API endpoints to create, manage, and delete request locks within request queues. - [Requests - Introduction](storage-request-queues-requests.md): This section describes API endpoints to create, manage, and delete requests within request queues. - [Request queues - Introduction](storage-request-queues.md): This section describes API endpoints to create, manage, and delete request queues. - [Working with storages](storages.md): Copy for LLM - [Get list of Actors in store](store-get.md): GET - [Apify Store Publishing Terms and Conditions December 2022](store-publishing-terms-and-conditions-december-2022.md): You are reading terms and conditions that are no longer effective. If you're a new user, the [latest terms](https://d... - [Apify Store Publishing Terms and Conditions](store-publishing-terms-and-conditions.md): Last updated: January 11, 2026 - [Store - Introduction](store.md): [Apify Store](https://apify.com/store) is home to thousands of public Actors available to the Apify community. The AP... - [Streaming resources](streaming-resources.md): Copy for LLM - [Submitting a form with a file attachment](submitting-a-form-with-a-file-attachment.md): **Understand how to download a file, attach it to a form using a headless browser in Playwright or Puppeteer, then su... - [Submitting a form with file attachment](submitting-form-with-file-attachment.md): When doing web automation with Apify, it can sometimes be necessary to submit an HTML form with a file attachment. Th... - [Submitting forms on .ASPX pages](submitting-forms-on-aspx-pages.md): Apify users sometimes need to submit a form on pages created with ASP.NET (URL typically ends with .aspx). These page... - [support](support.md): Copy for LLM - [SwitchyOmega](switchyomega.md): **Discover SwitchyOmega, a Chrome extension to manage and switch between proxies, which is extremely useful when test... - [System events in Apify Actors](system-events.md): **Learn about system events sent to your Actor and how to benefit from them.** - [Tasks & storage](tasks-and-storage.md): **Understand how to save the configurations for Actors with Actor tasks. Also, learn about storage and the different ... - [Actor tasks](tasks.md): **Create and save reusable configurations of Apify Actors tailored to specific use cases.** - [Anti-scraping techniques](techniques.md): **Understand the various common (and obscure) anti-scraping techniques used by websites to prevent bots from accessin... - [Telegram integration through Zapier](telegram.md): **Learn how to integrate your Apify Actors with Telegram through Zapier.** - [Telemetry](telemetry.md): Copy for LLM - [Automated testing](test.md): **Apify has a QA system that regularly runs automated tests to ensure that all Actors in the store are functional.** - [Gumloop - TikTok Actor integration](tiktok.md): Get TikTok hashtag videos, profile videos, followers, video details, and search results in Gumloop. - [Tips and tricks for robustness](tips-and-tricks-robustness.md): **Learn how to make your automated processes more effective. Avoid common web scraping and web automation pitfalls, f... - [Tools](tools.md): **Discover a variety of tools that can be used to enhance the scraper development process, or even unlock doors to ne... - [Troubleshooting](troubleshooting.md): Copy for LLM - [What's this section?](tutorials.md): **Learn about various different specific topics related to web-scraping and web-automation with the Apify Academy tut... - [Two-factor authentication setup](two-factor-authentication.md): **Learn about Apify Console's account two-factor authentication process and how to set it up.** - [Setting up a TypeScript project](type-script-actor.md): Copy for LLM - [Upgrading to v1](upgrading-to-v1.md): Copy for LLM - [Upgrading to v2](upgrading-to-v2.md): Copy for LLM - [Upgrading to v3](upgrading-to-v3.md): Copy for LLM - [Usage and resources](usage-and-resources.md): **Learn about your Actors' memory and processing power requirements, their relationship with Docker resources, minimu... - [Proxy usage](usage.md): **Learn how to configure and use Apify Proxy. See the required parameters such as the correct username and password.** - [Use Apify via API from PHP](use-apify-from-php.md): Apify's [RESTful API](https://docs.apify.com/api/v2#) allows you to use the platform from basically anywhere. Many pr... - [User-Agent Switcher](user-agent-switcher.md): **Learn how to switch your User-Agent header to different values in order to monitor how a certain site responds to t... - [Get public user data](user-get.md): GET - [Get private user data](users-me-get.md): GET - [Get limits](users-me-limits-get.md): GET - [Update limits](users-me-limits-put.md): PUT - [Get monthly usage](users-me-usage-monthly-get.md): GET - [Users - Introduction](users.md): The API endpoints described in this section return information about user accounts. - [Using the Apify API & JavaScript client](using-api-and-client.md): **Learn how to interact with the Apify API directly through the well-documented RESTful routes, or by using the propr... - [Finding elements with DevTools](using-devtools.md): **Learn how to use browser DevTools, CSS selectors, and JavaScript via the DevTools console to extract data from a we... - [Using proxies](using-proxies.md): **Learn how to use and automagically rotate proxies in your scrapers by using Crawlee, and a bit about how to obtain ... - [Using man-in-the-middle proxy to intercept requests in Puppeteer](using-proxy-to-intercept-requests-puppeteer.md): Sometimes you may need to intercept (or maybe block) requests in headless Chrome / Puppeteer, but`page.setRequestInt... - [Using storage & creating tasks](using-storage-creating-tasks.md): **Q: What is the relationship between Actors and tasks?** - [Using your own proxies](using-your-own-proxies.md): **Learn how to use your own proxies while using the Apify platform.** - [Actor input schema specification](v1.md): **Learn how to define and validate a schema for your Actor's input with code examples. Provide an autogenerated input... - [Apify API](v2.md): Download OpenAPI - [Dataset validation](validation.md): **Specify the dataset schema within the Actors so you can add monitoring and validation at the field level.** - [Environment variables](vars.md): Copy for LLM - [🔺 Vercel AI SDK integration](vercel-ai-sdk.md): **Learn how to integrate Apify Actors as tools for AI with Vercel AI SDK.** - [Video tutorials](video-tutorials.md): **Videos and live streams are powerful tools for connecting with users and potential users, especially when promoting... - [Waiting for dynamic content](waiting-for-dynamic-content.md): Use these helper functions to wait for data: - [Waiting for elements and events](waiting.md): **Learn the importance of waiting for content and events before running interaction or extraction code, as well as th... - [Web IDE](web-ide.md): **Create your first Actor using the web IDE in Apify Console.** - [This scraping tutorial will go into the nitty gritty details of extracting data from **https://apify.com/store** using **Web Scraper** (apify/web-scraper). If you arrived here from the Getting started with Apify scrapers, tutorial, great! You are ready to continue where we left off. If you haven't seen the Getting started yet, check it out, it will help you learn about Apify and scraping in general and set you up for this tutorial, because this one builds on topics and code examples discussed there.](web-scraper.md): This scraping tutorial will go into the nitty gritty details of extracting data from **[ - [Web scraping basics for JavaScript devs](web-scraping-for-beginners.md): **Learn how to develop web scrapers with this comprehensive and practical course. Go from beginner to expert, all in ... - [Delete webhook](webhook-delete.md): DELETE - [Get webhook dispatch](webhook-dispatch-get.md): GET - [Get list of webhook dispatches](webhook-dispatches-get.md): GET - [Get webhook](webhook-get.md): GET - [Update webhook](webhook-put.md): PUT - [Test webhook](webhook-test-post.md): POST - [Get collection](webhook-webhook-dispatches-get.md): GET - [Get list of webhooks](webhooks-get.md): GET - [Create webhook](webhooks-post.md): POST - [Webhook dispatches - Introduction](webhooks-webhook-dispatches.md): This section describes API endpoints to get webhook dispatches. - [Webhooks - Introduction](webhooks-webhooks.md): This section describes API endpoints to manage webhooks. - [Webhook integration](webhooks.md): **Learn how to integrate multiple Apify Actors or external systems with your Actor or task run. Send alerts when your... - [Webinars](webinars.md): Webinars and live streams are a fantastic way to connect with your audience, showcase your Actor's capabilities, and ... - [n8n - Website Content Crawler by Apify](website-content-crawler.md): Website Content Crawler from [Apify](https://apify.com/apify/website-content-crawler) lets you extract text content f... - [When to use Puppeteer Scraper](when-to-use-puppeteer-scraper.md): You may have read in the [Web Scraper](https://apify.com/apify/web-scraper) readme or somewhere else at Apify that [P... - [Apify Whistleblowing Policy](whistleblowing-policy.md): \[verze v českém jazyce níže] - [Why publish Actors on Apify](why.md): Publishing Actors on Apify Store transforms your web scraping and automation code into revenue-generating products wi... - [Windmill integration](windmill.md): **Use Windmill to run Apify Actors and tasks, react to Apify events via webhooks or polling, and move data between Ap... - [Workato integration](workato.md): **Learn how to integrate your Apify Actors with Workato for automated workflows.** - [Your Apify Store bio](your-store-bio.md): To help our community showcase their talents and projects, we introduced public profile pages for developers. On a de... - [Gumloop - YouTube Actor integration](youtube.md): Get YouTube search results, video details, channel videos, playlists, and channel metadata in Gumloop. - [Zapier integration](zapier.md): **Learn how to integrate your Apify Actors with Zapier.**