Aniwatch API

A free restful API serving anime information from hianime.to

Bug report · Feature request

Note

The API has shifted to version 2, thereby naturally introducing breaking changes. If you'd want to use the previous version of this API, then refer to the last stable version.

Important

https://api-aniwatch.onrender.com is only meant to demo the API and has rate-limiting enabled to minimise bandwidth consumption. It is recommended to deploy your own instance for personal use by customizing the api as you need it to be.
This API is just an unofficial api for hianime.to and is in no other way officially related to the same.
The content that this api provides is not mine, nor is it hosted by me. These belong to their respective owners. This api just demonstrates how to build an api that scrapes websites and uses their content.

💻 Installation

Local

Clone the repository and move into the directory.

git clone https://github.com/ghoshRitesh12/aniwatch-api.git
cd aniwatch-api

Install all the dependencies.
```
npm i #or yarn install or pnpm i
```
Start the server!
```
npm start #or yarn start or pnpm start
```
Now the server should be running on http://localhost:4000

Docker

Docker image is available at GitHub Container Registry.

Run the following commands to pull and run the docker image.

docker pull ghcr.io/ghoshritesh12/aniwatch
docker run -p 4000:4000 ghcr.io/ghoshritesh12/aniwatch

The above command will start the server on port 4000. You can access the server at http://localhost:4000 and you can also change the port by changing the -p option to -p <port>:4000.

You can also add the -d flag to run the container in detached mode.

⚙️ Envs

More info can be found in .env.example file

ANIWATCH_API_PORT: port number of the aniwatch api
ANIWATCH_API_WINDOW_MS: duration to track requests for rate limitting (in milliseconds)
ANIWATCH_API_MAX_REQS: maximum number of requests in the ANIWATCH_API_WINDOW_MS timeperiod
ANIWATCH_API_CORS_ALLOWED_ORIGINS: allowed origins, separated by commas and no spaces in between
ANIWATCH_VERCEL_DEPLOYMENT: required for distinguishing vercel deployment from other ones, set it to true of any other non-zero value
ANIWATCH_API_HOSTNAME: set this to your api instance's hostname to enable rate limitting, don't have this value if you don't wish to rate limit

⛅ Host your instance

Caution

For personal deployments:

If you wanna have rate limitting in your application, then set the ANIWATCH_API_HOSTNAME env to your deployed instance's hostname, otherwise don't set or have this env at all. If you set this env to an incorrect value, you may face other issues.
Remove the if block from the server.ts file, spanning from lines 71 to 83.

Vercel

Deploy your own instance of Aniwatch API on Vercel.

Note

When deploying to vercel, set an env named ANIWATCH_VERCEL_DEPLOYMENT to true or any non-zero value, but this env must be present.

Render

Deploy your own instance of Aniwatch API on Render.

📚 Documentation

The endpoints exposed by the api are listed below with examples that uses the Fetch API, but you can use any http library.

`GET` Anime Home Page

Endpoint

/api/v2/hianime/home

Request sample

const resp = await fetch("/api/v2/hianime/home");
const data = await resp.json();
console.log(data);

Response Schema

{
  success: true,
  data: {
    genres: ["Action", "Cars", "Adventure", ...],
    latestEpisodeAnimes: [
      {
        id: string,
        name: string,
        poster: string,
        type: string,
        episodes: {
          sub: number,
          dub: number,
        }
      },
      {...},
    ],
    spotlightAnimes: [
      {
        id: string,
        name: string,
        jname: string,
        poster: string,
        description: string,
        rank: number,
        otherInfo: string[],
        episodes: {
          sub: number,
          dub: number,
        },
      },
      {...},
    ],
    top10Animes: {
      today: [
        {
          episodes: {
            sub: number,
            dub: number,
          },
          id: string,
          name: string,
          poster: string,
          rank: number
        },
        {...},
      ],
      month: [...],
      week: [...]
    },
    topAiringAnimes: [
      {
        id: string,
        name: string,
        jname: string,
        poster: string,
      },
      {...},
    ],
    topUpcomingAnimes: [
      {
        id: string,
        name: string,
        poster: string,
        duration: string,
        type: string,
        rating: string,
        episodes: {
          sub: number,
          dub: number,
        }
      },
      {...},
    ],
    trendingAnimes: [
      {
        id: string,
        name: string,
        poster: string,
        rank: number,
      },
      {...},
    ],
    mostPopularAnimes: [
      {
        id: string,
        name: string,
        poster: string,
        type: string,
        episodes: {
          sub: number,
          dub: number,
        }
      },
      {...},
    ],
    mostFavoriteAnimes: [
      {
        id: string,
        name: string,
        poster: string,
        type: string,
        episodes: {
          sub: number,
          dub: number,
        }
      },
      {...},
    ],
    latestCompletedAnimes: [
      {
        id: string,
        name: string,
        poster: string,
        type: string,
        episodes: {
          sub: number,
          dub: number,
        }
      },
      {...},
    ],
  }
}

