{ "openapi": "3.0.1", "info": { "title": "Reddit Subreddit Scraper", "description": "Scrape Reddit subreddit posts, metadata, scores, media, comment counts, and optional top-comment previews. MCP optimized for SEO, social listening, and AI agents. $0.002/post.", "version": "0.1", "x-build-id": "d2mQzciuK5fPkZoHK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~reddit-subreddit-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-reddit-subreddit-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/khadinakbar~reddit-subreddit-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-reddit-subreddit-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/khadinakbar~reddit-subreddit-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-reddit-subreddit-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": [ "subreddits" ], "properties": { "subreddits": { "title": "Subreddits", "type": "array", "description": "Reddit subreddit names or URLs to scrape. Accepts r/MachineLearning, MachineLearning, or https://www.reddit.com/r/MachineLearning. AI agents should put subreddit targets here, not in query.", "items": { "type": "string" } }, "query": { "title": "Search within each subreddit", "type": "string", "description": "Optional keyword or phrase. When set, the actor searches inside every requested subreddit instead of returning the general feed. Leave empty for the normal hot/new/top/rising subreddit feed." }, "sort": { "title": "Post sort", "enum": [ "hot", "new", "top", "rising", "controversial" ], "type": "string", "description": "How to order posts. Use hot for trending discussions, new for fresh monitoring, top for highest scoring posts, rising for fast-moving posts, and controversial for polarizing threads.", "default": "hot" }, "timeRange": { "title": "Time range", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time window for top, controversial, and search results. Ignored by hot, new, and rising feeds.", "default": "week" }, "maxPosts": { "title": "Max posts", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Maximum number of post records to return across all subreddits. Billing stops when this cap is reached.", "default": 100 }, "includeSubredditInfo": { "title": "Include subreddit metadata", "type": "boolean", "description": "When true, adds one subreddit metadata record per subreddit with subscriber count, description, NSFW flag, type, icon, and banner.", "default": true }, "includeTopComments": { "title": "Include top comment previews", "type": "boolean", "description": "When true, each post record includes a compact topComments array. Use this for AI summaries and sentiment analysis. Leave off for faster, cheaper post-only extraction.", "default": false }, "maxTopCommentsPerPost": { "title": "Max top comments per post", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of top comments to embed in each post when includeTopComments is enabled.", "default": 5 }, "postDateLimit": { "title": "Ignore posts older than", "type": "string", "description": "Optional ISO date. Example: 2026-01-01. Posts older than this are skipped after retrieval." }, "includeNsfw": { "title": "Include NSFW posts", "type": "boolean", "description": "Disabled by default for business research and AI-agent workflows. Enable only when you intentionally need NSFW subreddit content.", "default": false }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Defaults to Apify Residential proxies because Reddit often blocks datacenter IPs. Leave unchanged unless you know your target and plan requirements.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "redditClientId": { "title": "Reddit client ID (optional)", "type": "string", "description": "Optional Reddit app client ID. Leave blank to use owner-managed access when configured. Create a free app at reddit.com/prefs/apps if you want to use your own credentials." }, "redditClientSecret": { "title": "Reddit client secret (optional)", "type": "string", "description": "Optional Reddit app client secret paired with redditClientId. This is not your Reddit password." } } }, "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 } } } } } } } } } }