Skip to content

Anime Classes

pymoe.anime

setMalClient(client_id)

This is a helper function to set the MyAnimeList Client ID at both endpoints.

PARAMETER DESCRIPTION
client_id

Your Client ID

TYPE: str

Source code in pymoe\anime\__init__.py 
 7
 8
 9
10
11
12
13
14
def setMalClient(client_id: str):
    """
    This is a helper function to set the MyAnimeList Client ID at both endpoints.

    :param client_id: Your Client ID
    """
    mg.settings["header"]["X-MAL-CLIENT-ID"] = client_id
    ms.settings["header"]["X-MAL-CLIENT-ID"] = client_id

pymoe.anime.get

character(item_id)

Return a Character from Anilist with the given ID

Source code in pymoe\anime\get\__init__.py 
 9
10
11
12
13
def character(item_id: int):
    """
    Return a Character from Anilist with the given ID
    """
    return anilist.character(item_id)

episode(item_id)

Return an Episode from Anilist with the given ID

Source code in pymoe\anime\get\__init__.py 
23
24
25
26
27
def episode(item_id: int):
    """
    Return an Episode from Anilist with the given ID
    """
    return anilist.episode(item_id)

show(item_id)

Return a Show from Anilist with the given ID

Source code in pymoe\anime\get\__init__.py 
16
17
18
19
20
def show(item_id: int):
    """
    Return a Show from Anilist with the given ID
    """
    return anilist.show(item_id)

staff(item_id)

Return a Staff member from Anilist with the given ID

Source code in pymoe\anime\get\__init__.py 
30
31
32
33
34
def staff(item_id: int):
    """
    Return a Staff member from Anilist with the given ID
    """
    return anilist.staff(item_id)

studio(item_id)

Return a Studio from Anilist with the given ID

Source code in pymoe\anime\get\__init__.py 
37
38
39
40
41
def studio(item_id: int):
    """
    Return a Studio from Anilist with the given ID
    """
    return anilist.studio(item_id)

pymoe.anime.get.anilist

settings = {'header': {'Content-Type': 'application/json', 'User-Agent': 'Pymoe (github.com/ccubed/PyMoe)', 'Accept': 'application/json'}, 'apiurl': 'https://graphql.anilist.co'} module-attribute

character(item_id)

Get a character with a certain ID in the anilist API.

PARAMETER DESCRIPTION
item_id

The ID of the character you want information on.

TYPE: int

Source code in pymoe\anime\get\anilist.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def character(item_id: int):
    """
    Get a character with a certain ID in the anilist API.

    :param item_id: The ID of the character you want information on.
    """
    query_string = """
        query ($id: Int){
            Character (id: $id){
                name{
                    full
                }
                image {
                    large
                    medium
                }
                description
                gender
                age
                siteUrl
                media{
                    nodes{
                        id
                        idMal
                        title {
                            romaji
                            english
                            native
                        }
                        coverImage {
                            extraLarge
                            large
                            medium
                            color
                        }
                        siteUrl
                    }
                }
            }
        }
    """

    r = requests.post(
        settings["apiurl"],
        headers=settings["header"],
        json={"query": query_string, "variables": {"id": item_id}},
    )

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if "errors" in jsd:
            raise serverError(r.text, r.status_code)
        else:
            return jsd

episode(item_id)

Unsupported on Anilist

Source code in pymoe\anime\get\anilist.py 
268
269
270
271
272
def episode(item_id: int):
    """
    Unsupported on Anilist
    """
    raise methodNotSupported("pymoe.anime.get.anilist.episode", "anilist")

season(theSeason=None, year=date.today().year, page=1, perPage=3)

Get a list of seasonal anime given a season and year.

PARAMETER DESCRIPTION
theSeason

What Season? See pymoe.utils.helpers for a list of seasons. If not provided we will determine the season for you based on the current month.

TYPE: str DEFAULT: None

year

What year do you want info on?

TYPE: int DEFAULT: year

page

Which page of results do you want?

TYPE: int DEFAULT: 1

perPage

How many results per page?

TYPE: int DEFAULT: 3

