{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Product Scraper & Price Tracker",
    "description": "Scrape Amazon products, search results and Best Sellers on 10 marketplaces: typed local prices, Buy Box, offers, BSR, stock, variants and a price/rank change monitor.",
    "version": "1.0",
    "x-build-id": "zm9Zzak6GgnIQHj2p"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/cylindrical_lighthouse~amazon-products/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-cylindrical_lighthouse-amazon-products",
        "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/cylindrical_lighthouse~amazon-products/runs": {
      "post": {
        "operationId": "runs-sync-cylindrical_lighthouse-amazon-products",
        "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/cylindrical_lighthouse~amazon-products/run-sync": {
      "post": {
        "operationId": "run-sync-cylindrical_lighthouse-amazon-products",
        "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": {
          "asins": {
            "title": "ASINs or product URLs",
            "type": "array",
            "description": "Products to scrape in full (title, price, Buy Box, stock, BSR, variants, specs). Each entry is a 10-character ASIN such as `B085DVHQ57` (looked up on the marketplace chosen below) or a product URL such as `https://www.amazon.de/dp/B08T1HR5CS` (its own marketplace is used). Each product is charged as one `product` event.",
            "items": {
              "type": "string"
            }
          },
          "searchQueries": {
            "title": "Search keywords",
            "type": "array",
            "description": "Keywords to search on the chosen marketplace, exactly as you would type them into Amazon's search box, e.g. `coffee grinder`. Each result is charged as one `listing-item` event, or as one `product` event when `scrapeProductDetails` is on. Limit results with `maxResultsPerQuery`.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Amazon URLs (search, category or Best Sellers)",
            "type": "array",
            "description": "Amazon page URLs from any of the 10 supported marketplaces. Supported pages: product (`/dp/ASIN`), search or category results (`/s?k=…` or `/s?rh=n:…`) and ranking lists (`/gp/bestsellers/…`, `/gp/new-releases/…`, `/gp/movers-and-shakers/…`, `/gp/most-wished-for/…`, `/gp/most-gifted/…`, `/zgbs/…`). Example: `https://www.amazon.com/gp/bestsellers/kitchen`.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "marketplace": {
            "title": "Marketplace (for ASINs and keywords)",
            "enum": [
              "US",
              "UK",
              "DE",
              "FR",
              "IT",
              "ES",
              "CA",
              "AU",
              "JP",
              "IN"
            ],
            "type": "string",
            "description": "Amazon site used for plain ASINs and search keywords. URLs always use their own site. Prices come back in that marketplace's currency, for delivery to a default postcode in its country (see `deliveryPostcodes`). Example: `DE` for amazon.de.",
            "default": "US"
          },
          "maxResultsPerQuery": {
            "title": "Max results per keyword, search URL or Best Sellers list",
            "minimum": 0,
            "maximum": 10000,
            "type": "integer",
            "description": "Stop each search keyword, search URL or ranking list after this many products. Amazon shows about 16–60 results per search page and 100 per Best Sellers list. Example: `50`. Use `0` for no limit (search stops where Amazon stops, usually 7–20 pages).",
            "default": 50
          },
          "scrapeProductDetails": {
            "title": "Open each search / Best Sellers result for full details",
            "type": "boolean",
            "description": "Off (default): search and ranking results come from the list pages only (title, price, rating, rank, badges); fast and charged as `listing-item`. On: each result's product page is also opened, so you get full product records (Buy Box, stock, BSR, variants, specs) charged as `product` instead.",
            "default": false
          },
          "includeOffers": {
            "title": "Include all offers (other sellers)",
            "type": "boolean",
            "description": "Also load the public \"Other sellers on Amazon\" panel for each product and return every offer with price, condition, seller and ships-from. Adds one `offers` event per product that has offers. Example: `true` to monitor third-party sellers against the Buy Box.",
            "default": false
          },
          "maxOffers": {
            "title": "Max offers per product",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Upper limit of offers returned per product when `includeOffers` is on. Amazon returns about 10 offers per panel page. Example: `10`.",
            "default": 10
          },
          "monitorChanges": {
            "title": "Monitor changes between runs",
            "type": "boolean",
            "description": "Remember each product's last price, Buy Box seller, stock and Best Sellers Rank in a named key-value store, and add `change` records (and a `changes` field on each product) when they differ from the previous run. Schedule the Actor (e.g. daily) with the same input to get a price and rank tracker. Change records are free.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor state store name",
            "pattern": "^[a-zA-Z0-9-]{1,63}$",
            "type": "string",
            "description": "Name of the key-value store in your Apify account that keeps the last-seen values. Use a different name per tracked list so that separate schedules don't overwrite each other. Letters, digits and dashes. Example: `amazon-monitor-my-brand`.",
            "default": "amazon-products-monitor"
          },
          "monitorOutput": {
            "title": "Monitoring output",
            "enum": [
              "all",
              "changesOnly"
            ],
            "type": "string",
            "description": "`all` (default): every product record plus a `change` record per detected change. `changesOnly`: only `change` records are written to the dataset; each product checked is still charged, and the full check report is saved as `MONITOR_REPORT` in the run's key-value store.",
            "default": "all"
          },
          "monitorFields": {
            "title": "Fields to watch",
            "type": "array",
            "description": "Which values produce a `change` record when they differ from the previous run. Options: `price`, `listPrice`, `availability`, `buyBoxSeller`, `bestSellersRank`, `rating`, `reviewsCount`, `offersCount`, `listRank` (position in a Best Sellers or search list).",
            "items": {
              "type": "string",
              "enum": [
                "price",
                "listPrice",
                "availability",
                "buyBoxSeller",
                "bestSellersRank",
                "rating",
                "reviewsCount",
                "offersCount",
                "listRank"
              ],
              "enumTitles": [
                "Price",
                "List price",
                "Availability / stock",
                "Buy Box seller",
                "Best Sellers Rank",
                "Rating",
                "Ratings count",
                "Offers count",
                "Position in list"
              ]
            },
            "default": [
              "price",
              "availability",
              "buyBoxSeller",
              "bestSellersRank",
              "listRank"
            ]
          },
          "priceChangeThresholdPercent": {
            "title": "Minimum price change (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Ignore price and list-price moves smaller than this percentage. `0` reports every change. Example: `5` reports only moves of 5% or more.",
            "default": 0
          },
          "rankChangeThresholdPercent": {
            "title": "Minimum rank change (%)",
            "minimum": 0,
            "maximum": 1000,
            "type": "integer",
            "description": "Ignore Best Sellers Rank and list-position moves smaller than this percentage (BSR moves every hour). Example: `10` reports a rank going from 1,000 to 1,100 or 900, but not to 1,050.",
            "default": 10
          },
          "deliveryPostcodes": {
            "title": "Delivery postcodes per marketplace",
            "type": "object",
            "description": "Postcode used as the anonymous \"Deliver to\" location, which decides the prices and offers Amazon shows. Keys are marketplace codes. Defaults: US 10001 (only if you set one), UK EC1A 1BB, DE 10115, FR 75001, IT 20121, ES 28001, CA M5V 3L9, AU 2000, JP 100-0001, IN 110001. Example: `{\"US\": \"90210\", \"DE\": \"80331\"}`.",
            "default": {}
          },
          "maxItems": {
            "title": "Max products in total",
            "minimum": 0,
            "type": "integer",
            "description": "Hard cap on product and listing records for the whole run, across all inputs. Change records don't count. `0` = no cap. Keeps cost predictable; you can also set a maximum cost per run in the run options.",
            "default": 0
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Maximum parallel requests to Amazon. Higher is faster but triggers more CAPTCHAs (which are retried automatically). Example: `8`.",
            "default": 8
          },
          "useResidentialFallback": {
            "title": "Retry blocked pages through residential proxy",
            "type": "boolean",
            "description": "Pages that stay blocked after 3 datacenter attempts are retried through a residential IP in the marketplace's country (capped at 10% of pages per run). Included in the price; no extra charge. Turn off only for testing.",
            "default": true
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}