Skip to content

Client

AniList 

AniList(api_url: str = 'https://graphql.anilist.co', *, client: Client | None = None)

AniList API client.

Parameters:

Name Type Description Default
api_url str

The URL of the AniList API.

 'https://graphql.anilist.co'
client Client | None

An httpx.Client instance used to make requests to AniList.

 None
Source code in src/pyanilist/_client.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
def __init__(self, api_url: str = "https://graphql.anilist.co", *, client: Client | None = None) -> None:
    """
    AniList API client.

    Parameters
    ----------
    api_url : str, optional
        The URL of the AniList API.
    client : Client | None, optional
        An [`httpx.Client`](https://www.python-httpx.org/api/#client) instance used to make requests to AniList.

    """
    self._api_url = api_url
    self._client = (
        Client(headers={"Referer": "https://anilist.co", "user-agent": f"pyanilist/{__version__}"})
        if client is None
        else client
    )

close 

close() -> None

Close the underlying HTTP connection.

Source code in src/pyanilist/_client.py 
62
63
64
def close(self) -> None:
    """Close the underlying HTTP connection."""
    self._client.close()

get_airing_schedule 

get_airing_schedule(media: int | str | Media, *, not_yet_aired: bool | None = None) -> Iterator[AiringSchedule]

Retrieve the airing schedule for a given Media object or ID.

Parameters:

Name Type Description Default
media int | str | Media

The media to get the airing schedule for. Can be an ID (int), a URL (str), or a Media object.

 required
not_yet_aired bool | None

Filter results to only include episodes that have not yet aired (True), exclude unaired episodes (False), or include all episodes (None).

 None

Yields:

Type Description
AiringSchedule
Source code in src/pyanilist/_client.py 
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
def get_airing_schedule(
    self,
    media: int | str | Media,
    *,
    not_yet_aired: bool | None = None,
) -> Iterator[AiringSchedule]:
    """
    Retrieve the airing schedule for a given `Media` object or ID.

    Parameters
    ----------
    media : int | str | Media
        The media to get the airing schedule for. Can be an ID (`int`), a URL (`str`), or a `Media` object.
    not_yet_aired : bool | None, optional
        Filter results to only include episodes that have not yet aired (`True`),
        exclude unaired episodes (`False`), or include all episodes (`None`).

    Yields
    ------
    AiringSchedule

    """
    variables: dict[str, Any] = {"mediaId": resolve_media_id(media)}

    if not_yet_aired is not None:  # pragma: no cover
        variables["notYetAired"] = not_yet_aired

    schedules = self._post(query=AIRING_SCHEDULE_QUERY, variables=variables)["airingSchedule"]["nodes"]

    for schedule in schedules:
        yield AiringSchedule.model_validate(schedule)

get_characters 

get_characters(media: int | str | Media, *, sort: Iterable[CharacterSort] | CharacterSort | None = None, role: CharacterRole | None = None) -> Iterator[Character]

Retrieve characters associated with a given Media object or ID.

Parameters:

Name Type Description Default
media int | str | Media

The media to get characters for. Can be an ID (int), a URL (str), or a Media object.

 required
sort Iterable[CharacterSort] | CharacterSort | None

Sorting criteria for the characters.

 None
role CharacterRole | None

Filter characters by their role in the media. If None, no filtering is applied.

 None

Yields:

