{ "openapi": "3.0.1", "info": { "title": "Stallion Reddit Scraper Pro", "description": null, "version": "0.0", "x-build-id": "9lYNZV0zOGUK5XJVt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/busy_evidence~stallion-reddit-scraper-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-busy_evidence-stallion-reddit-scraper-pro", "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/busy_evidence~stallion-reddit-scraper-pro/runs": { "post": { "operationId": "runs-sync-busy_evidence-stallion-reddit-scraper-pro", "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/busy_evidence~stallion-reddit-scraper-pro/run-sync": { "post": { "operationId": "run-sync-busy_evidence-stallion-reddit-scraper-pro", "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": "Reddit URLs: subreddit listings, posts, users, or search pages. When set, search fields are ignored.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searches": { "title": "Search keywords", "type": "array", "description": "Keywords for Reddit search (used when startUrls is empty). Legacy alias for searchTerms.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords for Reddit search (harshmaur-compatible alias for searches).", "items": { "type": "string" } }, "subredditUrls": { "title": "Subreddit URLs", "type": "array", "description": "Subreddit URLs for deep listing scrape (merged into startUrls).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchCommunityName": { "title": "Search community name", "type": "string", "description": "Restrict search to one subreddit (name only, no r/ prefix). Legacy alias for withinCommunity." }, "withinCommunity": { "title": "Within community", "type": "string", "description": "Restrict search to one subreddit (harshmaur-compatible alias)." }, "sort": { "title": "Sort", "enum": [ "new", "hot", "top", "relevance", "comments" ], "type": "string", "description": "Sort order for listings and search.", "default": "new" }, "time": { "title": "Time filter", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time range for top/relevance search (posts only).", "default": "all" }, "postDateLimit": { "title": "Post date limit", "type": "string", "description": "Only include posts on or after this date (YYYY-MM-DD). Legacy alias for postedAfter." }, "postedAfter": { "title": "Posted after", "type": "string", "description": "Only include posts on or after this date (YYYY-MM-DD)." }, "postedBefore": { "title": "Posted before", "type": "string", "description": "Only include posts on or before this date (YYYY-MM-DD)." }, "commentDateLimit": { "title": "Comment date limit", "type": "string", "description": "Only include comments on or after this date (YYYY-MM-DD). Legacy alias for commentedAfter." }, "commentedAfter": { "title": "Commented after", "type": "string", "description": "Only include comments on or after this date (YYYY-MM-DD)." }, "commentedBefore": { "title": "Commented before", "type": "string", "description": "Only include comments on or before this date (YYYY-MM-DD)." }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Hard cap on total dataset rows. Legacy alias — prefer maxPostsCount.", "default": 100 }, "maxPostsCount": { "title": "Max posts count", "minimum": 1, "type": "integer", "description": "Hard cap on total rows and per-listing post limit (harshmaur-compatible).", "default": 100 }, "maxPostCount": { "title": "Max posts per listing", "minimum": 1, "type": "integer", "description": "Max posts per listing or search page.", "default": 100 }, "maxComments": { "title": "Max comments per post", "minimum": 0, "type": "integer", "description": "Max comments per post. 0 = skip comment extraction. Legacy alias for maxCommentsPerPost.", "default": 0 }, "maxCommentsPerPost": { "title": "Max comments per post (alias)", "minimum": 0, "type": "integer", "description": "Harshmaur-compatible alias for maxComments.", "default": 0 }, "crawlCommentsPerPost": { "title": "Crawl comments per post", "type": "boolean", "description": "Fetch comments when maxComments > 0. Leave unchecked to auto-enable with maxComments." }, "scrollTimeout": { "title": "Scroll timeout (seconds)", "minimum": 1, "type": "integer", "description": "Seconds to keep paginating before stopping.", "default": 40 }, "includeNSFW": { "title": "Include NSFW", "type": "boolean", "description": "Include adult content.", "default": false }, "searchPosts": { "title": "Search posts", "type": "boolean", "description": "Search posts when using searches.", "default": true }, "searchComments": { "title": "Search comments", "type": "boolean", "description": "Search comments when using searches.", "default": false }, "searchCommunities": { "title": "Search communities", "type": "boolean", "description": "Search communities when using searches.", "default": false }, "searchUsers": { "title": "Search users", "type": "boolean", "description": "Search users when using searches.", "default": false }, "skipComments": { "title": "Skip comments", "type": "boolean", "description": "Skip comment extraction on post pages even if maxComments > 0.", "default": false }, "includeMediaLinks": { "title": "Include media links", "type": "boolean", "description": "Include image and video URLs in output (slower).", "default": false }, "fastMode": { "title": "Fast mode", "type": "boolean", "description": "Use HTTP JSON fast path for search URLs when possible (Phase 6 expands behavior).", "default": true }, "onlyWithFlair": { "title": "Only with flair", "type": "string", "description": "Only include posts matching this link flair text." }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy settings. Residential proxy recommended for Reddit." } } }, "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 } } } } } } } } } }