# List Subreddits by Query — Reddit

> List subreddits based on a search criteria. See the docs here

- Key: `reddit-list-subreddits-by-query`
- Type: Action (Read-only)
- Version: 0.1.4
- App: Reddit (`reddit`) — https://pipedream.com/apps/reddit.md
- This page (HTML): https://pipedream.com/apps/reddit/actions/list-subreddits-by-query
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/reddit/actions/list-subreddits-by-query/list-subreddits-by-query.mjs

## Description

List subreddits based on a search criteria. [See the docs here](https://www.reddit.com/dev/api/#GET_subreddits_search)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `subreddit` | `string` | Yes | Type to search for a subreddit or enter a custom expression to search subreddits by title. Options are loaded from the connected account. |
| `limit` | `integer` | No | Default to 25. The maximum number of items desired |
| `before` | `string` | No | Only one of after and before should be specified. These indicate the fullname of an item in the listing to use as the anchor point of the slice. |
| `after` | `string` | No | Only one of after and before should be specified. These indicate the fullname of an item in the listing to use as the anchor point of the slice. |
| `count` | `integer` | No | The number of items already seen in this listing. On the html site, the builder uses this to determine when to give values for before and after in the response. |
| `sort` | `string` | No | One of: relevance, activity |
| `srDetails` | `boolean` | No | If set to true, subreddit details will be expanded/included. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "reddit",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "reddit-list-subreddits-by-query",
  arguments: {
    subreddit: "Subreddit",
    limit: 10,
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "reddit-list-subreddits-by-query",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    reddit: { authProvisionId: "apn_xxxxxxx" },
    subreddit: "Subreddit",
    limit: 10,
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "reddit-list-subreddits-by-query",
    "configured_props": {
      "reddit": { "authProvisionId": "apn_xxxxxxx" },
      "subreddit": "Subreddit",
      "limit": 10
    }
  }'
```

---

- App: https://pipedream.com/apps/reddit.md · All apps: https://pipedream.com/apps