# WordPress Scraper (`jupri/wordpress`) Actor

💫 Scrape  WordPress and  Woocommerce websites

- **URL**: https://apify.com/jupri/wordpress.md
- **Developed by:** [cat](https://apify.com/jupri) (community)
- **Categories:** E-commerce, News
- **Features:** Full permissions
- **Stats:** 455 total users, 3 monthly users, 92.2% runs succeeded, 4 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

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

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## 💫 Welcome to WooCommerce Scraper

<img height="32" src="https://apify.com/actor-badge?actor=jupri~woocommerce" align="right">

![dont be sad readme is here](https://raw.githubusercontent.com/JupriGH/resources/main/cats/catframe.png)

### 🛒 About WooCommerce

<img src="https://upload.wikimedia.org/wikipedia/commons/d/d8/WooCommerce2025_logo.svg" height="128">

<img src="https://upload.wikimedia.org/wikipedia/commons/2/2a/WooCommerce_logo.svg" height="128" align="right">

**WooCommerce** is an [open-source](https://en.wikipedia.org/wiki/Open-source_software "Open-source software")  [e-commerce](https://en.wikipedia.org/wiki/E-commerce "E-commerce")  [plugin](https://en.wikipedia.org/wiki/Plug-in_\(computing\) "Plug-in (computing)") for [WordPress](https://en.wikipedia.org/wiki/WordPress "WordPress"). It is designed for small to large-sized online [merchants](https://en.wikipedia.org/wiki/Merchants "Merchants") using WordPress. Launched on September 27, 2011,[\[3\]](https://en.wikipedia.org/wiki/WooCommerce#cite_note-3) the plugin quickly became popular for its simplicity to install and customize and for the market position of the base product as freeware (even though many of its optional extensions are paid and proprietary). WooCommerce is developed and supported by Woo and includes contributions from a global community of developers.[\[4\]](https://en.wikipedia.org/wiki/WooCommerce#cite_note-4)

### 🛒 About This Actor

💫 Scrape WordPress or WooCommerce Websites

### 🛒 Tutorial

#### Input Parameters

| Name | Type | Description |
|-|-|-|
| `url` | ***array*** | List of `URL` |
| `resource` | ***string*** | Resource type to scrape |
| `limit` | ***integer*** | Number of results |
| `filters` | ***object*** | Search filters |

#### Supported URL

| Type | Examples |
|-|-|
| Homepage URL | `https://www.woocommerce.com`
| Category URL | `https://woocommerce.com/product-category/themes/arts-and-crafts/`
| Brands URL |  `https://woocommerce.com/brands/apify/`
| Product URL | `https://woocommerce.com/products/woopayments/`
| *etc.*

### 🛒 Input Examples

**Scrape product list**

```yaml
{ "url": ["https://www.woocommerce.com"], "limit": 100, "resource": "products" }
```

**Scrape specific products info**

```yaml
{ "url": ["https://woocommerce.com/products/woopayments/"] }
```

**Scrape category list**

```yaml
{ "url": ["https://www.woocommerce.com"], "limit": 20, "resource": "categories" }
```

### 🛒 Support

<img src="https://apify-uploads-prod.s3.us-east-1.amazonaws.com/5SxZhwYwpknFk8ek9-cat.gif" width="240">

Feel free to [reach out](https://console.apify.com/actors/XX8HRK0M62EEfpwNe/issues) to the developer for any issues or suggestions for improvement.

# Actor input Schema

## `url` (type: `array`):

💡 Where do you want to Shop ?

## `limit` (type: `integer`):

Number of results (per-query)

## `resource` (type: `string`):

No description

## `include_variations` (type: `boolean`):

No description

## `format` (type: `string`):

💡 Output format for Descriptions. <code>(default: Markdown)</code>

## `sort` (type: `string`):

Sort results by attribute

## `order` (type: `string`):

Order sort direction

## `search` (type: `string`):

💡 Limit results to those matching a string.

## `sku` (type: `string`):

💡 Limit result set to products with specific SKU(s). Use commas to separate.

## `rating` (type: `array`):

No description

## `min_price` (type: `integer`):

Limit result set to products based on a price.

## `max_price` (type: `integer`):

No description

## `tax_class` (type: `string`):

Limit result set to products with a specific tax class.

## `category` (type: `string`):

Product Category ID(s) separated by comma

## `tag` (type: `string`):

Product Tag ID(s) separated by comma

## `product_type` (type: `string`):

Products assigned a specific type

## `status` (type: `string`):

No description

## `stock` (type: `string`):

No description

## `featured` (type: `boolean`):

Featured products

## `sale` (type: `boolean`):

Products on sale

## `dev_proxy_config` (type: `object`):

💡 <b>Supported protocol:</b><br><br><b>HTTP(S), SOCKS5</b><br><code>{http|socks5}://{user:pass}@{hostname|ip-address}:port</code><br><br><b>Example</b>: <code>socks5://example.com:9000</code>

## `dev_custom_headers` (type: `array`):

💡 Additional HTTP Headers

## `dev_custom_cookies` (type: `array`):

💡 Additional HTTP Cookies

## `dev_transform_fields` (type: `array`):

💡 <b>Transform the resulting output. Select only needed fields.</b><br><br>For nested object use <b>DOT</b>. For example: <pre>address.streetAddress</pre><br>For nested array use <b>NUMBER</b> <i>(index of array element starting from index=0)</i>. For example: <pre>images.0.url</pre>

## `dev_dataset_name` (type: `string`):

💡 <b>Save results into custom named Dataset, use mask to customize dataset name</b><br><br><code>{ACTOR} = actor name<br>{DATE} = date (YYYYMMDD)<br>{TIME} = time (HHMMSS)</code><br><br>This masks can be used to autogenerate Dataset Name.<br><br>example: <i><code>data-{DATE}</code></i><br>Depending on today date the dataset name will be: <code>data-20230603</code><i><br><br>default: <code>data-{ACTOR}-{DATE}-{TIME}</code></i>

## `dev_dataset_clear` (type: `boolean`):

Clear Dataset before insert/update.

## `dev_no_strip` (type: `boolean`):

💡 Keep/Save empty values <i><code>(NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)</code></i>

## `dev_fileupload` (type: `string`):

💡 Upload your file and copy & paste the URL somewhere.

## Actor input object example

```json
{
  "url": [
    "https://woocommerce.com"
  ],
  "limit": 5
}
```

# 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 = {
    "url": [
        "https://woocommerce.com"
    ],
    "limit": 5
};

// Run the Actor and wait for it to finish
const run = await client.actor("jupri/wordpress").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 = {
    "url": ["https://woocommerce.com"],
    "limit": 5,
}

# Run the Actor and wait for it to finish
run = client.actor("jupri/wordpress").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 '{
  "url": [
    "https://woocommerce.com"
  ],
  "limit": 5
}' |
apify call jupri/wordpress --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,jupri/wordpress"
        }
    }
}
```

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/bHXadeC20monIjqzm/builds/5JUUhwnkvAklGBTGu/openapi.json
