Social Fetch
Reddit

Search Reddit posts

Search for posts on Reddit.

Operation

GET/v1/reddit/search
Cost: 1 credit

Headers

x-api-keystringrequired(header)

API key (`sfk_...`)

Parameters

querystringrequired(query)

Search query text for public Reddit posts.

min 1 chars · max 512 chars

sortBystring(query)

Optional sort order for search results.

one of: relevance, new, top

timeframestring(query)

Optional time range filter for search results.

one of: all, day, week, month, year

cursorstring(query)

Opaque pagination cursor returned by a previous response.

min 1 chars

trimboolean(query)

Whether to request a smaller response shape when available.

Response fields

data
objectrequired

Endpoint-specific response payload.

dataquery
stringrequired

Search query string evaluated for this response.

dataposts
arrayrequired

Posts returned for this page.

dataposts[]id
stringrequired

Stable post identifier.

min 1 chars

dataposts[]name
stringrequirednullable

Full post name when available.

dataposts[]title
stringrequirednullable

Post title when available.

dataposts[]author
stringrequirednullable

Author username when available.

dataposts[]subreddit
stringrequirednullable

Subreddit name without a leading r/ when available.

dataposts[]subredditPrefixedName
stringrequirednullable

Prefixed subreddit label such as r/example when available.

dataposts[]url
stringrequirednullable

Canonical public post URL when available.

dataposts[]permalink
stringrequirednullable

Public permalink URL when available.

dataposts[]bodyText
stringrequirednullable

Post body text when available.

dataposts[]score
integerrequirednullable

Post score when available.

≥ 0

dataposts[]upvotes
integerrequirednullable

Upvote count when available.

≥ 0

dataposts[]upvoteRatio
numberrequirednullable

Upvote ratio between 0 and 1 when available.

≥ 0 · ≤ 1

dataposts[]commentCount
integerrequirednullable

Comment count when available.

≥ 0

dataposts[]createdAt
stringrequirednullable

ISO-8601 creation timestamp when available.

dataposts[]isVideo
booleanrequired

Whether the post is a video post.

dataposts[]subredditSubscriberCount
integernullable

Subreddit subscriber count when available.

≥ 0

datatotalResults
integerrequired

Number of posts returned in this response.

≥ 0

datapage
objectrequired

Pagination information for the current response.

datapagenextCursor
stringrequirednullable

Cursor to pass in the next request when another page exists.

datapagehasMore
booleanrequired

Whether another page of results is available.

meta
objectrequired

Metadata describing the request and billing outcome.

metarequestId
stringrequired

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integerrequired

Credits charged for this request.

≥ 0

metaversion
stringrequired

Public API version that served the response.

one of: v1

Code example

Responses

Search results for the requested query.

Error codes

bad_requestinsufficient_creditsinternal_errorlookup_failedtemporarily_unavailableunauthorized

On this page