REST API Documentation

Ask us questions in the #api channel in our Discord Server

Error Format

All non-200 responses comes with an error message in the following format:

{
  "code": 400,
  "message": "Some helpful message."
}

GET /api/anime/{id}

Fetch all the vocabulary for a given anime.

Response Format:

{
  "id": "ID",
  "stage": 1,
  "title": {
    "name": "common title"
    "japanese": "japanese title",
    "translation": "english translation"
  },
  "vocabulary": [
    {
      "word": "The given word",
      "hiragana": ["ひら", "がな"],
      "translation": "English Translation"
    },
    ...
  ]
}
    

Explanation for stage: Shows the stage the list is at.

• 1 for very incomplete
• 2 for usable but incomplete
• 3 for mostly complete

In the event the list is considered complete, the stage field is simply absent.

GET /api/search

Search for a specific anime by a query.

Uses URL querystring with the following options:

• query: The query to search. (required)
• partial: If true retrieve a partial data with only the title and id

Response Format:

[
  {
    "id": "ID",
    "title": {
      "name": "common title",
      "japanese": "Japanese title",
      "translation": "English translation"
    },
    "stage": "1",
    "vocabulary": [ ... ]   // Not available in partial mode.
    "vocabulary_length": 56 // Only available in partial mode.
  },
  ...
]

The partial mode is useful when you are implementing a user search function so you don't actually download all the data yet and after a choice is made use the id to request the /api/anime/{id} route to retrieve the full data then.

GET /api/list

Get a quick list of all shows in our database.

[
  { "id": "ID", "title": "Common Title", "length": 56 },
  ...
]