{
  "openapi": "3.0.1",
  "info": {
    "title": "Goodreads Review Scraper By Star Rating & Spoiler Filter",
    "description": "📚 Goodreads Review Scraper extracts ratings, reviews, dates, reviewers & metadata from Goodreads book pages at scale. 🔍 Export clean data to CSV/JSON for sentiment, market research & content analysis. 🚀 Ideal for authors, publishers, researchers & SEO teams.",
    "version": "0.1",
    "x-build-id": "7tLyMEIITiCh6RWP4"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/simpleapi~goodreads-review-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-simpleapi-goodreads-review-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/simpleapi~goodreads-review-scraper/runs": {
      "post": {
        "operationId": "runs-sync-simpleapi-goodreads-review-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/simpleapi~goodreads-review-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-simpleapi-goodreads-review-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": [
          "urls"
        ],
        "properties": {
          "urls": {
            "title": "📚 Book URLs",
            "type": "array",
            "description": "Paste one or more Goodreads book links. **Tip:** you can paste just the number from the URL (e.g. `26032825`) — we’ll fix the link for you. 🌟",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "🔢 Max matching reviews per book",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "How many **matching** reviews to save **for each** book. The actor keeps paginating until it collects this many reviews that pass your filters (or the review list ends). Example: 50 here × 3 books = up to 150 rows. 📊",
            "default": 20
          },
          "minStars": {
            "title": "⭐ Minimum stars",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Keep only reviews rated **at least** this many stars (1–5). `0` = no minimum (also keeps unrated reviews). Example: minStars=1, maxStars=2 → complaint mining. Default 0.",
            "default": 0
          },
          "maxStars": {
            "title": "⭐ Maximum stars",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Keep only reviews rated **at most** this many stars (1–5). Example: minStars=5, maxStars=5 → 5★ only. Default 5.",
            "default": 5
          },
          "spoilerFilter": {
            "title": "🚫 Spoiler filter",
            "enum": [
              "all",
              "exclude",
              "only"
            ],
            "type": "string",
            "description": "**All** — keep every review · **Spoiler-free** — drop reviews flagged as spoilers · **Spoilers only** — keep only spoiler reviews. Uses Goodreads' own spoiler flag (plus AI spoiler detection below, when enabled).",
            "default": "all"
          },
          "minLikeCount": {
            "title": "👍 Minimum likes",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only reviews with **at least** this many likes. Example: 50 → only well-liked reviews. `0` = no minimum. Default 0.",
            "default": 0
          },
          "minCommentCount": {
            "title": "💬 Minimum comments",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only reviews with **at least** this many comments. `0` = no minimum. Default 0.",
            "default": 0
          },
          "minTextLength": {
            "title": "📝 Minimum review length (characters)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only reviews whose text is **at least** this many characters. Example: 200 → skip one-liners. `0` = no minimum. Default 0.",
            "default": 0
          },
          "textOnly": {
            "title": "📝 Text reviews only",
            "type": "boolean",
            "description": "Skip rating-only reviews that have **no written text**. Default off.",
            "default": false
          },
          "aiSpoilerDetection": {
            "title": "🤖 AI spoiler detection (optional)",
            "type": "boolean",
            "description": "Off by default. When on, an AI model reads each candidate review and flags plot spoilers Goodreads' own flag missed. The result is added as `aiIsSpoiler` and is combined with the spoiler filter above. Requires an AI model + API key below.",
            "default": false
          },
          "aiModel": {
            "title": "🤖 AI Model / Provider",
            "enum": [
              "claude-haiku-4-5",
              "claude-sonnet-5",
              "claude-opus-4-8",
              "claude-fable-5",
              "gpt-4o-mini",
              "gpt-4o",
              "gpt-4.1-mini",
              "gpt-4.1",
              "o3-mini",
              "o1",
              "gemini-2.0-flash-lite",
              "gemini-2.0-flash",
              "gemini-1.5-pro",
              "gemini-2.5-flash",
              "gemini-2.5-pro",
              "grok-2-latest",
              "grok-3-mini",
              "grok-3",
              "grok-beta",
              "deepseek-chat",
              "deepseek-reasoner",
              "sonar",
              "sonar-pro",
              "sonar-reasoning",
              "mistral-small-latest",
              "mistral-large-latest"
            ],
            "type": "string",
            "description": "Provider auto-detected from the name: claude-*=Anthropic, gpt-*/o1/o3=OpenAI, gemini-*=Google, grok-*=xAI, deepseek-*=DeepSeek, sonar*=Perplexity, mistral-*=Mistral. Cheaper mini/flash/haiku/lite models are recommended for classification.",
            "default": "claude-haiku-4-5"
          },
          "aiApiKey": {
            "title": "🔑 AI API key",
            "type": "string",
            "description": "API key for the chosen provider. Falls back to the provider env var if left blank: ANTHROPIC_API_KEY / OPENAI_API_KEY / GEMINI_API_KEY / XAI_API_KEY / DEEPSEEK_API_KEY / PERPLEXITY_API_KEY / MISTRAL_API_KEY."
          },
          "filtersAndOptions": {
            "title": "⚙️ Sorting, language & edition",
            "type": "object",
            "description": "🎛️ **Optional:** change sort order, language, and which edition reviews come from. Leave defaults for a quick start! 👇",
            "properties": {
              "sortBy": {
                "title": "📊 Sort reviews by",
                "type": "string",
                "description": "⭐ **Popular** — most helpful first · 🆕 **Newest** — newest first · 📜 **Oldest** — oldest first",
                "editor": "select",
                "enum": [
                  "popular",
                  "newest",
                  "oldest"
                ],
                "default": "popular"
              },
              "languageCode": {
                "title": "🌍 Review language",
                "type": "string",
                "description": "🌐 **All languages** — no filter · Or choose one language — reviews are filtered to match. 🗣️",
                "editor": "select",
                "enum": [
                  "all",
                  "en",
                  "bn",
                  "fr",
                  "de",
                  "es",
                  "it",
                  "pt",
                  "ru",
                  "ja",
                  "ko",
                  "zh",
                  "ar",
                  "hi",
                  "nl",
                  "pl",
                  "tr",
                  "vi",
                  "id",
                  "th"
                ],
                "enumTitles": [
                  "All languages",
                  "English",
                  "Bengali",
                  "French",
                  "German",
                  "Spanish",
                  "Italian",
                  "Portuguese",
                  "Russian",
                  "Japanese",
                  "Korean",
                  "Chinese",
                  "Arabic",
                  "Hindi",
                  "Dutch",
                  "Polish",
                  "Turkish",
                  "Vietnamese",
                  "Indonesian",
                  "Thai"
                ],
                "default": "all"
              },
              "reviewEdition": {
                "title": "📖 Edition scope",
                "type": "string",
                "description": "📚 **All editions** — reviews for the whole work · 📕 **This book only** — reviews for this edition. 🎯",
                "editor": "select",
                "enum": [
                  "ALL",
                  "only_this_book"
                ],
                "default": "ALL"
              }
            }
          },
          "proxyConfiguration": {
            "title": "🔒 Proxy (optional)",
            "type": "object",
            "description": "🌐 **Optional.** Turn on Apify Proxy if you need extra reliability. If something blocks a run, we’ll try smarter routing automatically — you stay focused on the results. ✨"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}