Docs
View as Markdown

bilibili.video

beta Standard may need a pack

Bilibili video details (view endpoint) by bvid.

GET /v1/bilibili/video

What you get#

One Bilibili record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

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#

NameTypeRequiredDefaultWhat it isConstraints
bvidstringyes(required)Bilibili video id, e.g. BV1GJ411x7h7max 12 chars; must match BV[A-Za-z0-9]{10}; trimmed

Request#

curl "https://api.onekey.dev/v1/bilibili/video?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": "id0290",
      "title": "Example content.title 0",
      "text": "example content.text 0",
      "createdAt": "2023-11-14T22:13:20Z"
    },
    "ext": {
      "bvid": "id0211",
      "danmaku": 100,
      "coins": 100
    },
    "author": {
      "id": "id0548",
      "displayName": "example author.displayName 0",
      "avatarUrl": "https://example.com/author/avatarurl/0"
    },
    "engagement": {
      "views": 100,
      "likes": 100,
      "comments": 100,
      "shares": 100,
      "bookmarks": 100
    },
    "media": {
      "durationSeconds": 100,
      "thumbnailUrl": "https://example.com/media/thumbnailurl/0"
    }
  },
  "metadata": {
    "platform": "bilibili",
    "endpoint": "video",
    "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. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
data.aidcontent.idtoString
data.bvidext.bvid-
data.titlecontent.titlestripHtml
data.desccontent.text-
data.pubdatecontent.createdAttoIsoDate
data.owner.midauthor.idtoString
data.owner.nameauthor.displayName-
data.owner.faceauthor.avatarUrlsafeUrl
data.stat.viewengagement.viewstoNumber
data.stat.likeengagement.likestoNumber
data.stat.replyengagement.commentstoNumber
data.stat.shareengagement.sharestoNumber
data.stat.danmakuext.danmakutoNumber
data.stat.coinext.coinstoNumber
data.stat.favoriteengagement.bookmarkstoNumber
data.durationmedia.durationSecondstoNumber
data.picmedia.thumbnailUrlsafeUrl

Caching and freshness#

  • Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
  • Between 1 hour and 1 day 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 3 days more (marked stale).
  • A "not found" is remembered for 5 minutes 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_foundThat record does not exist. Free; do not retry.
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: beta (not yet verified against the live source).