Bilibili is a major video and ACG streaming platform. In Shirone, Bilibili integrations are utilized in two distinct scenarios:

1. Anime Watchlist Synchronization (Anime Sync Provider): Offline synchronization of user anime follow lists into local snapshots (scripts/anime/providers/bilibili.mjs).
2. Video Embed Facade: Lazy-loaded, privacy-friendly video player embedding for articles (src/plugins/markdown/remark-bilibili.mjs, src/utils/bilibili.ts).

---

Watchlist Sync API

Shirone's sync script fetches follow lists via Bilibili's public user space API.

Configuration src/config/animeConfig.ts

Configure the Bilibili provider in src/config/animeConfig.ts:

src/config/animeConfig.ts

export const animeConfig = withUserConfig("anime", {
  enable: true,
  source: {
    kind: "snapshot",
    provider: "bilibili",
  },
  providers: {
    bilibili: {
      enable: true,
      vmid: "12345678",             // Your numeric Bilibili UID
      sessdataEnv: "BILI_SESSDATA", // Environment variable for private list credentials
      cover: {
        mode: "local",              // Download covers locally (recommended)
        useWebp: true,              // Convert to WebP format
      },
      request: {
        pageSize: 30,               // Items per page (10 ~ 50, default 30)
        maxItems: 300,              // Maximum entries to fetch
        minDelayMs: 300,            // Request delay in ms
      },
    },
  },
})

Field	Type	Default	Description
vmid	string	""	Bilibili numeric account UID (required)
sessdataEnv	string	"BILI_SESSDATA"	Name of the environment variable holding private credentials
cover.mode	"local" | "remote" | "none"	"local"	Cover image strategy: local (downloaded locally to prevent anti-hotlinking issues), remote, or none
cover.useWebp	boolean	true	Convert covers to lightweight WebP
request.pageSize	number	30	Pagination page size
request.minDelayMs	number	300	Delay between pagination requests in milliseconds

API Endpoint Specification

• Endpoint: GET https://api.bilibili.com/x/space/bangumi/follow/list
• Headers:
  • User-Agent: Desktop browser user-agent
  • Referer: https://space.bilibili.com/
  • Cookie: SESSDATA=${sessdata}; (injected only if private credentials are configured)

Query Parameters

Parameter	Type	Description
type	number	Fixed to 1 (Anime)
follow_status	number	Watch status: 1 Planned / 2 Watching / 3 Completed
vmid	string	Target user UID
ps	number	Page size (max 50)
pn	number	Page number (1-based)

Response Format

{
  "code": 0,
  "message": "0",
  "ttl": 1,
  "data": {
    "list": [
      {
        "media_id": 28228367,
        "season_id": 34209,
        "title": "SPY×FAMILY",
        "cover": "http://i0.hdslb.com/bfs/bangumi/image/....jpg",
        "total_count": 25,
        "progress": "Watched Ep 12",
        "rating": {
          "score": 9.7
        },
        "evaluate": "Master spy Twilight must disguise himself...",
        "publish": {
          "pub_time": "2022-04-09 23:00:00"
        },
        "styles": ["Comedy", "Action"]
      }
    ],
    "total": 45
  }
}

• code: 0: Success
• code: 53013 / -401: Target follow list is private; requires valid SESSDATA.

Anti-Hotlinking & Local Cover Caching

Bilibili image servers (hdslb.com) enforce strict Referer policies that block external hotlinking. Setting cover.mode: "local" instructs Shirone to download covers to public/assets/anime/covers/bili_{id}.webp during build time:

• Zero broken images: Assets are served from your own domain.
• Fast loading: Converted to optimized WebP format.

---

Video Embed Facade

When embedding Bilibili videos in Markdown articles, Shirone uses a lightweight facade:

::bilibili{bvid="BV1GJ411x7h7" part=1}

Player Endpoint

• Player URL: https://player.bilibili.com/player.html?bvid={bvid}&page={part}&as_wide=1&high_quality=1&danmaku=0
• On-Demand Activation: The page initially loads a lightweight static card without third-party iframes or cookies. The video player iframe only initializes when the visitor clicks the play button.

FAQ

Sync errorcode: 53013 (Permission Denied)

Your Bilibili privacy settings have set your watchlist to private. Solution: Add BILI_SESSDATA="your_sessdata" to your .env file or CI environment variables.

Caution

Credential Security WarningSESSDATA grants full access to your Bilibili account. Never commit .env containing real credentials to public git repositories or client bundles.

Running the sync command

pnpm anime:sync --provider bilibili

Copyright

Copyright Ownership:matsuzaka-yuki

License under:Attribution 4.0 International (CC-BY-4.0)

Contributors: matsuzaka-yuki

Previous pageBangumi API

Next pageUmami API