DocumentationScraping APIIntroduction

Introduction

The Scrapeless Scraping API is an innovative solution designed to simplify the extraction of data from websites with ease. Engineered to navigate even the most intricate web environments, it effectively manages dynamic content and JavaScript rendering.

With a single API call you get instant access to clean, structured data — no proxies, browsers, or CAPTCHA handling to write or maintain on your side.

Available Scrapers

Each scraper is exposed through the same API, selected with the actor parameter. Start with a scraper below:

ScraperactorDescription
Google Searchscraper.google.searchReal-time Google Search and Google Image results as structured JSON.
Amazon Scraperscraper.amazonProduct details, search results, offers, and reviews from Amazon.
TikTok Scraperscraper.tiktokProduct details, search results, offers, and reviews from Tiktok.

Getting Started

Send a single API call to extract structured data from a target site. The example below submits a task and, for longer-running tasks, polls until the result is ready.

import { Scrapeless } from '@scrapeless-ai/sdk';
const client = new Scrapeless({
  apiKey: 'YOUR_API_KEY',
});
 
async function runTask() {
  const result = await client.scraping.scrape({
    actor: 'scraper.shopee',
    input: {
      url: 'https://shopee.tw/a-i.10228173.24803858474'
    }
  });
 
  return result;
}
 
runTask()
  .then(data => {
    console.log('Data:', data);
  })
  .catch(error => {
    console.error('Error:', error);
  });

Parameters

ParameterTypeDescription
actorstringScraping service (e.g., scraper.shopee).
inputobjectTask-specific parameters (e.g., action, url).
proxyobjectOptional proxy configuration with country field.

Task Workflow

Every Scraping API task follows the same three-step lifecycle. Fast tasks return data directly; longer-running tasks switch to an asynchronous, poll-for-results flow.

  1. Submit a Task — Send a POST request to /api/v1/scraper/request.
  2. Handle the Response
    1. HTTP 200 (Success): Data is returned directly in the response body.
    2. HTTP 201 (Processing): Use the provided taskId to poll for results.
  3. Poll for Results — For asynchronous tasks, repeatedly call /api/v1/scraper/result/{taskId} until data is ready (HTTP 200).

For the full list of status codes and polling guidance, see Results and Polling. To receive results via a callback instead of polling, see Webhooks.

Billing Information

  1. Charges are applied on a per-request basis.
  2. Only successful requests will be billed.