HasBitsMethods

trait Zairakai\LaravelTwitch\Services\Concerns\HasBitsMethods

Twitch Bits API methods.

Source: src/Services/Concerns/HasBitsMethods.php

Methods

getBitsLeaderboard()

public function getBitsLeaderboard(int $count = 10, string $period = 'ALL', string $userId = null, string $startedAt = null): DataCollection

Get the top bits leaderboard for a broadcaster's channel.

Parameter	Description
$count	Number of results to return (1-100)
$period	DAY, WEEK, MONTH, YEAR, or ALL

Returns DataCollection<int, BitsLeaderboardEntry>

getCheermotes()

public function getCheermotes(string $broadcasterId = null): DataCollection

Get the list of Cheermotes for a broadcaster's channel.

Returns DataCollection<int, Cheermote>

getCustomPowerUps()

public function getCustomPowerUps(string $broadcasterId, string|array|null $powerUpIds = null): DataCollection

Get a broadcaster's custom Bits Power-ups (the catalog entries - distinct from a specific redemption of one, see ChannelCustomPowerUpRedemptionAddEvent).

Parameter	Description
$powerUpIds	Filter by specific Power-up id(s), max 50

Returns DataCollection<int, CustomPowerUp>

getExtensionTransactions()

public function getExtensionTransactions(string $extensionId, string|array|null $transactionIds = null, string $after = null, int $first = 20): PaginatedResult

Get a list of transactions for an extension.

Parameter	Description
$transactionIds	Filter by specific transaction ID(s)

Returns PaginatedResult<ExtensionTransaction>