{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Reviews Scraper Pro",
    "description": "Extract customer reviews from any Amazon product across 19+ domains with star-rating filtering and sort options. Same cookie-free, residential-proxy architecture as the base scraper.",
    "version": "1.1",
    "x-build-id": "57EQEUhUdPhRLsbme"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/crawlerbros~amazon-reviews-scraper-pro/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-crawlerbros-amazon-reviews-scraper-pro",
        "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/crawlerbros~amazon-reviews-scraper-pro/runs": {
      "post": {
        "operationId": "runs-sync-crawlerbros-amazon-reviews-scraper-pro",
        "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/crawlerbros~amazon-reviews-scraper-pro/run-sync": {
      "post": {
        "operationId": "run-sync-crawlerbros-amazon-reviews-scraper-pro",
        "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": [
          "proxyConfiguration"
        ],
        "properties": {
          "productUrls": {
            "title": "Product URLs",
            "type": "array",
            "description": "List of Amazon product URLs to scrape reviews from. Supports /dp/, /gp/product/, and /product/ URL formats across 19+ Amazon domains. A bare 10-character ASIN (e.g. \"B09X7MPX8L\", no URL) is also accepted -- it is expanded into a full URL using the `country` domain below. Leave empty and use `keywords`/`categoryUrls` instead to discover products automatically.",
            "items": {
              "type": "string"
            }
          },
          "keywords": {
            "title": "Keywords (auto-discover products)",
            "type": "array",
            "description": "Search keywords used to auto-discover products when `productUrls` is empty (e.g. \"wireless earbuds\"). Fetches Amazon's public `/s?k=` search results page for each keyword and reviews up to `maxProductsToDiscover` resulting products.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "categoryUrls": {
            "title": "Category / Search URLs (auto-discover products)",
            "type": "array",
            "description": "Advanced mode: supply your own Amazon `/s?...` or `/b?node=...` category/search URL(s) directly (used only when `productUrls` is empty). Products are discovered the same way as `keywords`.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "maxProductsToDiscover": {
            "title": "Max Products to Discover",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Maximum number of products to discover per run from `keywords`/`categoryUrls`. Ignored when `productUrls` is supplied directly.",
            "default": 10
          },
          "sourceMode": {
            "title": "Source Mode",
            "enum": [
              "AUTO",
              "INLINE_ONLY",
              "FULL_PAGE"
            ],
            "type": "string",
            "description": "AUTO (default): use `cookieString` if provided, otherwise the cookie-free inline /dp/ sample. INLINE_ONLY: always use the cheap cookie-free inline sample (ignores `cookieString`), never escalates to a RESIDENTIAL proxy, and disables `countryFallback` -- the strictest, cheapest, single-marketplace path. FULL_PAGE: requires `cookieString` and always uses the paginated, authenticated /product-reviews/ fetcher; see `onAuthRequired` for what happens if no valid cookie is supplied.",
            "default": "AUTO"
          },
          "onAuthRequired": {
            "title": "On Auth Required (FULL_PAGE only)",
            "enum": [
              "FAIL",
              "RETURN_PARTIAL"
            ],
            "type": "string",
            "description": "What to do when `sourceMode=FULL_PAGE` is selected but no valid `cookieString` was supplied. FAIL: abort the run with a typed `amazon_reviews_auth_required` status message and no data. RETURN_PARTIAL (default): fall back to the cookie-free inline sample instead, tagging every returned review `collectionCompleteness: \"INLINE_SAMPLE\"` so downstream consumers know it is not the full paginated set. Ignored unless `sourceMode=FULL_PAGE`.",
            "default": "RETURN_PARTIAL"
          },
          "includeAggregates": {
            "title": "Include Review Aggregates",
            "type": "boolean",
            "description": "Emit one additional `amazon_review_aggregate` record per product with the average rating, global ratings count, star histogram, and \"Customers say\" AI summary -- parsed from the same page HTML already fetched. These widgets render server-side even when individual review cards are gated, so this record is available more reliably than the reviews themselves.",
            "default": true
          },
          "country": {
            "title": "Amazon Domain",
            "enum": [
              "amazon.com",
              "amazon.co.uk",
              "amazon.de",
              "amazon.fr",
              "amazon.it",
              "amazon.es",
              "amazon.ca",
              "amazon.com.au",
              "amazon.co.jp",
              "amazon.in",
              "amazon.com.br",
              "amazon.com.mx",
              "amazon.nl",
              "amazon.sg",
              "amazon.ae",
              "amazon.sa",
              "amazon.pl",
              "amazon.se",
              "amazon.com.tr"
            ],
            "type": "string",
            "description": "Amazon country domain to scrape from. URLs from a different domain are honored automatically.",
            "default": "amazon.com"
          },
          "maxReviews": {
            "title": "Max Reviews per Product",
            "minimum": 1,
            "maximum": 15,
            "type": "integer",
            "description": "Maximum number of reviews to scrape per product (1-15). Cookie-free mode is capped by Amazon's inline /dp/ review block, which renders ~8-13 top reviews per ASIN with no pagination.",
            "default": 15
          },
          "sortBy": {
            "title": "Sort Reviews By",
            "enum": [
              "helpful",
              "recent"
            ],
            "type": "string",
            "description": "How to sort the reviews",
            "default": "helpful"
          },
          "filterByStar": {
            "title": "Filter by Star Rating",
            "enum": [
              "",
              "1",
              "2",
              "3",
              "4",
              "5"
            ],
            "type": "string",
            "description": "Filter reviews by specific star rating (1-5). Leave empty for all ratings.",
            "default": ""
          },
          "includeImages": {
            "title": "Include Review Images",
            "type": "boolean",
            "description": "Extract images uploaded by reviewers",
            "default": true
          },
          "includeGdprSensitive": {
            "title": "Include GDPR Sensitive Data",
            "type": "boolean",
            "description": "Include reviewer names, profile links, and avatars. Set to false for GDPR compliance.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "REQUIRED. Uses the free AUTO (datacenter) proxy group by default. The actor automatically escalates to a RESIDENTIAL proxy for a retry pass if AUTO gets blocked or returns 0 reviews (skipped when `sourceMode=INLINE_ONLY`, or when you pin `apifyProxyGroups` to RESIDENTIAL yourself here).",
            "default": {
              "useApifyProxy": true
            }
          },
          "countryFallback": {
            "title": "Multi-marketplace Fallback",
            "type": "boolean",
            "description": "When the requested `country` returns 0 review cards (e.g. amazon.com now ships an empty 'Customer reviews require account verification' block cookie-free), automatically retry amazon.ca then amazon.com.br with country-matched proxies. Ignored when `cookieString` is set, and forced off when `sourceMode=INLINE_ONLY`. Disable for strict single-marketplace matching.",
            "default": true
          },
          "cookieString": {
            "title": "Amazon Session Cookie String (optional)",
            "type": "string",
            "description": "Optional. Provide your own Amazon session cookies — the literal `Cookie:` header value from a logged-in browser's DevTools Network tab (e.g. `session-id=123-456...; ubid-main=...; at-main=...`). When set, the actor switches to paginated /product-reviews/ mode and can return up to `cookieModeMaxReviews` reviews per product, including the verified-purchase filter. Never paste your Amazon password here — only the session cookie value.",
            "default": ""
          },
          "cookieModeMaxReviews": {
            "title": "Max Reviews per Product (cookie mode)",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "Maximum reviews to return per ASIN when `cookieString` is provided. Amazon caps pagination at ~50 pages x ~10 reviews = ~500 per filter combination; the actor fans out across star filters when this exceeds 500. Ignored in cookie-free mode.",
            "default": 500
          },
          "verifiedPurchasesOnly": {
            "title": "Verified Purchases Only (cookie mode)",
            "type": "boolean",
            "description": "Only return reviews from Verified Purchases. Cookie mode only (requires `cookieString`) -- Amazon's cookie-free inline /dp/ block has no reviewerType-equivalent filter for anonymous sessions, so this has no effect without a cookie.",
            "default": false
          },
          "reviewerType": {
            "title": "Reviewer Type (cookie mode)",
            "enum": [
              "",
              "all_reviews",
              "avp_only_reviews"
            ],
            "type": "string",
            "description": "Explicit reviewerType filter, mirroring Amazon's own /product-reviews/ URL parameter. Cookie mode only -- has no effect without `cookieString`. Leave empty to use `verifiedPurchasesOnly` instead (or default to all reviews).",
            "default": ""
          },
          "maxConcurrency": {
            "title": "Max Concurrency",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Maximum number of concurrent browser pages",
            "default": 1
          },
          "requestTimeout": {
            "title": "Request Timeout (seconds)",
            "minimum": 30,
            "maximum": 180,
            "type": "integer",
            "description": "Timeout for each page request in seconds",
            "default": 60
          },
          "retryCount": {
            "title": "Retry Count",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Number of retries for failed requests / blocked sessions",
            "default": 3
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}