API reference — py-aniliberty

Текст страницы — оригинал из репозитория SDK, на английском. Исходный файл ↗

Everything below is importable from the top-level aniliberty package unless noted.

Client

`aniliberty.AniLiberty`

класс

AniLiberty(
    *,
    base_url: str = DEFAULT_BASE_URL,
    timeout: float = DEFAULT_TIMEOUT,
    max_concurrency: int = DEFAULT_MAX_CONCURRENCY,
    headers: Mapping[str, str] | None = None,
    http_client: httpx.AsyncClient | None = None,
    token: str | None = None,
    cache_dir: str | os.PathLike[str] | None = None,
    cache_ttl: float | None = None,
)

Async client for the AniLibria API.

Groups the API into resource namespaces that follow the tags of its OpenAPI spec (client.app, ...). Use it as an async context manager so the connection pool is closed when you're done, or call aclose() yourself.

Атрибуты

Имя	Тип	Описание
`http`		The low-level client every resource uses. `client.http.request(...)` is the escape hatch for endpoints the SDK doesn't cover yet — it returns raw JSON.
`app`		Service endpoints — API status and quick release search.
`releases`		Anime releases — latest, random, recommended, by ID/alias, members.
`episodes`		Episodes of releases, with HLS links.
`catalog`		The release catalog; `catalog.references` lists the values its filters accept.
`schedule`		The weekly airing schedule.
`genres`		Genres, and the releases of each.
`franchises`		Franchises — groups of related releases.
`torrents`		Torrents, `.torrent` file downloads and RSS feeds.
`teams`		AniLibria's own teams, roles and members.
`media`		Front-page promo banners and AniLibria's YouTube videos.
`auth`		Logging in and out — by password, one-time code or social network.
`me`		The logged-in user's own account — profile, favorites, collections, watch progress and history (needs a session).

Example

PYTHON

import asyncio

from aniliberty import AniLiberty


async def main() -> None:
    async with AniLiberty() as client:
        status = await client.app.status()
        print(status.is_alive)


asyncio.run(main())

ИСХОДНИК ↗

`token`

атрибутсвойство

token: str | None

The session token sent with every request, or None when not logged in.

Set by client.auth.login() (and the other login methods), cleared by client.auth.logout(). Save it to reuse the session later as AniLiberty(token=...); assign None to stop sending it without ending the session. It is a secret — don't log it.

ИСХОДНИК ↗

`aclose`

методasync

aclose() -> None

Close the connection pool. Safe to call more than once.

ИСХОДНИК ↗

Resources

The namespaces of an AniLiberty instance: client.app, client.releases, client.releases.ratings, client.episodes, client.catalog (with client.catalog.references), client.schedule, client.genres, client.franchises, client.torrents, client.teams, client.media, client.auth (with client.auth.otp, client.auth.social, client.auth.password), client.me (with client.me.favorites, client.me.collections and their references, client.me.views). Not meant to be created directly — import from aniliberty.resources only for type annotations.

`aniliberty.resources.AppResource`

класс

AppResource(http: HttpClient)

Базовые классы BaseResource

Service endpoints of the API, available as client.app.

ИСХОДНИК ↗

`status`

методasync

status() -> ApiStatus

Get the status of the API.

A cheap request that is handy as a health check. The response also lists the hosts the API is available at, which can be used as base_url mirrors.

Возвращает

Тип	Описание
`ApiStatus`	The API status.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `ApiStatus`.

ИСХОДНИК ↗

`search_releases`

методasync

search_releases(query: str, *, refresh: bool = False) -> list[Release]

Quick search of releases by name — the search box of the site.

Matches Russian and English names and aliases, fuzzily: "frieren", "Фрирен" and "sousou-no-frieren" find the same release. There is no paging and no limit: the API returns a short list (at most 20 releases in every query checked), in an order it chooses. For filtered, paginated search use the catalog instead.

Параметры

Имя	Тип	Описание	По умолчанию
`query`	`str`	Search text.
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`list[Release]`	Matching releases, without the per-endpoint extras (`genres` etc. are empty);
`list[Release]`	an empty list when nothing matches.

Исключения

Тип	Описание
`ValidationError`	`query` is empty.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Release`.

ИСХОДНИК ↗

`aniliberty.resources.ReleasesResource`

класс

ReleasesResource(http: HttpClient)

Базовые классы BaseResource

Anime releases, available as client.releases.

For filtering and sorting the whole catalog, see client.catalog; this namespace covers single releases and the ready-made selections.

limit on every method here must be between 1 and 50 — the API answers anything else with a 422, raised as ValidationError (see docs/api-notes.md).

Атрибуты

Имя	Тип	Описание
`ratings`		The logged-in user's own scores of releases (needs a session).

ИСХОДНИК ↗

`latest`

методasync

latest(
    *,
    limit: int | None = None,
    refresh: bool = False,
) -> builtins.list[Release]

Get the latest releases — the ones that got new episodes most recently.

Параметры

Имя	Тип	Описание	По умолчанию
`limit`	`int \| None`	How many releases to return, 1 to 50. Omitted, the API picks the number.	`None`
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`builtins.list[Release]`	The releases, with `genres` filled in.

Исключения

Тип	Описание
`ValidationError`	`limit` is out of range.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Release`.

ИСХОДНИК ↗

`random`

методasync

random(*, limit: int | None = None) -> builtins.list[Release]

Get random releases.

Параметры

Имя	Тип	Описание	По умолчанию
`limit`	`int \| None`	How many releases to return, 1 to 50.	`None`

Возвращает

Тип	Описание
`builtins.list[Release]`	The releases, with `genres` and `background_covers` filled in.

Исключения

Тип	Описание
`ValidationError`	`limit` is out of range.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Release`.

ИСХОДНИК ↗

`recommended`

методasync

recommended(
    *,
    release: int | Release | None = None,
    limit: int | None = None,
) -> builtins.list[Release]

Get recommended releases, optionally ones similar to a given release.

Параметры

Имя	Тип	Описание	По умолчанию
`release`	`int \| Release \| None`	Release ID, or a `Release`, to base recommendations on. Without it, the API returns general recommendations.	`None`
`limit`	`int \| None`	How many releases to return, 1 to 50.	`None`

Возвращает

Тип	Описание
`builtins.list[Release]`	The releases, with `genres` filled in.

Исключения

Тип	Описание
`TypeError`	`release` is not an `int` or a `Release` (aliases don't work here).
`ValidationError`	`limit` is out of range.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Release`.

ИСХОДНИК ↗

`list`

методasync

list(
    *,
    ids: Sequence[int] | None = None,
    aliases: Sequence[str] | None = None,
    page: int | None = None,
    limit: int | None = None,
    refresh: bool = False,
) -> Page[Release]

Get several releases at once by their IDs and/or aliases.

Releases given both by ID and by alias are returned once. The order of the result doesn't follow the order of ids/aliases. To fetch all pages, use iter_list().

Параметры

Имя	Тип	Описание	По умолчанию
`ids`	`Sequence[int] \| None`	Release IDs.	`None`
`aliases`	`Sequence[str] \| None`	Release aliases.	`None`
`page`	`int \| None`	Page number, starting at 1.	`None`
`limit`	`int \| None`	Page size, 1 to 50.	`None`
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`Page[Release]`	One page of releases, with `genres`, `members` and `sponsors` filled in.

Исключения

Тип	Описание
`ValueError`	Neither `ids` nor `aliases` was given (the API requires one).
`ValidationError`	`page` or `limit` is out of range.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Release`.

ИСХОДНИК ↗

`iter_list`

метод

iter_list(
    *,
    ids: Sequence[int] | None = None,
    aliases: Sequence[str] | None = None,
    limit: int | None = None,
    refresh: bool = False,
) -> AsyncIterator[Release]

Iterate over all releases matching ids/aliases, fetching page by page.

Same as calling list() with page=1, 2, ... until the last page; the next page is requested only once the current one has been consumed.

Параметры

Имя	Тип	Описание	По умолчанию
`ids`	`Sequence[int] \| None`	Release IDs.	`None`
`aliases`	`Sequence[str] \| None`	Release aliases.	`None`
`limit`	`int \| None`	Page size, 1 to 50 — affects how many requests are made, not the result.	`None`
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`AsyncIterator[Release]`	An async iterator over the releases.

Исключения

Тип	Описание
`ValueError`	Neither `ids` nor `aliases` was given — raised right away, not when iteration starts.

ИСХОДНИК ↗

`get`

методasync

get(release: int | str | Release, *, refresh: bool = False) -> Release

Get one release by its ID or alias.

Параметры

Имя	Тип	Описание	По умолчанию
`release`	`int \| str \| Release`	Release ID (`10297`), alias (`"sousou-no-frieren"`), or a `Release` (e.g. from a list, to get its full details).
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`Release`	The release, with `genres`, `members`, `sponsors` and
`Release`	`background_covers` filled in.

Исключения

Тип	Описание
`NotFoundError`	No release with this ID or alias.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Release`.

ИСХОДНИК ↗

`members`

методasync

members(
    release: int | str | Release,
    *,
    refresh: bool = False,
) -> builtins.list[ReleaseMember]

Get the people who worked on a release (voice actors, translators, ...).

Параметры

Имя	Тип	Описание	По умолчанию
`release`	`int \| str \| Release`	Release ID, alias, or a `Release`.
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`builtins.list[ReleaseMember]`	The release's members.

Исключения

Тип	Описание
`NotFoundError`	No release with this ID or alias.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `ReleaseMember`.

ИСХОДНИК ↗

`timecodes`

методasync

timecodes(release: int | str | Release) -> builtins.list[EpisodeView]

Get the logged-in user's watch records of a release's episodes. Needs a session.

Records appear about a minute after client.me.views.save_timecodes().

Параметры

Имя	Тип	Описание
`release`	`int \| str \| Release`	Release ID, alias, or a `Release`.

Возвращает

Тип	Описание
`builtins.list[EpisodeView]`	One record per episode the user has started; empty if none.

Исключения

Тип	Описание
`NotFoundError`	No release with this ID or alias.
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `EpisodeView`.

ИСХОДНИК ↗

`aniliberty.resources.RatingsResource`

класс

RatingsResource(http: HttpClient)

Базовые классы BaseResource

The logged-in user's own scores of releases, available as client.releases.ratings.

Needs a session (client.auth.login() or AniLiberty(token=...)); without a valid one every method raises AuthRequiredError. Releases are identified by numeric ID only: the API answers an alias with a 404, so a str is rejected.

The release's overall Release.rating is computed by the API on its own schedule: it didn't change within several minutes of a score being set (see docs/api-notes.md).

ИСХОДНИК ↗

`get`

методasync

get(release: int | Release) -> UserRating

Get the user's score for a release.

Параметры

Имя	Тип	Описание
`release`	`int \| Release`	Release ID, or a `Release`.

Возвращает

Тип	Описание
`UserRating`	The score; `score` is `None` if the user hasn't rated the release.

Исключения

Тип	Описание
`TypeError`	`release` is not an `int` or a `Release`.
`AuthRequiredError`	No valid session.
`NotFoundError`	No release with this ID.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `UserRating`.

ИСХОДНИК ↗

`set`

методasync

set(release: int | Release, *, score: int) -> UserRating

Rate a release, or change the user's score for it.

Параметры

Имя	Тип	Описание
`release`	`int \| Release`	Release ID, or a `Release`.
`score`	`int`	Whole number from 1 to 10.

Возвращает

Тип	Описание
`UserRating`	The saved score.

Исключения

Тип	Описание
`TypeError`	`release` is not an `int` or a `Release`, or `score` isn't an `int`.
`ValueError`	`score` is outside 1..10.
`AuthRequiredError`	No valid session.
`NotFoundError`	No release with this ID.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `UserRating`.

ИСХОДНИК ↗

`remove`

методasync

remove(release: int | Release) -> UserRating

Withdraw the user's score for a release. A no-op if there is none.

Параметры

Имя	Тип	Описание
`release`	`int \| Release`	Release ID, or a `Release`.

Возвращает

Тип	Описание
`UserRating`	The rating afterwards, with `score` `None`.

Исключения

Тип	Описание
`TypeError`	`release` is not an `int` or a `Release`.
`AuthRequiredError`	No valid session.
`NotFoundError`	No release with this ID.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `UserRating`.

ИСХОДНИК ↗

`aniliberty.resources.EpisodesResource`

класс

EpisodesResource(http: HttpClient)

Базовые классы BaseResource

Episodes of releases, available as client.episodes.

Episode IDs come from Release.episodes (client.releases.get()/list()) or Release.latest_episode (client.releases.latest()).

ИСХОДНИК ↗

`get`

методasync

get(episode: str | Episode) -> Episode

Get one episode, with its HLS links and its release.

Параметры

Имя	Тип	Описание
`episode`	`str \| Episode`	Episode ID, a UUID string such as `"a159552a-9fa7-4737-867b-d22cf7115602"`, or an `Episode` (e.g. from `Release.episodes`, to get it with its release).

Возвращает

Тип	Описание
`Episode`	The episode, with `release` filled in — the release (without `genres`) and
`Episode`	all of its episodes.

Исключения

