{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Reviews Scraper — Review Text, Ratings & ASIN Data",
    "description": "Scrape Amazon product reviews into clean JSON: review text, title, star rating, date, verified-purchase flag, helpful votes, variant, and author — plus a per-ASIN ratings histogram. Look up by ASIN, product URL, or keyword search. Pay per review.",
    "version": "0.3",
    "x-build-id": "s2CbC7orSJItDAdCG"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/jaybird~amazon-reviews-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-jaybird-amazon-reviews-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/jaybird~amazon-reviews-scraper/runs": {
      "post": {
        "operationId": "runs-sync-jaybird-amazon-reviews-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/jaybird~amazon-reviews-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-jaybird-amazon-reviews-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",
        "properties": {
          "asins": {
            "title": "ASINs",
            "type": "array",
            "description": "Amazon Standard Identification Numbers (10-character product IDs, e.g. B07DF46NW9). Reviews are scraped for each ASIN.",
            "items": {
              "type": "string"
            }
          },
          "productUrls": {
            "title": "Product URLs",
            "type": "array",
            "description": "Amazon product page URLs (any /dp/ or /gp/product/ link). The ASIN is extracted from each URL.",
            "items": {
              "type": "string"
            }
          },
          "keyword": {
            "title": "Search keyword",
            "type": "string",
            "description": "A search term. The Actor finds the top products for this keyword and scrapes their reviews. Use with 'Max products from search'."
          },
          "maxProducts": {
            "title": "Max products from search",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "When using a search keyword, how many of the top search-result products to scrape reviews for.",
            "default": 5
          },
          "maxReviewsPerAsin": {
            "title": "Max reviews per ASIN",
            "minimum": 0,
            "type": "integer",
            "description": "Cap on reviews collected per ASIN. The Actor returns the product page's \"Top reviews\" plus all customer image/video reviews from the media gallery (on amazon.com this is often dozens to hundreds for popular products; few or none for products without customer photos). The ratings histogram and totals are always captured. Set 0 for no cap.",
            "default": 100
          },
          "includeMediaReviews": {
            "title": "Include image & video reviews",
            "type": "boolean",
            "description": "Fetch the customer image/video reviews from the product's media gallery (amazon.com only; other marketplaces return Top reviews only). This is the main source of review volume. Turn off to return just the page's Top reviews, which is faster and cheaper.",
            "default": true
          },
          "reviewStars": {
            "title": "Filter by star rating",
            "type": "array",
            "description": "Only return reviews with these star ratings. Leave empty to return all ratings. (Filters the reviews collected anonymously; it does not unlock additional login-gated reviews.)",
            "items": {
              "type": "string",
              "enum": [
                "5",
                "4",
                "3",
                "2",
                "1"
              ],
              "enumTitles": [
                "5 stars",
                "4 stars",
                "3 stars",
                "2 stars",
                "1 star"
              ]
            },
            "default": []
          },
          "verifiedOnly": {
            "title": "Verified purchases only",
            "type": "boolean",
            "description": "Return only reviews marked \"Verified Purchase\".",
            "default": false
          },
          "mediaOnly": {
            "title": "Reviews with photos/video only",
            "type": "boolean",
            "description": "Return only reviews that include customer photos or video.",
            "default": false
          },
          "sortReviewsBy": {
            "title": "Sort reviews by",
            "enum": [
              "default",
              "mostRecent",
              "mostHelpful",
              "highestRating",
              "lowestRating"
            ],
            "type": "string",
            "description": "Order of the returned reviews. \"Amazon default\" keeps the page's Top-reviews order followed by media-gallery reviews.",
            "default": "default"
          },
          "domain": {
            "title": "Amazon domain (marketplace)",
            "enum": [
              "amazon.com",
              "amazon.co.uk",
              "amazon.de",
              "amazon.ca",
              "amazon.com.au",
              "amazon.in",
              "amazon.fr",
              "amazon.it",
              "amazon.es"
            ],
            "type": "string",
            "description": "The Amazon marketplace to scrape. Bare ASINs and keyword searches use this domain; full product URLs keep their own domain. More marketplaces can be added on request.",
            "default": "amazon.com"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}