/bilibili/videos/search

POST /api/bilibili/videos/search

Price: 5 credits

Search Bilibili videos by keyword

How to use it

Search Bilibili videos by keyword, optionally filtered by ordering, video length, content partition and publication date range. Returns video titles, covers, durations, owners and play/like/favorite/comment counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Search keyword (examples: "python"; minLength: 1)
• count integer required — Max number of results (min: 1)
• order string nullable — Result ordering (one of: "comprehensive", "most_played", "newest", "most_danmaku", "most_favorited", "most_commented")
• duration string nullable — Filter by video length (one of: "all", "under_10_min", "from_10_to_30_min", "from_30_to_60_min", "over_60_min")
• partition string nullable — Restrict the search to one content partition (category); omit to search all (one of: "animation", "bangumi", "guochuang", "music", "dance", "game", "knowledge", "tech", "sports", "car", "life", "food", "animal", "kichiku", "fashion", "entertainment", "cinephile", "documentary", "movie", "tv")
• pubtime_begin_s integer nullable — Only return videos published at or after this Unix timestamp (seconds) (min: 0)
• pubtime_end_s integer nullable — Only return videos published at or before this Unix timestamp (seconds) (min: 0)

Response

• @type string (default: "BilibiliSearchVideo")
• id string required
• aid integer nullable
• url string required
• description string nullable
• image string nullable
• duration integer nullable
• tid integer nullable
• tname string nullable
• owner object nullable
  • @type string (default: "BilibiliSearchVideoOwner")
  • id integer nullable
  • name string nullable
  • image string nullable
• play_count integer nullable
• danmaku_count integer nullable
• favorite_count integer nullable
• like_count integer nullable
• reply_count integer nullable
• tags array (default: [])
• is_pay boolean nullable
• published_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.