Тип	Описание
`NotFoundError`	No episode with this ID (also for IDs that aren't UUIDs).
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Episode`.

Example

PYTHON

release = await client.releases.get("tensei-shitara-ken-deshita-2nd-season")
episode = await client.episodes.get(release.episodes[0].id)
print(episode.ordinal, episode.hls_1080 or episode.hls_720)

ИСХОДНИК ↗

`timecode`

методasync

timecode(episode: str | Episode) -> EpisodeView

Get the logged-in user's watch record of an episode. Needs a session.

Records appear about a minute after client.me.views.save_timecodes(); for the positions saved just now use client.me.views.timecodes().

Параметры

Имя	Тип	Описание
`episode`	`str \| Episode`	Episode ID (a UUID string), or an `Episode`.

Возвращает

Тип	Описание
`EpisodeView`	Where the user stopped in the episode and whether they finished it.

Исключения

Тип	Описание
`NotFoundError`	The user has no record for this episode (yet), or there is no such episode.
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `EpisodeView`.

ИСХОДНИК ↗

`aniliberty.resources.CatalogResource`

класс

CatalogResource(http: HttpClient)

Базовые классы BaseResource

The release catalog with filters and sorting, available as client.catalog.

How the filters combine (checked against the live API, see docs/api-notes.md):

genres: a release must have all of the given genres (AND);
types, seasons, age_ratings, publish_statuses, production_statuses: any of the given values (OR);
different filters: all of them must match (AND);
year_from/year_to: inclusive on both ends;
search: the same matching as client.app.search_releases(), and likewise capped at about 20 matches in total, whatever the other filters and the page size.

Without sorting, releases come in "FRESH_AT_DESC" order (recently updated first).

Атрибуты

Имя	Тип	Описание
`references`		Values the catalog filters accept.

ИСХОДНИК ↗

`releases`

методasync

releases(
    *,
    genres: Sequence[int | Genre] | None = None,
    types: Sequence[ReleaseType | ValueDescription[str]] | None = None,
    seasons: Sequence[Season | ValueDescription[str]] | None = None,
    year_from: int | None = None,
    year_to: int | None = None,
    search: str | None = None,
    sorting: CatalogSorting | SortingOption | None = None,
    age_ratings: Sequence[AgeRatingValue | ValueDescription[str]] | None = None,
    publish_statuses: Sequence[PublishStatus | ValueDescription[str]] | None = None,
    production_statuses: Sequence[ProductionStatus | ValueDescription[str]] | None = None,
    page: int | None = None,
    limit: int | None = None,
    refresh: bool = False,
) -> Page[Release]

Get one page of catalog releases matching the filters.

Every filter is optional; without any, this is the whole catalog. Values can be passed as plain strings/IDs or as the items client.catalog.references returns. To go through all pages, use iter_releases().

Параметры

Имя	Тип	Описание	По умолчанию
`genres`	`Sequence[int \| Genre] \| None`	Genre IDs (or `Genre` objects); a release must have all of them.	`None`
`types`	`Sequence[ReleaseType \| ValueDescription[str]] \| None`	Release types, e.g. `["TV", "MOVIE"]`; any of them.	`None`
`seasons`	`Sequence[Season \| ValueDescription[str]] \| None`	Seasons, e.g. `["winter"]`; any of them.	`None`
`year_from`	`int \| None`	Earliest release year, inclusive.	`None`
`year_to`	`int \| None`	Latest release year, inclusive.	`None`
`search`	`str \| None`	Text to search in names (capped at about 20 matches by the API).	`None`
`sorting`	`CatalogSorting \| SortingOption \| None`	Sort order, e.g. `"RATING_DESC"`. Default: `"FRESH_AT_DESC"`.	`None`
`age_ratings`	`Sequence[AgeRatingValue \| ValueDescription[str]] \| None`	Age ratings, e.g. `["R16_PLUS"]`; any of them.	`None`
`publish_statuses`	`Sequence[PublishStatus \| ValueDescription[str]] \| None`	`"IS_ONGOING"` and/or `"IS_NOT_ONGOING"`.	`None`
`production_statuses`	`Sequence[ProductionStatus \| ValueDescription[str]] \| None`	`"IS_IN_PRODUCTION"` and/or `"IS_NOT_IN_PRODUCTION"`.	`None`
`page`	`int \| None`	Page number, starting at 1. A page past the last one is empty.	`None`
`limit`	`int \| None`	Page size, 1 to 50.	`None`
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`Page[Release]`	One page of releases, with `genres` filled in.

Исключения

Тип	Описание
`ValueError`	A filter value isn't one the API knows, or `year_from` is after `year_to`. The API itself would silently return no releases (or ignore the filter) instead of reporting these, so they are checked here.
`TypeError`	A list filter got a single string (`types="TV"`) or a value of the wrong type.
`ValidationError`	`page` or `limit` is out of range.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Release`.

Example

PYTHON

page = await client.catalog.releases(
    genres=[14], types=["TV"], year_from=2020, sorting="RATING_DESC", limit=25
)
print(f"{page.total} releases, page 1 of {page.total_pages}")

ИСХОДНИК ↗

`iter_releases`

метод

iter_releases(
    *,
    genres: Sequence[int | Genre] | None = None,
    types: Sequence[ReleaseType | ValueDescription[str]] | None = None,
    seasons: Sequence[Season | ValueDescription[str]] | None = None,
    year_from: int | None = None,
    year_to: int | None = None,
    search: str | None = None,
    sorting: CatalogSorting | SortingOption | None = None,
    age_ratings: Sequence[AgeRatingValue | ValueDescription[str]] | None = None,
    publish_statuses: Sequence[PublishStatus | ValueDescription[str]] | None = None,
    production_statuses: Sequence[ProductionStatus | ValueDescription[str]] | None = None,
    limit: int | None = None,
    refresh: bool = False,
) -> AsyncIterator[Release]

Iterate over all catalog releases matching the filters, fetching page by page.

Takes the same filters as releases(). The next page is requested only once the current one has been consumed, so breaking out of the loop early stops the requests. The whole catalog is a couple of thousand releases — iterate all of it only when you really need everything.

Параметры

Имя	Тип	Описание	По умолчанию
`genres`	`Sequence[int \| Genre] \| None`	See `releases()`.	`None`
`types`	`Sequence[ReleaseType \| ValueDescription[str]] \| None`	See `releases()`.	`None`
`seasons`	`Sequence[Season \| ValueDescription[str]] \| None`	See `releases()`.	`None`
`year_from`	`int \| None`	See `releases()`.	`None`
`year_to`	`int \| None`	See `releases()`.	`None`
`search`	`str \| None`	See `releases()`.	`None`
`sorting`	`CatalogSorting \| SortingOption \| None`	See `releases()`.	`None`
`age_ratings`	`Sequence[AgeRatingValue \| ValueDescription[str]] \| None`	See `releases()`.	`None`
`publish_statuses`	`Sequence[PublishStatus \| ValueDescription[str]] \| None`	See `releases()`.	`None`
`production_statuses`	`Sequence[ProductionStatus \| ValueDescription[str]] \| None`	See `releases()`.	`None`
`limit`	`int \| None`	Page size, 1 to 50 — affects how many requests are made, not the result.	`None`
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`AsyncIterator[Release]`	An async iterator over the releases.

Исключения

Тип	Описание
`ValueError`	Invalid filter values — raised right away, not when iteration starts.
`TypeError`	A list filter got a single string or a value of the wrong type.

ИСХОДНИК ↗

`aniliberty.resources.CatalogReferencesResource`

класс

CatalogReferencesResource(http: HttpClient)

Базовые классы BaseResource

Values the catalog filters accept, available as client.catalog.references.

Each method returns the list the site shows in its catalog filters. Use them instead of hardcoding values: the value (or id for genres, the number for years) of an item is exactly what the corresponding catalog filter takes.

The lists are small and change rarely — fetching them once per program run is enough.

ИСХОДНИК ↗

`genres`

методasync

genres(*, refresh: bool = False) -> list[Genre]

Get the genres the catalog can be filtered by.

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`list[Genre]`	Genres with `id` and `name` only — `image` and `total_releases` are
`list[Genre]`	`None` here, this list doesn't include them.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Genre`.

Example

PYTHON

genres = await client.catalog.references.genres()
action = next(genre for genre in genres if genre.name == "Экшен")
page = await client.catalog.releases(genres=[action])

ИСХОДНИК ↗

`types`

методasync

types(*, refresh: bool = False) -> list[ValueDescription[str]]

Get the release types, e.g. value="TV", description="ТВ".

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`list[ValueDescription[str]]`	The release types.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `ValueDescription`.

ИСХОДНИК ↗

`seasons`

методasync

seasons(*, refresh: bool = False) -> list[ValueDescription[str]]

Get the seasons, e.g. value="winter", description="Зима".

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`list[ValueDescription[str]]`	The seasons.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `ValueDescription`.

ИСХОДНИК ↗

`years`

методasync

years(*, refresh: bool = False) -> list[int]

Get the years that have releases in the catalog, oldest first.

Only years with at least one release are listed, so the range can have gaps.

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`list[int]`	The years.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response wasn't a list of integers.

ИСХОДНИК ↗

`age_ratings`

методasync

age_ratings(*, refresh: bool = False) -> list[AgeRating]

Get the age ratings, e.g. value="R16_PLUS", label="16+".

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`list[AgeRating]`	The age ratings (`is_adult` is `None` here — this list doesn't include it).

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `AgeRating`.

ИСХОДНИК ↗

`publish_statuses`

методasync

publish_statuses(
    *,
    refresh: bool = False,
) -> list[ValueDescription[str]]

Get the airing statuses, e.g. value="IS_ONGOING", description="Онгоинг".

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`list[ValueDescription[str]]`	The publish statuses.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `ValueDescription`.

Example

PYTHON

statuses = await client.catalog.references.publish_statuses()
ongoing = next(s for s in statuses if s.value == "IS_ONGOING")
page = await client.catalog.releases(publish_statuses=[ongoing])

ИСХОДНИК ↗

`production_statuses`

методasync

production_statuses(
    *,
    refresh: bool = False,
) -> list[ValueDescription[str]]

Get the dubbing statuses, e.g. value="IS_IN_PRODUCTION".

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`list[ValueDescription[str]]`	The production statuses.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `ValueDescription`.

ИСХОДНИК ↗

`sorting`

методasync

sorting(*, refresh: bool = False) -> list[SortingOption]

Get the ways the catalog can be sorted, e.g. value="FRESH_AT_DESC".

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`list[SortingOption]`	The sorting options.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `SortingOption`.

ИСХОДНИК ↗

`aniliberty.resources.ScheduleResource`

класс

ScheduleResource(http: HttpClient)

Базовые классы BaseResource

The weekly airing schedule of ongoing releases, available as client.schedule.

ИСХОДНИК ↗

`now`

методasync

now(*, refresh: bool = False) -> ScheduleNow

Get the releases scheduled for yesterday, today and tomorrow.

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`ScheduleNow`	The schedule for the three days. Each item says whether this week's episode is
`ScheduleNow`	already out (`published_release_episode`) and which one comes next.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `ScheduleNow`.

Example

PYTHON

schedule = await client.schedule.now()
for item in schedule.today:
    episode = item.published_release_episode
    status = f"episode {episode.ordinal} is out" if episode else "not out yet"
    print(item.release.name.main, "—", status)

ИСХОДНИК ↗

`week`

методasync

week(*, refresh: bool = False) -> list[ScheduledRelease]

Get the schedule for the whole current week.

The list is not ordered by weekday; group or sort it by item.release.publish_day.value (1 = Monday ... 7 = Sunday) as needed.

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`list[ScheduledRelease]`	All releases in this week's schedule.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `ScheduledRelease`.

Example

PYTHON

by_day: dict[int, list[ScheduledRelease]] = {}
for item in await client.schedule.week():
    day = item.release.publish_day.value if item.release.publish_day else 0
    by_day.setdefault(day, []).append(item)

ИСХОДНИК ↗

`aniliberty.resources.GenresResource`

класс

GenresResource(http: HttpClient)

Базовые классы BaseResource

Anime genres with their images and release counts, available as client.genres.

To filter the catalog by several genres at once, use client.catalog.releases(genres=...); releases() here lists the releases of one genre.

ИСХОДНИК ↗

`list`

методasync

list(*, refresh: bool = False) -> builtins.list[Genre]

Get all genres.

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`builtins.list[Genre]`	Every genre, with `image` and `total_releases` filled in.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Genre`.

ИСХОДНИК ↗

`get`

методasync

get(genre: int | Genre, *, refresh: bool = False) -> Genre

Get one genre.

Параметры

Имя	Тип	Описание	По умолчанию
`genre`	`int \| Genre`	Genre ID, or a `Genre` (e.g. from `client.catalog.references.genres()`, which has no image) to fetch its full data.
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`Genre`	The genre, with `image` and `total_releases`.

Исключения

Тип	Описание
`NotFoundError`	No genre with this ID.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Genre`.

ИСХОДНИК ↗

`random`

методasync

random(*, limit: int | None = None) -> builtins.list[Genre]

Get random genres.

Параметры

Имя	Тип	Описание	По умолчанию
`limit`	`int \| None`	How many genres to return. A value outside 1..(number of genres) isn't an error: the API returns all genres instead.	`None`

Возвращает

Тип	Описание
`builtins.list[Genre]`	The genres, in random order.

Исключения

Тип	Описание
`ValidationError`	`limit` isn't a number.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Genre`.

ИСХОДНИК ↗

`releases`

методasync

releases(
    genre: int | Genre,
    *,
    page: int | None = None,
    limit: int | None = None,
    refresh: bool = False,
) -> Page[Release]

Get one page of the releases of a genre.

The order is the API's own (neither by update date nor by year). For sorting and for combining genres with other filters, use client.catalog.releases(genres=[...]).

Параметры

Имя	Тип	Описание	По умолчанию
`genre`	`int \| Genre`	Genre ID or `Genre`.
`page`	`int \| None`	Page number, starting at 1. The API treats 0 and negative numbers as 1.	`None`
`limit`	`int \| None`	Page size, 1 to 30 here (not 50 as in the catalog). Omitted, the API uses 15.	`None`
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`Page[Release]`	One page of releases, with `genres` filled in.

Исключения

Тип	Описание
`NotFoundError`	No genre with this ID.
`ValidationError`	`limit` is out of range.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Release`.

ИСХОДНИК ↗

`iter_releases`

метод

iter_releases(
    genre: int | Genre,
    *,
    limit: int | None = None,
    refresh: bool = False,
) -> AsyncIterator[Release]

Iterate over all releases of a genre, fetching page by page.

Параметры

Имя	Тип	Описание	По умолчанию
`genre`	`int \| Genre`	Genre ID or `Genre`.
`limit`	`int \| None`	Page size, 1 to 30 — affects how many requests are made, not the result.	`None`
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`AsyncIterator[Release]`	An async iterator over the releases.

Исключения

Тип	Описание
`TypeError`	`genre` isn't an ID or a `Genre` — raised right away.

ИСХОДНИК ↗

`aniliberty.resources.FranchisesResource`

класс

FranchisesResource(http: HttpClient)

Базовые классы BaseResource

Franchises — groups of related releases, available as client.franchises.

ИСХОДНИК ↗

`list`

методasync

list(*, refresh: bool = False) -> builtins.list[Franchise]

Get all franchises (a few hundred, in one response).

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`builtins.list[Franchise]`	Every franchise, without `franchise_releases`.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Franchise`.

ИСХОДНИК ↗

`get`

методasync

get(franchise: str | Franchise, *, refresh: bool = False) -> Franchise

Get one franchise with its releases.

Параметры

Имя	Тип	Описание	По умолчанию
`franchise`	`str \| Franchise`	Franchise ID (a UUID string), or a `Franchise` from `list()` / `random()` to fetch its releases.
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`Franchise`	The franchise, with `franchise_releases` in order.

Исключения

Тип	Описание
`NotFoundError`	No franchise with this ID.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Franchise`.

Example

PYTHON

franchise = (await client.franchises.list())[0]
full = await client.franchises.get(franchise)
print(full.name, [fr.release.name.main for fr in full.franchise_releases])

ИСХОДНИК ↗

`random`

методasync

random(*, limit: int | None = None) -> builtins.list[Franchise]

Get random franchises.

Параметры

Имя	Тип	Описание	По умолчанию
`limit`	`int \| None`	How many franchises to return. Omitted, 0, or more than there are, the API returns all franchises (a few hundred) — pass a limit.	`None`

Возвращает

Тип	Описание
`builtins.list[Franchise]`	The franchises, without `franchise_releases`.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Franchise`.

ИСХОДНИК ↗

`for_release`

методasync

for_release(
    release: int | Release,
    *,
    refresh: bool = False,
) -> builtins.list[Franchise]

Get the franchises a release belongs to.

Параметры

Имя	Тип	Описание	По умолчанию
`release`	`int \| Release`	Release ID, or a `Release`. Only numeric IDs work here: the API answers an alias with a 404 even for an existing release, so a `str` is rejected.
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`builtins.list[Franchise]`	The franchises (usually one), with `franchise_releases`; an empty list if the
`builtins.list[Franchise]`	release isn't part of any franchise.

Исключения

Тип	Описание
`TypeError`	`release` is not an `int` or a `Release`.
`NotFoundError`	No release with this ID.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Franchise`.

Example

PYTHON

release = await client.releases.get("sousou-no-frieren")
for franchise in await client.franchises.for_release(release):
    print(franchise.name, [r.release.name.main for r in franchise.franchise_releases])

ИСХОДНИК ↗

`aniliberty.resources.TorrentsResource`

класс

TorrentsResource(http: HttpClient)

Базовые классы BaseResource

Torrents of releases, their .torrent files and RSS feeds, as client.torrents.

A torrent is identified by its numeric id or its info hash; every method that takes a torrent also accepts a Torrent object.

ИСХОДНИК ↗

`list`

методasync

list(
    *,
    page: int | None = None,
    limit: int | None = None,
) -> Page[Torrent]

Get one page of all torrents.

Параметры

Имя	Тип	Описание	По умолчанию
`page`	`int \| None`	Page number, starting at 1.	`None`
`limit`	`int \| None`	Page size, 1 to 50.	`None`

Возвращает

Тип	Описание
`Page[Torrent]`	One page of torrents, each with its `release`, most recently updated first.

Исключения

Тип	Описание
`ValidationError`	`page` or `limit` is out of range.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Torrent`.

ИСХОДНИК ↗

`iter_list`

метод

iter_list(*, limit: int | None = None) -> AsyncIterator[Torrent]

Iterate over all torrents (a few thousand), fetching page by page.

Параметры

Имя	Тип	Описание	По умолчанию
`limit`	`int \| None`	Page size, 1 to 50 — affects how many requests are made, not the result.	`None`

Возвращает

Тип	Описание
`AsyncIterator[Torrent]`	An async iterator over the torrents.

Исключения

Тип	Описание
`ValidationError`	`limit` is out of range — raised once iteration starts.
`APIError`	The API answered with another error, while iterating.
`TransportError`	A request failed without a response, while iterating.

ИСХОДНИК ↗

`get`

методasync

get(torrent: int | str | Torrent) -> Torrent

Get one torrent by its ID or info hash.

Параметры

Имя	Тип	Описание
`torrent`	`int \| str \| Torrent`	Torrent ID, info hash (any letter case), or a `Torrent`.

Возвращает

Тип	Описание
`Torrent`	The torrent, with `release` and `torrent_members`.

Исключения

Тип	Описание
`NotFoundError`	No torrent with this ID or hash.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Torrent`.

ИСХОДНИК ↗

`for_release`

методasync

for_release(release: int | Release) -> builtins.list[Torrent]

Get the torrents of a release.

Параметры

Имя	Тип	Описание
`release`	`int \| Release`	Release ID, or a `Release`. Only numeric IDs work here: the API answers an alias with a 404 even for an existing release, so a `str` is rejected.

Возвращает

Тип	Описание
`builtins.list[Torrent]`	The release's torrents; an empty list if it has none.

Исключения

Тип	Описание
`TypeError`	`release` is not an `int` or a `Release`.
`NotFoundError`	No release with this ID.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Torrent`.

Example

PYTHON

release = await client.releases.get("sousou-no-frieren")
for torrent in await client.torrents.for_release(release):
    print(torrent.label, torrent.size, torrent.seeders)

ИСХОДНИК ↗

`file`

методasync

file(torrent: int | str | Torrent) -> TorrentFile

Download a .torrent file into memory.

The files checked were 22 to 388 KB. To save one to disk without holding it in memory, use download().

Параметры

Имя	Тип	Описание
`torrent`	`int \| str \| Torrent`	Torrent ID, info hash, or a `Torrent`.

Возвращает

Тип	Описание
`TorrentFile`	The file's bytes and the file name the API suggests.

Исключения

Тип	Описание
`NotFoundError`	No torrent with this ID or hash.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.

ИСХОДНИК ↗

`download`

методasync

download(
    torrent: int | str | Torrent,
    *,
    path: str | os.PathLike[str],
) -> Path

Download a .torrent file to disk, streaming it in chunks.

The file is written to a temporary <name>.part next to the target and renamed only once complete, so a failed download never leaves a truncated .torrent behind. An existing file at the target path is overwritten.

Параметры

Имя	Тип	Описание
`torrent`	`int \| str \| Torrent`	Torrent ID, info hash, or a `Torrent`.
`path`	`str \| os.PathLike[str]`	Where to save it: a file path, or an existing directory — then the file is named as the API suggests (falling back to `<id or hash>.torrent`).

Возвращает

Тип	Описание
`Path`	The path of the saved file.

Исключения

Тип	Описание
`NotFoundError`	No torrent with this ID or hash.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`OSError`	The file couldn't be written.

ИСХОДНИК ↗

`rss`

методasync

rss(*, limit: int | None = None) -> str

Get the RSS feed of the latest torrents, as XML text.

The feed is meant for torrent clients and feed readers; each <item> has the torrent's hash (<guid>), <torrentId>, <releaseId> and an <enclosure> linking to the .torrent file. For the same data as models, use list().

Параметры

Имя	Тип	Описание	По умолчанию
`limit`	`int \| None`	How many torrents to include. Omitted, the API includes 10.	`None`

Возвращает

Тип	Описание
`str`	The RSS 2.0 document.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.

ИСХОДНИК ↗

`rss_for_release`

методasync

rss_for_release(release: int | Release) -> str

Get the RSS feed of a release's torrents, as XML text.

Параметры

Имя	Тип	Описание
`release`	`int \| Release`	Release ID, or a `Release` (aliases don't work here, as in `for_release()`).

Возвращает

Тип	Описание
`str`	The RSS 2.0 document.

Исключения

Тип	Описание
`TypeError`	`release` is not an `int` or a `Release`.
`NotFoundError`	No release with this ID.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.

ИСХОДНИК ↗

`aniliberty.resources.TeamsResource`

класс

TeamsResource(http: HttpClient)

Базовые классы BaseResource

AniLibria's own teams, roles and members, available as client.teams.

Each endpoint returns its whole list in one response (a few dozen teams and roles, a couple of hundred members); there is no pagination or filtering, so filter in Python.

ИСХОДНИК ↗

`list`

методasync

list(*, refresh: bool = False) -> builtins.list[Team]

Get all teams.

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`builtins.list[Team]`	Every team, ordered by `sort_order`.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Team`.

ИСХОДНИК ↗

`roles`

методasync

roles(*, refresh: bool = False) -> builtins.list[TeamRole]

Get all roles team members can have.

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`builtins.list[TeamRole]`	Every role, ordered by `sort_order`.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `TeamRole`.

ИСХОДНИК ↗

`users`

методasync

users(*, refresh: bool = False) -> builtins.list[TeamMember]

Get all team members, each with their team and roles.

Параметры

Имя	Тип	Описание	По умолчанию
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`builtins.list[TeamMember]`	Every member. Not sorted by team: the API interleaves teams, so group by
`builtins.list[TeamMember]`	`member.team` and sort by `member.sort_order` yourself if order matters.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `TeamMember`.

ИСХОДНИК ↗

`aniliberty.resources.MediaResource`

класс

MediaResource(http: HttpClient)

Базовые классы BaseResource

Front-page promo banners and AniLibria's YouTube videos, available as client.media.

The ads endpoints that live under /media as well (/media/vasts, /media/manifest.xml, spec tag Реклама.Vasts) are deliberately not covered.

ИСХОДНИК ↗

`promotions`

методasync

promotions() -> list[Promotion]

Get the promo banners shown on the site's front page.

Возвращает

Тип	Описание
`list[Promotion]`	Every current promotion (a handful), in random order — a new order on each
`list[Promotion]`	call. Paid ads are included; filter them out with `promo.is_ad`.

Исключения

Тип	Описание
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Promotion`.

ИСХОДНИК ↗

`videos`

методasync

videos(
    *,
    limit: int | None = None,
    refresh: bool = False,
) -> list[Video]

Get the latest videos from AniLibria's YouTube playlists, newest first.

Параметры

Имя	Тип	Описание	По умолчанию
`limit`	`int \| None`	How many videos to return, 1 to 50. Omitted, the API returns 10. 0 or a negative number returns all videos (over a thousand, more than 1 MB of JSON); more than 50 is a `ValidationError`.	`None`
`refresh`	`bool`	Fetch from the API even if the response is cached (see `AniLiberty(cache_dir=...)`); the new response replaces the cached one.	`False`

Возвращает

Тип	Описание
`list[Video]`	The videos, ordered by `created_at` from newest.

Исключения

Тип	Описание
`ValidationError`	`limit` is over 50.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Video`.

ИСХОДНИК ↗

`aniliberty.resources.AuthResource`

класс

AuthResource(http: HttpClient)

Базовые классы _SessionResource

Logging in and out, available as client.auth.

A successful login stores the session token on the client (client.token), so account methods work right after it. To reuse a session across runs, save client.token and pass it back as AniLiberty(token=...) — logging in on every run piles up sessions on the account.

Атрибуты

Имя	Тип	Описание
`otp`		Logging a device in with a one-time code.
`social`		Logging in with a social network.
`password`		Recovering a forgotten password.

ИСХОДНИК ↗

`login`

методasync

login(*, login: str, password: str) -> AuthToken

Параметры

Имя	Тип	Описание
`login`	`str`	The account's login or e-mail; the login is case-insensitive.
`password`	`str`	The account's password.

Возвращает

Тип	Описание
`AuthToken`	The new session's token, also stored as `client.token`.

Исключения

Тип	Описание
`AuthRequiredError`	Wrong login or password (HTTP 401); the API's reason is in `message`.
`ValidationError`	`login` or `password` is empty.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response. Not retried: login is a `POST`.
`ResponseParseError`	The response didn't match `AuthToken`.

ИСХОДНИК ↗

`logout`

методasync

logout() -> None

End the client's session and stop sending its token.

Only this session is ended; other sessions of the account (other devices, other logins) stay valid. client.token is None afterwards, also when the API rejects the token as already invalid.

Исключения

Тип	Описание
`AuthRequiredError`	The client has no token, or the API no longer accepts it (logged out or expired) — the session is over either way (HTTP 403).
`APIError`	The API answered with another error; the token is kept.
`TransportError`	The request failed without a response; the token is kept.

ИСХОДНИК ↗

`aniliberty.resources.OtpResource`

класс

OtpResource(http: HttpClient)

Базовые классы _SessionResource

Logging a device in with a one-time code, available as client.auth.otp.

Meant for devices where typing a password is awkward (a TV app):

The device calls issue(device_id=...) and shows the code.
The user enters the code on a device where they are logged in, which calls accept(code).
The device calls login(code=..., device_id=...) and gets its own session.

A code lives 5 minutes and logs in once.

ИСХОДНИК ↗

`issue`

методasync

issue(*, device_id: str) -> IssuedOtp

Issue a one-time code for a device. No session needed.

Asking again for the same device_id while the code is alive returns the same code.

Параметры

Имя	Тип	Описание
`device_id`	`str`	Any string identifying the device, e.g. a UUID it keeps; the same value must be passed to `login()`.

Возвращает

Тип	Описание
`IssuedOtp`	The code and the seconds it has left.

Исключения

Тип	Описание
`ValidationError`	`device_id` is empty.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `IssuedOtp`.

ИСХОДНИК ↗

`accept`

методasync

accept(code: str | int) -> None

Approve a one-time code with the client's session, letting its device log in.

Параметры

Имя	Тип	Описание
`code`	`str \| int`	The code the other device shows. Pass it as the string `issue()` returned — as an `int` a leading `0` would be lost.

Исключения

Тип	Описание
`AuthRequiredError`	The client has no valid session.
`NotFoundError`	No live code like that.
`ValidationError`	`code` is malformed.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.

ИСХОДНИК ↗

`login`

методasync

login(*, code: str | int, device_id: str) -> AuthToken

Log the device in with an accepted code, and use the session from now on.

Sent without the client's current token, if it has one: the API refuses this request from a logged-in caller (403). The new token replaces the old one.

Параметры

Имя	Тип	Описание
`code`	`str \| int`	The code from `issue()`, after it was accepted.
`device_id`	`str`	The same `device_id` that was passed to `issue()`.

Возвращает

Тип	Описание
`AuthToken`	The new session's token, also stored as `client.token`.

Исключения

Тип	Описание
`NotFoundError`	No live code for this device — wrong code or `device_id`, expired, or already used.
`ServerError`	The code hasn't been accepted yet — the API answers 500 to that.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `AuthToken`.

ИСХОДНИК ↗

`aniliberty.resources.SocialAuthResource`

класс

SocialAuthResource(http: HttpClient)

Базовые классы _SessionResource

Logging in with a social network, available as client.auth.social.

login(provider) returns an OAuth url and a state key.
The user opens url in a browser and logs in with the social network.
authenticate(state) exchanges the key for a session.

ИСХОДНИК ↗

`login`

методasync

login(provider: SocialProvider) -> SocialLogin

Start logging in with a social network.

Параметры

Имя	Тип	Описание
`provider`	`SocialProvider`	`"vk"`, `"google"`, `"patreon"` or `"discord"`.

Возвращает

Тип	Описание
`SocialLogin`	The OAuth page to send the user to, and the key to finish with.

Исключения

Тип	Описание
`ValueError`	`provider` isn't one of the above — checked before sending (the API answers 500 to unknown names).
`APIError`	The API answered with an error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `SocialLogin`.

ИСХОДНИК ↗

`authenticate`

методasync

authenticate(state: str) -> AuthToken

Finish a social login, and use the session from now on.

Параметры

Имя	Тип	Описание
`state`	`str`	`SocialLogin.state` from `login()`, after the user logged in on the OAuth page.

Возвращает

Тип	Описание
`AuthToken`	The new session's token, also stored as `client.token`.

Исключения

Тип	Описание
`NotFoundError`	Unknown `state`, or the user hasn't finished logging in yet.
`ValidationError`	`state` is empty.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `AuthToken`.

ИСХОДНИК ↗

`aniliberty.resources.PasswordResource`

класс

PasswordResource(http: HttpClient)

Базовые классы BaseResource

Recovering a forgotten password, available as client.auth.password.

ИСХОДНИК ↗

`forget`

методasync

forget(*, email: str) -> None

Ask the API to e-mail a password reset link.

The answer is the same whether or not an account has this e-mail, so it can't be used to check for one.

Параметры

Имя	Тип	Описание
`email`	`str`	The account's e-mail.

Исключения

Тип	Описание
`ValidationError`	`email` is empty or not an e-mail address.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.

ИСХОДНИК ↗

`reset`

методasync

reset(*, token: str, password: str) -> None

Set a new password with the token from the reset e-mail.

Doesn't log in: call client.auth.login() with the new password afterwards.

Параметры

Имя	Тип	Описание
`token`	`str`	The token from the link in the e-mail sent by `forget()`.
`password`	`str`	The new password (sent as both `password` and its confirmation).

Исключения

Тип	Описание
`NotFoundError`	Unknown or used `token`.
`ValidationError`	The password doesn't meet the API's rules, or a field is empty.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.

ИСХОДНИК ↗

`aniliberty.resources.MeResource`

класс

MeResource(http: HttpClient)

Базовые классы BaseResource

The logged-in user's own account, available as client.me.

Every method needs a session: log in with client.auth.login() or pass AniLiberty(token=...). Without a valid one the API answers 403, raised as AuthRequiredError.

Атрибуты

Имя	Тип	Описание
`favorites`		The user's favorite releases.
`collections`		The user's collections (planned, watched, watching, ...).
`views`		The user's watch progress (timecodes) and history.

ИСХОДНИК ↗

`profile`

методasync

profile() -> UserProfile

Get the logged-in user's profile.

Возвращает

Тип	Описание
`UserProfile`	The profile, with the account's e-mail and tracker passkey.

Исключения

Тип	Описание
`AuthRequiredError`	No session token, or the API doesn't accept it (logged out or expired).
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `UserProfile`.

ИСХОДНИК ↗

`aniliberty.resources.FavoritesResource`

класс

FavoritesResource(http: HttpClient)

Базовые классы BaseResource

The logged-in user's favorite releases, available as client.me.favorites.

Needs a session (client.auth.login() or AniLiberty(token=...)); without a valid one every method raises AuthRequiredError.

The API checks little here (see docs/api-notes.md): add() accepts IDs of releases that don't exist — they end up in ids(), though never in releases() — and adding a release twice or removing one that isn't there is silently a no-op.

Атрибуты

Имя	Тип	Описание
`references`		Values the favorites filters accept.

ИСХОДНИК ↗

`ids`

методasync

ids() -> list[int]

Get the IDs of all releases in favorites, in the order they were added.

Cheaper than releases() for checking whether a release is a favorite.

Возвращает

Тип	Описание
`list[int]`	Release IDs.

Исключения

Тип	Описание
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response wasn't a list of integers.

ИСХОДНИК ↗

`add`

методasync

add(*releases: int | Release) -> list[int]

Add releases to favorites.

Параметры

Имя	Тип	Описание	По умолчанию
`*releases`	`int \| Release`	Release IDs or `Release` objects, one or more. Releases already in favorites are skipped.	`()`

Возвращает

Тип	Описание
`list[int]`	IDs of all releases in favorites afterwards, like `ids()`.

Исключения

Тип	Описание
`ValueError`	No releases given.
`TypeError`	A value is neither an `int` nor a `Release`.
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response. Not retried: it's a `POST`, though adding again would do no harm.
`ResponseParseError`	The response wasn't a list of integers.

ИСХОДНИК ↗

`remove`

методasync

remove(*releases: int | Release) -> list[int]

Remove releases from favorites.

Параметры

Имя	Тип	Описание	По умолчанию
`*releases`	`int \| Release`	Release IDs or `Release` objects, one or more. Releases that aren't in favorites are skipped.	`()`

Возвращает

Тип	Описание
`list[int]`	IDs of the releases left in favorites, like `ids()`.

Исключения

Тип	Описание
`ValueError`	No releases given.
`TypeError`	A value is neither an `int` nor a `Release`.
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response wasn't a list of integers.

ИСХОДНИК ↗

`releases`

методasync

releases(
    *,
    genres: Sequence[int | Genre] | None = None,
    types: Sequence[ReleaseType | ValueDescription[str]] | None = None,
    years: Sequence[int] | None = None,
    search: str | None = None,
    sorting: FavoritesSorting | SortingOption | None = None,
    age_ratings: Sequence[AgeRatingValue | ValueDescription[str]] | None = None,
    page: int | None = None,
    limit: int | None = None,
) -> Page[Release]

Get one page of favorite releases matching the filters.

The filters combine like the catalog's: a release must have all of genres and any of the types, years and age_ratings; different filters must all match. To go through all pages, use iter_releases().

Параметры

Имя	Тип	Описание	По умолчанию
`genres`	`Sequence[int \| Genre] \| None`	Genre IDs (or `Genre` objects); a release must have all of them.	`None`
`types`	`Sequence[ReleaseType \| ValueDescription[str]] \| None`	Release types, e.g. `["TV", "MOVIE"]`; any of them.	`None`
`years`	`Sequence[int] \| None`	Release years; any of them. A range works too: `range(2020, 2026)`.	`None`
`search`	`str \| None`	Text to search in names.	`None`
`sorting`	`FavoritesSorting \| SortingOption \| None`	Sort order. Default: `"CREATED_AT_DESC"` (added to favorites most recently first). `"RATING_*"` sorts by how many users have the release in favorites.	`None`
`age_ratings`	`Sequence[AgeRatingValue \| ValueDescription[str]] \| None`	Age ratings, e.g. `["R16_PLUS"]`; any of them.	`None`
`page`	`int \| None`	Page number, starting at 1. A page past the last one is empty.	`None`
`limit`	`int \| None`	Page size, 1 to 50. Default: 25.	`None`

Возвращает

Тип	Описание
`Page[Release]`	One page of releases, with `genres` and `episodes` filled in.

Исключения

Тип	Описание
`ValueError`	A filter value isn't one the API knows (it would silently return nothing or ignore the filter instead).
`TypeError`	A list filter got a single value (`types="TV"`, `years=2024`) or a value of the wrong type.
`AuthRequiredError`	No valid session.
`ValidationError`	`page` or `limit` is out of range.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Release`.

ИСХОДНИК ↗

`iter_releases`

метод

iter_releases(
    *,
    genres: Sequence[int | Genre] | None = None,
    types: Sequence[ReleaseType | ValueDescription[str]] | None = None,
    years: Sequence[int] | None = None,
    search: str | None = None,
    sorting: FavoritesSorting | SortingOption | None = None,
    age_ratings: Sequence[AgeRatingValue | ValueDescription[str]] | None = None,
    limit: int | None = None,
) -> AsyncIterator[Release]

Iterate over all favorite releases matching the filters, fetching page by page.

Takes the same filters as releases(); the next page is requested only once the current one has been consumed.

Параметры

Имя	Тип	Описание	По умолчанию
`genres`	`Sequence[int \| Genre] \| None`	See `releases()`.	`None`
`types`	`Sequence[ReleaseType \| ValueDescription[str]] \| None`	See `releases()`.	`None`
`years`	`Sequence[int] \| None`	See `releases()`.	`None`
`search`	`str \| None`	See `releases()`.	`None`
`sorting`	`FavoritesSorting \| SortingOption \| None`	See `releases()`.	`None`
`age_ratings`	`Sequence[AgeRatingValue \| ValueDescription[str]] \| None`	See `releases()`.	`None`
`limit`	`int \| None`	Page size, 1 to 50 — affects how many requests are made, not the result.	`None`

Возвращает

Тип	Описание
`AsyncIterator[Release]`	An async iterator over the releases.

Исключения

Тип	Описание
`ValueError`	Invalid filter values — raised right away, not when iteration starts.
`TypeError`	A list filter got a single value or a value of the wrong type.

ИСХОДНИК ↗

`aniliberty.resources.FavoritesReferencesResource`

класс

FavoritesReferencesResource(http: HttpClient)

Базовые классы _OwnListReferencesResource

Values the favorites filters accept, available as client.me.favorites.references.

Unlike client.catalog.references, the lists only contain what occurs in the user's own favorites: the genres, types, years and age ratings of the releases added there. With empty favorites they are empty — except sorting(), which is always the full list.

ИСХОДНИК ↗

`sorting`

методasync

sorting() -> list[SortingOption]

Get the ways favorites can be sorted, e.g. value="CREATED_AT_DESC".

Возвращает

Тип	Описание
`list[SortingOption]`	All sorting options, whatever is in favorites.

Исключения

Тип	Описание
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `SortingOption`.

ИСХОДНИК ↗

`genres`

методasync

genres() -> list[Genre]

Get the genres of the releases in the list.

Возвращает

Тип	Описание
`list[Genre]`	Genres with `id` and `name` only.

Исключения

Тип	Описание
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Genre`.

ИСХОДНИК ↗

`types`

методasync

types() -> list[ValueDescription[str]]

Get the release types in the list, e.g. value="TV", description="ТВ".

Возвращает

Тип	Описание
`list[ValueDescription[str]]`	The release types.

Исключения

Тип	Описание
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `ValueDescription`.

ИСХОДНИК ↗

`years`

методasync

years() -> list[int]

Get the release years in the list, newest first.

Возвращает

Тип	Описание
`list[int]`	The years.

Исключения

Тип	Описание
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response wasn't a list of integers.

ИСХОДНИК ↗

`age_ratings`

методasync

age_ratings() -> list[AgeRating]

Get the age ratings in the list, e.g. value="R16_PLUS", label="16+".

Возвращает

Тип	Описание
`list[AgeRating]`	The age ratings (`is_adult` is `None` here).

Исключения

Тип	Описание
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `AgeRating`.

ИСХОДНИК ↗

`aniliberty.resources.CollectionsResource`

класс

CollectionsResource(http: HttpClient)

Базовые классы BaseResource

The user's collections, available as client.me.collections.

There are five collections (CollectionType): "PLANNED", "WATCHED", "WATCHING", "POSTPONED" and "ABANDONED". A release is in at most one of them: adding it to another collection moves it there. Collections are separate from favorites.

Needs a session (client.auth.login() or AniLiberty(token=...)); without a valid one every method raises AuthRequiredError. As with favorites, the API accepts IDs of releases that don't exist, and removing a release that isn't in any collection is a no-op.

The API also applies collection changes in the background (see docs/api-notes.md): a release removed right after being added can be back about a minute later, and removing a release can take minutes to stick. To be sure a change held, check ids() again a minute later.

Атрибуты

Имя	Тип	Описание
`references`		Values the collections filters accept.

ИСХОДНИК ↗

`ids`

методasync

ids() -> list[CollectionItem]

Get every release in the collections, with the collection it's in.

Возвращает

Тип	Описание
`list[CollectionItem]`	One item per release, in the order the releases were added.

Исключения

Тип	Описание
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `CollectionItem`.

ИСХОДНИК ↗

`add`

методasync

add(
    *releases: int | Release,
    to: CollectionType,
) -> list[CollectionItem]

Put releases into a collection, moving them out of the one they were in.

Параметры

Имя	Тип	Описание	По умолчанию
`*releases`	`int \| Release`	Release IDs or `Release` objects, one or more.	`()`
`to`	`CollectionType`	The collection, e.g. `"WATCHING"`.

Возвращает

Тип	Описание
`list[CollectionItem]`	Every release in the collections afterwards, like `ids()`.

Исключения

Тип	Описание
`ValueError`	No releases given, or `to` isn't a collection type.
`TypeError`	A release is neither an `int` nor a `Release`.
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `CollectionItem`.

ИСХОДНИК ↗

`remove`

методasync

remove(*releases: int | Release) -> list[CollectionItem]

Take releases out of whatever collection they are in.

Параметры

Имя	Тип	Описание	По умолчанию
`*releases`	`int \| Release`	Release IDs or `Release` objects, one or more.	`()`

Возвращает

Тип	Описание
`list[CollectionItem]`	The releases left in the collections, like `ids()`.

Исключения

Тип	Описание
`ValueError`	No releases given.
`TypeError`	A release is neither an `int` nor a `Release`.
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `CollectionItem`.

ИСХОДНИК ↗

`releases`

методasync

releases(
    collection: CollectionType,
    *,
    genres: Sequence[int | Genre] | None = None,
    types: Sequence[ReleaseType | ValueDescription[str]] | None = None,
    years: Sequence[int] | None = None,
    search: str | None = None,
    age_ratings: Sequence[AgeRatingValue | ValueDescription[str]] | None = None,
    page: int | None = None,
    limit: int | None = None,
) -> Page[Release]

Get one page of the releases in a collection, matching the filters.

Releases come most recently added first; the API offers no other order. The filters combine like the favorites' ones: all of genres, any of the types, years and age_ratings. To go through all pages, use iter_releases().

Параметры

Имя	Тип	Описание	По умолчанию
`collection`	`CollectionType`	The collection, e.g. `"PLANNED"`.
`genres`	`Sequence[int \| Genre] \| None`	Genre IDs (or `Genre` objects); a release must have all of them.	`None`
`types`	`Sequence[ReleaseType \| ValueDescription[str]] \| None`	Release types, e.g. `["TV", "MOVIE"]`; any of them.	`None`
`years`	`Sequence[int] \| None`	Release years; any of them. A range works too: `range(2020, 2026)`.	`None`
`search`	`str \| None`	Text to search in names.	`None`
`age_ratings`	`Sequence[AgeRatingValue \| ValueDescription[str]] \| None`	Age ratings, e.g. `["R16_PLUS"]`; any of them.	`None`
`page`	`int \| None`	Page number, starting at 1. A page past the last one is empty.	`None`
`limit`	`int \| None`	Page size, 1 to 50. Default: 25.	`None`

Возвращает

Тип	Описание
`Page[Release]`	One page of releases, with `genres` and `episodes` filled in.

Исключения

Тип	Описание
`ValueError`	`collection` or a filter value isn't one the API knows.
`TypeError`	A list filter got a single value or a value of the wrong type.
`AuthRequiredError`	No valid session.
`ValidationError`	`page` or `limit` is out of range.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Release`.

ИСХОДНИК ↗

`iter_releases`

метод

iter_releases(
    collection: CollectionType,
    *,
    genres: Sequence[int | Genre] | None = None,
    types: Sequence[ReleaseType | ValueDescription[str]] | None = None,
    years: Sequence[int] | None = None,
    search: str | None = None,
    age_ratings: Sequence[AgeRatingValue | ValueDescription[str]] | None = None,
    limit: int | None = None,
) -> AsyncIterator[Release]

Iterate over all releases in a collection matching the filters, page by page.

Takes the same arguments as releases(); the next page is requested only once the current one has been consumed.

Параметры

Имя	Тип	Описание	По умолчанию
`collection`	`CollectionType`	See `releases()`.
`genres`	`Sequence[int \| Genre] \| None`	See `releases()`.	`None`
`types`	`Sequence[ReleaseType \| ValueDescription[str]] \| None`	See `releases()`.	`None`
`years`	`Sequence[int] \| None`	See `releases()`.	`None`
`search`	`str \| None`	See `releases()`.	`None`
`age_ratings`	`Sequence[AgeRatingValue \| ValueDescription[str]] \| None`	See `releases()`.	`None`
`limit`	`int \| None`	Page size, 1 to 50 — affects how many requests are made, not the result.	`None`

Возвращает

Тип	Описание
`AsyncIterator[Release]`	An async iterator over the releases.

Исключения

Тип	Описание
`ValueError`	Invalid `collection` or filter values — raised right away, not when iteration starts.
`TypeError`	A list filter got a single value or a value of the wrong type.

ИСХОДНИК ↗

`aniliberty.resources.CollectionsReferencesResource`

класс

CollectionsReferencesResource(http: HttpClient)

Базовые классы _OwnListReferencesResource

Values the collections filters accept, available as client.me.collections.references.

The lists cover all the user's collections together — the API has no per-collection variant (a type_of_collection parameter is ignored). Collections can't be sorted, so unlike favorites there is no sorting().

ИСХОДНИК ↗

`genres`

методasync

genres() -> list[Genre]

Get the genres of the releases in the list.

Возвращает

Тип	Описание
`list[Genre]`	Genres with `id` and `name` only.

Исключения

Тип	Описание
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Genre`.

ИСХОДНИК ↗

`types`

методasync

types() -> list[ValueDescription[str]]

Get the release types in the list, e.g. value="TV", description="ТВ".

Возвращает

Тип	Описание
`list[ValueDescription[str]]`	The release types.

Исключения

Тип	Описание
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `ValueDescription`.

ИСХОДНИК ↗

`years`

методasync

years() -> list[int]

Get the release years in the list, newest first.

Возвращает

Тип	Описание
`list[int]`	The years.

Исключения

Тип	Описание
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response wasn't a list of integers.

ИСХОДНИК ↗

`age_ratings`

методasync

age_ratings() -> list[AgeRating]

Get the age ratings in the list, e.g. value="R16_PLUS", label="16+".

Возвращает

Тип	Описание
`list[AgeRating]`	The age ratings (`is_adult` is `None` here).

Исключения

Тип	Описание
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `AgeRating`.

ИСХОДНИК ↗

`aniliberty.resources.ViewsResource`

класс

ViewsResource(http: HttpClient)

Базовые классы BaseResource

The user's watch progress and history, available as client.me.views.

Needs a session (client.auth.login() or AniLiberty(token=...)); without a valid one every method raises AuthRequiredError.

The API stores timecodes in two steps (see docs/api-notes.md):

save_timecodes() shows up in timecodes() at once, but in history(), client.episodes.timecode() and client.releases.timecodes() only about a minute later.
remove_timecodes() likewise takes about a minute to reach the history, and timecodes() can keep listing the deleted entries after that; deleting them once more after the minute clears them.

Example

PYTHON

await client.me.views.save_timecodes(
    Timecode(release_episode_id=episode.id, time=743.5, is_watched=False)
)
progress = {t.release_episode_id: t for t in await client.me.views.timecodes()}

ИСХОДНИК ↗

`timecodes`

методasync

timecodes(*, since: datetime | None = None) -> list[Timecode]

Get the user's timecodes — the position in every episode they started.

Параметры

Имя	Тип	Описание	По умолчанию
`since`	`datetime \| None`	Only timecodes saved at or after this moment. Must be timezone-aware (e.g. `datetime.now(UTC) - timedelta(days=7)`).	`None`

Возвращает

Тип	Описание
`list[Timecode]`	The timecodes, in no documented order (updating one doesn't move it).

Исключения

Тип	Описание
`ValueError`	`since` has no time zone.
`AuthRequiredError`	No valid session.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `Timecode`.

ИСХОДНИК ↗

`save_timecodes`

методasync

save_timecodes(*timecodes: Timecode) -> None

Save the position in one or more episodes, replacing what was saved for them.

Параметры

Имя	Тип	Описание	По умолчанию
`*timecodes`	`Timecode`	One `Timecode` per episode.	`()`

Исключения

Тип	Описание
`ValueError`	No timecodes given.
`TypeError`	A value isn't a `Timecode`.
`AuthRequiredError`	No valid session.
`ValidationError`	An episode ID isn't a UUID. An ID of an episode that doesn't exist is accepted, and dropped later by the API.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.

ИСХОДНИК ↗

`remove_timecodes`

методasync

remove_timecodes(*episodes: str | Episode | Timecode) -> None

Delete the saved position in one or more episodes (and their history entries).

Episodes without a timecode are skipped. See the class docs: the deletion takes about a minute, and timecodes() may need a second call after that.

Параметры

Имя	Тип	Описание	По умолчанию
`*episodes`	`str \| Episode \| Timecode`	Episode IDs, or `Episode`/`Timecode` objects.	`()`

Исключения

Тип	Описание
`ValueError`	No episodes given.
`TypeError`	A value isn't an episode ID, `Episode` or `Timecode`.
`AuthRequiredError`	No valid session.
`ValidationError`	An episode ID isn't a UUID.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.

ИСХОДНИК ↗

`history`

методasync

history(
    *,
    page: int | None = None,
    limit: int | None = None,
) -> Page[HistoryEntry]

Get one page of the watch history — one entry per episode, most recent first.

Параметры

Имя	Тип	Описание	По умолчанию
`page`	`int \| None`	Page number, starting at 1. A page past the last one is empty.	`None`
`limit`	`int \| None`	Page size, 1 to 50. Default: 25.	`None`

Возвращает

Тип	Описание
`Page[HistoryEntry]`	One page of entries, each with its episode and the episode's release.

Исключения

Тип	Описание
`AuthRequiredError`	No valid session.
`ValidationError`	`page` or `limit` is out of range.
`APIError`	The API answered with another error.
`TransportError`	The request failed without a response.
`ResponseParseError`	The response didn't match `HistoryEntry`.

Example

PYTHON

page = await client.me.views.history(limit=10)
for entry in page.items:
    episode = entry.release_episode
    print(episode.release.name.main, episode.ordinal, entry.time)

ИСХОДНИК ↗

`iter_history`

метод

iter_history(*, limit: int | None = None) -> AsyncIterator[HistoryEntry]

Iterate over the whole watch history, fetching page by page.

Параметры

Имя	Тип	Описание	По умолчанию
`limit`	`int \| None`	Page size, 1 to 50 — affects how many requests are made, not the result.	`None`

Возвращает

Тип	Описание
`AsyncIterator[HistoryEntry]`	An async iterator over the entries, most recent first.

Исключения

Тип	Описание
`AuthRequiredError`	No valid session — raised once iteration starts.
`ValidationError`	`limit` is out of range — raised once iteration starts.
`APIError`	The API answered with another error, while iterating.
`TransportError`	A request failed without a response, while iterating.

ИСХОДНИК ↗

Pagination

`aniliberty.Page`

класс

Page()

Базовые классы AniLibertyModel, Generic[T]

One page of results from a paginated endpoint.

Paginated endpoints answer with {"data": [...], "meta": {"pagination": {...}}} (see docs/api-notes.md); Page flattens that into the fields below. Pages are numbered from 1. To walk through all pages, use the matching iter_*() method instead of calling the paginated one in a loop.

Атрибуты

Имя	Тип	Описание
`items`	`list[T]`	Items on this page.
`page`	`int`	Number of this page, starting at 1.
`limit`	`int`	Page size that was requested (`per_page` in the API).
`total`	`int`	Number of items on all pages.
`total_pages`	`int`	Number of pages.

Example

PYTHON

page = await client.catalog.releases(page=1, limit=25)
print(f"page {page.page} of {page.total_pages}, {page.total} releases in total")
for release in page.items:
    print(release.name.main)

ИСХОДНИК ↗

`has_next_page`

атрибутсвойство

has_next_page: bool

Whether there are more pages after this one.

ИСХОДНИК ↗

Models

Releases

`aniliberty.Release`

класс

Release()

Базовые классы AniLibertyModel

An anime release.

Spec schema: models.anime.releases.v1.release plus the extra fields each endpoint adds. List endpoints fill only part of the extras: genres comes with every endpoint except Episode.release, background_covers with random() and get(), members/sponsors with get() and list(), episodes with get(), list() and Episode.release, latest_episode with latest() only. An extra the endpoint doesn't send is an empty list or None.

Атрибуты

Имя	Тип	Описание
`id`	`int`	Release ID.
`alias`	`str`	URL slug, e.g. `"tensei-shitara-ken-deshita-2nd-season"`; `get()` accepts it as well as the ID.
`name`	`ReleaseName`	Release names.
`type`	`Annotated[ValueDescription[str] \| None, EMPTY_VALUE_AS_NONE]`	Release type; `type.value` is one of `TV`, `ONA`, `WEB`, `OVA`, `OAD`, `MOVIE`, `DORAMA`, `SPECIAL` (spec enum `enums.anime.releases.release.type`).
`year`	`int \| None`	Release year.
`season`	`Annotated[ValueDescription[str] \| None, EMPTY_VALUE_AS_NONE]`	Release season; `season.value` is one of `winter`, `spring`, `summer`, `autumn`.
`poster`	`Image \| None`	Release poster.
`description`	`str \| None`	Synopsis, in Russian.
`notification`	`str \| None`	Important notice shown on the release page, if any.
`age_rating`	`Annotated[AgeRating \| None, EMPTY_VALUE_AS_NONE]`	Age rating.
`publish_day`	`Annotated[ValueDescription[int] \| None, EMPTY_VALUE_AS_NONE]`	Weekday new episodes come out on; `publish_day.value` is 1 (Monday) to 7 (Sunday).
`is_ongoing`	`bool`	Whether the anime is still airing in its home country.
`is_in_production`	`bool`	Whether AniLibria is still dubbing it.
`is_blocked_by_geo`	`bool`	Whether it's blocked in the requester's region.
`is_blocked_by_copyrights`	`bool`	Whether it's blocked by the copyright holder.
`episodes_total`	`int \| None`	Number of episodes, if known.
`average_duration_of_episode`	`int \| None`	Average episode length, in minutes, if known.
`external_player`	`str \| None`	Link to an external player, if any.
`fresh_at`	`datetime \| None`	When the release was last bumped (e.g. by a new episode).
`created_at`	`datetime \| None`	When the release was added.
`updated_at`	`datetime \| None`	When the release was last edited.
`added_in_users_favorites`	`int`	How many users added it to favorites.
`added_in_planned_collection`	`int`	How many users put it in their "planned" collection.
`added_in_watched_collection`	`int`	How many users put it in "watched".
`added_in_watching_collection`	`int`	How many users put it in "watching".
`added_in_postponed_collection`	`int`	How many users put it in "postponed".
`added_in_abandoned_collection`	`int`	How many users put it in "abandoned".
`shikimori`	`ExternalRating \| None`	Entry on Shikimori.
`mal`	`ExternalRating \| None`	Entry on MyAnimeList.
`rating`	`ReleaseRating \| None`	Score from AniLibria users.
`genres`	`list[Genre]`	Genres of the release.
`background_covers`	`list[ImageSet]`	Wide cover images for a page background.
`members`	`list[ReleaseMember]`	People who worked on the release.
`sponsors`	`list[Sponsor]`	Sponsors shown on the release page.
`episodes`	`list[Episode]`	All episodes of the release, in order.
`latest_episode`	`Episode \| None`	The newest episode — only filled in by `client.releases.latest()`.

ИСХОДНИК ↗

`aniliberty.ReleaseName`

класс

ReleaseName()

Базовые классы AniLibertyModel

Names of a release.

Атрибуты

Имя	Тип	Описание
`main`	`str`	The main (Russian) title.
`english`	`str \| None`	The English or romanized title.
`alternative`	`str \| None`	Other titles, comma-separated, if any.

ИСХОДНИК ↗

`aniliberty.AgeRating`

класс

AgeRating()

Базовые классы ValueDescription[str]

Age rating of a release, e.g. value="R16_PLUS", label="16+".

value is one of R0_PLUS, R6_PLUS, R12_PLUS, R16_PLUS, R18_PLUS (spec enum enums.anime.releases.release.ageRating).

Атрибуты

Имя	Тип	Описание
`label`	`str \| None`	Short label, e.g. `"16+"`.
`is_adult`	`bool \| None`	Whether the release is for adults only.

ИСХОДНИК ↗

`aniliberty.ReleaseRating`

класс

ReleaseRating()

Базовые классы AniLibertyModel

Score given to a release by AniLibria users.

Атрибуты

Имя	Тип	Описание
`average`	`float \| None`	Average score from 1 to 10, `None` if nobody rated it yet.
`votes`	`int`	Number of people who rated it.
`distribution`	`dict[int, int]`	Number of votes per score, for every score from 1 to 10.

ИСХОДНИК ↗

`aniliberty.UserRating`

класс

UserRating()

Базовые классы AniLibertyModel

The logged-in user's own score for a release, from client.releases.ratings.

Spec schema: models.anime.releases.v1.release.rating.own.

Атрибуты

Имя	Тип	Описание
`release_id`	`int`	Release ID.
`score`	`int \| None`	The user's score, 1 to 10; `None` if they haven't rated the release.

ИСХОДНИК ↗

`aniliberty.ExternalRating`

класс

ExternalRating()

Базовые классы AniLibertyModel

A release's entry and score on an external site (Shikimori or MyAnimeList).

All fields are None when the release isn't linked to that site.

Атрибуты

Имя	Тип	Описание
`id`	`int \| None`	ID of the anime on the external site.
`url`	`str \| None`	Link to the anime's page there.
`rating`	`float \| None`	Average score there, from 1 to 10.
`votes`	`int \| None`	Number of people who rated it there.

ИСХОДНИК ↗

`aniliberty.ReleaseMember`

класс

ReleaseMember()

Базовые классы AniLibertyModel

A person who worked on a release (voice actor, translator, timer, ...).

Spec schema: models.anime.releases.v1.release.member.

Атрибуты

Имя	Тип	Описание
`id`	`str`	Member entry ID (a UUID string).
`nickname`	`str`	The member's nickname.
`role`	`Annotated[ValueDescription[str] \| None, EMPTY_VALUE_AS_NONE]`	What they did. `role.value` is one of `poster`, `timing`, `voicing`, `editing`, `decorating`, `translating`, `hevc` (spec enum `enums.anime.releases.release.member.role`).
`user`	`LinkedAccount \| None`	Linked site account, if any (usually `None`).

ИСХОДНИК ↗

`aniliberty.Sponsor`

класс

Sponsor()

Базовые классы AniLibertyModel

A sponsor shown on a release page.

Spec schema: models.anime.sponsors.v1.sponsor.

Атрибуты

Имя	Тип	Описание
`id`	`str`	Sponsor ID.
`title`	`str \| None`	Sponsor name.
`description`	`str \| None`	Sponsor description.
`url`	`str \| None`	Sponsor link.
`url_title`	`str \| None`	Text of the sponsor link.

ИСХОДНИК ↗

`aniliberty.Genre`

класс

Genre()

Базовые классы AniLibertyModel

An anime genre.

Spec schema: models.anime.genres.v1.genre.

Атрибуты

Имя	Тип	Описание
`id`	`int`	Genre ID — the value to pass to catalog genre filters.
`name`	`str`	Genre name, in Russian (e.g. `"Экшен"`).
`image`	`Image \| None`	Genre cover image.
`total_releases`	`int \| None`	Number of releases with this genre.

ИСХОДНИК ↗

Episodes

`aniliberty.Episode`

класс

Episode()

Базовые классы AniLibertyModel

An episode of a release, with links to its HLS streams.

Spec schema: models.anime.releases.v1.release.episode. HLS links are absolute URLs of .m3u8 playlists on the video CDN, returned exactly as the API sends them — their query string (country, ads flags, ...) is part of the link. Downloading the video itself is out of scope for the SDK: hand the playlist to a player or to ffmpeg.

Атрибуты

Имя	Тип	Описание
`id`	`str`	Episode ID (a UUID string) — pass it to `client.episodes.get()`.
`release_id`	`int`	ID of the release the episode belongs to.
`ordinal`	`int \| float`	Episode number. Usually an `int`; the spec allows fractions such as `12.5` for recap/special episodes, which come as a `float`.
`sort_order`	`int`	Position of the episode in the release's list.
`name`	`str \| None`	Episode title, in Russian, if it has one (most don't).
`name_english`	`str \| None`	Episode title in English, if any.
`duration`	`int`	Length, in seconds.
`opening`	`Annotated[SkipRange \| None, BeforeValidator(_empty_skip_as_none)]`	Where the opening is, `None` if not marked.
`ending`	`Annotated[SkipRange \| None, BeforeValidator(_empty_skip_as_none)]`	Where the ending is, `None` if not marked.
`preview`	`Image \| None`	Still image from the episode. Often present with all paths `None`.
`hls_480`	`str \| None`	HLS playlist, 480p.
`hls_720`	`str \| None`	HLS playlist, 720p.
`hls_1080`	`str \| None`	HLS playlist, 1080p — missing on some episodes.
`rutube_id`	`str \| None`	ID of the episode on Rutube, if it's published there.
`youtube_id`	`str \| None`	ID of the episode on YouTube, if it's published there.
`updated_at`	`datetime \| None`	When the episode was last updated.
`release`	`Release \| None`	The release with all its episodes — only filled in by `client.episodes.get()`.

ИСХОДНИК ↗

`aniliberty.SkipRange`

класс

SkipRange()

Базовые классы AniLibertyModel

Where an opening or ending is, so a player can offer to skip it.

The spec describes the numbers as "seconds from the start or the end of the episode"; in every live sample checked they were seconds from the start (an ending of a 1502-second episode at 1326–1502), see docs/api-notes.md.

Атрибуты

Имя	Тип	Описание
`start`	`int \| None`	Where the segment starts, in seconds.
`stop`	`int \| None`	Where the segment ends, in seconds.

ИСХОДНИК ↗

Franchises

`aniliberty.Franchise`

класс

Franchise()

Базовые классы AniLibertyModel

A franchise: a group of related releases (seasons, movies, spin-offs).

Spec schema: models.anime.franchises.v1.franchise. The totals are precomputed by the API and can be missing or stale — two franchises with total_releases=None still had two releases each — so count franchise_releases when the exact number matters.

Атрибуты

Имя	Тип	Описание
`id`	`str`	Franchise ID (a UUID string).
`name`	`str`	Name in Russian.
`name_english`	`str \| None`	Name in English or romanized.
`image`	`Image \| None`	Franchise cover image (its paths can be `None`).
`rating`	`float \| None`	Franchise rating — `None` for every franchise at the time of writing.
`first_year`	`int \| None`	Year of the first release.
`last_year`	`int \| None`	Year of the latest release.
`total_releases`	`int \| None`	Number of releases.
`total_episodes`	`int \| None`	Number of episodes across all releases.
`total_duration`	`str \| None`	Total watch time as human-readable Russian text, e.g. `"10 часов"`.
`total_duration_in_seconds`	`int \| None`	Total watch time, in seconds.
`franchise_releases`	`list[FranchiseRelease]`	The releases, ordered by `sort_order` — only filled in by `client.franchises.get()` and `client.franchises.for_release()`.

ИСХОДНИК ↗

`aniliberty.FranchiseRelease`

класс

FranchiseRelease()

Базовые классы AniLibertyModel

One release of a franchise, with its place in the franchise.

Spec schema: models.anime.franchises.v1.franchise.release.

Атрибуты

Имя	Тип	Описание
`id`	`str`	ID of this release-to-franchise link (a UUID string).
`franchise_id`	`str`	ID of the franchise.
`release_id`	`int`	ID of the release.
`sort_order`	`int`	Position of the release in the franchise, starting at 1 — in every franchise checked, the chronological order.
`release`	`Release`	The release itself (without `genres` and `episodes`; fetch it with `client.releases.get()` for those).

ИСХОДНИК ↗

Torrents

`aniliberty.Torrent`

класс

Torrent()

Базовые классы AniLibertyModel

A torrent of a release.

Spec schema: models.anime.torrents.v1.torrent.

Атрибуты

Имя	Тип	Описание
`id`	`int`	Torrent ID.
`hash`	`str`	Info hash (40 hex characters); `client.torrents.get()` accepts it as well as the ID, in any letter case.
`label`	`str`	Full title, e.g. `"One Piece - AniLiberty.TOP [WEBRip 1080p][AVC][1-24]"`.
`filename`	`str`	Name of the `.torrent` file.
`description`	`str`	Which episodes it contains, e.g. `"1-24"`.
`magnet`	`str`	Magnet link.
`size`	`int`	Total size of the files the torrent downloads, in bytes (not the size of the `.torrent` file itself).
`type`	`Annotated[ValueDescription[str] \| None, EMPTY_VALUE_AS_NONE]`	Source, e.g. `"WEB-DL"`, `"BDRip"` (spec enum `enums.anime.torrents.torrent.type`).
`quality`	`Annotated[ValueDescription[str] \| None, EMPTY_VALUE_AS_NONE]`	Resolution, e.g. `"1080p"` (spec enum `enums.anime.torrents.torrent.quality`).
`codec`	`Annotated[TorrentCodec \| None, EMPTY_VALUE_AS_NONE]`	Video codec.
`color`	`Annotated[ValueDescription[str] \| None, EMPTY_VALUE_AS_NONE]`	Color depth, `"8bit"` or `"10Bit"` (spec enum `enums.anime.torrents.torrent.color`).
`bitrate`	`int \| None`	Bitrate in kbit/s — usually `None`.
`is_hardsub`	`bool`	Whether the subtitles are burned into the video.
`seeders`	`int`	Number of seeders.
`leechers`	`int`	Number of leechers.
`completed_times`	`int`	How many times it was downloaded completely.
`sort_order`	`int`	Position among the release's torrents.
`created_at`	`datetime \| None`	When the torrent was added.
`updated_at`	`datetime \| None`	When the torrent was last updated.
`release`	`Release \| None`	The release (without `genres` and `episodes`).
`torrent_members`	`list[TorrentMember]`	People credited on the torrent; often empty.

ИСХОДНИК ↗

`aniliberty.TorrentCodec`

класс

TorrentCodec()

Базовые классы ValueDescription[str]

Video codec of a torrent, e.g. value="x265/HEVC", label="HEVC".

value is one of AV1, x264/AVC, x265/HEVC, x265hq/HEVC-HQ (spec enum enums.anime.torrents.torrent.codec).

Атрибуты

Имя	Тип	Описание
`label`	`str \| None`	Short label the site shows, e.g. `"HEVC"`.
`label_color`	`str \| None`	Color of that label as `#RRGGBB`, if it has one.
`label_is_visible`	`bool \| None`	Whether the site shows the label.

ИСХОДНИК ↗

`aniliberty.TorrentMember`

класс

TorrentMember()

Базовые классы AniLibertyModel

A person credited on a torrent (e.g. who encoded the HEVC version).

Атрибуты

Имя	Тип	Описание
`id`	`str`	Member entry ID (a UUID string).
`nickname`	`str`	The member's nickname.
`role`	`Annotated[ValueDescription[str] \| None, EMPTY_VALUE_AS_NONE]`	What they did; `role.value` was `"HEVC"` on every torrent checked.
`external_url`	`str \| None`	The member's own link (e.g. a Telegram channel), if any.
`user`	`LinkedAccount \| None`	Linked site account, if any.

ИСХОДНИК ↗

`aniliberty.TorrentFile`

класс

TorrentFile()

Базовые классы AniLibertyModel

A downloaded .torrent file, from client.torrents.file().

Атрибуты

Имя	Тип	Описание
`filename`	`str \| None`	The file name the API suggests (from `Content-Disposition`), if it sent one.
`content`	`bytes`	The file's bytes.

ИСХОДНИК ↗

Teams

`aniliberty.Team`

класс

Team()

Базовые классы AniLibertyModel

An AniLibria team — one of the "leagues" the project's members are grouped into.

Spec schema: models.teams.v1.team.

Атрибуты

Имя	Тип	Описание
`id`	`str`	Team ID (a UUID string).
`title`	`str`	Team name in Russian, e.g. `"II Лига"`.
`description`	`str \| None`	Short description in Russian, e.g. `"Высшая"` — `None` for some teams.
`sort_order`	`int`	Position of the team in the list, from 0 (project leadership) up.

ИСХОДНИК ↗

`aniliberty.TeamRole`

класс

TeamRole()

Базовые классы AniLibertyModel

A role a team member can have: voice actor, translator, timer, ...

Spec schema: models.teams.v1.team.role.

Атрибуты

Имя	Тип	Описание
`id`	`str`	Role ID (a UUID string).
`title`	`str`	Role name in Russian, e.g. `"Актёр"`.
`color`	`str \| None`	The role's display color as a CSS hex string, e.g. `"#339966"` — `None` for most roles, and not normalized (both `"#B523C5"` and `"#b523c5"` occur).
`sort_order`	`int`	Position of the role in the list.

ИСХОДНИК ↗

`aniliberty.TeamMember`

класс

TeamMember()

Базовые классы AniLibertyModel

A member of an AniLibria team, with the team and their roles.

Spec schema: items of responses.api.v1.teams.users (models.teams.v1.team.user with team, user and roles added).

Атрибуты

Имя	Тип	Описание
`id`	`str`	Member ID (a UUID string).
`nickname`	`str`	The member's nickname in the team — the same name that appears in a release's `members`.
`is_intern`	`bool`	Whether the member is an intern.
`is_vacation`	`bool`	Whether the member is on vacation.
`sort_order`	`int`	Position of the member within their team, from 1.
`team`	`Team`	The team the member belongs to.
`roles`	`list[TeamRole]`	The member's roles (at least one for every member at the time of writing).
`user`	`LinkedAccount \| None`	The linked site account — `None` for most members.

ИСХОДНИК ↗

Media

`aniliberty.Promotion`

класс

Promotion()

Базовые классы AniLibertyModel

A promo banner from the site's front page: a featured release, a news post or an ad.

Spec schema: models.media.promotions.v1.promotion. What a promotion links to depends on its kind: a featured release has release and no url; a news post or an ad has url (and usually url_label) and no release.

Атрибуты

Имя	Тип	Описание
`id`	`str`	Promotion ID (a UUID string).
`title`	`str \| None`	Banner title, e.g. the release name — can be `None`.
`description`	`str \| None`	Banner text — can be `None`.
`image`	`Image \| None`	Banner image.
`url`	`str \| None`	External link the banner points to (absolute), or `None`.
`url_label`	`str \| None`	Text for the link button, e.g. `"Подписаться на канал"`, or `None`.
`release`	`Release \| None`	The featured release (with `genres`, without `episodes`), or `None`.
`is_ad`	`bool`	Whether this is a paid ad rather than the site's own promo.
`has_overlay`	`bool`	Whether the site darkens the image under the text.
`ad_erid`	`str \| None`	Ad registry token (ERID) of an ad — `None` on every promotion at the time of writing.
`ad_origin`	`str \| None`	Advertiser of an ad — `None` on every promotion at the time of writing.

ИСХОДНИК ↗

`aniliberty.Video`

класс

Video()

Базовые классы AniLibertyModel

A video from one of AniLibria's YouTube playlists: trailers, reviews, announcements.

Spec schema: items of responses.v1.media.videos (models.media.videos.v1.video.content with origin added).

Атрибуты

Имя	Тип	Описание
`id`	`int`	Video ID on the site.
`title`	`str`	Video title.
`url`	`str`	Link to watch the video (`https://www.youtube.com/watch?v=...`).
`video_id`	`str`	The video's YouTube ID.
`image`	`Image \| None`	Preview image (its paths can be `None`).
`views`	`int \| None`	View count, as last synced from YouTube — can be `None`.
`comments`	`int \| None`	Comment count, as last synced from YouTube — can be `None`.
`is_announce`	`bool`	Whether the video is a season announcement.
`origin`	`VideoOrigin \| None`	The playlist the video comes from.
`created_at`	`datetime \| None`	When the video was published.
`updated_at`	`datetime \| None`	When the site last synced the video's data.

ИСХОДНИК ↗

`aniliberty.VideoOrigin`

класс

VideoOrigin()

Базовые классы AniLibertyModel

Where a video comes from: a YouTube playlist the site tracks.

Spec schema: models.media.videos.v1.video.origin.

Атрибуты

Имя	Тип	Описание
`id`	`str`	Origin ID (a UUID string).
`title`	`str \| None`	Playlist or channel name, e.g. `"AniLiberty"`.
`description`	`str \| None`	Playlist description in Russian.
`url`	`str \| None`	Playlist URL.
`type`	`Annotated[ValueDescription[str] \| None, EMPTY_VALUE_AS_NONE]`	Source type. `type.value` is `"YOUTUBE_PLAYLIST"` — the only value in the spec (enum `enums.media.videos.video.origin.type`) and on every video seen.
`is_announce`	`bool`	Whether the playlist holds season announcements.

ИСХОДНИК ↗

Schedule

`aniliberty.ScheduledRelease`

класс

ScheduledRelease()

Базовые классы AniLibertyModel

A release in the airing schedule, with where it stands this week.

Spec schema: models.anime.schedule.v1.releaseInSchedule. The weekday a release comes out on is release.publish_day (value 1 = Monday ... 7 = Sunday).

Атрибуты

Имя	Тип	Описание
`release`	`Release`	The release, with `genres` filled in.
`published_release_episode`	`Episode \| None`	The episode that came out during the current week (Monday to Sunday), or `None` if this week's episode isn't out yet. It can come out on a different day than `publish_day` — e.g. a Saturday release whose episode was out on Tuesday.
`next_release_episode_number`	`int \| None`	Number of the next episode to come out, `None` when no further episode is expected.
`full_season_is_released`	`bool`	Whether all episodes of the season are already out.

Example

PYTHON

for item in await client.schedule.week():
    day = item.release.publish_day.description if item.release.publish_day else "?"
    print(day, item.release.name.main, item.next_release_episode_number)

ИСХОДНИК ↗

`aniliberty.ScheduleNow`

класс

ScheduleNow()

Базовые классы AniLibertyModel

Releases scheduled for yesterday, today and tomorrow.

Spec schema: responses.v1.anime.schedule.now. Each list holds the releases whose publish_day is that day of the week.

Атрибуты

Имя	Тип	Описание
`yesterday`	`list[ScheduledRelease]`	Releases that came out (or were due) yesterday.
`today`	`list[ScheduledRelease]`	Releases due today.
`tomorrow`	`list[ScheduledRelease]`	Releases due tomorrow.

ИСХОДНИК ↗

Catalog

`aniliberty.SortingOption`

класс

SortingOption()

Базовые классы ValueDescription[str]

A way to sort a list, from client.catalog.references.sorting() or client.me.favorites.references.sorting().

value is what the matching sorting filter takes, e.g. "FRESH_AT_DESC".

Атрибуты

Имя	Тип	Описание
`label`	`str \| None`	Short name, in Russian, e.g. `"Обновлены недавно"`.

ИСХОДНИК ↗

Catalog models (spec tags Аниме.Каталог and Аниме.Каталог.Справочники).

`ReleaseType`

атрибут

ReleaseType = Literal['TV', 'ONA', 'WEB', 'OVA', 'OAD', 'MOVIE', 'DORAMA', 'SPECIAL']

Release type. Spec: enums.anime.releases.release.type.

ИСХОДНИК ↗

`Season`

атрибут

Season = Literal['winter', 'spring', 'summer', 'autumn']

Release season. Spec: enums.anime.releases.release.season.

ИСХОДНИК ↗

`AgeRatingValue`

атрибут

AgeRatingValue = Literal['R0_PLUS', 'R6_PLUS', 'R12_PLUS', 'R16_PLUS', 'R18_PLUS']

Age rating. Spec: enums.anime.releases.release.ageRating.

ИСХОДНИК ↗

`PublishStatus`

атрибут

PublishStatus = Literal['IS_ONGOING', 'IS_NOT_ONGOING']

Whether the anime is still airing. Spec: enums.anime.catalog.filter.publishStatus.

ИСХОДНИК ↗

`ProductionStatus`

атрибут

ProductionStatus = Literal['IS_IN_PRODUCTION', 'IS_NOT_IN_PRODUCTION']

Whether AniLibria is still dubbing it. Spec: enums.anime.catalog.filter.productionStatus.

ИСХОДНИК ↗

`CatalogSorting`

атрибут

Catalog sort order. Spec: enums.anime.catalog.filter.sorting.

ИСХОДНИК ↗

Common

`aniliberty.ValueDescription`

класс

ValueDescription()

Базовые классы AniLibertyModel, Generic[T]

A machine value with its human-readable (Russian) description.

The API returns many enumerations this way — a release's type, season, publish day, a torrent's quality, ... — e.g. {"value": "TV", "description": "ТВ"} or {"value": 5, "description": "Пятница"} (publish_day uses weekday numbers). Fields with extra keys next to these two (age_rating's label/is_adult, a torrent codec's label_*) use subclasses.

Атрибуты

Имя	Тип	Описание
`value`	`T`	The machine value — use it for comparisons and catalog filters.
`description`	`str \| None`	The value's description in Russian, for display.

ИСХОДНИК ↗

`aniliberty.Image`

класс

Image()

Базовые классы ImageSet

An image in its original format plus optimized (WebP) variants.

Spec schema: commons.v1.models.components.image.withOptimized — used for release posters, episode previews, genre and franchise images, user avatars.

Атрибуты

Имя	Тип	Описание
`optimized`	`ImageSet \| None`	The same image in WebP, usually smaller.

Example

PYTHON

poster = release.poster
print(poster.preview_url)            # https://aniliberty.top/storage/....jpg
print(poster.optimized.preview_url)  # https://aniliberty.top/storage/....webp

ИСХОДНИК ↗

`aniliberty.ImageSet`

класс

ImageSet()

Базовые классы AniLibertyModel

Links to one image in several sizes.

The API sends relative paths such as /storage/releases/posters/1/abc.jpg; they resolve against the site's origin, not the /api/v1 base URL (see docs/api-notes.md). The raw paths are kept in src/preview/thumbnail, and the *_url properties return absolute URLs on the host the client talked to (or on https://aniliberty.top for a model built by hand).

Any of the paths can be None — e.g. a user without an avatar gets an image object whose paths are all None.

Атрибуты

Имя	Тип	Описание
`src`	`str \| None`	Original image path. Only posters and episode previews have it.
`preview`	`str \| None`	Path of the medium-size image.
`thumbnail`	`str \| None`	Path of the small image.

ИСХОДНИК ↗

`src_url`

атрибутсвойство

src_url: str | None

Absolute URL of src.

ИСХОДНИК ↗

`preview_url`

атрибутсвойство

preview_url: str | None

Absolute URL of preview.

ИСХОДНИК ↗

`thumbnail_url`

атрибутсвойство

thumbnail_url: str | None

Absolute URL of thumbnail.

ИСХОДНИК ↗

`aniliberty.LinkedAccount`

класс

LinkedAccount()

Базовые классы AniLibertyModel

The site account linked to a person in the credits or in a team.

The user of ReleaseMember, TorrentMember and TeamMember — set when the person has an account on the site, None otherwise. Spec schemas: models.teams.v1.team.user.account and the user of release/torrent members.

Атрибуты

Имя	Тип	Описание
`id`	`int`	User ID on the site.
`nickname`	`str \| None`	The account's nickname. Only team members' accounts have it (it can differ from the team nickname); for release and torrent members it's `None` — their own `nickname` is on the member.
`avatar`	`Image \| None`	The account's avatar (its paths can be `None`).

ИСХОДНИК ↗

Building blocks shared by many models: value + description pairs and images.

`EMPTY_VALUE_AS_NONE`

атрибут

EMPTY_VALUE_AS_NONE = BeforeValidator(_empty_value_as_none)

Turns {"value": null, ...} into None for an optional ValueDescription field.

The API sometimes sends a value + description object with both keys null — seen on season of releases in the schedule — instead of omitting it. Annotate such fields as::

TEXT

season: Annotated[ValueDescription[str] | None, EMPTY_VALUE_AS_NONE] = None

ИСХОДНИК ↗

Service

`aniliberty.ApiStatus`

класс

ApiStatus()

Базовые классы AniLibertyModel

Status of the API, returned by client.app.status().

Spec schema: responses.v1.app.status.

Атрибуты

Имя	Тип	Описание
`is_alive`	`bool`	Whether the API reports itself as working.
`available_api_endpoints`	`list[str]`	Hosts the API can be reached at, e.g. `["https://aniliberty.top"]` — origins without the `/api/v1` suffix.
`request`	`RequestInfo \| None`	What the API knows about the caller, if it sent that.

ИСХОДНИК ↗

`aniliberty.RequestInfo`

класс

RequestInfo()

Базовые классы AniLibertyModel

What the API knows about the client that sent the request (geolocated by IP).

Spec schema: responses.v1.app.status → request. All fields are optional: the spec marks none of them required, and geolocation can fail.

Атрибуты

Имя	Тип	Описание
`ip`	`str \| None`	The client's IP address as seen by the API.
`country`	`str \| None`	Country name, in English (e.g. `"The Netherlands"`).
`iso_code`	`str \| None`	ISO 3166-1 alpha-2 country code (e.g. `"NL"`).
`timezone`	`str \| None`	IANA time zone name (e.g. `"Europe/Amsterdam"`).

ИСХОДНИК ↗

Authentication

`aniliberty.AuthToken`

класс

AuthToken()

Базовые классы AniLibertyModel

A session token, returned by the login methods of client.auth.

Spec schemas: responses.v1.accounts.users.auth.login, responses.api.v1.accounts.otp.login, responses.v1.accounts.users.auth.social.authenticate.

The token is an opaque string (32 characters at the time of writing) with no expiry inside; the API has no refresh endpoint. Every login creates a new, independent session, and client.auth.logout() ends only the client's own.

Атрибуты

Имя	Тип	Описание
`token`	`str`	The session token. Keep it secret — it gives full access to the account.

ИСХОДНИК ↗

`aniliberty.IssuedOtp`

класс

IssuedOtp()

Базовые классы AniLibertyModel

A one-time code issued by client.auth.otp.issue().

Spec schema: responses.api.v1.accounts.otp.get.

Атрибуты

Имя	Тип	Описание
`otp`	`Otp`	The code.
`remaining_time`	`float`	Seconds until the code expires (fractional; about 300 for a new code).

ИСХОДНИК ↗

`aniliberty.Otp`

класс

Otp()

Базовые классы AniLibertyModel

A one-time code for logging in a device without typing the password.

Spec schema: models.accounts.otp.v1.otp.

Атрибуты

Имя	Тип	Описание
`code`	`str`	The code to show to the user, as a string — it can start with `0`.
`device_id`	`str`	The device the code was issued for.
`user_id`	`int \| None`	The account that accepted the code; `None` until it's accepted.
`expired_at`	`datetime`	When the code expires.

ИСХОДНИК ↗

`aniliberty.SocialLogin`

класс

SocialLogin()

Базовые классы AniLibertyModel

Where to send the user to log in with a social network.

Spec schema: responses.v1.accounts.users.auth.social.login.

Атрибуты

Имя	Тип	Описание
`url`	`str`	The OAuth page of the social network, to open in a browser.
`state`	`str`	Key to pass to `client.auth.social.authenticate()` once the user has logged in there.

ИСХОДНИК ↗

Authentication models (spec tags Аккаунты.Пользователи.Авторизация.* and Аккаунты.ОдноразовыеПароли).

`SocialProvider`

атрибут

SocialProvider = Literal['vk', 'google', 'patreon', 'discord']

Social networks that can be used to log in.

ИСХОДНИК ↗

Account

`aniliberty.UserProfile`

класс

UserProfile()

Базовые классы AniLibertyModel

The logged-in user's own profile, returned by client.me.profile().

Spec schema: models.users.v1.user. email and torrents.passkey are only sent for the user's own profile.

Атрибуты

Имя	Тип	Описание
`id`	`int`	User ID.
`login`	`str`	Login, used to log in (together with `email`).
`email`	`str \| None`	E-mail of the account.
`nickname`	`str \| None`	Display name; defaults to the login for a new account.
`avatar`	`Image \| None`	Avatar; all paths are `None` without one.
`torrents`	`TorrentStats \| None`	Tracker passkey and traffic.
`is_banned`	`bool \| None`	Whether the user is banned on the site.
`created_at`	`datetime \| None`	When the account was created.
`is_with_ads`	`bool \| None`	Whether ads are shown to the user — in the spec, but not sent by the API at the time of writing (see the three flags below).
`is_with_video_ads`	`bool \| None`	Whether video ads are shown (not in the spec).
`is_with_content_ads`	`bool \| None`	Whether ads are shown among the site's content (not in the spec).
`is_with_video_ads_always`	`bool \| None`	An ad flag the API doesn't document (not in the spec); it matches the `isWithVideoAdsAlways` parameter of the user's HLS links.

ИСХОДНИК ↗

`aniliberty.TorrentStats`

класс

TorrentStats()

Базовые классы AniLibertyModel

The account's torrent tracker data.

Spec schema: models.users.v1.user → torrents.

Атрибуты

Имя	Тип	Описание
`passkey`	`str \| None`	The account's tracker passkey — the `pk` of `.torrent` and RSS links, also put into `magnet` links of torrents when logged in. A secret: it's left out of the model's `repr`.
`uploaded`	`int \| None`	Total uploaded, in bytes; `None` until the account has uploaded anything.
`downloaded`	`int \| None`	Total downloaded, in bytes; `None` until the account has downloaded anything.

ИСХОДНИК ↗

`aniliberty.CollectionItem`

класс

CollectionItem()

Базовые классы AniLibertyModel

A release in one of the user's collections, from client.me.collections.ids().

Spec schema: responses.api.v1.accounts.users.me.collections.ids.item — the API sends a [release_id, collection] pair, e.g. [9839, "WATCHED"]; it's validated into this model (a dict with the field names works too).

Атрибуты

Имя	Тип	Описание
`release_id`	`int`	Release ID.
`collection`	`CollectionType`	The collection the release is in. A release is in one collection at most.

ИСХОДНИК ↗

User account models (spec tags Аккаунты.Пользователи.Мое.*).

`FavoritesSorting`

атрибут

Sort order of favorites; CREATED_AT_* is when the release was added to favorites.

ИСХОДНИК ↗

`CollectionType`

атрибут

CollectionType = Literal['PLANNED', 'WATCHED', 'WATCHING', 'POSTPONED', 'ABANDONED']

A user's collection: planned, watched, watching, postponed or abandoned.

ИСХОДНИК ↗

Watch progress

`aniliberty.Timecode`

класс

Timecode()

Базовые классы AniLibertyModel

Where the user stopped in an episode, and whether they finished it.

What client.me.views.save_timecodes() takes and client.me.views.timecodes() returns. Spec schema: responses.v1.accounts.users.me.views.timecodes.item — the API sends an [episode_id, time, is_watched] triple, which is validated into this model (a dict with the field names works too).

Атрибуты

Имя	Тип	Описание
`release_episode_id`	`str`	Episode ID (a UUID string), as in `Episode.id`.
`time`	`float`	Position in the episode, in seconds from its start (fractions allowed, not negative).
`is_watched`	`bool`	Whether the episode counts as watched.

ИСХОДНИК ↗

`aniliberty.EpisodeView`

класс

EpisodeView()

Базовые классы AniLibertyModel

The stored watch record of one episode.

Returned by client.episodes.timecode() and client.releases.timecodes(). Spec schema: models.accounts.users.v1.user.view. Records are written by the API about a minute after client.me.views.save_timecodes() (see docs/api-notes.md).

Атрибуты

Имя	Тип	Описание
`id`	`int`	Record ID.
`release_episode_id`	`str`	Episode ID (a UUID string).
`time`	`float`	Position in the episode, in seconds from its start.
`is_watched`	`bool`	Whether the episode counts as watched.
`updated_at`	`datetime \| None`	When the record was last saved.
`user_id`	`int \| None`	The user the record belongs to.

ИСХОДНИК ↗

`aniliberty.HistoryEntry`

класс

HistoryEntry()

Базовые классы EpisodeView

An entry of the watch history, from client.me.views.history().

Spec schema: responses.v1.accounts.users.me.views.history → data[].

Атрибуты

Имя	Тип	Описание
`release_episode`	`Episode \| None`	The episode, with its release in `release_episode.release`.

ИСХОДНИК ↗

Exceptions

`aniliberty.AniLibertyError`

класс

AniLibertyError()

Базовые классы Exception

Base class for all errors raised by the SDK.

ИСХОДНИК ↗

`aniliberty.APIError`

класс

APIError(
    message: str,
    *,
    status_code: int,
    method: str,
    url: str,
    payload: Any = None,
)

Базовые классы AniLibertyError

The API responded with an error status.

Raised as is for statuses without a dedicated subclass (e.g. 400, 405, 409); otherwise one of the subclasses below is raised, so except APIError catches all of them.

Атрибуты

Имя	Тип	Описание
`status_code`		HTTP status code of the response.
`message`		Error message — the `message` field of the API's JSON body when it has one, otherwise the HTTP reason phrase.
`method`		HTTP method of the failed request.
`url`		Full URL of the failed request.
`payload`		The decoded JSON body of the response, or its text if it wasn't JSON.

ИСХОДНИК ↗

`aniliberty.NotFoundError`

класс

NotFoundError(
    message: str,
    *,
    status_code: int,
    method: str,
    url: str,
    payload: Any = None,
)

Базовые классы APIError

The requested resource doesn't exist (404).

The API's own message for this status is an internal Laravel lookup string such as "No query results for model [...]" — it's kept in payload, while message is a plain "Not found".

ИСХОДНИК ↗

`aniliberty.ValidationError`

класс

ValidationError(
    message: str,
    *,
    status_code: int,
    method: str,
    url: str,
    payload: Any = None,
    errors: dict[str, list[str]] | None = None,
)

Базовые классы APIError

The API rejected the request parameters (422).

Not to be confused with pydantic.ValidationError: this one means the request was invalid, e.g. limit above the endpoint's maximum. A response that doesn't fit the SDK's models raises ResponseParseError instead.

Атрибуты

Имя	Тип	Описание
`errors`	`dict[str, list[str]]`	Messages per parameter, as the API returns them (in Russian), e.g. `{"limit": ["Поле limit не может быть больше 50."]}`.

ИСХОДНИК ↗

`aniliberty.RateLimitError`

класс

RateLimitError(
    message: str,
    *,
    status_code: int,
    method: str,
    url: str,
    payload: Any = None,
    retry_after: float | None = None,
)

Базовые классы APIError

The API answered 429 Too Many Requests.

Атрибуты

Имя	Тип	Описание
`retry_after`		The response's `Retry-After` value, in seconds, if it sent one.

ИСХОДНИК ↗

`aniliberty.AuthRequiredError`

класс

AuthRequiredError(
    message: str,
    *,
    status_code: int,
    method: str,
    url: str,
    payload: Any = None,
)

Базовые классы APIError

The request needs a valid session, or the credentials were wrong (401/403 JSON).

The API answers 403 "This action is unauthorized." to an account endpoint called without a session token, with a malformed one, or with one that was logged out or has expired — it doesn't say which. Log in again (client.auth.login()) or pass a fresh token to AniLiberty. Wrong credentials at client.auth.login() are a 401; the API's reason is in message.

ИСХОДНИК ↗

`aniliberty.ServerError`

класс

ServerError(
    message: str,
    *,
    status_code: int,
    method: str,
    url: str,
    payload: Any = None,
)

Базовые классы APIError

The API (or the CDN in front of it) failed with a 5xx status.

ИСХОДНИК ↗

`aniliberty.AccessBlockedError`

класс

AccessBlockedError(
    message: str,
    *,
    status_code: int,
    method: str,
    url: str,
    payload: Any = None,
)

Базовые классы APIError

Something in front of the API answered with an HTML page instead of JSON.

The SDK always sends Accept: application/json, and with that header the API itself answers with JSON even for errors (see docs/api-notes.md). An HTML page therefore comes from the Cloudflare edge in front of the API — a bot challenge or a block of the network/IP. Resending the same request gets the same answer, so this is not retried.

HTML on a 5xx status is not this error but ServerError: Cloudflare renders its own origin errors (502, 520, ...) as HTML pages too, and those are worth retrying.

ИСХОДНИК ↗

`aniliberty.TransportError`

класс

TransportError(message: str, *, method: str, url: str)

Базовые классы AniLibertyError

The request failed before any response arrived (connection error, timeout, ...).

The underlying httpx exception is available as __cause__.

Атрибуты

Имя	Тип	Описание
`method`		HTTP method of the failed request.
`url`		Full URL of the failed request.

ИСХОДНИК ↗

`aniliberty.ResponseParseError`

класс

ResponseParseError(message: str, *, url: str, payload: Any = None)

Базовые классы AniLibertyError

A successful response couldn't be decoded or didn't match the SDK's model.

Usually means the API changed its response format. The raw data is kept so it isn't lost: payload holds the decoded JSON (or the body text if it wasn't JSON), and the original json/pydantic exception is available as __cause__.

Атрибуты

Имя	Тип	Описание
`url`		Full URL of the request.
`payload`		Decoded JSON body, or the body text if it wasn't valid JSON.

ИСХОДНИК ↗

Low-level HTTP client

Available as client.http; client.http.request(...) is the escape hatch for endpoints the SDK doesn't cover yet.

`aniliberty.HttpClient`

класс

HttpClient(
    *,
    base_url: str = DEFAULT_BASE_URL,
    timeout: float = DEFAULT_TIMEOUT,
    headers: Mapping[str, str] | None = None,
    http_client: httpx.AsyncClient | None = None,
    token: str | None = None,
    max_concurrency: int = DEFAULT_MAX_CONCURRENCY,
    request_delay: float = DEFAULT_REQUEST_DELAY,
    max_retries: int = DEFAULT_MAX_RETRIES,
    retry_base_delay: float = DEFAULT_RETRY_BASE_DELAY,
    max_retry_after: float = DEFAULT_MAX_RETRY_AFTER,
    cache_dir: str | os.PathLike[str] | None = None,
    cache_ttl: float | None = None,
    sleep: Callable[[float], Awaitable[None]] = asyncio.sleep,
    clock: Callable[[], float] = time.monotonic,
    cache_clock: Callable[[], float] = time.time,
)

Sends requests to the API and turns responses into JSON or SDK exceptions.

Every resource of AniLiberty goes through this class; it is also the escape hatch for endpoints the SDK doesn't cover yet: await client.http.request("GET", "/teams/roles") returns the decoded JSON as is, with the same headers, limits, retries and error handling as the rest of the SDK.

Request paths are relative to base_url and joined as strings, so "/app/status" with the default base URL becomes https://aniliberty.top/api/v1/app/status. Absolute URLs are not accepted.

Being polite to the API is built in:

Concurrency — at most max_concurrency requests are in flight at once, however many coroutines call the client (e.g. via asyncio.gather).
Pacing — consecutive requests start at least request_delay seconds apart.
Retries — 429 is retried for any method, 5xx and network errors/timeouts only for idempotent methods (IDEMPOTENT_METHODS). The delay is the response's Retry-After when it has one, otherwise retry_base_delay doubled per attempt (1 s, 2 s, 4 s by default). Other 4xx and HTML block pages are never retried.

With cache_dir set, request(..., cache=True) keeps the decoded JSON of successful GET responses on disk and answers repeated identical requests from there until cache_ttl passes — see request() for what is and isn't cached.

ИСХОДНИК ↗

`base_url`

атрибутсвойство

base_url: str

The API base URL, without a trailing slash.

ИСХОДНИК ↗

`site_url`

атрибутсвойство

site_url: str

Origin of base_url (scheme and host), e.g. https://aniliberty.top.

Relative paths in responses, such as image paths, resolve against it.

ИСХОДНИК ↗

`cache_dir`

атрибутсвойство

cache_dir: Path | None

The response cache directory, or None when caching is off.

ИСХОДНИК ↗

`token`

атрибутсвойство

token: str | None

Session token sent as Authorization: Bearer <token>, or None for none.

Set it to start or stop sending the token; it replaces an Authorization header given in headers. Public endpoints work with or without it (even with an expired one); account endpoints answer 403 without a valid one.

ИСХОДНИК ↗

`closed`

атрибутсвойство

closed: bool

Whether aclose() has been called.

ИСХОДНИК ↗

`aclose`

методasync

aclose() -> None

Close the underlying httpx.AsyncClient, unless it was passed in by the caller.

Safe to call more than once.

ИСХОДНИК ↗

`url`

метод

url(path: str) -> str

Return the full URL for an API path such as "/app/status".

ИСХОДНИК ↗

`request`

методasync

request(
    method: str,
    path: str,
    *,
    params: Mapping[str, Any] | None = None,
    json: Any = None,
    with_token: bool = True,
    cache: bool = False,
    refresh: bool = False,
) -> Any

Send a request and return the decoded JSON body.

Retries and limits described on the class apply.

A response is read from and saved to the cache only when all of these hold: the client has a cache_dir, cache=True, the method is GET, and no session token goes with the request — so nothing that depends on the logged-in user (or carries their torrent passkey) ever lands on disk. The cache key is the method, the full URL and the query parameters in sorted order. Only successful responses with a body are cached; errors are raised as usual and never stored.

Параметры

Имя	Тип	Описание	По умолчанию
`method`	`str`	HTTP method, e.g. `"GET"`.
`path`	`str`	Path relative to `base_url`, e.g. `"/anime/releases/latest"`.
`params`	`Mapping[str, Any] \| None`	Query parameters, passed to `httpx` as is.	`None`
`json`	`Any`	JSON request body.	`None`
`with_token`	`bool`	Whether to send `token`. `False` for the endpoints that refuse a logged-in caller (`POST /accounts/otp/login` answers 403 to one).	`True`
`cache`	`bool`	Whether the response may be read from and saved to the cache (see above). The SDK's own methods pass it for endpoints whose data doesn't change from call to call.	`False`
`refresh`	`bool`	Skip reading the cache and fetch from the API; the fresh response still replaces the cached one.	`False`

Возвращает

Тип	Описание
`Any`	The decoded JSON body (`dict`, `list`, ...), or `None` for an empty body.

Исключения

Тип	Описание
`APIError`	The API answered with an error status — one of its subclasses for 404, 422, 429, 401/403, 5xx and HTML pages. 429 and 5xx are raised only once retries are exhausted.
`TransportError`	The request failed without a response (network error, timeout), after retries for idempotent methods.
`ResponseParseError`	A successful response wasn't valid JSON.
`RuntimeError`	The client has been closed.

ИСХОДНИК ↗

`request_raw`

методasync

request_raw(
    method: str,
    path: str,
    *,
    params: Mapping[str, Any] | None = None,
) -> httpx.Response

Send a request for a non-JSON resource (a file, an XML feed) and return the response.

Same limits, retries and error handling as request(); the body is fully read, so use stream() instead for large downloads.

Параметры

Имя	Тип	Описание	По умолчанию
`method`	`str`	HTTP method, e.g. `"GET"`.
`path`	`str`	Path relative to `base_url`.
`params`	`Mapping[str, Any] \| None`	Query parameters, passed to `httpx` as is.	`None`

Возвращает

Тип	Описание
`httpx.Response`	The successful `httpx.Response`, with `content`/`text` and headers.

Исключения

Тип	Описание
`APIError`	The API answered with an error status — see `request()`.
`TransportError`	The request failed without a response.
`RuntimeError`	The client has been closed.

ИСХОДНИК ↗

`stream`

методasync

stream(
    method: str,
    path: str,
    *,
    params: Mapping[str, Any] | None = None,
) -> AsyncIterator[httpx.Response]

Send a request and stream the response body, for downloads.

Limits and retries apply until the response headers arrive: a 429/5xx is retried before anything is yielded, and an error status raises like request(). The body is then read by the caller (response.aiter_bytes()); the response is closed when the async with block exits.

Параметры

Имя	Тип	Описание	По умолчанию
`method`	`str`	HTTP method, e.g. `"GET"`.
`path`	`str`	Path relative to `base_url`.
`params`	`Mapping[str, Any] \| None`	Query parameters, passed to `httpx` as is.	`None`

Выдаёт

Тип	Описание
`AsyncIterator[httpx.Response]`	The successful `httpx.Response`, body not read yet.

Исключения

Тип	Описание
`APIError`	The API answered with an error status — see `request()`.
`TransportError`	The request failed without a response.
`RuntimeError`	The client has been closed.

ИСХОДНИК ↗