---
title: "Group"
description: "获取一个 Reddit 社区。"
---

```http
GET | POST /v1/reddit/group
```

参数可以用 `GET` 的查询字符串发送，也可以用 `POST` 的 JSON 请求体发送，两者等价。

## 传入内容

| 传入 | 读取内容 | 说明 |
|---|---|---|
| `community` | 该社区 | `include=rules,style` 会在 `ext` 下附加其规则和样式（每项 +1 个单位） |

每次调用只传一个来源。所有标识符也都接受页面 URL。

## 参数

| 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. |

## 请求

```bash tab="cURL"
curl "https://gateway.apinoa.com/v1/reddit/group?community=technology&include=rules" \
  -H "x-api-key: $APINOA_API_KEY"
```

```js tab="JavaScript"
const params = new URLSearchParams({ community: "technology", include: "rules" });
const res = await fetch(`https://gateway.apinoa.com/v1/reddit/group?${params}`, {
  headers: { "x-api-key": process.env.APINOA_API_KEY },
});
const { success, data, error } = await res.json();
```

```python tab="Python"
import os

import requests

res = requests.get(
    "https://gateway.apinoa.com/v1/reddit/group",
    params={"community": "technology", "include": "rules"},
    headers={"x-api-key": os.environ["APINOA_API_KEY"]},
)
body = res.json()
```

## 响应

在 `data` 中返回 [`Group`](/docs/api-reference/sns/response-schema#group)。 真实响应的节选：数组只保留前几项，长文本已截断。

```json
{
  "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"
        ]
      }
    }
  }
}
```

## 错误

| 状态 | 代码 | 含义 |
|---|---|---|
| 400 | `INVALID_PARAMS` | 参数缺失、未知或超出范围。消息中会指出是哪一个。 |
| 401 | `UNAUTHORIZED` | 缺少 `x-api-key` 请求头，或密钥已吊销或未知。 |
| 402 | `INSUFFICIENT_BALANCE` | 余额不足以支付本次调用。请在控制台充值。 |
| 404 | `NOT_FOUND` | 账号、帖子或分组不存在，或为私密、已删除、有年龄限制。 |
| 429 | `MARKETPLACE_SATURATED` | 并发调用过多。请等待 `Retry-After` 秒后重试。 |
| 502 | `UPSTREAM_ERROR` | 平台返回了无法使用的内容。请退避后重试。 |

全部错误代码见 [Errors](/docs/errors)。失败的调用不计费。

## 价格

**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](https://apinoa.com/en/pricing); the rate steps down above 1,000 calls a day.