{ "openapi": "3.0.1", "info": { "title": "Reddit Comments Search Scraper", "description": null, "version": "0.1", "x-build-id": "EW6hky1aBtxTf3jOX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/simpleapi~reddit-comments-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-simpleapi-reddit-comments-search-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/simpleapi~reddit-comments-search-scraper/runs": { "post": { "operationId": "runs-sync-simpleapi-reddit-comments-search-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/simpleapi~reddit-comments-search-scraper/run-sync": { "post": { "operationId": "run-sync-simpleapi-reddit-comments-search-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": { "urls": { "title": "šŸŒ Reddit URLs (bulk)", "type": "array", "description": "One or more Reddit URLs. Supports:\nā€¢ Search URLs ā€” https://www.reddit.com/search/?q=ai&sort=new\nā€¢ Subreddit URLs ā€” https://www.reddit.com/r/python/\nā€¢ Subreddit search URLs ā€” https://www.reddit.com/r/python/search/?q=django&restrict_sr=1\n\nLeave empty if you want to use the keyword field below instead.", "items": { "type": "string" } }, "query": { "title": "šŸ”Ž Search Query (fallback)", "type": "string", "description": "Keyword to search across all of Reddit. Used only when the URLs field above is empty. Example: 'artificial intelligence'." }, "sort": { "title": "šŸ“Š Sort By", "enum": [ "relevance", "hot", "top", "new", "comments" ], "type": "string", "description": "How Reddit orders the search results.\nā€¢ Relevance ā€” best match to the query\nā€¢ Hot ā€” trending now\nā€¢ Top ā€” highest score\nā€¢ New ā€” newest first\nā€¢ Comments ā€” most comments", "default": "relevance" }, "safeSearch": { "title": "šŸ”ž Safe Search", "enum": [ "off", "on" ], "type": "string", "description": "Whether to include NSFW (over-18) posts in the results.", "default": "off" }, "maxItems": { "title": "šŸ“¦ Maximum Items", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard cap on the total number of posts returned across all input URLs. The archive returns up to 100 posts per request and the scraper paginates until this cap is reached.", "default": 10 }, "maxRetries": { "title": "šŸ” Max Retries Per Request", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many times to retry a failed Reddit API request (per proxy tier) before falling back to the next tier.", "default": 3 }, "proxyConfiguration": { "title": "šŸ›”ļø Proxy Configuration", "type": "object", "description": "Default is no proxy ā€” the data archives usually serve fine without one. If an archive rate-limits the request IP (403/429), the scraper auto-escalates: direct ā†’ datacenter ā†’ residential. Once it falls back to residential, it stays there for the rest of the run.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }