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

Uploaded Source

Built Distribution

genshin-1.5.0-py3-none-any.whl (107.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: genshin-1.5.0.tar.gz
  • Upload date:
  • Size: 78.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for genshin-1.5.0.tar.gz
Algorithm Hash digest
SHA256 831e3428ffe30699efc899781aefa25e75916d1c510548503dfb91fbb0714daf
MD5 834b132e3f2cec7867bfac903ff54a89
BLAKE2b-256 f19c55ec16efddc0bf727a2a2c5bd5159a0a502222859c7ec7a1db359dd776ad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: genshin-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 107.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for genshin-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7ad2efb35088684077671a8ab89983dafa11a0454ce28722a9d7a5de23e8dab6
MD5 74073426d2def358411e11a0da8ec0ab
BLAKE2b-256 c1be0d4e0b20615d538e76302a980a903418f5a3d43675d70deb513e3b9330df

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