Source code in pymoe\anime\get\anilist.py 
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
def season(
    theSeason: str = None, year: int = date.today().year, page: int = 1, perPage: int = 3
):
    """
    Get a list of seasonal anime given a season and year.

    :param theSeason: What Season? See pymoe.utils.helpers for a list of seasons. If not provided we will determine the season for you based on the current month.
    :param year: What year do you want info on?
    :param page: Which page of results do you want?
    :param perPage: How many results per page?
    """
    myseason = theSeason if theSeason else whatSeason(date.today().month)

    query_string = """
        query($season: MediaSeason, $seasonYear: Int, $page: Int, $perPage: Int){
            Page (page: $page, perPage: $perPage) {
                pageInfo {
                    currentPage
                    hasNextPage
                }
                media (season: $season, seasonYear: $seasonYear){
                    id
                    idMal
                    title {
                        romaji
                        english
                        native
                    }
                    description
                    genres
                    coverImage {
                        extraLarge
                        large
                        medium
                        color
                    }
                    isAdult
                    nextAiringEpisode {
                        timeUntilAiring
                        airingAt
                    }
                    startDate {
                        year
                        month
                        day
                    }
                    streamingEpisodes {
                        title
                        thumbnail
                        url
                        site
                    }
                    siteUrl
                    externalLinks {
                        url
                        site
                        language
                    }
                }
            }
        }
    """

    jsonData = {
        "query": query_string,
        "variables": {
            "season": myseason.upper(),
            "seasonYear": year,
            "page": page,
            "perPage": perPage,
        },
    }

    r = requests.post(settings["apiurl"], headers=settings["header"], json=jsonData)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if "errors" in jsd:
            raise serverError(r.text, r.status_code)
        else:
            if jsd["data"]["Page"]["pageInfo"]["hasNextPage"]:
                return anilistWrapper(
                    jsd["data"]["Page"]["media"],
                    jsonData,
                    settings["header"],
                    settings["apiurl"],
                )
            else:
                return jsd["data"]["Page"]["media"]

show(item_id)

Get a show with a certain ID in the anilist API.

PARAMETER DESCRIPTION
item_id

The ID of the show you want information on.

TYPE: int

Source code in pymoe\anime\get\anilist.py 
 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
def show(item_id: int):
    """
    Get a show with a certain ID in the anilist API.

    :param item_id: The ID of the show you want information on.
    """
    query_string = """
        query ($id: Int) {
            Media (id: $id, type: ANIME) {
                title {
                    romaji
                    english
                    native
                }
                startDate {
                    year
                    month
                    day
                }
                endDate {
                    year
                    month
                    day
                }
                coverImage {
                    extraLarge
                    large
                    medium
                    color
                }
                bannerImage
                format
                status
                episodes
                season
                seasonYear
                description
                averageScore
                meanScore
                genres
                synonyms
                isAdult
                siteUrl
                idMal
                popularity
                nextAiringEpisode {
                    timeUntilAiring
                    airingAt
                }
                streamingEpisodes {
                    title
                    thumbnail
                    url
                    site
                }
                externalLinks{
                    url
                    site
                    language
                }
                characters {
                    nodes {
                        id
                        name {
                            first
                            last
                        }
                        image {
                            large
                            medium
                        }
                        description
                        gender
                        age
                        siteUrl
                    }
                }
            }
        }
    """

    r = requests.post(
        settings["apiurl"],
        headers=settings["header"],
        json={"query": query_string, "variables": {"id": item_id}},
    )

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if "errors" in jsd:
            raise serverError(r.text, r.status_code)
        else:
            return jsd

staff(item_id)

Get information on a specific staffer given their ID.

PARAMETER DESCRIPTION
item_id

The ID of the staff member you want information on.

TYPE: int

Source code in pymoe\anime\get\anilist.py 
312
313
314
315
316
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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
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
def staff(item_id: int):
    """
    Get information on a specific staffer given their ID.

    :param item_id: The ID of the staff member you want information on.
    """
    query_string = """
        query ($id: Int){
            Staff (id: $id){
                name {
                    full
                }
                languageV2
                image {
                    large
                    medium
                }
                description
                primaryOccupations
                gender
                dateOfBirth {
                    year
                    month
                    day
                }
                dateOfDeath {
                    year
                    month
                    day
                }
                age
                homeTown
                yearsActive
                siteUrl
                staffMedia{
                    nodes {
                        id
                        idMal
                        title {
                            romaji
                            english
                            native
                        }
                        coverImage {
                            extraLarge
                            large
                            medium
                            color
                        }
                        siteUrl
                    }
                }
                characters{
                    nodes {
                        name {
                            full
                        }
                        image {
                            large
                            medium
                        }
                        age
                        siteUrl
                        media {
                            nodes {
                                id
                                idMal
                                title {
                                    romaji
                                    english
                                    native
                                }
                                coverImage {
                                    extraLarge
                                    large
                                    medium
                                    color
                                }
                                siteUrl
                            }
                        }
                    }
                }
            }
        }
    """

    r = requests.post(
        settings["apiurl"],
        headers=settings["header"],
        json={"query": query_string, "variables": {"id": item_id}},
    )

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if "errors" in jsd:
            raise serverError(r.text, r.status_code)
        else:
            return jsd

streaming(item_id, page=1, perPage=3)

Given a show ID, return all streaming links for that show. Unlike Kitsu, this returns one streaming link per episode per service.

PARAMETER DESCRIPTION
item_id

The ID of the show you want streaming links for

TYPE: int

Source code in pymoe\anime\get\anilist.py 
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
def streaming(item_id: int, page: int = 1, perPage: int = 3):
    """
    Given a show ID, return all streaming links for that show.
    Unlike Kitsu, this returns one streaming link per episode per service.

    :param item_id: The ID of the show you want streaming links for
    """
    query_string = """
        query ($id: Int) {
            Media(id: $id){
                streamingEpisodes {
                    title
                    thumbnail
                    url
                    site
                }
            }
        }
    """

    r = requests.post(
        settings["apiurl"],
        headers=settings["header"],
        json={"query": query_string, "variables": {"id": item_id}},
    )

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if "errors" in jsd:
            raise serverError(r.text, r.status_code)
        else:
            return jsd

