{ "openapi": "3.0.1", "info": { "title": "Reddit Search Scraper", "description": "🔍 Search Reddit by keyword and extract posts, comments, communities, users, and media with scores, engagement metrics, exact timestamps, and rich metadata. Get clean, structured JSON for research, monitoring, analytics, and AI workflows.", "version": "0.0", "x-build-id": "ClYtfNPPFEdkAaZrF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apt_marble~reddit-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apt_marble-reddit-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/apt_marble~reddit-search-scraper/runs": { "post": { "operationId": "runs-sync-apt_marble-reddit-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/apt_marble~reddit-search-scraper/run-sync": { "post": { "operationId": "run-sync-apt_marble-reddit-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": [ "searchTerms" ], "properties": { "searchTerms": { "title": "Search terms", "type": "array", "description": "One or more keywords to search Reddit for.", "default": [ "artificial intelligence" ], "items": { "type": "string" } }, "searchCommunityName": { "title": "Community (optional)", "type": "string", "description": "If provided, the search will be performed only inside this community (e.g., 'programming'). Applies to posts, comments and media — community and user searches are always global.", "default": "" }, "searchForPosts": { "title": "Search for posts", "type": "boolean", "description": "Scrape posts matching the search terms.", "default": true }, "searchForComments": { "title": "Search for comments", "type": "boolean", "description": "Scrape comments matching the search terms.", "default": false }, "searchForCommunities": { "title": "Search for communities", "type": "boolean", "description": "Scrape communities (subreddits) matching the search terms.", "default": false }, "searchForUsers": { "title": "Search for users", "type": "boolean", "description": "Scrape user profiles matching the search terms.", "default": false }, "searchForMedia": { "title": "Search for media", "type": "boolean", "description": "Scrape media posts (images, videos, galleries) matching the search terms.", "default": false }, "sortSearch": { "title": "Sort search", "enum": [ "", "relevance", "hot", "top", "new", "rising", "comments" ], "type": "string", "description": "How Reddit ranks the results.", "default": "" }, "filterByDate": { "title": "Filter by date (Posts only)", "enum": [ "", "hour", "day", "week", "month", "year" ], "type": "string", "description": "Only include results from this time window.", "default": "" }, "maxPostsPerTerm": { "title": "Maximum posts per search term", "minimum": 0, "type": "integer", "description": "How many posts to scrape for each search term.", "default": 10 }, "maxCommentsPerTerm": { "title": "Maximum comments per search term", "minimum": 0, "type": "integer", "description": "How many comments to scrape for each search term.", "default": 10 }, "maxCommunitiesPerTerm": { "title": "Maximum communities per search term", "minimum": 0, "type": "integer", "description": "How many communities to scrape for each search term.", "default": 5 }, "maxUsersPerTerm": { "title": "Maximum users per search term", "minimum": 0, "type": "integer", "description": "How many users to scrape for each search term.", "default": 5 }, "maxMediaPerTerm": { "title": "Maximum media posts per search term", "minimum": 0, "type": "integer", "description": "How many media posts to scrape for each search term.", "default": 5 }, "includeNsfw": { "title": "Include NSFW results (advanced)", "type": "boolean", "description": "Include results marked 18+. Off by default.", "default": false }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many search terms to process in parallel.", "default": 3 } } }, "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 } } } } } } } } } }