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 null` No
__v `integer null` No
slot `string null` No
itemId `string null` No
itemCode `string null` No
name `string null` No
rarity `string null` No
stats `object null` No
type `string null` No
code `string null` No
skills `EquipmentSkills null` No
state `number null` No
maxState `number null` No
quantity `integer null` No
lastAcquisitionAt `string null` No

EquipmentSkills

Stat bonuses granted by an equipped item.

Field Type Required Description
_id `string null` No
__v `integer null` No
attack `number null` No
armor `number null` No
criticalChance `number null` No
criticalDamages `number null` No
dodge `number null` No
precision `number null` No

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

Clone this wiki locally