bleach-api

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 13 Open GitHub ↗

This is the API for Bleach Anime.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Bleach Banner](https://raw.githubusercontent.com/ashishk1331/bleach-api/main/banner.png "Banner")

# Bleach API

This api is the live adaption of the Bleach Database.

## Base URL

Thanks to render for their generous free tier which helped me host the api.

```
https://bleach-api-8v2r.onrender.com/
```

## Character type

```ts
export interface Character {
  id: string;
  slug: string;
  name: {
    english: string;
    kanji: string;
    romaji: string;
  };
  description: string;
  avatar: string;
  stats: {
    race: string;
    birthday: string;
    gender: string;
    height: string;
    weight: string;
    ProfessionalStatus: {
      previous_affiliation: string;
      previous_occupation: string;
      previous_team: string;
      partner: string;
      base_of_operations: string[];
    };
    Zanpakutō: {
      resurrección: string;
    };
    FirstAppearance: {
      manga: string;
      anime: string;
    };
    Voices: {
      japanese: string;
      english: string;
    };
  };
  media: {
    source: string;
    alt: string;
  }[];
  quotes: {
    quote: string;
    to: string;
    reference: string | null;
  }[];
}
```

## URL endpoints

List of all available endpoints:

1. `/`
   The root endpoint which generally returns some basic info about the API.

```json
    {
    	"name": "Bleach API",
    	"description": "This is the API for Bleach Anime.",
    	"supports": ["shinigami", "humans", "quincy", "arrancar"],
    	"author": "AshishK1331",
    	"contact": "https://twitter.com/AshishK1331"
    }
    ```

2. `/characters`
   The route returns all the available character types:

```json
    {
    	"types": ["shinigami", "humans", "quincy", "arrancar"]
    }
    ```

3. `/characters/{race}`
   This route returns the list of all characters that belong to the given `race`, which can either be `shinigami`, `humans`, `quincy` or `arrancar`.

```json
    {
    	"shinigami": [
    		"Niko Kuna",
    		"Ikkaku Madarame",
    		"Sajin Komamura",
    		...
    	]
    }
    ```

4. `/characters/{race}/{name}`
   This route returns all the characters in the specified class with their respective data. You can chose any name by first bringing up entire list from the previous route.

```json
    {
    	"results": [
    		{
    			"id": "renji_abarai",
    			"name": {
    				"english": "Renji Abarai",
    				"kanji": "阿散井 恋次",
    				"romaji": "Abarai Renji"
    			},
    			"description": "Renji Abarai (阿散井 恋次, Abarai Renji) is the lieutenant of the 6th Division under Captain Byakuya Kuchiki and is married to Rukia Kuchiki. He formerly served as the 6th Seat of the 11th Division under Kenpachi Zaraki. Renji has brown eyes and long crimson hair, which is usually kept in a high ponytail. As a child, Renji's hairline was leveled. Later, he styled it in a large widow's-peak.",
    			...
    		}
    	]
    }
    ```

5. `/avatar/{race}/{slug}`
   Fetch PNG avatar for the character by defining its `race` and `slug`.
   Example: If you want to get avatar for human `Keigo Asano`, use his slug `keigo-asano` along with the category `humans`.

```bash
   https://bleach-api-8v2r.onrender.com/avatar/humans/keigo-asano
   ```

bleach-api

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README