API reference
Forum Search API
Fused forum search across Reddit and Hacker News, merged into one tagged result list. Naver is listed in sources_unavailable pending a keyed official API.
Endpoint
/v1/search/forumslive · proven10 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
query | yes | Search phrase | rust async runtime |
sources | no | Comma list restricting which forums are searched | reddit,hackernews |
exclude | no | Comma list of forums to skip | hackernews |
comments | no | Reserved — inline comments are not supported yet | top |
timeframe | no | hour | day | week | month | year | all | week |
lookback_days | no | Only results from the last N days, where the source supports it | 30 |
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 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/search/forums?query=rust%20async%20runtime" \ -H "x-api-key: mn_your_key_here"
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/search/forums?query=rust%20async%20runtime",
{ 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
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/search/forums?query=rust%20async%20runtime",
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.
{
"success": true,
"platform": "search",
"endpoint": "/v1/search/forums",
"data": {
"_warnings": [
"example"
],
"count": 0,
"items": [
{
"author": "example",
"comments_count": 0,
"created_at": "2026-09-01T12:00:00Z",
"hn_url": "https://example.com/example",
"id": "example",
"points": 0,
"source": "example",
"story_id": "example",
"text": "example",
"title": "example",
"type": "example",
"url": "https://example.com/example"
}
],
"query": "example",
"sources": [
{
"count": 0,
"error": "example",
"ok": false,
"served_by": "example",
"source": "example"
}
],
"sources_unavailable": [
"example"
]
},
"credits_used": 10,
"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. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[].author | string | null | Public author information supplied with this record. |
items[].comments_count | number | null | Optional comments count supplied by this operation. Null means unknown. |
items[].created_at | string | null | Source creation time, not the API retrieval time. |
items[].hn_url | string | null | Optional hn url supplied by this operation. Null means unknown. |
items[].id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].points | number | null | Optional points supplied by this operation. Null means unknown. |
items[].source | string | null | Optional source supplied by this operation. Null means unknown. |
items[].story_id | string | null | Optional story id supplied by this operation. Null means unknown. |
items[].text | string | null | Source text when supplied. |
items[].title | string | null | Source title when supplied. |
items[].type | string | null | Optional type supplied by this operation. Null means unknown. |
items[].url | string | null | Original source URL when supplied. |
query | string | null | Optional query supplied by this operation. Null means unknown. |
sources | array | null | Optional sources supplied by this operation. Null means unknown. |
sources[].count | number | null | Number of records in this response, not lifetime or total matches. |
sources[].error | string | null | Optional error supplied by this operation. Null means unknown. |
sources[].ok | boolean | null | Optional ok supplied by this operation. Null means unknown. |
sources[].served_by | string | null | Optional served by supplied by this operation. Null means unknown. |
sources[].source | string | null | Optional source supplied by this operation. Null means unknown. |
sources_unavailable | array | null | Optional sources unavailable 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