Type Value: REDDIT_SUBREDDIT
Status: PRODUCTION

A REDDIT_SUBREDDIT link type corresponds to a Reddit community. Along with the standard preview attributes (title, description, image), REDDIT_SUBREDDIT links provide in-depth community details such as subscriber counts, activity levels, and moderation status. This allows you to enrich your application with community-oriented data and display insightful subreddit profiles.

What It Includes

When type is REDDIT_SUBREDDIT, the response includes a redditSubreddit object with fields like:

  • name & title: The subreddit’s handle (e.g., r/programming) and its human-friendly title.
  • description: A brief summary or statement of the subreddit’s purpose.
  • subscribersCount & activeUsersCount: Metrics indicating the community size and engagement level.
  • createdDate: When the subreddit was established.
  • type: Indicates whether the subreddit is public, private, or restricted.
  • nsfw: A boolean flag to show if the community is tagged as Not Safe For Work.
  • banner & avatar: Responsive images for visual branding elements.

These attributes let you highlight a subreddit’s popularity, content nature, and access level, helping users quickly gauge whether it’s a community they’d like to join or explore further.

Example Request

curl -X POST "https://api.peekalink.io/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"link": "https://www.reddit.com/r/aww"}'

Example Response

{
    "id": 275,
    "ok": false,
    "url": "https://www.reddit.com/r/aww/",
    "domain": "reddit.com",
    "type": "REDDIT_SUBREDDIT",
    "status": 302,
    "updatedAt": "2024-12-16T14:51:59.775Z",
    "size": 1288732,
    "redirected": true,
    "redirectionUrl": "https://www.reddit.com/r/aww/?rdt=34759",
    "redirectionCount": 2,
    "redirectionTrail": [
        "https://www.reddit.com/r/aww/",
        "https://www.reddit.com/r/aww/?rdt=34759"
    ],
    "title": "A subreddit for cute and cuddly pictures (r/aww)",
    "description": "Things that make you go AWW! -- like puppies, bunnies, babies, and so on...\nFeel free to post original pictures and videos of cute things.",
    "icon": {
        "url": "https://cdn.peekalink.io/d7ss90zj4em6rbb4pomieg6f/346/76x76.png",
        "width": 76,
        "height": 76,
        "backgroundColor": "#000000"
    },
    "image": {
        "thumbnail": {
            "width": 240,
            "height": 240,
            "url": "https://cdn.peekalink.io/g7vr5epg4nf6u4ox37l1cs4o/1404/communityIcon_uz6ge49x9h6e1_thumbnail.png"
        },
        "medium": {
            "width": 250,
            "height": 250,
            "url": "https://cdn.peekalink.io/g7vr5epg4nf6u4ox37l1cs4o/1404/communityIcon_uz6ge49x9h6e1_medium.png"
        },
        "large": {
            "width": 250,
            "height": 250,
            "url": "https://cdn.peekalink.io/g7vr5epg4nf6u4ox37l1cs4o/1404/communityIcon_uz6ge49x9h6e1_large.png"
        },
        "original": {
            "width": 250,
            "height": 250,
            "url": "https://cdn.peekalink.io/g7vr5epg4nf6u4ox37l1cs4o/1404/communityIcon_uz6ge49x9h6e1_original.png"
        }
    },
    "redditSubreddit": {
        "id": 23,
        "name": "aww",
        "title": "A subreddit for cute and cuddly pictures",
        "description": "Things that make you go AWW! -- like puppies, bunnies, babies, and so on...\n\nFeel free to post original pictures and videos of cute things.",
        "type": "PUBLIC",
        "nsfw": false,
        "activeUsersCount": 770,
        "subscribersCount": 37263585,
        "createdDate": "2008-01-25T04:07:02.756Z",
        "avatar": {
            "thumbnail": {
                "width": 240,
                "height": 240,
                "url": "https://cdn.peekalink.io/g7vr5epg4nf6u4ox37l1cs4o/1404/communityIcon_uz6ge49x9h6e1_thumbnail.png"
            },
            "medium": {
                "width": 250,
                "height": 250,
                "url": "https://cdn.peekalink.io/g7vr5epg4nf6u4ox37l1cs4o/1404/communityIcon_uz6ge49x9h6e1_medium.png"
            },
            "large": {
                "width": 250,
                "height": 250,
                "url": "https://cdn.peekalink.io/g7vr5epg4nf6u4ox37l1cs4o/1404/communityIcon_uz6ge49x9h6e1_large.png"
            },
            "original": {
                "width": 250,
                "height": 250,
                "url": "https://cdn.peekalink.io/g7vr5epg4nf6u4ox37l1cs4o/1404/communityIcon_uz6ge49x9h6e1_original.png"
            }
        },
        "banner": {
            "thumbnail": {
                "width": 320,
                "height": 23,
                "url": "https://cdn.peekalink.io/kgfeg8ibc04yssxf48tmc8pf/1405/bannerBackgroundImage_rympiqekcqbc1_thumbnail.jpeg"
            },
            "medium": {
                "width": 640,
                "height": 46,
                "url": "https://cdn.peekalink.io/kgfeg8ibc04yssxf48tmc8pf/1405/bannerBackgroundImage_rympiqekcqbc1_medium.jpeg"
            },
            "large": {
                "width": 1280,
                "height": 91,
                "url": "https://cdn.peekalink.io/kgfeg8ibc04yssxf48tmc8pf/1405/bannerBackgroundImage_rympiqekcqbc1_large.jpeg"
            },
            "original": {
                "width": 2000,
                "height": 143,
                "url": "https://cdn.peekalink.io/kgfeg8ibc04yssxf48tmc8pf/1405/bannerBackgroundImage_rympiqekcqbc1_original.jpeg"
            }
        }
    },
    "requestId": "cm4r5m3qz0001149uclkq9nrg"
}

Special Notes

  • Fallback Strategies: If metadata is missing, Peekalink infers defaults to maintain consistency.
  • NSFW & Type Fields: These let you adjust how you present or filter communities based on content sensitivity or access restrictions.
  • Scalable Integration: Start with the basic title and subscriber count, then incrementally add details like active user counts, banners, and descriptions as your product matures.

Schema reference

For a full technical breakdown of all fields and validation rules, including detailed JSON schemas, please refer to the API Reference.