{ "openapi": "3.0.1", "info": { "title": "Reddit Scraper", "description": "Scrape public Reddit posts and comments from subreddit, search, user, and thread RSS feeds without Reddit API credentials.", "version": "0.1", "x-build-id": "9KPn23rv62eFAKYF9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetch_cat~reddit-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetch_cat-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/fetch_cat~reddit-scraper/runs": { "post": { "operationId": "runs-sync-fetch_cat-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/fetch_cat~reddit-scraper/run-sync": { "post": { "operationId": "run-sync-fetch_cat-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": { "urls": { "title": "Reddit URLs", "type": "array", "description": "Subreddit, post, comment, user profile, or Reddit search URLs to scrape.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQuery": { "title": "Search query", "type": "string", "description": "Optional Reddit search query. Used with global Reddit search unless Search subreddit is filled." }, "searchSubreddit": { "title": "Search subreddit", "type": "string", "description": "Optional subreddit name for restricting searchQuery, for example technology or webscraping." }, "sort": { "title": "Sort order", "enum": [ "hot", "new", "top", "rising", "relevance" ], "type": "string", "description": "Sort mode for subreddit listings and search feeds.", "default": "hot" }, "timeFilter": { "title": "Time filter", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time window for top/search RSS feeds.", "default": "week" }, "maxPostsPerSource": { "title": "Maximum posts per source", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of post records to save from each URL or query source.", "default": 20 }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Fetch comments for discovered post URLs using Reddit comments RSS. Best-effort and limited by maxCommentsPerPost.", "default": false }, "maxCommentsPerPost": { "title": "Maximum comments per post", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum number of comment records to save per post when comments are enabled.", "default": 10 }, "commentContextMode": { "title": "Comment URL mode", "enum": [ "focused", "post" ], "type": "string", "description": "For comment URLs, fetch the focused context when Reddit RSS supports it, otherwise fetch the post comment feed.", "default": "focused" }, "commentContextDepth": { "title": "Comment context depth", "minimum": 0, "maximum": 10, "type": "integer", "description": "Context depth parameter for focused comment RSS URLs.", "default": 3 }, "retryCount": { "title": "Retry attempts per Reddit request", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum retry attempts for Reddit RSS requests after rate limits, proxy resets, or temporary server errors.", "default": 2 }, "initialRetryDelayMillis": { "title": "Initial retry delay (ms)", "minimum": 250, "maximum": 30000, "type": "integer", "description": "Base delay for exponential backoff after Reddit rate limits or proxy errors. Retry-After headers are respected when Reddit sends them.", "default": 750 }, "requestPacingMillis": { "title": "Request pacing delay (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Minimum delay between Reddit RSS requests. Increase this for large comment-heavy runs if Reddit returns 429 or proxy errors.", "default": 750 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Residential Apify Proxy is recommended because Reddit often rate-limits shared datacenter traffic.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }