Documentation of Apify REST API version 2 that enables to manage, build and run actors, and manage associated resources like storage.

F/PUB0khfmJ1wL40kSDRcOSQnAipufsu/p+US1qmEmM=

Mold our tools any way you want to scrape websites or automate repetitive tasks. Find the solution to your task here or use the Search box above.

Home

edyhe3GwdVEfqymaiYwz5TMMaE1FhUVLCJYzozqv05c=

Learn about what Apify is and what we do. Get familiar with the platform and take you first steps in using actors.

About

47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=

Step-by-step tutorial that will help you get started with all Apify Scrapers. Learn the foundations of scraping the web with Apify and creating your own actors.

Getting started

Getting started with Apify Scrapers

m9vaN2PzzDK1jbyIAvs6coFyK2HxrCiT7B4hWYvoA+c=

Learn how to scrape a website using Apify's Web Scraper. Build an actor's page function, extract information from a web page and download your data.

Web Scraper

Learn how to scrape a website using Apify's Cheerio Scraper. Build an actor's page function, extract information from a web page and download your data.

Cheerio Scraper

Learn how to scrape a website using Apify's Puppeteer Scraper. Build an actor's page function, extract information from a web page and download your data.

Puppeteer Scraper

SqP1VXeJsZiTwNnDoTVpY0UzddApydxk5HuUlayJt8s=

Discover Apify's ready-made web scraping and automation tools. Compare Web Scraper, Cheerio Scraper and Puppeteer Scraper to decide which is right for you.

Apify scrapers

7jDiQNIYuHjYTcGyxTOiSmm9fw/OzmIw06fUINxFs6k=

Wait for dynamically loaded content when web scraping. See code examples and a detailed breakdown for setting timeouts and custom wait functions.

Scraping dynamic content

pxt0fcdldExg1evx5Hygso6//h2TuDYumWBl4syhwxo=

Learn how to perform the most common integration workflow - run the job => wait => collect data. Integrate Apify actors with your applications.

Run actor and retrieve data via API

Oqi7mAmteMeFWkkIM3baz57BTOE6fbABpgTW9vLYsW4=

Learn how to complete a website's authentication process using headless Chrome and Puppeteer. Automate the filling in of log in details and passwords.

Log into a website using Puppeteer

kyz/wAit08O1i0PsFts5zap60aMSHy4+JquMFvFZzeA=

Learn to crawl and scrape data from URLs specified in a spreadsheet with Apify scrapers. Scrape a pre-determined list of web pages with Apify actors.

Crawl a list of URLs from a Google Sheets document

/XHyk1PhMK8yAqm/xDZpWRBMjL1elLD2PAHPJa78adk=

Learn how to scrape the web and automate processes with Apify. From beginner guides for using actors to advanced topics like migrations and performance.

Tutorials

43noqfIcWYsRtAkHDLNFLZX6+P0c22LL2208gIueVOg=

An introduction to the methods you can use to extract data from websites. Analyze web pages for hidden elements to find the most effective approach.

Web scraping techniques

IFCotckGhtSdQCQRiLcVfqf5MBtdvVtuSVIZGLknoRg=

Explore the basics of web scraping prevention. Get around them with IP address rotation and proxies, emulate browser signatures or shared IP address sessions.

Anti-scraping techniques

Anti-scraping techniques and how to bypass them

fqQfccJd50xkcee4jENIqTGB/p0XWwDgXQFEGhQP9rk=

All you need to know about extracting structured data from web pages, the protections websites employ to prevent it, and how to bypass them.

Web Scraping 101

7KCNhjp7wG8RM9ikb2P7IkyL/iYKPTG5QjNxTtD8d+M=

Learn how to make your automated processes more effective. Avoid common RPA pitfalls, future-proof your programs and improve your processes.

Tips and tricks

lw2DWAUz+EmaoSDCrggi646I+UIcur9CI+0HnxioQUk=

Learn the basics of robotic process automation. Make your processes on the web and other software more efficient by automating repetitive tasks.

