Skip to content

Resource InventoryResource

CrucifiedPain edited this page Jun 26, 2026 · 8 revisions

InventoryResource (client.inventory)

Endpoints: • inventory.fetchCurrentEquipment

.get_equipment()

Get the currently equipped items for a user.

Args: user_id: The unique identifier of the user.

Signature

await client.inventory.get_equipment(user_id: 'str') -> 'list[Equipment]'

Parameters

Name Type Default
user_id str *Required*

Return Models

Equipment

A single equipped item returned by inventory.fetchCurrentEquipment.

The API returns one object keyed by slot (weapon, helmet, ...); the resource flattens it into a list of Equipment with slot set.

Field Type Required Description
_id string Optional
__v integer Optional
slot string Optional The slot.
itemId string Optional The item id.
itemCode string Optional The item code.
name string Optional The official name of the country.
rarity string Optional The rarity.
stats object Optional The stats.
type string Optional The type.
code string Optional The code.
skills EquipmentSkills Optional The skills.
state number Optional The state.
maxState number Optional The max state.
quantity integer Optional The quantity.
lastAcquisitionAt string Optional The timestamp of the last acquisition event.

EquipmentSkills

Stat bonuses granted by an equipped item.

Field Type Required Description
_id string Optional
__v integer Optional
attack number Optional The attack.
armor number Optional The armor.
criticalChance number Optional The critical chance.
criticalDamages number Optional The critical damages.
dodge number Optional The dodge.
precision number Optional The precision.

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

await client.inventory.invalidate_cache() -> 'None'

Clone this wiki locally