Type Value: REDDIT_USER
Status: PRODUCTION

A REDDIT_USER link type corresponds to a Reddit user profile. Alongside the standard preview attributes (title, description, image), REDDIT_USER links provide rich metadata about a user’s karma, profile images, and creation date. This helps you integrate Reddit users into your application with detailed, authentic previews.

What It Includes

When type is REDDIT_USER, the response includes a redditUser object with fields like:

  • username & name: The Reddit handle and optional display name.
  • Avatar fields: Multiple avatar or banner images (including flattened and background variants) that let you choose from different representations or layouts.
  • bio: A short biography or user description.
  • karma, postKarma, commentKarma: Metrics reflecting the user’s engagement and contribution style.
  • joinedAt: The date and time when the user’s account was created.

By leveraging these details, you can create user profiles that highlight an individual’s Reddit history, reputation, and personality.

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/u/lifenautjoe"}'

Example Response

{
    "id": 651,
    "ok": false,
    "url": "https://www.reddit.com/u/lifenautjoe/",
    "domain": "reddit.com",
    "type": "REDDIT_USER",
    "status": 302,
    "updatedAt": "2024-11-27T12:04:12.225Z",
    "redirected": true,
    "redirectionUrl": "https://www.reddit.com/u/lifenautjoe/?rdt=51369",
    "redirectionCount": 2,
    "redirectionTrail": [
        "https://www.reddit.com/u/lifenautjoe/",
        "https://www.reddit.com/u/lifenautjoe/?rdt=51369"
    ],
    "title": "lifenautjoe (u/lifenautjoe)",
    "description": "AI/ML Engineer",
    "icon": {
        "url": "https://cdn.peekalink.io/d7ss90zj4em6rbb4pomieg6f/346/76x76.png",
        "width": 76,
        "height": 76,
        "backgroundColor": "#000000"
    },
    "image": {
        "id": 1331,
        "thumbnailId": 4998,
        "mediumId": 4997,
        "largeId": 4999,
        "originalId": 5000,
        "thumbnail": {
            "id": 4998,
            "url": "https://cdn.peekalink.io/reddit-users/lifenautjoe/flattened-avatar/lifenautjoe-flattened-avatar-1210_thumbnail.png",
            "width": 180,
            "height": 240,
            "size": 9979,
            "format": "png",
            "createdAt": "2024-11-27T10:27:29.005Z",
            "updatedAt": "2024-11-27T10:27:29.005Z"
        },
        "medium": {
            "id": 4997,
            "url": "https://cdn.peekalink.io/reddit-users/lifenautjoe/flattened-avatar/lifenautjoe-flattened-avatar-1210_medium.png",
            "width": 360,
            "height": 480,
            "size": 25145,
            "format": "png",
            "createdAt": "2024-11-27T10:27:28.980Z",
            "updatedAt": "2024-11-27T10:27:28.980Z"
        },
        "large": {
            "id": 4999,
            "url": "https://cdn.peekalink.io/reddit-users/lifenautjoe/flattened-avatar/lifenautjoe-flattened-avatar-1210_large.png",
            "width": 552,
            "height": 736,
            "size": 31596,
            "format": "png",
            "createdAt": "2024-11-27T10:27:29.013Z",
            "updatedAt": "2024-11-27T10:27:29.013Z"
        },
        "original": {
            "id": 5000,
            "url": "https://cdn.peekalink.io/reddit-users/lifenautjoe/flattened-avatar/lifenautjoe-flattened-avatar-1210_original.png",
            "width": 552,
            "height": 736,
            "size": 31596,
            "format": "png",
            "createdAt": "2024-11-27T10:27:29.077Z",
            "updatedAt": "2024-11-27T10:27:29.077Z"
        }
    },
    "redditUser": {
        "id": 28,
        "username": "lifenautjoe",
        "name": "lifenautjoe",
        "bio": "AI/ML Engineer",
        "karma": 2548,
        "postKarma": 1997,
        "commentKarma": 551,
        "joinedAt": "2017-10-09T00:00:00.000Z",
        "flattenedAvatar": {
            "id": 1331,
            "thumbnailId": 4998,
            "mediumId": 4997,
            "largeId": 4999,
            "originalId": 5000,
            "thumbnail": {
                "id": 4998,
                "url": "https://cdn.peekalink.io/reddit-users/lifenautjoe/flattened-avatar/lifenautjoe-flattened-avatar-1210_thumbnail.png",
                "width": 180,
                "height": 240,
                "size": 9979,
                "format": "png",
                "createdAt": "2024-11-27T10:27:29.005Z",
                "updatedAt": "2024-11-27T10:27:29.005Z"
            },
            "medium": {
                "id": 4997,
                "url": "https://cdn.peekalink.io/reddit-users/lifenautjoe/flattened-avatar/lifenautjoe-flattened-avatar-1210_medium.png",
                "width": 360,
                "height": 480,
                "size": 25145,
                "format": "png",
                "createdAt": "2024-11-27T10:27:28.980Z",
                "updatedAt": "2024-11-27T10:27:28.980Z"
            },
            "large": {
                "id": 4999,
                "url": "https://cdn.peekalink.io/reddit-users/lifenautjoe/flattened-avatar/lifenautjoe-flattened-avatar-1210_large.png",
                "width": 552,
                "height": 736,
                "size": 31596,
                "format": "png",
                "createdAt": "2024-11-27T10:27:29.013Z",
                "updatedAt": "2024-11-27T10:27:29.013Z"
            },
            "original": {
                "id": 5000,
                "url": "https://cdn.peekalink.io/reddit-users/lifenautjoe/flattened-avatar/lifenautjoe-flattened-avatar-1210_original.png",
                "width": 552,
                "height": 736,
                "size": 31596,
                "format": "png",
                "createdAt": "2024-11-27T10:27:29.077Z",
                "updatedAt": "2024-11-27T10:27:29.077Z"
            }
        },
        "avatar": {
            "thumbnail": {
                "width": 187,
                "height": 240,
                "url": "https://cdn.peekalink.io/eqcpq75jurux7nvvw8w455ah/1401/e81c8edc-0ec6-47df-90f4-ce04e9d496e8_thumbnail.png"
            },
            "medium": {
                "width": 375,
                "height": 480,
                "url": "https://cdn.peekalink.io/eqcpq75jurux7nvvw8w455ah/1401/e81c8edc-0ec6-47df-90f4-ce04e9d496e8_medium.png"
            },
            "large": {
                "width": 380,
                "height": 487,
                "url": "https://cdn.peekalink.io/eqcpq75jurux7nvvw8w455ah/1401/e81c8edc-0ec6-47df-90f4-ce04e9d496e8_large.png"
            },
            "original": {
                "width": 380,
                "height": 487,
                "url": "https://cdn.peekalink.io/eqcpq75jurux7nvvw8w455ah/1401/e81c8edc-0ec6-47df-90f4-ce04e9d496e8_original.png"
            }
        },
        "avatarBackground": {
            "thumbnail": {
                "width": 320,
                "height": 96,
                "url": "https://cdn.peekalink.io/af30xn8p96eautgrgmo8rgfx/1211/profileBanner_e55nfl0nqd3e1_thumbnail.jpeg"
            },
            "medium": {
                "width": 640,
                "height": 192,
                "url": "https://cdn.peekalink.io/af30xn8p96eautgrgmo8rgfx/1211/profileBanner_e55nfl0nqd3e1_medium.jpeg"
            },
            "large": {
                "width": 1280,
                "height": 384,
                "url": "https://cdn.peekalink.io/af30xn8p96eautgrgmo8rgfx/1211/profileBanner_e55nfl0nqd3e1_large.jpeg"
            },
            "original": {
                "width": 1280,
                "height": 384,
                "url": "https://cdn.peekalink.io/af30xn8p96eautgrgmo8rgfx/1211/profileBanner_e55nfl0nqd3e1_original.jpeg"
            }
        },
        "banner": {
            "thumbnail": {
                "width": 320,
                "height": 96,
                "url": "https://cdn.peekalink.io/af30xn8p96eautgrgmo8rgfx/1211/profileBanner_e55nfl0nqd3e1_thumbnail.jpeg"
            },
            "medium": {
                "width": 640,
                "height": 192,
                "url": "https://cdn.peekalink.io/af30xn8p96eautgrgmo8rgfx/1211/profileBanner_e55nfl0nqd3e1_medium.jpeg"
            },
            "large": {
                "width": 1280,
                "height": 384,
                "url": "https://cdn.peekalink.io/af30xn8p96eautgrgmo8rgfx/1211/profileBanner_e55nfl0nqd3e1_large.jpeg"
            },
            "original": {
                "width": 1280,
                "height": 384,
                "url": "https://cdn.peekalink.io/af30xn8p96eautgrgmo8rgfx/1211/profileBanner_e55nfl0nqd3e1_original.jpeg"
            }
        }
    },
    "requestId": "cm4r5j7k00001ko1ua54cqafe"
}

Special Notes

  • Fallback Strategies: If certain fields are missing, Peekalink uses inference to ensure a consistent, useful preview.
  • Multiple Avatar & Banner Options: Different image fields offer flexible design choices when displaying user profiles.
  • Karma Metrics: Highlight the user’s activity and reputation by showing total karma or breaking it down into post and comment karma.

Schema reference

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