studio(item_id)

Get a studio with a specific id.

PARAMETER DESCRIPTION
item_id

The ID of the studio you want information on.

TYPE: int

Source code in pymoe\anime\get\anilist.py 
416
417
418
419
420
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
458
459
460
461
462
463
def studio(item_id: int):
    """
    Get a studio with a specific id.

    :param item_id: The ID of the studio you want information on.
    """
    query_string = """
        query ($id: Int) {
            Studio (id: $id) {
                name
                siteUrl
                media {
                    nodes {
                        id
                        idMal
                        title {
                            romaji
                            english
                            native
                        }
                        coverImage {
                            extraLarge
                            large
                            medium
                            color
                        }
                        siteUrl
                    }
                }
            }
        }
    """

    r = requests.post(
        settings["apiurl"],
        headers=settings["header"],
        json={"query": query_string, "variables": {"id": item_id}},
    )

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if "errors" in jsd:
            raise serverError(r.text, r.status_code)
        else:
            return jsd

pymoe.anime.get.kitsu

settings = {'header': {'Content-Type': 'application/vnd.api+json', 'User-Agent': 'Pymoe (github.com/ccubed/PyMoe)', 'Accept': 'application/vnd.api+json'}, 'apiurl': 'https://kitsu.io/api/edge'} module-attribute

character(item_id)

Get a character with the specific ID from the kitsu api.

PARAMETER DESCRIPTION
item_id

ID of the character you want info on.

TYPE: int

Source code in pymoe\anime\get\kitsu.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
def character(item_id: int):
    """
    Get a character with the specific ID from the kitsu api.

    :param item_id: ID of the character you want info on.
    """
    r = requests.get(
        settings["apiurl"] + "/characters/{}".format(item_id), headers=settings["header"]
    )

    if r.status_code != 200:
        raise serverError(r.text, r.status_code)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        return jsd

episode(item_id)

Get an episode with the specific ID from the kitsu api.

PARAMETER DESCRIPTION
item_id

ID of the episode you want info on.

TYPE: int

Source code in pymoe\anime\get\kitsu.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
def episode(item_id: int):
    """
    Get an episode with the specific ID from the kitsu api.

    :param item_id: ID of the episode you want info on.
    """
    r = requests.get(
        settings["apiurl"] + "/episodes/{}".format(item_id), headers=settings["header"]
    )

    if r.status_code != 200:
        raise serverError(r.text, r.status_code)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        return jsd

show(item_id)

Get a show with the specific ID from the kitsu api.

PARAMETER DESCRIPTION
item_id

ID of the show you want info on.

TYPE: int

Source code in pymoe\anime\get\kitsu.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def show(item_id: int):
    """
    Get a show with the specific ID from the kitsu api.

    :param item_id: ID of the show you want info on.
    """
    r = requests.get(
        settings["apiurl"] + "/anime/{}".format(item_id), headers=settings["header"]
    )

    if r.status_code != 200:
        raise serverError(r.text, r.status_code)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        return jsd

staff(item_id)

Get a staffer with the specific ID from the kitsu api.

PARAMETER DESCRIPTION
item_id

ID of the staffer you want info on.

TYPE: int

Source code in pymoe\anime\get\kitsu.py 
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def staff(item_id: int):
    """
    Get a staffer with the specific ID from the kitsu api.

    :param item_id: ID of the staffer you want info on.
    """
    r = requests.get(
        settings["apiurl"] + "/anime-staff/{}/person".format(item_id),
        headers=settings["header"],
    )

    if r.status_code != 200:
        raise serverError(r.text, r.status_code)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        return jsd

studio(item_id)

Get a studio with the specific ID from the kitsu api.

PARAMETER DESCRIPTION
item_id

ID of the studio you want info on.

TYPE: int

Source code in pymoe\anime\get\kitsu.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
def studio(item_id: int):
    """
    Get a studio with the specific ID from the kitsu api.

    :param item_id: ID of the studio you want info on.
    """
    r = requests.get(
        settings["apiurl"] + "/anime-productions/{}/producer".format(item_id),
        headers=settings["header"],
    )

    if r.status_code != 200:
        raise serverError(r.text, r.status_code)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        return jsd

pymoe.anime.get.mal

settings = {'header': {'Content-Type': 'application/json', 'User-Agent': 'Pymoe (github.com/ccubed/PyMoe)', 'Accept': 'application/json', 'X-MAL-CLIENT-ID': None}, 'apiurl': 'https://api.myanimelist.net/v2/', 'default_fields': 'id,title,main_picture,alternative_titles,start_date,end_date,synopsis,mean,rank,nsfw,genres,media_type,status,num_episodes,start_season,broadcast,source,rating,studios,related_anime,related_manga'} module-attribute

character(item_id)

No endpoint exists for this at this time Method not supported