Robotic process automation

S83/cmGZ+wAojEPNfjpl8P7iYbAIdORGb/yiQp/x4Vo=

A step-by-step monitoring tutorial that shows how you can receive notifications when an actor or task run fails or does not return enough results.

Actor or task run failure

hzZJLgYr0GUy5kFslJ5PaigZW253Bb3DYsTdBY/xuIU=

A step-by-step monitoring tutorial that shows you how to ensure your data is correctly formatted and unique. Visualize your data using the monitoring dashboard.

Check data quality

/rv5gCsEJP3mUgbsMUXgL523PqGKuSK3WZRmFAWygpU=

A step-by-step monitoring tutorial that shows you how to monitor and ensure consistency in named datasets which aggregate data from multiple actors or tasks.

Monitor shared datasets

PzPbxSp7TGvPmfcnU3J/RTewmIVq35UP/iGSs9Fn6D4=

A step-by-step monitoring tutorial that shows you how to monitor multiple runs, validate your results and visualize them using the monitoring dashboard.

Monitor multiple tasks

5uq4bY/zX8W0imOL6spcta81rIILhPSE5+wqG+crjqc=

Learn how to check the performance of your actors, tasks and storages. Validate your data and receive notifications when your jobs succeed or fail.

Monitoring

VZcaLTNQpRhUxvVtztzPnACyZTSmmAVf1AUSFfVO/XU=

Create your first Apify actor using code examples. A step-by-step introduction to web scraping with the Apify platform.

Quick start

FTrVOVnnKP+DFZk1pTVKCne4jmBQNrf3FxnNF478f6k=

Configure your actor's input parameters using the Apify app, locally or via API. Access parameters in key-value stores from your actor's code.

Input

yXj2IT9OWntIjAB8pU3+qw6hFWFGi1JlVXQomLhlQwg=

Start your actors from the Apify app or via API. Learn about actor lifecycles, how to specify settings and version, provide input and resurrect finished runs.

Running

ZX7/VX36dZAsfPATVeiaSmWs/GmylVuCnCPuR5n6dj8=

Create custom versions of an actor for specific use cases. Set a task's name and input parameters.

Configure

gSSAgmjlZj3mx9aPZDGfqTjKDOAdGdsL4zjeWogRwMA=

Learn how to set up reusable versions of your actors for specific use cases.

Create

S87dynVsMwG52LgS79qb/FKw8BQ1iWbFSHFFi1BXlvo=

Start your actor tasks from the Apify app or via API.

xJ91kPshbfTPvcRvKTYRakas0GSf1kdqG4Zdxavd1Ms=

Set up configurations of your Apify actors for simplified usage. Create multiple configurations of the same actor tailored to various use cases.

Tasks

VLRLObi4FZSm6Oz0hidf+y042ELKxs2z4aPHam1Nnyk=

Learn about the Docker images you can use as your actor's base. Choose the correct base image for your actor's type and requirements.

Base Docker images

NZhw8cvepIJa/eAfNw+E2qEvB6qAwBzSqQMb0yENnow=

Apify's conventions for actor build numbers. Learn to use a specific version of your actor in a run, understand an actor's lifecycle and manage its cache.

Builds

5VQ4RUQ0qiN9iszlHlHSMLIOCAs4n9jO08WlLGfNkOs=

Learn how to provide your actor with context that determines its behavior.

Environment variables

CQnQNWOpcOdrgLr0uulcvpoqCyC9G0au8CZJuFag7AQ=

Learn how to define and easily validate a schema for your actor's input with code examples. Provide an autogenerated input UI to your actor's users.

Input schema

DnrddEh0m7xXsJL4cckuAUCXcqa89ItrBt7CQHieF1E=

Learn all about an Apify actor's code. Compare deployment options, create a custom Dockerfile, set environment variables and metamorph your actor.

Source code

8QM0TDQgAK4DNS3g1FhEfpNGbJiZuZqLYmzNVmWrUFw=

