Listings & Search

Deep Comment Search

Genuine comment search. Takes the parent posts from comment search, fetches each post's comment tree, and returns the ACTUAL comments whose body matches your query, with body, score, author, a comment-deep permalink, and the parent post. Premium: one comment-search read plus up to limit comment-tree reads. Best-effort: a deleted or deep-tree comment may be missed (meta.truncated flags a depth-limited tree). Cost: $0.02 per call.

get/api/reddit/search/comments/deep

Request

  • Base URL: https://api.redditapis.com
  • URL: https://api.redditapis.com/api/reddit/search/comments/deep
  • Auth: HTTP bearer

Query parameters

qstring required

Search query

sortstring

relevance | new | top | comments

tstring

hour | day | week | month | year | all

limitstring

Number of parent POSTS to expand, 1-25 (default 5). Each is one comment-tree fetch.

max_commentsstring

Optional cap on comments returned (highest-scored kept). meta.capped flags a trim.

nsfwboolean

true = include NSFW results (Safe Search off)

afterstring

Pagination cursor. Pass back the after value from the previous response exactly as it was sent; it is opaque and carries your paging depth. When after comes back null there is no next page to request, but that does not always mean you have every item: Reddit often stops serving a busy listing long before it runs out, and it also caps any single listing at roughly 1000 items. The response says which happened in listing_status (complete, truncated, or unknown). Only complete means you have everything.

group_bystring

Set to 'author' for the research mode: return the distinct PEOPLE who mentioned the query (ranked by matching-comment count) instead of a flat comment list.

max_authorsstring

Only with group_by=author. Optional cap on people returned (most prolific first). meta.authors_capped flags a trim.

Response

Successful response.

commentsobject[]
authorsobject[]
metaobject
afterstring nullable

Opaque pagination cursor; null when no next page is offered.

exhausted_reasonstring nullable

Present only when after is null: why the listing stopped.

listing_statusstring nullable

complete | truncated | unknown. Only complete means you have every item.

items_returnedinteger nullable

Running item count across the pages walked so far.

final_page_itemsinteger nullable

Items on the last page served.

hintstring nullable

Human-readable next step for this exhausted_reason.

Changes

No recorded changes to this operation across all 1 revision of this API.