Type Description
Character
Source code in src/pyanilist/_client.py 
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
def get_characters(
    self,
    media: int | str | Media,
    *,
    sort: Iterable[CharacterSort] | CharacterSort | None = None,
    role: CharacterRole | None = None,
) -> Iterator[Character]:
    """
    Retrieve characters associated with a given `Media` object or ID.

    Parameters
    ----------
    media : int | str | Media
        The media to get characters for. Can be an ID (`int`), a URL (`str`), or a `Media` object.
    sort : Iterable[CharacterSort] | CharacterSort | None, optional
        Sorting criteria for the characters.
    role : CharacterRole | None, optional
        Filter characters by their role in the media. If `None`, no filtering is applied.

    Yields
    ------
    Character

    """
    variables: dict[str, Any] = {"mediaId": resolve_media_id(media)}

    match sort:  # pragma: no cover
        case CharacterSort():
            variables["sort"] = [sort]
        case Iterable():
            variables["sort"] = sort
        case None:
            pass
        case _:
            assert_never(sort)

    if role is not None:  # pragma: no cover
        variables["role"] = role

    characters = self._post(query=CHARACTERS_QUERY, variables=variables)["characters"]["edges"]

    for character in characters:
        yield Character.model_validate(
            {"role": character["role"], "voiceActors": character["voiceActors"], **character["node"]}
        )

get_media 

get_media(search: str | None = None, *, id: int | None = None, id_mal: int | None = None, start_date: int | None = None, end_date: int | None = None, season: MediaSeason | None = None, season_year: int | None = None, type: MediaType | None = None, format: MediaFormat | None = None, status: MediaStatus | None = None, episodes: int | None = None, chapters: int | None = None, duration: int | None = None, volumes: int | None = None, is_adult: bool | None = None, genre: str | None = None, tag: str | None = None, minimum_tag_rank: int | None = None, tag_category: str | None = None, licensed_by: str | None = None, licensed_by_id: int | None = None, average_score: int | None = None, popularity: int | None = None, source: MediaSource | None = None, country_of_origin: str | None = None, is_licensed: bool | None = None, id_not: int | None = None, id_in: Iterable[int] | None = None, id_not_in: Iterable[int] | None = None, id_mal_not: int | None = None, id_mal_in: Iterable[int] | None = None, id_mal_not_in: Iterable[int] | None = None, start_date_greater: int | None = None, start_date_lesser: int | None = None, start_date_like: str | None = None, end_date_greater: int | None = None, end_date_lesser: int | None = None, end_date_like: str | None = None, format_in: Iterable[MediaFormat] | None = None, format_not: MediaFormat | None = None, format_not_in: Iterable[MediaFormat] | None = None, status_in: Iterable[MediaStatus] | None = None, status_not: MediaStatus | None = None, status_not_in: Iterable[MediaStatus] | None = None, episodes_greater: int | None = None, episodes_lesser: int | None = None, duration_greater: int | None = None, duration_lesser: int | None = None, chapters_greater: int | None = None, chapters_lesser: int | None = None, volumes_greater: int | None = None, volumes_lesser: int | None = None, genre_in: Iterable[str] | None = None, genre_not_in: Iterable[str] | None = None, tag_in: Iterable[str] | None = None, tag_not_in: Iterable[str] | None = None, tag_category_in: Iterable[str] | None = None, tag_category_not_in: Iterable[str] | None = None, licensed_by_in: Iterable[str] | None = None, licensed_by_id_in: Iterable[int] | None = None, average_score_not: int | None = None, average_score_greater: int | None = None, average_score_lesser: int | None = None, popularity_not: int | None = None, popularity_greater: int | None = None, popularity_lesser: int | None = None, source_in: Iterable[MediaSource] | None = None, sort: Iterable[MediaSort] | None = None) -> Media

Search for media on AniList based on the provided parameters.

Parameters:

Name Type Description Default
search str | None

Filter by search query.

 None
id int | None

Filter by the media id.

 None
id_mal int | None

Filter by the media's MyAnimeList id.

 None
start_date int | None

Filter by the start date of the media. Must be an 8 digit long date integer (YYYYMMDD). Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500.

 None
end_date int | None

Filter by the end date of the media.

 None
season MediaSeason | None

Filter by the season the media was released in.

 None
season_year int | None

The year of the season (Winter 2017 would also include December 2016 releases). Requires season argument.

 None
type MediaType | None

Filter by the media's type.

 None
format MediaFormat | None

Filter by the media's format.

 None
status MediaStatus | None

Filter by the media's current release status.

 None
