{ "openapi": "3.0.1", "info": { "title": "Bilibili Scraper - Videos, Channels & Stats", "description": "Scrape Bilibili (哔哩哔哩) videos by keyword, a creator's full channel uploads, video URLs or trending: views, likes, coins, favorites, shares, danmaku, comments count, tags, duration and date. HTTP only, no login. US$ 3 per 1,000 videos; failed videos are free.", "version": "0.1", "x-build-id": "PbMn4pGv88EbIYrMv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapewise~bilibili-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapewise-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/scrapewise~bilibili-scraper/runs": { "post": { "operationId": "runs-sync-scrapewise-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/scrapewise~bilibili-scraper/run-sync": { "post": { "operationId": "run-sync-scrapewise-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": { "mode": { "title": "Mode", "enum": [ "search", "video_detail", "user_videos", "popular" ], "type": "string", "description": "What to scrape. Same mode names as other Bilibili scrapers, so you can switch without changing your integration.", "default": "search" }, "searchQuery": { "title": "Search keyword", "type": "string", "description": "Keyword for 'search' mode. Chinese (原神) and English (minecraft) both work." }, "searchQueries": { "title": "More search keywords (optional)", "type": "array", "description": "Extra keywords for 'search' mode. Each keyword gets up to 'Max results' videos; duplicates across keywords are removed.", "items": { "type": "string" } }, "sortOrder": { "title": "Sort order (search)", "enum": [ "totalrank", "click", "pubdate", "dm", "stow", "scores" ], "type": "string", "description": "How Bilibili sorts search results.", "default": "totalrank" }, "durationFilter": { "title": "Duration (search)", "enum": [ "any", "short", "medium", "long", "verylong" ], "type": "string", "description": "Filter search results by video length.", "default": "any" }, "pubtimeBegin": { "title": "Published after (search)", "type": "string", "description": "YYYY-MM-DD, China time. Leave empty for no filter." }, "pubtimeEnd": { "title": "Published before (search)", "type": "string", "description": "YYYY-MM-DD, China time, inclusive. Leave empty for no filter." }, "videoUrls": { "title": "Video URLs or IDs", "type": "array", "description": "For 'video_detail' mode: bilibili.com/video URLs, b23.tv short links, BV ids (BV1P4YX63Eej) or av ids (av117257959120137).", "items": { "type": "string" } }, "userIds": { "title": "Channel IDs or URLs", "type": "array", "description": "For 'user_videos' mode: the creator's numeric id (mid) or channel URL (space.bilibili.com/546195). Returns the full upload list, newest first, up to 'Max results' per channel.", "items": { "type": "string" } }, "includeDetails": { "title": "Full stats and tags", "type": "boolean", "description": "Search, channel and trending lists do not include coins, shares or tags. When on, each video is opened to add them. Same price.", "default": true }, "includeSubtitles": { "title": "Subtitles when public", "type": "boolean", "description": "Adds the video's subtitles when Bilibili serves them without login. Bilibili now hides most subtitles (including AI subtitles) behind login, so expect this to be empty for most videos; 'subtitleStatus' tells you why. Same price.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum videos per keyword or per channel. For 'video_detail' and 'popular' it is the run total. Bilibili search stops at 1,000 results per keyword.", "default": 30 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy is the default and works for Bilibili. Blocked requests are retried on a new IP.", "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 } } }, "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 } } } } } } } } } }