# MAL2Go/anime
MAL2Go `anime` package has functionality related to getting data about anime.

To *update* anime status (score, status, etc) refer to [`user/anime`](user/anime) package.

## Usage
Firstly, import this package and instanciate the client.
``` go
import (
  "github.com/MikunoNaka/MAL2Go/anime"
)
```

Now instanciate with
``` go
myClient := anime.Client {
  AuthToken: "Bearer " + yourTokenHere,
}
```

- ### Searching for an anime
``` go
searchString := "mushishi" // your search string here

// max amount of results to pull. Max is 500
limit := 10

// if the offset is 2 it will skip the first 2 results, then pull the next 10
offset := 0

// the API by default only returns some basic data
// you can specify some fields as a []string slice.
// it will return the default fields even if they aren't specified
fields := []string{
  "id", "title", "main_picture",
  "alternative_titles", "start_date",
  "end_date", "synopsis", "mean", "rank",
  "popularity", "num_list_users",
  "num_scoring_users", "nsfw", "created_at",
  "updated_at", "media_type", "status",
  "genres", "my_list_status", "num_episodes",
  "start_season", "broadcast", "source",
  "average_episode_duration", "rating",
  "pictures", "background", "related_anime",
  "related_manga", "recommendations",
  "studios", "statistics",
} // for all default fields fields := []string{} will also work

// finally making the API request
searchResults, err := myClient.SearchAnime(searchString, limit, offset, fields)

fmt.Println(searchResults.Animes) // print list of the search results

// results have page numbers
fmt.Println(searchResults.ListPaging.NextPage, searchResults.ListPaging.PrevPage)
```

**More to be added later**

## Structure
- [anime.go](anime/anime.go)
Contains all the exported functions for pulling data from the API.

- [anime.structs.go](anime/anime.structs.go)
Contains all the structs representing an anime entry on MyAnimeList.

- [client.go](anime/client.go)
The Client for accessing the API with this package.

- [general.structs.go](anime/general.structs.go)
Some structs that can't particularly be grouped with another file.

- [ranking.structs.go](anime/ranking.structs.go)
Representing anime ranking data both in the form returned by the API and
the formatted form to be returned by this package.

- [request_handler.go](anime/request_handler.go)
Responsible for making HTTP requests

- [search.structs.go](anime/search.structs.go)
Representing search results.

- [seasonal.structs.go](anime/seasonal.structs.go)
Representing seasonal anime list.

- [suggestedanime.structs.go](anime/suggestedanime.structs.go)
Representing suggested anime data.