Skip to content

Resource RoundResource

CrucifiedPain edited this page Jun 26, 2026 · 9 revisions

RoundResource (client.round)

Endpoints: • round.getById • round.getLastHits

.get()

Get a battle round by ID.

Signature

await client.round.get(round_id: 'str') -> 'Round'

Parameters

Name Type Default
round_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

Hit

A single hit entry (round.getLastHits / round side lastHits).

Field Type Required Description
_id `string null` No
__v `integer null` No
user `string null` No
mu `string null` No
damages `number null` No
isCriticalHit `boolean null` No
isMissed `boolean null` No
hitAt `string null` No
ammo `string null` No
weapon `Equipment null` No
equipments `array[Equipment] null` No

Round

Field Type Required Description
_id `string null` No
__v `integer null` No
battle `string null` No
number `integer null` No
isActive `boolean null` No
attacker `RoundSide null` No
defender `RoundSide null` No
live `RoundLive null` No
createdAt `string null` No
updatedAt `string null` No

RoundLive

Field Type Required Description
_id `string null` No
__v `integer null` No
ticksCount `integer null` No
actualTickPoints `number null` No
nextTickAt `string null` No

RoundSide

Combat stats of one side (attacker/defender) within a round.

Field Type Required Description
_id `string null` No
__v `integer null` No
country `string null` No
damages `number null` No
points `number null` No
hitCount `integer null` No
lastHits `array[Hit] null` No

.get_last_hits()

Get the most recent hits in a battle round.

Signature

await client.round.get_last_hits(round_id: 'str') -> 'list[Hit]'

Parameters

Name Type Default
round_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

Hit

A single hit entry (round.getLastHits / round side lastHits).

Field Type Required Description
_id `string null` No
__v `integer null` No
user `string null` No
mu `string null` No
damages `number null` No
isCriticalHit `boolean null` No
isMissed `boolean null` No
hitAt `string null` No
ammo `string null` No
weapon `Equipment null` No
equipments `array[Equipment] null` No

.get_many()

Fetch multiple rounds by ID concurrently using the auto-batcher.

Signature

await client.round.get_many(round_ids: 'list[str]') -> 'list[Round | None]'

Parameters

Name Type Default
round_ids list[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

Hit

A single hit entry (round.getLastHits / round side lastHits).

Field Type Required Description
_id `string null` No
__v `integer null` No
user `string null` No
mu `string null` No
damages `number null` No
isCriticalHit `boolean null` No
isMissed `boolean null` No
hitAt `string null` No
ammo `string null` No
weapon `Equipment null` No
equipments `array[Equipment] null` No

Round

Field Type Required Description
_id `string null` No
__v `integer null` No
battle `string null` No
number `integer null` No
isActive `boolean null` No
attacker `RoundSide null` No
defender `RoundSide null` No
live `RoundLive null` No
createdAt `string null` No
updatedAt `string null` No

RoundLive

Field Type Required Description
_id `string null` No
__v `integer null` No
ticksCount `integer null` No
actualTickPoints `number null` No
nextTickAt `string null` No

RoundSide

Combat stats of one side (attacker/defender) within a round.

Field Type Required Description
_id `string null` No
__v `integer null` No
country `string null` No
damages `number null` No
points `number null` No
hitCount `integer null` No
lastHits `array[Hit] null` No

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

Clone this wiki locally