Output schema demo

Empty TypeScript template

Start a new web scraping project quickly and easily in TypeScript (Node.js) with our empty project template. It provides a basic structure for the Actor with Apify SDK and allows you to easily add your own functionality.

Included features

• Apify SDK - a toolkit for building Actors
• Crawlee - web scraping and browser automation library

How it works

Insert your own code between await Actor.init() and await Actor.exit(). If you would like to use the Crawlee library simply uncomment its import import { CheerioCrawler } from '@crawlee/cheerio';.

Input

The Actor produces its output (key-value files and datasets) immediately, then keeps running so you can open the live view. Two optional fields control its lifecycle:

Field	Type	Default	Description
liveViewDelaySecs	integer (seconds)	0	How long to wait after the run starts before the live view becomes available. 0 starts it right away.
maxRunTimeSecs	integer (seconds)	0	Total run-time cap, measured from run start (the live-view delay counts towards it). The Actor stops itself once reached. 0 runs indefinitely until you press Stop in the live view or abort the run.

Both default to 0, which preserves the original behavior: the live view starts immediately and the run lives on until you stop it manually.

Resources

• TypeScript vs. JavaScript: which to use for web scraping?
• Node.js tutorials in Academy
• Video guide on getting scraped data using Apify API
• Integration with Airbyte, Make, Zapier, Google Drive, and other apps
• A short guide on how to build web scrapers using code templates:

Getting started

For complete information see this article. To run the Actor use the following command:

$apify run

Deploy to Apify

Connect Git repository to Apify

If you've created a Git repository for the project, you can easily connect to Apify:

1. Go to Actor creation page
2. Click on Link Git Repository button

Push project on your local machine to Apify

You can also deploy the project on your local machine to Apify without the need for the Git repository.

1. Log in to Apify. You will need to provide your Apify API Token to complete this action.

   $apify login
   

2. Deploy your Actor. This command will deploy and build the Actor on the Apify Platform. You can find your newly created Actor under Actors -> My Actors.

   $apify push
   

Documentation reference

To learn more about Apify and Actors, take a look at the following resources:

• Apify SDK for JavaScript documentation
• Apify SDK for Python documentation
• Apify Platform documentation
• Join our developer community on Discord