episodes int | None

Filter by amount of episodes the media has.

 None
chapters int | None

Filter by the media's episode length.

 None
duration int | None

Filter by the media's chapter count.

 None
volumes int | None

Filter by the media's volume count.

 None
is_adult bool | None

Filter by if the media's intended for 18+ adult audiences.

 None
genre str | None

Filter by the media's genres.

 None
tag str | None

Filter by the media's tags.

 None
minimum_tag_rank int | None

Only apply the tags filter argument to tags above this rank. Default: 18.

 None
tag_category str | None

Filter by the media's tags within a tag category.

 None
licensed_by str | None

Filter media by sites name with a online streaming or reading license.

 None
licensed_by_id int | None

Filter media by sites id with a online streaming or reading license.

 None
average_score int | None

Filter by the media's average score.

 None
popularity int | None

Filter by the number of users with this media on their list.

 None
source MediaSource | None

Filter by the source type of the media.

 None
country_of_origin str | None

Filter by the media's country of origin.

 None
is_licensed bool | None

If the media is officially licensed or a self-published doujin release.

 None
id_not int | None

Filter by the media id.

 None
id_in Iterable[int] | None

Filter by the media id.

 None
id_not_in Iterable[int] | None

Filter by the media id.

 None
id_mal_not int | None

Filter by the media's MyAnimeList id.

 None
id_mal_in Iterable[int] | None

Filter by the media's MyAnimeList id.

 None
id_mal_not_in Iterable[int] | None

Filter by the media's MyAnimeList id.

 None
start_date_greater int | None

Filter by the start date of the media. Must be an 8 digit long date integer (YYYYMMDD). Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500.

 None
start_date_lesser int | None

Filter by the start date of the media. Must be an 8 digit long date integer (YYYYMMDD). Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500.

 None
start_date_like str | None

Filter by the start date of the media.

 None
end_date_greater int | None

Filter by the end date of the media. Must be an 8 digit long date integer (YYYYMMDD). Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500.

 None
end_date_lesser int | None

Filter by the end date of the media. Must be an 8 digit long date integer (YYYYMMDD). Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500.

 None
end_date_like str | None

Filter by the end date of the media.

 None
format_in Iterable[MediaFormat] | None

Filter by the media's format.

 None
format_not MediaFormat | None

Filter by the media's format.

 None
format_not_in Iterable[MediaFormat] | None

Filter by the media's format.

 None
status_in Iterable[MediaStatus] | None

Filter by the media's current release status.

 None
status_not MediaStatus | None

Filter by the media's current release status.

 None
status_not_in Iterable[MediaStatus] | None

Filter by the media's current release status.

 None
episodes_greater int | None

Filter by amount of episodes the media has.

 None
episodes_lesser int | None

Filter by amount of episodes the media has.

 None
duration_greater int | None

Filter by the media's episode length.

 None
duration_lesser int | None

Filter by the media's episode length.

 None
chapters_greater int | None

Filter by the media's chapter count.

 None
chapters_lesser int | None

Filter by the media's chapter count.

 None
volumes_greater int | None

Filter by the media's volume count.

 None
volumes_lesser int | None

Filter by the media's volume count.

 None
genre_in Iterable[str] | None

Filter by the media's genres.

 None
genre_not_in Iterable[str] | None

Filter by the media's genres.

 None
tag_in Iterable[str] | None

Filter by the media's tags.

 None
tag_not_in Iterable[str] | None

Filter by the media's tags.

 None
tag_category_in Iterable[str] | None

Filter by the media's tags within a tag category.

 None
tag_category_not_in Iterable[str] | None

Filter by the media's tags within a tag category.

 None
licensed_by_in Iterable[str] | None

Filter media by sites name with a online streaming or reading license.

 None
licensed_by_id_in Iterable[int] | None

Filter media by sites id with a online streaming or reading license.

 None
average_score_not int | None

Filter by the media's average score.

 None
average_score_greater int | None

