{ "openapi": "3.0.1", "info": { "title": "Bilibili Scraper — Videos, Comments, Creators & Search | B站", "description": "Bilibili scraper API: videos by keyword, video details and stats, comments, creator profiles and uploads, popular rankings. No login, JSON/CSV/Excel.", "version": "0.1", "x-build-id": "WsdHl1nVkXe1HbyrJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/innolabs~bilibili-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-innolabs-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/innolabs~bilibili-scraper/runs": { "post": { "operationId": "runs-sync-innolabs-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/innolabs~bilibili-scraper/run-sync": { "post": { "operationId": "run-sync-innolabs-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 searched on Bilibili, in any language (e.g. 'python tutorial', '原神', 'iPhone 17 测评'). Each keyword returns up to 'Max videos per source' videos.", "items": { "type": "string" } }, "startUrls": { "title": "Video and creator URLs", "type": "array", "description": "Video pages (https://www.bilibili.com/video/BV1884g6mE8K, av123456 links, m.bilibili.com and b23.tv share links, or a bare BV id) and creator pages (https://space.bilibili.com/546195). A creator URL returns the creator's profile and their latest uploads.", "items": { "type": "string" } }, "popular": { "title": "Popular videos", "type": "boolean", "description": "Also scrape Bilibili's Popular board (综合热门), the videos trending across the site right now.", "default": false }, "maxVideosPerSource": { "title": "Max videos per source", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many videos to take from each search keyword, each creator's uploads and the Popular board. Search returns at most 1,000 videos per keyword.", "default": 50 }, "searchOrder": { "title": "Sort search results by", "enum": [ "totalrank", "click", "pubdate", "dm", "stow", "scores" ], "type": "string", "description": "Relevance (default), most viewed, newest, most danmaku (bullet comments), most favorited or most commented.", "default": "totalrank" }, "searchDuration": { "title": "Video length", "enum": [ "any", "under10", "10to30", "30to60", "over60" ], "type": "string", "description": "Keep only search results of this length.", "default": "any" }, "includeVideoDetails": { "title": "Full video details", "type": "boolean", "description": "Fetch every video's full statistics (coins, shares, likes, favorites), tags, parts, resolution and honors. Turn off for faster, lighter runs: search results then have no coins or shares, creator uploads only views, danmaku, length and date.", "default": true }, "creatorVideos": { "title": "Creator uploads", "type": "boolean", "description": "For creator URLs, also scrape their uploaded videos (up to 'Max videos per source'). Off = profile only.", "default": true }, "creatorVideosOrder": { "title": "Creator uploads order", "enum": [ "pubdate", "click" ], "type": "string", "description": "Take a creator's newest uploads or their most viewed ones.", "default": "pubdate" }, "includeOwnerProfiles": { "title": "Uploader profiles", "type": "boolean", "description": "Also output the profile (followers, likes, video count, verification) of every video's uploader, once per creator. Useful to find creators (KOLs) by keyword.", "default": false }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Scrape the comments of every video: text, likes, reply count, date, author (name, level, VIP), pinned and uploader-liked flags, attached pictures.", "default": false }, "maxCommentsPerVideo": { "title": "Max comments per video", "minimum": 1, "maximum": 100000, "type": "integer", "description": "How many comments (and replies, if enabled) to collect per video.", "default": 100 }, "commentsSort": { "title": "Sort comments by", "enum": [ "hot", "newest" ], "type": "string", "description": "Hot (most liked first, Bilibili's default) or newest first.", "default": "hot" }, "includeCommentReplies": { "title": "Include replies", "type": "boolean", "description": "Also collect the replies under each comment (threads). Replies count towards 'Max comments per video'.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Hard cap on dataset items (videos, comments and creators together). The run stops cleanly when reached.", "default": 1000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. The default datacenter proxy works for Bilibili.", "default": { "useApifyProxy": true } }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Log every page and request retry.", "default": 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 } } } } } } } } } }