# Reddit Scraper (`gio21/reddit-scraper`) Actor Scrape Reddit posts and comments from any subreddit. Extract titles, scores, authors, comments, and more using Reddit's public JSON API. - **URL**: https://apify.com/gio21/reddit-scraper.md - **Developed by:** [Gio](https://apify.com/gio21) (community) - **Categories:** Social media - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Reddit Scraper Scrape posts and comments from any Reddit subreddit using Reddit's public JSON API. No login required. ### Features - Scrape posts from any public subreddit - Sort by hot, new, top, or rising - Optional comment extraction per post - Search within a subreddit - Automatic pagination - Pay-per-event pricing ### Input | Field | Type | Default | Description | |-------|------|---------|-------------| | subreddit | string | technology | Subreddit name (without r/) | | searchQuery | string | | Search query within the subreddit | | sort | string | hot | Sort: hot, new, top, rising | | topTimeframe | string | week | Timeframe for top sort | | maxItems | integer | 25 | Max posts to scrape | | includeComments | boolean | false | Fetch top-level comments | | maxComments | integer | 10 | Max comments per post | ### Output Each post includes: id, title, author, subreddit, score, upvoteRatio, numComments, url, linkUrl, selfText, isVideo, thumbnail, flair, isNSFW, isPinned, awards, createdAt, scrapedAt, and optionally comments. ### Pricing $0.005 per post scraped. Free tier limited to 15 posts. ### Example ```json { "subreddit": "technology", "sort": "top", "topTimeframe": "week", "maxItems": 50, "includeComments": true, "maxComments": 5 } ```` # Actor input Schema ## `subreddit` (type: `string`): Subreddit name to scrape (without r/ prefix). E.g. 'technology', 'askreddit'. ## `searchQuery` (type: `string`): Optional search query within the subreddit. Leave empty to get top/hot/new posts. ## `sort` (type: `string`): How to sort posts. ## `topTimeframe` (type: `string`): Timeframe for 'top' sort. Only used when sort is 'top'. ## `maxItems` (type: `integer`): Maximum number of posts to scrape. ## `includeComments` (type: `boolean`): Whether to scrape top-level comments for each post. ## `maxComments` (type: `integer`): Maximum number of top-level comments to fetch per post (when includeComments is true). ## `proxy` (type: `object`): Proxy settings. Recommended to use Apify proxy. ## Actor input object example ```json { "subreddit": "technology", "sort": "hot", "topTimeframe": "week", "maxItems": 25, "includeComments": false, "maxComments": 10, "proxy": { "useApifyProxy": true } } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "subreddit": "technology", "sort": "hot", "topTimeframe": "week", "maxItems": 25, "includeComments": false, "maxComments": 10, "proxy": { "useApifyProxy": true } }; // Run the Actor and wait for it to finish const run = await client.actor("gio21/reddit-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "subreddit": "technology", "sort": "hot", "topTimeframe": "week", "maxItems": 25, "includeComments": False, "maxComments": 10, "proxy": { "useApifyProxy": True }, } # Run the Actor and wait for it to finish run = client.actor("gio21/reddit-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "subreddit": "technology", "sort": "hot", "topTimeframe": "week", "maxItems": 25, "includeComments": false, "maxComments": 10, "proxy": { "useApifyProxy": true } }' | apify call gio21/reddit-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=gio21/reddit-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Reddit Scraper", "description": "Scrape Reddit posts and comments from any subreddit. Extract titles, scores, authors, comments, and more using Reddit's public JSON API.", "version": "0.0", "x-build-id": "iCAH9m8GkXenuQ9DB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gio21~reddit-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gio21-reddit-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/gio21~reddit-scraper/runs": { "post": { "operationId": "runs-sync-gio21-reddit-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/gio21~reddit-scraper/run-sync": { "post": { "operationId": "run-sync-gio21-reddit-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": [ "subreddit" ], "properties": { "subreddit": { "title": "Subreddit", "type": "string", "description": "Subreddit name to scrape (without r/ prefix). E.g. 'technology', 'askreddit'." }, "searchQuery": { "title": "Search Query", "type": "string", "description": "Optional search query within the subreddit. Leave empty to get top/hot/new posts." }, "sort": { "title": "Sort By", "enum": [ "hot", "new", "top", "rising" ], "type": "string", "description": "How to sort posts.", "default": "hot" }, "topTimeframe": { "title": "Top Timeframe", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Timeframe for 'top' sort. Only used when sort is 'top'.", "default": "week" }, "maxItems": { "title": "Max Posts", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of posts to scrape.", "default": 25 }, "includeComments": { "title": "Include Comments", "type": "boolean", "description": "Whether to scrape top-level comments for each post.", "default": false }, "maxComments": { "title": "Max Comments per Post", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of top-level comments to fetch per post (when includeComments is true).", "default": 10 }, "proxy": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Recommended to use Apify proxy." } } }, "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 } } } } } } } } } } ```