Filter by the media's average score.

 None
average_score_lesser int | None

Filter by the media's average score.

 None
popularity_not int | None

Filter by the number of users with this media on their list.

 None
popularity_greater int | None

Filter by the number of users with this media on their list.

 None
popularity_lesser int | None

Filter by the number of users with this media on their list.

 None
source_in Iterable[MediaSource] | None

Filter by the source type of the media.

 None
sort Iterable[MediaSort] | None

The order the results will be returned in.

 None

Raises:

Type Description
HTTPStatusError

AniList returned a non 2xx response.

Returns:

Type Description
Media

A Media object representing the retrieved media information.
Source code in src/pyanilist/_client.py 
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
def get_media(
    self,
    search: str | None = None,
    *,
    id: int | None = None,
    id_mal: int | None = None,
    start_date: int | None = None,
    end_date: int | None = None,
    season: MediaSeason | None = None,
    season_year: int | None = None,
    type: MediaType | None = None,
    format: MediaFormat | None = None,
    status: MediaStatus | None = None,
    episodes: int | None = None,
    chapters: int | None = None,
    duration: int | None = None,
    volumes: int | None = None,
    is_adult: bool | None = None,
    genre: str | None = None,
    tag: str | None = None,
    minimum_tag_rank: int | None = None,
    tag_category: str | None = None,
    licensed_by: str | None = None,
    licensed_by_id: int | None = None,
    average_score: int | None = None,
    popularity: int | None = None,
    source: MediaSource | None = None,
    country_of_origin: str | None = None,
    is_licensed: bool | None = None,
    id_not: int | None = None,
    id_in: Iterable[int] | None = None,
    id_not_in: Iterable[int] | None = None,
    id_mal_not: int | None = None,
    id_mal_in: Iterable[int] | None = None,
    id_mal_not_in: Iterable[int] | None = None,
    start_date_greater: int | None = None,
    start_date_lesser: int | None = None,
    start_date_like: str | None = None,
    end_date_greater: int | None = None,
    end_date_lesser: int | None = None,
    end_date_like: str | None = None,
    format_in: Iterable[MediaFormat] | None = None,
    format_not: MediaFormat | None = None,
    format_not_in: Iterable[MediaFormat] | None = None,
    status_in: Iterable[MediaStatus] | None = None,
    status_not: MediaStatus | None = None,
    status_not_in: Iterable[MediaStatus] | None = None,
    episodes_greater: int | None = None,
    episodes_lesser: int | None = None,
    duration_greater: int | None = None,
    duration_lesser: int | None = None,
    chapters_greater: int | None = None,
    chapters_lesser: int | None = None,
    volumes_greater: int | None = None,
    volumes_lesser: int | None = None,
    genre_in: Iterable[str] | None = None,
    genre_not_in: Iterable[str] | None = None,
    tag_in: Iterable[str] | None = None,
    tag_not_in: Iterable[str] | None = None,
    tag_category_in: Iterable[str] | None = None,
    tag_category_not_in: Iterable[str] | None = None,
    licensed_by_in: Iterable[str] | None = None,
    licensed_by_id_in: Iterable[int] | None = None,
    average_score_not: int | None = None,
    average_score_greater: int | None = None,
    average_score_lesser: int | None = None,
    popularity_not: int | None = None,
    popularity_greater: int | None = None,
    popularity_lesser: int | None = None,
    source_in: Iterable[MediaSource] | None = None,
    sort: Iterable[MediaSort] | None = None,
) -> Media:
    """
    Search for media on AniList based on the provided parameters.

    Parameters
    ----------
    search : str | None, optional
        Filter by search query.
    id : int | None, optional
        Filter by the media id.
    id_mal : int | None, optional
        Filter by the media's MyAnimeList id.
    start_date : int | None, optional
        Filter by the start date of the media.
        Must be an 8 digit long date integer (YYYYMMDD).
        Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500.
    end_date : int | None, optional
        Filter by the end date of the media.
    season : MediaSeason | None, optional
        Filter by the season the media was released in.
    season_year : int | None, optional
        The year of the season (Winter 2017 would also include December 2016 releases). Requires season argument.
    type : MediaType | None, optional
        Filter by the media's type.
    format : MediaFormat | None, optional
        Filter by the media's format.
    status : MediaStatus | None, optional
        Filter by the media's current release status.
    episodes : int | None, optional
        Filter by amount of episodes the media has.
    chapters : int | None, optional
        Filter by the media's episode length.
    duration : int | None, optional
        Filter by the media's chapter count.
    volumes : int | None, optional
        Filter by the media's volume count.
    is_adult : bool | None, optional
        Filter by if the media's intended for 18+ adult audiences.
    genre : str | None, optional
        Filter by the media's genres.
    tag : str | None, optional
        Filter by the media's tags.
    minimum_tag_rank : int | None, optional
        Only apply the tags filter argument to tags above this rank. Default: 18.
    tag_category : str | None, optional
        Filter by the media's tags within a tag category.
    licensed_by : str | None, optional
        Filter media by sites name with a online streaming or reading license.
    licensed_by_id : int | None, optional
        Filter media by sites id with a online streaming or reading license.
    average_score : int | None, optional
        Filter by the media's average score.
    popularity : int | None, optional
        Filter by the number of users with this media on their list.
    source : MediaSource | None, optional
        Filter by the source type of the media.
    country_of_origin : str | None, optional
        Filter by the media's country of origin.
    is_licensed : bool | None, optional
        If the media is officially licensed or a self-published doujin release.
    id_not : int | None, optional
        Filter by the media id.
    id_in : Iterable[int] | None, optional
        Filter by the media id.
    id_not_in : Iterable[int] | None, optional
        Filter by the media id.
    id_mal_not : int | None, optional
        Filter by the media's MyAnimeList id.
    id_mal_in : Iterable[int] | None, optional
        Filter by the media's MyAnimeList id.
    id_mal_not_in : Iterable[int] | None, optional
        Filter by the media's MyAnimeList id.
    start_date_greater : int | None, optional
        Filter by the start date of the media.
        Must be an 8 digit long date integer (YYYYMMDD).
        Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500.
    start_date_lesser : int | None, optional
        Filter by the start date of the media.
        Must be an 8 digit long date integer (YYYYMMDD).
        Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500.
    start_date_like : str | None, optional
        Filter by the start date of the media.
    end_date_greater : int | None, optional
        Filter by the end date of the media.
        Must be an 8 digit long date integer (YYYYMMDD).
        Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500.
    end_date_lesser : int | None, optional
        Filter by the end date of the media.
        Must be an 8 digit long date integer (YYYYMMDD).
        Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500.
    end_date_like : str | None, optional
        Filter by the end date of the media.
    format_in : Iterable[MediaFormat] | None, optional
        Filter by the media's format.
    format_not : MediaFormat | None, optional
        Filter by the media's format.
    format_not_in : Iterable[MediaFormat] | None, optional
        Filter by the media's format.
    status_in : Iterable[MediaStatus] | None, optional
        Filter by the media's current release status.
    status_not : MediaStatus | None, optional
        Filter by the media's current release status.
    status_not_in : Iterable[MediaStatus] | None, optional
        Filter by the media's current release status.
    episodes_greater : int | None, optional
        Filter by amount of episodes the media has.
    episodes_lesser : int | None, optional
        Filter by amount of episodes the media has.
    duration_greater : int | None, optional
        Filter by the media's episode length.
    duration_lesser : int | None, optional
        Filter by the media's episode length.
    chapters_greater : int | None, optional
        Filter by the media's chapter count.
    chapters_lesser : int | None, optional
        Filter by the media's chapter count.
    volumes_greater : int | None, optional
        Filter by the media's volume count.
    volumes_lesser : int | None, optional
        Filter by the media's volume count.
    genre_in : Iterable[str] | None, optional
        Filter by the media's genres.
    genre_not_in : Iterable[str] | None, optional
        Filter by the media's genres.
    tag_in : Iterable[str] | None, optional
        Filter by the media's tags.
    tag_not_in : Iterable[str] | None, optional
        Filter by the media's tags.
    tag_category_in : Iterable[str] | None, optional
        Filter by the media's tags within a tag category.
    tag_category_not_in : Iterable[str] | None, optional
        Filter by the media's tags within a tag category.
    licensed_by_in : Iterable[str] | None, optional
        Filter media by sites name with a online streaming or reading license.
    licensed_by_id_in : Iterable[int] | None, optional
        Filter media by sites id with a online streaming or reading license.
    average_score_not : int | None, optional
        Filter by the media's average score.
    average_score_greater : int | None, optional
        Filter by the media's average score.
    average_score_lesser : int | None, optional
        Filter by the media's average score.
    popularity_not : int | None, optional
        Filter by the number of users with this media on their list.
    popularity_greater : int | None, optional
        Filter by the number of users with this media on their list.
    popularity_lesser : int | None, optional
        Filter by the number of users with this media on their list.
    source_in : Iterable[MediaSource] | None, optional
        Filter by the source type of the media.
    sort : Iterable[MediaSort] | None, optional
        The order the results will be returned in.

    Raises
    ------
    HTTPStatusError
        AniList returned a non 2xx response.

    Returns
    -------
    Media
        A Media object representing the retrieved media information.

    """

    variables = locals()
    variables.pop("self")

    media = self._post(
        query=MEDIA_QUERY,
        variables={to_anilist_case(key): value for key, value in variables.items() if value is not None},
    )

    return Media.model_validate(remove_null_fields(media))

