API Reference

client

Classes:

• YattaAPI –

  The main class to interact with the Project Yatta API.

CACHE_PATH module-attribute

CACHE_PATH = Path('./.cache/yatta')

YattaAPI

The main class to interact with the Project Yatta API.

Provide asynchronous methods to fetch various game data like characters, light cones, relics, items, etc. Support caching via aiohttp-client-cache.

Parameters:

• lang

  (Language, default: EN ) –

  The language to use for API responses. Defaults to Language.EN.

• cache_ttl

  (int, default: 3600 ) –

  The time-to-live for the cache in seconds. Defaults to 3600 (1 hour).

• headers

  (dict[str, Any] | None, default: None ) –

  Optional dictionary of headers to include in requests.

• session

  (ClientSession | None, default: None ) –

  Optional existing aiohttp.ClientSession to use. If None, a new CachedSession will be created.

• cache_backend

  (CacheBackend | None, default: None ) –

  Optional CacheBackend instance for caching. If None, a SQLite backend will be used with a default path.

Methods:

• close –

  Close the internal aiohttp session.

• fetch_book_detail –

  Fetch detailed information for a specific book.

• fetch_books –

  Fetch a list of all available books.

• fetch_changelogs –

  Fetch a list of all available changelogs.

• fetch_character_detail –

  Fetch detailed information for a specific character.

• fetch_characters –

  Fetch a list of all available characters.

• fetch_item_detail –

  Fetch detailed information for a specific item.

• fetch_items –

  Fetch a list of all available items.

• fetch_latest_version –

  Fetch the latest data version hash from the API.

• fetch_light_cone_detail –

  Fetch detailed information for a specific light cone.

• fetch_light_cones –

  Fetch a list of all available light cones.

• fetch_manual_avatar –

  Fetch manual avatar data, typically used for stat mappings.

• fetch_message_types –

  Fetch a mapping of message type IDs to their names.

• fetch_messages –

  Fetch a list of all available message threads.

• fetch_relic_set_detail –

  Fetch detailed information for a specific relic set.

• fetch_relic_sets –

  Fetch a list of all available relic sets.

• start –

  Initialize the internal aiohttp session.

Attributes:

• BASE_URL (Final[str]) –
• cache_ttl –
• lang –

BASE_URL class-attribute instance-attribute

BASE_URL: Final[str] = 'https://sr.yatta.moe/api/v2'

cache_ttl instance-attribute

cache_ttl = cache_ttl

lang instance-attribute

lang = lang

close async

close() -> None

Close the internal aiohttp session.

Should be called to release resources if not using async with.

fetch_book_detail async

fetch_book_detail(id: int, use_cache: bool = True) -> BookDetail

Fetch detailed information for a specific book.

Parameters:

• id

  (int) –

  The unique identifier of the book.

• use_cache

  (bool, default: True ) –

  Whether to allow the response to be served from cache. Defaults to True.

Returns:

• BookDetail –

  A BookDetail object containing detailed book information.

Raises:

• DataNotFoundError –

  If no book with the given ID is found.

• YattaAPIError –

  For other API errors.

fetch_books async

fetch_books(use_cache: bool = True) -> list[Book]

Fetch a list of all available books.

Parameters:

• use_cache

  (bool, default: True ) –

  Whether to allow the response to be served from cache. Defaults to True.

Returns:

• list[Book] –

  A list of Book objects.

Raises:

• DataNotFoundError –

  If the book list endpoint returns 404.

• YattaAPIError –

  For other API errors.

fetch_changelogs async

fetch_changelogs(use_cache: bool = True) -> list[Changelog]

Fetch a list of all available changelogs.

Parameters:

• use_cache

  (bool, default: True ) –

  Whether to allow the response to be served from cache. Defaults to True.

Returns:

• list[Changelog] –

  A list of Changelog objects.

Raises:

• DataNotFoundError –

  If the changelog endpoint returns 404.

• YattaAPIError –

  For other API errors.

fetch_character_detail async

fetch_character_detail(id: int, use_cache: bool = True) -> CharacterDetail

Fetch detailed information for a specific character.

Parameters:

• id

  (int) –

  The unique identifier of the character.

• use_cache

  (bool, default: True ) –

  Whether to allow the response to be served from cache. Defaults to True.

Returns:

• CharacterDetail –

  A CharacterDetail object containing detailed character information.

Raises:

• DataNotFoundError –

  If no character with the given ID is found.

• YattaAPIError –

  For other API errors.

fetch_characters async

fetch_characters(use_cache: bool = True) -> list[Character]

Fetch a list of all available characters.

Parameters:

• use_cache

  (bool, default: True ) –

  Whether to allow the response to be served from cache. Defaults to True.

Returns:

• list[Character] –

  A list of Character objects.

Raises:

• DataNotFoundError –

  If the character list endpoint returns 404.

• YattaAPIError –

  For other API errors.

fetch_item_detail async

fetch_item_detail(id: int, use_cache: bool = True) -> ItemDetail

Fetch detailed information for a specific item.

Parameters:

• id

  (int) –

  The unique identifier of the item.

• use_cache

  (bool, default: True ) –

  Whether to allow the response to be served from cache. Defaults to True.

Returns:

• ItemDetail –

  An ItemDetail object containing detailed item information.

Raises:

• DataNotFoundError –

  If no item with the given ID is found.

• YattaAPIError –

  For other API errors.

fetch_items async

fetch_items(use_cache: bool = True) -> list[Item]

Fetch a list of all available items.

Parameters:

• use_cache

  (bool, default: True ) –

  Whether to allow the response to be served from cache. Defaults to True.

Returns:

• list[Item] –

  A list of Item objects.

Raises:

• DataNotFoundError –

  If the item list endpoint returns 404.

• YattaAPIError –

  For other API errors.

fetch_latest_version async

fetch_latest_version() -> str

Fetch the latest data version hash from the API.

This bypasses the regular cache to ensure the absolute latest version is retrieved.

Returns:

• str –

  The latest version hash string.

Raises:

• YattaAPIError –

  For API errors during the fetch.

fetch_light_cone_detail async

fetch_light_cone_detail(id: int, use_cache: bool = True) -> LightConeDetail

Fetch detailed information for a specific light cone.

Parameters:

• id

  (int) –

  The unique identifier of the light cone.

• use_cache

  (bool, default: True ) –

  Whether to allow the response to be served from cache. Defaults to True.

Returns:

• LightConeDetail –

  A LightConeDetail object containing detailed light cone information.

Raises:

• DataNotFoundError –

  If no light cone with the given ID is found.

• YattaAPIError –

  For other API errors.

fetch_light_cones async

fetch_light_cones(use_cache: bool = True) -> list[LightCone]

Fetch a list of all available light cones.

Parameters:

• use_cache

  (bool, default: True ) –

  Whether to allow the response to be served from cache. Defaults to True.

Returns:

• list[LightCone] –

  A list of LightCone objects.

Raises:

• DataNotFoundError –

  If the light cone list endpoint returns 404.

• YattaAPIError –

  For other API errors.

fetch_manual_avatar async

fetch_manual_avatar(use_cache: bool = True) -> dict[str, dict[str, str]]

Fetch manual avatar data, typically used for stat mappings.

Parameters:

• use_cache

  (bool, default: True ) –

  Whether to allow the response to be served from cache. Defaults to True.

Returns:

• dict[str, dict[str, str]] –

  A dictionary containing manual avatar data, often mapping stat keys to names and icons.

Raises:

• DataNotFoundError –

  If the manual avatar endpoint returns 404.

• YattaAPIError –

  For other API errors.

fetch_message_types async

fetch_message_types(use_cache: bool = True) -> dict[str, str]

Fetch a mapping of message type IDs to their names.

Parameters:

• use_cache

  (bool, default: True ) –

  Whether to allow the response to be served from cache. Defaults to True.

Returns:

• dict[str, str] –

  A dictionary where keys are message type IDs (as strings) and values are type names.

Raises:

• DataNotFoundError –

  If the message endpoint returns 404.

• YattaAPIError –

  For other API errors.

fetch_messages async

fetch_messages(use_cache: bool = True) -> list[Message]

Fetch a list of all available message threads.

Parameters:

• use_cache

  (bool, default: True ) –

  Whether to allow the response to be served from cache. Defaults to True.

Returns:

• list[Message] –

  A list of Message objects.

Raises:

• DataNotFoundError –

  If the message list endpoint returns 404.

• YattaAPIError –

  For other API errors.

fetch_relic_set_detail async

fetch_relic_set_detail(id: int, use_cache: bool = True) -> RelicSetDetail

Fetch detailed information for a specific relic set.

Parameters:

• id

  (int) –

  The unique identifier of the relic set.

• use_cache

  (bool, default: True ) –

  Whether to allow the response to be served from cache. Defaults to True.

Returns:

• RelicSetDetail –

  A RelicSetDetail object containing detailed relic set information.

Raises:

• DataNotFoundError –

  If no relic set with the given ID is found.

• YattaAPIError –

  For other API errors.

fetch_relic_sets async

fetch_relic_sets(use_cache: bool = True) -> list[RelicSet]

Fetch a list of all available relic sets.

Parameters:

• use_cache

  (bool, default: True ) –

  Whether to allow the response to be served from cache. Defaults to True.

Returns:

• list[RelicSet] –

  A list of RelicSet objects.

Raises:

• DataNotFoundError –

  If the relic list endpoint returns 404.

• YattaAPIError –

  For other API errors.

start async

start() -> None

Initialize the internal aiohttp session.

Must be called before making any API requests if not using async with.