Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jeluchu/monkx

A Kotlin wrapper for MonosChinos
https://github.com/jeluchu/monkx

anime api kotlin monoschinos wrapper

Last synced: about 1 month ago
JSON representation

A Kotlin wrapper for MonosChinos

Awesome Lists containing this project

README

        

![Monkx Banner](https://raw.githubusercontent.com/jeluchu/monkx/develop/assets/monkx.png)
[![Discord Server](https://img.shields.io/discord/460491088004907029.svg?style=flat&logo=discord)](https://discord.gg/2DZHfxv9XN) [![](https://jitpack.io/v/jeluchu/monkx.svg)](https://jitpack.io/#jeluchu/monkx)

Wrapper for [MonosChinos Web](https://monoschinos2.com/) build using Kotlin + Kotlin DSL + Coroutines power 🚀

# Installation
with Gradle
```groovy
repositories {
maven { url 'https://jitpack.io' }
}

dependencies {
implementation("com.github.jeluchu:monkx:1.0.0")
}
```
# Example
```kotlin
fun main() {
val anime = runBlocking { Monkx.getAnime("shigatsu-wa-kimi-no-uso-sub-espanol") }
println(anime.title) // Prints: Shigatsu wa Kimi no Uso
}
```

# Available requests

- **Search:** Using Monkx, you can call the request, `getSearchAnime(anime: String)` and after passing it the query from which you want to obtain information it will return a list.

- **Anime:** Using Monkx, you can call the request, `getAnime(anime: String)` and after passing it the query from which you want to obtain information it will return a object.

- **Servers:** Using Monkx, you can call the request, `getServers(id: String)` and after passing it the query from which you want to obtain information it will return a list with available servers.

- **Last Episodes:** Using Monkx, you can call the request, `getLastEpisodes()` and after calling this method, the request will return a list of all recent episodes.

- **Calendar:** Using Monkx, you can call the request, `getCalendar()` and after calling this method, the request will return a list of all animes in the week.

- **Broadcast:** Using Monkx, you can call the request, `getBroadcast()` and after calling this method, the request will return a list of all animes on air. ***(Note: This request has a delay of 3 seconds per request as it makes requests for all the pages that are available.)***

# Objets

### Search return AnimeSearch object
```kotlin
data class AnimeSearch(
val title: String,
val image: String,
val type: String,
val year: String
)
```

### Anime return AnimeInfo object
```kotlin
data class AnimeInfo(
val title: String,
val image: String,
val cover: String,
val synopsis: String,
val state: String,
val type: String,
val genres: List,
val episodesCount: Int,
val episodes: List
)

// AnimeEpisode is this object
data class AnimeEpisode(
val id: String,
val number: Int
)
```

### Servers return Server object
```kotlin
data class AnimeInfo(
val id: String,
val url: String
)
```

### LastEpisodes return Server object
```kotlin
data class Episode(
val title: String,
val episodeNumber: Int,
val type: String,
val image: String,
val url: String,
val id: String
)
```

### Calendar return WeekCalendar object
```kotlin
data class WeekCalendar(
var monday: List,
var tuesday: List,
var wednesday: List,
var thursday: List,
var friday: List,
var saturday: List,
var sunday: List
)

// AnimeCalendar is this object
data class AnimeCalendar(
val title: String,
val episodeNumber: Int,
val image: String,
val genres: List
)
```

### Broadcast return Broadcast object
```kotlin
data class Broadcast(
val title: String,
val url: String,
val image: String,
val id: String
)
```

# Release
For latest release or to check the changelogs, please check Release tab.

# Contribution
Want to help? I'm very open to contributors so just do it or contact me if you have any question (Discord: jeluchu)