{ "openapi": "3.0.1", "info": { "title": "Reddit Scraper - Posts, Comments & Search (GDPR modes)", "description": "Scrape Reddit posts and comments from subreddits, search or post URLs, with optional GDPR modes (omit or pseudonymize usernames). No profile scraping. $0.0015 per post, $0.0006 per comment.", "version": "0.1", "x-build-id": "J6Z7Mok3JDqXUrB2A" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/admirala~reddit-scraper-gdpr/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-admirala-reddit-scraper-gdpr", "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/admirala~reddit-scraper-gdpr/runs": { "post": { "operationId": "runs-sync-admirala-reddit-scraper-gdpr", "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/admirala~reddit-scraper-gdpr/run-sync": { "post": { "operationId": "run-sync-admirala-reddit-scraper-gdpr", "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": "Subreddit names without r/, e.g. [\"python\", \"datascience\"].", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Optional Reddit search terms, e.g. [\"web scraping\"]. Combined with Subreddits = search inside those subreddits.", "items": { "type": "string" } }, "postUrls": { "title": "Post URLs", "type": "array", "description": "Optional direct Reddit post links, e.g. [\"https://www.reddit.com/r/python/comments/abc123/title/\"].", "items": { "type": "string" } }, "sort": { "title": "Sort", "enum": [ "hot", "new", "top", "rising", "relevance", "comments" ], "type": "string", "description": "Subreddits: hot/new/top/rising. Search: relevance/new/top/comments.", "default": "hot" }, "time": { "title": "Time range (top/search)", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time window for 'top' and search.", "default": "week" }, "maxPosts": { "title": "Max posts per source", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum posts per subreddit or search query (1-1000).", "default": 25 }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Also fetch comments of each post ($0.0006 per comment).", "default": false }, "maxComments": { "title": "Max comments per post", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum comments per post (1-500), top-level and replies, in Reddit's order.", "default": 50 }, "authorMode": { "title": "Usernames", "enum": [ "include", "omit", "pseudonymize" ], "type": "string", "description": "include = Reddit usernames as shown publicly (default). omit = no usernames, u/ mentions in text masked. pseudonymize = random per-run ID per author (same author = same ID within one run). Profiles are never scraped.", "default": "include" } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }