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

# List posts in a subreddit feed



## OpenAPI

````yaml /openapi.json post /reddit/list-subreddit-posts
openapi: 3.1.0
info:
  title: Bridgly API
  description: >-
    Web scraping API for LinkedIn, X (Twitter) and Reddit. Authenticated
    endpoints accept a Bridgly API key (`bgly_…`) via `Authorization: Bearer
    <token>`.
  version: 1.0.0
servers:
  - url: https://api.bridgly.app
    description: Production
security: []
tags:
  - name: LinkedIn
    description: Scrape LinkedIn profiles, companies, posts, and search.
  - name: Reddit
    description: Scrape Reddit posts, subreddits, users, and search.
  - name: X (Twitter)
    description: Scrape tweets and search X.
paths:
  /reddit/list-subreddit-posts:
    post:
      tags:
        - Reddit
      summary: List posts in a subreddit feed
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                subreddit:
                  type: string
                  description: Subreddit name without the "r/" prefix, e.g. "programming".
                sort:
                  type: string
                  enum:
                    - hot
                    - new
                    - top
                    - rising
                  description: Feed ordering. Defaults to "hot".
                time:
                  type: string
                  enum:
                    - hour
                    - day
                    - week
                    - month
                    - year
                    - all
                  description: Restrict results to a recent window. Defaults to "all".
                count:
                  default: 10
                  description: Number of posts to return (1–10). Defaults to 10.
                  type: integer
                  minimum: 1
                  maximum: 10
                after:
                  description: >-
                    Pagination cursor (a Reddit fullname returned as `after`
                    from a previous page).
                  type: string
              required:
                - subreddit
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  timeMs:
                    type: number
                    description: >-
                      Wall-clock time the request took to complete, in
                      milliseconds.
                  creditsCost:
                    type: number
                    description: Number of account credits this request consumed.
                  data:
                    type: object
                    properties:
                      posts:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: >-
                                Base-36 post id without the `t3_` prefix, e.g.
                                "1u3a0cd".
                            fullname:
                              type: string
                              description: >-
                                Reddit fullname including the type prefix, e.g.
                                "t3_1u3a0cd".
                            title:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Post title.
                            author:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Author username, or "[deleted]" when removed.
                            authorFullname:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Author account fullname, e.g. "t2_98wao505".
                            selftext:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Self-post body text (empty string for link
                                posts).
                            score:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: Net score (upvotes minus downvotes).
                            ups:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: >-
                                Upvote count (Reddit fuzzes this for large
                                posts).
                            downs:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: >-
                                Downvote count (Reddit reports 0 on modern
                                listings).
                            upvoteRatio:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: Fraction of votes that are upvotes, 0–1.
                            numComments:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: Total comment count.
                            numCrossposts:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: Number of times this post has been crossposted.
                            totalAwardsReceived:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: Total number of awards the post has received.
                            gilded:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: >-
                                Number of times the post has been gilded (gold
                                awards).
                            createdUtc:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: Creation time as a Unix epoch in seconds.
                            createdAt:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Creation time as an ISO-8601 UTC string, e.g.
                                "2026-07-12T…Z".
                            editedUtc:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: >-
                                Last edit time as a Unix epoch in seconds, or
                                null if never edited.
                            editedAt:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Last edit time as an ISO-8601 UTC string, or
                                null if never edited.
                            permalink:
                              type: string
                              description: >-
                                Site-relative permalink path, e.g.
                                "/r/technology/comments/…".
                            postUrl:
                              type: string
                              description: Absolute URL to the post on reddit.com.
                            url:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                The URL the post points to — the external link
                                for link posts, or the post permalink for self
                                posts.
                            subreddit:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Subreddit name without prefix, e.g.
                                "technology".
                            subredditId:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Subreddit fullname (stable `t5_` id), e.g.
                                "t5_2fwo" — use to look the community up.
                            subredditUrl:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Absolute URL to the subreddit on reddit.com.
                            subredditPrefixed:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Subreddit name with prefix, e.g. "r/technology".
                            subredditSubscribers:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: Subscriber count of the subreddit, when present.
                            subredditType:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Subreddit access type, e.g. "public",
                                "restricted", "private".
                            linkFlairText:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Link flair label, if any.
                            domain:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Source domain, e.g. "self.technology" or
                                "nytimes.com".
                            thumbnail:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Thumbnail URL, or a sentinel like
                                "self"/"default"/"nsfw" when there is no image.
                            distinguished:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Distinguish state set by staff, e.g. "moderator"
                                or "admin"; null for regular posts.
                            isSelf:
                              type: boolean
                              description: Whether this is a self (text) post.
                            isVideo:
                              type: boolean
                              description: Whether the post hosts a Reddit video.
                            isOriginalContent:
                              type: boolean
                              description: >-
                                Whether the post is flagged as original content
                                (OC).
                            over18:
                              type: boolean
                              description: Whether the post is marked NSFW.
                            spoiler:
                              type: boolean
                              description: Whether the post is marked as a spoiler.
                            stickied:
                              type: boolean
                              description: >-
                                Whether the post is pinned to the top of its
                                subreddit feed.
                            pinned:
                              type: boolean
                              description: >-
                                Whether the post is pinned to the author's
                                profile.
                            archived:
                              type: boolean
                              description: >-
                                Whether the post is archived (no longer accepts
                                votes).
                            contestMode:
                              type: boolean
                              description: >-
                                Whether comments are shown in randomized
                                contest-mode order.
                            locked:
                              type: boolean
                              description: Whether commenting is locked.
                          required:
                            - id
                            - fullname
                            - title
                            - author
                            - authorFullname
                            - selftext
                            - score
                            - ups
                            - downs
                            - upvoteRatio
                            - numComments
                            - numCrossposts
                            - totalAwardsReceived
                            - gilded
                            - createdUtc
                            - createdAt
                            - editedUtc
                            - editedAt
                            - permalink
                            - postUrl
                            - url
                            - subreddit
                            - subredditId
                            - subredditUrl
                            - subredditPrefixed
                            - subredditSubscribers
                            - subredditType
                            - linkFlairText
                            - domain
                            - thumbnail
                            - distinguished
                            - isSelf
                            - isVideo
                            - isOriginalContent
                            - over18
                            - spoiler
                            - stickied
                            - pinned
                            - archived
                            - contestMode
                            - locked
                          additionalProperties: false
                        description: Posts in the subreddit feed.
                      subreddit:
                        type: string
                        description: >-
                          The subreddit these posts belong to (without the "r/"
                          prefix).
                      after:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: >-
                          Pagination cursor for the next page (Reddit `after`
                          fullname), or null when there are no more results.
                    required:
                      - posts
                      - subreddit
                      - after
                    additionalProperties: false
                required:
                  - timeMs
                  - creditsCost
                  - data
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '402':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: typescript
          label: Bridgly SDK
          source: |-
            import { Bridgly } from 'bridgly';

            const client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });

            const res = await client.reddit.listSubredditPosts({
              subreddit: "string",
              count: 10,
            });
            if (res.type === 'success') console.log(res.data);
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Bridgly API key (`bgly_…`). Metered endpoints deduct credits from the
        resolved account.

````