Resource TransactionResource

TransactionResource (client.transaction)

Endpoints: • transaction.getPaginatedTransactions (cursor-paginated)

.collect_all()

Fetch all transactions back to oldest_date using parallel time-slicing. By forging synthetic cursors for intermediate dates, this method bypasses the sequential dependency of cursor pagination and allows fetching chunks concurrently. Because the chunks are fetched concurrently, the underlying HTTP client will automatically batch them into single POST requests.

Signature

await client.transaction.collect_all(*, oldest_date: 'datetime | str', limit: 'int' = 100, user_id: 'str | None' = None, mu_id: 'str | None' = None, country_id: 'str | None' = None, party_id: 'str | None' = None, item_code: 'str | None' = None, transaction_type: 'TransactionType | str | list[TransactionType | str] | None' = None, time_slice_days: 'float' = 0.2, concurrency: 'int' = 500) -> 'list[Transaction]'

Parameters

Name	Type	Default
oldest_date	datetime | str	*Required*
limit	int	100
user_id	str	None
mu_id	str	None
country_id	str	None
party_id	str	None
item_code	str	None
transaction_type	TransactionType | str | list[TransactionType | str]	None
time_slice_days	float	0.2
concurrency	int	500

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.

Transaction

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
transactionType	string	Optional	The transaction type.
money	number	Optional	The money.
quantity	integer	Optional	The quantity.
sellerId	string	Optional	The seller id.
buyerId	string	Optional	The buyer id.
itemCode	string	Optional	The item code.
item	Equipment	Optional	The item.
offerCreatedAt	string	Optional	The offer created at.
userId	string	Optional	The user id.
muId	string	Optional	The mu id.
countryId	string	Optional	The country id.
partyId	string	Optional	The party id.
createdAt	string	Optional	The timestamp when this record was created.
updatedAt	string	Optional	The timestamp when this record was last modified.

---

.get_paginated()

Get paginated transactions with optional filters.

transaction_type uniquely accepts a single type string OR a list — both are valid per the API schema. When a list is passed it is serialised as-is.

Signature

await client.transaction.get_paginated(*, limit: 'int' = 10, cursor: 'str | None' = None, user_id: 'str | None' = None, mu_id: 'str | None' = None, country_id: 'str | None' = None, party_id: 'str | None' = None, item_code: 'str | None' = None, transaction_type: 'TransactionType | str | list[TransactionType | str] | None' = None, auto_items: 'bool' = False, max_pages: 'int | float' = inf, cursor_end: 'str | None' = None) -> 'CursorPage[Transaction] | AsyncIterator[Transaction]'

Parameters

Name	Type	Default
limit	int	10
cursor	str	None
user_id	str	None
mu_id	str	None
country_id	str	None
party_id	str	None
item_code	str	None
transaction_type	TransactionType | str | list[TransactionType | str]	None
auto_items	bool	False
max_pages	int | float	inf
cursor_end	str	None

Return Models

CursorPage[Transaction]

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
items	array[Transaction]	Required
nextCursor	string	Optional
hasMore	boolean	Optional

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.

Transaction

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
transactionType	string	Optional	The transaction type.
money	number	Optional	The money.
quantity	integer	Optional	The quantity.
sellerId	string	Optional	The seller id.
buyerId	string	Optional	The buyer id.
itemCode	string	Optional	The item code.
item	Equipment	Optional	The item.
offerCreatedAt	string	Optional	The offer created at.
userId	string	Optional	The user id.
muId	string	Optional	The mu id.
countryId	string	Optional	The country id.
partyId	string	Optional	The party id.
createdAt	string	Optional	The timestamp when this record was created.
updatedAt	string	Optional	The timestamp when this record was last modified.

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

---