From f23dae307e06d95499b35dbdd8e341b45756b330 Mon Sep 17 00:00:00 2001
From: Vidhu Kant Sharma <vidhukant@vidhukant.xyz>
Date: Tue, 20 Sep 2022 23:11:52 +0530
Subject: First commit

---
 content/docs/mal2go/v4/anime/get-anime-ranking.md | 57 +++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 content/docs/mal2go/v4/anime/get-anime-ranking.md

(limited to 'content/docs/mal2go/v4/anime/get-anime-ranking.md')

diff --git a/content/docs/mal2go/v4/anime/get-anime-ranking.md b/content/docs/mal2go/v4/anime/get-anime-ranking.md
new file mode 100644
index 0000000..6479b6c
--- /dev/null
+++ b/content/docs/mal2go/v4/anime/get-anime-ranking.md
@@ -0,0 +1,57 @@
+---
+title: "Get anime ranking list"
+description: "Returns a list of animes sorted by their rank"
+weight: 4
+---
+
+`GetAnimeRanking` returns a list of animes sorted by their rank. It accepts these arguments:
+
+- `rankingType string` Ranking type can be:
+  + `all`
+  + `airing`
+  + `upcoming`
+  + `tv`
+  + `ova`
+  + `movie`
+  + `special`
+  + `bypopularity`
+  + `favorite`
+- `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,
+  }
+    
+  rankingType := "movie"
+  limit, offset := 10, 0
+  nsfw := true // include NSFW results
+  fields := []string{"title"}
+    
+  ranking, err := myClient.GetAnimeRanking(rankingType, limit, offset, nsfw, fields)
+  if err != nil {
+    log.Fatal(err) // remember kids, always handle errors
+  }
+    
+  for _, i := range ranking {
+    fmt.Printf("#%d: %s\n", i.RankNum, i.Title)
+  }
+}
+```
+
+Above example prints the top 10 ranked anime movies on MyAnimeList.
-- 
cgit v1.2.3