🔼 Back to Top

`GET` Anime About Info

Endpoint

/api/v2/hianime/anime/{animeId}

Query Parameters

Parameter	Type	Description	Required?	Default
`animeId`	string	The unique anime id (in kebab case).	Yes	--

Request sample

const resp = await fetch("/api/v2/hianime/anime/attack-on-titan-112");
const data = await resp.json();
console.log(data);

Response Schema

{
  success: true,
  data: {
    anime: [
      info: {
        id: string,
        name: string,
        poster: string,
        description: string,
        stats: {
          rating: string,
          quality: string,
          episodes: {
            sub: number,
            dub: number
          },
          type: string,
          duration: string
        },
        promotionalVideos: [
          {
            title: string | undefined,
            source: string | undefined,
            thumbnail: string | undefined
          },
          {...},
        ],
        characterVoiceActor: [
          {
            character: {
              id: string,
              poster: string,
              name: string,
              cast: string
            },
            voiceActor: {
              id: string,
              poster: string,
              name: string,
              cast: string
            }
          },
          {...},
        ]
      }
      moreInfo: {
        aired: string,
        genres: ["Action", "Mystery", ...],
        status: string,
        studios: string,
        duration: string
        ...
      }
    ],
    mostPopularAnimes: [
      {
        episodes: {
          sub: number,
          dub: number,
        },
        id: string,
        jname: string,
        name: string,
        poster: string,
        type: string
      },
      {...},
    ],
    recommendedAnimes: [
      {
        id: string,
        name: string,
        poster: string,
        duration: string,
        type: string,
        rating: string,
        episodes: {
          sub: number,
          dub: number,
        }
      },
      {...},
    ],
    relatedAnimes: [
      {
        id: string,
        name: string,
        poster: string,
        duration: string,
        type: string,
        rating: string,
        episodes: {
          sub: number,
          dub: number,
        }
      },
      {...},
    ],
    seasons: [
      {
        id: string,
        name: string,
        title: string,
        poster: string,
        isCurrent: boolean
      },
      {...}
    ]
  }
}

🔼 Back to Top

`GET` Search Results

Endpoint

# basic example
/api/v2/hianime/search?q={query}&page={page}

# advanced example
/api/v2/hianime/search?q={query}&page={page}&genres={genres}&type={type}&sort={sort}&season={season}&language={sub_or_dub}&status={status}&rated={rating}&start_date={yyyy-mm-dd}&end_date={yyyy-mm-dd}&score={score}

Query Parameters

Parameter	Type	Description	Required?	Default
`q`	string	The search query, i.e. the title of the item you are looking for.	Yes	--
`page`	number	The page number of the result.	No	`1`
`type`	string	Type of the anime. eg: `movie`	No	--
`status`	string	Status of the anime. eg: `finished-airing`	No	--
`rated`	string	Rating of the anime. eg: `r+` or `pg-13`	No	--
`score`	string	Score of the anime. eg: `good` or `very-good`	No	--
`season`	string	Season of the aired anime. eg: `spring`	No	--
`language`	string	Language category of the anime. eg: `sub` or `sub-&-dub`	No	--
`start_date`	string	Start date of the anime(yyyy-mm-dd). eg: `2014-10-2`	No	--
`end_date`	string	End date of the anime(yyyy-mm-dd). eg: `2010-12-4`	No	--
`sort`	string	Order of sorting the anime result. eg: `recently-added`	No	--
`genres`	string	Genre of the anime, separated by commas. eg: `isekai,shounen`	No	--

[!TIP] For both start_date and end_date, year must be mentioned. If you wanna omit date or month specify 0 instead. Eg: omitting date -> 2014-10-0, omitting month -> 2014-0-12, omitting both -> 2014-0-0

Request sample

// basic example
const resp = await fetch("/api/v2/hianime/search?q=titan&page=1");
const data = await resp.json();
console.log(data);

// advanced example
const resp = await fetch(
  "/api/v2/hianime/search?q=girls&genres=action,adventure&type=movie&sort=score&season=spring&language=dub&status=finished-airing&rated=pg-13&start_date=2014-0-0&score=good"
);
const data = await resp.json();
console.log(data);

Response Schema

{
  success: true,
  data: {
    animes: [
      {
        id: string,
        name: string,
        poster: string,
        duration: string,
        type: string,
        rating: string,
        episodes: {
          sub: number,
          dub: number,
        }
      },
      {...},
    ],
    mostPopularAnimes: [
      {
        episodes: {
          sub: number,
          dub: number,
        },
        id: string,
        jname: string,
        name: string,
        poster: string,
        type: string
      },
      {...},
    ],
    currentPage: 1,
    totalPages: 1,
    hasNextPage: false,
    searchQuery: string,
    searchFilters: {
      [filter_name]: [filter_value]
      ...
    }
  }
}

🔼 Back to Top

`GET` Search Suggestions

Endpoint

/api/v2/hianime/search/suggestion?q={query}

Query Parameters

Parameter	Type	Description	Required?	Default
`q`	string	The search suggestion query.	Yes	--

Request sample

const resp = await fetch("/api/v2/hianime/search/suggestion?q=monster");
const data = await resp.json();
console.log(data);

Response Schema

{
  success: true,
  data: {
    suggestions: [
      {
        id: string,
        name: string,
        poster: string,
        jname: string,
        moreInfo: ["Jan 21, 2022", "Movie", "17m"]
      },
      {...},
    ]
  }
}

🔼 Back to Top

`GET` Producer Animes

Endpoint

/api/v2/hianime/producer/{name}?page={page}

Path Parameters

Parameter	Type	Description	Required?	Default
`name`	string	The name of anime producer (in kebab case).	Yes	--

Query Parameters

Parameter	Type	Description	Required?	Default
`page`	number	The page number of the result.	No	`1`

Request sample

const resp = await fetch("/api/v2/hianime/producer/toei-animation?page=2");
const data = await resp.json();
console.log(data);

Response Schema

{
  success: true,
  data: {
    producerName: "Toei Animation Anime",
    animes: [
      {
        id: string,
        name: string,
        poster: string,
        duration: string,
        type: string,
        rating: string,
        episodes: {
          sub: number,
          dub: number,
        }
      },
      {...},
    ],
    top10Animes: {
      today: [
        {
          episodes: {
            sub: number,
            dub: number,
          },
          id: string,
          name: string,
          poster: string,
          rank: number
        },
        {...},
      ],
      month: [...],
      week: [...]
    },
    topAiringAnimes: [
      {
        episodes: {
          sub: number,
          dub: number,
        },
        id: string,
        jname: string,
        name: string,
        poster: string,
        type: string
      },
      {...},
    ],
    currentPage: 2,
    totalPages: 11,
    hasNextPage: true
  }
}

🔼 Back to Top

`GET` Genre Animes

Endpoint

/api/v2/hianime/genre/{name}?page={page}

Path Parameters

Parameter	Type	Description	Required?	Default
`name`	string	The name of anime genre (in kebab case).	Yes	--

Query Parameters

Parameter	Type	Description	Required?	Default
`page`	number	The page number of the result.	No	`1`

Request sample

const resp = await fetch("/api/v2/hianime/genre/shounen?page=2");
const data = await resp.json();
console.log(data);

