Reddit API
Reddit omni-search
One keyword swept across Reddit: the matching threads, the top-level comments on each, and the communities they sit in with subscriber and activity figures.
Endpoint
GET/v1/reddit/omni-searchlive · proven5 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
query | yes | Keyword or phrase to sweep across Reddit | notion alternatives |
subreddit | no | Limit the sweep to one subreddit | |
threads | no | Threads to return, 1 to 10 | 5 |
comments_per_thread | no | Top-level comments per thread, 0 to 15 | 5 |
include | no | comments, subreddits, or none | comments,subreddits |
sort | no | relevance, hot, top, new or comments | relevance |
timeframe | no | hour, day, week, month, year or all | year |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
judgments | no | Add bounded AI labels to eligible returned records (default on). off preserves the original data shape. Unclassified records remain present; labels depend on evidence, time, capacity and the existing request budget. No label surcharge. | on |
label | no | Set none to disable labels; default enables the endpoint’s label set. Equivalent to judgments=off. | none |
label_evidence | no | Include exact supporting sentences and zero-based sentence indexes when a label has validated evidence. No extra charge or change to decisions. | 1 |
exclude | no | Optionally remove confidently labelled engagement bait. Uncertain and unclassified records stay; removed IDs and an owner-bound recall reference are returned. | engagement_bait |
fit | no | Use goal to replace confidently irrelevant records with recall stubs. Keeps first, last, relevant and uncertain records; preserves order. Full evidence is stored for 24 hours when available. | goal |
goal | no | Required with fit=goal: describe the task in at most 600 characters. Supplied text is task context, never permission to act on posts. | Find concrete product complaints |
tokens | no | Optional soft response target for fit=goal, 256–32000. Safety and evidence retention take priority, so the returned result may exceed it. | 4000 |
Examples
Make the request
curl
curl "https://www.monocrawl.com/v1/reddit/omni-search?query=notion%20alternatives" \ -H "x-api-key: mn_your_key_here"
TypeScript
typescript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/reddit/omni-search?query=notion%20alternatives",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/reddit/omni-search?query=notion%20alternatives",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
200 · application/json
{
"success": true,
"platform": "reddit",
"endpoint": "/v1/reddit/omni-search",
"data": {
"_warnings": [
"example"
],
"count": 0,
"cursor": null,
"query": "example",
"sort": "example",
"sources": [
{
"cost_micros": 0,
"error": "example",
"funding_reason": "example",
"latency_ms": 0,
"ok": false,
"source": "example"
}
],
"subreddits": [
{
"description": "example",
"name": "example",
"subscribers": 0,
"thread_count": 0,
"title": "example",
"url": "https://example.com/example"
}
],
"threads": [
{
"author": "example",
"author_id": "example",
"comments_count": 0,
"created_at": "2026-09-01T12:00:00Z",
"gallery": [],
"id": "example",
"is_video": false,
"over_18": false,
"score": 0,
"selftext": "example",
"selftext_html": "example",
"spoiler": false,
"subreddit": "example",
"title": "example",
"top_comments": [
{}
],
"url": "https://example.com/example"
}
],
"totals": {
"comments_sampled": 0,
"communities": 0,
"threads": 0
}
},
"credits_used": 5,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
_warnings | array | null | Optional warnings supplied by this operation. Null means unknown. |
count | number | null | Number of records in this response, not lifetime or total matches. |
cursor | string | null | Opaque next-page token; pass it back unchanged. Null does not prove complete history. |
query | string | null | Optional query supplied by this operation. Null means unknown. |
sort | string | null | Optional sort supplied by this operation. Null means unknown. |
sources | array | null | Optional sources supplied by this operation. Null means unknown. |
sources[].cost_micros | number | null | Optional cost micros supplied by this operation. Null means unknown. |
sources[].error | string | null | Optional error supplied by this operation. Null means unknown. |
sources[].funding_reason | string | null | Optional funding reason supplied by this operation. Null means unknown. |
sources[].latency_ms | number | null | Optional latency ms supplied by this operation. Null means unknown. |
sources[].ok | boolean | null | Optional ok supplied by this operation. Null means unknown. |
sources[].source | string | null | Optional source supplied by this operation. Null means unknown. |
subreddits | array | null | Optional subreddits supplied by this operation. Null means unknown. |
subreddits[].description | string | null | Source description; null or absent means not supplied. |
subreddits[].name | string | null | Optional name supplied by this operation. Null means unknown. |
subreddits[].subscribers | number | null | Optional subscribers supplied by this operation. Null means unknown. |
subreddits[].thread_count | number | null | Optional thread count supplied by this operation. Null means unknown. |
subreddits[].title | string | null | Source title when supplied. |
subreddits[].url | string | null | Original source URL when supplied. |
threads | array | null | Optional threads supplied by this operation. Null means unknown. |
threads[].author | string | null | Public author information supplied with this record. |
threads[].author_id | string | null | Optional author id supplied by this operation. Null means unknown. |
threads[].comments_count | number | null | Optional comments count supplied by this operation. Null means unknown. |
threads[].created_at | string | null | Source creation time, not the API retrieval time. |
threads[].gallery | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
threads[].id | string | null | Source identifier. Preserve the supplied type and exact value. |
threads[].is_video | boolean | null | Optional is video supplied by this operation. Null means unknown. |
threads[].over_18 | boolean | null | Optional over 18 supplied by this operation. Null means unknown. |
threads[].score | number | null | Optional score supplied by this operation. Null means unknown. |
threads[].selftext | string | null | Optional selftext supplied by this operation. Null means unknown. |
threads[].selftext_html | string | null | Optional selftext html supplied by this operation. Null means unknown. |
threads[].spoiler | boolean | null | Optional spoiler supplied by this operation. Null means unknown. |
threads[].subreddit | string | null | Optional subreddit supplied by this operation. Null means unknown. |
threads[].title | string | null | Source title when supplied. |
threads[].top_comments | array | null | Optional top comments supplied by this operation. Null means unknown. |
threads[].url | string | null | Original source URL when supplied. |
totals | object | null | Optional totals supplied by this operation. Null means unknown. |
totals.comments_sampled | number | null | Optional comments sampled supplied by this operation. Null means unknown. |
totals.communities | number | null | Optional communities supplied by this operation. Null means unknown. |
totals.threads | number | null | Optional threads supplied by this operation. Null means unknown. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference