{ "openapi": "3.0.1", "info": { "title": "Reddit Scraper", "description": "Scrape Reddit posts, comments, search results, and user profiles. No API keys or browser needed. Supports 4 modes: subreddit posts (hot/new/top/rising), Reddit search, user profiles, and full comment trees. Fast, lightweight HTTP-based scraping with built-in rate limiting and retry logic.", "version": "0.0", "x-build-id": "6nqA2dIJvpkOgm1dr" }, "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" ], "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 when sorting by Top. Only applies when sort is 'Top'.", "default": "week" }, "searchQuery": { "title": "🔍 Search Query", "type": "string", "description": "Keyword or phrase to search across Reddit. 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. Overrides the single Search Query field when provided. Ideal for brand monitoring, competitor research, and topic mapping. Example: [\"ChatGPT vs Claude\", \"best LLM 2025\", \"AI coding assistant\"]" }, "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.", "default": "relevance" }, "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. Set to 0 for no limit.", "default": 100 }, "maxResults": { "title": "🔢 Max Results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of results to return. Free users are limited to 25 results per run. Subscribe for 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. Slower and uses more proxy traffic.", "default": false }, "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 } } }, "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 } } } } } } } } } }