Bangumi.tv icon

Bangumi.tv

Interact with the Bangumi.tv API

Actions21

Character → Search

AI-generated

Summary

Search characters using a keyword, optionally including NSFW results if permitted, and control pagination via limit and offset.

Inputs

  • Keyword (required) — The search keyword used to find matching characters.
  • NSFW — Boolean to include NSFW (Not Safe For Work) results in the search; requires appropriate permission.
  • Limit — Maximum number of search results to return, between 1 and 50 (default 50).
  • Offset — Number of search results to skip for pagination, minimum 0 (default 0).

Output shape

a list of character records matching the search criteria

Results are limited by 'Limit' and offset by 'Offset'. NSFW results are included only if permitted and if the parameter is set to true. The search is performed via a POST request to /v0/search/characters, passing the keyword and optional NSFW filter in the request body.

Examples

Example 1: Search for characters related to 'Naruto' with default settings

Set Keyword to 'Naruto', leave NSFW false, Limit and Offset at defaults

Example 2: Search for up to 10 NSFW characters skipping first 5

Set Keyword, NSFW to true, Limit to 10, Offset to 5

Links

Discussion