# Reddit (`canadesk/reddit`) Actor

Collect subreddit posts, search for keyword or users, and more from reddit.com! It's fast and costs little.

- **URL**: https://apify.com/canadesk/reddit.md
- **Developed by:** [Canadesk Support](https://apify.com/canadesk) (community)
- **Categories:** News, Social media, SEO tools
- **Stats:** 111 total users, 2 monthly users, 88.5% runs succeeded, 5 bookmarks
- **User rating**: No ratings yet

## Pricing

$5.00/month + usage

To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period.You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have.

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

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

⭐ For bulk mode and higher limits, use actor **canadesk/reddit-bulk** instead!

🛑 Reddit does not respond well to high-volume scraping. Keep the limit low and chain requests instead.

### Features

- **Search for Keywords**

    Set Keywords, Mode and Limit.

    In the raw data, field "kind" differentiates t3 (Post) from t1 (Comment).

- **Get Subreddit Posts**

    Set Keywords, Category, Mode and Limit.

- **Get Post Details**

    Set Post URL and Mode.

- **Get User Posts**

    Set User ID, Mode and Limit.

### Examples

You can also fetch raw data instead.

**Get Subreddit Posts** returns:

````

\[
{
"title": "Was Alonzo Harris from Training day once a good man",
"author": "Lower-Adhesiveness-3",
"permalink": "/r/movies/comments/1hgmfpt/was\_alonzo\_harris\_from\_training\_day\_once\_a\_good/",
"score": 4,
"comments": 4,
"timestamp": 1734473853
},
{
"title": "Actors who were unconvincing as a parent and child?",
"author": "Odd-Recognition4120",
"permalink": "/r/movies/comments/1hgme6m/actors\_who\_were\_unconvincing\_as\_a\_parent\_and\_child/",
"score": 1,
"comments": 5,
"timestamp": 1734473736
},
{
"title": "Thoughts on Old Boy (2003 and 2013)?",
"author": "Twistybananana",
"permalink": "/r/movies/comments/1hglyqs/thoughts\_on\_old\_boy\_2003\_and\_2013/",
"score": 6,
"comments": 7,
"timestamp": 1734472622
}
]

```

**Get Post Details** returns:

```

\[
{
"title": "Chrome Canary just killed uBlock Origin and other Manifest V2 extensions",
"body": "",
"comments": \[
{
"author": "Neutral-President",
"body": "I would argue that if you want to be free from advertising, perhaps using a web browser created and distributed by the world’s biggest advertising company Is not the wisest strategy.",
"replies": \[
{
"author": "\[deleted]",
"body": "\[removed]",
"replies": \[
{
"author": "Quentin-Code",
"body": "This is missing one important point: why is google paying Mozilla. \n\nGoogle is not paying Mozilla only to be the default search, that’s not the real reason, the real reason is that Firefox is the legal argument of Google to say that they don’t have a monopoly with Chrome. If Firefox dies, Google will have to align much more money in legal battle and may still end up losing.\n\nIn addition Firefox will not die if Google stops paying: it’s open source and it will simply develop much slower and likely cut on some of its services.",
"replies": \[
{
"author": "NYstate",
"body": ">the real reason is that Firefox is the legal argument of Google to say that they don’t have a monopoly with Chrome\n\nYup. Google will has a monopoly. They make the phone, the OS, the search engine and steer the traffic to their services and earn them ads.Throw in YouTube and you have a total monopoly over the flow of the Internet. Google is *this* close to being under fire from the government but Firefox is their saving grace. All they need to do is to low advertise Firefox as an alternate and the trail is off",
"replies": \[
...
]
}
]
},
...
]
},
...
]
},
...
]
}
]

````

### Limitations

1. Returns a maximum of 500 results per run.

2. Does not support bulk.

3. "Search for Keywords" rounds up the limit to the closest 100.

### Support

Always use a Residential or Custom proxy!

Open a new issue or contact support. Please share your Run URL and Input.

Cheers!

# Actor input Schema

## `process` (type: `string`):

Process to run.
## `keyword` (type: `string`):

Only applies to Search for Keywords and Get Subreddit Posts.
## `category` (type: `string`):

Only applies to Get Subreddit Posts.
## `postlink` (type: `string`):

Only applies to Get Post Details. Format: https://www.reddit.com/r/{TOPIC}/comments/{ID}/{TITLE}/
## `userid` (type: `string`):

Only applies to Get User Posts.
## `mode` (type: `string`):

Defines the JSON result format.
## `limit` (type: `integer`):

Maximum number of results.
## `delay` (type: `integer`):

Waiting time between requests.
## `proxy` (type: `object`):

Select proxies to be used by your crawler.

## Actor input object example

```json
{
  "process": "gs",
  "keyword": "world news",
  "category": "new",
  "postlink": "https://www.reddit.com/r/technology/comments/1fxf8iq/chrome_canary_just_killed_ublock_origin_and_other/",
  "mode": "1",
  "limit": 3,
  "delay": 3,
  "proxy": {
    "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 = {
    "keyword": "world news",
    "postlink": "https://www.reddit.com/r/technology/comments/1fxf8iq/chrome_canary_just_killed_ublock_origin_and_other/",
    "userid": "",
    "proxy": {
        "useApifyProxy": true,
        "apifyProxyGroups": [
            "RESIDENTIAL"
        ]
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("canadesk/reddit").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 = {
    "keyword": "world news",
    "postlink": "https://www.reddit.com/r/technology/comments/1fxf8iq/chrome_canary_just_killed_ublock_origin_and_other/",
    "userid": "",
    "proxy": {
        "useApifyProxy": True,
        "apifyProxyGroups": ["RESIDENTIAL"],
    },
}

# Run the Actor and wait for it to finish
run = client.actor("canadesk/reddit").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 '{
  "keyword": "world news",
  "postlink": "https://www.reddit.com/r/technology/comments/1fxf8iq/chrome_canary_just_killed_ublock_origin_and_other/",
  "userid": "",
  "proxy": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ]
  }
}' |
apify call canadesk/reddit --silent --output-dataset

```

## MCP server setup

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

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Reddit",
        "description": "Collect subreddit posts, search for keyword or users, and more from reddit.com! It's fast and costs little.",
        "version": "1.4",
        "x-build-id": "pm5scIn44XPNodZKN"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/canadesk~reddit/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-canadesk-reddit",
                "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/canadesk~reddit/runs": {
            "post": {
                "operationId": "runs-sync-canadesk-reddit",
                "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/canadesk~reddit/run-sync": {
            "post": {
                "operationId": "run-sync-canadesk-reddit",
                "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": [
                    "process"
                ],
                "properties": {
                    "process": {
                        "title": "Process",
                        "enum": [
                            "sk",
                            "gs",
                            "gp",
                            "gu"
                        ],
                        "type": "string",
                        "description": "Process to run.",
                        "default": "gs"
                    },
                    "keyword": {
                        "title": "Keyword",
                        "type": "string",
                        "description": "Only applies to Search for Keywords and Get Subreddit Posts."
                    },
                    "category": {
                        "title": "Category",
                        "enum": [
                            "new",
                            "hot",
                            "top"
                        ],
                        "type": "string",
                        "description": "Only applies to Get Subreddit Posts.",
                        "default": "new"
                    },
                    "postlink": {
                        "title": "Post URL",
                        "type": "string",
                        "description": "Only applies to Get Post Details. Format: https://www.reddit.com/r/{TOPIC}/comments/{ID}/{TITLE}/"
                    },
                    "userid": {
                        "title": "User ID",
                        "type": "string",
                        "description": "Only applies to Get User Posts."
                    },
                    "mode": {
                        "title": "Fetch mode",
                        "enum": [
                            "1",
                            "2"
                        ],
                        "type": "string",
                        "description": "Defines the JSON result format.",
                        "default": "1"
                    },
                    "limit": {
                        "title": "Search limit",
                        "minimum": 1,
                        "maximum": 500,
                        "type": "integer",
                        "description": "Maximum number of results.",
                        "default": 3
                    },
                    "delay": {
                        "title": "Settings - Delay",
                        "minimum": 1,
                        "maximum": 30,
                        "type": "integer",
                        "description": "Waiting time between requests.",
                        "default": 3
                    },
                    "proxy": {
                        "title": "Proxy configuration",
                        "type": "object",
                        "description": "Select proxies to be used by your crawler."
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```