Resource RoundResource

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	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.

Hit

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

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
user	string	Optional	The user.
mu	string	Optional	The UUID of the Military Unit this user belongs to.
damages	number	Optional	The damages.
isCriticalHit	boolean	Optional	The is critical hit.
isMissed	boolean	Optional	The is missed.
hitAt	string	Optional	The hit at.
ammo	string	Optional	The ammo.
weapon	Equipment	Optional	The weapon.
equipments	array[Equipment]	Optional	The equipments.

Round

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
battle	string	Optional
number	integer	Optional
isActive	boolean	Optional	Whether the user has logged in recently and is considered an active player.
attacker	RoundSide	Optional	The UUID of the country initiating the battle.
defender	RoundSide	Optional	The UUID of the country defending the region.
live	RoundLive	Optional	The live.
createdAt	string	Optional	The timestamp when this record was created.
updatedAt	string	Optional	The timestamp when this record was last modified.

RoundLive

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
ticksCount	integer	Optional	The total number of ticks.
actualTickPoints	number	Optional	The actual tick points.
nextTickAt	string	Optional	The next tick at.

RoundSide

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

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
country	string	Optional	The UUID of the country this user holds citizenship in.
damages	number	Optional	The damages.
points	number	Optional	The points.
hitCount	integer	Optional	The total number of hit.
lastHits	array[Hit]	Optional	The timestamp of the last hits event.

---

.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	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.

Hit

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

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
user	string	Optional	The user.
mu	string	Optional	The UUID of the Military Unit this user belongs to.
damages	number	Optional	The damages.
isCriticalHit	boolean	Optional	The is critical hit.
isMissed	boolean	Optional	The is missed.
hitAt	string	Optional	The hit at.
ammo	string	Optional	The ammo.
weapon	Equipment	Optional	The weapon.
equipments	array[Equipment]	Optional	The equipments.

---

.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	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.

Hit

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

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
user	string	Optional	The user.
mu	string	Optional	The UUID of the Military Unit this user belongs to.
damages	number	Optional	The damages.
isCriticalHit	boolean	Optional	The is critical hit.
isMissed	boolean	Optional	The is missed.
hitAt	string	Optional	The hit at.
ammo	string	Optional	The ammo.
weapon	Equipment	Optional	The weapon.
equipments	array[Equipment]	Optional	The equipments.

Round

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
battle	string	Optional
number	integer	Optional
isActive	boolean	Optional	Whether the user has logged in recently and is considered an active player.
attacker	RoundSide	Optional	The UUID of the country initiating the battle.
defender	RoundSide	Optional	The UUID of the country defending the region.
live	RoundLive	Optional	The live.
createdAt	string	Optional	The timestamp when this record was created.
updatedAt	string	Optional	The timestamp when this record was last modified.

RoundLive

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
ticksCount	integer	Optional	The total number of ticks.
actualTickPoints	number	Optional	The actual tick points.
nextTickAt	string	Optional	The next tick at.

RoundSide

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

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
country	string	Optional	The UUID of the country this user holds citizenship in.
damages	number	Optional	The damages.
points	number	Optional	The points.
hitCount	integer	Optional	The total number of hit.
lastHits	array[Hit]	Optional	The timestamp of the last hits event.

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

---