{ "openapi": "3.0.1", "info": { "title": "Bilibili Scraper API - Search, Danmaku, Video Stats, Monitor", "description": "Bilibili (哔哩哔哩, the Chinese YouTube) scraper API, no login: video search with sort and date filters, video stats (views, likes, coins, favorites, shares), tags, danmaku (弹幕) with timestamps, top comments, uploader profiles and popular videos. Monitor mode returns new videos only. $2.49 per 1,000.", "version": "0.1", "x-build-id": "XmAcUVfxUPwytPnzl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reportable_broth~bilibili-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reportable_broth-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/reportable_broth~bilibili-scraper/runs": { "post": { "operationId": "runs-sync-reportable_broth-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/reportable_broth~bilibili-scraper/run-sync": { "post": { "operationId": "run-sync-reportable_broth-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": "Video search, Chinese or English. Up to 1,000 videos per keyword.", "default": [], "items": { "type": "string" } }, "maxVideosPerKeyword": { "title": "Max videos per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Bilibili returns up to 50 pages of 20.", "default": 50 }, "sort": { "title": "Search sort", "enum": [ "relevance", "views", "newest", "danmaku", "favorites", "comments" ], "type": "string", "description": "Search order.", "default": "relevance" }, "duration": { "title": "Video length", "enum": [ "any", "under10", "10to30", "30to60", "over60" ], "type": "string", "description": "Search filter.", "default": "any" }, "publishedAfter": { "title": "Published after (YYYY-MM-DD)", "type": "string", "description": "Search filter, China time. Leave empty for any date." }, "publishedBefore": { "title": "Published before (YYYY-MM-DD)", "type": "string", "description": "Search filter, China time." }, "videoUrls": { "title": "Video URLs", "type": "array", "description": "bilibili.com/video/BV..., av numbers, BV ids or b23.tv short links. Returns full details and tags.", "default": [], "items": { "type": "string" } }, "users": { "title": "Uploader (UP主) profiles", "type": "array", "description": "space.bilibili.com/ or the numeric id. Returns followers, video count, likes received, level and verification.", "default": [], "items": { "type": "string" } }, "popularVideos": { "title": "Popular videos (热门)", "minimum": 0, "maximum": 500, "type": "integer", "description": "How many of Bilibili's current popular videos to return. 0 = off.", "default": 0 }, "fullDetails": { "title": "Full details for search and popular videos", "type": "boolean", "description": "Adds coins, shares, exact duration, tags and the cid for each video (one extra request per video).", "default": false }, "danmakuPerVideo": { "title": "Danmaku (弹幕) per video", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Bullet comments with the second they appear. Applies to EVERY video returned (search, popular and URLs), and each danmaku line is one item - use a small number with big searches. 0 = off.", "default": 0 }, "topComments": { "title": "Top comments per video", "type": "boolean", "description": "The pinned and top comments Bilibili shows without login (usually 3 per video). Applies to every video returned.", "default": false }, "onlyNew": { "title": "Only new items (monitor mode)", "type": "boolean", "description": "Schedule the Actor; each run returns only items earlier runs haven't returned.", "default": false }, "monitorStoreName": { "title": "Monitor memory name", "type": "string", "description": "Runs with the same inputs share memory automatically." }, "requestGapSecs": { "title": "Seconds between requests", "minimum": 0.3, "maximum": 10, "type": "number", "description": "Default 1 s." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "The Actor switches IP automatically when Bilibili pushes back.", "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 } } } } } } } } } }