---
title: "Groups"
description: "Reddit 커뮤니티를 검색하거나, 커뮤니티 이름을 자동완성하거나, 사용자가 활동하는 커뮤니티를 나열합니다."
---

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

파라미터는 `GET`의 쿼리 문자열로도, `POST`의 JSON 본문으로도 보낼 수 있습니다. 둘은 같습니다.

## 넘길 값

| 넘기는 값 | 읽는 것 | 비고 |
|---|---|---|
| `query` | 커뮤니티 검색 |  |
| `prefix` | 이름 자동완성: 이름이 이것으로 시작하는 커뮤니티 | `includeNsfw`; 한 페이지 |
| `username` | 사용자가 활동하는 커뮤니티 |  |

호출마다 소스는 하나만 넘기세요. 모든 식별자는 페이지 URL도 받습니다.

## 파라미터

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

## 요청

```bash tab="cURL"
curl "https://gateway.apinoa.com/v1/reddit/groups?query=photography&limit=3" \
  -H "x-api-key: $APINOA_API_KEY"
```

```js tab="JavaScript"
const params = new URLSearchParams({ query: "photography", limit: "3" });
const res = await fetch(`https://gateway.apinoa.com/v1/reddit/groups?${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/groups",
    params={"query": "photography", "limit": "3"},
    headers={"x-api-key": os.environ["APINOA_API_KEY"]},
)
body = res.json()
```

## 응답

`data`에 [`Group`](/docs/api-reference/sns/response-schema#group) [`Page`](/docs/api-reference/sns/response-schema#page)를 돌려줍니다. 실제 응답을 줄인 것입니다. 배열은 앞쪽 항목만 남기고 긴 텍스트는 잘랐습니다.

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

## 에러

| 상태 | 코드 | 의미 |
|---|---|---|
| 400 | `INVALID_CURSOR` | 이 오퍼레이션이 돌려준 `cursor`가 아닙니다. `cursor` 없이 처음부터 다시 호출하세요. |
| 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. [List price](https://apinoa.com/en/pricing); the rate steps down above 1,000 calls a day.