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

EquipmentSkills

Stat bonuses granted by an equipped item.

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

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

Clone this wiki locally