Group
Get a Reddit community.
GET | POST /v1/reddit/groupSend parameters as a query string with GET, or as a JSON body with POST. Both are equivalent.
What to Pass
| Pass | Reads | Notes |
|---|---|---|
community | The community | include=rules,style adds its rules and style under ext (+1 unit each) |
Pass one source per call. Every identifier also takes the page URL.
Parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
community | string | Community name (with or without r/) or URL. | |
include | string list | Extra reads to attach under ext: rules (+1 unit). The community's style is always in ext.style (it comes with the community), so style is accepted and free. |
Request
curl "https://gateway.apinoa.com/v1/reddit/group?community=technology&include=rules" \
-H "x-api-key: $APINOA_API_KEY"Response
Returns Group in data. A real response, shortened: arrays keep their first entries and long text is cut.
{
"success": true,
"data": {
"platform": "reddit",
"kind": "community",
"id": "2qh16",
"name": "technology",
"url": "https://www.reddit.com/r/technology/",
"description": "Subreddit dedicated to the news and discussions about the creation and use of technology and its surrounding issues.",
"avatarUrl": "https://b.thumbs.redditmedia.com/J_fCwTYJkoM-way-eaOHv8AOHoF_jNXNqOvPrQ7bINY.png",
"createdAt": "2008-01-25T03:27:55.000Z",
"counts": {
"members": 20595712
},
"sensitive": false,
"ext": {
"fullname": "t5_2qh16",
"title": "/r/Technology ",
"sidebar": "/r/Technology is a place to share and discuss the latest developments, happenings and curiosities in the world of techn…",
"type": "public",
"language": "en",
"submissionType": "link",
"advertiserCategory": "Local",
"submitText": "* Submissions must be primarily news and developments relating to technology. Do not submit content older than 2 weeks.…",
"settings": {
"allowImages": false,
"allowVideos": false,
"allowVideoGifs": false,
"allowPolls": false,
"allowGalleries": false,
"spoilersEnabled": false,
"allowDiscovery": true,
"restrictPosting": true,
"restrictCommenting": false,
"allOriginalContent": false,
"linkFlairEnabled": true,
"userFlairEnabled": true,
"crosspostable": false,
"archivePosts": true,
"commentScoreHideMins": 0,
"wikiEnabled": true
},
"style": {
"keyColor": "#0dd3bb",
"iconUrl": "https://b.thumbs.redditmedia.com/J_fCwTYJkoM-way-eaOHv8AOHoF_jNXNqOvPrQ7bINY.png",
"headerImageUrl": "https://a.thumbs.redditmedia.com/VwBugImhQhFTJhC0HjM9IWyEEEF898HHtI2AunD5SW4.png",
"headerTitle": "r/Technology"
},
"rules": {
"platform": "reddit",
"community": "technology",
"rules": [
{
"priority": 0,
"shortName": "Submissions must be about technology",
"description": "Submissions must be primarily news and developments relating to technology.\n\n[Self posts](https://www.reddit.com/r/tech…",
"appliesTo": "posts",
"violationReason": "Not related to technology",
"createdAt": "2022-05-19T15:51:02.000Z"
}
],
"siteRules": [
"Spam",
"Personal and confidential information"
]
}
}
}
}Errors
| Status | Code | Meaning |
|---|---|---|
| 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, plus $0.001 for each extra call it makes — at most 1 more, so $0.002 in total. List price; the rate steps down above 1,000 calls a day.