{ "openapi": "3.0.1", "info": { "title": "Bilibili Scraper: Videos, Comments, Danmaku & Uploaders", "description": "Scrape Bilibili videos from search, popular and ranking lists, video links and uploaders: title, views, likes, coins, favorites, shares, danmaku and comment counts, tags, duration, uploader. Optional comments, danmaku (bullet comments) and uploader profiles with followers.", "version": "1.0", "x-build-id": "IH2sWSh2vlBv33HKu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ksvan~bilibili-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ksvan-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/ksvan~bilibili-scraper/runs": { "post": { "operationId": "runs-sync-ksvan-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/ksvan~bilibili-scraper/run-sync": { "post": { "operationId": "run-sync-ksvan-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": "One Bilibili video search per keyword (Chinese or English).", "items": { "type": "string" } }, "sort": { "title": "Sort (search)", "enum": [ "relevance", "views", "newest", "danmaku", "favorites" ], "type": "string", "description": "Applies to keyword searches.", "default": "relevance" }, "duration": { "title": "Duration (search)", "enum": [ "any", "under10", "10to30", "30to60", "over60" ], "type": "string", "description": "Applies to keyword searches.", "default": "any" }, "popular": { "title": "Popular videos", "type": "boolean", "description": "Bilibili's current popular list (综合热门).", "default": false }, "ranking": { "title": "Ranking", "enum": [ "none", "all", "1", "3", "4", "5", "36", "188", "119", "129", "160", "211", "217", "223", "155", "181" ], "type": "string", "description": "Top 100 of the 3-day ranking (排行榜), all or one category.", "default": "none" }, "videoUrls": { "title": "Video links or IDs", "type": "array", "description": "https://www.bilibili.com/video/BV1..., BV ids or av numbers. Always returned with full details and tags.", "items": { "type": "string" } }, "users": { "title": "Uploaders", "type": "array", "description": "https://space.bilibili.com/ or numeric uploader ids (mid). Returns the profile with followers and, optionally, the uploader's videos.", "items": { "type": "string" } }, "includeUploaderVideos": { "title": "Uploader videos", "type": "boolean", "description": "List each uploader's videos, newest first (up to Max videos per source).", "default": true }, "maxVideosPerSource": { "title": "Max videos per search / list / uploader", "minimum": 1, "type": "integer", "description": "Search and popular give 20 per page, ranking up to 100, uploaders 30 per page.", "default": 40 }, "includeVideoDetails": { "title": "Full video details", "type": "boolean", "description": "Open every video for coins, shares, tags, cid, resolution and the full description. Search results already include views, likes, favorites, danmaku and comment counts.", "default": false }, "maxCommentsPerVideo": { "title": "Comments per video", "minimum": 0, "type": "integer", "description": "0 = no comments. 20 per page, pinned comment first.", "default": 0 }, "commentSort": { "title": "Comment order", "enum": [ "hot", "newest" ], "type": "string", "description": "Order of comments.", "default": "hot" }, "maxDanmakuPerVideo": { "title": "Danmaku per video", "minimum": 0, "type": "integer", "description": "0 = no danmaku. Bullet comments in playback order (Bilibili serves up to a few thousand per video).", "default": 0 }, "maxItems": { "title": "Max records in total", "minimum": 0, "type": "integer", "description": "0 = no limit. Counts videos, comments, danmaku and uploaders.", "default": 0 }, "maxConcurrency": { "title": "Parallel videos", "minimum": 1, "maximum": 10, "type": "integer", "description": "Videos processed at the same time (details, comments, danmaku).", "default": 5 }, "maxRetries": { "title": "Max retries per request", "minimum": 2, "maximum": 10, "type": "integer", "description": "Each retry uses a new proxy IP.", "default": 6 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave the default: datacenter proxy with automatic switch to residential when Bilibili blocks. Pick a group only to force it.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }