{ "openapi": "3.0.1", "info": { "title": "Reddit Multi-Mode Scraper with Advanced Pro Filters", "description": "Scrape Reddit subreddit posts, post comment threads, and user profile posts, with any combination of modes in a single run. Filter by score, age, NSFW status, keyword, author, or comment depth before anything is saved. No login required.", "version": "2.0", "x-build-id": "8NqcUjPnceaJI8pg3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~reddit-multi-mode-scraper-with-advanced-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-reddit-multi-mode-scraper-with-advanced-pro", "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/vexaloom-labs~reddit-multi-mode-scraper-with-advanced-pro/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-reddit-multi-mode-scraper-with-advanced-pro", "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/vexaloom-labs~reddit-multi-mode-scraper-with-advanced-pro/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-reddit-multi-mode-scraper-with-advanced-pro", "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": { "mode": { "title": "Mode (single)", "enum": [ "posts", "comments", "search", "users", "subreddits" ], "type": "string", "description": "Run one mode. Prefer `modes` to combine modes in a single run.", "default": "posts" }, "modes": { "title": "Modes (run several at once)", "type": "array", "description": "Run multiple modes in one execution, for example [\"posts\", \"search\"]. When set, this overrides the single `mode` field.", "default": [ "posts" ], "items": { "type": "string" } }, "subreddits": { "title": "Subreddits", "type": "array", "description": "Communities to read for posts, comments or subreddit details. Accepts bare names, r/ prefixes, or full Reddit URLs.", "default": [ "python" ], "items": { "type": "string" } }, "searchQueries": { "title": "Search keywords or phrases", "type": "array", "description": "Keywords for search mode. Supports Reddit search syntax such as author:, flair:, site:, quotes, AND/OR/NOT and -exclusions.", "default": [ "python" ], "items": { "type": "string" } }, "searchType": { "title": "Search result type", "enum": [ "posts", "comments", "both" ], "type": "string", "description": "Search for posts, comments, or both.", "default": "posts" }, "searchSort": { "title": "Search sort order", "enum": [ "relevance", "hot", "top", "new", "comments" ], "type": "string", "description": "How to order search results.", "default": "relevance" }, "withinCommunity": { "title": "Search inside one community (optional)", "type": "string", "description": "Restrict search results to a single subreddit. Leave empty to search all of Reddit." }, "maxSearchResults": { "title": "Maximum search results per query", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap search results (posts or comments) for each query.", "default": 50 }, "enrichSearchResults": { "title": "Load full post details for search results", "type": "boolean", "description": "Open the first few search-result posts to fill score, comment count, body and media. Disable for the fastest search runs.", "default": true }, "postUrls": { "title": "Post URLs or IDs (comments mode)", "type": "array", "description": "Reddit post URLs or bare post IDs to read comment trees from.", "items": { "type": "string" } }, "usernames": { "title": "Usernames (users mode)", "type": "array", "description": "Reddit users to read. Accepts plain names, u/ prefixes, or full profile URLs.", "items": { "type": "string" } }, "section": { "title": "Profile section", "enum": [ "overview", "submitted", "comments" ], "type": "string", "description": "Which part of a user's profile to read.", "default": "submitted" }, "sort": { "title": "Post sort order", "enum": [ "hot", "new", "top", "rising", "controversial", "best" ], "type": "string", "description": "How to sort subreddit listings and profile posts.", "default": "hot" }, "timeFilter": { "title": "Time window", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time range for top/controversial sorts and search.", "default": "day" }, "commentSort": { "title": "Comment sort order", "enum": [ "confidence", "top", "new", "controversial", "old", "qa" ], "type": "string", "description": "How to order comments inside a thread.", "default": "confidence" }, "maxPosts": { "title": "Maximum posts per community or user", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many posts for each subreddit or profile.", "default": 25 }, "maxComments": { "title": "Maximum comments per post", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many comments for each post URL.", "default": 100 }, "maxItems": { "title": "Maximum total records", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Global safety cap for the whole run, across all modes.", "default": 1000 }, "expandThreads": { "title": "Expand comment trees", "type": "boolean", "description": "Load collapsed 'more comments' branches and additional profile pages when available.", "default": true }, "includePost": { "title": "Include the post alongside its comments", "type": "boolean", "description": "Emit the parent post record in comments mode in addition to its comments.", "default": false }, "includeSubredditInfo": { "title": "Include community details with posts", "type": "boolean", "description": "Emit one subreddit metadata record per community in posts mode.", "default": false }, "includeRules": { "title": "Include community rules", "type": "boolean", "description": "Add the public rules list to subreddit metadata records.", "default": false }, "minScore": { "title": "Minimum score", "minimum": -10000000, "maximum": 10000000, "type": "integer", "description": "Drop posts and comments with a lower score. Leave empty for no minimum." }, "maxScore": { "title": "Maximum score", "minimum": -10000000, "maximum": 10000000, "type": "integer", "description": "Drop posts and comments with a higher score. Leave empty for no maximum." }, "minComments": { "title": "Minimum post comment count", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Keep only posts that have at least this many comments." }, "maxPostComments": { "title": "Maximum post comment count", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Keep only posts that have at most this many comments." }, "minUpvoteRatio": { "title": "Minimum upvote ratio", "minimum": 0, "maximum": 1, "type": "number", "description": "Keep only posts at or above this upvote ratio (0 to 1)." }, "maxAgeDays": { "title": "Maximum age in days", "minimum": 1, "maximum": 36500, "type": "integer", "description": "Drop posts and comments older than this many days." }, "postedAfter": { "title": "Posted on or after", "type": "string", "description": "Keep only posts created on or after this date (YYYY-MM-DD, UTC)." }, "postedBefore": { "title": "Posted on or before", "type": "string", "description": "Keep only posts created on or before this date (YYYY-MM-DD, UTC)." }, "postType": { "title": "Post type", "enum": [ "all", "self", "link", "image", "video", "gallery", "poll", "crosspost", "gif", "multi_media" ], "type": "string", "description": "Keep only posts of this type. Choose 'all' to keep every type.", "default": "all" }, "excludeStickied": { "title": "Exclude stickied posts", "type": "boolean", "description": "Drop pinned/stickied posts from listings and search results.", "default": false }, "excludeNsfw": { "title": "Exclude NSFW posts", "type": "boolean", "description": "Drop posts Reddit flags as NSFW (18+).", "default": false }, "keywordFilter": { "title": "Keyword filter", "type": "string", "description": "Keep only posts or comments whose title, body or text contains this text (case-insensitive)." }, "authorFilter": { "title": "Author contains", "type": "string", "description": "Keep only records whose author name contains this text (case-insensitive)." }, "authorAllowlist": { "title": "Only these authors", "type": "array", "description": "Keep only records by these exact usernames (case-insensitive).", "items": { "type": "string" } }, "authorBlocklist": { "title": "Exclude these authors", "type": "array", "description": "Drop records by these exact usernames (case-insensitive).", "items": { "type": "string" } }, "flairFilter": { "title": "Flair contains", "type": "string", "description": "Keep only posts whose link flair contains this text (case-insensitive)." }, "domainFilter": { "title": "Link domain contains", "type": "string", "description": "Keep only posts whose link domain contains this text (case-insensitive)." }, "maxDepth": { "title": "Maximum comment depth", "minimum": 0, "maximum": 100, "type": "integer", "description": "In comments mode, drop comments nested deeper than this level." } } }, "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 } } } } } } } } } }