Reddit

Subreddit post search

Posts in one subreddit that match a search.

GET/v1/reddit/subreddits/search1 credit
x-api-key*stringrequiredheader

Your API key, made in the dashboard.

Parameters

6
q*stringrequiredquery

What to search for.

min 1 chars · max 200 chars · example: push ups

subredditstringoptionalquery

A subreddit's name, without r/. Give subreddit or url.

example: Fitness

urlstringoptionalquery

A subreddit's link: reddit.com/r/<name>, with anything after it. Give subreddit or url.

max 300 chars

sortenumoptionalquery

The order: relevance, hot, top, new, or comments (most commented first).

one of: relevance, hot, top, new, comments · default: relevance

timeenumoptionalquery

With sort relevance, top or comments: how far back to search.

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

cursorstringoptionalquery

For the next page: page.next_cursor from the page before. Send the other parameters again with it.

Response fields

23
dataarray

The result: one object, or a list for the endpoints that return several.

data[].idstring

The post's id, with Reddit's t3_ prefix.

data[].urlstring

The post's link.

data[].titlestringnullable

Its title.

data[].textstringnullable

Its own text, for a text post.

data[].authorstringnullable

Its author's username, without u/.

data[].subredditstringnullable

The subreddit it is in, without r/.

data[].scoreintegernullable

Upvotes minus downvotes.

data[].comment_countintegernullable

How many comments it has.

data[].upvote_rationumbernullable

The share of its votes that are upvotes, from 0 to 1.

data[].post_typestringnullable

Reddit's name for the kind of post, such as "text", "link" or "multi_media".

data[].created_atstringnullable

When it was posted.

format: date-time

pageobjectnullable

Paging, for the endpoints that page; null for the others.

page.next_cursorstringnullable

Send it as the cursor parameter, with the same other parameters, for the next page. Null on the last page.

page.has_morebooleanoptional

Whether another page follows.

default: false

metaobject

About this call.

meta.platformstring

The platform: reddit, threads, tiktok or youtube.

meta.endpointstring

The endpoint's name, such as channel_videos.

meta.paramsobject

The call's parameters, defaults included. Parameters without a value, and the cursor, are left out.

meta.request_idstring

This call's id. Quote it when you report a problem.

meta.api_versionstring

The API version that answered.

meta.fetched_atstring

When the data was fetched from the platform (UTC).

format: date-time

meta.cachedbooleanoptional

Whether it came from our cache; fetched_at says how old it is.

default: false

Code example

curl -X GET 'https://api.socialparse.dev/v1/reddit/subreddits/search?q=push+ups&subreddit=Fitness' \  -H 'x-api-key: YOUR_API_KEY'

Responses

Successful Response

{  "data": [    {      "id": "string",      "url": "string",      "title": "string",      "text": "string",      "author": "string",      "subreddit": "string",      "score": 0,      "comment_count": 0,      "upvote_ratio": 0,      "post_type": "string",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "page": {    "next_cursor": "string",    "has_more": false  },  "meta": {    "platform": "string",    "endpoint": "string",    "params": {      "property1": "string",      "property2": "string"    },    "request_id": "string",    "api_version": "string",    "fetched_at": "2019-08-24T14:15:22Z",    "cached": false  }}