Response Schema

{
  success: true,
  data: {
    genreName: "Shounen Anime",
    animes: [
      {
        id: string,
        name: string,
        poster: string,
        duration: string,
        type: string,
        rating: string,
        episodes: {
          sub: number,
          dub: number,
        }
      },
      {...},
    ],
    genres: ["Action", "Cars", "Adventure", ...],
    topAiringAnimes: [
      {
        episodes: {
          sub: number,
          dub: number,
        },
        id: string,
        jname: string,
        name: string,
        poster: string,
        type: string
      },
      {...},
    ],
    currentPage: 2,
    totalPages: 38,
    hasNextPage: true
  }
}

🔼 Back to Top

`GET` Category Animes

Endpoint

/api/v2/hianime/category/{name}?page={page}

Path Parameters

Parameter	Type	Description	Required?	Default
`category`	string	The category of anime.	Yes	--

Query Parameters

Parameter	Type	Description	Required?	Default
`page`	number	The page number of the result.	No	`1`

Request sample

// categories -> "most-favorite", "most-popular", "subbed-anime", "dubbed-anime", "recently-updated", "recently-added", "top-upcoming", "top-airing", "movie", "special", "ova", "ona", "tv", "completed"

const resp = await fetch("/api/v2/hianime/category/tv?page=2");
const data = await resp.json();
console.log(data);

Response Schema

{
  success: true,
  data: {
    category: "TV Series Anime",
    animes: [
      {
        id: string,
        name: string,
        poster: string,
        duration: string,
        type: string,
        rating: string,
        episodes: {
          sub: number,
          dub: number,
        }
      },
      {...},
    ],
    genres: ["Action", "Cars", "Adventure", ...],
    top10Animes: {
      today: [
        {
          episodes: {
            sub: number,
            dub: number,
          },
          id: string,
          name: string,
          poster: string,
          rank: number
        },
        {...},
      ],
      month: [...],
      week: [...]
    },
    currentPage: 2,
    totalPages: 100,
    hasNextPage: true
  }
}

🔼 Back to Top

`GET` Estimated Schedules

Endpoint

/api/v2/hianime/schedule?date={date}

Query Parameters

Parameter	Type	Description	Required?	Default
`date (yyyy-mm-dd)`	string	The date of the desired schedule. (months & days must have 2 digits)	Yes	--

Request sample

const resp = await fetch("/api/v2/hianime/schedule?date=2024-06-09");
const data = await resp.json();
console.log(data);

Response Schema

{
  success: true,
  data: {
    scheduledAnimes: [
      {
        id: string,
        time: string, // 24 hours format
        name: string,
        jname: string,
        airingTimestamp: number,
        secondsUntilAiring: number
      },
      {...}
    ]
  }
}

🔼 Back to Top

`GET` Anime Episodes

Endpoint

/api/v2/hianime/anime/{animeId}/episodes

Path Parameters

Parameter	Type	Description	Required?	Default
`animeId`	string	The unique anime id.	Yes	--

Request sample

const resp = await fetch("/api/v2/hianime/anime/steinsgate-3/episodes");
const data = await resp.json();
console.log(data);

Response Schema

{
  success: true,
  data: {
    totalEpisodes: 24,
    episodes: [
      {
        number: 1,
        title: "Turning Point",
        episodeId: "steinsgate-3?ep=213"
        isFiller: false,
      },
      {...}
    ]
  }
}

🔼 Back to Top

`GET` Anime Episode Servers

Endpoint

/api/v2/hianime/episode/servers?animeEpisodeId={id}

Query Parameters

Parameter	Type	Description	Required?	Default
`animeEpisodeId`	string	The unique anime episode id.	Yes	--

Request sample

const resp = await fetch(
  "/api/v2/hianime/episode/servers?animeEpisodeId=steinsgate-0-92?ep=2055"
);
const data = await resp.json();
console.log(data);

Response Schema

