Streaks

The Streaks system tracks continuous player activity, enabling reward-based player engagement. Learn more in the Streaks concept guide.

Overview #

The Streaks system enables your game to:

  • List current player streaks.
  • Claim rewards based on streak achievements.
  • Reset specific player streaks.
  • Update streaks manually.

Before You Start #

Ensure you have:

  • Python project configured with Hiro SDK.
  • Nakama system integrated (guide).

Working with Streaks #

Listing Player Streaks #

List all current streaks for the player:

1
2

streaks_list = await hiro_client.streaks_list()
print(streaks_list)

Claiming Streak Rewards #

Allow players to claim rewards for completed streaks:

1
2
3
4
5

request = StreaksClaimRequest()
request.item_category = ["daily_login"]

streaks_list = await hiro_client.streaks_claim(request)
print(streaks_list)

Resetting Streaks #

Reset specified streaks for a player:

1
2
3
4
5

request = StreaksResetRequest()
request.item_category = ["daily_login"]

streaks_list = await hiro_client.streaks_reset(request)
print(streaks_list)

Updating Streaks #

Manually update streak values:

1
2
3
4
5
6
7

request = StreaksUpdateRequest()
request.ids = {
    "daily_login": "1"
}

streaks_list = await hiro_client.streaks_update(request)
print(streaks_list)