{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Scraper API — Products, Reviews, Sellers, Best Sellers",
    "description": "Extract Amazon product data, customer reviews, seller profiles and buy-box offers from 19 marketplaces (US, UK, DE,\n  FR, IT, ES, JP, IN, AU…). Full PDP, BSR, stars histogram, variants, A+, seller VAT + 4-period feedback. No Amazon API\n  needed, no captcha. Pay-per-event from $0.001/record.",
    "version": "0.6",
    "x-build-id": "yV9hFkQ97LbAwZvWu"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/pro100chok~amazon-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-pro100chok-amazon-scraper",
        "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/pro100chok~amazon-scraper/runs": {
      "post": {
        "operationId": "runs-sync-pro100chok-amazon-scraper",
        "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/pro100chok~amazon-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-pro100chok-amazon-scraper",
        "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": [
          "scrapeType"
        ],
        "properties": {
          "scrapeType": {
            "title": "🎯 What to scrape",
            "enum": [
              "product",
              "search",
              "category",
              "charts",
              "reviews",
              "seller",
              "storefront",
              "stores",
              "offers",
              "deals",
              "asinLookup",
              "reviewById"
            ],
            "type": "string",
            "description": "Pick one mode. Each mode pulls a different surface of Amazon and outputs a different shape (see Storage → Dataset views).\n\n🛍️  **Product**  — full product details (price, brand, A+ content, variants with names, BSR, sales volume, sustainability, comparison table…)\n🔍  **Search**   — products ranked by keyword, with price / brand / Prime / rating / deal filters\n🏆  **Category** — products from a /Best-Sellers/ or any category URL\n📈  **Charts**   — Best Sellers, New Releases, Movers & Shakers, Most Wished For, Gift Ideas by category slug\n⭐  **Reviews**  — review-level rows (rating, body, ISO date, verified, variant, images)\n🏪  **Seller**   — seller profile (business name, VAT, e-mail, 4-period feedback, policies)\n🏬  **Storefront** — every product a given seller offers\n🏷️  **Brand store** — products from an Amazon `/stores/` brand page\n💲  **Offers**   — every offer for one ASIN (price, condition, seller, Prime)\n🔥  **Deals**    — Today's Deals grid (no input needed)\n🔢  **EAN/UPC → ASIN** — look up Amazon products by barcode\n💬  **Review by ID** — fetch a single review by its review ID",
            "default": "product"
          },
          "productUrls": {
            "title": "🛍️ Product URLs or ASINs",
            "type": "array",
            "description": "For Scrape Type: Product details. One per line. Accepts full URLs (`https://www.amazon.com/dp/B07XJ8C8F5`) or bare ASINs (`B07XJ8C8F5`). Bare ASINs default to the marketplace below.",
            "items": {
              "type": "string"
            }
          },
          "includeOffers": {
            "title": "💲 Also fetch all offers for each product",
            "type": "boolean",
            "description": "Adds an `offers: [...]` list (every seller / condition / price) to each product record, and fills `offersCount`. Each offer is charged as one `offer` event.",
            "default": false
          },
          "includeSellerDetails": {
            "title": "🏪 Also fetch the buy-box seller's profile",
            "type": "boolean",
            "description": "Adds a `sellerDetails` object (business name, address, VAT, feedback breakdown) for the seller who currently holds the buy box. Charged as one `seller` event per product.",
            "default": false
          },
          "searchKeywords": {
            "title": "🔍 Search keywords",
            "type": "array",
            "description": "For Scrape Type: Search results. One keyword per line (e.g. `wireless headphones`, `mechanical keyboard`).",
            "items": {
              "type": "string"
            }
          },
          "categoryUrls": {
            "title": "🏆 Category URLs",
            "type": "array",
            "description": "For Scrape Type: Category. One per line. Best-seller, New-releases, Movers-&-Shakers or any `/s?...` listing URL.\nExample: `https://www.amazon.com/Best-Sellers/zgbs/electronics`",
            "items": {
              "type": "string"
            }
          },
          "chartCategories": {
            "title": "📈 Chart category slugs",
            "type": "array",
            "description": "For Scrape Type: Charts. One category slug per line — `electronics`, `books`, `home-garden`, `toys-and-games`… Leave a single empty value to scrape the chart's top-level page.",
            "items": {
              "type": "string"
            }
          },
          "chartType": {
            "title": "📈 Which chart",
            "enum": [
              "bestsellers",
              "new-releases",
              "movers-and-shakers",
              "most-wished-for",
              "gift-ideas"
            ],
            "type": "string",
            "description": "Used when Scrape Type = Charts. Note: Amazon renders **Movers & Shakers** in the browser and serves no products in the HTML, so that one chart comes back empty; the other four are served ready-made.",
            "default": "bestsellers"
          },
          "reviewProductUrls": {
            "title": "⭐ Product URLs or ASINs for reviews",
            "type": "array",
            "description": "For Scrape Type: Reviews. One per line. Each review is pushed as a separate dataset item.",
            "items": {
              "type": "string"
            }
          },
          "sellerInputs": {
            "title": "🏪 Seller IDs or URLs",
            "type": "array",
            "description": "For Scrape Type: Seller profile. One per line. Accepts seller IDs (`A2L77EE7U53NWQ`) or full seller profile URLs.\nFind a seller ID on any product page → \"Sold by …\" → click → copy `?seller=` value.",
            "items": {
              "type": "string"
            }
          },
          "storefrontSellers": {
            "title": "🏬 Seller IDs or storefront URLs",
            "type": "array",
            "description": "For Scrape Type: Seller storefront. One per line. Accepts seller IDs (`A2L77EE7U53NWQ`) or storefront URLs (`https://www.amazon.com/s?me=A2L77EE7U53NWQ`). Returns the products that seller lists.",
            "items": {
              "type": "string"
            }
          },
          "storeUrls": {
            "title": "🏷️ Amazon brand-store URLs",
            "type": "array",
            "description": "For Scrape Type: Brand store. One per line — e.g. `https://www.amazon.com/stores/page/5EF421E8-DE42-44BD-888D-052017C90B8F`.\nAmazon renders these pages in the browser, so the actor reads the brand from the page and pulls that brand's catalogue.",
            "items": {
              "type": "string"
            }
          },
          "offerAsins": {
            "title": "💲 Product URLs or ASINs for offers",
            "type": "array",
            "description": "For Scrape Type: Offers (buy-box). One per line. Returns every seller / condition / price for the ASIN.",
            "items": {
              "type": "string"
            }
          },
          "productCodes": {
            "title": "🔢 EAN / UPC / ISBN codes",
            "type": "array",
            "description": "For Scrape Type: EAN/UPC → ASIN. One barcode per line. Dashes and spaces are ignored. Returns the matching Amazon products (ASIN, title, price…).",
            "items": {
              "type": "string"
            }
          },
          "reviewIds": {
            "title": "💬 Review IDs or review URLs",
            "type": "array",
            "description": "For Scrape Type: Review by ID. One per line — e.g. `RKP7CFF9MXBS9` or `https://www.amazon.com/gp/customer-reviews/RKP7CFF9MXBS9`.\nAmazon keeps individual review pages behind a password wall; without a signed-in session the record comes back with a `_note` explaining that.",
            "items": {
              "type": "string"
            }
          },
          "maxItemsPerInput": {
            "title": "🔢 Max items per input",
            "minimum": 0,
            "type": "integer",
            "description": "Global cap per keyword / category / storefront / chart. 0 = unlimited (Amazon will still cap listings at ~20 pages × 24 ≈ 480 organic).",
            "default": 100
          },
          "searchSort": {
            "title": "↕️ Sort search results",
            "enum": [
              "relevance",
              "price-asc-rank",
              "price-desc-rank",
              "review-rank",
              "date-desc-rank"
            ],
            "type": "string",
            "description": "Amazon search sort order.",
            "default": "relevance"
          },
          "maxSearchPages": {
            "title": "📄 Max listing pages per input",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Applies to search, category, charts and storefront. Amazon caps search at ~20 pages.",
            "default": 5
          },
          "searchMinPrice": {
            "title": "💵 Min price",
            "minimum": 0,
            "type": "integer",
            "description": "Lowest price to include, in the marketplace currency. Leave empty for no lower bound."
          },
          "searchMaxPrice": {
            "title": "💵 Max price",
            "minimum": 0,
            "type": "integer",
            "description": "Highest price to include, in the marketplace currency. Leave empty for no upper bound."
          },
          "searchBrand": {
            "title": "🏷️ Brand",
            "type": "string",
            "description": "Restrict results to one brand, exactly as Amazon spells it (e.g. `Sony`, `Anker`)."
          },
          "searchSellerId": {
            "title": "🏪 Seller ID",
            "type": "string",
            "description": "Restrict results to products sold by this seller (`A2L77EE7U53NWQ`)."
          },
          "searchPrimeOnly": {
            "title": "🚚 Prime only",
            "type": "boolean",
            "description": "Only products eligible for Prime shipping.",
            "default": false
          },
          "searchFourStarsAndUp": {
            "title": "⭐ 4 stars & up",
            "type": "boolean",
            "description": "Only products rated 4 stars or better.",
            "default": false
          },
          "searchCondition": {
            "title": "🏷️ Condition",
            "enum": [
              "all",
              "new",
              "used",
              "renewed"
            ],
            "type": "string",
            "description": "Item condition filter for search results.",
            "default": "all"
          },
          "searchDeals": {
            "title": "🔥 Deals",
            "enum": [
              "none",
              "todays_deals",
              "all_discounts"
            ],
            "type": "string",
            "description": "Restrict results to discounted items.",
            "default": "none"
          },
          "reviewsSort": {
            "title": "↕️ Reviews sort",
            "enum": [
              "helpful",
              "recent"
            ],
            "type": "string",
            "description": "Sort order for review pages.",
            "default": "helpful"
          },
          "reviewsFilterByStar": {
            "title": "⭐ Star-rating filter",
            "enum": [
              "all_stars",
              "five_star",
              "four_star",
              "three_star",
              "two_star",
              "one_star",
              "positive",
              "critical"
            ],
            "type": "string",
            "description": "Limit reviews to a single star rating, or to overall positive / critical buckets.",
            "default": "all_stars"
          },
          "reviewsFilterByMedia": {
            "title": "🖼️ Media filter",
            "enum": [
              "all_contents",
              "media_reviews_only"
            ],
            "type": "string",
            "description": "Show all reviews or only those that include photos / videos.",
            "default": "all_contents"
          },
          "reviewsFilterByVerified": {
            "title": "✅ Only verified-purchase reviews",
            "type": "boolean",
            "description": "If true, restrict results to reviews from buyers Amazon verified as purchasers.",
            "default": false
          },
          "reviewsDateFrom": {
            "title": "📅 Reviews from (YYYY-MM-DD)",
            "type": "string",
            "description": "Keep only reviews written on or after this date. Matching uses the normalised `dateIso` field; a review whose date could not be parsed is kept."
          },
          "reviewsDateTo": {
            "title": "📅 Reviews until (YYYY-MM-DD)",
            "type": "string",
            "description": "Keep only reviews written on or before this date."
          },
          "reviewsFilterByKeyword": {
            "title": "🔎 Reviews containing keyword",
            "type": "string",
            "description": "Keep only reviews whose title or body contains this text (case-insensitive)."
          },
          "maxReviewsPerProduct": {
            "title": "🔢 Max reviews per product",
            "minimum": 0,
            "type": "integer",
            "description": "Upper bound per product. Amazon itself now exposes only ~8-13 reviews per ASIN (deep pagination was retired), so this mostly acts as a safety cap. Set 0 for no limit.",
            "default": 100
          },
          "includeSellerReviews": {
            "title": "💬 Include individual seller feedback",
            "type": "boolean",
            "description": "Embed individual customer feedback rows (rating + text + reviewer + date) into the seller record under `reviews: [...]`. These embedded rows are not charged separately.",
            "default": false
          },
          "maxSellerReviews": {
            "title": "🔢 Max seller-feedback rows",
            "minimum": 0,
            "type": "integer",
            "description": "Cap on individual feedback rows fetched per seller (paginated via `&page=N`). 0 = no limit. Default 10 ≈ one page.",
            "default": 10
          },
          "offerCondition": {
            "title": "🏷️ Condition filter",
            "enum": [
              "all",
              "new",
              "used",
              "refurbished",
              "collectible"
            ],
            "type": "string",
            "description": "Limit offers by item condition.",
            "default": "all"
          },
          "marketplace": {
            "title": "🌍 Marketplace",
            "enum": [
              "com",
              "co.uk",
              "de",
              "fr",
              "it",
              "es",
              "nl",
              "se",
              "pl",
              "ca",
              "com.mx",
              "com.br",
              "co.jp",
              "in",
              "com.au",
              "sg",
              "ae",
              "sa",
              "com.tr"
            ],
            "type": "string",
            "description": "Default Amazon domain. Bare ASINs/seller IDs go here. Full URLs override.",
            "default": "com"
          },
          "deliveryZipCode": {
            "title": "📍 Delivery ZIP / postcode",
            "type": "string",
            "description": "Set the delivery address Amazon prices against — e.g. `10001`, `SW1A 1AA`, or a 2-letter country code like `DE`.\nWithout it Amazon quotes prices, stock and delivery dates for a city of its own choosing. The address is set once per run; if Amazon refuses it, the run says so in the log and keeps the location Amazon picked instead of silently retrying."
          },
          "maxConcurrency": {
            "title": "⚡ Max concurrent requests",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Higher = faster, but Amazon throttles bursts from one address. Default 4 is the safe setting.",
            "default": 4
          },
          "useOurAccounts": {
            "title": "🔐 Use our Amazon accounts",
            "type": "boolean",
            "description": "Run signed in with an Amazon session from our own account pool — nothing needed from you. Each account is leased to one run at a time and returned afterwards. Your own cookies below always take priority. When every account is busy the run continues signed-out; products, search, charts, sellers and offers are unaffected.",
            "default": true
          },
          "amazonCookies": {
            "title": "🍪 Your Amazon cookies (JSON)",
            "type": "string",
            "description": "Optional — only if you prefer your own session over ours (it then takes priority). Paste the EditThisCookie export of a logged-in Amazon tab. Cookies are per-domain: an amazon.com export only authenticates amazon.com, so export from the same marketplace you scrape. See the README for step-by-step instructions."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}