> ## 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 post API > Read a post and its comment thread, with a cursor for the rest of the comments. Call the Reddit post API for JSON. 1 credit per call. Returns a post and its comment thread, with a cursor for the rest of the comments. The post is identified by its URL or ID. ## Request Exactly one of `postUrl` or `postId` 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.post({ postUrl: "https://www.reddit.com/r/programming/comments/1abc2de/example_post/" }); console.log(result.data.results); ``` ```python Python icon="python" theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.reddit.post(post_url="https://www.reddit.com/r/programming/comments/1abc2de/example_post/") print(result["data"]["results"]) ``` ```bash cURL icon="terminal" theme={null} curl -X POST https://api.stophy.dev/v1/reddit/post \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"postUrl":"https://www.reddit.com/r/programming/comments/1abc2de/example_post/"}' ``` ```bash CLI icon="square-terminal" theme={null} stophy reddit post --postUrl https://www.reddit.com/r/programming/comments/1abc2de/example_post/ ``` ## Response If successful, the response body contains the standard envelope. `data` contains the post, and `results` lists its 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": { "postId": "1wxj3er", "postUrl": "https://www.reddit.com/r/AskReddit/comments/1wxj3er/men_whats_one_small_seemingly_insignificant_thing/", "title": "Men, what’s one small, seemingly insignificant thing you’ve noticed that can be a telltale sign of the difference…", "authorId": "ojjf3gg0x", "authorUsername": "AuthorConfident9386", "authorUrl": "https://www.reddit.com/user/AuthorConfident9386/", "subreddit": "AskReddit", "score": 5312, "upvotePercent": 89, "comments": 2349, "publishedAt": "2026-10-04T15:56:50.000Z", "isNsfw": false, "isVideo": false, "isPinned": false, "results": [ { "commentId": "pdu7cxe", "commentUrl": "https://www.reddit.com/r/AskReddit/comments/1wxj3er/men_whats_one_small_seemingly_insignificant_thing/pdu7cxe/", "authorId": "aug9d", "authorUsername": "s0ulfire", "authorUrl": "https://www.reddit.com/user/s0ulfire/", "text": "Ability to admit one’s mistake ", "score": 5756, "publishedAt": "2026-10-04T16:47:49.000Z", "depth": 0, "isSubmitter": false, "isPinned": false } ], "cursor": "8f1d680b-d686-4b78-a88e-7334dcfa10d1" }, "creditsUsed": 1, "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b" } ``` | Field | Type | Description | | - | - | - | | `cursor` | string | Pass it as `cursor` to retrieve the rest of the comments. | | `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. | | `depth` | integer | The nesting level of the comment in the thread. Top-level comments are 0. | | `isSubmitter` | boolean | `true` if the commenter is the author of the post. | For every field, see the response schema on this page. ## Optional parameters | Parameter | Type | Description | | - | - | - | | `comment` | string | A comment id or link. Returns that comment's thread. | | `sort` | string | Specifies the order of the comments. Acceptable values are `best`, `top`, `newest`, `controversial`, `old` and `qa`. If unset, defaults to `best`. | | `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 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. * [Reddit user](/api-reference/endpoint/reddit-user): Accepts `userUrl`. Returns a user's profile and a page of their posts and comments. ## OpenAPI ````yaml api-reference/openapi.json POST /v1/reddit/post 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/post: post: summary: >- Read a post and its comment thread, with a cursor for the rest of the comments description: Costs 1 credit per call. Pages with cursor. operationId: redditPost requestBody: required: true content: application/json: schema: type: object properties: postUrl: type: string description: >- Link to the Reddit post, like https://www.reddit.com/r/programming/comments/1abc2de/example_post/. Send this or postId. postId: type: string description: Reddit post id, like 1abc2de. Send this or postUrl. comment: description: >- A comment id or link: returns that comment's thread, like Reddit's own link. type: string sort: default: best description: Reddit's own comment sort. type: string enum: - best - top - newest - controversial - old - qa cursor: type: string minLength: 1 description: The cursor from the previous response. Send it as is. sendOne: - postUrl - postId additionalProperties: false 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: 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 results: type: array items: type: object additionalProperties: false properties: commentId: type: string commentUrl: type: string format: uri parentId: type: string authorId: type: string authorUsername: type: string authorUrl: 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))$ depth: type: integer minimum: -9007199254740991 maximum: 9007199254740991 isSubmitter: type: boolean isPinned: type: boolean required: - commentUrl - score - depth - isSubmitter - isPinned cursor: description: Loads the comments Reddit folded away. 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.