Web Scraper avatar

Web Scraper

Try for free

No credit card required

View all Actors
Web Scraper

Web Scraper

apify/web-scraper
Try for free

No credit card required

Crawls arbitrary websites using the Chrome browser and extracts data from pages using JavaScript code. The Actor supports both recursive crawling and lists of URLs and automatically manages concurrency for maximum performance. This is Apify's basic tool for web crawling and scraping.

Do you want to learn more about this Actor?

Get a demo

You can access the Web Scraper programmatically from your own applications by using the Apify API. You can choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.

1# Set API token
2API_TOKEN=<YOUR_API_TOKEN>
3
4# Prepare Actor input
5cat > input.json << 'EOF'
6{
7  "runMode": "DEVELOPMENT",
8  "startUrls": [
9    {
10      "url": "https://crawlee.dev"
11    }
12  ],
13  "linkSelector": "a[href]",
14  "globs": [
15    {
16      "glob": "https://crawlee.dev/*/*"
17    }
18  ],
19  "pseudoUrls": [],
20  "excludes": [
21    {
22      "glob": "/**/*.{png,jpg,jpeg,pdf}"
23    }
24  ],
25  "pageFunction": "// The function accepts a single argument: the \"context\" object.\n// For a complete list of its properties and functions,\n// see https://apify.com/apify/web-scraper#page-function \nasync function pageFunction(context) {\n    // This statement works as a breakpoint when you're trying to debug your code. Works only with Run mode: DEVELOPMENT!\n    // debugger; \n\n    // jQuery is handy for finding DOM elements and extracting data from them.\n    // To use it, make sure to enable the \"Inject jQuery\" option.\n    const $ = context.jQuery;\n    const pageTitle = $('title').first().text();\n    const h1 = $('h1').first().text();\n    const first_h2 = $('h2').first().text();\n    const random_text_from_the_page = $('p').first().text();\n\n\n    // Print some information to actor log\n    context.log.info(`URL: ${context.request.url}, TITLE: ${pageTitle}`);\n\n    // Manually add a new page to the queue for scraping.\n   await context.enqueueRequest({ url: 'http://www.example.com' });\n\n    // Return an object with the data extracted from the page.\n    // It will be stored to the resulting dataset.\n    return {\n        url: context.request.url,\n        pageTitle,\n        h1,\n        first_h2,\n        random_text_from_the_page\n    };\n}",
26  "proxyConfiguration": {
27    "useApifyProxy": true
28  },
29  "initialCookies": [],
30  "waitUntil": [
31    "networkidle2"
32  ],
33  "preNavigationHooks": "// We need to return array of (possibly async) functions here.\n// The functions accept two arguments: the \"crawlingContext\" object\n// and \"gotoOptions\".\n[\n    async (crawlingContext, gotoOptions) => {\n        // ...\n    },\n]\n",
34  "postNavigationHooks": "// We need to return array of (possibly async) functions here.\n// The functions accept a single argument: the \"crawlingContext\" object.\n[\n    async (crawlingContext) => {\n        // ...\n    },\n]",
35  "breakpointLocation": "NONE",
36  "customData": {}
37}
38EOF
39
40# Run the Actor using an HTTP API
41# See the full API reference at https://docs.apify.com/api/v2
42curl "https://api.apify.com/v2/acts/apify~web-scraper/runs?token=$API_TOKEN" \
43  -X POST \
44  -d @input.json \
45  -H 'Content-Type: application/json'

Web Scraper API

Below, you can find a list of relevant HTTP API endpoints for calling the Web Scraper Actor. For this, you’ll need an Apify account. Replace <YOUR_API_TOKEN> in the URLs with your Apify API token, which you can find under Integrations in Apify Console. For details, see the API reference .

Run Actor

POST
https://api.apify.com/v2/acts/apify~web-scraper/runs?token=<YOUR_API_TOKEN>

Note: By adding the method=POST query parameter, this API endpoint can be called using a GET request and thus used in third-party webhooks. Please refer to our Run Actor API documentation .

Run Actor synchronously and get dataset items

POST
https://api.apify.com/v2/acts/apify~web-scraper/run-sync-get-dataset-items?token=<YOUR_API_TOKEN>

Note: This endpoint supports both POST and GET request methods. However, only the POST method allows you to pass input data. For more information, please refer to our Run Actor synchronously and get dataset items API documentation .

Get Actor

GET
https://api.apify.com/v2/acts/apify~web-scraper?token=<YOUR_API_TOKEN>

For more information, please refer to our Get Actor API documentation .

Actors can be used to scrape web pages, extract data, or automate browser tasks. Use the Web Scraper API programmatically via the Apify API.

You can choose from:

You can start Web Scraper with the Apify API by sending an HTTP POST request to the Run Actor endpoint. An Actor’s input and its content type can be passed as a payload of the POST request, and additional options can be specified using URL query parameters. The Web Scraper is identified within the API by its ID, which is the creator’s username and the name of the Actor.

When the Web Scraper run finishes you can list the data from its default dataset (storage) via the API or you can preview the data directly on Apify Console .

Developer
Maintained by Apify
Actor metrics
  • 2.7k monthly users
  • 167 stars
  • 99.9% runs succeeded
  • 6.9 days response time
  • Created in Mar 2019
  • Modified about 1 month ago