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

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.4.0.tar.gz (75.7 kB view details)

Uploaded Source

Built Distribution

genshin-1.4.0-py3-none-any.whl (102.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: genshin-1.4.0.tar.gz
  • Upload date:
  • Size: 75.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for genshin-1.4.0.tar.gz
Algorithm Hash digest
SHA256 e5af58f187ba4b9aba7dd5585f4146a332f9bff939efc90a2268371124c1597a
MD5 2babc9c047ea00a46dbedc42dcde51a1
BLAKE2b-256 18676acd3450259850437648341a949a692f9e96dbe37e8cbef92f246d95e7d9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: genshin-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 102.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for genshin-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 93a47d47125cc09acaa7c7cf145c409699896ec957edb938a91f97676b761f43
MD5 fb2ed1a826ccfcc4585133671ad0334d
BLAKE2b-256 4f79545e0ff53c7251153cc3964ae983e5c477d3458e67d73f00b3124444bddc

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