{ "openapi": "3.0.1", "info": { "title": "Reddit Posts Scraper — Subreddit, Search, User & Thread JSON", "description": "Scrape Reddit posts, comments, user submissions and search results via public JSON endpoints. PPE pricing, MCP-native, clean markdown output for RAG pipelines.", "version": "0.1", "x-build-id": "PPm3pSm6gLkzN4qn0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tugelbay~reddit-posts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tugelbay-reddit-posts-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/tugelbay~reddit-posts-scraper/runs": { "post": { "operationId": "runs-sync-tugelbay-reddit-posts-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/tugelbay~reddit-posts-scraper/run-sync": { "post": { "operationId": "run-sync-tugelbay-reddit-posts-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", "properties": { "subreddits": { "title": "Subreddits", "type": "array", "description": "Subreddit names (without r/). The scraper will fetch posts from each using the selected sort.", "items": { "type": "string" } }, "search": { "title": "Search query", "type": "string", "description": "Reddit-wide keyword search. If set, subreddits are ignored. Supports Reddit search operators (author:, subreddit:, etc)." }, "users": { "title": "User handles", "type": "array", "description": "Reddit usernames (without u/). Fetches each user's submitted posts. If set, subreddits/search are ignored.", "items": { "type": "string" } }, "postIds": { "title": "Post IDs", "type": "array", "description": "Specific post IDs (e.g. '1k0abc') to fetch directly with full content. If set, all other sources are ignored.", "items": { "type": "string" } }, "sort": { "title": "Sort", "enum": [ "hot", "new", "top", "rising", "controversial" ], "type": "string", "description": "How to sort listings (ignored for postIds).", "default": "hot" }, "timeframe": { "title": "Timeframe (for top/controversial)", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Only used when sort is 'top' or 'controversial'.", "default": "day" }, "maxItems": { "title": "Max posts", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of posts to return across all sources. Each post counts as one PPE event. Increase after trying the free sample.", "default": 10 }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Fetch the comment tree for each post. Slower and more requests. Leave off for feed-scanning use cases.", "default": false }, "maxComments": { "title": "Max comments per post", "minimum": 1, "maximum": 500, "type": "integer", "description": "Only used when Include comments is on.", "default": 20 }, "maxCommentDepth": { "title": "Max comment depth", "minimum": 0, "maximum": 10, "type": "integer", "description": "How deep to traverse reply threads. 0 = top-level only, 3 = includes replies-of-replies-of-replies.", "default": 3 }, "outputFormat": { "title": "Output format", "enum": [ "full", "minimal", "rag" ], "type": "string", "description": "'full' includes every Reddit field. 'minimal' keeps just the key fields. 'rag' outputs a single Markdown block per post, ready to ingest into a vector DB.", "default": "full" }, "skipNsfw": { "title": "Skip NSFW posts", "type": "boolean", "description": "Filter out posts marked over_18 by Reddit.", "default": false }, "minScore": { "title": "Minimum score", "minimum": 0, "type": "integer", "description": "Drop posts with fewer upvotes than this. 0 = no filter.", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Reddit blocks datacenter IPs — residential is required. The default uses Apify's RESIDENTIAL group.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }