reddit · subreddit
List posts in a public subreddit. GET /v1/reddit/subreddit accepts your x-api-key header. Costs 1 credit per successful fresh call; failures and opt-in cache hits (cache_max_age) are free. Native path: GET /api/v1/web/reddit/subreddit. Same request parameters and JSON shape as the reference API, so you can switch by changing the base URL.
Request parameters
Public subreddit feed (Reddit RSS): newest/hot/top posts with title, author, permalink, link, self-text and thumbnail. Score and comment counts are not published in the feed (null). ~25 per page; paginate with after.
| Parameter | Type | Required | Description |
|---|---|---|---|
subreddit | string | Yes | Subreddit name without r/ (URL accepted). |
sort | string | No | hot (default), new, top, rising or controversial. Allowed: hot, new, top, rising, controversial. |
timeframe | string | No | For top/controversial: hour, day, week, month, year, all. Allowed: hour, day, week, month, year, all. |
after | string | No | Cursor from a previous page (the "after" value). |
trim | boolean | No | Drop selftext_html to shrink the response. |
freshness | string | No | 24h (default), 1h, 7d, or live. Accepted cache hits are free; live forces refresh except simultaneous requests may share newly fetched data. |
Code examples
Set SIGNALSHELF_BASE_URL and SIGNALSHELF_API_KEY on your server.
curl "$SIGNALSHELF_BASE_URL/v1/reddit/subreddit?subreddit=technology" \
-H "x-api-key: $SIGNALSHELF_API_KEY"const response = await fetch(process.env.SIGNALSHELF_BASE_URL + "/v1/reddit/subreddit?subreddit=technology", {
headers: { 'x-api-key': process.env.SIGNALSHELF_API_KEY },
});
const body = await response.json();
if (!response.ok) throw new Error(body.error.message);
console.log(body.data, body.meta);import os, requests
response = requests.get(
os.environ['SIGNALSHELF_BASE_URL'] + "/v1/reddit/subreddit?subreddit=technology",
headers={'x-api-key': os.environ['SIGNALSHELF_API_KEY']},
timeout=30,
)
response.raise_for_status()
print(response.json())Response and pagination
The response contains data and meta. data includes platform, resource, sample:false, provider, and the public source payload. Lists return data.items; individual resources return data.data.
Author feeds include data.next_cursor. Return it unchanged in cursor for the next page. Feed entries can include reposts. Single-post lookups resolve the handle to a DID first. Deleted or moderated posts may be unavailable.
meta includes event_id, mode, cache, credits_charged, fetched_at, age_seconds, and duration_ms. A fresh successful result costs one credit; accepted cached results and failures cost zero.
Availability and failures
Implementation is not a continuous availability guarantee. Source rate limits, retention, deleted content, restrictions, and regional availability apply. This is an independent SignalShelf contract, not a drop-in competitor response format.
400: invalid parameters. 401: missing/revoked key. 402: insufficient credits. 404: missing public resource. 429: SignalShelf throttle. 502/503: upstream failure or rate limit, with credit restored.