{ "openapi": "3.0.1", "info": { "title": "Subreddit Posts Search Scraper", "description": "Search public Reddit posts by keyword inside specified subreddits. Returns one validated post record per result; it does not extract comments, profiles, or subreddit metadata.", "version": "0.1", "x-build-id": "YoQZjFSidLZHCDWHG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~subreddit-posts-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-subreddit-posts-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/khadinakbar~subreddit-posts-search-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-subreddit-posts-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/khadinakbar~subreddit-posts-search-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-subreddit-posts-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", "required": [ "searchQuery", "subreddits" ], "properties": { "searchQuery": { "title": "Post search query", "minLength": 1, "maxLength": 200, "type": "string", "description": "Use this for the keyword or phrase to find in public Reddit posts, for example \"artificial intelligence\". It is searched independently inside every selected subreddit. This field is required and must contain 1 through 200 characters. This is not a Reddit URL, username, or subreddit name.", "default": "artificial intelligence" }, "subreddits": { "title": "Subreddits to search", "minItems": 1, "maxItems": 20, "type": "array", "description": "Use this for the public communities to search, for example \"technology\" or \"r/MachineLearning\". Accepts a bare name, an r/ prefix, or a Reddit subreddit URL. Provide 1 through 20 distinct communities. This is not a global Reddit search, a post URL list, or a list of usernames.", "default": [ "technology" ], "items": { "type": "string" } }, "maxResults": { "title": "Maximum posts", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Use this to cap the total unique posts saved across all subreddit searches, for example 25. Defaults to 25 and accepts 1 through 1000. The cap also prevents more than this number of post-found event charges. This is not a per-subreddit limit or a page count.", "default": 25 }, "sortBy": { "title": "Post order", "enum": [ "relevance", "new", "top", "comments", "hot" ], "type": "string", "description": "Use this to choose provider ordering for matching posts, for example \"relevance\". Defaults to relevance; choose new for monitoring, top for high-scoring posts, or comments for active discussions. This does not search comments or change the search query.", "default": "relevance" }, "timeFilter": { "title": "Time filter", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Use this to constrain the provider search time window, for example \"month\". Defaults to month and accepts hour, day, week, month, year, or all. Use all for historical research and new for recent monitoring. This is not an exact post-date cutoff.", "default": "month" }, "includeNsfw": { "title": "Include NSFW posts", "type": "boolean", "description": "Use this only when adult-marked public Reddit posts are appropriate for the stated research purpose. Pass true to keep posts whose provider metadata marks them NSFW. Defaults to false. This does not bypass private, quarantined, deleted, or login-only content restrictions.", "default": 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 } } } } } } } } } }