{ "openapi": "3.0.1", "info": { "title": "Reddit Comment Scraper — Posts, Subreddits & Keywords", "description": "Scrape Reddit comments from any post URL, subreddit feed, or keyword search. Full nested threads, 24 metadata fields per comment, built-in analytics report. No API key, no browser, 512 MB RAM.", "version": "1.0", "x-build-id": "GXpIMOVC92NXTZCAd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brilliant_gum~reddit-comment-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brilliant_gum-reddit-comment-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/brilliant_gum~reddit-comment-scraper/runs": { "post": { "operationId": "runs-sync-brilliant_gum-reddit-comment-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/brilliant_gum~reddit-comment-scraper/run-sync": { "post": { "operationId": "run-sync-brilliant_gum-reddit-comment-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": "Post / Subreddit URLs", "type": "array", "description": "Direct Reddit post URLs (to scrape their comments) or subreddit URLs (to scrape the feed then comments). Example: https://www.reddit.com/r/Python/comments/abc123/...", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "subreddits": { "title": "Subreddits", "type": "array", "description": "Subreddit names to scrape (e.g. \"python\" or \"r/MachineLearning\"). Fetches recent posts then collects their comments.", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Search keywords. Finds posts matching these terms across Reddit (or within specified subreddits) and collects their comments.", "items": { "type": "string" } }, "postSort": { "title": "Post sort", "enum": [ "relevance", "new", "hot", "top", "comments", "controversial" ], "type": "string", "description": "Sort order for posts when using subreddit or keyword mode. Note: 'controversial' applies only to subreddit feeds (Reddit's search API ignores it).", "default": "hot" }, "postTime": { "title": "Post time filter", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time period for posts (applies to top/relevance sort).", "default": "week" }, "commentSort": { "title": "Comment sort", "enum": [ "top", "new", "controversial", "old", "qa", "confidence" ], "type": "string", "description": "How comments are sorted within each post.", "default": "top" }, "maxPostsPerSource": { "title": "Max posts per source", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of posts to process per subreddit or keyword. Higher values = more comments but longer runtime.", "default": 25 }, "maxCommentsPerPost": { "title": "Max comments per post", "minimum": 0, "type": "integer", "description": "Maximum number of comments to collect per post (0 = no limit, collect all available).", "default": 100 }, "maxDepth": { "title": "Max comment depth", "minimum": 0, "type": "integer", "description": "Maximum nesting depth. 0 = all levels. 1 = top-level comments only. 2 = top-level + one reply level.", "default": 0 }, "minScore": { "title": "Min comment score", "minimum": 0, "type": "integer", "description": "Skip comments with fewer upvotes than this value. Useful for filtering low-quality comments.", "default": 0 }, "excludeDeleted": { "title": "Exclude deleted / removed", "type": "boolean", "description": "Skip comments where the content or author has been deleted or removed by moderators.", "default": false }, "includeNSFW": { "title": "Include NSFW posts", "type": "boolean", "description": "Include comments from posts marked as Not Safe For Work.", "default": false }, "includeAnalytics": { "title": "Include analytics report", "type": "boolean", "description": "Generate a community insights report and save it to the Key-Value store under the key ANALYTICS.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Reddit blocks datacenter IPs. Apify Residential proxy is strongly recommended for reliable results." }, "requestDelayMs": { "title": "Request delay (ms)", "minimum": 0, "type": "integer", "description": "Milliseconds to wait between requests. Increase to 1000+ for large runs to avoid rate limiting.", "default": 500 } } }, "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 } } } } } } } } } }