Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dhanush-git/gogoanime-api

This is a personal project that I am working on... work in progress πŸ‘·β€β™‚οΈ
https://github.com/dhanush-git/gogoanime-api

anime anime-scraper animejs api downloader gogoanime gogoanime-api

Last synced: about 1 month ago
JSON representation

This is a personal project that I am working on... work in progress πŸ‘·β€β™‚οΈ

Awesome Lists containing this project

README

        

# Gogoanime-API v.1🧬
This is a personal project that I am working on 🧰
it is a simple api for scrapping πŸ”ͺ gogoanime.so

**How to use the API ?**

πŸ”’ step 1
```
Download the repo 🟒
```

πŸ”’ step 2
```
npm install
```
this should install πŸ”» all the dependencies required for running this project πŸ“‚



πŸ”’ step 3

```
npm start
```
Now you should get a output similar to this

```
Listening to port 3000
```
πŸ₯³ Yay, our API server is running πŸƒβ€β™‚οΈπŸ’¨

πŸ”’ step 4 : Now visit
```
http://127.0.0.1:3000/
```
and you should be greeted with
```
πŸ‘‹ Hello world🌍, Welcome to πŸ¦„ GogoAnime API 🧬
```

# API Documentation πŸ“‘

*Running on localhost*

**Available routes**

/Popular/:page_no

/NewSeasons/page_no

/getAnime/anime_id

/getEpisode/episode_id

/search/search_query

**GET | Popular Anime 🍿**
```
http://127.0.0.1:3000/Popular/:page
```
>this will return all the popular anime
```
[
{
"name": "anime name",
"img_url": "url",
"anime_id": "anime id"
}
...
]
```

**GET | New Seasons πŸ†•**
```
http://127.0.0.1:3000/NewSeasons/:page
```
>this will return all anime with new seasons available
```
[
{
"name": "anime name",
"img_url": "url",
"anime_id": "anime id"
}
...
]
```
**GET | Anime πŸ•΅οΈβ€β™‚οΈ**
```
http://127.0.0.1:3000/getAnime/:anime_id
```
>this will return the anime **name ,thumbnail image ,about ?** and **episode_id** for all the episodes available for that anime
```
[
{
"name": "anime name",
"img_url": "url",
"about": "Plot Summary: about the anime",
"episode_id":
[
"some-anime-episode-1",
"some-anime-episode-2",
"some-anime-episode-3"
...
]
}
]
```
**GET | Anime Episode πŸ“½**
```
http://127.0.0.1:3000/getEpisode/:episode_id
```
>this will return the downloadable πŸ”» link for the episode
```
[
{
"quality": "watch(360P-mp4)",
"ep_link": "episode url"
}

...
]
```

**GET | Search Anime πŸ“½**
```
http://127.0.0.1:3000/search/:search-query
```
>this will return all the anime related to the search
```
[
{
"name": "anime name",
"img_url": "url",
"anime_id": "anime id"
}

...

]
```



**πŸ’’ Troubleshootings**


This is just a personal project created for study / demonstration purpose and to simplify my working life, it may or may not be a good fit for your project(s).


**❀️ Show your support**


Please ⭐ this repository if you like it or this project helped you!
Feel free to open issues or submit pull-requests to help me improving my work.


**πŸ€– Author**


Dhanush Suvarna