{ "openapi": "3.0.1", "info": { "title": "Reddit Scraper - Posts, Comments, Search & Subreddits", "description": "Scrape Reddit posts and top comments from subreddits and keyword searches using each user's free Reddit API credentials. Export structured Reddit data for social listening, market research, and AI workflows.", "version": "0.1", "x-build-id": "42rVoMtET389N33bw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/groupoject~reddit-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-groupoject-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/groupoject~reddit-scraper/runs": { "post": { "operationId": "runs-sync-groupoject-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/groupoject~reddit-scraper/run-sync": { "post": { "operationId": "run-sync-groupoject-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": [ "redditClientId", "redditClientSecret" ], "properties": { "redditClientId": { "title": "Reddit Client ID", "type": "string", "description": "Your Reddit app's Client ID. Create a free app at https://www.reddit.com/prefs/apps → 'create another app...' → choose type 'script'. The Client ID is the short string shown directly under the app's name." }, "redditClientSecret": { "title": "Reddit Client Secret", "type": "string", "description": "Your Reddit app's Secret (labelled 'secret' on the app page at https://www.reddit.com/prefs/apps). Kept encrypted; each user brings their own so rate limits are per-account." }, "subreddits": { "title": "Subreddits", "type": "array", "description": "Subreddit names to scrape, without the 'r/' prefix (e.g. 'python', 'dataisbeautiful').", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Optional keyword searches run against Reddit's site-wide search. One record per matching post.", "items": { "type": "string" } }, "sort": { "title": "Sort", "enum": [ "hot", "new", "top", "rising" ], "type": "string", "description": "How to sort posts within each source.", "default": "hot" }, "time": { "title": "Time range (for 'top' sort)", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time window applied only when sort is 'top'.", "default": "week" }, "maxItems": { "title": "Max items per source", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of posts to collect per subreddit or search query.", "default": 50 }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "If enabled, fetch the top comments for each post (slower, extra requests).", "default": false }, "maxComments": { "title": "Max comments per post", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of top-level comments to collect per post when 'Include comments' is enabled.", "default": 10 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. The official Reddit API usually works best without proxy; add Apify Proxy only if your environment requires it." } } }, "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 } } } } } } } } } }