# twitch.clip

**stable** **Standard**

A single Twitch clip by slug.

`GET /v1/twitch/clip`

## What you get

One Twitch record in Onekey's unified shape, in `data`. If the record does not exist you get a `404 not_found` and are not charged.

## What it costs

- **Standard · 1 credit** for a fresh fetch, charged only when it succeeds.
- **Free when served from cache (0.2 credit for a cached response over 100 KB).**
- **Free** if the request is invalid (never charged) or the source fails or reports not found (refunded).

## Parameters

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `slug` | string | yes | (required) | Twitch clip slug | max 100 chars; must match `[A-Za-z0-9_\-]{5,100}`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/twitch/clip?slug=TangentialBillowingJalapenoYee-ccA2oB1pEYh4CHWJ" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/twitch/clip",
    params={"slug": "TangentialBillowingJalapenoYee-ccA2oB1pEYh4CHWJ"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ slug: "TangentialBillowingJalapenoYee-ccA2oB1pEYh4CHWJ" });
const res = await fetch(`https://api.onekey.dev/v1/twitch/clip?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

A real Twitch response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": {
    "content": {
      "id": "2358589597",
      "slug": "TangentialBillowingJalapenoYee-ccA2oB1pEYh4CHWJ",
      "title": "F Shroud",
      "createdAt": "2023-06-02T11:41:50Z",
      "category": "Diablo IV"
    },
    "engagement": {
      "views": 562956
    },
    "media": {
      "durationSeconds": 28,
      "thumbnailUrl": "https://static-cdn.jtvnw.net/twitch-video-assets/twitch-vap-video-assets-prod-us-west-2/5696a6a8-e053-4c2e-a54c-5ca62c48102e/landscape/thumb/thumb-0000000000-1920x1080.jpg"
    },
    "author": {
      "id": "37402112",
      "username": "shroud",
      "displayName": "shroud"
    }
  },
  "metadata": {
    "platform": "twitch",
    "endpoint": "clip",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `0.data.clip.id` | `content.id` | - |
| `0.data.clip.slug` | `content.slug` | - |
| `0.data.clip.title` | `content.title` | - |
| `0.data.clip.viewCount` | `engagement.views` | `toNumber` |
| `0.data.clip.createdAt` | `content.createdAt` | `toIsoDate` |
| `0.data.clip.durationSeconds` | `media.durationSeconds` | `toNumber` |
| `0.data.clip.thumbnailURL` | `media.thumbnailUrl` | `safeUrl` |
| `0.data.clip.broadcaster.id` | `author.id` | - |
| `0.data.clip.broadcaster.login` | `author.username` | - |
| `0.data.clip.broadcaster.displayName` | `author.displayName` | - |
| `0.data.clip.game.name` | `content.category` | - |

## Caching and freshness

- Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
- Between 1 hour and 1 day the cached copy is still served instantly and marked `stale: true` while Onekey refreshes it in the background.
- If the source is down when a refresh is needed, the last copy can be served for up to 3 days more (marked stale).
- A "not found" is remembered for 5 minutes and is free.
- The cache is shared across all customers, which is what keeps repeat calls cheap.

## What can go wrong

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | That record does not exist. Free; do not retry. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).