# twitch.videos

**stable** **Standard**

Recent videos (VODs) of a Twitch channel.

`GET /v1/twitch/videos`

## What you get

A list of Twitch results in Onekey's unified shape, in `data` (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free `404 not_found` instead.

**Also known as:** `/twitch/user/videos` on APIs that nest their paths. See [Alternatives and equivalents](https://onekey.dev/docs/alternatives.md).

## 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 |
| --- | --- | --- | --- | --- | --- |
| `login` | string | yes | (required) | Twitch login name, e.g. shroud | max 25 chars; must match `[A-Za-z0-9_]{1,25}`; trimmed, leading @ removed, lowercased |

## Request

```bash
curl "https://api.onekey.dev/v1/twitch/videos?login=shroud" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/twitch/videos",
    params={"login": "shroud"},
    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({ login: "shroud" });
const res = await fetch(`https://api.onekey.dev/v1/twitch/videos?${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": "2886470967",
        "title": "GOING FOR 10M",
        "createdAt": "2026-09-28T16:59:56Z",
        "category": "WARDOGS"
      },
      "engagement": {
        "views": 255
      },
      "media": {
        "durationSeconds": 10474,
        "thumbnailUrl": "https://vod-secure.twitch.tv/_404/404_processing_320x180.png"
      },
      "author": {
        "username": "shroud"
      }
    },
    {
      "content": {
        "id": "2885710155",
        "title": "doggin till the sunsets",
        "createdAt": "2026-09-27T18:24:59Z",
        "category": "WARDOGS"
      },
      "engagement": {
        "views": 268260
      },
      "media": {
        "durationSeconds": 26631,
        "thumbnailUrl": "https://static-cdn.jtvnw.net/cf_vods/d2vi6trrdongqn/4d1e87a450386eaa0156_shroud_320414846686_1790533494//thumb/thumb0-320x180.jpg"
      },
      "author": {
        "username": "shroud"
      }
    }
  ],
  "metadata": {
    "platform": "twitch",
    "endpoint": "videos",
    "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 |
| --- | --- | --- |
| `node.id` | `content.id` | - |
| `node.title` | `content.title` | - |
| `node.viewCount` | `engagement.views` | `toNumber` |
| `node.lengthSeconds` | `media.durationSeconds` | `toNumber` |
| `node.publishedAt` | `content.createdAt` | `toIsoDate` |
| `node.previewThumbnailURL` | `media.thumbnailUrl` | `safeUrl` |
| `node.game.name` | `content.category` | - |
| `node.owner.login` | `author.username` | - |

## Caching and freshness

- Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
- Between 2 minutes and 15 minutes 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 1 hour more (marked stale).
- A "not found" is remembered for 1 minute 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` | Unknown endpoint path. |
| 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).