Docs
View as Markdown

bilibili.comments

stable 3 credits may need a pack

Top-level comments on a Bilibili video (by aid).

GET /v1/bilibili/comments

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
aidstringyes(required)Bilibili video aid (numeric av id)max 15 chars; must match [0-9]{1,15}; trimmed
pagestringno1Pagemax 3 chars; must match [0-9]{1,3}; trimmed

Request#

curl "https://api.onekey.dev/v1/bilibili/comments?aid=170001" \
  -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": "1353715029",
        "text": "妖王为了提倡节约用水,特意拍了《HOP》这部公益短片,这部短片讲述了一群男人为了节约用水而挤在一个澡盆里洗澡的故事,他们的精神可嘉,值得我们大家学习",
        "createdAt": "2019-02-03T04:07:30Z"
      },
      "author": {
        "id": "266952687",
        "displayName": "君之自由",
        "avatarUrl": "https://i0.hdslb.com/bfs/face/1379184a8c0caa875ef5bd31d30e89cf6e092f9c.jpg"
      },
      "engagement": {
        "likes": 181001,
        "comments": 617
      }
    },
    {
      "content": {
        "id": "669376635",
        "text": "性感妖王今犹在,不见当年比利王。",
        "createdAt": "2018-03-04T07:12:03Z"
      },
      "author": {
        "id": "54293768",
        "displayName": "此山独晴",
        "avatarUrl": "https://i2.hdslb.com/bfs/face/fc3431a9cade8f025582018486348929b6db613d.jpg"
      },
      "engagement": {
        "likes": 147524,
        "comments": 571
      }
    }
  ],
  "metadata": {
    "platform": "bilibili",
    "endpoint": "comments",
    "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
rpidcontent.idtoString
content.messagecontent.text-
ctimecontent.createdAttoIsoDate
midauthor.idtoString
member.unameauthor.displayName-
member.avatarauthor.avatarUrlsafeUrl
likeengagement.likestoNumber
rcountengagement.commentstoNumber

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