{ "openapi": "3.0.1", "info": { "title": "Reddit Scraper | All in one", "description": "Scrape Reddit posts, comments, subreddits, and user profiles. Extract engagement metrics, media, nested comment threads, and 35+ data fields. Filter by date, score, NSFW, and media.", "version": "1.0", "x-build-id": "28gzm5on3yzkSX6Hp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeforge~reddit-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeforge-reddit-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/scrapeforge~reddit-scraper/runs": { "post": { "operationId": "runs-sync-scrapeforge-reddit-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/scrapeforge~reddit-scraper/run-sync": { "post": { "operationId": "run-sync-scrapeforge-reddit-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": "Start URLs", "type": "array", "description": "Reddit URLs to scrape: subreddit URLs (r/python), post URLs, user profiles (u/username), or search URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchTerms": { "title": "Search Terms", "type": "array", "description": "Keywords to search across Reddit.", "items": { "type": "string" } }, "subreddits": { "title": "Subreddits", "type": "array", "description": "Subreddit names to scrape posts from (without r/ prefix).", "items": { "type": "string" } }, "usernames": { "title": "Usernames", "type": "array", "description": "Reddit usernames to scrape posts/comments from (without u/ prefix).", "items": { "type": "string" } }, "maxItems": { "title": "Max Items Per Source", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of posts to extract per source.", "default": 100 }, "scrapeComments": { "title": "Scrape comments", "type": "boolean", "description": "Turn ON to extract comments. ⚠️ Each comment is counted as a result (it adds to cost) and appears as its own row in the dataset, linked to its post. Turn OFF and comments are never fetched (no cost, no rows).", "default": false }, "maxComments": { "title": "Max Comments Per Post", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum comments to extract per post. Only applies when 'Scrape comments' is ON.", "default": 100 }, "commentDepth": { "title": "Comment Reply Depth", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum depth of nested replies to follow. Only applies when 'Scrape comments' is ON.", "default": 3 }, "fetchPostDetails": { "title": "Fetch Post Details", "type": "boolean", "description": "Extract full post detail — body text and upvote ratio. More complete data, but slower (one extra request per post). Turn OFF for fast, low-cost runs that return post metadata only (title, score, author, dates, media, flags).", "default": true }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many posts to process in parallel. Higher = faster; lower = gentler.", "default": 5 }, "maximizeCoverage": { "title": "Maximize Search Coverage", "type": "boolean", "description": "For search terms, gather results more thoroughly and de-duplicate them to return more posts per query. Only affects searchTerms.", "default": true }, "sort": { "title": "Sort Order", "enum": [ "hot", "new", "top", "rising", "relevance", "comments" ], "type": "string", "description": "Sort order for subreddit posts and search results.", "default": "hot" }, "timeFilter": { "title": "Time Filter", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time range filter (for 'top' and search sorting).", "default": "all" }, "startDate": { "title": "Start Date", "type": "string", "description": "Only include posts after this date (YYYY-MM-DD)." }, "endDate": { "title": "End Date", "type": "string", "description": "Only include posts before this date (YYYY-MM-DD)." }, "minScore": { "title": "Minimum Score", "minimum": 0, "type": "integer", "description": "Only include posts with at least this score." }, "includeNSFW": { "title": "Include NSFW", "type": "boolean", "description": "Include NSFW (Not Safe For Work) posts.", "default": false }, "mediaOnly": { "title": "Media Only", "type": "boolean", "description": "Only include posts that contain media (images, videos, galleries).", "default": false }, "customMapFunction": { "title": "Custom Map Function", "type": "string", "description": "JavaScript function to transform each post object. Receives 'post' as argument, must return an object." } } }, "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 } } } } } } } } } }