MercenaryContractAuctionResource (client.mercenary_contract_auction)

Endpoints: • mercenaryContractAuction.getPaginatedAuctions

.collect_all()

Fetch all items across all pages concurrently using parallel time-slicing.

Signature

await client.mercenary_contract_auction.collect_all(**kwargs: 'typing.Any') -> 'list[MercenaryContractAuction]'

Parameters

Name	Type	Default
kwargs	Any	Required

Return Models

MercenaryContractAuction

Field	Type	Required
_id	string	Optional
__v	integer	Optional
battle	string	Required
bids	array[MercenaryContractAuctionBid]	Required
budget	integer | number	Required
country	string	Required
createdAt	string	Required
createdBy	string	Required
currentPayout	integer | number	Required
currentPerK	integer | number	Required
currentWinner	string	Optional
currentWinnerUser	string	Optional
duration	integer	Required
expiresAt	string	Required
forCountry	string	Required
forCountrySide	string	Required
initialPerK	integer | number	Required
minimumDamage	integer | number	Required
professionalsOnly	boolean	Required
round	string	Required
roundNumber	integer	Required
status	string	Required
updatedAt	string	Required

MercenaryContractAuctionBid

Field	Type	Required
_id	string	Optional
__v	integer	Optional
bidAt	string	Required
mu	string	Required
payout	integer | number	Required
perK	integer | number	Required
user	string	Required

---

.get_paginated_auctions()

Get mercenary contract auctions (cursor-paginated).

Signature

await client.mercenary_contract_auction.get_paginated_auctions(*, country_id: 'str | None' = None, battle_id: 'str | None' = None, status: 'MercenaryAuctionStatus | str | None' = None, limit: 'int' = 10, cursor: 'str | None' = None, auto_items: 'bool' = False, max_pages: 'int | float' = inf, cursor_end: 'str | None' = None) -> 'CursorPage[MercenaryContractAuction] | AsyncIterator[MercenaryContractAuction]'

Parameters

Name	Type	Default
country_id	str	None
battle_id	str	None
status	MercenaryAuctionStatus | str	None
limit	int	10
cursor	str	None
auto_items	bool	False
max_pages	int | float	inf
cursor_end	str	None

Return Models

CursorPage[MercenaryContractAuction]

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

MercenaryContractAuction

Field	Type	Required
_id	string	Optional
__v	integer	Optional
battle	string	Required
bids	array[MercenaryContractAuctionBid]	Required
budget	integer | number	Required
country	string	Required
createdAt	string	Required
createdBy	string	Required
currentPayout	integer | number	Required
currentPerK	integer | number	Required
currentWinner	string	Optional
currentWinnerUser	string	Optional
duration	integer	Required
expiresAt	string	Required
forCountry	string	Required
forCountrySide	string	Required
initialPerK	integer | number	Required
minimumDamage	integer | number	Required
professionalsOnly	boolean	Required
round	string	Required
roundNumber	integer	Required
status	string	Required
updatedAt	string	Required

MercenaryContractAuctionBid

Field	Type	Required
_id	string	Optional
__v	integer	Optional
bidAt	string	Required
mu	string	Required
payout	integer | number	Required
perK	integer | number	Required
user	string	Required

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

---