bilibili.related - Onekey docs

stable 3 credits may need a pack

Videos related to a Bilibili video (by bvid).

GET /v1/bilibili/related

What you get#

A list of Bilibili 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#

3 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
`bvid`	string	yes	(required)	Bilibili video id, e.g. BV1GJ411x7h7	max 12 chars; must match `BV[A-Za-z0-9]{10}`; trimmed

Request#

curl "https://api.onekey.dev/v1/bilibili/related?bvid=BV1GJ411x7h7" \
  -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 Bilibili response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "content": {
        "id": "113491440567226",
        "title": "视频已失效",
        "text": "-",
        "createdAt": "2024-11-16T07:29:38Z"
      },
      "ext": {
        "bvid": "BV1V4UYY5EhD",
        "danmaku": 1121,
        "coins": 465
      },
      "author": {
        "id": "3493084276984624",
        "displayName": "CR400BF-AS-5421",
        "avatarUrl": "https://i1.hdslb.com/bfs/face/c6d9cf47201fc0c589e688056564b1ed42dd1651.jpg"
      },
      "engagement": {
        "views": 522478,
        "likes": 10269,
        "comments": 1011,
        "shares": 469,
        "bookmarks": 6268
      },
      "media": {
        "durationSeconds": 18,
        "thumbnailUrl": "http://i0.hdslb.com/bfs/archive/797622f41524e4772e55070b68cad4c662291d5c.jpg"
      }
    },
    {
      "content": {
        "id": "681309864",
        "title": "大家好，我是Rick Astley,今天我入驻b站了！ doge",
        "text": "-",
        "createdAt": "2022-02-06T06:03:13Z"
      },
      "ext": {
        "bvid": "BV1eS4y157Ey",
        "danmaku": 83693,
        "coins": 59228
      },
      "author": {
        "id": "373025504",
        "displayName": "Rickrocknroll",
        "avatarUrl": "https://i2.hdslb.com/bfs/face/2e80099ab1fa6fd6deece7acdf157406aaf50377.jpg"
      },
      "engagement": {
        "views": 18023342,
        "likes": 1351629,
        "comments": 19981,
        "shares": 60042,
        "bookmarks": 141695
      },
      "media": {
        "durationSeconds": 232,
        "thumbnailUrl": "http://i1.hdslb.com/bfs/archive/f04cb129c990f7a911e81ad410bec7aef2950e0e.jpg"
      }
    }
  ],
  "metadata": {
    "platform": "bilibili",
    "endpoint": "related",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 3,
    "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
`aid`	`content.id`	`toString`
`bvid`	`ext.bvid`	-
`title`	`content.title`	`stripHtml`
`desc`	`content.text`	-
`pubdate`	`content.createdAt`	`toIsoDate`
`owner.mid`	`author.id`	`toString`
`owner.name`	`author.displayName`	-
`owner.face`	`author.avatarUrl`	`safeUrl`
`stat.view`	`engagement.views`	`toNumber`
`stat.like`	`engagement.likes`	`toNumber`
`stat.reply`	`engagement.comments`	`toNumber`
`stat.share`	`engagement.shares`	`toNumber`
`stat.danmaku`	`ext.danmaku`	`toNumber`
`stat.coin`	`ext.coins`	`toNumber`
`stat.favorite`	`engagement.bookmarks`	`toNumber`
`duration`	`media.durationSeconds`	`toNumber`
`pic`	`media.thumbnailUrl`	`safeUrl`

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