{ "openapi": "3.0.1", "info": { "title": "Reddit Scraper", "description": "Scrape Reddit posts, comments, search results, and user profiles. Monitor brand mentions, competitors, and product feedback across Reddit. No API keys or browser needed. Batch multi-query search, MCP-ready for AI agents.", "version": "1.5", "x-build-id": "B7AL1dgJB52lqcZu2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/labrat011~reddit-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-labrat011-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/labrat011~reddit-scraper/runs": { "post": { "operationId": "runs-sync-labrat011-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/labrat011~reddit-scraper/run-sync": { "post": { "operationId": "run-sync-labrat011-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", "required": [ "mode" ], "properties": { "mode": { "title": "🎯 Scraping Mode", "enum": [ "subreddit_posts", "search", "user_profile", "post_comments" ], "type": "string", "description": "What type of Reddit data to scrape.", "default": "subreddit_posts" }, "subreddits": { "title": "📌 Subreddits", "type": "array", "description": "List of subreddit names to scrape (without r/ prefix). Example: python, webdev, machinelearning", "items": { "type": "string" } }, "sort": { "title": "🔃 Sort Order", "enum": [ "hot", "new", "top", "rising", "controversial" ], "type": "string", "description": "How to sort subreddit posts.", "default": "hot" }, "timeFilter": { "title": "📅 Time Filter (Top sort only)", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time range filter. Applies ONLY when the sort is Top: that means sort='top' in Subreddit Posts mode, or searchSort='top' in Search mode. With any other sort value this field is accepted but has no effect.", "default": "week" }, "searchQuery": { "title": "🔍 Search Query", "type": "string", "description": "Keyword or phrase to search across Reddit. IMPORTANT: Reddit matches loose words by default, not phrases. To match an exact phrase, wrap it in double quotes: \"looking for an alternative to\". (When sending input as JSON, the quotes must be escaped.) An unquoted multi-word query returns largely unrelated posts. Use searchQueriesList for multiple queries in one run." }, "searchQueriesList": { "title": "🔍 Search Queries List (Batch Search)", "type": "array", "description": "Run multiple search queries in a single job. Results are merged and deduplicated by post ID, and this field overrides Search Query when provided. IMPORTANT: wrap each phrase in double quotes for exact-phrase matching, for example \"looking for an alternative to\" as one entry and \"is there a tool that\" as another. (When sending input as JSON, the inner quotes must be escaped.) Unquoted phrases return loosely matched, mostly irrelevant posts. Note that maxResults is a shared budget across all queries and is consumed in order, so later queries return nothing once it is used up. Ideal for brand monitoring, competitor research, and topic mapping.", "items": { "type": "string" } }, "searchSubreddit": { "title": "📌 Limit Search to Subreddit", "type": "string", "description": "Optional: restrict search to a specific subreddit (without r/ prefix). Leave empty to search all of Reddit." }, "searchSort": { "title": "🔃 Search Sort Order", "enum": [ "relevance", "hot", "top", "new", "comments" ], "type": "string", "description": "How to sort search results. Relevance, the default, favours highly upvoted posts, which are often several years old. For recent results use Top together with timeFilter, or New for the newest posts regardless of engagement.", "default": "relevance" }, "searchPosts": { "title": "Search posts", "type": "boolean", "description": "Return matching posts. On by default.", "default": true }, "searchComments": { "title": "Search comments", "type": "boolean", "description": "Also return matching comments, which is where most brand and product mentions live. Each comment carries the title, score and comment count of the post it was left on (postTitle, postScore, postNumComments). Counts toward maxResults.", "default": false }, "usernames": { "title": "👤 Usernames", "type": "array", "description": "List of Reddit usernames to scrape (without u/ prefix).", "items": { "type": "string" } }, "userContentType": { "title": "📋 User Content Type", "enum": [ "overview", "submitted", "comments" ], "type": "string", "description": "What type of content to scrape from user profiles.", "default": "overview" }, "postUrls": { "title": "💬 Post URLs", "type": "array", "description": "Full Reddit post URLs to extract comments from.", "items": { "type": "string" } }, "maxCommentsPerPost": { "title": "🔢 Max Comments per Post", "minimum": 0, "type": "integer", "description": "Maximum number of comments to extract per post, nested replies included. Set to 0 to read the whole thread. In Subreddit Posts and Search mode, comments count toward maxResults and a single post may use at most a fifth of it, so one long thread cannot fill the run before the second post is reached. The run log says so when that lowers this number. Post Comments mode is not capped this way: there the thread is the target.", "default": 100 }, "maxResults": { "title": "🔢 Max Results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of results for the whole run. This is a shared total, not a per-query limit: when using searchQueriesList the budget is consumed one query at a time, so allow at least 25 per query you expect results from. Free Apify plan users are limited to 25 results per run. Any paid Apify plan allows up to 10,000.", "default": 100 }, "includeComments": { "title": "💬 Include Comments with Posts", "type": "boolean", "description": "When scraping posts (subreddit or search mode), also fetch comments for each post. Comments count toward maxResults, so raise maxResults when you turn this on. No single post may use more than a fifth of the budget, which keeps a run spread across several posts. To pull one thread in depth, use Post Comments mode instead. Slower and uses more proxy traffic.", "default": false }, "includeNsfw": { "title": "🔞 Include NSFW Content", "type": "boolean", "description": "When enabled, adult/NSFW content is included in results. Default is off, which filters out NSFW posts and the comments on them, so a filtered post never leaves its thread behind.", "default": false }, "postedAfter": { "title": "Posted after", "type": "string", "description": "Only return posts and comments created after this point. Use a date (2026-10-01), a date and time (2026-10-01T12:00:00Z), or a window back from now such as '24 hours', '7 days' or '3 months', which suits scheduled runs. With sort 'new', the scan stops as soon as it passes this point, which keeps monitoring runs fast." }, "postedBefore": { "title": "Posted before", "type": "string", "description": "Only return posts and comments created before this point. Same formats as postedAfter." }, "proxyConfiguration": { "title": "🔒 Proxy Configuration", "type": "object", "description": "Proxy settings. Residential proxies are strongly recommended, Reddit blocks most datacenter IPs." } } }, "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 } } } } } } } } } }