{ "openapi": "3.0.1", "info": { "title": "Reddit Scraper & Keyword Monitor", "description": "Scrape Reddit posts and comments by keyword, subreddit or user — title, text, author, subreddit, links, dates. Built for brand and topic monitoring: schedule it and get only new mentions. Fast, low-cost, no login. From $1 per 1,000 posts and comments.", "version": "0.1", "x-build-id": "tUb9xSpxJKNXNWg8t" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tacps126~reddit-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tacps126-reddit-monitor", "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/tacps126~reddit-monitor/runs": { "post": { "operationId": "runs-sync-tacps126-reddit-monitor", "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/tacps126~reddit-monitor/run-sync": { "post": { "operationId": "run-sync-tacps126-reddit-monitor", "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": { "keywords": { "title": "Keywords", "type": "array", "description": "Search all of Reddit for these — brand names, products, topics. `\"exact phrase\"` works.", "items": { "type": "string" } }, "subreddits": { "title": "Subreddits", "type": "array", "description": "Subreddit names or links, e.g. `webscraping`, `r/python`. Their latest posts are collected.", "items": { "type": "string" } }, "searchInSubreddits": { "title": "Search only inside these subreddits", "type": "boolean", "description": "Search the keywords only within the listed subreddits (instead of collecting their latest posts).", "default": false }, "users": { "title": "Users", "type": "array", "description": "Usernames or profile links — their submitted posts are collected.", "items": { "type": "string" } }, "sort": { "title": "Sort by", "enum": [ "new", "hot", "top", "relevance" ], "type": "string", "description": "Order of posts.", "default": "new" }, "time": { "title": "Time range", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "For searches and “Top”: only posts from this period.", "default": "week" }, "mustInclude": { "title": "Must mention", "type": "array", "description": "Keep only posts/comments whose title or text mentions any of these — useful to cut noise from broad subreddits.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip if mentions", "type": "array", "description": "Drop posts/comments mentioning any of these, e.g. `hiring`, `meme`.", "items": { "type": "string" } }, "excludeAuthors": { "title": "Skip authors", "type": "array", "description": "Ignore these users, e.g. `AutoModerator` or your own team's accounts.", "items": { "type": "string" } }, "dateFrom": { "title": "Posted on or after", "type": "string", "description": "Only posts and comments from this date on." }, "postType": { "title": "Post type", "enum": [ "any", "text", "link" ], "type": "string", "description": "Keep only text discussions, or only posts that share a link or image.", "default": "any" }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Also collect each post's comments (one extra request per post).", "default": false }, "maxCommentsPerPost": { "title": "Max comments per post", "minimum": 1, "maximum": 500, "type": "integer", "description": "Comments to collect per post.", "default": 50 }, "maxPostsPerSource": { "title": "Max posts per keyword / subreddit / user", "minimum": 1, "type": "integer", "description": "Posts to collect from each source.", "default": 100 }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Maximum posts and comments in total.", "default": 500 }, "onlyNew": { "title": "Only new posts and comments", "type": "boolean", "description": "Return only posts and comments no earlier run with the same input has delivered — for brand and keyword alerts. You pay only for new ones.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Optional name for the “only new” history, so several monitors can run side by side." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential proxy recommended: without it Reddit allows only about one request per minute, so larger runs are slow. Proxy traffic is small (about 0.4 MB per 100 posts).", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "tenantId": { "title": "Tenant ID", "type": "string", "description": "Optional label used to keep separate histories for different clients or teams." }, "debug": { "title": "Debug", "type": "boolean", "description": "Save extra diagnostics with the run (for support requests).", "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 }, "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 } } } } } } } } } }