> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Reddit

> Reddit is a social news platform with user-driven communities (subreddits), offering content sharing, discussions, and viral marketing opportunities for brands

Reddit is a social news platform with user-driven communities (subreddits), offering content sharing, discussions, and viral marketing opportunities for brands

`reddit` · **23 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth reddit
run auth reddit --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run reddit          # common commands
run reddit --all    # every command
```

```ts theme={"theme":"github-dark"}
import { reddit } from "@boxd/run";
```

## Common tools

| Tool                      | What it does                                                                                                                                            |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `edit-comment-or-post`    | Edits the body text of the authenticated user's own existing comment or self-post on Reddit; cannot edit link posts or titles.                          |
| `get`                     | Tool to retrieve a listing of Reddit posts sorted by the specified criteria (hot, new, top, rising, controversial, best).                               |
| `get-controversial-posts` | Tool to retrieve controversial posts from all subreddits with time filters.                                                                             |
| `get-new`                 | DEPRECATED: Use RetrieveRedditPost instead. Tool to retrieve newest posts from a subreddit sorted by creation time.                                     |
| `get-user-about`          | Retrieves information about a specified Reddit user account, including karma scores and gold status.                                                    |
| `get-r-top`               | DEPRECATED: Use RetrieveRedditPost with sort='top' and time\_filter set instead - it now supports the same hour/day/week/month/year/all time filtering. |
| `get-subreddits-search`   | Tool to search subreddits by title and description. Use when you need to find subreddits matching a specific topic or keyword.                          |

<Accordion title="All 23 tools" icon="list">
  | Tool                        | What it does                                                                                                                                            |
  | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `create-post`               | Creates a new text or link post on a specified, existing Reddit subreddit, optionally applying a flair.                                                 |
  | `delete-comment`            | Deletes a Reddit comment, identified by its fullname ID, if it was authored by the authenticated user.                                                  |
  | `delete-post`               | Permanently and irreversibly deletes a Reddit post by its ID.                                                                                           |
  | `edit-comment-or-post`      | Edits the body text of the authenticated user's own existing comment or self-post on Reddit; cannot edit link posts or titles.                          |
  | `get`                       | Tool to retrieve a listing of Reddit posts sorted by the specified criteria (hot, new, top, rising, controversial, best).                               |
  | `get-controversial-posts`   | Tool to retrieve controversial posts from all subreddits with time filters.                                                                             |
  | `get-me-prefs`              | Tool to retrieve preference settings of the logged in user. Use when you need to check user preferences or settings.                                    |
  | `get-new`                   | DEPRECATED: Use RetrieveRedditPost instead. Tool to retrieve newest posts from a subreddit sorted by creation time.                                     |
  | `get-random`                | Tool to retrieve a random public Reddit post from any subreddit.                                                                                        |
  | `get-user-about`            | Retrieves information about a specified Reddit user account, including karma scores and gold status.                                                    |
  | `get-r-top`                 | DEPRECATED: Use RetrieveRedditPost with sort='top' and time\_filter set instead - it now supports the same hour/day/week/month/year/all time filtering. |
  | `get-scopes`                | Tool to retrieve all available OAuth scopes supported by the Reddit API.                                                                                |
  | `get-subrules`              | Fetch the explicit posting rules for a subreddit to ensure compliance before posting or commenting.                                                     |
  | `get-subreddits-search`     | Tool to search subreddits by title and description. Use when you need to find subreddits matching a specific topic or keyword.                          |
  | `get-user-flair`            | Fetches the list of user flair assignments for a given subreddit.                                                                                       |
  | `get-username-available`    | Tool to check whether a username is available for registration on Reddit.                                                                               |
  | `list-subpost-flairs`       | List available link/post flairs for a subreddit (including flair\_template\_id) so posts can satisfy flair-required validation.                         |
  | `post-comment`              | Posts a comment on Reddit, replying to an existing submission (post) or another comment.                                                                |
  | `retrieve-post-comments`    | Retrieves all comments for a Reddit post given its base-36 article ID.                                                                                  |
  | `retrieve-post`             | Retrieves posts from a specified, publicly accessible subreddit.                                                                                        |
  | `retrieve-specific-comment` | Retrieves detailed information for a single Reddit comment or post using its fullname.                                                                  |
  | `search-across-subreddits`  | Searches Reddit for posts using a query. Results are nested under `data.children[i].data` (kind `t3` for posts); a `posts` array may also appear, so... |
  | `toggle-inbox-replies`      | Enable or disable inbox replies for a submission or comment.                                                                                            |
</Accordion>

[Open Reddit in the console →](https://app.boxd.sh/integrations/detail/reddit)
