{ "openapi": "3.0.1", "info": { "title": "Cheapest Reddit Scraper API", "description": "Scrape Reddit subreddit posts, post details, comments, search results, and user profiles via the public JSON API. Supports pagination, multiple targets per run, and configurable sort orders.", "version": "0.0", "x-build-id": "zMVzUfRp7rp5Vp4va" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scoutlayer~cheapest-reddit-scraper-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scoutlayer-cheapest-reddit-scraper-api", "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/scoutlayer~cheapest-reddit-scraper-api/runs": { "post": { "operationId": "runs-sync-scoutlayer-cheapest-reddit-scraper-api", "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/scoutlayer~cheapest-reddit-scraper-api/run-sync": { "post": { "operationId": "run-sync-scoutlayer-cheapest-reddit-scraper-api", "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": [ "scrapeType" ], "properties": { "scrapeType": { "title": "Scrape Type", "enum": [ "subreddit", "post", "comments", "search", "user" ], "type": "string", "description": "Select what type of data to scrape from Reddit.", "default": "subreddit" }, "maxPages": { "title": "Max Pages (Global Default)", "minimum": 1, "type": "integer", "description": "Global fallback for max pages across all paginated types (Subreddit Posts, Search) when no type-specific limit is set. Each page returns up to 100 posts.", "default": 3 }, "subreddits": { "title": "Subreddits", "type": "array", "description": "Subreddit names or URLs to scrape posts from, e.g. \"programming\" or \"https://www.reddit.com/r/programming/\". Required for Scrape Type: Subreddit Posts.", "items": { "type": "string" } }, "sort": { "title": "Sort Order", "enum": [ "hot", "new", "top", "rising" ], "type": "string", "description": "Sort order for subreddit posts.", "default": "hot" }, "maxSubredditPages": { "title": "Max Subreddit Pages", "minimum": 1, "type": "integer", "description": "Maximum number of pages to scrape per subreddit. Each page returns up to 100 posts. Falls back to \"Max Pages (Global Default)\" if not set.", "default": 3 }, "postUrls": { "title": "Post URLs or IDs", "type": "array", "description": "Reddit post URLs (e.g. \"https://www.reddit.com/r/programming/comments/abc123/title/\") or short IDs (e.g. \"abc123\"). Required for Scrape Type: Post Detail.", "items": { "type": "string" } }, "commentPostUrls": { "title": "Post URLs or IDs (Comments)", "type": "array", "description": "Reddit post URLs or short IDs to fetch comments for. Required for Scrape Type: Post Comments.", "items": { "type": "string" } }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "Search keywords to query Reddit for, e.g. \"machine learning\" or \"rust programming\". Required for Scrape Type: Search.", "items": { "type": "string" } }, "searchSort": { "title": "Search Sort Order", "enum": [ "relevance", "new", "top", "comments" ], "type": "string", "description": "Sort order for search results.", "default": "relevance" }, "searchSubreddit": { "title": "Restrict to Subreddit", "type": "string", "description": "Optional. Restrict search results to a specific subreddit (e.g. \"programming\"). Leave blank to search all of Reddit." }, "maxSearchPages": { "title": "Max Search Pages", "minimum": 1, "type": "integer", "description": "Maximum number of result pages to scrape per query. Each page returns up to 100 posts. Falls back to \"Max Pages (Global Default)\" if not set.", "default": 3 }, "usernames": { "title": "Usernames", "type": "array", "description": "Reddit usernames to fetch public profiles for, e.g. \"spez\". Required for Scrape Type: User Profile.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }