{ "openapi": "3.0.1", "info": { "title": "Reddit Api Scraper", "description": "Extract structured data from Reddit quickly and reliably with the Reddit API Scraper. Collect posts, comments, subreddit details, user profiles, upvotes, timestamps, and more using the official API. Ideal for research, monitoring trends, sentiment analysis, and building Reddit datasets at scale.", "version": "0.1", "x-build-id": "gI3mpUtJZc0dnufFp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapier~reddit-api-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapier-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/scrapier~reddit-api-scraper/runs": { "post": { "operationId": "runs-sync-scrapier-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/scrapier~reddit-api-scraper/run-sync": { "post": { "operationId": "run-sync-scrapier-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", "required": [ "searchKeywords" ], "properties": { "searchKeywords": { "title": "🔑 Search keywords (required)", "type": "array", "description": "Enter the words or phrases you want to search on Reddit (e.g. webscraping, python, ChatGPT, AI). You can add multiple keywords — use + Add or Bulk edit. Each keyword is searched across Reddit and results are grouped by keyword in the output. One keyword per line in bulk mode.", "items": { "type": "string" } }, "subredditNames": { "title": "📌 Subreddit names", "type": "array", "description": "Optional. Restrict search to specific subreddits only (e.g. python, programming, learnprogramming). Leave empty to search all of Reddit. Add multiple with + Add or Bulk edit. Improves relevance when you know which communities to target.", "items": { "type": "string" } }, "resultsLimitPerKeyword": { "title": "📊 Results limit per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of posts to fetch per keyword (1–1000). Higher values may take longer and can trigger rate limits; the actor uses delays and retries to stay safe. Start with 10–50 for testing. Default: 10.", "default": 10 }, "sorting": { "title": "📅 Sorting", "enum": [ "new", "hot", "top", "relevance" ], "type": "string", "description": "How Reddit search results are ordered: New (latest first), Hot (trending now), Top (most upvoted), or Relevance (best match to your keyword). Default: New.", "default": "new" }, "proxyConfiguration": { "title": "🌐 Proxy configuration", "type": "object", "description": "By default no proxy is used (direct requests to Reddit). If Reddit blocks or rate-limits the request, the actor automatically falls back to datacenter proxy, then to residential proxy (with up to 3 retries). Once it switches to residential, it stays on residential for all remaining requests. Turn on Apify Proxy here if you want to use proxy from the very first request." } } }, "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 } } } } } } } } } }