{
  "openapi": "3.0.1",
  "info": {
    "title": "Price & Stock Monitor for Shopify Stores: Competitor Tracking",
    "description": "Monitor competitors' Shopify stores: new and removed products, price drops and rises, sales started or ended, back in stock, sold out since your last run, with an HTML report. Prices, stock, variants and SKUs per product. Obeys robots.txt. $0.50 per 1,000 products + $0.002 per store read. Free demo.",
    "version": "0.1",
    "x-build-id": "9X8DlXE4F7q1q5IJu"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/wisekit~product-price-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-wisekit-product-price-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/wisekit~product-price-monitor/runs": {
      "post": {
        "operationId": "runs-sync-wisekit-product-price-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/wisekit~product-price-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-wisekit-product-price-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": [
          "storeUrls"
        ],
        "properties": {
          "storeUrls": {
            "title": "Store URLs or domains",
            "type": "array",
            "description": "Required. The online stores to read, one per line. Any of these work: a bare domain (\"allbirds.com\"), a full URL (\"https://www.allbirds.com\"), a collection URL (\"https://kith.com/collections/footwear\": reads only that collection) or a product URL (\"https://example.com/products/blue-shirt\": outputs only that product, found in the store's product feed). Several URLs from the same store are combined, and two domains that lead to the same store are read once. Up to 50 stores per run (1 on the Apify free plan). Each store's robots.txt is read first and obeyed; stores that block us, are password protected or aren't Shopify stores are reported and not charged (products already read before a store stops responding are still delivered and charged). Agent example: {\"storeUrls\":[\"allbirds.com\",\"kith.com/collections/footwear\"]}.",
            "items": {
              "type": "string"
            }
          },
          "monitorName": {
            "title": "Monitor name (to see changes between runs)",
            "type": "string",
            "description": "Optional. Give the monitor any name, e.g. \"competitors\", and use the same name on every run (for example on a daily schedule). The first run saves every product as the baseline; each later run marks products as new, removed, price up or down (old → new, % change), back in stock or sold out, and adds a change report. The saved state lives in a key-value store named \"product-monitor-<name>\" in your own Apify account. The name needs at least one letter a-z or digit 0-9; a name without any stops the run with an error before anything is read or charged. Leave empty for a one-off snapshot."
          },
          "onlyChanges": {
            "title": "Only output changed products",
            "type": "boolean",
            "description": "Only with a monitor name, on runs after the first: output only products that are new, removed or changed (price, stock, sale or variants), so unchanged products are neither output nor charged (the store read, $0.002 per started 1,000 products read, still applies). The first run of a monitor always outputs every product as the baseline. Default: false (output every product with its change info).",
            "default": false
          },
          "maxProductsPerStore": {
            "title": "Max products per store",
            "minimum": 1,
            "maximum": 25000,
            "type": "integer",
            "description": "The most products read from each store (1 to 25,000). Default 1,000. Each product is one dataset row ($0.0005) and each started 1,000 products read is one store read ($0.002), so this also caps the cost: 1,000 products ≈ $0.50 per store. On slow stores the store read is counted per started 30 seconds of reading time if that is more: the time spent on requests that worked plus the pause between requests (1 second, or the Crawl-delay the store's robots.txt asks for); waits after HTTP 429 or errors, failed requests and writing rows are not counted. For product URLs, this is how far into the store's catalogue to look. Apify free-plan accounts are limited to 100 products per run.",
            "default": 1000
          },
          "collectionHandles": {
            "title": "Only these collections (optional)",
            "type": "array",
            "description": "Optional. Collection handles to read instead of the whole store, e.g. \"mens-shoes\" (the part after /collections/ in the store's URL). Applies to every store given as a plain domain. Leave empty to read the whole catalogue. Some stores' robots.txt disallow collection product feeds; those are skipped and listed in the summary. Entries that aren't handles (for example \"..\") are ignored; if no entry is a valid handle the run stops with an error before anything is read or charged.",
            "items": {
              "type": "string"
            }
          },
          "includeDescription": {
            "title": "Include product descriptions (HTML)",
            "type": "boolean",
            "description": "Add each product's description as HTML (\"descriptionHtml\"). Off by default: descriptions make rows much larger and are rarely needed for price and stock monitoring.",
            "default": false
          },
          "demoMode": {
            "title": "Free demo (no requests, no charge)",
            "type": "boolean",
            "description": "Tick to see sample output for free: a fictional store read twice from bundled data, with new and removed products, price drops and rises, back in stock and sold out, plus the HTML change report. No store is contacted and nothing is charged; other fields are ignored. Rows are labelled \"demo\": true. Agent example: {\"storeUrls\":[\"demo\"],\"demoMode\":true}.",
            "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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}