{
  "openapi": "3.0.1",
  "info": {
    "title": "Any Store Product Monitor: Price & Stock Tracker",
    "description": "Track price, stock and variants on any online shop's product pages: Shopify, WooCommerce, Magento, BigCommerce, Wix, Squarespace and more. Changes-only monitoring for competitor price watchlists, from $2 per 1,000 products; compact JSON for AI agents.",
    "version": "0.1",
    "x-build-id": "Wn8EyKanPweVhNf0U"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/cleanpull~any-store-product-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-cleanpull-any-store-product-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/cleanpull~any-store-product-monitor/runs": {
      "post": {
        "operationId": "runs-sync-cleanpull-any-store-product-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/cleanpull~any-store-product-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-cleanpull-any-store-product-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",
        "properties": {
          "productUrls": {
            "title": "Product URLs",
            "type": "array",
            "description": "Product page addresses from any online shop, one per line: Shopify, WooCommerce, Magento, BigCommerce, Wix, Squarespace, PrestaShop, Shopware, Salesforce Commerce Cloud and custom stores. Each row gives price, stock, variants and more.",
            "items": {
              "type": "string"
            }
          },
          "sitemaps": {
            "title": "Whole stores (sitemaps)",
            "type": "array",
            "description": "Optional. A store address (brand.com) or a sitemap URL, one per line. The actor finds the store's product sitemaps (from robots.txt) and reads its product pages, up to the limit below.",
            "items": {
              "type": "string"
            }
          },
          "urlFilter": {
            "title": "Only URLs containing",
            "type": "string",
            "description": "Optional. For sitemaps: keep only product URLs containing this text (case-insensitive), or matching a /regular expression/."
          },
          "maxProductsPerSitemap": {
            "title": "Products per store",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "How many product URLs to read from each store's sitemaps.",
            "default": 100
          },
          "datasetId": {
            "title": "Dataset of products",
            "type": "string",
            "description": "Optional. Another dataset (a previous run, or another actor's results) whose rows hold product URLs. Pick it here so this actor is given read access to it; it never sees your other storages."
          },
          "datasetField": {
            "title": "Dataset field",
            "type": "string",
            "description": "The field holding the product URL in that dataset. \"url\", \"productUrl\" and \"link\" are also tried.",
            "default": "url"
          },
          "includeVariants": {
            "title": "Variants",
            "type": "boolean",
            "description": "List every variant (size, colour…) with its own price, stock, SKU and barcode where the store publishes them. On WooCommerce this can add one small request per product.",
            "default": true
          },
          "readFullPage": {
            "title": "Read the page on Shopify too",
            "type": "boolean",
            "description": "Shopify products are read from the store's product data alone (fast, small). On: also read the product page, for review ratings and anything else its markup adds.",
            "default": false
          },
          "changesOnly": {
            "title": "Changes only",
            "type": "boolean",
            "description": "Return only products that changed since the last run with the same monitor name (price, stock, sale, variants, title, image, page removed). Unchanged products cost $0.50 per 1,000. Every row always lists its changes; the first run is the baseline. Schedule it daily or hourly.",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Runs with the same name compare against each other. Use one name per watchlist.",
            "default": "default"
          },
          "changeTypes": {
            "title": "Changes to report",
            "type": "array",
            "description": "Which changes count. A product whose only changes are left out counts as unchanged.",
            "items": {
              "type": "string",
              "enum": [
                "price",
                "stock",
                "sale",
                "variants",
                "title",
                "image",
                "removed"
              ],
              "enumTitles": [
                "Price",
                "Stock state",
                "Sale started or ended",
                "Variant price, stock, added or removed",
                "Title",
                "Main image",
                "Page removed (404)"
              ]
            },
            "default": [
              "price",
              "stock",
              "sale",
              "variants",
              "title",
              "image",
              "removed"
            ]
          },
          "minPriceChangePercent": {
            "title": "Smallest price change (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Ignore price moves smaller than this percentage. 0 reports every change.",
            "default": 0
          },
          "maxItems": {
            "title": "Max products",
            "minimum": 1,
            "type": "integer",
            "description": "Optional. Stop after this many product rows."
          },
          "fields": {
            "title": "Only these fields",
            "type": "array",
            "description": "Optional. Keep only these fields, for example [\"url\", \"title\", \"price\", \"currency\", \"inStock\"].",
            "items": {
              "type": "string"
            }
          },
          "maxConcurrency": {
            "title": "Products at a time",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Products read in parallel across all stores.",
            "default": 5
          },
          "maxConcurrencyPerStore": {
            "title": "Products at a time per store",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Products read in parallel from one store. Low values are polite and avoid blocks.",
            "default": 2
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional. The actor picks proxies itself per store: direct, then datacenter, then residential only for stores that block the others."
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Optional. Accepted for compatibility with other actors: product URLs, same as Product URLs.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}