{ "openapi": "3.0.1", "info": { "title": "Bilibili Scraper - Videos, Comments, Danmaku & Uploaders", "description": "Scrape Bilibili (哔哩哔哩) videos by keyword, URL, uploader or trending list. Get views, likes, coins, favorites, tags, uploader stats, comments and danmaku as JSON, CSV or Excel. Fast HTTP scraper, no browser.", "version": "1.0", "x-build-id": "mLssATH7bxTROnels" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/v1tal615~bilibili-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-v1tal615-bilibili-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/v1tal615~bilibili-scraper/runs": { "post": { "operationId": "runs-sync-v1tal615-bilibili-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/v1tal615~bilibili-scraper/run-sync": { "post": { "operationId": "run-sync-v1tal615-bilibili-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "Keywords to search on Bilibili, in Chinese or English (e.g. 原神, minecraft, AI). Each keyword returns up to 'Max results' videos (Bilibili caps search at 1,000 per keyword, use date filters to go further).", "default": [], "items": { "type": "string" } }, "videoUrls": { "title": "Video URLs or IDs", "type": "array", "description": "Bilibili video links (bilibili.com/video/BV..., m.bilibili.com, b23.tv short links), BV ids or av ids. Returns full details for each video.", "default": [], "items": { "type": "string" } }, "uploaders": { "title": "Uploaders (channels)", "type": "array", "description": "Uploader space URLs (space.bilibili.com/946974), numeric UIDs, or exact display names. Returns the uploader profile and, optionally, their videos (newest first).", "default": [], "items": { "type": "string" } }, "trending": { "title": "Trending list", "enum": [ "none", "popular", "precious" ], "type": "string", "description": "Also scrape a Bilibili trending list. 'Popular' is the live 综合热门 feed; 'Weekly must-watch' is 入站必刷.", "default": "none" }, "maxResults": { "title": "Max videos per keyword / uploader / list", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Upper limit of videos returned for each search keyword, each uploader and the trending list.", "default": 50 }, "searchSortBy": { "title": "Sort search results by", "enum": [ "relevance", "views", "newest", "danmaku", "favorites" ], "type": "string", "description": "Ordering used for keyword search.", "default": "relevance" }, "publishedAfter": { "title": "Published after", "type": "string", "description": "Only videos published on or after this date (Beijing time). Absolute date or relative like '30 days'. Search only." }, "publishedBefore": { "title": "Published before", "type": "string", "description": "Only videos published on or before this date (Beijing time). Search only." }, "durationFilter": { "title": "Video length", "enum": [ "any", "under10", "10to30", "30to60", "over60" ], "type": "string", "description": "Filter search results by duration.", "default": "any" }, "fetchFullDetails": { "title": "Fetch full video details", "type": "boolean", "description": "For search, uploader and trending results, open every video to add coins, shares, tags, original/repost flag and uploader follower count. Slower (one extra request per video). Video URLs always get full details.", "default": false }, "scrapeUploaderVideos": { "title": "Include uploader videos", "type": "boolean", "description": "For each uploader, also return their videos (newest first, up to 'Max results'). Turn off to get profiles only.", "default": true }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Also scrape comments of every video found. Without a SESSDATA cookie Bilibili only shows the top few comments (and their replies) to guests.", "default": false }, "maxCommentsPerVideo": { "title": "Max comments per video", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Limit of comments + replies per video.", "default": 100 }, "commentSortBy": { "title": "Comment order", "enum": [ "hot", "newest" ], "type": "string", "description": "Hot (most liked) or newest first. Newest needs a SESSDATA cookie to go beyond the first page.", "default": "hot" }, "includeReplies": { "title": "Include replies to comments", "type": "boolean", "description": "Also fetch the reply threads under each top-level comment.", "default": true }, "includeDanmaku": { "title": "Include danmaku (bullet comments)", "type": "boolean", "description": "Also scrape the danmaku shown over each video: text, second in the video, mode, color and send time.", "default": false }, "maxDanmakuPerVideo": { "title": "Max danmaku per video", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Limit of danmaku lines per video (Bilibili serves the current pool, usually up to a few thousand).", "default": 1000 }, "sessdata": { "title": "SESSDATA cookie (optional)", "type": "string", "description": "Optional. The SESSDATA cookie of your own Bilibili account, only needed for full comment lists. It is stored encrypted and only sent to bilibili.com." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed in most cases. Enable if Bilibili keeps rate-limiting your runs.", "default": { "useApifyProxy": false } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }