Skip to content

Latest commit

 

History

History
287 lines (196 loc) · 13.2 KB

README.md

File metadata and controls

287 lines (196 loc) · 13.2 KB

🌟 Animesage API

Version Status License JavaScript npm Node.js Express

Welcome to the Animesage API documentation. This API provides various endpoints to access anime-related data.

📖 Table of Contents

🌐 Base URL

  • Base URL: https://api.animesage.online/
  • Version 1 Base URL: https://api.animesage.online/api/public/v1/

📚 Endpoints (v1)

1. 🎥 Get Detailed Information About a Specific Anime

  • Endpoint: GET /v1/anime/:animeId/info

  • Description: Retrieve comprehensive details about a specific anime.

  • Path Parameters:

    Parameter Type Required Description
    animeId integer/string Yes The unique identifier for the anime.
  • Query Parameters:

    Parameter Type Default Required Options Description
    idProvider string animesage No animesage anilist mal gogo zoro pahe notifymoe kitsu anidb livechart anisearch animeplanet Specifies the provider of the anime ID.
  • Example:

    curl -X GET "https://api.animesage.online/api/public/v1/anime/1/info?idProvider=anilist"

2. 📺 Get All Episodes Info of a Specific Anime

  • Endpoint: GET /v1/anime/:animeId/episodes

  • Description: Fetch information on all episodes of a specific anime.

  • Path Parameters:

    Parameter Type Required Description
    animeId integer/string Yes The unique identifier for the anime.
  • Query Parameters:

    Parameter Type Default Required Options Description
    idProvider string animesage No animesage anilist mal gogo zoro pahe notifymoe kitsu anidb livechart anisearch animeplanet Specifies the provider of the anime ID.
  • Example:

    curl -X GET "https://api.animesage.online/api/public/v1/anime/1/episodes?idProvider=anilist"

3. 📄 Get All Anime Information by Page

  • Endpoint: GET /v1/anime/info/page/:page

  • Description: Access a paginated list of anime information.

  • Path Parameters:

    Parameter Type Required Description
    page integer Yes The page number to retrieve.
  • Query Parameters:

    Parameter Type Default Required Description
    limit integer 20 No Number of results per page. Min: 1, Max: 50
    year integer No Filter by release year.
    season string No Options: winter spring summer fall
  • Example:

    curl -X GET "https://api.animesage.online/api/public/v1/anime/info/page/1?limit=50&year=2023&season=winter"

4. 🔍 Search for an Anime by Title

  • Endpoint: GET /v1/anime/search-by-title/:title

  • Description: Look up an anime using its title.

  • Path Parameters:

    Parameter Type Required Description
    title string Yes The title of the anime to search for.
  • Query Parameters:

    Parameter Type Default Required Description
    page integer 1 No The page number to retrieve.
    limit integer 20 No Number of results per page. Min: 1, Max: 50
  • Example:

    curl -X GET "https://api.animesage.online/api/public/v1/anime/search-by-title/reincarnated as slime?page=1&limit=50"

5. 🔥 Get Trending Anime

  • Endpoint: GET /v1/anime/trending

  • Description: Discover currently trending anime.

  • Query Parameters:

    Parameter Type Default Required Description
    page integer 1 No The page number to retrieve.
    limit integer 20 No Number of results per page. Min: 1, Max: 50
  • Example:

    curl -X GET "https://api.animesage.online/api/public/v1/anime/trending?page=1&limit=50"

6. 🌟 Get Popular Anime

  • Endpoint: GET /v1/anime/popular

  • Description: Explore popular anime titles.

  • Query Parameters:

    Parameter Type Default Required Description
    page integer 1 No The page number to retrieve.
    limit integer 20 No Number of results per page. Min: 1, Max: 50
  • Example:

    curl -X GET "https://api.animesage.online/api/public/v1/anime/popular?page=1&limit=50"

7. 🎬 Get Stream Links for a Specific Anime Episode

  • Endpoint: GET /v1/anime/:animeId/stream/:episodeNumber

  • Description: Obtain streaming links for a specific episode of an anime.

  • Path Parameters:

    Parameter Type Required Description
    animeId integer/string Yes The unique identifier for the anime.
    episodeNumber integer Yes The episode number.
  • Query Parameters:

    Parameter Type Default Required Options Description
    idProvider string animesage No animesage anilist mal gogo zoro pahe notifymoe kitsu anidb livechart anisearch animeplanet Specifies the provider of the anime ID.
    type string sub-dub No sub dub sub-dub Specifies the type of the episode. Choose sub-dub to get both sub and dub sources. Choose sub to get only sub sources and dub to get only dub sources.
  • Example:

    curl -X GET "https://api.animesage.online/api/public/v1/anime/1/stream/1?idProvider=anilist&type=sub"

8. 🎲 Get a Random Anime

  • Endpoint: GET /v1/anime/random

  • Description: Fetch a random anime title.

  • Query Parameters:

    Parameter Type Default Required Description
    isStreamable boolean false No If true, the anime has streaming links.
  • Example:

    curl -X GET "https://api.animesage.online/api/public/v1/anime/random?isStreamable=true"

9. 📅 Get All Latest Airing Anime

  • Endpoint: GET /v1/anime/latest-anime

  • Description: Access a list of the latest airing anime.

  • Query Parameters:

    Parameter Type Default Required Description
    page integer 1 No The page number to retrieve.
    limit integer 20 No Number of results per page. Min: 1, Max: 50
  • Example:

    curl -X GET "https://api.animesage.online/api/public/v1/anime/latest-anime?page=1&limit=50"

10. 🎬 Get Download Links for a Specific Anime Episode

  • Endpoint: GET /v1/anime/:animeId/download/:episodeNumber

  • Description: Obtain download links for a specific episode of an anime.

  • Path Parameters:

    Parameter Type Required Description
    animeId integer/string Yes The unique identifier for the anime.
    episodeNumber integer Yes The episode number.
  • Query Parameters:

    Parameter Type Default Required Options Description
    idProvider string animesage No animesage anilist mal gogo zoro pahe notifymoe kitsu anidb livechart anisearch animeplanet Specifies the provider of the anime ID.
    type string sub-dub No sub dub sub-dub Specifies the type of the episode. Choose sub-dub to get both sub and dub sources. Choose sub to get only sub sources and dub to get only dub sources.
  • Example:

    curl -X GET "https://api.animesage.online/api/public/v1/anime/171018/download/1?idProvider=anilist&type=sub"

🚦 Rate Limits (v1)

To ensure fair usage and maintain performance, the Animesage API enforces the following rate limits:

🕒 Time Frame 🚀 Requests Allowed 🌟 Description
⏱️ Per Minute 120 requests Maximum number of requests allowed per minute.
⏰ Per Second 10 requests Maximum number of requests allowed per second.

Note: Exceeding these limits will result in a 1-minute timeout from accessing the API. Please ensure your application handles rate limit responses gracefully.

📧 Contact for Higher Rate Limits

If you are a developer creating an app, website, or project and require a higher rate limit, please feel free to contact me at [email protected] for further discussion.

👤 Developer

📖 Documentation

For more detailed documentation, visit Animesage API Docs.

🙏 Thanks/Credits

DMCA

DMCA

📜 License

This project is licensed under the Custom BY-NC License.


© 2024 Animesage-Online. All Rights Reserved.