Source code in pymoe\anime\get\mal.py 
31
32
33
34
35
36
def character(item_id: int):
    """
    No endpoint exists for this at this time
    Method not supported
    """
    raise methodNotSupported("pymoe.anime.get.mal.character", "myanimelist")

episode(item_id)

No endpoint exists for this at this time Method not supported

Source code in pymoe\anime\get\mal.py 
59
60
61
62
63
64
def episode(item_id: int):
    """
    No endpoint exists for this at this time
    Method not supported
    """
    raise methodNotSupported("pymoe.anime.get.mal.episode", "myanimelist")

keyAssert()

This is just an assert. It cancels the request if the API Key is not present.

Source code in pymoe\anime\get\mal.py 
18
19
20
21
22
23
24
25
26
27
28
def keyAssert():
    """
    This is just an assert. It cancels the request if the API Key is not present.
    """
    if (
        not settings["header"]["X-MAL-CLIENT-ID"]
        or type(settings["header"]["X-MAL-CLIENT-ID"]) != str
    ):
        raise ValueError("pymoe.anime.get.mal.keyAssert: API Key should be a string.")
    else:
        pass

show(item_id, fields=None)

Get a show with the specific ID from the myanimelist api.

PARAMETER DESCRIPTION
item_id

ID of the show you want info on.

TYPE: int

Source code in pymoe\anime\get\mal.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def show(item_id: int, fields: str = None):
    """
    Get a show with the specific ID from the myanimelist api.

    :param item_id: ID of the show you want info on.
    """
    keyAssert()

    r = requests.get(
        settings["apiurl"] + "anime/{}".format(item_id),
        params={"fields": fields or settings["default_fields"], "nsfw": "true"},
        headers=settings["header"],
    )

    if r.status_code != 200:
        raise serverError(r.text, r.status_code)

    return ujson.loads(r.text)

staff(item_id)

No endpoint exists for this at this time Method not supported

Source code in pymoe\anime\get\mal.py 
75
76
77
78
79
80
def staff(item_id: int):
    """
    No endpoint exists for this at this time
    Method not supported
    """
    raise methodNotSupported("pymoe.anime.get.mal.staff", "myanimelist")

streaming(item_id)

No endpoint exists for this at this time Method not supported

Source code in pymoe\anime\get\mal.py 
67
68
69
70
71
72
def streaming(item_id: int):
    """
    No endpoint exists for this at this time
    Method not supported
    """
    raise methodNotSupported("pymoe.anime.get.mal.streaming", "myanimelist")

studio(item_id)

No endpoint exists for this at this time Method not supported

Source code in pymoe\anime\get\mal.py 
83
84
85
86
87
88
def studio(item_id: int):
    """
    No endpoint exists for this at this time
    Method not supported
    """
    raise methodNotSupported("pymoe.anime.get.mal.studio", "myanimelist")

pymoe.anime.search

characters(term)

Search for characters that match term on anilist

Source code in pymoe\anime\search\__init__.py 
10
11
12
13
14
def characters(term: str):
    """
    Search for characters that match term on anilist
    """
    return anilist.characters(term)

season(season=None, seasonYear=date.today().year)

Given a season and seasonYear, return the list of seasonal anime from Anilist.

Source code in pymoe\anime\search\__init__.py 
38
39
40
41
42
def season(season: str = None, seasonYear: int = date.today().year):
    """
    Given a season and seasonYear, return the list of seasonal anime from Anilist.
    """
    return asg(season, seasonYear)

shows(term)

Search for characters that match term on anilist

Source code in pymoe\anime\search\__init__.py 
17
18
19
20
21
def shows(term: str):
    """
    Search for characters that match term on anilist
    """
    return anilist.shows(term)

staff(term)

Search for characters that match term on anilist

Source code in pymoe\anime\search\__init__.py 
24
25
26
27
28
def staff(term: str):
    """
    Search for characters that match term on anilist
    """
    return anilist.staff(term)

studios(term)

Search for characters that match term on anilist

Source code in pymoe\anime\search\__init__.py 
31
32
33
34
35
def studios(term: str):
    """
    Search for characters that match term on anilist
    """
    return anilist.studios(term)

pymoe.anime.search.anilist

settings = {'header': {'Content-Type': 'application/json', 'User-Agent': 'Pymoe (github.com/ccubed/PyMoe)', 'Accept': 'application/json'}, 'apiurl': 'https://graphql.anilist.co'} module-attribute

airingSchedule(item_id)

Given an anime id, return the airing schedule. This returns a full airing schedule, including already aired episodes. If an episode has already aired timeUntilAiring will be <= 0. timeUntilAiring is just seconds.

PARAMETER DESCRIPTION
item_id

The ID of the show you want a schedule for

TYPE: int

