{ "openapi": "3.0.1", "info": { "title": "Kickstarter Scraper", "description": "Extract Kickstarter projects from search, category, and discover URLs. Optionally add the full project page and charge comments one by one.", "version": "1.0", "x-build-id": "NS6assAaFJrBbnBwY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rigelbytes~kickstarter-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rigelbytes-kickstarter-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/rigelbytes~kickstarter-scraper/runs": { "post": { "operationId": "runs-sync-rigelbytes-kickstarter-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/rigelbytes~kickstarter-scraper/run-sync": { "post": { "operationId": "run-sync-rigelbytes-kickstarter-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": { "startUrls": { "title": "Kickstarter URLs", "type": "array", "description": "Project URLs or discover URLs copied from the browser, for example https://www.kickstarter.com/discover/categories/technology or https://www.kickstarter.com/projects/147449099/tooldance-x1-smart-desktop-cnc-with-industrial-capability. A project URL scrapes that project. A discover or category URL uses the filters in the URL, and any filter the URL omits is taken from the fields below.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Search terms, such as board game or mechanical keyboard. Each query is searched with the category and filters below.", "items": { "type": "string" } }, "category": { "title": "Category", "enum": [ "all", "1", "26", "3", "6", "7", "9", "11", "10", "12", "13", "14", "15", "18", "16", "17" ], "type": "string", "description": "Kickstarter category. Applied to search queries. Also used on its own to browse that category when no search query is set. Ignored for project URLs.", "default": "all" }, "states": { "title": "Project status", "uniqueItems": true, "type": "array", "description": "Which campaign statuses to include. The category pages on Kickstarter start with Upcoming, Live, and Late pledge.", "items": { "type": "string", "enum": [ "upcoming", "live", "late_pledge", "successful", "failed", "canceled" ], "enumTitles": [ "Upcoming", "Live", "Late pledge", "Successful", "Failed", "Canceled" ] }, "default": [ "upcoming", "live", "late_pledge" ] }, "sort": { "title": "Sort", "enum": [ "magic", "popularity", "newest", "end_date", "most_funded", "most_backed" ], "type": "string", "description": "How discover results are ordered.", "default": "magic" }, "pledged": { "title": "Amount pledged", "enum": [ "any", "0", "1", "2", "3", "4" ], "type": "string", "description": "Filter by the amount pledged in USD.", "default": "any" }, "goal": { "title": "Funding goal", "enum": [ "any", "0", "1", "2", "3", "4" ], "type": "string", "description": "Filter by the project funding goal in USD.", "default": "any" }, "staffPicks": { "title": "Projects We Love only", "type": "boolean", "description": "Keep only projects marked as Projects We Love.", "default": false }, "maxItems": { "title": "Max projects", "minimum": 0, "type": "integer", "description": "Maximum number of projects to extract. 0 means no limit. Comments have their own cap.", "default": 0 }, "includeProjectDetails": { "title": "Include project details", "type": "boolean", "description": "Also extract the story, risks, rewards, FAQs, creator, and community for each project. Charged separately from the project. Off by default.", "default": false }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Extract comments and replies. Each comment is charged separately. Off by default.", "default": false }, "maxComments": { "title": "Max comments", "minimum": 0, "type": "integer", "description": "Maximum comments to extract across the whole run when comments are enabled. 0 means no limit.", "default": 0 }, "detailConcurrency": { "title": "Detail concurrency", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many projects to enrich at once when project details or comments are enabled. Each project uses its own proxy session.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy used for discover and for project pages. Residential proxies are recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }