Resource MercenaryContractAuctionResource

MercenaryContractAuctionResource (client.mercenary_contract_auction)

Endpoints: • mercenaryContractAuction.getPaginatedAuctions

.collect_all()

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

Signature

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

Parameters

Name	Type	Default
kwargs	Any	*Required*

Return Models

MercenaryContractAuction

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

MercenaryContractAuctionBid

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
bidAt	string	✅
mu	string	✅
payout	integer \| number	✅
perK	integer \| number	✅
user	string	✅

---

.get_paginated_auctions()

Get mercenary contract auctions (cursor-paginated).

Signature

await client.mercenarycontractauction.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	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

Return Models

CursorPage[MercenaryContractAuction]

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

MercenaryContractAuction

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

MercenaryContractAuctionBid

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
bidAt	string	✅
mu	string	✅
payout	integer \| number	✅
perK	integer \| number	✅
user	string	✅

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

---