Source code in pymoe\anime\search\anilist.py 
371
372
373
374
375
376
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 airingSchedule(item_id: int):
    """
    Given an anime id, return the airing schedule.
    This returns a full airing schedule, including already aired episodes.
    If an episode has already aired timeUntilAiring will be <= 0.
    timeUntilAiring is just seconds.

    :param item_id: The ID of the show you want a schedule for
    """
    query_string = """\
        query( $id: Int, $page: Int, $perPage: Int ) {
            Page ( page: $page, perPage: $perPage ) {
                pageInfo {
                    currentPage
                    hasNextPage
                }
                airingSchedules ( mediaId: $id ) {
                    id
                    episode
                    timeUntilAiring
                }
            }
        }
    """

    json_params = {
        "query": query_string,
        "variables": {"id": item_id, "page": 1, "perPage": 3},
    }

    r = requests.post(settings["apiurl"], headers=settings["header"], json=json_params)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if "errors" in jsd:
            raise serverError(r.text, r.status_code)
        else:
            if jsd["data"]["Page"]["pageInfo"]["hasNextPage"]:
                return anilistWrapper(
                    jsd["data"]["Page"]["airingSchedules"],
                    json_params,
                    settings["header"],
                    settings["apiurl"],
                )
            else:
                return jsd["data"]["Page"]["airingSchedules"]

characters(term, page=1, perPage=3)

Search for characters that match the term in the API.

PARAMETER DESCRIPTION
term

Search Term

TYPE: str

page

Which page of the results?

TYPE: int DEFAULT: 1

perPage

How many results per page?

TYPE: int DEFAULT: 3

Source code in pymoe\anime\search\anilist.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def characters(term: str, page: int = 1, perPage: int = 3):
    """
    Search for characters that match the term in the API.

    :param term: Search Term
    :param page: Which page of the results?
    :param perPage: How many results per page?
    """
    query_string = """\
        query ($query: String, $page: Int, $perPage: Int){
            Page (page: $page, perPage: $perPage) {
                pageInfo {
                    currentPage
                    hasNextPage
                }
                characters (search: $query) {
                    id
                    name{
                        first
                        last
                    }
                    image{
                        large
                    }
                    description
                    gender
                    age
                    siteUrl
                    media {
                        nodes {
                            id
                            idMal
                            title {
                                romaji
                                english
                                native
                            }
                            coverImage {
                                extraLarge
                                large
                                medium
                                color
                            }
                            siteUrl
                        }
                    }
                }
            }
        }
    """

    json_params = {
        "query": query_string,
        "variables": {"query": term, "page": page, "perPage": perPage},
    }

    r = requests.post(settings["apiurl"], headers=settings["header"], json=json_params)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if "errors" in jsd:
            raise serverError(r.text, r.status_code)
        else:
            if jsd["data"]["Page"]["pageInfo"]["hasNextPage"]:
                return anilistWrapper(
                    jsd["data"]["Page"]["characters"],
                    json_params,
                    settings["header"],
                    settings["apiurl"],
                )
            else:
                return jsd["data"]["Page"]["characters"]

dynamicRequest(params)

This allows you to run a query you wrote yourself against the anilist API. You have to pass both a properly formatted query and the dictionary of parameters needed. If your request returns multiple results, you will get back a wrapper.

PARAMETER DESCRIPTION
params

Dictionary of parameters needed for the request. Note this needs to include the GraphQL query.

TYPE: Dict

Source code in pymoe\anime\search\anilist.py 
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
def dynamicRequest(params: Dict):
    """
    This allows you to run a query you wrote yourself against the anilist API.
    You have to pass both a properly formatted query and the dictionary of parameters needed.
    If your request returns multiple results, you will get back a wrapper.

    :param params: Dictionary of parameters needed for the request. Note this needs to include the GraphQL query.
    """
    r = requests.post(settings["apiurl"], headers=settings["header"], json=params)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if "errors" in jsd:
            raise serverError(r.text, r.status_code)
        else:
            if jsd["data"]["Page"]["pageInfo"]["hasNextPage"]:
                return anilistWrapper(
                    jsd["data"]["Page"]["airingSchedules"],
                    params,
                    settings["header"],
                    settings["apiurl"],
                )
            else:
                return jsd["data"]["Page"]["airingSchedules"]

shows(term, page=1, perPage=3)

Search for shows(anime) that match the term in the API.

PARAMETER DESCRIPTION
term

Search Term

TYPE: str

page

Which page of the results?

TYPE: int DEFAULT: 1

perPage

How many results per page?

TYPE: int DEFAULT: 3

Source code in pymoe\anime\search\anilist.py 
 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
