> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Reddit subreddits

> Read the Reddit list of popular subreddits as JSON with the reddit-subreddits parser. $1 per 1,000 calls. Send the page to scrape.

Reads the Reddit list of popular subreddits, reddit.com/subreddits, and returns a list of profiles as JSON.

## Make a request

Send the page's URL to [scrape](https://docs.stophy.dev/api-reference/endpoint/scrape.md) with a `json` format that names the parser. Get an API key in the [Quickstart](https://docs.stophy.dev/quickstart).

```bash cURL theme={null}
curl -X POST https://api.stophy.dev/v1/scrape \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.reddit.com/subreddits/","formats":[{"type":"json","parser":"reddit-subreddits"}]}'
```

```typescript TypeScript theme={null}
const response = await fetch("https://api.stophy.dev/v1/scrape", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.STOPHY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    url: "https://www.reddit.com/subreddits/",
    formats: [{ type: "json", parser: "reddit-subreddits" }],
  }),
});
console.log(await response.json());
```

```python Python theme={null}
import os

import requests

response = requests.post(
    "https://api.stophy.dev/v1/scrape",
    headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
    json={
        "url": "https://www.reddit.com/subreddits/",
        "formats": [{"type": "json", "parser": "reddit-subreddits"}],
    },
)
print(response.json())
```

## Read the response

The parser's data is in `data.json`. Its fields include `results`, `cursor`, `page` and `total`. This sample is cut to the first items.

```json theme={null}
{
  "success": true,
  "data": {
    "json": {
      "results": [
        {
          "id": "0",
          "url": "https://example.com/example_user",
          "handle": "example_user",
          "name": "Example user",
          "bio": null,
          "avatarUrl": null,
          "isVerified": null,
          "followers": 2934223,
          "following": null,
          "posts": null,
          "website": null,
          "location": null,
          "category": null,
          "createdAt": "2009-07-26T18:12:48.273Z",
          "isNsfw": false
        }
      ],
      "cursor": "seen_a48c4e57-63d0-431a-b5b2-293480ee6320",
      "page": null,
      "total": null
    }
  }
}
```

## Options

Send options in the `options` object of the `json` format.

| Option | What it does |
| - | - |
| `cursor` | The cursor from the previous response. Send it as is. |

## Price

\$1 per 1,000 calls. See [Pricing](https://docs.stophy.dev/account/pricing.md).

## Limits and errors

* The URL must be the Reddit list of popular subreddits, reddit.com/subreddits. Any other URL fails with `invalidRequest`.
* To read the next page, send the `cursor` from the response as the `cursor` option. Paging needs an API key.
* The answer comes back in `data.json`. If the page cannot be read, the call fails with an error code from [Errors](https://docs.stophy.dev/api-reference/errors.md).

## Related

* [Pre-built parsers](https://docs.stophy.dev/scrape/prebuilt-parsers) lists every parser.
* [Scrape](https://docs.stophy.dev/scrape/overview) has the options every scrape takes.
* [Reddit search](https://docs.stophy.dev/scrape/prebuilt-parsers/social/reddit-search.md)
* [Reddit post](https://docs.stophy.dev/scrape/prebuilt-parsers/social/reddit-post.md)
* [Reddit subreddit](https://docs.stophy.dev/scrape/prebuilt-parsers/social/reddit-subreddit.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.