{
  success: true,
  data: {
    episodeId: "steinsgate-0-92?ep=2055",
    episodeNo: 5,
    sub: [
      {
        serverId: 4,
        serverName: "vidstreaming",
      },
      {...}
    ],
    dub: [
      {
        serverId: 1,
        serverName: "megacloud",
      },
      {...}
    ],
    raw: [
      {
        serverId: 1,
        serverName: "megacloud",
      },
      {...}
    ]
  }
}

🔼 Back to Top

`GET` Anime Episode Streaming Links

Endpoint

/api/v2/hianime/episode/sources?animeEpisodeId={id}?server={server}&category={dub || sub || raw}

Query Parameters

Parameter	Type	Description	Required?	Default
`animeEpisodeId`	string	The unique anime episode id.	Yes	--
`server`	string	The name of the server.	No	`"hd-1"`
`category`	string	The category of the episode ('sub', 'dub' or 'raw').	No	`"sub"`

Request sample

const resp = await fetch(
  "/api/v2/hianime/episode/sources?animeEpisodeId=steinsgate-3?ep=230&server=hd-1&category=dub"
);
const data = await resp.json();
console.log(data);

Response Schema

{
  success: true,
  data: {
    headers: {
      Referer: string,
      "User-Agent": string,
      ...
    },
    sources: [
      {
        url: string, // .m3u8 hls streaming file
        isM3U8: boolean,
        quality?: string,
      },
      {...}
    ],
    subtitles: [
      {
        lang: "English",
        url: string, // .vtt subtitle file
      },
      {...}
    ],
    anilistID: number | null,
    malID: number | null
  }
}

🔼 Back to Top

👨‍💻 Development

Pull requests and stars are always welcome. If you encounter any bug or want to add a new feature to this api, consider creating a new issue. If you wish to contribute to this project, read the CONTRIBUTING.md file.

✨ Contributors

Thanks to the following people for keeping this project alive and relevant.

🤝 Thanks

🙌 Support

Don't forget to leave a star 🌟. You can also follow me on X (Twitter) @riteshgsh.

📜 License

This project is licensed under the MIT License - see the LICENSE file for more details.

Name		Name	Last commit message	Last commit date
Latest commit History 473 Commits
.github		.github
.husky		.husky
api		api
public		public
src		src
test		test
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.env.example		.env.example
.gitignore		.gitignore
.prettierignore		.prettierignore
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
package.json		package.json
prettier.config.mjs		prettier.config.mjs
render.yaml		render.yaml
tsconfig.json		tsconfig.json
vercel.json		vercel.json
vitest.config.ts		vitest.config.ts

License

BravinJoshua/aniwatch-api

Folders and files

Latest commit

History

Repository files navigation

Aniwatch API

Table of Contents

💻 Installation

Local

Docker

⚙️ Envs

⛅ Host your instance

Vercel

Render

📚 Documentation

GET Anime Home Page

Endpoint

Request sample

Response Schema

GET Anime About Info

Endpoint

Query Parameters

Request sample

Response Schema

GET Search Results

Endpoint

Query Parameters

Request sample

Response Schema

GET Search Suggestions

Endpoint

Query Parameters

Request sample

Response Schema

GET Producer Animes

Endpoint

Path Parameters

Query Parameters

Request sample

Response Schema

GET Genre Animes

Endpoint

Path Parameters

Query Parameters

Request sample

Response Schema

GET Category Animes

Endpoint

Path Parameters

Query Parameters

Request sample

Response Schema

GET Estimated Schedules

Endpoint

Query Parameters

Request sample

Response Schema

GET Anime Episodes

Endpoint

Path Parameters

Request sample

Response Schema

GET Anime Episode Servers

Endpoint

Query Parameters

Request sample

Response Schema

GET Anime Episode Streaming Links

Endpoint

Query Parameters

Request sample

Response Schema

👨‍💻 Development

✨ Contributors

🤝 Thanks

🙌 Support

📜 License

About

Resources

`GET` Anime Home Page

`GET` Anime About Info

`GET` Search Results

`GET` Search Suggestions

`GET` Producer Animes

`GET` Genre Animes

`GET` Category Animes

`GET` Estimated Schedules

`GET` Anime Episodes

`GET` Anime Episode Servers

`GET` Anime Episode Streaming Links

Packages