Skip to main content
POST
Search Reddit posts, subreddits and users
Searches Reddit posts, subreddits and users.

Request

query is required.
This endpoint can be called without an API key, subject to per-address limits. Pagination requires a key.

Response

If successful, the response body contains the standard envelope. data.results[] contains posts, subreddits or users, depending on type. The following example is a real response, truncated: each list shows one item and long strings are cut.
For every field, see the response schema on this page.

Optional parameters

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.
  • Reddit post: Accepts postUrl. Returns a post and its comment thread, with a cursor for the rest of the comments.
  • Reddit subreddit: Accepts subreddit. Returns a subreddit’s info and a page of its posts.
  • Reddit user: Accepts userUrl. Returns a user’s profile and a page of their posts and comments.
  • Reddit other discussions: Accepts postUrl. Returns where else on Reddit one link was shared, equivalent to Reddit’s Other discussions.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
query
string
required

Words to find. With any sort other than relevance, a query of several words matches that exact phrase; use sort relevance to match the words anywhere in a post. Quotes, AND, OR, NOT, title:, selftext:, author:, subreddit: and site: are used as typed.

Required string length: 1 - 512
type
enum<string>
default:posts
Available options:
posts,
subreddits,
users
subreddit
string
sort
enum<string>
default:relevance

relevance matches the words anywhere in a post. hot, top, newest and mostComments match the exact phrase, so a query of several words only returns posts containing that phrase.

Available options:
relevance,
hot,
top,
newest,
mostComments
time
enum<string>

Reddit's own time filter. Leave out for Reddit's default.

Available options:
pastHour,
today,
pastWeek,
pastMonth,
pastYear,
allTime
cursor
string

The cursor from the previous response. Send it as is.

Minimum string length: 1

Response

The data, and the credits this call used.

success
any
required
data
object
required
creditsUsed
integer
required
requestId
string
required