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

EquipmentSkills

Stat bonuses granted by an equipped item.

Field	Type	Required
_id	string	Optional
__v	integer	Optional
attack	number	Optional
armor	number	Optional
criticalChance	number	Optional
criticalDamages	number	Optional
dodge	number	Optional
precision	number	Optional

Transaction

Field	Type	Required
_id	string	Optional
__v	integer	Optional
transactionType	string	Optional
money	number	Optional
quantity	integer	Optional
sellerId	string	Optional
buyerId	string	Optional
itemCode	string	Optional
item	Equipment	Optional
offerCreatedAt	string	Optional
userId	string	Optional
muId	string	Optional
countryId	string	Optional
partyId	string	Optional
createdAt	string	Optional
updatedAt	string	Optional

---

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

EquipmentSkills

Stat bonuses granted by an equipped item.

Field	Type	Required
_id	string	Optional
__v	integer	Optional
attack	number	Optional
armor	number	Optional
criticalChance	number	Optional
criticalDamages	number	Optional
dodge	number	Optional
precision	number	Optional

Transaction

Field	Type	Required
_id	string	Optional
__v	integer	Optional
transactionType	string	Optional
money	number	Optional
quantity	integer	Optional
sellerId	string	Optional
buyerId	string	Optional
itemCode	string	Optional
item	Equipment	Optional
offerCreatedAt	string	Optional
userId	string	Optional
muId	string	Optional
countryId	string	Optional
partyId	string	Optional
createdAt	string	Optional
updatedAt	string	Optional

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

---