{ "openapi": "3.0.1", "info": { "title": "Bilibili Scraper", "description": "Scrape Bilibili videos, categories, search results, and creator spaces. Extract titles, stats, tags, and optional creator profiles from public Bilibili pages.", "version": "1.0", "x-build-id": "YIqUDKu3tkSVYb69u" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rigelbytes~bilibili-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rigelbytes-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/rigelbytes~bilibili-scraper/runs": { "post": { "operationId": "runs-sync-rigelbytes-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/rigelbytes~bilibili-scraper/run-sync": { "post": { "operationId": "run-sync-rigelbytes-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Bilibili page URLs to scrape, e.g. \"https://www.bilibili.com/video/BV1Kthg69E9K/\", \"https://space.bilibili.com/390949212\", \"https://www.bilibili.com/movie/\", or \"https://search.bilibili.com/all?keyword=原神\".", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "Keywords to search on Bilibili, e.g. \"原神\", \"LOL\", or \"美食\". Each query is paginated until maxItems is reached.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Built-in Bilibili sections to scrape. Use this instead of (or together with) category URLs.", "items": { "type": "string", "enum": [ "popular", "ranking", "anime", "movie", "tv", "variety", "documentary", "guochuang", "entertainment", "douga", "music", "dance", "game", "knowledge", "tech", "sports", "life", "food", "fashion", "cinephile" ], "enumTitles": [ "Popular", "Ranking (all)", "Anime", "Movies", "TV Dramas", "Variety", "Documentary", "Guochuang (Chinese animation)", "Entertainment", "Douga (animation)", "Music", "Dance", "Games", "Knowledge", "Tech", "Sports", "Life", "Food", "Fashion", "Cinephile" ] }, "default": [] }, "maxItems": { "title": "Max Items", "minimum": 0, "type": "integer", "description": "Maximum number of primary videos from search, URLs, or categories (0 = unlimited). Nested creator videos do not count toward this limit.", "default": 0 }, "scrapeVideoDetails": { "title": "Scrape video details", "type": "boolean", "description": "When enabled, attach a videoDetails object on each primary row (description, tags, coins, favorites, shares). Charged as the video-details event per record. Default is disabled.", "default": false }, "scrapeCreatorVideos": { "title": "Scrape creator videos", "type": "boolean", "description": "When enabled, attach a creatorVideos list on each primary row with that creator's uploads (10 by default; set maxCreatorVideos to 0 for all). Extra uploads do not become new dataset rows. Charged as the creator-videos event per extra upload. Creator space URLs already scrape uploads as primary rows, so this list is not duplicated onto those rows. Default is disabled.", "default": false }, "maxCreatorVideos": { "title": "Max creator videos", "minimum": 0, "type": "integer", "description": "How many uploads to attach in creatorVideos for each creator. Default is 10. Set to 0 to extract all of that creator's videos.", "default": 10 }, "scrapeCreatorStats": { "title": "Scrape creator details", "type": "boolean", "description": "When enabled, attach a creatorDetails object on each primary row (followers, following, video count, level, bio). Charged as the creator-details event per record. Default is disabled.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Residential proxies are recommended for Bilibili.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }