Auctions

Auctions enable players to interact within a player-driven economy by bidding on or directly purchasing items. Learn more in the Auctions concept guide.

Overview #

Auctions provide a dynamic system for players to trade items by:

  • Allowing players to list items for auction.
  • Facilitating competitive bidding processes.
  • Managing transactions securely and transparently.

Prerequisites #

  • Unity project set up with Hiro SDK
  • Nakama System integrated (guide)

Working with Auctions #

Creating an Auction #

Create a new auctions for players:

1
2
3
4
5

request = AuctionCreateRequest()
request.template_id = "template_auction_001"
request.condition_id = "condition_001"

auction = await hiro_client.auctions_create(request)

Placing a Bid on an Auction #

Submit a bid on an active auction:

1
2
3
4
5
6
7
8

request = AuctionBidRequest()
request.id = "auction_instance_123"
request.version = "1.0"
request.instanceIds = {
    "gold": "1000"
}

auctions = await hiro_client.auctions_bid(request)

Cancelling an Auction #

Cancel an ongoing action:

1
2
3
4

request = AuctionCancelRequest()
request.id = "auction_instance_123"

auctions = await hiro_client.auctions_cancel(request)

Claiming a Winning Bid #

Claim the item the player won:

1
2
3
4

request = AuctionClaimBidRequest()
request.id = "auction_instance_123"

auctions = await hiro_client.auctions_claim_bid(request)

List Available Auctions #

View current active auctions:

1
2
3

request = AuctionListRequest()

auctions = await hiro_client.auctions_list(request)