API Reference
GIClient
Bases: BaseClient
Client to interact with the Hakushin Genshin Impact API.
fetch_artifact_set_detail(set_id, *, use_cache=True)
async
Fetch the details of a Genshin Impact artifact set.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
set_id
|
int
|
The artifact set ID. |
required |
use_cache
|
bool
|
Whether to use the response cache. |
True
|
Returns:
| Type | Description |
|---|---|
ArtifactSetDetail
|
The artifact set details object. |
fetch_artifact_sets(*, use_cache=True)
async
Fetch all Genshin Impact artifact sets.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
use_cache
|
bool
|
Whether to use the response cache. |
True
|
Returns:
| Type | Description |
|---|---|
list[ArtifactSet]
|
A list of artifact set objects. |
fetch_character_detail(character_id, *, use_cache=True)
async
Fetch the details of a Genshin Impact character.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
character_id
|
str
|
The character ID. |
required |
use_cache
|
bool
|
Whether to use the response cache. |
True
|
Returns:
| Type | Description |
|---|---|
CharacterDetail
|
The character details object. |
fetch_characters(*, use_cache=True)
async
Fetch all Genshin Impact characters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
use_cache
|
bool
|
Whether to use the response cache. |
True
|
Returns:
| Type | Description |
|---|---|
list[Character]
|
A list of character objects. |
fetch_new(*, use_cache=True)
async
Fetch the ID of beta items in Genshin Impact.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
use_cache
|
bool
|
Whether to use the response cache. |
True
|
Returns:
| Type | Description |
|---|---|
New
|
A model representing the new items. |
fetch_weapon_detail(weapon_id, *, use_cache=True)
async
Fetch the details of a Genshin Impact weapon.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
weapon_id
|
int
|
The weapon ID. |
required |
use_cache
|
bool
|
Whether to use the response cache. |
True
|
Returns:
| Type | Description |
|---|---|
WeaponDetail
|
The weapon details object. |
fetch_weapons(*, use_cache=True)
async
Fetch all Genshin Impact weapons.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
use_cache
|
bool
|
Whether to use the response cache. |
True
|
Returns:
| Type | Description |
|---|---|
list[Weapon]
|
A list of weapon objects. |