Docs
View as Markdown

bilibili.search_videos

stable 3 credits may need a pack

Search Bilibili videos by keyword.

GET /v1/bilibili/search_videos

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#

NameTypeRequiredDefaultWhat it isConstraints
qstringyes(required)Search keywordmax 80 chars; must match [^\x00-\x1f]{1,80}; trimmed, repeated spaces collapsed
pagestringno1Pagemax 3 chars; must match [0-9]{1,3}; trimmed

Request#

curl "https://api.onekey.dev/v1/bilibili/search_videos?q=music" \
  -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": [
    {
      "ext": {
        "bvid": "BV1BDk2YCEHF",
        "danmaku": 2209,
        "durationText": "667:37"
      },
      "content": {
        "id": "113685351696429",
        "title": "【神仙打架】华语乐坛神仙打架150首歌曲,经典歌曲合集,带滚动歌词(分P)",
        "text": "华语经典合集",
        "createdAt": "2024-12-26T09:30:26Z",
        "url": "http://www.bilibili.com/video/av113685351696429"
      },
      "author": {
        "id": "387522518",
        "displayName": "典藏音乐"
      },
      "engagement": {
        "views": 28885687,
        "likes": 52747,
        "comments": 1620,
        "bookmarks": 98984
      },
      "media": {
        "thumbnailUrl": null
      }
    },
    {
      "ext": {
        "bvid": "BV1FPjy6TEiE",
        "danmaku": 2403,
        "durationText": "222:28"
      },
      "content": {
        "id": "116779154212963",
        "title": "【周杰伦】50首精选合集/后台播放/无损音质/HIFI音质/华语流行音乐才是最叼的",
        "text": "-",
        "createdAt": "2026-06-19T22:52:25Z",
        "url": "http://www.bilibili.com/video/av116779154212963"
      },
      "author": {
        "id": "1749710516",
        "displayName": "超级爱下雨天"
      },
      "engagement": {
        "views": 15494175,
        "likes": 48979,
        "comments": 1687,
        "bookmarks": 88613
      },
      "media": {
        "thumbnailUrl": null
      }
    }
  ],
  "metadata": {
    "platform": "bilibili",
    "endpoint": "search_videos",
    "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 pathOnekey fieldTransform
bvidext.bvid-
aidcontent.idtoString
titlecontent.titlestripHtml
descriptioncontent.text-
pubdatecontent.createdAttoIsoDate
midauthor.idtoString
authorauthor.displayName-
playengagement.viewstoNumber
likeengagement.likestoNumber
reviewengagement.commentstoNumber
video_reviewext.danmakutoNumber
favoritesengagement.bookmarkstoNumber
durationext.durationText-
picmedia.thumbnailUrlsafeUrl
arcurlcontent.urlsafeUrl

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