API reference
Reddit Search API
Search posts across all of Reddit by keyword, with sort and time filters.
Endpoint
GET/v1/reddit/searchlive · proven1 creditParameters
Query parameters
Useful optional inputs
timeframe— Choose the source time window relevant to your task.A narrower window is not a completeness guarantee or a price reduction.
sort— Choose the documented source ordering before paging through results.Ordering keeps the normal endpoint price and does not guarantee exhaustive results.
dry_run— Read a free estimate before fetching sources or scheduling paid work.Zero credits; cache status and availability are snapshots rather than guarantees.
| Name | Required | Description | Example |
|---|---|---|---|
query | yes | Keyword or phrase to search for | customer feedback |
sort | no | relevance, hot, top, new or comments (default relevance) Accepted values: relevance, hot, top, new, comments. Case, spaces, hyphens and underscores are interchangeable. | relevance |
timeframe | no | hour, day, week, month, year or all Accepted values: hour, day, week, month, year, all. Case, spaces, hyphens and underscores are interchangeable. | month |
after | no | Reddit fullname to continue after (alias of cursor) | t3_1abcd2 |
cursor | no | Opaque cursor from the previous page | t3_1abcd2 |
limit | no | Results per page, 1-100 (default 25) | 25 |
include_body | no | Include supplied selftext and HTML bodies (default true). Set false to omit them; trim=true also omits bodies. No additional supplier call. | true |
trim | no | true to force selftext bodies off | false |
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. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. | 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. Accepted values: on, off. Case, spaces, hyphens and underscores are interchangeable. | on |
label | no | Set none to disable labels; default enables the endpoint’s label set. Equivalent to judgments=off. Accepted values: default, none. Case, spaces, hyphens and underscores are interchangeable. | 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. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. | 1 |
exclude | no | Optionally remove confidently labelled engagement bait. Uncertain and unclassified records stay; removed IDs and an owner-bound recall reference are returned. Accepted values: engagement_bait. Case, spaces, hyphens and underscores are interchangeable. | 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. Accepted values: goal. Case, spaces, hyphens and underscores are interchangeable. | 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/search?query=customer%20feedback" \ -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/search?query=customer%20feedback",
{ 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/search?query=customer%20feedback",
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/search",
"data": {
"items": [
{
"id": "example1",
"title": "What improved your desk setup?",
"author": "example_reader",
"subreddit": "example_community",
"url": null,
"score": 42,
"comments_count": 18,
"text": null
}
],
"cursor": null,
"has_more": null
},
"credits_used": 1,
"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: reviewed response shaper. 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 |
|---|---|---|
items | array | Records in this response page. |
items[].id | string | null | Source identifier. Preserve its exact string value; do not convert large IDs to numbers. |
items[].url | string | null | Original source URL when supplied. |
items[].title | string | null | Discussion title. |
items[].author | string | null | Reddit username, not an author object. |
items[].subreddit | string | null | Community name. |
items[].text | string | null | Post body when included. |
items[].created_at | string | null | Source publication time, normalized to an ISO date-time when available. |
items[].score | number | null | Net score; can be negative and is not a like count. |
items[].comments_count | number | null | Comments reported by the source; null or absent is unknown, not zero. |
items[].upvote_ratio | number | null | Source upvote ratio on a 0–1 scale. |
count | number | null | Returned row count when supplied; not the full source total. |
cursor | string | null | Opaque next-page token. A missing token does not prove full history was retrieved. |
has_more | boolean | null | Source continuation indicator; null means unknown. |
_warnings | array | Collection limitations or component warnings. Read before interpreting coverage. |
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