{ "openapi": "3.0.1", "info": { "title": "Reddit API Scraper", "description": "Scrape Reddit posts, comments, search results, subreddits, and user profiles via Reddit's OAuth data API. No login required.", "version": "0.1", "x-build-id": "OeXmLDM6Z28jS4bqT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rl1987~reddit-api-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rl1987-reddit-api-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/rl1987~reddit-api-scraper/runs": { "post": { "operationId": "runs-sync-rl1987-reddit-api-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/rl1987~reddit-api-scraper/run-sync": { "post": { "operationId": "run-sync-rl1987-reddit-api-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": "Subreddits to scrape post listings from. Accepts names (`programming`), `r/`-prefixed names, or full URLs (`https://www.reddit.com/r/programming`).", "items": { "type": "string" } }, "sort": { "title": "Subreddit sort", "enum": [ "hot", "new", "top", "rising", "controversial" ], "type": "string", "description": "Sort order for subreddit post listings.", "default": "hot" }, "time": { "title": "Time window", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time window for the `top` and `controversial` sorts (ignored otherwise).", "default": "all" }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Full-text search queries to run against Reddit. Each query is executed and its result posts are pushed to the dataset.", "items": { "type": "string" } }, "searchSort": { "title": "Search sort", "enum": [ "relevance", "hot", "top", "new", "comments" ], "type": "string", "description": "Sort order for search results.", "default": "relevance" }, "searchInSubreddits": { "title": "Restrict search to subreddits", "type": "boolean", "description": "When enabled, each search query is restricted to each subreddit listed in the Subreddits field (searches `r/{subreddit}/search` with `restrict_sr=true`). When disabled, searches are global.", "default": false }, "postUrls": { "title": "Post URLs / IDs", "type": "array", "description": "Individual Reddit posts to fetch (including full self-text and comment threads). Accepts full permalinks, `comments/{id}` URLs, base-36 IDs, or `t3_`-prefixed fullnames.", "items": { "type": "string" } }, "usernames": { "title": "Usernames", "type": "array", "description": "Reddit users to scrape. Fetches the profile and, per the `User content` option, their posts and/or comments. Accepts names, `u/`-prefixed names, or profile URLs.", "items": { "type": "string" } }, "userContent": { "title": "User content", "enum": [ "overview", "submitted", "comments", "about" ], "type": "string", "description": "Which content to fetch for each username.", "default": "overview" }, "includeComments": { "title": "Include comments for scraped posts", "type": "boolean", "description": "Fetch and output the comment tree for every post collected from subreddits and searches (in addition to posts given directly in Post URLs, whose comments are always fetched).", "default": false }, "maxComments": { "title": "Max comments per post", "minimum": 0, "type": "integer", "description": "Upper bound on the number of comments emitted per post. 0 = no comments (post only).", "default": 50 }, "commentSort": { "title": "Comment sort", "enum": [ "confidence", "top", "new", "controversial", "old", "qa" ], "type": "string", "description": "Sort order for comment threads.", "default": "confidence" }, "maxItemsPerSource": { "title": "Max posts per source", "minimum": 0, "type": "integer", "description": "Maximum posts to collect from each individual subreddit, search query, or user listing. 0 = unlimited (fetch until the API runs out).", "default": 100 }, "includeNsfw": { "title": "Include NSFW (over-18) results", "type": "boolean", "description": "Include NSFW results in search output.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Reddit rate-limits per IP and per OAuth token (~100 req/min); residential or datacenter proxies help distribute load. Recommended for larger runs.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }