Apify SDK for JavaScript

Copy for LLM

The Apify SDK for JavaScript is the official library for creating Apify Actors using JavaScript or TypeScript. It provides useful features like Actor lifecycle management, local storage emulation, and Actor event handling.

import { Actor } from 'apify';

await Actor.init();

const input = await Actor.getInput();
console.log(input);

await Actor.exit();

What are Actors

Actors are serverless cloud programs capable of performing tasks in a web browser, similar to what a human can do. These tasks can range from simple operations, such as filling out forms or unsubscribing from services, to complex jobs like scraping and processing large numbers of web pages.

Actors can be executed locally or on the Apify platform. The Apify platform lets you run Actors at scale and provides features for monitoring, scheduling, publishing, and monetizing them.

Quick start

To create and run Actors using Apify Console, check out Apify Console documentation. For creating and running JavaScript Actors locally, refer to the Apify platform guide.

Explore the Examples section to see the SDK in action, and refer to the guide section for a deeper understanding of the SDK's features and best practices.

Installation

The Apify SDK for JavaScript is typically installed when you create a new Actor project using the Apify CLI. To install it manually in an existing project, use:

npm install apify

API client alternative

If you need to interact with the Apify API programmatically without creating Actors, use the Apify API client for JavaScript instead.