# Product Availability Monitor (`mighty_monk/product-availability-monitor`) Actor

Monitor e-commerce product URLs for stock and price changes. Supports Shopify products.json, WooCommerce pages, and schema.org Product parsing with snapshot-based change detection.

- **URL**: https://apify.com/mighty\_monk/product-availability-monitor.md
- **Developed by:** [Harsh](https://apify.com/mighty_monk) (community)
- **Categories:** E-commerce, Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 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/platform/actors/running/actors-in-store#pay-per-usage

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
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.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use 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

## Product Availability Monitor

Monitor e-commerce product URLs for **stock availability** and **price changes** across Shopify, WooCommerce, and generic schema.org storefronts. Each run returns structured JSON with change detection against the previous snapshot.

### Features

- **Multi-platform parsing** — Shopify `/products.json`, WooCommerce HTML heuristics, and schema.org `Product` JSON-LD
- **Change detection** — compares `inStock` and `price` with the previous run via KV store or `previousSnapshot` input
- **Structured output** — `url`, `inStock`, `price`, `currency`, `lastChange`, `timestamp`
- **JSON run report** — summary saved to key-value store key `OUTPUT`
- **Retries & rate limiting** — configurable `maxRequestRetries` and `maxRequestsPerMinute`
- **Logging** — per-product status and run summary in Actor logs

### Input

| Field | Type | Default | Description |
| --- | --- | --- | --- |
| `productUrls` | `object[]` | — | Product page URLs to monitor (**required**) |
| `previousSnapshot` | `object` | — | Optional URL → state map to override KV snapshot |
| `persistSnapshot` | `boolean` | `true` | Save `PRODUCT_SNAPSHOT` for the next run |
| `maxRequestRetries` | `integer` | `3` | HTTP retry count |
| `maxRequestsPerMinute` | `integer` | `30` | Request rate limit |
| `useProxy` | `boolean` | `false` | Use Apify Proxy |

#### Example input

```json
{
    "productUrls": [
        { "url": "https://shop.polymer80.com/products/pf940v2-80-textured-pistol-frame" },
        { "url": "https://woocommerce.com/products/woocommerce-subscriptions/" }
    ],
    "persistSnapshot": true,
    "maxRequestRetries": 3,
    "maxRequestsPerMinute": 30
}
````

See `examples/input.json` and `storage/key_value_stores/default/INPUT.json`.

### Output

#### Dataset (per product)

| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | Product page URL |
| `inStock` | `boolean` | Whether the product appears available |
| `price` | `number \| null` | Parsed price when available |
| `currency` | `string \| null` | ISO currency code when available |
| `lastChange` | `string` | `first_run`, `no_change`, or change description |
| `timestamp` | `string` | ISO timestamp of the check |
| `parseMethod` | `string` | `shopify`, `woocommerce`, `schema.org`, or `unknown` |
| `title` | `string \| null` | Product title when parsed |
| `error` | `string` | Present when the URL could not be monitored |

#### `lastChange` values

- `first_run` — no previous snapshot for this URL
- `no_change` — stock and price unchanged
- `inStock: false -> true; price: 29.99 -> 24.99 USD` — human-readable diff

#### Key-value store

| Key | Description |
| --- | --- |
| `OUTPUT` | JSON run report with totals and full `results` array |
| `PRODUCT_SNAPSHOT` | Snapshot used on the next scheduled run |

#### Example report (`OUTPUT`)

```json
{
    "timestamp": "2026-07-05T12:00:00.000Z",
    "totalProducts": 2,
    "changed": 1,
    "inStock": 1,
    "outOfStock": 1,
    "errors": 0,
    "results": []
}
```

See `examples/example-output.json`.

### Parsing strategy

1. **Shopify** — product URLs under `/products/` are fetched via `{url}.json` first; HTML fallback is used on failure.
2. **WooCommerce** — Woo-specific selectors plus schema.org JSON-LD on product pages.
3. **schema.org** — generic `Product` JSON-LD extraction for other storefronts.

### Scheduling

Run this Actor on a schedule (e.g. every hour). With `persistSnapshot: true`, each run automatically compares against the last successful snapshot stored in the Actor key-value store.

### Local development

```bash
npm install
npm run lint
npm run build
npm test
apify run --purge
```

### Pricing

Pay per result: **$0.003** per dataset item (`apify-default-dataset-item`).

### License

ISC

# Actor input Schema

## `productUrls` (type: `array`):

E-commerce product page URLs to monitor for stock and price changes.

## `previousSnapshot` (type: `object`):

Optional map of URL to previous product state. When omitted, the Actor loads PRODUCT\_SNAPSHOT from the key-value store.

## `persistSnapshot` (type: `boolean`):

Save the latest product states to PRODUCT\_SNAPSHOT in the key-value store for the next scheduled run.

## `maxRequestRetries` (type: `integer`):

How many times to retry a failed HTTP request before giving up.

## `maxRequestsPerMinute` (type: `integer`):

Rate limit to avoid overloading target sites.

## `useProxy` (type: `boolean`):

Enable Apify Proxy for requests. Recommended for production runs on protected storefronts.

## Actor input object example

```json
{
  "productUrls": [
    {
      "url": "https://shop.polymer80.com/products/pf940v2-80-textured-pistol-frame"
    },
    {
      "url": "https://woocommerce.com/products/woocommerce-subscriptions/"
    }
  ],
  "previousSnapshot": {},
  "persistSnapshot": true,
  "maxRequestRetries": 3,
  "maxRequestsPerMinute": 30,
  "useProxy": false
}
```

# Actor output Schema

## `results` (type: `string`):

No description

## `report` (type: `string`):

No description

## `snapshot` (type: `string`):

No description

# 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 = {
    "productUrls": [
        {
            "url": "https://shop.polymer80.com/products/pf940v2-80-textured-pistol-frame"
        },
        {
            "url": "https://woocommerce.com/products/woocommerce-subscriptions/"
        }
    ],
    "previousSnapshot": {}
};

// Run the Actor and wait for it to finish
const run = await client.actor("mighty_monk/product-availability-monitor").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 = {
    "productUrls": [
        { "url": "https://shop.polymer80.com/products/pf940v2-80-textured-pistol-frame" },
        { "url": "https://woocommerce.com/products/woocommerce-subscriptions/" },
    ],
    "previousSnapshot": {},
}

# Run the Actor and wait for it to finish
run = client.actor("mighty_monk/product-availability-monitor").call(run_input=run_input)

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

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

```

## CLI example

```bash
echo '{
  "productUrls": [
    {
      "url": "https://shop.polymer80.com/products/pf940v2-80-textured-pistol-frame"
    },
    {
      "url": "https://woocommerce.com/products/woocommerce-subscriptions/"
    }
  ],
  "previousSnapshot": {}
}' |
apify call mighty_monk/product-availability-monitor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=mighty_monk/product-availability-monitor",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Product Availability Monitor",
        "description": "Monitor e-commerce product URLs for stock and price changes. Supports Shopify products.json, WooCommerce pages, and schema.org Product parsing with snapshot-based change detection.",
        "version": "1.0",
        "x-build-id": "S5OzSUewJ0MMLW0EI"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/mighty_monk~product-availability-monitor/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-mighty_monk-product-availability-monitor",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/mighty_monk~product-availability-monitor/runs": {
            "post": {
                "operationId": "runs-sync-mighty_monk-product-availability-monitor",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/mighty_monk~product-availability-monitor/run-sync": {
            "post": {
                "operationId": "run-sync-mighty_monk-product-availability-monitor",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "required": [
                    "productUrls"
                ],
                "properties": {
                    "productUrls": {
                        "title": "Product URLs",
                        "type": "array",
                        "description": "E-commerce product page URLs to monitor for stock and price changes.",
                        "items": {
                            "type": "object",
                            "required": [
                                "url"
                            ],
                            "properties": {
                                "url": {
                                    "type": "string",
                                    "title": "URL of a web page",
                                    "format": "uri"
                                }
                            }
                        }
                    },
                    "previousSnapshot": {
                        "title": "Previous snapshot",
                        "type": "object",
                        "description": "Optional map of URL to previous product state. When omitted, the Actor loads PRODUCT_SNAPSHOT from the key-value store."
                    },
                    "persistSnapshot": {
                        "title": "Persist snapshot",
                        "type": "boolean",
                        "description": "Save the latest product states to PRODUCT_SNAPSHOT in the key-value store for the next scheduled run.",
                        "default": true
                    },
                    "maxRequestRetries": {
                        "title": "Max request retries",
                        "minimum": 0,
                        "maximum": 10,
                        "type": "integer",
                        "description": "How many times to retry a failed HTTP request before giving up.",
                        "default": 3
                    },
                    "maxRequestsPerMinute": {
                        "title": "Max requests per minute",
                        "minimum": 1,
                        "maximum": 300,
                        "type": "integer",
                        "description": "Rate limit to avoid overloading target sites.",
                        "default": 30
                    },
                    "useProxy": {
                        "title": "Use Apify Proxy",
                        "type": "boolean",
                        "description": "Enable Apify Proxy for requests. Recommended for production runs on protected storefronts.",
                        "default": false
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