get_recommendations 

get_recommendations(media: int | str | Media, *, sort: Iterable[RecommendationSort] | RecommendationSort | None = None) -> Iterator[Media]

Retrieve recommended media based on a given Media object or ID.

Parameters:

Name Type Description Default
media int | str | Media

The media to get recommendations for. Can be an ID (int), a URL (str), or a Media object.

 required
sort Iterable[RecommendationSort] | RecommendationSort | None

Sorting criteria for the recommendations.

 None

Yields:

Type Description
Media
Source code in src/pyanilist/_client.py 
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
def get_recommendations(
    self, media: int | str | Media, *, sort: Iterable[RecommendationSort] | RecommendationSort | None = None
) -> Iterator[Media]:
    """
    Retrieve recommended media based on a given `Media` object or ID.

    Parameters
    ----------
    media : int | str | Media
        The media to get recommendations for. Can be an ID (`int`), a URL (`str`), or a `Media` object.
    sort : Iterable[RecommendationSort] | RecommendationSort | None, optional
        Sorting criteria for the recommendations.

    Yields
    ------
    Media

    """
    variables: dict[str, Any] = {"mediaId": resolve_media_id(media)}

    match sort:  # pragma: no cover
        case RecommendationSort():
            variables["sort"] = [sort]
        case Iterable():
            variables["sort"] = sort
        case None:
            pass
        case _:
            assert_never(sort)

    recs = self._post(query=RECOMMENDATIONS_QUERY, variables=variables)["recommendations"]["nodes"]

    for rec in recs:
        yield self.get_media(id=int(rec["mediaRecommendation"]["id"]))

