# Price Detector (Experimental) (`equidem/price-detector-experimental`) Actor

- **URL**: https://apify.com/equidem/price-detector-experimental.md
- **Developed by:** [Matěj Sochor](https://apify.com/equidem) (community)
- **Categories:** E-commerce
- **Stats:** 72 total users, 0 monthly users, 0.0% runs succeeded, 1 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

## Price Detector (Experimental)
This actor implements a price detection AI model. Given a snapshot of a product detail webpage,
it will try to find the current price and the original price (if the product was discounted).
The current measured accuracy is around 95%.

Please note that this release is experimental, which is why its usage is restricted to those with our permission.
If you want to use it, email matej@apify.com.
Also, the detector is constrained to EU currencies and USD at this point. It will likely not work well for webpages containing other currencies.

### Input
There are two ways to input the product details webpage snapshots into the actor:
(for an explanation of the specific attributes, see below)
1. If you only want to detect price in a single webpage:

   ```json
   {
      "restrictionPassword": "...",
      "html": "8f24f3cdbd09780884108c2ed43bd0e4240dfd43a553779b55815c2b2a144cf0.html",
      "kvStoreId": "RexjDmnTvJcAuWLZn",
      "mhtml": "8f24f3cdbd09780884108c2ed43bd0e4240dfd43a553779b55815c2b2a144cf0.mhtml",
      "url": "https://stayclassy.no/collections/black-friday-rekord-lave-priser-i-hele-november/products/classywalk-spirallas-med-nokkel"
   }
````

2. If you need to detect it in multiple webpages in one run:

   ```json
   {
      "restrictionPassword": "...",
      "webpages": [
          {
              "html": "8f24f3cdbd09780884108c2ed43bd0e4240dfd43a553779b55815c2b2a144cf0.html",
              "kvStoreId": "RexjDmnTvJcAuWLZn",
              "mhtml": "8f24f3cdbd09780884108c2ed43bd0e4240dfd43a553779b55815c2b2a144cf0.mhtml",
              "url": "https://stayclassy.no/collections/black-friday-rekord-lave-priser-i-hele-november/products/classywalk-spirallas-med-nokkel"
          },
          {
              "url": "https://www.rdveikals.lv/products/lv/1675/451049/sort/5/filter/0_0_0_0/Dz%C4%ABv%C5%BEogu-%C5%A1%C4%B7%C4%93res-54.4-Instruments.html",
              "kvStoreId": "RO7fsSWGF9Q0gArn6",
              "html": "ee5f837b7d863a32d6088efac8433e7d3b976a8ca7ca17b6adcb5196e75830e9.html",
              "mhtml": "ee5f837b7d863a32d6088efac8433e7d3b976a8ca7ca17b6adcb5196e75830e9.mhtml"
          }
      ]
   }
   ```

As you can see, there are five input attributes:

1. **restrictionPassword** - a password required for the actor to run
2. **kvStoreId** - Id of the key value store that contains the html and mhtml snapshots (due to size restrictions, the snapshots themselves cannot be passed in the input and need to be passed through another key value store)
3. **url** - URL of the webpage being processed
4. **html** - Key to a record in the snapshot key value store that contains the page's HTML snapshot
5. **mhtml** - Key to a record in the snapshot key value store that contains the page's MHTML snapshot

### Output

Outputs are put into the default dataset of the actor run, with each row corresponding to one of the webpages on the input.
Each of those rows looks like this:

```json
{
   "url": "https://stayclassy.no/collections/black-friday-rekord-lave-priser-i-hele-november/products/classywalk-spirallas-med-nokkel",
   "currentPrice": 49,
   "referralPrice": 236,
   "currency": "NOK"
}
```

Where:

1. **url** is the webpage's url from the input
2. **currentPrice** is the price the products currently sells for
3. **referralPrice** is the price before discount (when the product is discounted)
4. **currency** is the currency (if it can be determined)

# Actor input Schema

## `restrictionPassword` (type: `string`):

A password needed to run the actor due to it being in a restricted experimental mode. If you want to try the actor, write to matej@apify.com

## `kvStoreId` (type: `string`):

Id of the key value store that contains the html and mhtml snapshots

## `url` (type: `string`):

URL of the product page

## `html` (type: `string`):

Key to a record in the snapshot key value store that contains the page's HTML snapshot

## `mhtml` (type: `string`):

Key to a record in the snapshot key value store that contains the page's MHTML snapshot

## `webpages` (type: `array`):

Use when you want to detect price in multiple webpages in one run. It should be an array of objects containing the previous four attributes. Overrides the other inputs if present.

## Actor input object example

```json
{
  "url": "https://www.directcosmetics.com/shop/product/79990"
}
```

# 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://www.directcosmetics.com/shop/product/79990"
};

// Run the Actor and wait for it to finish
const run = await client.actor("equidem/price-detector-experimental").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://www.directcosmetics.com/shop/product/79990" }

# Run the Actor and wait for it to finish
run = client.actor("equidem/price-detector-experimental").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 '{
  "url": "https://www.directcosmetics.com/shop/product/79990"
}' |
apify call equidem/price-detector-experimental --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=equidem/price-detector-experimental",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Price Detector (Experimental)",
        "version": "0.0",
        "x-build-id": "TCvazim2sKcoqJTTO"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/equidem~price-detector-experimental/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-equidem-price-detector-experimental",
                "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/equidem~price-detector-experimental/runs": {
            "post": {
                "operationId": "runs-sync-equidem-price-detector-experimental",
                "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/equidem~price-detector-experimental/run-sync": {
            "post": {
                "operationId": "run-sync-equidem-price-detector-experimental",
                "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",
                "properties": {
                    "restrictionPassword": {
                        "title": "Detector Password",
                        "type": "string",
                        "description": "A password needed to run the actor due to it being in a restricted experimental mode. If you want to try the actor, write to matej@apify.com"
                    },
                    "kvStoreId": {
                        "title": "Snapshot KVS Id",
                        "type": "string",
                        "description": "Id of the key value store that contains the html and mhtml snapshots"
                    },
                    "url": {
                        "title": "Product page URL",
                        "type": "string",
                        "description": "URL of the product page"
                    },
                    "html": {
                        "title": "HTML snapshot record key",
                        "type": "string",
                        "description": "Key to a record in the snapshot key value store that contains the page's HTML snapshot"
                    },
                    "mhtml": {
                        "title": "MHTML snapshot record key",
                        "type": "string",
                        "description": "Key to a record in the snapshot key value store that contains the page's MHTML snapshot"
                    },
                    "webpages": {
                        "title": "Inputs for multiple webpages",
                        "type": "array",
                        "description": "Use when you want to detect price in multiple webpages in one run. It should be an array of objects containing the previous four attributes. Overrides the other inputs if present."
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
