youtube.related - Onekey docs

stable 2 credits may need a pack

Related / up-next videos for a YouTube video.

GET /v1/youtube/related

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.

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#

Name	Type	Required	Default	What it is	Constraints
`id`	string	yes	(required)	YouTube video id	max 11 chars; must match `[A-Za-z0-9_\-]{11}`; trimmed

Request#

curl "https://api.onekey.dev/v1/youtube/related?id=dQw4w9WgXcQ" \
  -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": "izGwDsrQ1eQ",
        "title": "George Michael - Careless Whisper (Official Video)"
      },
      "author": {
        "displayName": "George Michael"
      },
      "ext": {
        "viewsText": "1.6B",
        "publishedText": "16y ago",
        "durationText": "5:01"
      },
      "media": {
        "thumbnailUrl": "https://i.ytimg.com/vi/izGwDsrQ1eQ/hqdefault.jpg?sqp=-oaymwEbCKgBEF5IVfKriqkDDggBFQAAiEIYAXABwAEG&rs=AOn4CLAPEMSx8W9_-QGlw_ZFUf3cYVKl6w"
      }
    },
    {
      "content": {
        "id": "zpzdgmqIHOQ",
        "title": "Madonna - La Isla Bonita (Official Video)"
      },
      "author": {
        "displayName": "Madonna"
      },
      "ext": {
        "viewsText": "1.2B",
        "publishedText": "16y ago",
        "durationText": "4:02"
      },
      "media": {
        "thumbnailUrl": "https://i.ytimg.com/vi/zpzdgmqIHOQ/hqdefault.jpg?sqp=-oaymwEbCKgBEF5IVfKriqkDDggBFQAAiEIYAXABwAEG&rs=AOn4CLC_Rd9XEDAlyToOZfyHN3BoPqAv4Q"
      }
    }
  ],
  "metadata": {
    "platform": "youtube",
    "endpoint": "related",
    "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 path	Onekey field	Transform
`lockupViewModel.contentId`	`content.id`	-
`lockupViewModel.metadata.lockupMetadataViewModel.title.content`	`content.title`	-
`lockupViewModel.metadata.lockupMetadataViewModel.metadata.contentMetadataViewModel.metadataRows.0.metadataParts.0.text.content`	`author.displayName`	-
`lockupViewModel.metadata.lockupMetadataViewModel.metadata.contentMetadataViewModel.metadataRows.1.metadataParts.0.text.content`	`ext.viewsText`	-
`lockupViewModel.metadata.lockupMetadataViewModel.metadata.contentMetadataViewModel.metadataRows.1.metadataParts.1.text.content`	`ext.publishedText`	-
`lockupViewModel.contentImage.thumbnailViewModel.image.sources.0.url`	`media.thumbnailUrl`	`safeUrl`
`lockupViewModel.contentImage.thumbnailViewModel.overlays.0.thumbnailBottomOverlayViewModel.badges.0.thumbnailBadgeViewModel.text`	`ext.durationText`	-

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; 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).