> ## Documentation Index > Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt > Use this file to discover all available pages before exploring further. # Reddit user API > Get a user's profile and a page of their posts and comments. Call the Reddit user API for JSON. 1 credit per call. Every call returns the same flat shape. Returns a user's profile and a page of their posts and comments. The user is identified by its URL or username. ## Request Exactly one of `userUrl` or `username` is required. A request that sets both, or none, fails with `invalidRequest`. ```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null} import { Stophy } from "stophy"; const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY }); const result = await stophy.reddit.user({ username: "spez" }); console.log(result.data.results); ``` ```python Python icon="python" theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.reddit.user(username="spez") print(result["data"]["results"]) ``` ```bash cURL icon="terminal" theme={null} curl -X POST https://api.stophy.dev/v1/reddit/user \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"username":"spez"}' ``` ```bash CLI icon="square-terminal" theme={null} stophy reddit user --username spez ``` ## Response If successful, the response body contains the standard envelope. `data` contains the user's profile and karma, and `results` lists a page of their posts and comments. The following example is a real response, truncated: each list shows one item and long strings are cut. ```json theme={null} { "success": true, "data": { "userId": "1w72", "username": "spez", "userUrl": "https://www.reddit.com/user/spez/", "postKarma": 184509, "commentKarma": 756493, "createdAt": "2005-06-06T04:00:00.000Z", "avatarUrl": "https://styles.redditmedia.com/t5_3k30p/styles/profileIcon_uj015iwx9s7g1.png?width=256&height=256&crop=256:256,smart&s=…", "isVerified": true, "results": [ { "type": "comment", "commentId": "p1wosm9", "commentUrl": "https://www.reddit.com/r/u_spez/comments/1vgbkge/modernizing_reddits_infrastructure_with_you/p1wosm9/", "text": "That was the thinking. Otherwise it would be easier to just replicate the UI. ", "score": 13, "publishedAt": "2026-08-05T18:31:50.000Z", "subreddit": "u_spez", "postId": "1vgbkge", "postTitle": "Modernizing Reddit’s infrastructure with you" }, { "type": "post", "postId": "1vgbkge", "postUrl": "https://www.reddit.com/r/u_spez/comments/1vgbkge/modernizing_reddits_infrastructure_with_you/", "title": "Modernizing Reddit’s infrastructure with you", "text": "Hi everyone,\n\nLast May, I shared how we were building Reddit for its [next…", "authorId": "1w72", "authorUsername": "spez", "authorUrl": "https://www.reddit.com/user/spez/", "subreddit": "u_spez", "score": 350, "upvotePercent": 84, "comments": 472, "publishedAt": "2026-08-05T16:03:56.000Z", "thumbnailUrl": "https://external-preview.redd.it/-_NM9QKmwnaF7Ti3sXwY6oJD9PVQrQGXBx1288oLFXw.png?auto=webp&s=58d39b335111d200e60a1e6fa3…", "isNsfw": false, "isVideo": false, "isPinned": false } ], "cursor": "t1_opmb76u" }, "creditsUsed": 1, "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b" } ``` | Field | Type | Description | | - | - | - | | `cursor` | string | The pagination token. Pass it as `cursor` to retrieve the next page. Omitted on the last page. | | `type` | string | The kind of item: `post` or `comment`. | | `publishedAt` | string (ISO 8601) | The publication time, in UTC. | | `score` | integer | Upvotes minus downvotes. | | `upvotePercent` | number | The share of votes that are upvotes, as a percentage. | | `createdAt` | string (ISO 8601) | The creation time, in UTC. | For every field, see the response schema on this page. ## Optional parameters | Parameter | Type | Description | | - | - | - | | `tab` | string | Specifies which part of the profile to read. Acceptable values are `overview`, `posts` and `comments`. If unset, defaults to `overview`. | | `sort` | string | Specifies the order of the results. Acceptable values are `newest`, `hot`, `top` and `controversial`. If unset, defaults to `newest`. | | `time` | string | Restricts results to posts from this period. Leave it out for Reddit's default. Acceptable values are `pastHour`, `today`, `pastWeek`, `pastMonth`, `pastYear` and `allTime`. | | `cursor` | string | The pagination token from the previous response. | ## Billing Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed. ## Pagination Results are paginated. To retrieve the next page, pass the value of `data.cursor` as `cursor` in a subsequent request. A response that omits `cursor` is the last page. ## Related methods * [Reddit post](/api-reference/endpoint/reddit-post): Accepts `postUrl`. Returns a post and its comment thread, with a cursor for the rest of the comments. * [Reddit subreddit](/api-reference/endpoint/reddit-subreddit): Accepts `subreddit`. Returns a subreddit's info and a page of its posts. * [Reddit other discussions](/api-reference/endpoint/reddit-discussions): Accepts `postUrl`. Returns where else on Reddit one link was shared, equivalent to Reddit's Other discussions. ## OpenAPI ````yaml api-reference/openapi.json POST /v1/reddit/user openapi: 3.1.0 info: title: Stophy API version: '1' description: >- Every endpoint is a POST that takes its input as a JSON object body. Unknown fields are rejected with 400. Responses leave out empty values: null, empty strings, empty objects and empty nested lists are not sent. x-credits is what one call costs. Every call costs the same, whatever it returns, unless an operation's description says it costs per 10 results, or per second of audio. Then x-credits is the lowest price and x-credits-max the most one call can cost. Where an operation takes limit, send it to return fewer results and pay for fewer. When a response has a cursor, send it back unchanged with the same input to get the next page. When it has a page, send the next page number. servers: - url: https://api.stophy.dev security: - apiKey: [] paths: /v1/reddit/user: post: summary: Get a user's profile and a page of their posts and comments description: Costs 1 credit per call. Pages with cursor. operationId: redditUser requestBody: required: true content: application/json: schema: type: object properties: userUrl: type: string description: >- Link to the Reddit user, like https://www.reddit.com/user/spez. Send this or username. username: type: string description: Reddit user username, like spez. Send this or userUrl. tab: default: overview type: string enum: - overview - posts - comments sort: default: newest description: Reddit's own sort. type: string enum: - newest - hot - top - controversial time: description: Reddit's own time filter. Leave out for Reddit's default. type: string enum: - pastHour - today - pastWeek - pastMonth - pastYear - allTime cursor: type: string minLength: 1 description: The cursor from the previous response. Send it as is. sendOne: - userUrl - username additionalProperties: false example: username: spez responses: '200': description: The data, and the credits this call used. headers: X-Request-ID: $ref: '#/components/headers/RequestId' x-credits-used: $ref: '#/components/headers/CreditsUsed' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' x-cache: $ref: '#/components/headers/Cache' x-cache-age: $ref: '#/components/headers/CacheAge' content: application/json: schema: type: object required: - success - data - creditsUsed - requestId properties: success: const: true data: type: object additionalProperties: false properties: userId: type: string username: type: string userUrl: type: string format: uri postKarma: type: integer minimum: -9007199254740991 maximum: 9007199254740991 commentKarma: type: integer minimum: -9007199254740991 maximum: 9007199254740991 createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ avatarUrl: type: string format: uri isVerified: type: boolean results: type: array items: oneOf: - type: object additionalProperties: false properties: type: type: string const: post postId: type: string postUrl: type: string format: uri title: type: string text: type: string authorId: type: string authorUsername: type: string authorUrl: type: string format: uri subreddit: type: string score: type: integer minimum: -9007199254740991 maximum: 9007199254740991 upvotePercent: type: number minimum: 0 maximum: 100 comments: type: integer minimum: -9007199254740991 maximum: 9007199254740991 publishedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ flair: type: string linkUrl: type: string format: uri thumbnailUrl: type: string format: uri isNsfw: type: boolean isVideo: type: boolean isPinned: type: boolean imageUrls: type: array items: type: string format: uri videoUrl: type: string format: uri videoHlsUrl: type: string format: uri videoDurationSeconds: type: number pollOptions: type: array items: type: object additionalProperties: false properties: text: type: string votes: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: [] pollTotalVotes: type: integer minimum: -9007199254740991 maximum: 9007199254740991 pollEndsAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ repostOfUrl: type: string format: uri required: - type - postUrl - score - comments - isNsfw - isVideo - isPinned - type: object additionalProperties: false properties: type: type: string const: comment commentId: type: string commentUrl: type: string format: uri text: type: string score: type: integer minimum: -9007199254740991 maximum: 9007199254740991 publishedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ subreddit: type: string postId: type: string postTitle: type: string required: - type - commentUrl - score cursor: type: string required: - results creditsUsed: type: integer requestId: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' components: headers: RequestId: description: The request id. Quote it when you report a problem. schema: type: string CreditsUsed: description: Credits this call used. schema: type: integer RateLimitLimit: description: Requests allowed in the current window. schema: type: integer RateLimitRemaining: description: Requests left in the current window. schema: type: integer RateLimitReset: description: Unix time in seconds when the current window resets. schema: type: integer Cache: description: hit if this result came from the cache, miss if it was fetched live. schema: type: string CacheAge: description: Seconds since the returned result was written to the cache. schema: type: integer RetryAfter: description: Seconds to wait before retrying. schema: type: integer responses: Error: description: The request failed. retryable says whether trying again can help. headers: X-Request-ID: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object required: - success - error properties: success: const: false error: type: object required: - code - message - retryable - requestId properties: code: type: string enum: - cliSessionCompleted - cliSessionExists - cliSessionNotFound - forbidden - insufficientCredits - internalError - inviteClaimed - inviteDisabled - inviteExpired - inviteUsedUp - invalidCliSession - invalidCliVerifier - invalidRequest - notFound - rateLimited - sourceChanged - sourceRefused - sourceTimeout - sourceUnavailable - tooManyInFlight - unauthorized - unsupportedMediaType message: type: string retryable: type: boolean retryAfterSeconds: type: integer requestId: type: string requiredCredits: type: number availableCredits: type: number billingUrl: type: string const: https://stophy.dev/billing securitySchemes: apiKey: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.