# Reddit on Onekey

> 21 endpoints for Reddit (0 stable, 21 beta), 1 to 2 credits each. Category: Social networks. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.
Access: 21 of 21 endpoints are marked "needs a pack" or "may need a pack": free-grant credits reach only the open fetch path; a verified email and a purchased pack unlock the rest.

Page: https://onekey.dev/platforms/reddit
Reference (Markdown): https://onekey.dev/docs/api/reddit.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 21 mapped Reddit endpoints return each:

- `content.createdAt` (ISO 8601 date): 20
- `content.id` (string): 19
- `content.text` (string): 19
- `content.title` (string): 19
- `entity.name` (string): 19
- `author.username` (string): 15
- `engagement.likes` (integer): 15
- `media.thumbnailUrl` (URL): 15
- `engagement.comments` (integer): 12
- `content.url` (URL): 11
- `engagement.upvoteRatio` (number): 10
- `entity.stats.followers` (integer): 4
- `author.avatarUrl` (URL): 1
- `author.id` (string): 1
- `content.language` (string): 1
- `media.url` (URL): 1
- plus 3 platform-specific fields under `ext.`

## Endpoints

### reddit.frontpage

Reddit r/all hot posts.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/frontpage` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `entity.name`, `engagement.likes`, `engagement.comments`, `engagement.upvoteRatio`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/reddit/frontpage.md

### reddit.new_subreddits

Newly created subreddits.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/new_subreddits` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `entity.name`, `content.title`, `content.text`, `entity.stats.followers`, `content.createdAt`, `media.thumbnailUrl`, `ext.nsfw`
- Reference: https://onekey.dev/docs/api/reddit/new_subreddits.md

### reddit.popular_subreddits

Popular subreddits.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/popular_subreddits` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `entity.name`, `content.title`, `content.text`, `entity.stats.followers`, `content.createdAt`, `media.thumbnailUrl`, `ext.nsfw`
- Reference: https://onekey.dev/docs/api/reddit/popular_subreddits.md

### reddit.post

A Reddit post by id (with its listing metadata).
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/reddit/post?id=abc121` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Post id (base36), e.g. 1abcde
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `entity.name`, `engagement.likes`, `engagement.comments`, `engagement.upvoteRatio`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/reddit/post.md

### reddit.post_comments

Top-level comments of a Reddit post.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/post_comments?id=abc121` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Post id (base36), e.g. 1abcde
- Fields returned: `content.id`, `content.text`, `content.createdAt`, `author.username`, `engagement.likes`, `content.title`, `entity.name`
- Reference: https://onekey.dev/docs/api/reddit/post_comments.md

### reddit.post_transcript

Transcript of a Reddit video post.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/reddit/post_transcript?url=https%3A%2F%2Fwww.reddit.com%2Fr%2Fyouseeingthisshit%2Fcomments%2F1oiu9xm%2F` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `url` (string, required): Reddit post URL or direct v.redd.it video URL
- Fields returned: `content.id`, `content.text`, `content.language`, `content.url`, `ext.captionUrl`
- Reference: https://onekey.dev/docs/api/reddit/post_transcript.md

### reddit.search_comments

Search Reddit comments across all communities.
- Price: 1 credit per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/search_comments?query=python` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Search phrase; Reddit operators such as author:name and subreddit:name work
- Fields returned: `content.id`, `content.text`, `author.username`, `entity.name`, `engagement.likes`, `content.createdAt`, `content.title`
- Reference: https://onekey.dev/docs/api/reddit/search_comments.md

### reddit.search_media

Search Reddit image and video posts.
- Price: 1 credit per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/search_media?query=cats` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Search phrase; Reddit operators such as subreddit:name work
- Fields returned: `content.id`, `content.title`, `media.url`, `media.thumbnailUrl`, `author.username`, `entity.name`, `engagement.likes`, `engagement.comments`, `content.createdAt`
- Reference: https://onekey.dev/docs/api/reddit/search_media.md

### reddit.search_posts

