twitch.clips
stable Advanced
Top clips of a Twitch channel (all time).
GET /v1/twitch/clips
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.
What it costs#
- Advanced · 5 credits 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#
curl "https://api.onekey.dev/v1/twitch/clips?login=shroud" \
-H "x-api-key: YOUR_API_KEY"Try it
Add your key to run this call right here. No key? Get one free. The key stays in this tab.
Recorded response#
A real Twitch response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.
{
"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": {
"username": "shroud"
},
"ext": {
"clippedBy": "pato_bolado"
}
},
{
"content": {
"id": "3663533447",
"slug": "SuccessfulEndearingPidgeonPunchTrees-46KXLAMeuS9kpp5Q",
"title": "it's gonna be over",
"createdAt": "2023-08-05T10:53:38Z",
"category": "Baldur's Gate 3"
},
"engagement": {
"views": 562610
},
"media": {
"durationSeconds": 19,
"thumbnailUrl": "https://static-cdn.jtvnw.net/twitch-video-assets/twitch-vap-video-assets-prod-us-west-2/05f80190-90b4-4569-94ce-36a01d87b191/landscape/thumb/thumb-0000000000-1920x1080.jpg"
},
"author": {
"username": "shroud"
},
"ext": {
"clippedBy": "jawnpeed"
}
}
],
"metadata": {
"platform": "twitch",
"endpoint": "clips",
"cached": false,
"stale": false,
"age_s": 0,
"fetched_at": "2026-01-01T12:00:00+00:00",
"credits_charged": 5,
"request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
},
"error": null
}Field mapping#
How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.
| Source path | Onekey field | Transform |
|---|---|---|
node.id | content.id | - |
node.slug | content.slug | - |
node.title | content.title | - |
node.viewCount | engagement.views | toNumber |
node.createdAt | content.createdAt | toIsoDate |
node.durationSeconds | media.durationSeconds | toNumber |
node.thumbnailURL | media.thumbnailUrl | safeUrl |
node.broadcaster.login | author.username | - |
node.curator.login | ext.clippedBy | - |
node.game.name | content.category | - |
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: truewhile 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; 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 for the full list and retry guidance.
Status: stable (verified against the live source).