genshinstats 1.2.5

A wrapper for the official hoyolab.com Genshin impact gameRecord API.

genshinstats

This project is meant to be a wrapper for the hoyolab.com gameRecord api. I have attempted to reverse engineer their API to find out the important tokens and cookies and then to what urls they are sent. You can pip install with PyPI

how to use

Import the genshinstats module and do set_cookie(...) to login. You can either use set_cookie(account_id=..., cookie_token=...). The cookie is required and will raise an error if missing. All functions are documented and type hinted.

examples

Simple examples of usage:

import genshinstats as gs # import module
gs.set_cookie(account_id=119480035, cookie_token="hEIIh08ghAIlHY1QQZBnsngVWXzaEMQtrSV0Bowu") # login

uid = 710785423
user_info = gs.get_user_info(uid) # get user info with a uid
total_characters = len(user_info['characters']) # get the amount of characters
print('user "sadru" has a total of',total_characters,'characters')

Cookies should be your own. These are just some example cookies of an account that can be deleted at any time.

stats = gs.get_user_info(uid)['stats']
for field,value in stats.items():
    print(f'{field.replace("_"," ")}: {value}')

characters = gs.get_all_characters(uid)
for char in characters:
    print(f"{char['rarity']}* {char['name']:10} Level: {char['level']:2} C{char['constellation']}")

spiral_abyss = gs.get_spiral_abyss(uid,previous=True)
stats = spiral_abyss['stats']
for field,value in stats.items():
    print(f'{field.replace("_"," ")}: {value}')

submodules

gachalog

Gets your gacha pull logs. For this you must first open the history/details page in genshin impact, the script will then get all required data by itself.

types = gs.get_gacha_types() # get the types
name = types[2]['name'] # name == "Character Event Wish"
log = gs.get_gacha_log(name) # get the gacha log
for i in log:
    print(f"{i['time']} - {i['name']} ({i['rarity']}* {i['type']})")

ids = gs.get_all_gacha_ids() # get all possible gacha ids (only counts opened details pages)
for i in ids:
    details = gs.get_gacha_details(i) # 
    print(f"{details['gacha_type']} - {details['banner']}")
    print('5 stars:', ', '.join(i['name'] for i in details['r5_up_items']))
    print('4 stars:', ', '.join(i['name'] for i in details['r4_up_items']))
    print()

View other's history by setting a authkey yourself:

gs.set_authkey("D3ZYe49SUzpDgzrt/l00n2673Zg8N/Yd9OSc7NulRHhp8EhzlEnz2ISBtKBR0fZ/DGs8...")
gs.set_authkey(logfile='other_output_log.txt')

Since the authkey lasts only a day this is more like for exporting than for actual use.

how to get your cookie

1. go to hoyolab.com
2. login to your account
3. open inspect mode (Developer Tools)
4. go to Application, Cookies, https://www.hoyolab.com.
5. copy account_id and cookie_token
6. use set_cookie(account_id=..., cookie_token=...) in your code

about this project

contribution

All contributions are welcome as long as it's in a form of a clean PR. Currently looking for people to reverse engineer the new api version.

crediting

This project can be freely downloaded and distributed. Crediting is appreciated.