Docs
View as Markdown

youtube.channel_shorts

stable 2 credits may need a pack

Shorts from a YouTube channel (Shorts tab).

GET /v1/youtube/channel_shorts

What you get#

A list of YouTube 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: /youtube/channel/shorts on APIs that nest their paths. See Alternatives and equivalents.

What it costs#

  • 2 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#

NameTypeRequiredDefaultWhat it isConstraints
channel_idstringyes(required)YouTube channel id (UC + 22 chars)max 24 chars; must match UC[A-Za-z0-9_\-]{22}; trimmed

Request#

curl "https://api.onekey.dev/v1/youtube/channel_shorts?channel_id=UC_x5XG1OV2P6uZZ5FSM9Ttw" \
  -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 YouTube response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "content": {
        "id": "FVkp6tc2rNY",
        "title": "🪄 Gemini Live API in action"
      },
      "ext": {
        "viewsText": "3.8K views"
      },
      "media": {
        "thumbnailUrl": "https://i.ytimg.com/vi/FVkp6tc2rNY/oar2.jpg?sqp=-oaymwEdCJUDENAFSFWQAgHyq4qpAwwIARUAAIhCcAHAAQY=&rs=AOn4CLAiulbQ5Xd4QWy-ITSNKbPApvgTeg&usqp=CCk"
      }
    },
    {
      "content": {
        "id": "M1q063UD-gw",
        "title": "Manage your agents while you’re on the move with the Antigravity Remote Control"
      },
      "ext": {
        "viewsText": "4.8K views"
      },
      "media": {
        "thumbnailUrl": "https://i.ytimg.com/vi/M1q063UD-gw/oar2.jpg?sqp=-oaymwEdCJUDENAFSFWQAgHyq4qpAwwIARUAAIhCcAHAAQY=&rs=AOn4CLC7OF8D6bW_KCt_WvlMJT_xTGKUHA&usqp=CCk"
      }
    }
  ],
  "metadata": {
    "platform": "youtube",
    "endpoint": "channel_shorts",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "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 pathOnekey fieldTransform
richItemRenderer.content.shortsLockupViewModel.onTap.innertubeCommand.reelWatchEndpoint.videoIdcontent.id-
richItemRenderer.content.shortsLockupViewModel.overlayMetadata.primaryText.contentcontent.title-
richItemRenderer.content.shortsLockupViewModel.overlayMetadata.secondaryText.contentext.viewsText-
richItemRenderer.content.shortsLockupViewModel.thumbnailViewModel.thumbnailViewModel.image.sources.0.urlmedia.thumbnailUrlsafeUrl

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#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).