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`	No
__v	`integer	null`	No
battle	string	Yes
bids	array	Yes
budget	`integer	number`	Yes
country	string	Yes
createdAt	string	Yes
createdBy	string	Yes
currentPayout	`integer	number`	Yes
currentPerK	`integer	number`	Yes
currentWinner	`string	null`	No
currentWinnerUser	`string	null`	No
duration	integer	Yes
expiresAt	string	Yes
forCountry	string	Yes
forCountrySide	string	Yes
initialPerK	`integer	number`	Yes
minimumDamage	`integer	number`	Yes
professionalsOnly	boolean	Yes
round	string	Yes
roundNumber	integer	Yes
status	string	Yes
updatedAt	string	Yes

MercenaryContractAuctionBid

Field	Type	Required	Description
_id	`string	null`	No
__v	`integer	null`	No
bidAt	string	Yes
mu	string	Yes
payout	`integer	number`	Yes
perK	`integer	number`	Yes
user	string	Yes

---

.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`
battle_id	`str	None`
status	`MercenaryAuctionStatus	str
limit	int	10
cursor	`str	None`
auto_items	bool	False
max_pages	`int	float`
cursor_end	`str	None`

Return Models

CursorPage[MercenaryContractAuction]

Field	Type	Required	Description
_id	`string	null`	No
__v	`integer	null`	No
items	array	Yes
nextCursor	`string	null`	No
hasMore	boolean	No

MercenaryContractAuction

Field	Type	Required	Description
_id	`string	null`	No
__v	`integer	null`	No
battle	string	Yes
bids	array	Yes
budget	`integer	number`	Yes
country	string	Yes
createdAt	string	Yes
createdBy	string	Yes
currentPayout	`integer	number`	Yes
currentPerK	`integer	number`	Yes
currentWinner	`string	null`	No
currentWinnerUser	`string	null`	No
duration	integer	Yes
expiresAt	string	Yes
forCountry	string	Yes
forCountrySide	string	Yes
initialPerK	`integer	number`	Yes
minimumDamage	`integer	number`	Yes
professionalsOnly	boolean	Yes
round	string	Yes
roundNumber	integer	Yes
status	string	Yes
updatedAt	string	Yes

MercenaryContractAuctionBid

Field	Type	Required	Description
_id	`string	null`	No
__v	`integer	null`	No
bidAt	string	Yes
mu	string	Yes
payout	`integer	number`	Yes
perK	`integer	number`	Yes
user	string	Yes

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

---