{ "openapi": "3.0.1", "info": { "title": "Reddit MCP Scraper", "description": "Unified Reddit scraper supporting 3 modes: (1) Subreddit posts with content extraction, (2) Post comments with threading, (3) User profiles with metadata. Extract comprehensive data including scores, timestamps, flairs, NSFW flags, and more.", "version": "2.0", "x-build-id": "pMzUU6VN26Cr63D1D" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~reddit-mcp-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-reddit-mcp-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/crawlerbros~reddit-mcp-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-reddit-mcp-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/crawlerbros~reddit-mcp-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-reddit-mcp-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", "comments", "profile", "search", "discover" ], "type": "string", "description": "Choose which Reddit data to scrape: subreddit posts, post comment threads, user profiles, keyword search, or curated community discovery (no keyword needed).", "default": "subreddit" }, "subreddits": { "title": "Subreddits (subreddit mode)", "type": "array", "description": "List of subreddits to scrape. Accepts names (python), r/ names or full URLs.", "items": { "type": "string" } }, "maxPosts": { "title": "Maximum posts", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum posts per subreddit / user / keyword. In profile mode this caps the 'posts'/'overview' sections' post count only — see maxComments for the comment count cap.", "default": 25 }, "maxItems": { "title": "Maximum total records", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Global safety cap on the total number of records pushed across the whole run (all modes and all inputs).", "default": 100000 }, "sort": { "title": "Sort posts by", "enum": [ "relevance", "hot", "new", "top", "rising", "controversial", "best", "comments" ], "type": "string", "description": "How to sort posts (subreddit mode), search results (search mode), or a user's post/comment history (profile mode — 'rising'/'best' fall back to 'new' for profile mode since Reddit's user listing doesn't support them).", "default": "hot" }, "timeFilter": { "title": "Time filter", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time range for 'top'/'controversial' sort (subreddit mode, profile mode) or search results (search mode).", "default": "day" }, "postUrls": { "title": "Post URLs (comments mode)", "type": "array", "description": "List of Reddit post URLs (or comment URLs / post IDs) to scrape comment threads from.", "items": { "type": "string" } }, "maxComments": { "title": "Maximum comments", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum comments per post (comments mode), per keyword (search mode), or per user's comment history (profile mode, 'comments'/'overview' sections — capped independently from maxPosts).", "default": 100 }, "commentSort": { "title": "Sort comments by", "enum": [ "confidence", "top", "new", "controversial", "old", "qa" ], "type": "string", "description": "How to sort comment threads (comments mode).", "default": "confidence" }, "includePost": { "title": "Include parent post (comments mode)", "type": "boolean", "description": "Emit the parent post record before each thread's comments.", "default": true }, "usernames": { "title": "Usernames (profile mode)", "type": "array", "description": "List of Reddit usernames to scrape (names, u/ names or profile URLs).", "items": { "type": "string" } }, "includeProfileInfo": { "title": "Include profile info record (profile mode)", "type": "boolean", "description": "Emit a user_profile record with karma breakdown, premium, verified email, moderator flags, account age.", "default": true }, "includeTrophies": { "title": "Include trophies (profile mode)", "type": "boolean", "description": "Also fetch the user's trophy case (names + icon URLs) from their profile page.", "default": false }, "includeModeratedSubreddits": { "title": "Include moderated subreddits (profile mode)", "type": "boolean", "description": "Also fetch the list of communities the user moderates (subreddit name, subscribers, type, mod permissions) and attach it to the user_profile record. Omitted when the user moderates nothing.", "default": false }, "sections": { "title": "Profile sections (profile mode)", "type": "array", "description": "Which history sections to scrape (profile mode). 'Overview' returns the combined posts + comments feed.", "items": { "type": "string", "enum": [ "overview", "posts", "comments" ], "enumTitles": [ "Overview (posts + comments)", "Posts", "Comments" ] }, "default": [ "posts" ] }, "restrictSubreddits": { "title": "Restrict to subreddits (profile mode)", "type": "array", "description": "Only keep a user's posts/comments made in these subreddits (case-insensitive). Accepts bare names (python), r/ prefixed (r/python), or subreddit URLs. Leave empty to include every subreddit in the user's history.", "items": { "type": "string" } }, "keyword": { "title": "Keyword filter (profile mode)", "type": "string", "description": "Only keep a user's posts/comments whose title, self-text or comment body contains this text (case-insensitive substring match). Leave empty to disable." }, "keywords": { "title": "Keywords (search mode)", "type": "array", "description": "Keywords to search for. Advanced syntax supported: \"exact phrase\", python AND rust, -exclude, author:name, flair:tag, subreddit:name, site:domain.", "items": { "type": "string" } }, "searchPosts": { "title": "Search posts (search mode)", "type": "boolean", "description": "Include posts in keyword search results.", "default": true }, "searchComments": { "title": "Search comments (search mode)", "type": "boolean", "description": "Include comments in keyword search results.", "default": false }, "searchCommunities": { "title": "Search communities (search mode)", "type": "boolean", "description": "Include subreddits in keyword search results.", "default": false }, "searchUsers": { "title": "Search users (search mode)", "type": "boolean", "description": "Include Reddit accounts whose username matches the keyword (user discovery). Reddit's account search always searches globally (subreddit scoping doesn't apply) and returns a single page of up to 100 accounts per keyword.", "default": false }, "withinCommunity": { "title": "Limit search to ONE community (search mode)", "type": "string", "description": "Restrict the keyword search to a single subreddit (name, r/name or URL). Applies to post and comment search only — Reddit's own search API does not support scoping community (subreddit) or user results to a single subreddit, so 'Search communities' and 'Search users' always search globally regardless of this field." }, "maxCommunities": { "title": "Maximum communities per keyword (search mode) / total (discover mode)", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum subreddits returned per keyword (search mode), or maximum communities returned overall (discover mode).", "default": 10 }, "discoverListing": { "title": "Community listing (discover mode)", "enum": [ "popular", "new", "default" ], "type": "string", "description": "Which of Reddit's own curated community listings to walk (discover mode) — no keyword required. 'Popular' mirrors r/popular's trending communities, 'New' is the newest-created public communities, 'Default' is Reddit's default-subscribed set for new accounts.", "default": "popular" }, "maxUsers": { "title": "Maximum users per keyword (search mode)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Maximum Reddit accounts returned per keyword. Reddit serves at most ~100 accounts per query regardless of this cap.", "default": 25 }, "includeNSFW": { "title": "Include NSFW (18+) content", "type": "boolean", "description": "Include NSFW posts (or NSFW communities in discover mode) in results.", "default": false }, "onlyWithFlair": { "title": "Only posts that have a flair (subreddit mode, profile mode)", "type": "boolean", "description": "Drop posts without a flair tag. Has no effect on comments, search mode or communities.", "default": false }, "fullSubreddit": { "title": "Full subreddit mode (subreddit mode)", "type": "boolean", "description": "Walk 'New' posts as deep as Reddit allows (~1,000 per listing) instead of the first pages.", "default": false }, "includeSubredditInfo": { "title": "Include community info record (subreddit mode)", "type": "boolean", "description": "Emit one 'community' record per subreddit (subscribers, description, rules-related flags, banner/icon, NSFW status, etc.) before its posts.", "default": false }, "includeSubredditRules": { "title": "Include subreddit rules (subreddit mode)", "type": "boolean", "description": "Also fetch each subreddit's posting rules (name, description, violation reason, priority) and attach them to the community record. Only takes effect when 'Include community info record' is also on; omitted when the subreddit has no rules.", "default": false }, "titleContains": { "title": "Title contains keyword (subreddit/profile/search modes)", "type": "string", "description": "Only keep posts whose title contains this text (case-insensitive substring match). Has no effect on comments/communities/users. Leave empty to keep all titles." }, "contentContains": { "title": "Post text contains keyword (subreddit/profile/search modes)", "type": "string", "description": "Only keep self (text) posts whose body contains this text (case-insensitive substring match). Link/image/video posts have no body text and are excluded when this is set. Has no effect on comments/communities/users. Leave empty to keep all posts." }, "flairContains": { "title": "Flair contains keyword (subreddit/profile/search modes)", "type": "string", "description": "Only keep posts whose link flair contains this text (case-insensitive substring match). Has no effect on comments/communities/users. Leave empty to keep all flairs." }, "authorFlairContains": { "title": "Author flair contains keyword (subreddit/profile/search modes)", "type": "string", "description": "Only keep posts whose author flair contains this text (case-insensitive substring match). Has no effect on comments/communities/users. Leave empty to keep all." }, "domain": { "title": "Domain contains (subreddit/profile/search modes)", "type": "string", "description": "Only keep posts whose link domain contains this text (case-insensitive, e.g. 'youtube.com' or 'self.python'). Has no effect on comments/communities/users. Leave empty to keep all domains." }, "distinguished": { "title": "Distinguished (official) posts only (subreddit/profile/search modes)", "enum": [ "moderator", "admin", "special", "none" ], "type": "string", "description": "Only keep posts distinguished by Reddit as moderator, admin or special (e.g. Reddit-team) posts, or only regular (non-distinguished) posts. Has no effect on comments/communities/users. Leave unset to keep all posts." }, "minAwards": { "title": "Minimum awards received (subreddit/profile/search modes)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Only keep posts with at least this many total awards. Has no effect on comments/communities/users. Leave unset to keep all posts." }, "onlyOriginalContent": { "title": "Only original content (OC) posts (subreddit/profile/search modes)", "type": "boolean", "description": "When enabled, only posts the author tagged as original content are kept. Has no effect on comments/communities/users.", "default": false }, "excludeArchived": { "title": "Exclude archived posts (subreddit/profile/search modes)", "type": "boolean", "description": "When enabled, posts that Reddit has archived (locked from further voting/commenting after 6 months) are dropped from the results. Has no effect on comments/communities/users.", "default": false }, "excludeKeywords": { "title": "Exclude keywords (subreddit/profile/search modes)", "type": "array", "description": "Drop posts whose title, self-text body or flair contains any of these keywords or phrases (case-insensitive substring match) — useful for filtering out megathreads, giveaways or spam boilerplate. Has no effect on comments/communities/users. Leave empty to keep all posts.", "items": { "type": "string" } }, "minContentLength": { "title": "Minimum post body length (characters) (subreddit/profile/search modes)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Only keep self (text) posts whose body is at least this many characters long. Link/image/video posts have no body and are excluded when this is set. Has no effect on comments/communities/users. Leave unset to keep all lengths." }, "maxContentLength": { "title": "Maximum post body length (characters) (subreddit/profile/search modes)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Only keep self (text) posts whose body is at most this many characters long. Has no effect on comments/communities/users. Leave unset to keep all lengths." }, "authors": { "title": "Only posts by these authors (subreddit & search modes)", "type": "array", "description": "Only keep posts submitted by one of these usernames (bare name or u/-prefixed, case-insensitive). Has no effect on comments/communities/users or profile mode (already scoped to the given usernames). Leave empty to keep posts from all authors.", "items": { "type": "string" } }, "excludeAuthors": { "title": "Exclude posts by these authors (subreddit & search modes)", "type": "array", "description": "Drop posts submitted by any of these usernames (bare name or u/-prefixed, case-insensitive) — useful for filtering out bots (e.g. AutoModerator) or known spam accounts. Has no effect on comments/communities/users or profile mode. Leave empty to keep posts from all authors.", "items": { "type": "string" } }, "postType": { "title": "Only posts of this type (subreddit/profile/search modes)", "enum": [ "self", "link", "image", "video", "gallery", "poll" ], "type": "string", "description": "Keep only posts of the selected content type. Leave unset to keep all types. Has no effect on comments/communities/users." }, "minPostComments": { "title": "Minimum comments on the post (subreddit/profile/search modes)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Only keep posts that have at least this many comments (the post's own comment count — not to be confused with 'Maximum comments' above, which caps how many comment records are scraped in comments/search mode). Has no effect on comments/communities/users." }, "maxPostComments": { "title": "Maximum comments on the post (subreddit/profile/search modes)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Only keep posts that have at most this many comments. Useful for finding under-discussed posts. Has no effect on comments/communities/users." }, "minUpvoteRatio": { "title": "Minimum upvote ratio (subreddit/profile/search modes)", "minimum": 0, "maximum": 1, "type": "number", "description": "Only keep posts whose upvote ratio (fraction of votes that are upvotes, 0-1) is at or above this value. Useful for filtering out controversial/divisive posts. Has no effect on comments/communities/users." }, "excludeStickied": { "title": "Exclude stickied/pinned posts (subreddit/profile/search modes)", "type": "boolean", "description": "When enabled, posts pinned/stickied in their community are dropped from the results.", "default": false }, "excludeRemoved": { "title": "Exclude removed/deleted posts (subreddit/profile/search modes)", "type": "boolean", "description": "When enabled, posts removed by a moderator, Reddit, or deleted by their author (marker: removed_by_category) are dropped from the results.", "default": false }, "excludeCrossposts": { "title": "Exclude crossposts (subreddit/profile/search modes)", "type": "boolean", "description": "When enabled, posts that are crossposts from another subreddit are dropped, keeping only original submissions.", "default": false }, "excludeSpoilers": { "title": "Exclude spoiler-tagged posts (subreddit/profile/search modes)", "type": "boolean", "description": "When enabled, posts marked as a spoiler by their author are dropped from the results.", "default": false }, "excludeLocked": { "title": "Exclude locked posts (subreddit/profile/search modes)", "type": "boolean", "description": "When enabled, posts with comments locked by a moderator are dropped from the results.", "default": false }, "excludeDeletedAuthor": { "title": "Exclude posts with a deleted author (subreddit/profile/search modes)", "type": "boolean", "description": "When enabled, posts whose author account was deleted (shown as [deleted]/[removed]) are dropped from the results.", "default": false }, "minScore": { "title": "Minimum score (subreddit/comments/profile/search modes)", "minimum": -1000000, "maximum": 1000000, "type": "integer", "description": "Only keep posts/comments with a score (upvotes minus downvotes) at or above this value. Leave unset to keep all scores." }, "maxScore": { "title": "Maximum score (subreddit/comments/profile/search modes)", "minimum": -1000000, "maximum": 1000000, "type": "integer", "description": "Only keep posts/comments with a score (upvotes minus downvotes) at or below this value. Useful for finding overlooked/low-visibility items. Leave unset to keep all scores." }, "minCommunitySubscribers": { "title": "Minimum community subscribers (search / discover modes)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Only keep communities (subreddits) with at least this many subscribers. Applies when 'Search communities' is enabled (search mode) or always (discover mode). Leave unset to keep all sizes." }, "maxCommunitySubscribers": { "title": "Maximum community subscribers (search / discover modes)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Only keep communities (subreddits) with at most this many subscribers. Useful for finding small/niche communities. Applies when 'Search communities' is enabled (search mode) or always (discover mode). Leave unset to keep all sizes." }, "minUserKarma": { "title": "Minimum total karma (search mode)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Only keep Reddit accounts with at least this much total karma. Applies when 'Search users' is enabled; ignored otherwise. Leave unset to keep all accounts." }, "maxUserKarma": { "title": "Maximum total karma (search mode)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Only keep Reddit accounts with at most this much total karma. Useful for finding newer/low-karma accounts. Applies when 'Search users' is enabled; ignored otherwise. Leave unset to keep all accounts." }, "postedAfter": { "title": "Created on or after (YYYY-MM-DD)", "type": "string", "description": "Only keep posts/comments created on or after this date (UTC)." }, "postedBefore": { "title": "Created on or before (YYYY-MM-DD)", "type": "string", "description": "Only keep posts/comments created on or before this date (UTC)." } } }, "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 } } } } } } } } } }