{ "openapi": "3.0.1", "info": { "title": "Goodreads Scraper", "description": "Scrape public Goodreads books from search terms, book URLs, shelves, genres, lists, and author pages. Export ratings, authors, ISBNs, descriptions, covers, source ranks, and optional review rows.", "version": "0.2", "x-build-id": "JfTSxhOdtxTbS9eXY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~goodreads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-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/maximedupre~goodreads-scraper/runs": { "post": { "operationId": "runs-sync-maximedupre-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/maximedupre~goodreads-scraper/run-sync": { "post": { "operationId": "run-sync-maximedupre-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", "properties": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Enter Goodreads book searches such as science fiction, romantasy, Stephen King, or business books. Each term is searched separately.", "items": { "type": "string", "minLength": 1 } }, "isbns": { "title": "ISBNs", "type": "array", "description": "Enter ISBN-10 or ISBN-13 values. Hyphens and spaces are fine; each ISBN is searched on Goodreads and the matching book is saved when found.", "items": { "type": "string", "minLength": 1 } }, "targets": { "title": "Goodreads URLs", "type": "array", "description": "Paste public Goodreads book, shelf, genre, list, search, author, or series URLs. Use one shelf or genre URL for a simple first URL run.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL", "description": "A public Goodreads book, shelf, genre, list, search, author book-list, or series URL." } } } }, "maxItems": { "title": "Book limit", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum Goodreads book rows to save across all searches and URLs.", "default": 25 }, "maxPages": { "title": "Page limit per target", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum listing pages to scan for each Goodreads shelf, genre, list, author, or search URL.", "default": 3 }, "includeBookDetails": { "title": "Include book details", "type": "boolean", "description": "Open each book page to add fields such as description, ISBN, language, page count, awards, rating count, and review count.", "default": true }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Also save visible public Goodreads review rows found on each book page. Leave off unless you need review text.", "default": false }, "maxReviewsPerBook": { "title": "Review limit per book", "minimum": 0, "maximum": 100, "type": "integer", "description": "Maximum Goodreads review rows to save for each book when reviews are enabled. Use a small number for first review runs.", "default": 0 }, "includeMetadata": { "title": "Include author/list/series metadata", "type": "boolean", "description": "Also save summary rows for Goodreads author, list, and series targets when available.", "default": false }, "minRating": { "title": "Minimum average rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only save books whose Goodreads average rating is at least this value." }, "minRatingsCount": { "title": "Minimum ratings count", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Only save books with at least this many Goodreads ratings." }, "publishYearMin": { "title": "Published year from", "minimum": 0, "maximum": 3000, "type": "integer", "description": "Only save books first published in or after this year when Goodreads exposes a year." }, "publishYearMax": { "title": "Published year to", "minimum": 0, "maximum": 3000, "type": "integer", "description": "Only save books first published in or before this year when Goodreads exposes a year." }, "language": { "title": "Language contains", "type": "string", "description": "Only save books whose Goodreads language field contains this text, such as English or en." }, "containsGenre": { "title": "Genre contains", "type": "string", "description": "Only save books with at least one genre containing this text." }, "containsAuthor": { "title": "Author contains", "type": "string", "description": "Only save books with at least one author name containing this text." }, "deduplicateBooks": { "title": "Deduplicate books", "type": "boolean", "description": "Save each Goodreads book once even if it appears in multiple submitted searches or URLs.", "default": true } } }, "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 } } } } } } } } } }