get_relations 

get_relations(media: int | str | Media) -> Iterator[RelatedMedia]

Retrieve related media based on a given Media object or ID.

Parameters:

Name Type Description Default
media int | str | Media

The media to get relations for. Can be an ID (int), a URL (str), or a Media object.

 required

Yields:

Type Description
RelatedMedia
Source code in src/pyanilist/_client.py 
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
def get_relations(self, media: int | str | Media) -> Iterator[RelatedMedia]:
    """
    Retrieve related media based on a given `Media` object or ID.

    Parameters
    ----------
    media : int | str | Media
        The media to get relations for. Can be an ID (`int`), a URL (`str`), or a `Media` object.

    Yields
    ------
    RelatedMedia

    """
    relations = self._post(query=RELATIONS_QUERY, variables={"mediaId": resolve_media_id(media)})["relations"][
        "edges"
    ]

    for relation in relations:
        relation_type = relation["relationType"]
        media_id = int(relation["node"]["id"])
        media = self.get_media(id=media_id)

        yield RelatedMedia(relation_type=relation_type, **media.model_dump())

get_staffs 

get_staffs(media: int | str | Media, *, sort: Iterable[StaffSort] | StaffSort | None = None) -> Iterator[Staff]

Retrieve staffs based on a given Media object or ID.

Parameters:

Name Type Description Default
media int | str | Media

The media to get staffs for. Can be an ID (int), a URL (str), or a Media object.

 required
sort Iterable[StaffSort] | StaffSort | None

Sorting criteria for the staffs.

 None

Yields:

Type Description
Staff
Source code in src/pyanilist/_client.py 
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
def get_staffs(
    self,
    media: int | str | Media,
    *,
    sort: Iterable[StaffSort] | StaffSort | None = None,
) -> Iterator[Staff]:
    """
    Retrieve staffs based on a given `Media` object or ID.

    Parameters
    ----------
    media : int | str | Media
        The media to get staffs for. Can be an ID (`int`), a URL (`str`), or a `Media` object.
    sort : Iterable[StaffSort] | StaffSort | None, optional
        Sorting criteria for the staffs.

    Yields
    ------
    Staff

    """
    variables: dict[str, Any] = {"mediaId": resolve_media_id(media)}

    match sort:  # pragma: no cover
        case StaffSort():
            variables["sort"] = [sort]
        case Iterable():
            variables["sort"] = sort
        case None:
            pass
        case _:
            assert_never(sort)

    staffs = self._post(query=STAFFS_QUERY, variables=variables)["staff"]["edges"]

    for staff in staffs:
        yield Staff.model_validate({"role": staff["role"], **staff["node"]})

get_studios 

get_studios(media: int | str | Media, *, sort: Iterable[StudioSort] | StudioSort | None = None, is_main: bool | None = None) -> Iterator[Studio]

Retrieve studios based on a given Media object or ID.

Parameters:

Name Type Description Default
media int | str | Media

The media to get studios for. Can be an ID (int), a URL (str), or a Media object.

 required
sort Iterable[StudioSort] | StudioSort | None

Sorting criteria for the studios.

 None
is_main bool | None

Filter for the main studios (True), non-main studios (False), or all (None).

 None

Yields:

Type Description
Studio
Source code in src/pyanilist/_client.py 
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
def get_studios(
    self,
    media: int | str | Media,
    *,
    sort: Iterable[StudioSort] | StudioSort | None = None,
    is_main: bool | None = None,
) -> Iterator[Studio]:
    """
    Retrieve studios based on a given `Media` object or ID.

    Parameters
    ----------
    media : int | str | Media
        The media to get studios for. Can be an ID (`int`), a URL (`str`), or a `Media` object.
    sort : Iterable[StudioSort] | StudioSort | None, optional
        Sorting criteria for the studios.
    is_main : bool | None, optional
        Filter for the main studios (`True`), non-main studios (`False`), or all (`None`).

    Yields
    ------
    Studio

    """
    variables: dict[str, Any] = {"mediaId": resolve_media_id(media)}

    match sort:  # pragma: no cover
        case StudioSort():
            variables["sort"] = [sort]
        case Iterable():
            variables["sort"] = sort
        case None:
            pass
        case _:
            assert_never(sort)

    if is_main is not None:  # pragma: no cover
        variables["isMain"] = is_main

    studios = self._post(query=STUDIOS_QUERY, variables=variables)["studios"]["edges"]

    for studio in studios:
        yield Studio.model_validate({"isMain": studio["isMain"], **studio["node"]})