def shows(term: str, page: int = 1, perPage: int = 3):
    """
    Search for shows(anime) that match the term in the API.

    :param term: Search Term
    :param page: Which page of the results?
    :param perPage: How many results per page?
    """
    query_string = """\
        query ($query: String, $page: Int, $perPage: Int){
            Page (page: $page, perPage: $perPage){
                pageInfo {
                    currentPage
                    hasNextPage
                }
                media (search: $query, type: ANIME) {
                    id
                    idMal
                    title {
                        romaji
                        english
                        native
                    }
                    coverImage {
                        extraLarge
                        large
                        medium
                        color
                    }
                    averageScore
                    popularity
                    episodes
                    season
                    hashtag
                    isAdult
                    siteUrl
                    characters {
                        nodes {
                            id
                            name {
                                first
                                last
                            }
                            image {
                                large
                                medium
                            }
                            description
                            gender
                            age
                            siteUrl
                        }
                    }
                }
            }
        }
    """

    json_params = {
        "query": query_string,
        "variables": {"query": term, "page": page, "perPage": perPage},
    }

    r = requests.post(settings["apiurl"], headers=settings["header"], json=json_params)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if "errors" in jsd:
            raise serverError(r.text, r.status_code)
        else:
            if jsd["data"]["Page"]["pageInfo"]["hasNextPage"]:
                return anilistWrapper(
                    jsd["data"]["Page"]["media"],
                    json_params,
                    settings["header"],
                    settings["apiurl"],
                )
            else:
                return jsd["data"]["Page"]["media"]

staff(term, page=1, perPage=3)

Search for staffers that match the term in the API.

PARAMETER DESCRIPTION
term

Search Term

TYPE: str

page

Which page of the results?

TYPE: int DEFAULT: 1

perPage

How many results per page?

TYPE: int DEFAULT: 3

Source code in pymoe\anime\search\anilist.py 
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
def staff(term: str, page: int = 1, perPage: int = 3):
    """
    Search for staffers that match the term in the API.

    :param term: Search Term
    :param page: Which page of the results?
    :param perPage: How many results per page?
    """
    query_string = """\
        query($query: String, $page: Int, $perPage: Int){
            Page(page: $page, perPage: $perPage){
                pageInfo{
                    currentPage
                    hasNextPage
                }
                staff (search: $query){
                    id
                    name {
                        first
                        last
                    }
                    languageV2
                    image {
                        large
                        medium
                    }
                    description
                    primaryOccupations
                    gender
                    dateOfBirth {
                        year
                        month
                        day
                    }
                    dateOfDeath {
                        year
                        month
                        day
                    }
                    age
                    homeTown
                    yearsActive
                    siteUrl
                    staffMedia {
                        nodes {
                            id
                            idMal
                            title {
                                romaji
                                english
                                native
                            }
                            coverImage {
                                extraLarge
                                large
                                medium
                                color
                            }
                            siteUrl
                        }
                    }
                    characters {
                        nodes {
                            name {
                                first
                                last
                            }
                            image {
                                large
                                medium
                            }
                            age
                            siteUrl
                            media {
                                nodes {
                                    id
                                    idMal
                                    title {
                                        romaji
                                        english
                                        native
                                    }
                                    coverImage {
                                        extraLarge
                                        large
                                        medium
                                        color
                                    }
                                    siteUrl
                                }
                            }
                        }
                    }
                }
            }
        }
    """

    json_params = {
        "query": query_string,
        "variables": {"query": term, "page": page, "perPage": perPage},
    }

    r = requests.post(settings["apiurl"], headers=settings["header"], json=json_params)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if "errors" in jsd:
            raise serverError(r.text, r.status_code)
        else:
            if jsd["data"]["Page"]["pageInfo"]["hasNextPage"]:
                return anilistWrapper(
                    jsd["data"]["Page"]["staff"],
                    json_params,
                    settings["header"],
                    settings["apiurl"],
                )
            else:
                return jsd["data"]["Page"]["staff"]

studios(term, page=1, perPage=3)

Search for studios that match the term in the API.

PARAMETER DESCRIPTION
term

Search Term

TYPE: str

page

Which page of the results?

TYPE: int DEFAULT: 1

perPage

How many results per page?

TYPE: int DEFAULT: 3

Source code in pymoe\anime\search\anilist.py 
303
304
305
306
307
308
309
310
311
312
313
314
315
316
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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
def studios(term: str, page: int = 1, perPage: int = 3):
    """
    Search for studios that match the term in the API.

    :param term: Search Term
    :param page: Which page of the results?
    :param perPage: How many results per page?
    """
    query_string = """\
        query($query: String, $page: Int, $perPage: Int){
            Page(page: $page, perPage: $perPage){
                pageInfo{
                    currentPage
                    hasNextPage
                }
                studios(search: $query){
                    id
                    name
                    siteUrl
                    media {
                        nodes {
                            id
                            idMal
                            title {
                                romaji
                                english
                                native
                            }
                            coverImage {
                                extraLarge
                                large
                                medium
                                color
                            }
                            siteUrl
                        }
                    }
                }
            }
        }
    """

    json_params = {
        "query": query_string,
        "variables": {"query": term, "page": page, "perPage": perPage},
    }

    r = requests.post(settings["apiurl"], headers=settings["header"], json=json_params)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if "errors" in jsd:
            raise serverError(r.text, r.status_code)
        else:
            if jsd["data"]["Page"]["pageInfo"]["hasNextPage"]:
                return anilistWrapper(
                    jsd["data"]["Page"]["studios"],
                    json_params,
                    settings["header"],
                    settings["apiurl"],
                )
            else:
                return jsd["data"]["Page"]["studios"]

pymoe.anime.search.kitsu

