{ "openapi": "3.0.1", "info": { "title": "Reddit Pulse", "description": "Extract Reddit posts, comments, users, and subreddit metadata at scale — and turn them into structured signals. Find your next SaaS idea, monitor brand mentions, mine pain points, or feed an AI / RAG pipeline. No Reddit API key, no login, no developer registration.", "version": "0.10", "x-build-id": "Iy42FC5ocMuGnMNxs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dizilus~reddit-pulse/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dizilus-reddit-pulse", "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/dizilus~reddit-pulse/runs": { "post": { "operationId": "runs-sync-dizilus-reddit-pulse", "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/dizilus~reddit-pulse/run-sync": { "post": { "operationId": "run-sync-dizilus-reddit-pulse", "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": { "subreddits": { "title": "Subreddits to scrape", "type": "array", "description": "List of subreddit names (without r/). Example: ['python', 'webscraping']. Optional if you provide 'searchQuery'.", "items": { "type": "string" } }, "searchQuery": { "title": "Search query", "type": "string", "description": "If set, the actor searches Reddit for this query instead of browsing subreddit sort modes. Combine with 'searchRestrictToSubreddits' to limit the search to your subreddits list." }, "searchSort": { "title": "Search sort", "enum": [ "relevance", "new", "top", "comments", "hot" ], "type": "string", "description": "How to sort search results (only used if 'searchQuery' is set).", "default": "relevance" }, "searchRestrictToSubreddits": { "title": "Restrict search to listed subreddits", "type": "boolean", "description": "If true and 'subreddits' is provided, search runs only inside those subreddits instead of all of Reddit.", "default": false }, "sort": { "title": "Sort by", "enum": [ "hot", "new", "top", "rising" ], "type": "string", "description": "How to sort posts", "default": "hot" }, "timeRange": { "title": "Time range (only for 'top')", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time window for the 'top' sort mode. Ignored for other sort modes.", "default": "day" }, "maxPosts": { "title": "Max posts per subreddit", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of posts to scrape from each subreddit", "default": 25 }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Scrape top-level comments for each post", "default": false }, "includeRules": { "title": "Include subreddit rules", "type": "boolean", "description": "Also scrape the rules of each subreddit (one row per subreddit, with the full rules list).", "default": false }, "includeSubredditInfo": { "title": "Include subreddit metadata", "type": "boolean", "description": "Also scrape each subreddit's about page: subscriber count, active users, description, icon, creation date, NSFW flag, submission rules, etc. One row per subreddit.", "default": false }, "maxCommentsPerPost": { "title": "Max comments per post", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of comments (across all depth levels) per post. Only used if 'Include comments' is true.", "default": 50 }, "commentDepth": { "title": "Comment nesting depth", "minimum": 1, "maximum": 10, "type": "integer", "description": "How deep to traverse reply threads. 1 = top-level only (legacy behaviour), 2 = top-level + their direct replies, etc. Default 3 covers the bulk of meaningful discussion.", "default": 3 }, "minCommentScore": { "title": "Minimum comment score", "type": "integer", "description": "Skip comments with score below this threshold. Use a small positive number (e.g. 1) to filter out downvoted and removed comments.", "default": -1000 }, "excludeRemoved": { "title": "Exclude removed / deleted content", "type": "boolean", "description": "If true, skip posts and comments that were removed by moderators or deleted by their author. Saves money on per-event charges.", "default": false }, "nsfwFilter": { "title": "NSFW filter", "enum": [ "include", "exclude", "only" ], "type": "string", "description": "How to handle NSFW (over-18) posts. 'include' = scrape everything (default), 'exclude' = skip NSFW posts and their comments, 'only' = scrape NSFW posts only.", "default": "include" }, "ideaMiningMode": { "title": "SaaS idea-mining mode", "type": "boolean", "description": "Turn the actor into a structured pain-point finder. Filters posts to those matching pain phrases (e.g. 'I wish there was', 'looking for a tool'), computes a demand score, and tags intent tier. Uses a curated subreddit list if you don't supply one.", "default": false }, "painPhrasePack": { "title": "Pain phrase pack", "enum": [ "saas", "leads", "feature-request", "custom" ], "type": "string", "description": "Pre-built keyword pack for idea-mining mode. 'saas' = founder/builder pain phrases, 'leads' = buying-intent phrases for lead-gen, 'feature-request' = product feedback phrases, 'custom' = use your own list from 'customPainPhrases'.", "default": "saas" }, "customPainPhrases": { "title": "Custom pain phrases", "type": "array", "description": "Used when painPhrasePack='custom'. Case-insensitive substring match against post title + selftext.", "items": { "type": "string" } }, "users": { "title": "Users to scrape", "type": "array", "description": "List of Reddit usernames (without u/) whose posts and/or comments should be scraped. Independent of the 'subreddits' field.", "items": { "type": "string" } }, "userContentType": { "title": "User content to scrape", "enum": [ "posts", "comments", "both" ], "type": "string", "description": "Which type of content to fetch for each user. Used only when 'users' is set.", "default": "both" }, "maxItemsPerUser": { "title": "Max items per user", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum posts or comments to scrape per user (each type is capped separately if userContentType='both').", "default": 25 }, "mentionMonitorMode": { "title": "Mention / brand monitor mode", "type": "boolean", "description": "Track one or more keywords across all of Reddit. Useful for brand/competitor mention monitoring. Requires 'mentionTerms' to be set.", "default": false }, "mentionTerms": { "title": "Mention terms", "type": "array", "description": "Keywords or brand names to track. The actor runs one search per term and tags each matching post with the term that produced it.", "items": { "type": "string" } }, "sentimentClassification": { "title": "Add sentiment classification", "type": "boolean", "description": "Tag each post with a basic sentiment label (positive / negative / neutral) based on keyword heuristics. Lightweight, no LLM cost.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Recommended: use Apify Proxy with residential groups" } } }, "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 } } } } } } } } } }