{ "openapi": "3.0.1", "info": { "title": "Reddit Scraper", "description": "Scrape Reddit posts, comments, users, and subreddits without login. Native nested comment trees, accurate in-subreddit search, fast direct JSON API. First 100 results free.", "version": "0.6", "x-build-id": "SYcXnY7ZP0cQExxXl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/modnine~reddit-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-modnine-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/modnine~reddit-scraper/runs": { "post": { "operationId": "runs-sync-modnine-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/modnine~reddit-scraper/run-sync": { "post": { "operationId": "run-sync-modnine-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", "properties": { "startUrls": { "title": "Reddit URLs", "type": "array", "description": "Subreddit, post, or user URLs to scrape. Examples:\n- https://www.reddit.com/r/python/\n- https://www.reddit.com/r/python/top/\n- https://www.reddit.com/r/python/comments/abc123/title/\n- https://www.reddit.com/user/spez/\n\nLeave empty to use Search instead.", "default": [], "items": { "type": "string" } }, "searches": { "title": "Search queries", "type": "array", "description": "Optional Reddit search queries. Each query produces matching posts. Use `searchSubreddit` to scope to one community for relevance.", "default": [], "items": { "type": "string" } }, "searchSubreddit": { "title": "Restrict search to subreddit", "type": "string", "description": "If set, search runs inside this subreddit only (no leading r/). Strongly recommended — global Reddit search returns noisy results." }, "scrapeMode": { "title": "What to scrape", "enum": [ "auto", "subreddit", "post", "user", "search" ], "type": "string", "description": "How to interpret the URLs. `auto` detects each URL's kind (subreddit / post / user). Use the explicit modes only if you want to override that or your URLs are unusual.", "default": "auto" }, "sort": { "title": "Sort", "enum": [ "hot", "new", "top", "rising", "controversial", "relevance" ], "type": "string", "description": "How to sort subreddit listings and search results.", "default": "hot" }, "time": { "title": "Time window (for `top`)", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time filter when sort=top.", "default": "week" }, "maxItems": { "title": "Max items per run", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on dataset items across all sources combined. Posts, comments, users count as 1 item each.", "default": 100 }, "maxPostsPerSource": { "title": "Max posts per subreddit / search / user", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many posts to take from each subreddit, search, or user page before moving on.", "default": 25 }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "When scraping posts, also fetch their comment trees. Adds 1 request per post. Comments count toward `maxItems`.", "default": false }, "maxCommentsPerPost": { "title": "Max comments per post", "minimum": 0, "maximum": 500, "type": "integer", "description": "Cap on comments per post (top-level + nested). Reddit's default page is ~200.", "default": 50 }, "nestedComments": { "title": "Nested comment tree", "type": "boolean", "description": "If true, comments are emitted as nested trees with `replies[]` filled in. If false (default), each comment is a separate flat dataset item with `parent_id`.", "default": false }, "includeNSFW": { "title": "Include NSFW content", "type": "boolean", "description": "If false, NSFW posts are filtered out client-side and `include_over_18=false` is sent to Reddit's listing endpoint.", "default": true }, "postsAfter": { "title": "Skip posts before this date (UTC, YYYY-MM-DD)", "type": "string", "description": "Only emit posts created on or after this date. Leave empty to include everything. Saves cost on large subreddits." }, "requestDelay": { "title": "Delay between requests (seconds)", "minimum": 0, "maximum": 30, "type": "integer", "description": "Pause between paginated requests. 0 is fine for residential proxies; raise to 1-2 if you hit rate-limits.", "default": 1 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is recommended (RESIDENTIAL group). Datacenter IPs are blocked by Reddit.", "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 } } } } } } } } } }