settings = {'header': {'Content-Type': 'application/vnd.api+json', 'User-Agent': 'Pymoe (github.com/ccubed/PyMoe)', 'Accept': 'application/vnd.api+json'}, 'apiurl': 'https://kitsu.io/api/edge'} module-attribute

characters(term)

Search for characters that match the term in the Kitsu API.

PARAMETER DESCRIPTION
term

Search Term

TYPE: str

Source code in pymoe\anime\search\kitsu.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
def characters(term: str):
    """
    Search for characters that match the term in the Kitsu API.

    :param term: Search Term
    """
    r = requests.get(
        settings["apiurl"] + "/characters",
        params={"filter[name]": term},
        headers=settings["header"],
    )

    if r.status_code != 200:
        raise serverError(r.text, r.status_code)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if jsd["meta"]["count"]:
            return kitsuWrapper(
                jsd["data"],
                jsd["links"]["next"] if "next" in jsd["links"] else None,
                settings["header"],
            )
        else:
            return jsd

season(season=None, seasonYear=date.today().year)

Given a season and a year, return a list of shows airing in that season and year. This can also pull historical and future data. (Though not too far in the future)

PARAMETER DESCRIPTION
season

Which Season? See pymoe.helpers for a list of seasons.

TYPE: str DEFAULT: None

seasonYear

What year?

TYPE: int DEFAULT: year

Source code in pymoe\anime\search\kitsu.py 
 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
def season(season: str = None, seasonYear: int = date.today().year):
    """
    Given a season and a year, return a list of shows airing in that season and year.
    This can also pull historical and future data. (Though not too far in the future)

    :param season: Which Season? See pymoe.helpers for a list of seasons.
    :param seasonYear: What year?
    """
    myseason = season if season else whatSeason(date.today().month)

    r = requests.get(
        settings["apiurl"] + "/anime",
        params={"filter[season]": myseason, "filter[seasonYear]": seasonYear},
        headers=settings["header"],
    )

    if r.status_code != 200:
        raise serverError(r.text, r.status_code)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if jsd["meta"]["count"]:
            return kitsuWrapper(
                jsd["data"],
                jsd["links"]["next"] if "next" in jsd["links"] else None,
                settings["header"],
            )
        else:
            return jsd

shows(term)

Search for shows that match the term in the Kitsu API.

PARAMETER DESCRIPTION
term

Search Term

TYPE: str

Source code in pymoe\anime\search\kitsu.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def shows(term: str):
    """
    Search for shows that match the term in the Kitsu API.

    :param term: Search Term
    """
    r = requests.get(
        settings["apiurl"] + "/anime",
        params={"filter[text]": term},
        headers=settings["header"],
    )

    if r.status_code != 200:
        raise serverError(r.text, r.status_code)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if jsd["meta"]["count"]:
            return kitsuWrapper(
                jsd["data"],
                jsd["links"]["next"] if "next" in jsd["links"] else None,
                settings["header"],
            )
        else:
            return jsd

staff(term)

Kitsu doesn't support text filtering on the anime-staff endpoint. Method not supported.

Source code in pymoe\anime\search\kitsu.py 
78
79
80
81
82
83
def staff(term: str):
    """
    Kitsu doesn't support text filtering on the anime-staff endpoint.
    Method not supported.
    """
    raise methodNotSupported("pymoe.anime.search.kitsu.staff", "kitsu")

streaming(item_id)

Given a media ID, return all streaming links related to that media. Unlike anilist, this returns one link per streaming service.

PARAMETER DESCRIPTION
item_id

ID to get streaming links for

TYPE: int

Source code in pymoe\anime\search\kitsu.py 
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
def streaming(item_id: int):
    """
    Given a media ID, return all streaming links related to that media.
    Unlike anilist, this returns one link per streaming service.

    :param item_id: ID to get streaming links for
    """
    data = show(item_id)

    r = requests.get(
        data["data"]["relationships"]["streamingLinks"]["links"]["related"],
        headers=settings["header"],
    )

    if r.status_code != 200:
        raise serverError(r.text, r.status_code)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)
    else:
        if jsd["meta"]["count"]:
            return kitsuWrapper(
                jsd["data"],
                jsd["links"]["next"] if "next" in jsd["links"] else None,
                settings["header"],
            )
        else:
            return jsd

studios(term)

Kitsu doesn't support text filtering on the anime-producers endpoint. Method not supported.

Source code in pymoe\anime\search\kitsu.py 
86
87
88
89
90
91
def studios(term: str):
    """
    Kitsu doesn't support text filtering on the anime-producers endpoint.
    Method not supported.
    """
    raise methodNotSupported("pymoe.anime.search.kitsu.studios", "kitsu")

pymoe.anime.search.mal

settings = {'header': {'Content-Type': 'application/json', 'User-Agent': 'Pymoe (github.com/ccubed/PyMoe)', 'Accept': 'application/json', 'X-MAL-CLIENT-ID': None}, 'apiurl': 'https://api.myanimelist.net/v2/', 'default_fields': 'id,title,main_picture,alternative_titles,start_date,end_date,synopsis,mean,rank,nsfw,genres,media_type,status,num_episodes,start_season,broadcast,source,rating,studios,related_anime,related_manga'} module-attribute

