# E-commerce Scraping Tool (`bornoo/e-commerce-scraping-tool`) Actor

E-commerce Scraping Tool extracts product data including title, price, image, rating, and product URL from online stores and category pages. Built with Python, it supports custom start URLs, item limits, and structured dataset outputs for price monitoring, catalog tracking, and market research.

- **URL**: https://apify.com/bornoo/e-commerce-scraping-tool.md
- **Developed by:** [Biddut Hossain](https://apify.com/bornoo) (community)
- **Categories:** E-commerce
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $11.00 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## E-commerce Scraping Tool

E-commerce Scraping Tool extracts product data including title, price, image, rating, and product URL from online stores and category pages. Built with Python, it supports custom start URLs, item limits, and structured dataset outputs for price monitoring, catalog tracking, and market research.

### What does this Actor do?

Given a list of product or category page URLs, this Actor:

1. Fetches each page over HTTP.
2. Parses the HTML with BeautifulSoup.
3. Extracts key product fields: `title`, `price`, `image`, `rating`, and `url`.
4. Pushes each extracted item to the Actor's default dataset.
5. Stops once `maxItems` products have been scraped.

### Input

| Field | Type | Required | Description |
|---|---|---|---|
| `startUrls` | array | Yes | List of product/category URLs to scrape. |
| `maxItems` | integer | No | Maximum number of products to extract (default: `50`). |
| `proxyConfiguration` | object | No | Apify Proxy configuration to avoid IP blocking. |

Example input:

```json
{
  "startUrls": [
    { "url": "https://example.com/category/shoes" },
    { "url": "https://example.com/product/12345" }
  ],
  "maxItems": 100
}
```

### Output

Each scraped product is stored as a record in the default dataset, e.g.:

```json
{
  "url": "https://example.com/product/12345",
  "title": "Running Shoes - Model X",
  "price": "$59.99",
  "image": "https://example.com/images/shoe.jpg",
  "rating": "4.5"
}
```

You can export results from the **Storage → Dataset** tab in JSON, CSV, Excel, or XML format, or via the Apify API.

### Customizing selectors

The CSS selectors in `src/main.py` (`.product-title`, `.price`, etc.) are generic placeholders. Since every e-commerce site has different HTML markup, open the target site, inspect the product elements in your browser's dev tools, and update the selectors in `scrape_page()` accordingly.

### Project structure

```
.actor/
  actor.json          # Actor metadata
  input_schema.json    # Input UI schema
src/
  __init__.py
  main.py              # Scraping logic
Dockerfile
requirements.txt
README.md
```

### Local development notes

This Actor is designed to be built and run directly from the Apify Console web editor — no local terminal required. Just paste/upload these files into the Console's code editor for your Actor, click **Build**, then **Start**.

### Resources

- [Apify Python SDK docs](https://docs.apify.com/sdk/python)
- [Apify Actor input schema docs](https://docs.apify.com/platform/actors/development/actor-definition/input-schema)

# Actor input Schema

## `startUrls` (type: `array`):

List of e-commerce product or category page URLs to scrape.

## `maxItems` (type: `integer`):

Maximum number of products to extract before the run stops.

## `proxyConfiguration` (type: `object`):

Select proxies to be used by your scraper.

## Actor input object example

```json
{
  "startUrls": [
    {
      "url": "https://example.com/category/shoes"
    }
  ],
  "maxItems": 50,
  "proxyConfiguration": {
    "useApifyProxy": true
  }
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "startUrls": [
        {
            "url": "https://example.com/category/shoes"
        }
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("bornoo/e-commerce-scraping-tool").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "startUrls": [{ "url": "https://example.com/category/shoes" }] }

# Run the Actor and wait for it to finish
run = client.actor("bornoo/e-commerce-scraping-tool").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "startUrls": [
    {
      "url": "https://example.com/category/shoes"
    }
  ]
}' |
apify call bornoo/e-commerce-scraping-tool --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,bornoo/e-commerce-scraping-tool"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/WdEU61nUaZ0dkBtbW/builds/0hBISBj9ssmzMMIv7/openapi.json
