{ "openapi": "3.0.1", "info": { "title": "Goodreads Book Scraper", "description": "Extract book data from Goodreads: titles, authors, ratings, reviews, genres, ISBN, publisher, and more. HTTP-based, no proxy required.", "version": "1.1", "x-build-id": "c5frSs1OgeFjcOrlO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~goodreads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-goodreads-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/crawlerbros~goodreads-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-goodreads-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/crawlerbros~goodreads-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-goodreads-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "auto", "books", "search", "isbns", "authors", "series", "lists", "shelves", "genres" ], "type": "string", "description": "What to scrape. Use 'auto' (default) to run any non-empty inputs you provide. Or pick a specific mode to run only that one.", "default": "auto" }, "bookUrls": { "title": "Book URLs", "type": "array", "description": "Direct Goodreads book URLs. (mode=auto, books)", "items": { "type": "string" }, "default": [] }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Free-text search terms (titles, authors, keywords). (mode=auto, search)", "items": { "type": "string" }, "default": [] }, "isbns": { "title": "ISBNs", "type": "array", "description": "ISBN-10 or ISBN-13 codes. Goodreads' search redirects ISBN queries to the matching book. (mode=auto, isbns)", "items": { "type": "string" }, "default": [] }, "authorUrls": { "title": "Author URLs", "type": "array", "description": "Goodreads author URLs (e.g. https://www.goodreads.com/author/show/1077326). The actor walks /author/list/?page=N for all books. (mode=auto, authors)", "items": { "type": "string" }, "default": [] }, "seriesUrls": { "title": "Series URLs", "type": "array", "description": "Goodreads series URLs (e.g. https://www.goodreads.com/series/49075-harry-potter). All books in the series are scraped. (mode=auto, series)", "items": { "type": "string" }, "default": [] }, "listUrls": { "title": "Listopia list URLs", "type": "array", "description": "Goodreads /list/show/ URLs (e.g. Best Books Ever). Paginated. (mode=auto, lists)", "items": { "type": "string" }, "default": [] }, "shelfNames": { "title": "Shelf names", "type": "array", "description": "Popular shelf names like 'mystery', 'fantasy', 'historical-fiction'. Paginated. (mode=auto, shelves)", "items": { "type": "string" }, "default": [] }, "genreNames": { "title": "Genre names", "type": "array", "description": "Genre names like 'fiction', 'romance', 'mystery'. (mode=auto, genres)", "items": { "type": "string" }, "default": [] }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on total records emitted across all inputs. Books, search results, and listing-page results all count toward this.", "default": 50 }, "maxResultsPerQuery": { "title": "[Deprecated] Max results per query", "minimum": 1, "maximum": 100, "type": "integer", "description": "Legacy field. Use maxItems instead. When set and maxItems is at its default, this value is used as the cap." }, "minRating": { "title": "Min average rating", "minimum": 0, "maximum": 5, "type": "integer", "description": "Drop books with averageRating below this integer threshold (0-5). For finer thresholds (e.g. 4.5), use a higher minRatingsCount filter to surface highly-rated books." }, "minRatingsCount": { "title": "Min ratings count", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Drop books with fewer than N ratings." }, "publishYearMin": { "title": "Published year min", "minimum": 0, "maximum": 3000, "type": "integer", "description": "Drop books published before this year." }, "publishYearMax": { "title": "Published year max", "minimum": 0, "maximum": 3000, "type": "integer", "description": "Drop books published after this year." }, "language": { "title": "Language", "type": "string", "description": "Drop books whose language doesn't contain this string (case-insensitive substring match). E.g. 'en', 'eng', 'English'." }, "containsGenre": { "title": "Contains genre", "type": "string", "description": "Drop books unless one of their genres contains this substring (case-insensitive)." }, "containsAuthor": { "title": "Contains author", "type": "string", "description": "Drop books unless one of their authors contains this substring (case-insensitive)." }, "includeMetadata": { "title": "Include metadata records", "type": "boolean", "description": "When true, emit one extra record per author/series/list with bio, description, and counts (recordType: 'author' | 'series' | 'list'). Default false.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy. Goodreads is reachable from datacenter IPs without proxy; only enable if you hit sustained 429s.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }