Skip to main content

Async API wrapper for Enka Network written in Python, supports GI and HSR.

Project description

enka.py

⚠️ Notice: Package Renaming

Important Announcement:

The enka-api package has been deprecated and is now replaced by the new package named enka.

What You Need to Know

  • New Package: Please install the new package using the following command:
  • Deprecation Details: The enka-api package will continue to be available for a limited time, but we encourage you to transition to the new package as soon as possible.

Introduction

enka.py is an async API wrapper for enka.network written in Python.
You can find the API docs for Enka Network here.
Developing something for Hoyoverse games? You might be interested in other API wrappers written by me.

Features

  • Fully typed.
  • Fully asynchronous by using aiofiles, aiohttp, and asyncio, suitable for Discord bots.
  • Provides direct icon URLs.
  • Supports Python 3.10+.
  • Supports all game languages.
  • Supports both Genshin Impact and Honkai Star Rail.
  • Supports persistent caching using SQLite.
  • Supports Pydantic V2, this also means full autocomplete support.
  • Seamlessly integrates with GenshinData and StarRailData.

Installation

pip install enka

Quick Example

import enka
import asyncio

async def main() -> None:
    async with enka.GenshinClient(enka.gi.Language.ENGLISH) as client:
      response = await client.fetch_showcase(901211014)
      print(response.player.nickname)
      print(response.characters[0].name)

asyncio.run(main())

Getting Started

Read the wiki to learn more about on how to use this wrapper.

Questions, Issues, Feedback, Contributions

Whether you want to make any bug reports, feature requests, or contribute to the wrapper, simply open an issue or pull request in this repository.
If GitHub is not your type, you can find me on Discord, my username is @seria_ati.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

enka_api-2.4.4.tar.gz (99.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

enka_api-2.4.4-py3-none-any.whl (60.5 kB view details)

Uploaded Python 3

File details

Details for the file enka_api-2.4.4.tar.gz.

File metadata

  • Download URL: enka_api-2.4.4.tar.gz
  • Upload date:
  • Size: 99.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.11

File hashes

Hashes for enka_api-2.4.4.tar.gz
Algorithm Hash digest
SHA256 8641a3878b4630c7b1f1f484efe4ff6286abc293d22a711effadb4524c726628
MD5 4d1a0469f724491009d629df9a6dcadd
BLAKE2b-256 acdda5011d04846dbb256a4e4e3fa793313c6357d99d990385805ca218abc2cd

See more details on using hashes here.

File details

Details for the file enka_api-2.4.4-py3-none-any.whl.

File metadata

  • Download URL: enka_api-2.4.4-py3-none-any.whl
  • Upload date:
  • Size: 60.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.11

File hashes

Hashes for enka_api-2.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 41d19679201c15aa02f92d8941aabdb523fd07f0e8497a1325a7714a33b49030
MD5 4c9ba1937e74a59697e4661b6b6fa22e
BLAKE2b-256 a337b0c6633708023db069c89998167dbf2b60c31371f6470704ecf1bda90084

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page