# Reddit oEmbed API Documentation

<p><strong>Reddit oEmbed API</strong> returns the title, the author name and the embed code of a Reddit post URL. Use it to render a post card without the full post data.</p>

- **Documentation:** [https://scrappa.co/docs/reddit-api/reddit_oembed](https://scrappa.co/docs/reddit-api/reddit_oembed)
- **API group:** Reddit API
- **Endpoint:** `GET https://scrappa.co/api/reddit/oembed`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string | Yes | Reddit post URL. Example: https://www.reddit.com/r/pics/comments/1xhsecz/title/. |

## Example response

```json
{
    "data": {
        "url": "https://www.reddit.com/r/pics/comments/1xhsecz/title/",
        "html": "<blockquote class=\"reddit-embed-bq\" style=\"height:500px\"><a href=\"https://www.reddit.com/r/pics/comments/1xhsecz/title/\">Title</a> from <...",
        "title": "I Transformed my Victorian home into Monster House for Halloween!",
        "width": 550,
        "height": null,
        "author_url": null,
        "author_name": "ChristineHMcConnell"
    },
    "meta": {
        "billable": true,
        "endpoint_family": "oembed"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A required parameter or a value is invalid. This response is not billable. |
| 404 | Not Found | The subreddit, post or user does not exist, is private or is banned. This response is not billable. |
| 503 | Upstream Unavailable | Reddit could not be reached or returned data that does not match the request. This response is not billable and is retryable. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)