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	Optional
__v	integer	Optional
battle	string	Required	The battle.
bids	array[MercenaryContractAuctionBid]	Required	The bids.
budget	integer | number	Required	The budget.
country	string	Required	The UUID of the country this user holds citizenship in.
createdAt	string	Required	The timestamp when this record was created.
createdBy	string	Required	The created by.
currentPayout	integer | number	Required	The current payout.
currentPerK	integer | number	Required	The current per k.
currentWinner	string	Optional	The current winner.
currentWinnerUser	string	Optional	The current winner user.
duration	integer	Required	The duration.
expiresAt	string	Required	The expires at.
forCountry	string	Required	The for country.
forCountrySide	string	Required	The for country side.
initialPerK	integer | number	Required	The initial per k.
minimumDamage	integer | number	Required	The minimum damage.
professionalsOnly	boolean	Required	The professionals only.
round	string	Required	The round.
roundNumber	integer	Required	The round number.
status	string	Required	The status.
updatedAt	string	Required	The timestamp when this record was last modified.

MercenaryContractAuctionBid

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
bidAt	string	Required	The bid at.
mu	string	Required	The UUID of the Military Unit this user belongs to.
payout	integer | number	Required	The payout.
perK	integer | number	Required	The per k.
user	string	Required	The user.

---

.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	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	Description
_id	string	Optional
__v	integer	Optional
items	array[MercenaryContractAuction]	Required
nextCursor	string	Optional
hasMore	boolean	Optional

MercenaryContractAuction

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
battle	string	Required	The battle.
bids	array[MercenaryContractAuctionBid]	Required	The bids.
budget	integer | number	Required	The budget.
country	string	Required	The UUID of the country this user holds citizenship in.
createdAt	string	Required	The timestamp when this record was created.
createdBy	string	Required	The created by.
currentPayout	integer | number	Required	The current payout.
currentPerK	integer | number	Required	The current per k.
currentWinner	string	Optional	The current winner.
currentWinnerUser	string	Optional	The current winner user.
duration	integer	Required	The duration.
expiresAt	string	Required	The expires at.
forCountry	string	Required	The for country.
forCountrySide	string	Required	The for country side.
initialPerK	integer | number	Required	The initial per k.
minimumDamage	integer | number	Required	The minimum damage.
professionalsOnly	boolean	Required	The professionals only.
round	string	Required	The round.
roundNumber	integer	Required	The round number.
status	string	Required	The status.
updatedAt	string	Required	The timestamp when this record was last modified.

MercenaryContractAuctionBid

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
bidAt	string	Required	The bid at.
mu	string	Required	The UUID of the Military Unit this user belongs to.
payout	integer | number	Required	The payout.
perK	integer | number	Required	The per k.
user	string	Required	The user.

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

---