{ "openapi": "3.0.1", "info": { "title": "Bilibili Scraper - Videos, Stats, Creators, Comments", "description": "Scrape Bilibili (B站) videos by keyword, creator (UP主) uploads, Popular or Ranking, or video URLs/BV ids: title, author, followers, publish date, duration, views, likes, coins, favorites, shares, danmaku, replies, tags. Optional comments. Half the usual price.", "version": "0.1", "x-build-id": "ogRfxs2Z3cR9FPydu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/unbrowseai~bilibili-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-unbrowseai-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/unbrowseai~bilibili-scraper/runs": { "post": { "operationId": "runs-sync-unbrowseai-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/unbrowseai~bilibili-scraper/run-sync": { "post": { "operationId": "run-sync-unbrowseai-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": { "searchKeywords": { "title": "Search keywords", "type": "array", "description": "Keywords to search Bilibili videos for, in Chinese or any language (e.g. 原神, 人工智能, minecraft). Each keyword returns up to 'Max videos per source'.", "items": { "type": "string" } }, "userIds": { "title": "Creators (UP主)", "type": "array", "description": "Creator user IDs (UID, e.g. 546195) or space URLs (https://space.bilibili.com/546195). Returns their uploads, newest first.", "default": [], "items": { "type": "string" } }, "chart": { "title": "Popular or Ranking", "enum": [ "none", "popular", "ranking" ], "type": "string", "description": "Also scrape the site-wide 'Popular now' feed (up to about 1,000 videos) or the daily 'Ranking' top 100.", "default": "none" }, "videoUrls": { "title": "Video URLs or BV ids", "type": "array", "description": "Single videos: bilibili.com/video/... URLs, BV ids (BV1...), av ids or b23.tv short links.", "default": [], "items": { "type": "string" } }, "maxResults": { "title": "Max videos per source", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum videos per keyword, per creator and for Popular/Ranking. Search is capped by Bilibili at about 1,000 results per keyword.", "default": 20 }, "sortOrder": { "title": "Search sort order", "enum": [ "totalrank", "click", "pubdate", "dm", "stow" ], "type": "string", "description": "How keyword search results are ordered.", "default": "totalrank" }, "includeDetails": { "title": "Full stats for every video", "type": "boolean", "description": "Fetch each video's detail: coins, shares, tags and the creator's follower count. Turn off for faster list-only data (some fields will be empty).", "default": true }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Also return comments for each video as separate items (type 'comment'), charged per comment.", "default": false }, "maxComments": { "title": "Max comments per video", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Upper limit of comments per video when comments are on.", "default": 20 }, "commentSort": { "title": "Comment order", "enum": [ "hot", "time" ], "type": "string", "description": "Hot (most liked first) or newest first.", "default": "hot" }, "includeSubReplies": { "title": "Include replies to comments", "type": "boolean", "description": "Also return the replies Bilibili shows under each comment (counted toward the comment limit).", "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 } } } } } } } } } }