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

# Search Reddit communities



## OpenAPI

````yaml /openapi.json post /reddit/search/communities
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
  - url: http://localhost:4000
    description: Local
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/search/communities:
    post:
      tags:
        - Reddit
      summary: Search Reddit communities
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                  description: >-
                    The text to search Reddit for, e.g. "openai", "best
                    keyboard".
                subreddit:
                  description: >-
                    Restrict the search to a single subreddit (name without the
                    "r/" prefix). Only applies to post search.
                  type: string
                sort:
                  type: string
                  enum:
                    - relevance
                    - hot
                    - top
                    - new
                    - comments
                  description: Result ordering. Defaults to "relevance".
                time:
                  type: string
                  enum:
                    - hour
                    - day
                    - week
                    - month
                    - year
                    - all
                  description: Restrict results to a recent window. Defaults to "all".
                after:
                  description: >-
                    Pagination cursor (a Reddit fullname returned as `after`
                    from a previous page).
                  type: string
                limit:
                  description: Number of results to return (1–100). Defaults to 25.
                  type: integer
                  minimum: 1
                  maximum: 100
              required:
                - query
      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:
                      communities:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: >-
                                Base-36 subreddit id without the `t5_` prefix,
                                e.g. "3b9u5".
                            fullname:
                              type: string
                              description: >-
                                Reddit fullname including the prefix, e.g.
                                "t5_3b9u5".
                            name:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Subreddit name without prefix, e.g. "OpenAI".
                            namePrefixed:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Subreddit name with prefix, e.g. "r/OpenAI".
                            title:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Subreddit display title.
                            description:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Public, short description of the subreddit.
                            subscribers:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: Subscriber count.
                            over18:
                              type: boolean
                              description: Whether the subreddit is marked NSFW.
                            subredditType:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Access type, e.g. "public", "restricted",
                                "private".
                            url:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Site-relative path, e.g. "/r/OpenAI/".
                            communityUrl:
                              type: string
                              description: Absolute URL to the subreddit on reddit.com.
                            iconUrl:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Community icon (falls back to the legacy icon),
                                if any.
                            bannerUrl:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Banner image URL, if any.
                            createdUtc:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: Creation time as a Unix epoch in seconds.
                          required:
                            - id
                            - fullname
                            - name
                            - namePrefixed
                            - title
                            - description
                            - subscribers
                            - over18
                            - subredditType
                            - url
                            - communityUrl
                            - iconUrl
                            - bannerUrl
                            - createdUtc
                          additionalProperties: false
                        description: Matching subreddits / communities.
                      query:
                        type: string
                        description: The query string that was searched on Reddit.
                      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:
                      - communities
                      - query
                      - 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: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Bridgly API key (`bgly_…`). Metered endpoints deduct credits from the
        resolved account.

````