{ "openapi": "3.0.1", "info": { "title": "Freebooksy Scraper", "description": "Scrape free and discounted Kindle ebook deals from Freebooksy - the leading free-ebooks deal site. Daily deals, genre archives, tag pages, full-text search, and direct post/URL lookup with cover images, retailer links (Kindle/Apple Books/Kobo/Nook/Google Play), series data, and deal expiry dates.", "version": "1.0", "x-build-id": "tR5OWwmNtScd76ed6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~freebooksy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-freebooksy-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~freebooksy-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-freebooksy-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~freebooksy-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-freebooksy-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": [ "deals", "byGenre", "byTag", "search", "byUrl" ], "type": "string", "description": "What to fetch.", "default": "deals" }, "genre": { "title": "Genre", "enum": [ "black-literature", "chick-lit", "childrens", "christian-fiction", "cookbooks-nutrition", "cozy-mystery", "erotica", "erotic-romance", "fantasy", "historical", "historical-romance", "horror", "humor", "lgbtq", "literary-fiction", "mystery", "non-fiction", "paranormal", "paranormal-romance", "religion", "romance", "romantic-comedy", "romantic-suspense", "science-fiction", "self-help", "self-help-how-to", "spirituality", "sweet-contemporary-romance", "thriller", "travel", "womens-fiction", "young-adult" ], "type": "string", "description": "Genre archive to browse (mode=byGenre).", "default": "romance" }, "genreFilter": { "title": "Genre filter", "enum": [ "black-literature", "chick-lit", "childrens", "christian-fiction", "cookbooks-nutrition", "cozy-mystery", "erotica", "erotic-romance", "fantasy", "historical", "historical-romance", "horror", "humor", "lgbtq", "literary-fiction", "mystery", "non-fiction", "paranormal", "paranormal-romance", "religion", "romance", "romantic-comedy", "romantic-suspense", "science-fiction", "self-help", "self-help-how-to", "spirituality", "sweet-contemporary-romance", "thriller", "travel", "womens-fiction", "young-adult" ], "type": "string", "description": "Only emit deals whose post is tagged with this genre. Applies to all modes." }, "tagSlug": { "title": "Tag slug (mode=byTag)", "type": "string", "description": "Freebooksy tag slug, e.g. `mystery`, `kindle-unlimited`, `contemporary-romance`.", "default": "kindle-unlimited" }, "searchQuery": { "title": "Search query (mode=search)", "type": "string", "description": "Free-text search across Freebooksy deal posts.", "default": "romance" }, "startUrls": { "title": "Deal URLs", "type": "array", "description": "Optional Freebooksy deal post URLs to fetch directly.", "items": { "type": "string" } }, "keywords": { "title": "Keywords filter", "type": "string", "description": "Only emit deals whose title, author, or description contains this text (case-insensitive)." }, "minPrice": { "title": "Min price (USD)", "minimum": 0, "maximum": 1000, "type": "number", "description": "Only emit deals priced at or above this value. Applies to homepage deals and series-book prices." }, "maxPrice": { "title": "Max price (USD)", "minimum": 0, "maximum": 1000, "type": "number", "description": "Only emit deals priced at or below this value." }, "freeBooksOnly": { "title": "Free books only", "type": "boolean", "description": "Only emit deals that are completely free (drops paid promotions).", "default": false }, "dateFrom": { "title": "Deal expiry date (from)", "type": "string", "description": "Only emit deals expiring on or after this date (YYYY-MM-DD)." }, "dateTo": { "title": "Deal expiry date (to)", "type": "string", "description": "Only emit deals expiring on or before this date (YYYY-MM-DD)." }, "includeSeriesBooks": { "title": "Include series books", "type": "boolean", "description": "Attach other books in the series (cover, URL, price) to each deal record.", "default": true }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum archive pages to walk (genre / tag / search modes). ~7 deals per post, 10 posts per page.", "default": 3 }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Uses the free Apify AUTO proxy group as a fallback if freebooksy.com rate-limits the datacenter IP.", "default": { "useApifyProxy": 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 } } } } } } } } } }