Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 3.67 KB

README.en.md

File metadata and controls

73 lines (48 loc) · 3.67 KB

🌸 AnimeGarden

version AnimeGarden Deploy Worker CI

English | 简体中文

動漫花園 3-rd party mirror site and Anime Torrent aggregation site.

  • ☁️ Provide API endpoint for developers
  • 📺 View bangumi onair calendar to find your favourite anime easily
  • 🔖 Support Advanced search, i.e. 葬送的芙莉莲 +简体内嵌 fansub:桜都字幕组 type:动画
  • 📙 Generate RSS feed, i.e. 葬送的芙莉莲
  • ⭐ Bookmark management and generate aggregated RSS feed
  • 👷‍♂️ Support AutoBangumi and AnimeSpace

home

API Usage

curl "https://garden.breadio.wiki/api/resources?page=1&pageSize=10"

You can find the interactive Open API document here and more API usage example in scripts/api.http.

If you are using JavaScript / TypeScript, you can just use the API wrapper fetchResources and fetchResourceDetail in package animegarden.

Package Usage

AnimeGarden API client and utils for JavaScript / TypeScript.

npm i animegarden
import { fetchResources } from 'animegarden'

// Fetch the first page of Anime Garden mirror site
const resources = await fetchResources(fetch)

// Fetch all the resources which match some filter conditions
const sakurato = await fetchResources(fetch, { count: -1, fansub: 619 })

Assume your environment has built-in Fetch. If not you can use undici or ofetch.

You can check more filter conditions FilterOptions and usage examples in ./scripts/ directory.

Local Development

Follow CONTRIBUTING.md to setup the environment and start developing.

Related Projects

  • AnimeSpace: Keep following your favourite anime
  • Anitomy: A TypeScript port of Anitomy inspired by AnitomySharp.
  • bgmc: Bangumi Data / API Clients

Credits

License

MIT License © 2023 XLor