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

# Get subreddit profile

> Costs 2 credits.



## OpenAPI

````yaml /openapi.json get /v1/reddit/subreddits/{name}
openapi: 3.1.0
info:
  title: Nephia API
  description: >-
    B2B API for structured data from live Sources (Vinted, X, Reddit).
    Authenticate with an API key on your Account. Pull endpoints charge credits
    per request. Watches poll on an interval and deliver webhook events. Product
    request quota is per Account (all API keys share one bucket), by Plan: Free
    60/min, Starter 350/min, Growth 700/min, Pro 1,200/min. Credit packs do not
    raise the quota.
  version: 1.0.0
servers:
  - url: https://api.nephia.cc
    description: Production
  - url: http://localhost:3000
    description: Local
security:
  - ApiKeyAuth: []
tags:
  - name: Account
    description: Account balance
  - name: Vinted — Search
    description: Vinted catalog search
  - name: Vinted — Items
    description: Vinted listing detail
  - name: Vinted — Users
    description: Vinted sellers and wardrobes
  - name: Vinted — Reference
    description: Vinted filter metadata
  - name: Vinted — Watches
    description: Vinted watches, events, and activity
  - name: X — Tweets
    description: Tweet lookup, replies, thread, quotes, and engagers
  - name: X — Users
    description: X profiles, timelines, and social graphs
  - name: X — Search
    description: Tweet search
  - name: X — Lists
    description: X list timelines
  - name: X — Trends
    description: Trend places and snapshots
  - name: X — Watches
    description: X watches, events, and activity
  - name: Reddit — Search
    description: Reddit post, subreddit, and user search
  - name: Reddit — Posts
    description: Reddit posts, comments, duplicates, and trending
  - name: Reddit — Subreddits
    description: Subreddit profiles, listings, and rules
  - name: Reddit — Users
    description: Reddit user profiles and activity
  - name: Reddit — Watches
    description: Reddit watches, events, and activity
paths:
  /v1/reddit/subreddits/{name}:
    get:
      tags:
        - Reddit — Subreddits
      summary: Get subreddit profile
      description: Costs 2 credits.
      operationId: getV1RedditSubredditsByName
      parameters:
        - in: path
          name: name
          schema:
            type: string
            minLength: 1
          required: true
      responses:
        '200':
          description: Subreddit profile
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  id:
                    type:
                      - string
                      - 'null'
                  fullname:
                    type:
                      - string
                      - 'null'
                  title:
                    type: string
                  publicDescription:
                    type:
                      - string
                      - 'null'
                  description:
                    type:
                      - string
                      - 'null'
                  subscribers:
                    type:
                      - number
                      - 'null'
                  activeUsers:
                    type:
                      - number
                      - 'null'
                  type:
                    type:
                      - string
                      - 'null'
                  isNsfw:
                    type: boolean
                  isQuarantined:
                    type: boolean
                  iconUrl:
                    type:
                      - string
                      - 'null'
                  bannerUrl:
                    type:
                      - string
                      - 'null'
                  createdAt:
                    type:
                      - string
                      - 'null'
                  permissions:
                    type:
                      - object
                      - 'null'
                    properties:
                      canPost:
                        type:
                          - boolean
                          - 'null'
                      canComment:
                        type:
                          - boolean
                          - 'null'
                      canWiki:
                        type:
                          - boolean
                          - 'null'
                      canFlair:
                        type:
                          - boolean
                          - 'null'
                      canMod:
                        type:
                          - boolean
                          - 'null'
                    required:
                      - canPost
                      - canComment
                      - canWiki
                      - canFlair
                      - canMod
                required:
                  - name
                  - id
                  - fullname
                  - title
                  - publicDescription
                  - description
                  - subscribers
                  - activeUsers
                  - type
                  - isNsfw
                  - isQuarantined
                  - iconUrl
                  - bannerUrl
                  - createdAt
                  - permissions
        '402':
          description: Insufficient credits
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
        '404':
          description: Subreddit not found or private
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
        '429':
          description: >-
            Request quota exceeded. Retry after the `Retry-After` header
            (seconds). Response includes `RateLimit-*` headers (IETF draft-7).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
              example:
                error: Rate limit exceeded
                code: TOO_MANY_REQUESTS
        '503':
          description: Upstream temporarily unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key created from the Nephia dashboard for your Account.

````