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

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	❌

Transaction

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
transactionType	string \| null	❌
money	number \| null	❌
quantity	integer \| null	❌
sellerId	string \| null	❌
buyerId	string \| null	❌
itemCode	string \| null	❌
item	Equipment \| null	❌
offerCreatedAt	string \| null	❌
userId	string \| null	❌
muId	string \| null	❌
countryId	string \| null	❌
partyId	string \| null	❌
createdAt	string \| null	❌
updatedAt	string \| null	❌

---

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

Return Models

CursorPage[Transaction]

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
items	array[Transaction]	✅
nextCursor	string \| null	❌
hasMore	boolean	❌

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	❌

Transaction

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
transactionType	string \| null	❌
money	number \| null	❌
quantity	integer \| null	❌
sellerId	string \| null	❌
buyerId	string \| null	❌
itemCode	string \| null	❌
item	Equipment \| null	❌
offerCreatedAt	string \| null	❌
userId	string \| null	❌
muId	string \| null	❌
countryId	string \| null	❌
partyId	string \| null	❌
createdAt	string \| null	❌
updatedAt	string \| null	❌

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

---