Skip to main content

An API wrapper for Genshin Impact.

Project description

genshin.py

Downloads PyPI package Last Commit Coverage Discord

Modern API wrapper for Genshin Impact & Honkai Impact 3rd built on asyncio and pydantic.


Documentation: https://thesadru.github.io/genshin.py

API Reference: https://thesadru.github.io/genshin.py/pdoc/genshin

Source Code: https://github.com/thesadru/genshin.py


The primary focus of genshin.py is convenience. The entire project is fully type-hinted and abstracts a large amount of the api to be easier to use.

Key features:

  • All data is in the form of Pydantic Models which means full autocompletion and linter support.
  • Requests are significantly faster thanks to proper usage of asyncio.
  • Chinese and Engrish names returned by the API are renamed to simpler English fields.
  • Supports the majority of the popular endpoints.
  • Cleanly integrates with frameworks like FastAPI out of the box.

Note: This library is a successor to genshinstats - an unofficial wrapper for the Genshin Impact api.

Requirements

  • Python 3.8+
  • aiohttp
  • Pydantic
pip install genshin

Example

A very simple example of how genshin.py would be used:

import asyncio
import genshin

async def main():
    cookies = {"ltuid": 119480035, "ltoken": "cnF7TiZqHAAvYqgCBoSPx5EjwezOh1ZHoqSHf7dT"}
    client = genshin.Client(cookies)

    data = await client.get_genshin_user(710785423)
    print(f"User has a total of {data.stats.characters} characters")

asyncio.run(main())

Contributing

Any kind of contribution is welcome. Please read CONTRIBUTING.md to see what you need to do to make a contribution.

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

genshin-1.6.3.tar.gz (94.7 kB view details)

Uploaded Source

Built Distribution

genshin-1.6.3-py3-none-any.whl (126.9 kB view details)

Uploaded Python 3

File details

Details for the file genshin-1.6.3.tar.gz.

File metadata

  • Download URL: genshin-1.6.3.tar.gz
  • Upload date:
  • Size: 94.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for genshin-1.6.3.tar.gz
Algorithm Hash digest
SHA256 5a9dc17fcaf1627f1b4077e77d6e000c1121b8d8797e34809bc8dce6678606cc
MD5 3444438cd0eb389aa1a84d0df88f42ef
BLAKE2b-256 45f8a553be34c9c90be8d66d8a68f7a049366c813995f6225f7b3da651d982ab

See more details on using hashes here.

File details

Details for the file genshin-1.6.3-py3-none-any.whl.

File metadata

  • Download URL: genshin-1.6.3-py3-none-any.whl
  • Upload date:
  • Size: 126.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for genshin-1.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 de5f87dbac46abbbed8ccc6cf48be345044a927cbce28fe0830639484d53b1e0
MD5 401ae09fb0c58d7e36ba521b3f98ba5f
BLAKE2b-256 352178e96ec72175cfc2dece5dfab6088bd84ed7fe458472c50507628ab436b6

See more details on using hashes here.

Supported by

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