# bilibili.ranking

**stable** **3 credits** **may need a pack**

Bilibili all-site ranking (3-day) of videos.

`GET /v1/bilibili/ranking`

> [!NOTE] **May need a pack.** Free credits use only the open fetch path; the fallback path behind it needs a purchased pack and a verified email. See [pricing](https://onekey.dev/pricing).

## 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

This endpoint takes no parameters.

## Request

```bash
curl "https://api.onekey.dev/v1/bilibili/ranking" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/bilibili/ranking",
    params={},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({});
const res = await fetch(`https://api.onekey.dev/v1/bilibili/ranking?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## 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": "117343120398899",
        "title": "《原神》六周年主题曲《风的来信》"
      },
      "ext": {
        "bvid": "BV14Baa6JENd",
        "danmaku": 35549,
        "coins": 0,
        "durationText": "14:38"
      },
      "author": {
        "id": "401742377",
        "displayName": "原神"
      },
      "engagement": {
        "views": 1732060
      },
      "media": {
        "thumbnailUrl": "http://i2.hdslb.com/bfs/archive/e0fff47818224cf8016d5743fb8b35a2c3812eb8.jpg"
      }
    },
    {
      "content": {
        "id": "117341761312756",
        "title": "蛙跳爬泰山"
      },
      "ext": {
        "bvid": "BV1Hxah6BEGy",
        "danmaku": 8781,
        "coins": 0,
        "durationText": "9:20"
      },
      "author": {
        "id": "494818687",
        "displayName": "爱健身小庞"
      },
      "engagement": {
        "views": 1413029
      },
      "media": {
        "thumbnailUrl": "http://i1.hdslb.com/bfs/archive/7352ffb6b3855ae481e3588fccfc0b436e315119.jpg"
      }
    }
  ],
  "metadata": {
    "platform": "bilibili",
    "endpoint": "ranking",
    "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](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `aid` | `content.id` | `toString` |
| `bvid` | `ext.bvid` | - |
| `title` | `content.title` | `stripHtml` |
| `mid` | `author.id` | `toString` |
| `author` | `author.displayName` | - |
| `play` | `engagement.views` | `toNumber` |
| `video_review` | `ext.danmaku` | `toNumber` |
| `coins` | `ext.coins` | `toNumber` |
| `duration` | `ext.durationText` | - |
| `pic` | `media.thumbnailUrl` | `safeUrl` |

## Caching and freshness

- Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
- Between 30 seconds and 5 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 15 minutes 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](https://onekey.dev/pricing); 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](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).