← Reddit

List Comments in a Post with Reddit API

Pipedream makes it easy to connect APIs for Reddit and 800+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
List Comments in a Post with the Reddit API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to List Comments in a Post with the Reddit API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the List Comments in a Post action
    1. Connect your Reddit account
    2. Select a Subreddit
    3. Select a Post
    4. Optional- Configure Number of Parents
    5. Optional- Configure Depth
    6. Optional- Configure Include subreddit details?
    7. Optional- Select a Sort
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

List Comments in a Post on Reddit
Description:List comments for a specific post. [See the docs here](https://www.reddit.com/dev/api/#GET_comments_{article})
Version:0.0.2
Key:reddit-list-comments-in-a-post

Code

import reddit from "../../reddit.app.mjs";
import { axios } from "@pipedream/platform";

export default {
  type: "action",
  key: "reddit-list-comments-in-a-post",
  version: "0.0.2",
  name: "List Comments in a Post",
  description: "List comments for a specific post. [See the docs here](https://www.reddit.com/dev/api/#GET_comments_{article})",
  props: {
    reddit,
    subreddit: {
      propDefinition: [
        reddit,
        "subreddit",
      ],
      description: "Search for a subreddit, or enter a subreddit display name as a custom expression (for example, `happycowgifs`).",
    },
    subredditPost: {
      propDefinition: [
        reddit,
        "subredditPost",
        ({ subreddit }) => ({
          subreddit,
        }),
      ],
    },
    numberOfParents: {
      propDefinition: [
        reddit,
        "numberOfParents",
      ],
    },
    depth: {
      propDefinition: [
        reddit,
        "depth",
      ],
      description: "If set to `1`, include only new comments that are direct children to the subreddit pointed at by **Post**. Furthermore, `depth` determines the maximum depth of children, within the related subreddit comment tree, of new comments to be included.",
    },
    includeSubredditDetails: {
      propDefinition: [
        reddit,
        "includeSubredditDetails",
      ],
    },
    sort: {
      type: "string",
      label: "Sort",
      description: "The order of the comments",
      optional: true,
      options: [
        "confidence",
        "top",
        "new",
        "controversial",
        "old",
        "random",
        "qa",
        "live",
      ],
    },
  },
  async run({ $ }) {
    const {
      subreddit,
      subredditPost,
      numberOfParents,
      depth,
      includeSubredditDetails,
      sort,
    } = this;

    const res = await axios($, this.reddit._getAxiosParams({
      method: "GET",
      path: `/r/${subreddit?.value || subreddit}/comments/article`,
      params: {
        article: subredditPost?.value || subredditPost,
        context: numberOfParents,
        depth: depth,
        sr_detail: includeSubredditDetails,
        threaded: true,
        sort: sort,
      },
    }));

    $.export("$summary", `Comments for "${subredditPost?.label || subredditPost}" in "${subreddit?.label || subreddit}" subreddit successfully fetched`);
    return res;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
RedditredditappThis component uses the Reddit app.
SubredditsubredditstringSelect a value from the drop down menu.
PostsubredditPoststringSelect a value from the drop down menu.
Number of ParentsnumberOfParentsinteger

When set to 0, it will only contain the new comment. Otherwise, it will also contain the parents of the comment up to the number indicated in this property.

Depthdepthinteger

If set to 1, include only new comments that are direct children to the subreddit pointed at by Post. Furthermore, depth determines the maximum depth of children, within the related subreddit comment tree, of new comments to be included.

Include subreddit details?includeSubredditDetailsboolean

If set to true, subreddit details will be expanded/included.

SortsortstringSelect a value from the drop down menu:confidencetopnewcontroversialoldrandomqalive

Authentication

Reddit uses OAuth authentication. When you connect your Reddit account, Pipedream will open a popup window where you can sign into Reddit and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Reddit API.

Pipedream requests the following authorization scopes when you connect your account:

accountidentityeditflairhistoryreadreportsavestructuredstylessubmitsubscribevoteflairmodflairmodconfigmodflairmodlogmodpostsmodwikimysubredditswikieditwikiread

About Reddit

Reddit is a network of communities based on people's interests. Find communities you're interested in, and become part of an online community!