# Reddit Subreddit Scraper (`codingfrontend/reddit-subreddit-scraper`) Actor

Scrape the newest, hottest, top, or rising posts from any Reddit subreddit with full metadata, images, videos, awards, and optional comments.

- **URL**: https://apify.com/codingfrontend/reddit-subreddit-scraper.md
- **Developed by:** [codingfrontend](https://apify.com/codingfrontend) (community)
- **Categories:** Social media, Developer tools, Other
- **Stats:** 2 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $4.99 / 1,000 results

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## 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 Subreddit Scraper

Scrape the newest, hottest, top, or rising posts from any Reddit subreddit with full post metadata, images, videos, gallery content, awards, and optional comments — using Reddit's official JSON API for reliable, structured data extraction.

### Features

- **Sort modes** — Scrape by New, Hot, Top, Rising, or Controversial
- **Time filters** — For Top/Controversial: Past Hour, Today, This Week, This Month, This Year, All Time
- **Deep scraping** — Opens each post in a parallel browser tab for complete fields (self-text, images, video, gallery, awards, crosspost data)
- **Parallel tabs** — Processes 3 posts simultaneously for fast extraction
- **Pagination** — Automatically follows `after` cursor to fetch all pages
- **Comments** — Optional top-20 comments with up to 5 nested replies
- **50+ fields** — Author info, flair, media, video HLS/DASH/fallback URLs, gallery images with captions, awards breakdown, moderation metadata, and more
- **Stealth mode** — Random user agents, headers, and fingerprinting to avoid rate limits

---

### Input Options

| Field | Type | Default | Description |
|-------|------|---------|-------------|
| `subreddit` | String | *required* | Subreddit name (without `r/`). E.g. `javascript`, `worldnews` |
| `sortBy` | Enum | `new` | `new` · `hot` · `top` · `rising` · `controversial` |
| `topTime` | Enum | `week` | For Top/Controversial: `hour` · `day` · `week` · `month` · `year` · `all` |
| `maxItems` | Number | `50` | Maximum posts to scrape (1–1000) |
| `deepScraping` | Boolean | `true` | Open each post for full metadata (recommended) |
| `includeComments` | Boolean | `false` | Include top 20 comments with nested replies |
| `headless` | Boolean | `true` | Run browser in headless mode |
| `proxyConfiguration` | Object | Apify Residential | Proxy settings |

---

### Example Inputs

#### Scrape newest posts from r/javascript
```json
{
  "subreddit": "javascript",
  "sortBy": "new",
  "maxItems": 100,
  "deepScraping": true,
  "includeComments": false
}
````

#### Top posts from r/worldnews this month

```json
{
  "subreddit": "worldnews",
  "sortBy": "top",
  "topTime": "month",
  "maxItems": 50,
  "deepScraping": true,
  "includeComments": true
}
```

#### Hot posts from r/AskReddit

```json
{
  "subreddit": "AskReddit",
  "sortBy": "hot",
  "maxItems": 25,
  "deepScraping": true,
  "includeComments": true
}
```

***

### Output Dataset Fields

| Field | Type | Description |
|-------|------|-------------|
| `id` | String | Reddit post ID |
| `title` | String | Post title |
| `url` | String | External link URL (or Reddit permalink for self posts) |
| `permalink` | String | Full Reddit URL |
| `subreddit` | String | Subreddit name |
| `subredditId` | String | Subreddit fullname (t5\_xxx) |
| `subredditType` | String | `public`, `private`, `restricted` |
| `subredditSubscribers` | Number | Subscriber count |
| `author` | String | Post author username |
| `authorFullname` | String | Author fullname (t2\_xxx) |
| `authorFlair` | String | Author flair text |
| `authorPremium` | Boolean | Whether author has Reddit Premium |
| `score` | Number | Upvotes minus downvotes |
| `upvoteRatio` | Number | Fraction of upvotes (0.0–1.0) |
| `numComments` | Number | Total comment count |
| `createdAt` | String | ISO 8601 creation timestamp |
| `editedAt` | String/Boolean | ISO 8601 edit timestamp or `false` |
| `selfText` | String | Post body text (self posts) |
| `postType` | String | `self` · `link` · `image` · `video` · `gallery` · `crosspost` |
| `isVideo` | Boolean | Whether post contains hosted video |
| `isSelf` | Boolean | Whether it's a text/self post |
| `isGallery` | Boolean | Whether it's a gallery post |
| `isOC` | Boolean | Original content flag |
| `thumbnail` | String | Thumbnail image URL |
| `flair` | String | Post flair text |
| `flairBackgroundColor` | String | Flair background hex color |
| `domain` | String | Link domain |
| `nsfw` | Boolean | NSFW flag |
| `spoiler` | Boolean | Spoiler flag |
| `locked` | Boolean | Whether post is locked |
| `pinned` | Boolean | Whether post is pinned |
| `stickied` | Boolean | Whether post is stickied |
| `archived` | Boolean | Whether post is archived |
| `distinguished` | String | `moderator`, `admin`, or `null` |
| `suggestedSort` | String | Suggested comment sort |
| `numCrossposts` | Number | Cross-post count |
| `postHint` | String | `self` · `link` · `image` · `rich:video` · `hosted:video` |
| `isCrossPost` | Boolean | Whether it's a cross-post |
| `crosspostFrom` | String | Original subreddit if cross-posted |
| `crosspostOriginal` | Object | Full original post object if cross-posted |
| `awardsCount` | Number | Total awards received |
| `gilded` | Number | Number of times gilded |
| `gildings` | Object | Breakdown by award tier |
| `awards` | Array | Award names and counts |
| `previewImages` | Array | Preview image objects with resolutions |
| `videoData` | Object | Video URLs (HLS, DASH, fallback), dimensions, duration |
| `galleryImages` | Array | Gallery images with URL, caption, mp4 |
| `mediaEmbed` | Object | Embedded media HTML/dimensions |
| `comments` | Array | Top comments (if `includeComments=true`) |
| `scrapedAt` | String | ISO 8601 scrape timestamp |

***

### Example Output

```json
{
  "id": "1t9jt9w",
  "title": "BlueJS: Compile JavaScript to 12MB native binaries",
  "url": "https://github.com/example/bluejs",
  "permalink": "https://www.reddit.com/r/javascript/comments/1t9jt9w/...",
  "subreddit": "javascript",
  "subredditSubscribers": 2400000,
  "author": "dev_user",
  "score": 1842,
  "upvoteRatio": 0.97,
  "numComments": 143,
  "createdAt": "2025-06-01T10:30:00.000Z",
  "postType": "link",
  "domain": "github.com",
  "nsfw": false,
  "awardsCount": 3,
  "previewImages": [{ "url": "https://...", "width": 1200, "height": 630 }],
  "scrapedAt": "2025-06-01T12:00:00.000Z"
}
```

***

### Related Actors

- **Reddit Search Scraper** — Search Reddit by keyword across all subreddits
- **Reddit Post Scraper** — Scrape specific Reddit post URLs for full details

***

### Author

Built by **Kumar Lakshmanan** · <lakshmanan.w3dev@gmail.com>

# Actor input Schema

## `subreddit` (type: `string`):

Name of the subreddit to scrape (without r/). Example: javascript, worldnews, AskReddit

## `sortBy` (type: `string`):

How to sort the posts

## `topTime` (type: `string`):

Time period when sortBy is 'top' or 'controversial'

## `maxItems` (type: `integer`):

Maximum number of posts to scrape

## `deepScraping` (type: `boolean`):

Open each post in a parallel browser tab to extract full details: complete selfText, images, videos, gallery, awards, metadata. Recommended for rich datasets.

## `includeComments` (type: `boolean`):

Fetch top 20 comments with nested replies for each post (requires deepScraping=true)

## `headless` (type: `boolean`):

Run browser in headless mode (recommended for production)

## `proxyConfiguration` (type: `object`):

Proxy settings. Apify Residential proxy recommended to avoid Reddit rate limits.

## Actor input object example

```json
{
  "subreddit": "javascript",
  "sortBy": "new",
  "topTime": "week",
  "maxItems": 50,
  "deepScraping": true,
  "includeComments": false,
  "headless": true,
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ]
  }
}
```

# 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "subreddit": "javascript",
    "maxItems": 50,
    "deepScraping": true,
    "includeComments": false,
    "headless": true
};

// Run the Actor and wait for it to finish
const run = await client.actor("codingfrontend/reddit-subreddit-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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "subreddit": "javascript",
    "maxItems": 50,
    "deepScraping": True,
    "includeComments": False,
    "headless": True,
}

# Run the Actor and wait for it to finish
run = client.actor("codingfrontend/reddit-subreddit-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": "javascript",
  "maxItems": 50,
  "deepScraping": true,
  "includeComments": false,
  "headless": true
}' |
apify call codingfrontend/reddit-subreddit-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=codingfrontend/reddit-subreddit-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Reddit Subreddit Scraper",
        "description": "Scrape the newest, hottest, top, or rising posts from any Reddit subreddit with full metadata, images, videos, awards, and optional comments.",
        "version": "1.0",
        "x-build-id": "mDl070AojkLj5maxD"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/codingfrontend~reddit-subreddit-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-codingfrontend-reddit-subreddit-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/codingfrontend~reddit-subreddit-scraper/runs": {
            "post": {
                "operationId": "runs-sync-codingfrontend-reddit-subreddit-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/codingfrontend~reddit-subreddit-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-codingfrontend-reddit-subreddit-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 Name",
                        "type": "string",
                        "description": "Name of the subreddit to scrape (without r/). Example: javascript, worldnews, AskReddit"
                    },
                    "sortBy": {
                        "title": "Sort By",
                        "enum": [
                            "new",
                            "hot",
                            "top",
                            "rising",
                            "controversial"
                        ],
                        "type": "string",
                        "description": "How to sort the posts",
                        "default": "new"
                    },
                    "topTime": {
                        "title": "Top / Controversial Time Filter",
                        "enum": [
                            "hour",
                            "day",
                            "week",
                            "month",
                            "year",
                            "all"
                        ],
                        "type": "string",
                        "description": "Time period when sortBy is 'top' or 'controversial'",
                        "default": "week"
                    },
                    "maxItems": {
                        "title": "Max Posts",
                        "minimum": 1,
                        "maximum": 1000,
                        "type": "integer",
                        "description": "Maximum number of posts to scrape",
                        "default": 50
                    },
                    "deepScraping": {
                        "title": "Deep Scraping",
                        "type": "boolean",
                        "description": "Open each post in a parallel browser tab to extract full details: complete selfText, images, videos, gallery, awards, metadata. Recommended for rich datasets.",
                        "default": true
                    },
                    "includeComments": {
                        "title": "Include Comments",
                        "type": "boolean",
                        "description": "Fetch top 20 comments with nested replies for each post (requires deepScraping=true)",
                        "default": false
                    },
                    "headless": {
                        "title": "Headless Mode",
                        "type": "boolean",
                        "description": "Run browser in headless mode (recommended for production)",
                        "default": true
                    },
                    "proxyConfiguration": {
                        "title": "Proxy Configuration",
                        "type": "object",
                        "description": "Proxy settings. Apify Residential proxy recommended to avoid Reddit rate limits.",
                        "default": {
                            "useApifyProxy": true,
                            "apifyProxyGroups": [
                                "RESIDENTIAL"
                            ]
                        }
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
