{ "openapi": "3.0.1", "info": { "title": "Reddit Comments Scraper", "description": "The most powerful Reddit comments on Apify. Get comprehensive comments data from direct urls, post urls, or user profiles. Power your analysis with comment replies from post urls up to any depth. This tools is your best bet to unlock Reddit's ecosystem.", "version": "1.0", "x-build-id": "M35vEZoTKnT9fUq0o" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/toludare~reddit-comments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-toludare-reddit-comments-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/toludare~reddit-comments-scraper/runs": { "post": { "operationId": "runs-sync-toludare-reddit-comments-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/toludare~reddit-comments-scraper/run-sync": { "post": { "operationId": "run-sync-toludare-reddit-comments-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": "Start URLs", "uniqueItems": true, "type": "array", "description": "Enter post, direct comment, or user urls.", "items": { "type": "string", "pattern": "^https:\\/\\/www\\.reddit\\.com\\/(r\\/\\w+\\/comments\\/\\w+\\/\\w+(\\/\\w+)?|user\\/\\w+)\\/?(\\?.+)?$" } }, "postSortBy": { "title": "Sort Comments By", "enum": [ "confidence", "top", "new", "controversial", "old", "qa" ], "type": "string", "description": "Choose filter to sort post comments.", "default": "confidence" }, "postTraversalStrategy": { "title": "Comments Traversal Strategy", "enum": [ "depth", "breadth" ], "type": "string", "description": "Choose the strategy for traversing the comment tree.", "default": "depth" }, "postMaxDepth": { "title": "Comments Maximum Depth", "minimum": -1, "type": "integer", "description": "Set the maximum depth to reach in the comment tree. Use -1 to reach the maximum depth possible.", "default": -1 }, "postMaxComments": { "title": "Maximum Comments", "minimum": 0, "type": "integer", "description": "Set maximum number of comments to scrape. Use 0 to scrape all comments.", "default": 100 }, "postIncludeModThreads": { "title": "Include Moderator Threads", "type": "boolean", "description": "Click to include moderator threads in the output.", "default": true }, "postIncludeUnavailableThreads": { "title": "Include Unavailable Threads", "type": "boolean", "description": "Click to include unavailable (deleted or removed) threads in the output.", "default": true }, "userSortBy": { "title": "Sort Comments By", "enum": [ "hot", "new", "top" ], "type": "string", "description": "Choose filter to sort user comments.", "default": "new" }, "userSortTimePeriod": { "title": "Sort Time Period", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Choose time period for user sort setting.", "default": "day" }, "userMaxComments": { "title": "Maximum Comments", "minimum": 0, "type": "integer", "description": "Set maximum number of comments to scrape. Use 0 to scrape all comments.", "default": 100 } } }, "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 } } } } } } } } } }