characters(term)

No endpoint exists for this at this time. Method not supported

Source code in pymoe\anime\search\mal.py 
32
33
34
35
36
37
def characters(term: str):
    """
    No endpoint exists for this at this time.
    Method not supported
    """
    raise methodNotSupported("pymoe.anime.search.mal.characters", "myanimelist")

keyAssert()

This is just an assert. It cancels the request if the API Key is not present.

Source code in pymoe\anime\search\mal.py 
19
20
21
22
23
24
25
26
27
28
29
def keyAssert():
    """
    This is just an assert. It cancels the request if the API Key is not present.
    """
    if (
        not settings["header"]["X-MAL-CLIENT-ID"]
        or type(settings["header"]["X-MAL-CLIENT-ID"]) != str
    ):
        raise ValueError("pymoe.anime.search.mal.keyAssert: API Key should be a string.")
    else:
        pass

season(season=None, seasonYear=date.today().year, limit=10, offset=0, nsfw=False)

Search for shows from a given season in a given year.

PARAMETER DESCRIPTION
season

Which season? See pymoe.helpers for a list.

TYPE: str DEFAULT: None

seasonYear

Which year?

TYPE: int DEFAULT: year

limit

How many results per page?

TYPE: int DEFAULT: 10

offset

Which result do we start at?

TYPE: int DEFAULT: 0

nsfw

Return adult results?

TYPE: bool DEFAULT: False

Source code in pymoe\anime\search\mal.py 
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
def season(
    season: str = None,
    seasonYear: int = date.today().year,
    limit: int = 10,
    offset: int = 0,
    nsfw: bool = False,
):
    """
    Search for shows from a given season in a given year.

    :param season: Which season? See pymoe.helpers for a list.
    :param seasonYear: Which year?
    :param limit: How many results per page?
    :param offset: Which result do we start at?
    :param nsfw: Return adult results?
    """
    keyAssert()

    myseason = season or whatSeason(date.today().month)

    r = requests.get(
        settings["apiurl"] + "anime/season/{}/{}".format(seasonYear, myseason),
        params={
            "sort": "anime_score",
            "limit": limit,
            "offset": offset,
            "fields": "id,title,main_picture,alternative_titles,start_date,broadcast",
            "nsfw": "false" if not nsfw else "true",
        },
        headers=settings["header"],
    )

    if r.status_code != 200:
        raise serverError(r.text, r.status_code)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)

    rdict = [item["node"] for item in jsd["data"]]
    r_url = jsd["paging"]["next"] if "next" in jsd["paging"] else None

    return malWrapper(rdict, r_url, settings["header"])

shows(term, fields=None, limit=10, offset=0, nsfw=False)

Search for shows that match the given search term.

PARAMETER DESCRIPTION
term

Search Term

TYPE: str

fields

a comma separated list of fields to request from the API

TYPE: str | None DEFAULT: None

limit

How many results per page?

TYPE: int DEFAULT: 10

offset

Which result should we start at?

TYPE: int DEFAULT: 0

nsfw

Return adult results?

TYPE: bool DEFAULT: False

Source code in pymoe\anime\search\mal.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
def shows(
    term: str,
    fields: str | None = None,
    limit: int = 10,
    offset: int = 0,
    nsfw: bool = False,
):
    """
    Search for shows that match the given search term.

    :param term: Search Term
    :param fields: a comma separated list of fields to request from the API
    :param limit: How many results per page?
    :param offset: Which result should we start at?
    :param nsfw: Return adult results?
    """
    keyAssert()

    r = requests.get(
        settings["apiurl"] + "anime",
        params={
            "q": term,
            "fields": settings["default_fields"] or fields,
            "limit": limit,
            "offset": offset,
            "nsfw": "false" if not nsfw else "true",
        },
        headers=settings["header"],
    )

    if r.status_code != 200:
        raise serverError(r.text, r.status_code)

    try:
        jsd = ujson.loads(r.text)
    except ValueError:
        raise serializationFailed(r.text, r.status_code)

    rdict = [item["node"] for item in jsd["data"]]
    r_url = jsd["paging"]["next"] if "next" in jsd["paging"] else None

    return malWrapper(rdict, r_url, settings["header"])

staff(term)

No endpoint exists for this at this time. Method not supported

Source code in pymoe\anime\search\mal.py 
84
85
86
87
88
89
def staff(term: str):
    """
    No endpoint exists for this at this time.
    Method not supported
    """
    raise methodNotSupported("pymoe.anime.search.mal.staff", "myanimelist")

studios(term)

No endpoint exists for this at this time. Method not supported

Source code in pymoe\anime\search\mal.py 
92
93
94
95
96
97
def studios(term: str):
    """
    No endpoint exists for this at this time.
    Method not supported
    """
    raise methodNotSupported("pymoe.anime.search.mal.studios", "myanimelist")