Search Reddit posts.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/search_posts?q=python` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `entity.name`, `engagement.likes`, `engagement.comments`, `engagement.upvoteRatio`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/reddit/search_posts.md

### reddit.search_subreddit

Search posts inside one subreddit.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/search_subreddit?subreddit=python&q=asyncio` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `subreddit` (string, required): Subreddit name without r/, e.g. python
  - `q` (string, required): Search query
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `entity.name`, `engagement.likes`, `engagement.comments`, `engagement.upvoteRatio`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/reddit/search_subreddit.md

### reddit.search_subreddits

Search subreddits.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/search_subreddits?q=python` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `entity.name`, `content.title`, `content.text`, `entity.stats.followers`, `content.createdAt`, `media.thumbnailUrl`, `ext.nsfw`
- Reference: https://onekey.dev/docs/api/reddit/search_subreddits.md

### reddit.subreddit_about

A subreddit's profile.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/reddit/subreddit_about?subreddit=python` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `subreddit` (string, required): Subreddit name without r/, e.g. python
- Fields returned: `content.id`, `entity.name`, `content.title`, `content.text`, `entity.stats.followers`, `content.createdAt`, `media.thumbnailUrl`, `ext.nsfw`
- Reference: https://onekey.dev/docs/api/reddit/subreddit_about.md

### reddit.subreddit_controversial

Controversial posts of a subreddit (past week).
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/subreddit_controversial?subreddit=python` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `subreddit` (string, required): Subreddit name without r/, e.g. python
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `entity.name`, `engagement.likes`, `engagement.comments`, `engagement.upvoteRatio`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/reddit/subreddit_controversial.md

### reddit.subreddit_hot

Hot posts of a subreddit.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/subreddit_hot?subreddit=python` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `subreddit` (string, required): Subreddit name without r/, e.g. python
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `entity.name`, `engagement.likes`, `engagement.comments`, `engagement.upvoteRatio`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/reddit/subreddit_hot.md

### reddit.subreddit_new

Newest posts of a subreddit.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/subreddit_new?subreddit=python` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `subreddit` (string, required): Subreddit name without r/, e.g. python
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `entity.name`, `engagement.likes`, `engagement.comments`, `engagement.upvoteRatio`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/reddit/subreddit_new.md

### reddit.subreddit_rising

Rising posts of a subreddit.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/subreddit_rising?subreddit=python` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `subreddit` (string, required): Subreddit name without r/, e.g. python
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `entity.name`, `engagement.likes`, `engagement.comments`, `engagement.upvoteRatio`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/reddit/subreddit_rising.md

### reddit.subreddit_rules

Rules of a subreddit.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/subreddit_rules?subreddit=python` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `subreddit` (string, required): Subreddit name without r/, e.g. python
- Fields returned: `content.title`, `content.text`, `entity.name`, `content.createdAt`
- Reference: https://onekey.dev/docs/api/reddit/subreddit_rules.md

### reddit.subreddit_top

Top posts of a subreddit (past week).
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/subreddit_top?subreddit=python` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `subreddit` (string, required): Subreddit name without r/, e.g. python
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `entity.name`, `engagement.likes`, `engagement.comments`, `engagement.upvoteRatio`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/reddit/subreddit_top.md

### reddit.user_about

A Reddit user's profile.
- Price: 1 credit per fresh call. Status: beta. Access: may need a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/reddit/user_about?username=spez` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): Reddit username, e.g. spez
- Fields returned: `author.id`, `author.username`, `engagement.likes`, `engagement.comments`, `content.createdAt`, `author.avatarUrl`, `ext.karma`
- Reference: https://onekey.dev/docs/api/reddit/user_about.md

### reddit.user_comments

Comments written by a Reddit user.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/user_comments?username=spez` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): Reddit username, e.g. spez
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.text`, `content.createdAt`, `author.username`, `engagement.likes`, `content.title`, `entity.name`
- Reference: https://onekey.dev/docs/api/reddit/user_comments.md

### reddit.user_posts

Posts submitted by a Reddit user.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/reddit/user_posts?username=spez` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): Reddit username, e.g. spez
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `entity.name`, `engagement.likes`, `engagement.comments`, `engagement.upvoteRatio`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/reddit/user_posts.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/reddit/user_about?username=spez" \
  -H "x-api-key: YOUR_API_KEY"
```