aboutsummaryrefslogtreecommitdiff
path: root/content/docs/mal2go/v4/anime/get-seasonal-anime.md
diff options
context:
space:
mode:
Diffstat (limited to 'content/docs/mal2go/v4/anime/get-seasonal-anime.md')
-rw-r--r--content/docs/mal2go/v4/anime/get-seasonal-anime.md61
1 files changed, 61 insertions, 0 deletions
diff --git a/content/docs/mal2go/v4/anime/get-seasonal-anime.md b/content/docs/mal2go/v4/anime/get-seasonal-anime.md
new file mode 100644
index 0000000..f473a02
--- /dev/null
+++ b/content/docs/mal2go/v4/anime/get-seasonal-anime.md
@@ -0,0 +1,61 @@
+---
+title: "Get seasonal anime list"
+description: "Specify an year and season to get animes from"
+weight: 5
+---
+
+`GetSeasonalAnime` returns a list of animes that released in the specified season and year. Accepted arguments are:
+
+- `year string` Is the max amount of search results to get. Max is 500.
+- `season string` Is the "offset" for the search results. If offset is greater than 0 the first n number of search reults will be ignored.
+Possible seasons:
+ + `winter`
+ + `spring`
+ + `summer`
+ + `fall`
+- `sort string` Wether to include NSFW rated search results
+Possible sorts:
+ + `anime_score`
+ + `anime_num_list_users`
+- `limit int` Is the max amount of results to get. Max is 500.
+- `offset int` Is the "offset" for results. If offset is greater than 0 the first n number of reults will be ignored.
+- `nsfw bool` Wether to include NSFW rated results
+- `fields []string` The fields to include in the response. [Here](/docs/mal2go/v4/anime/types#mal2goanimeanime) is a list of the valid fields. Just using an empty slice (`[]string{}`) will include all the fields.
+
+Example:
+
+``` go
+package main
+
+import (
+ "github.com/MikunoNaka/MAL2Go/v4/anime"
+ "log"
+ "fmt"
+)
+
+func main() {
+ authToken := "YOUR_TOKEN_HERE"
+ myClient := anime.Client {
+ AuthToken: "Bearer " + authToken,
+ }
+
+ year := "2022"
+ season := "spring"
+ sort := "anime_num_list_users"
+ limit, offset := 10, 0
+ nsfw := true // include NSFW results
+ fields := []string{"title"}
+
+ seasonalAnimes, err := myClient.GetSeasonalAnime(year, season, sort, limit, offset, nsfw, fields)
+ if err != nil {
+ log.Fatal(err) // remember kids, always handle errors
+ }
+
+ fmt.Printf("Here are some popular animes from %s, %d\n", seasonalAnimes.Season.Name, seasonalAnimes.Season.Year)
+ for _, i := range seasonalAnimes.Animes {
+ fmt.Println(i.Title)
+ }
+}
+```
+
+Above example prints 10 animes from spring 2022 with the most users.