Reddit Subreddit Listing

reddit_subreddit_listing

Fetch posts from a subreddit with configurable sort order and limit

Category: reddit•Timeout: 300s• Retryable

Input schema

POST this shape to /api/v1/tasks as the input field when creating a task in a group of type reddit_subreddit_listing.

{
  "type": "object",
  "properties": {
    "subreddit": {
      "type": "string",
      "description": "Subreddit name without the r/ prefix (e.g. \"programming\")",
      "examples": [
        "programming",
        "SaaS",
        "wallstreetbets"
      ]
    },
    "sort": {
      "type": "string",
      "enum": [
        "new",
        "hot",
        "top",
        "best",
        "rising"
      ],
      "description": "Post sort order"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Number of posts to fetch (1–100)"
    },
    "timeframe": {
      "type": "string",
      "enum": [
        "hour",
        "day",
        "week",
        "month",
        "year",
        "all"
      ],
      "description": "Time window — only applies when sort is \"top\""
    }
  },
  "required": [
    "subreddit",
    "sort",
    "limit"
  ]
}

Output schema

Executors submit their output matching this shape to /api/v1/tasks/[taskId]/submit. Readers pull it back from task detail endpoints.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The resolved Reddit listing URL that was fetched"
    },
    "data": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "description": "Always \"Listing\""
        },
        "data": {
          "type": "object",
          "properties": {
            "after": {
              "type": [
                "string",
                "null"
              ],
              "description": "Pagination cursor for the next page"
            },
            "children": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "description": "Always \"t3\""
                  },
                  "data": {
                    "type": "object",
                    "description": "Reddit t3 Post object (filtered fields only)",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "title": {
                        "type": "string"
                      },
                      "selftext": {
                        "type": "string"
                      },
                      "url": {
                        "type": "string"
                      },
                      "permalink": {
                        "type": "string"
                      },
                      "author": {
                        "type": "string"
                      },
                      "subreddit": {
                        "type": "string"
                      },
                      "score": {
                        "type": "integer"
                      },
                      "num_comments": {
                        "type": "integer"
                      },
                      "created_utc": {
                        "type": "number"
                      },
                      "is_self": {
                        "type": "boolean"
                      },
                      "upvote_ratio": {
                        "type": "number"
                      },
                      "link_flair_text": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "over_18": {
                        "type": "boolean"
                      },
                      "stickied": {
                        "type": "boolean"
                      },
                      "thumbnail": {
                        "type": "string"
                      },
                      "is_video": {
                        "type": "boolean"
                      },
                      "domain": {
                        "type": "string"
                      },
                      "post_hint": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "required": [
    "url",
    "data"
  ]
}

Ready to run Reddit Subreddit Listing?

Create a project, approve an executor, and push your first reddit_subreddit_listing task.

Get started