Maintain a long-running actor's state to protect from unexpected restarts. See a code example on how to protect your run in case of server shutdown.

State persistence

mt72vggAJM5E8GngXRiI7GZUbwuPPwPn8JpALQFS+BY=

Read about the technical part of building Apify actors. Learn to define actor inputs, build new versions, persist actor state and choose base Docker images.

Development

cpaEkpl37Hs2qAfq8G/2ttGZXtLg+tKnEOmjKFUThf0=

Apify's standards for actor naming. Learn how to choose the right name for scraping and non-scraping actors and how to optimize your actor for search engines.

Naming your actor

Az0PxSlhxsTHkirkQKDRmoKNHHLFPOI8qzmgkOEeUHg=

Optimize your actors to get more relevant visits from Google and other search engines. Set search engine-friendly actor name, title and description examples.

SEO for actors

U+/5cv/rMs+r5u22Xo8KFTQJyyMd33bNsxmMeZQO5Jo=

Learn how to make your actor available to the public or keep it private. Prepare your actor for Apify Store with a description and README file.

Publishing

1JQlRQKYYnhcBMng9Ho+KRQQvh1k8QDH7dr+jl9+1sk=

Learn more about Apify's security practices and data protection measures.

Security

Zec7v/RKM31JENADfka6icpgFTOTjrKlUHI1uM6DtSk=

Learn the Apify platform's resource capability and limitations such as max memory, disk size and number of actors/tasks per user or schedule.

Limits

W1k9Z5i+Y8Dh3D7UAkrY5S+0bfrVcbFvFL2Gu4hGV2U=

Discover the Apify platform's various features. This page contains introductory code for building actors, Dockerfiles and persisting your actor's state.

Examples

L/Zq7GCgb7kPiWKBeQM2V+lUYrzVLdgqDPgDxcTpIG8=

Learn how to develop, run and share serverless cloud programs. Create your own web scraping and automation tools and publish them on the Apify platform.

Actors

UPsea0IGuQ5t3hRy6GYnILwCbr4i2sPUbfuAY58oZdw=

Learn how to automatically start your actor and task runs and the basics of *cron* expressions. Set up and manage your schedules from the Apify app or via API.

Schedules

LmcvFId2QAn/cgigItCNFevKRNOQIVAMAnlL9eK7PzQ=

Store and export web scraping, crawling or data processing job results. Learn how to access and manage datasets in the Apify app or via API.

Dataset

Tk2QOc/seardYNAkFuRB3NMjuD2IYpuPEqDJ4AqNTSs=

Store anything from actor or task run results JSON documents or images. Learn how to access and manage key-value stores from the Apify app or via API.

Key-value store

tTy7K4wf01AxaC4FXWpEwsaTHefQZYO1hIDBMGsgjSY=

Queue URLs for an actor to visit in its run. Learn how to share your queues between actor runs. Access and manage request queues from the Apify app or via API.

Request queue

vTj9ikO1ZgQwQ/OD3JaaQpBHohZ8g6oW/7qr1kP//Xg=

Store anything from images and key-value pairs to structured output data. Learn how to access and manage your stored data from the Apify platform or via API.

Storage

98lzzH5iDJ6UdHos2kJgKmml2+8+3hdRzLXRfq6CNds=

Learn how to connect your application to Apify Proxy. See the required parameters such as the correct username and password.

Connection settings

eiH703d5yqFlzXK0Xbk6k1AvzaJ/ye7wMbJg5zKH5B8=

Learn how to connect to Apify's datacenter proxies from your application with Node.js (axios and got), Python 2 and 3 and PHP using code examples.

ZHbq9dENjS1w0Rx0UqmVNut0kJ1ZM2BntEQSoi0DoSw=

Learn how to reduce blocking when web scraping using IP address rotation. See proxy parameters and learn to implement Apify Proxy in an application.

Datacenter proxy

jJuYE776lR+DL1eDyxuNIR7bKhpu3irYhv/OoASgAO8=

Helpful tips for using your application with Apify's residential proxies. Control traffic, deal with interrupted connections and manage expenses.

