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

Uploaded Source

Built Distribution

genshin-1.2.1-py3-none-any.whl (90.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: genshin-1.2.1.tar.gz
  • Upload date:
  • Size: 66.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.13

File hashes

Hashes for genshin-1.2.1.tar.gz
Algorithm Hash digest
SHA256 7f837ff8bc258ab44501007560c15e7ecbb5509abd80760c71ea5c1aca670a20
MD5 db7cb621265713c50310804110ec15dd
BLAKE2b-256 5273115c8011f835fdd2da1e95fc37bb7973a38f51a41d05f41f5d856ad1f175

See more details on using hashes here.

File details

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

File metadata

  • Download URL: genshin-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 90.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.13

File hashes

Hashes for genshin-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1985d0715cae5282d25470651eedb4b8dcc0e7093c9c8d53daffe22085137ac1
MD5 6756793df4ce572100cabf12db69f5d4
BLAKE2b-256 0085aef51c0dcbf85977657d17ed6c85c0d7421f22ccf2633e057dd8c0e49e9d

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