# Apify documentation

This document provides detailed documentation for the Apify web scraping and automation platform. You might also want to check out the following resources:

*   [**Video tutorials**](https://www.youtube.com/apify) - step-by-step video tutorials for beginners
*   [**Help center**](https://help.apify.com/) - examples, tutorials and various tips & tricks
*   [**Stack Overflow**](https://stackoverflow.com/questions/tagged/apify) - community questions

Anything missing? Please let us know at [support@apify.com](mailto:support@apify.com)

## [](#table-of-contents)Table of contents

*   [**Scraping**](/scraping) - Scrape and crawl websites using a few simple lines of JavaScript.
*   [**Actors**](/actors) - Run arbitrary web scraping or automation tasks in the Apify cloud.
*   [**Tasks**](/actors/tasks) - Store one or more configurations of an Actor.
*   [**Schedules**](/schedules) - Executes crawler or actor jobs at specific times.
*   [**Storage**](/storage) - Key-value store, dataset and request queue that enable storage of actor inputs and results.
*   [**Proxy**](/proxy) - Provides access to proxy services that can be used in crawlers, actors or any other application that support HTTP proxies.
*   [**Webhooks**](/webhooks) - Provide an easy and reliable way to configure the Apify platform to carry out an action when a certain system event occurs.
*   [**API**](/api) - REST API that enables integration with external applications.
*   [**SDK**](https://sdk.apify.com) - Open-source libraries to simplify development of local web scraping and automation projects, crawl websites with headless Chrome and Puppeteer, simplify development of Apify actors and integrate with the Apify API.
*   [**CLI**](/cli) - Command line interface (CLI) to help you to create, develop, run and deploy Apify actors from your local computer.



Documentation of the Apify platform, which includes detailed descriptions of Apify Actors, Storage, Proxy, and API.

gHB/cqAAescmPhmWgRCuw2oi/u6p4Bb1uBSZ9Zbq+h4=

Introduction

47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=

Step-by-step tutorial that will help you get started with all Apify Scrapers.

Getting started

Getting started with Apify Scrapers

m9vaN2PzzDK1jbyIAvs6coFyK2HxrCiT7B4hWYvoA+c=

Step by step tutorial that will help you create a page function for Web Scraper.

Web Scraper

Step by step tutorial that will help you create a page function for Cheerio Scraper.

Cheerio Scraper

Step by step tutorial that will help you create a page function for Puppeteer Scraper.

Puppeteer Scraper

FjAu14zMbmZU/H3YpU+LyJTXRrcu08tL0uUV+8vAYGg=

Scraping documentation is a hub for all your web scraping and crawling needs.

Scraping

jr4YX2wRCj+eizNwrh+GV8KnjRj3yRDNvxNmt/g4wos=

Documentation of Apify actors - serverless computing jobs that enable execution of long-running web scraping and automation tasks in the cloud.

Quick start

klPckyzGLQkH169D7TZhOjBqtKrfhw/gnRayWODwdo4=

Input and output

X37qUrmqWb45OqstEcfCxf/cKGJcyGvdb2H68JBMFeo=

Running

wwNDqYvek0KeAWZW8OufhKLlqyeRH+ehc97HvGGJ1oA=

Documentation of Apify Task - a way to set up configuration of your Apify Actor for simplified usage.

Configure

d6TQvlwys4aLEYRr6jd6z0eD3jK5Z9YbRrLB3iDf3xE=

Create

S87dynVsMwG52LgS79qb/FKw8BQ1iWbFSHFFi1BXlvo=

azZeecXZiroIuRgn3djNxqsTid37jiuL45x0uEipGGY=

Tasks

TKDtk1ILsXAS6De0thBFX//LctPadYixDtmu0S8Cr1I=

Documentation of Apify actors - options for Docker images to use as your actor's base.

Base Docker images

CLr0v5iIyYQzSrNJL5EGISpmeG2Jjq5UcPRe5qy/shQ=

Documentation of Apify actors - determining your actor's context using environment variables.

Environment variables

e2Hzxs8Z9MG1izldEshWXw+pgMpafZe2k+xIeUaNePc=

Documentation of Apify actors - defining your actor's input schema.

Input schema

JBqVmz1kpqptayTyXh256cVYPE7kNrNG02tz3iIVVSs=

Documentation of Apify actors - building your actor.

Builds

EzanS6POCy3g7jtrwv2C6naW2ZUMyNrQk9OXCkhwDMY=

Documentation of Apify actors - storing your actor's source code.

Source code

s/jYrxF2je6yYWrHElU2SwDA4OAFkrgwfZcU260YdiY=

Documentation of Apify actors - persisting your actor's state.

State persistence

mZ2JVTFXpT4oWs9P+DV3/PWKt4ytJ6D33UJEssrrViQ=

Development

x1JsB/OGKiBn7mMIeJveoP8KcEgz3JxpCE9+zUlTal8=

Documentation of Apify's standards for actor naming.

Naming your actor

OFRFawh3HO64uOvjgeHu/EBSzb62zA3nPgGTLGTNONI=

Optimize your actors' title, description, and README to get more relevant visits from Google and other search engines.

SEO for actors

M5pTjvF1KGho7ET5UNAq1hQWN6h1fSXLU64DxlVsHVU=

Publishing

JquS//dbbBI78gothu2Cj4C8iGrsjoHb4HseuGKzXwI=

Security

x7aa1doe4g9REq5zCJLdrX+fl2LOZLv5wAJ+pr4yDfA=

Limits

QyyTaVWGT2UtVR5Yd5AsQOVwi8vbzPKNSloRYltzOAg=

Examples

/O7+Vyq5cdEw9uYbQyCGInFriCJ+I/1p1xDaDLP9q04=

Learn about Apify Actors - the easy way to develop, run and share serverless cloud programs.

Actors

w/UTr1Aucyt8vvIjYR5NHDX3mbrfpY1plo4MUiFj5po=

Documentation of Apify Schedules, which run actors or tasks at specific times using cron-like syntax.

Schedules

drGEclTv+IawI/mWj6wezmyV8sSv3/uC/e/QsD0XmyE=

Documentation of Apify simple key-value store that enables storage of Actor inputs and results.

Key-value store

5FAm9ouPErfdfaboTpTfWfTePG6HZC/7VaQs02c8U9c=

Dataset

9c8YxCR++StCJU4DHda2bAFVOuna38Dg1niXkvS6Xo0=

Request queue

Er/F+2k/plJC3AhEu+GP/M2a761zQOg0Eiqajl6ULFw=

Storage

rvOedSK613vtP4yk0wUf70h9EXMwGYqWJOBHAPuw9mE=

Documentation of Apify Proxy that enables anonymization of access to websites and IP rotation.

Connection settings

QflS3ivuNrdmWBACONXjYiQj0rocnp1LpnltqJHYl5Y=

NodeJS Examples

uElFiQ5m+dzNOTwKFdS7Q/SvhsUQZ7CmC30fBz8dXSs=

PHP Examples

MlHBxn+xCYer60ScHzb3AOCJ9sHptow7eYmJbthNf3I=

Python Examples

xYKHBaHSGEZwUWyzG1wo3gsm8+ePTD2Ppr7fxEZ3m9E=

Datacenter proxy

IYL7JrFDLMWrIt55y0BNFXNSU4qS2evbTueMxuw5oE0=

RQuahEbBESzT+4T2FITm96eAPQ0y9//to4ngETYAbAU=

kwTIWqSsK1bfgdhn1GWHQOmnJAf3/E3HU0oRmQglLZk=

9Ol3rWRjXvmFqj2qKELmZyxWEUBJlIWTmb2djbgtsmY=

Tips and tricks

ECYXknlz/NezvnH7XL8Mc/zgW6SNxMnV28hbygIDW6c=

Residential proxy

vJOQbZx1z78hVsoRvu8zgWV7s/fDaVPm6mc3a6mEq18=

H+byXPJKn+0M4ZF5MeY9p/BtvXmGVzMAdjHxQWmPjY0=

q53gTkGkPr+/L1X9nIossUphpQdZsU2tvJueXQPCEs0=

pIZo514leRqezyIiPo0mfBvJ38D7a3T3AITGWqWHNDU=

Google SERP proxy

iiMzdwcCnEOnNDEoa/dDpFb9Z25098dct4uyJunFtf4=

Troubleshooting

A6DXwDBDwpww9kbevzRTLVha1AUgG5dpW6KxkOSzaqk=

Proxy

2XiHk00zvt/Cqb7N61jyLIZVtm06/vCDrMdXdMvZu6A=

Documentation of Apify webhooks system that enables integration of multiple actors or external systems.

Events

elU/r39enGm2+iakNZRZyuH9Lfi5crQ8Gmi5FFxXCW4=

Actions

vQW7QIts1nzeOlcXRjL2T7sRR6SeIiCHa3oXvL7L+5g=

Ad hoc webhooks

dXO0mGGdFlTX/hIrqTQNorCa7Sfrpeyauf+VJsm85kc=

Webhooks

j08/fe9Y7oVALlqlujbrMxtWawXAzvnE0Q/nAfM19Pk=

Documentation of access rights and publication on the Apify platform.

Access rights

/B/QfHzFHAguylu7cP7DDIY7YIt4umkT45FlQzlyw4Y=

Documentation of the Apify REST API (version 2), which enables you to manage, build and run actors, and manage associated resources like storage.

API reference

Nqnn8clbgv+5l0PgxcTOldg8mkMKrFn4TvPL+rYUUGg=

Full documentation of the latest version of the apify-client NPM package, which simplifies access to the Apify API using JavaScript / Node.js

JavaScript API client

AbpHGcgLb+kRsJGnwFEktk7uzpZOCcBY74+YBdrKVGs=

Apify command line interface (CLI) helps you to create, develop, run and deploy Apify Actor acts from your local computer.

/K+XZb0s9aUfYFcyp95y1ZA9EveEYA9ichh6lALpI8c=