{ "openapi": "3.0.1", "info": { "title": "Gumroad Scraper — Products, Discover & Creator Storefronts", "description": "Gumroad scraper for Discover search, category and tag listings, creator storefronts, and product URLs. Prices, ratings, sales counts, variants, and seller profiles. HTTP-only public data, no login.", "version": "0.1", "x-build-id": "1uSeYQAatMNeh0DiK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawloop~gumroad-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawloop-gumroad-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/crawloop~gumroad-scraper/runs": { "post": { "operationId": "runs-sync-crawloop-gumroad-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/crawloop~gumroad-scraper/run-sync": { "post": { "operationId": "run-sync-crawloop-gumroad-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": { "searchQueries": { "title": "Search queries", "type": "array", "description": "Keywords for Gumroad Discover (e.g. notion template, lightroom presets, ai course).", "items": { "type": "string" } }, "tags": { "title": "Tags", "type": "array", "description": "Discover tag slugs (e.g. notion, design, photography).", "default": [], "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Discover taxonomy slugs from the Discover URL, e.g. design, software-development, 3d, business-and-money, drawing-and-painting.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Discover, product (/l/permalink), or creator storefront URLs. Custom-domain Gumroad shops are supported.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Direct product links such as https://seller.gumroad.com/l/permalink.", "default": [], "items": { "type": "string" } }, "sellerUrls": { "title": "Creator storefront URLs", "type": "array", "description": "Creator profile URLs (subdomain or custom domain). Every public product on the storefront is collected.", "default": [], "items": { "type": "string" } }, "sort": { "title": "Sort order", "enum": [ "", "newest", "hot_and_new", "best_sellers", "highest_rated" ], "type": "string", "description": "Discover sort. Leave default for featured/relevance.", "default": "" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "number", "description": "Keep products at or above this amount (listing currency). 0 = no floor.", "default": 0 }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "number", "description": "Keep products at or below this amount. 0 = no ceiling. Also sent to Discover as max_price.", "default": 0 }, "minRating": { "title": "Min rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Minimum average star rating (1–5). Products with no ratings are dropped when set. 0 = off.", "default": 0 }, "fileTypes": { "title": "File types", "type": "array", "description": "Discover file-type filter (pdf, zip, mp4, mp3, epub, png, …).", "default": [], "items": { "type": "string" } }, "nativeTypes": { "title": "Product types", "type": "array", "description": "Keep these native types only. Empty = all.", "items": { "type": "string", "enum": [ "digital", "course", "ebook", "membership", "bundle", "podcast", "audiobook", "newsletter", "physical", "commission", "call", "coffee", "ticket" ], "enumTitles": [ "Digital product", "Course / tutorial", "E-book", "Membership", "Bundle", "Podcast", "Audiobook", "Newsletter", "Physical good", "Commission", "Call", "Coffee (tip)", "Ticket" ] }, "default": [] }, "freeOnly": { "title": "Free / PWYW only", "type": "boolean", "description": "Keep free or pay-what-you-want products only.", "default": false }, "payWhatYouWantOnly": { "title": "Pay-what-you-want only", "type": "boolean", "description": "Keep products where the buyer sets the price.", "default": false }, "sellerVerifiedOnly": { "title": "Verified sellers only", "type": "boolean", "description": "Keep products from verified Gumroad sellers.", "default": false }, "scrapeDetails": { "title": "Scrape full product details", "type": "boolean", "description": "Fetch each product's public .json for sales count, description, rating histogram, variants/options, covers, and refund policy. Extra request per product. Product URLs always include details.", "default": false }, "includeHtmlDescription": { "title": "Include description HTML", "type": "boolean", "description": "Add descriptionHtml in addition to stripped description text. Only filled when details are scraped.", "default": false }, "maxItems": { "title": "Max products", "minimum": 0, "type": "integer", "description": "Hard cap across all inputs. 0 = unlimited.", "default": 50 }, "maxPages": { "title": "Max Discover pages per query", "minimum": 0, "type": "integer", "description": "Each Discover page is 36 products. 0 = no page cap (still limited by Max products).", "default": 0 }, "monitorMode": { "title": "Monitor mode (only new & changed)", "type": "boolean", "description": "Remember products between runs and emit only NEW or CHANGED rows (price, ratings, sales count, name).", "default": false }, "monitorKey": { "title": "Monitor memory key", "type": "string", "description": "Distinct key per saved search so monitors do not share state.", "default": "default" }, "requestDelaySecs": { "title": "Request delay (seconds)", "minimum": 0, "type": "number", "description": "Throttle between HTTP requests.", "default": 0.2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Public Discover and product JSON usually work without a proxy. Enable Apify Proxy only if you hit HTTP 403/429.", "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 } } } } } } } } } }