{ "openapi": "3.0.1", "info": { "title": "Goodreads Book, Author & Listopia List Scraper", "description": "Look up Goodreads books by URL, search query, or ISBN, or pull every book by an author, in a series, on a Listopia list, shelf, or genre page. Filter by rating, ratings count, publish year, language, genre, or author.", "version": "1.1", "x-build-id": "SE0siaqd22MLHJstA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataspryva~goodreads-book-author-and-listopia-list-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataspryva-goodreads-book-author-and-listopia-list-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/dataspryva~goodreads-book-author-and-listopia-list-scraper/runs": { "post": { "operationId": "runs-sync-dataspryva-goodreads-book-author-and-listopia-list-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/dataspryva~goodreads-book-author-and-listopia-list-scraper/run-sync": { "post": { "operationId": "run-sync-dataspryva-goodreads-book-author-and-listopia-list-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", "reviews", "editions", "quotes", "similar", "bookLists", "newReleases" ], "type": "string", "description": "What to scrape. Auto runs every non-empty input you provide.", "default": "auto" }, "bookUrls": { "title": "Book URLs or IDs", "type": "array", "description": "Goodreads book URLs, bare book IDs, or ISBNs. Used by books, reviews, editions, similar, and bookLists. (mode=books, reviews, editions, similar, bookLists, auto)", "items": { "type": "string" }, "default": [] }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Titles, authors, or keywords to search for. (mode=search, auto)", "items": { "type": "string" }, "default": [] }, "isbns": { "title": "ISBNs", "type": "array", "description": "ISBN-10 or ISBN-13 values. Hyphens and spaces are accepted. (mode=isbns, auto)", "items": { "type": "string" }, "default": [] }, "authorUrls": { "title": "Author URLs or IDs", "type": "array", "description": "Goodreads author URLs or bare author IDs. (mode=authors, auto)", "items": { "type": "string" }, "default": [] }, "seriesUrls": { "title": "Series URLs or IDs", "type": "array", "description": "Goodreads series URLs or bare series IDs. (mode=series, auto)", "items": { "type": "string" }, "default": [] }, "listUrls": { "title": "Listopia URLs or IDs", "type": "array", "description": "Listopia /list/show/ URLs or bare list IDs. (mode=lists, auto)", "items": { "type": "string" }, "default": [] }, "shelfNames": { "title": "Shelf names", "type": "array", "description": "Popular shelf names such as mystery, fantasy, or historical-fiction. (mode=shelves, auto)", "items": { "type": "string" }, "default": [] }, "genreNames": { "title": "Genre names", "type": "array", "description": "Genre slugs such as fantasy, romance, or science-fiction. (mode=genres, auto)", "items": { "type": "string" }, "default": [] }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Hard cap on every record emitted in the run, including review, edition, quote, list, and summary records.", "default": 50 }, "detailLevel": { "title": "Detail level", "enum": [ "full", "listing" ], "type": "string", "description": "Full returns complete book records. Listing returns lighter row records for search, author, series, list, shelf, and genre results.", "default": "full" }, "includeMetadata": { "title": "Include summary records", "type": "boolean", "description": "Also emit one author, series, or Listopia summary record alongside the books.", "default": false }, "includeRelated": { "title": "Include related book data", "type": "boolean", "description": "In auto mode, also collect reviews, editions, similar books, and lists for each book URL.", "default": false }, "minRating": { "title": "Minimum average rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Drop books rated below this value. Decimals such as 4.5 are supported." }, "minRatingsCount": { "title": "Minimum ratings count", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Drop books with fewer ratings than this." }, "publishYearMin": { "title": "Published year from", "minimum": 0, "maximum": 3000, "type": "integer", "description": "Drop books first published before this year." }, "publishYearMax": { "title": "Published year to", "minimum": 0, "maximum": 3000, "type": "integer", "description": "Drop books first published after this year." }, "language": { "title": "Language", "type": "string", "description": "Keep books whose language starts with this text, for example en, English, or fre." }, "containsGenre": { "title": "Contains genre", "type": "string", "description": "Keep books with a genre containing this text." }, "containsAuthor": { "title": "Contains author", "type": "string", "description": "Keep books with an author name containing this text." }, "maxReviewsPerBook": { "title": "Max reviews per book", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Reviews to collect for each book. (mode=reviews)", "default": 30 }, "reviewSort": { "title": "Review sort order", "enum": [ "DEFAULT", "NEWEST", "OLDEST" ], "type": "string", "description": "Order reviews by Goodreads default, newest first, or oldest first. (mode=reviews)", "default": "DEFAULT" }, "reviewLanguage": { "title": "Review language", "enum": [ "all", "en", "es", "fr", "de", "it", "pt", "nl", "pl", "tr", "ar", "ru", "uk", "zh", "zh-TW", "ja", "ko", "hi", "bn", "id", "vi", "th", "sv", "no", "da", "fi", "cs", "sk", "hu", "ro", "bg", "el", "he", "sr", "hr", "sl", "lt", "lv", "et", "ca", "gl", "eu", "fa", "ur", "ms", "tl", "af", "sw", "ka", "hy", "az", "uz", "mn", "is", "ga", "cy", "sq", "bs", "mk", "be", "la" ], "type": "string", "description": "Only collect reviews written in this language. (mode=reviews)", "default": "all" }, "reviewRatingMin": { "title": "Minimum review rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only collect reviews with at least this star rating. (mode=reviews)" }, "reviewRatingMax": { "title": "Maximum review rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only collect reviews with at most this star rating. (mode=reviews)" }, "excludeSpoilers": { "title": "Exclude spoilers", "type": "boolean", "description": "Skip reviews Goodreads marks as containing spoilers. (mode=reviews)", "default": false }, "maxEditionsPerBook": { "title": "Max editions per book", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Editions to collect for each book. (mode=editions)", "default": 20 }, "quoteTags": { "title": "Quote tags", "type": "array", "description": "Quote tag pages to scrape, such as love, life, or wisdom. (mode=quotes)", "items": { "type": "string" }, "default": [] }, "quoteAuthorUrls": { "title": "Quote author URLs or IDs", "type": "array", "description": "Author quote pages as Goodreads URLs or bare author IDs. (mode=quotes)", "items": { "type": "string" }, "default": [] }, "quoteWorkUrls": { "title": "Quote work URLs or IDs", "type": "array", "description": "Work quote pages as Goodreads URLs or bare work IDs. (mode=quotes)", "items": { "type": "string" }, "default": [] }, "maxQuotesPerSource": { "title": "Max quotes per source", "minimum": 1, "maximum": 3000, "type": "integer", "description": "Quotes to collect from each tag, author, or work. (mode=quotes)", "default": 30 }, "maxSimilarPerBook": { "title": "Max similar books per book", "minimum": 1, "maximum": 100, "type": "integer", "description": "Similar books to collect for each input book. (mode=similar)", "default": 20 }, "maxListsPerBook": { "title": "Max lists per book", "minimum": 1, "maximum": 100, "type": "integer", "description": "Listopia lists to collect for each input book. (mode=bookLists)", "default": 20 }, "releaseYear": { "title": "Release chart year", "minimum": 1900, "maximum": 2100, "type": "integer", "description": "Year of the new-releases chart. (mode=newReleases)", "default": 2026 }, "releaseMonth": { "title": "Release chart month", "enum": [ "all", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12" ], "type": "string", "description": "Month of the new-releases chart, or all for the yearly chart. (mode=newReleases)", "default": "all" } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }