{ "openapi": "3.0.1", "info": { "title": "Reddit Scraper", "description": "Reddit scraper that extracts posts, comments, communities, and user profiles from any subreddit or search query, so marketers and researchers can collect structured Reddit data without API keys or login.", "version": "0.0", "x-build-id": "8o68tVsQv7cXGZHhb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kawsar~reddit-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kawsar-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/kawsar~reddit-scraper/runs": { "post": { "operationId": "runs-sync-kawsar-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/kawsar~reddit-scraper/run-sync": { "post": { "operationId": "run-sync-kawsar-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": "Start URLs", "type": "array", "description": "List of Reddit URLs to scrape. Supports subreddits (e.g. https://www.reddit.com/r/programming/), posts, user profiles, and search result pages. Leave blank if you are using the Search Terms field instead.", "items": { "type": "string" } }, "scrapeType": { "title": "Scrape Type", "enum": [ "posts", "comments", "communities", "users" ], "type": "string", "description": "What data to extract from the Subreddit/Search inputs (Posts by default).", "default": "posts" }, "searches": { "title": "Search Terms", "type": "array", "description": "Keywords to search for on Reddit. Each term triggers a search and returns matching posts, communities, and users. Do not combine with Start URLs.", "items": { "type": "string" } }, "searchCommunityName": { "title": "Search Within Community", "type": "string", "description": "Limit the keyword search to a specific subreddit. Enter only the community name without r/ (e.g. 'programming'). Only applies when Search Terms are provided." }, "sort": { "title": "Sort By", "enum": [ "hot", "new", "top", "relevance", "comments" ], "type": "string", "description": "Sort order for search results and subreddit listings.", "default": "hot" }, "time": { "title": "Time Filter", "enum": [ "all", "hour", "day", "week", "month", "year" ], "type": "string", "description": "Filter results by time period. Only applies when searching posts or sorting by Top.", "default": "all" }, "includeNSFW": { "title": "Include NSFW Content", "type": "boolean", "description": "Toggle to include adult or NSFW (Not Safe For Work) content in search results. Disabled by default.", "default": false }, "skipComments": { "title": "Skip Comments", "type": "boolean", "description": "If enabled, comments will not be extracted when scraping post pages. Speeds up runs when you only need post data.", "default": false }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of result items to collect per run (posts, comments, users, communities combined). Increase for larger datasets.", "default": 100 }, "timeoutSecs": { "title": "Actor Timeout (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "Maximum total runtime for the actor in seconds. The run stops after this time even if maxItems has not been reached.", "default": 300 }, "requestTimeoutSecs": { "title": "Request Timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Timeout for each individual HTTP request to Reddit. Requests that exceed this time are skipped.", "default": 30 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Select proxies to use for requests. Helps avoid IP blocking and rate limits. Datacenter proxies are fastest; Residential proxies are harder to detect.", "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 } } } } } } } } } }