Sign in
search

Get search results.

This endpoint will return search results for the specified query.

get/search

Query parameters

scope'kurozora' | 'library' required

The types used to perform the search.

The scope of the search.

types[]string[] required

The types used to perform the search.

The types used to perform the search.

querystring required
Example:one piece

The search query.

limitstring

The limit on the number of objects, or number of objects in the specified relationship, that are returned. The default value is 25 and the maximum value is 25.

pagestring

The next page or group of objects to fetch. The default value is 1.

Response

Successful GET Search JSON response

object required

Example response

{
  "data": {
    "characters": {
      "data": [
        {
          "id": 7487,
          "uuid": "7487",
          "type": "characters",
          "href": "/v1/characters/krieg"
        },
        {
          "id": 16398,
          "uuid": "16398",
          "type": "characters",
          "href": "/v1/characters/whetton"
        }
      ],
      "next": "/v1/search?query=one%20piece&scope=kurozora&limit=2&types%5B0%5D=characters&page=2"
    },
    "shows": {
      "data": [
        {
          "id": 22598,
          "uuid": "22598",
          "type": "show",
          "href": "/v1/anime/one-piece"
        },
        {
          "id": 13739,
          "uuid": "13739",
          "type": "show",
          "href": "/v1/anime/one-piece-film-gold-cine-mike-popcorn-kokuchi"
        }
      ],
      "next": "/v1/search?query=one%20piece&scope=kurozora&limit=2&types%5B0%5D=shows&page=2"
    },
    "studios": {
      "data": [
        {
          "id": 1345,
          "uuid": "1345",
          "type": "studios",
          "href": "/v1/studios/one-piece-magazine"
        },
        {
          "id": 2334,
          "uuid": "2334",
          "type": "studios",
          "href": "/v1/studios/toei-animation"
        }
      ],
      "next": null
    }
  }
}

Changes

Changed in 5 of the 50 revisions of this API.14