{ "openapi": "3.0.1", "info": { "title": "Reddit Scraper", "description": "Collect Reddit posts, comments and search results.", "version": "0.1", "x-build-id": "lA3Wlqj241sTxYXER" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/barefoot_grade~reddit-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-barefoot_grade-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/barefoot_grade~reddit-scraper/runs": { "post": { "operationId": "runs-sync-barefoot_grade-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/barefoot_grade~reddit-scraper/run-sync": { "post": { "operationId": "run-sync-barefoot_grade-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": "Subreddits, users or post links", "type": "array", "description": "One per line: a subreddit (r/python or a reddit.com/r/... link), a user (u/name or a reddit.com/user/... link), a post link (its comments are collected too) or a Reddit search link.", "items": { "type": "string", "minLength": 1 } }, "searchQueries": { "title": "Search Reddit", "type": "array", "description": "Searches across all of Reddit, one per line, exactly as you would type them into Reddit's search box. Tip: add subreddit:name to search inside one community.", "items": { "type": "string", "minLength": 1 } }, "sort": { "title": "Sort subreddit and user posts by", "enum": [ "hot", "new", "top", "rising", "controversial" ], "type": "string", "description": "Hot, New, Top, Rising or Controversial. A sort inside a subreddit link (reddit.com/r/name/top) takes precedence.", "default": "hot" }, "timeFilter": { "title": "Time window", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "For Top and Controversial sorting and for searches: past hour, day, week, month, year or all time.", "default": "week" }, "searchSort": { "title": "Sort search results by", "enum": [ "relevance", "hot", "top", "new", "comments" ], "type": "string", "description": "Relevance, Hot, Top, New or Most comments.", "default": "relevance" }, "maxPostsPerSource": { "title": "Posts per subreddit, user or search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many posts to collect from each source. Reddit lists at most about 1,000 posts per listing.", "default": 100 }, "includeScores": { "title": "Exact upvotes and comment counts", "type": "boolean", "description": "Add each post's exact upvote count, comment count, NSFW flag and post type. Turn off for faster runs when you only need the posts themselves.", "default": true }, "includeComments": { "title": "Collect comments of every post", "type": "boolean", "description": "Also collect the comment thread of each post found in subreddits, users and searches. Post links always include their comments. Each comment is one row.", "default": false }, "maxCommentsPerPost": { "title": "Comments per post", "minimum": 1, "maximum": 500, "type": "integer", "description": "Up to 500 comments per post, in Reddit's default thread order.", "default": 100 }, "maxItems": { "title": "Maximum rows in total", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Total cap on posts plus comments across every source. The run stops when it is reached.", "default": 1000 } } }, "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 } } } } } } } } } }