Groups
Search Reddit communities, autocomplete a community name, or list the communities a user is active in.
GET | POST /v1/reddit/groupsSend parameters as a query string with GET, or as a JSON body with POST. Both are equivalent.
What to Pass
| Pass | Reads | Notes |
|---|---|---|
query | A community search | |
prefix | Name autocomplete: communities whose name starts with it | includeNsfw; one page |
username | The communities a user is active in |
Pass one source per call. Every identifier also takes the page URL.
Parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
cursor | string | Opaque cursor from the previous page's cursor. Pass it alone for the next page. | |
includeNsfw | boolean | prefix only: include over-18 communities. | |
limit | integer 1–100 | Items per page, 1–100. | |
prefix | string | Autocomplete: communities whose name starts with this (fast, one page). | |
query | string | Search communities by keyword. | |
username | string | The communities a user is active in: username or profile URL. |
Request
curl "https://gateway.apinoa.com/v1/reddit/groups?query=photography&limit=3" \
-H "x-api-key: $APINOA_API_KEY"Response
Returns Page of Group in data. A real response, shortened: arrays keep their first entries and long text is cut.
{
"success": true,
"data": {
"platform": "reddit",
"items": [
{
"platform": "reddit",
"kind": "community",
"id": "2qh2a",
"name": "photography",
"url": "https://www.reddit.com/r/photography/",
"description": "/r/photography is a place to politely discuss the tools, technique, art and culture of photography and to post topics t…",
"avatarUrl": "https://styles.redditmedia.com/t5_2qh2a/styles/communityIcon_ewee979e9tib1.png?width=256&s=98f37a3e36d9c6c3631fe569571f…",
"bannerUrl": "https://styles.redditmedia.com/t5_2qh2a/styles/bannerBackgroundImage_quu3wdl77tib1.png?width=4000&s=c4b33e56a54192ba98c…",
"createdAt": "2008-01-25T05:32:49.000Z",
"counts": {
"members": 5668327
},
"sensitive": false,
"ext": {
"fullname": "t5_2qh2a",
"title": "Photography",
"sidebar": "/r/photography is a place to politely discuss the tools, technique, art and culture of photography and to post topics t…",
"type": "public",
"language": "en",
"submissionType": "any",
"advertiserCategory": "Lifestyles",
"submitText": "**PLEASE REMEMBER TO FLAIR YOUR POSTS**\n\n* This sub is for discussing photography, not just sharing your work. We have…",
"settings": {
"allowImages": false,
"allowVideos": false,
"allowVideoGifs": false,
"allowPolls": false,
"allowGalleries": false,
"spoilersEnabled": true,
"allowDiscovery": true,
"restrictPosting": true,
"restrictCommenting": false,
"allOriginalContent": false,
"linkFlairEnabled": true,
"userFlairEnabled": false,
"crosspostable": false,
"archivePosts": false,
"commentScoreHideMins": 180,
"suggestedCommentSort": "confidence",
"wikiEnabled": true,
"allowedMediaInComments": [
"giphy",
"static"
]
}
}
}
],
"cursor": "RjvzT7CZ0WloEEGA_XTHSRLU2Ia7PEAPgIHxnz5MuTkxEAed4QiaxwGSMV4GjEyZuFRoNHN7XBfL0ccvbyKMrSdBmcbPTkJZWrF51xxHeqeRbGWY1xuM6tm…"
}
}Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | INVALID_CURSOR | The cursor is not one this operation returned. Start again without it. |
| 400 | INVALID_PARAMS | A parameter is missing, unknown or out of range. The message names it. |
| 401 | UNAUTHORIZED | The x-api-key header is missing, or the key is revoked or unknown. |
| 402 | INSUFFICIENT_BALANCE | The balance does not cover this call. Top up in the dashboard. |
| 404 | NOT_FOUND | The account, post or group does not exist, or is private, deleted or age-restricted. |
| 429 | MARKETPLACE_SATURATED | Too many concurrent calls. Retry after the Retry-After seconds. |
| 502 | UPSTREAM_ERROR | The platform answered with something unusable. Retry with backoff. |
Every code is listed in Errors. Failed calls are not billed.
Pricing
Price $0.001 per call. List price; the rate steps down above 1,000 calls a day.