knMEJsQs8k6hiJZ9Mv55x6e7aGlmffWFg+6ieIUOfUc=

Achieve a higher level of anonymity using IP addresses from human users. Access a wider pool of proxies and reduce blocking by websites' anti-scraping measures.

Residential proxy

IeDXmWIlxk1wYRjTHsAD30eHobn73ffyXZXRxEFYjSs=

Learn how to connect to Google SERP proxies from your applications with Node.js (axios and got), Python 2 and 3 and PHP using code examples.

JoTAWWzQxkXMtsx9AEuplJXqa3fU/O1lVQrW8cIs1lM=

Learn how to collect search results from Google Search-powered tools. Get search results from localized domains in multiple countries, e.g. the US and Germany.

Google SERP proxy

Om8qNXlGkYNxiDYHv+MdFvaiBiYWq0xGcqBh4cYpEhY=

Useful tips for debugging applications that use Apify Proxy. Check the status of your proxies and view information about the client IP address.

Troubleshooting

bENK6LQoIUFq5tHwRkhYpETLycTzPEEwu2uGwr4Z0w8=

Learn how to anonymously access websites when running web scraping or automation jobs. Prevent IP address-based blocking using IP address rotation.

Proxy

ivW0l5PwpDgstCHxA9EOFs99yKT46G0MCT3/+hq9oUw=

Specify the types of events that trigger a webhook in an actor or task run. Trigger an action on actor or task run creation, success or failure.

Events

vU+KkJkoy9RDlS/mTkNpmnWsv7xv+ZfOABDoxkDYDdU=

Send a notification when a specific event occurs in your actor or task run. Dynamically add data to the notification payload when sending the notification.

Actions

IBfzt4CmjCydvuOrsJ2JhSQWIcBpTq+vzP37h7QASME=

Learn how to set one-off webhooks for actor runs started via the Apify API or from the actor's code. Trigger the event once the run reaches a desired state.

Ad-hoc webhooks

D82ifEQRs6gPFNw6KTwSjQEJSTOflcFLSxJoAeMSuWQ=

Learn how to integrate multiple Apify actors or external systems with your actor or task run. Send alerts when your actor run succeeds or fails.

Webhooks

l2KN8HNOgtnYOZOp30tKNR6nC2yqmyIXxd3KCg4E/Q4=

Configure your organization account by inviting new members and assigning their roles. Manage team members' access permissions to the organization's resources.

Setup

F5a+jlLeJiaHdYBnbRwm6d4k01LqyiirGX6eOK6x1Ts=

Learn to use and manage your organization account using the Apify app or API. View the organizations you are in and manage your memberships.

How to use

0cxR0bcwxKThTr5NZLqUCAD/ESF2igHWYKOh6mrRdEE=

Create a specialized account for your organization to encourage collaboration and manage permissions efficiently. Convert an existing account or create one from scratch.

Organization account

Y567CBrY5u96rfeW4VCPbyOTdf1j9oLMZdE5gVCPyRc=

Learn about the access rights you can grant to other users. See a list of all access options for Apify resources such as actors, actor runs/tasks and storage.

List of permissions

7r+IoYov5vTv4TGI/Rcx2u1NVwaRSI5m0VuWSiqSTfc=

Manage permissions for organizations or private resources such as actors, actor runs and storages. Allow other users to read, run, modify or build new versions.

Access rights

daEdpEyAJIa8b2VkCqSKcw8PaExcB6Qro80XNes/sHA=

Manage, build and run actors, access and manage your storages with the Apify REST API (v2). Test API endpoints and create URL requests using the Blueprint GUI.

API reference

Simplified access to the Apify API from any JavaScript or Node.js application. Manage your actors, tasks and storage via API with the apify-client NPM package.

JavaScript API client

AbpHGcgLb+kRsJGnwFEktk7uzpZOCcBY74+YBdrKVGs=

Create new actors from your computer's command line. Run actors locally or deploy them to the Apify platform. View the Apify CLI's command reference.