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

Uploaded Source

Built Distribution

genshin-1.2.0-py3-none-any.whl (90.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: genshin-1.2.0.tar.gz
  • Upload date:
  • Size: 66.2 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.0.tar.gz
Algorithm Hash digest
SHA256 83234ef9b0640cc3ed5846158e52f37efaa52f50fdebe4882103f185c39d8fe7
MD5 9f221d37cddc091854204322c3eae91d
BLAKE2b-256 ce479f00e1929011f87c576690a5fcf226df0a2d98d90954a527142b83883a23

See more details on using hashes here.

File details

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

File metadata

  • Download URL: genshin-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 90.0 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9777c88c1feff8c54babe38c0b28bb825d43f6a84f6a123496870f13e6fd17c3
MD5 3d625819a54ee4a3e057bfb5dee1e151
BLAKE2b-256 d66888f20bf215378e29cc5d4aff39ea00e9aec2b77dc41e0e8235cb8b0ef9ab

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