{ "openapi": "3.0.1", "info": { "title": "Goodreads Review Scraper", "description": "๐Ÿ“š Goodreads Review Scraper pulls reviews from book & author pages โ€” ratings, review text, dates, shelves, likes & reviewer info. โšก Export CSV/JSON/API for sentiment, market research & book marketing. ๐Ÿš€ Perfect for publishers, authors & data teams.", "version": "1.0", "x-build-id": "3zcExf70QKgKWcmei" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~goodreads-review-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-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/scraper-engine~goodreads-review-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-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/scraper-engine~goodreads-review-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-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 reviews per book", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many reviews to collect **for each** book in your list. (Example: 50 here ร— 3 books = up to 150 rows.) ๐Ÿ“Š", "default": 20 }, "filtersAndOptions": { "title": "โš™๏ธ Filters & sorting", "type": "object", "description": "๐ŸŽ›๏ธ **Optional:** open this section to 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 } } } } } } } } } }