Class DonationAlertsDonationsApi

Donation Alerts Donations API.

Remarks

This API provides functionality to fetch donations associated with a streamer’s account. It supports fetching donations page-by-page, retrieving all donations, and working with paginators for more flexible data handling.

The API methods require the oauth-donation-index scope to access the data.

Hierarchy

BaseApi
- DonationAlertsDonationsApi

Index

Methods

createDonationsPaginator getAllDonations getDonations

Methods

createDonationsPaginator

createDonationsPaginator(
    user: UserIdResolvable,
    rateLimiterOptions?: RateLimiterRequestOptions,
): DonationAlertsApiPaginator<
    DonationAlertsDonationData,
    DonationAlertsDonation,
>
Creates a paginator for fetching donation data.

The paginator provides flexibility by allowing you to fetch donation data page-by-page. This is especially useful for handling large datasets incrementally.
Parameters
- user: UserIdResolvable
  The ID of the user to fetch donations for.
- OptionalrateLimiterOptions: RateLimiterRequestOptions
  Optional Rate Limiter configuration.
Returns DonationAlertsApiPaginator<DonationAlertsDonationData, DonationAlertsDonation>
A DonationAlertsApiPaginator instance for donations.
Remarks
Requires the oauth-donation-index scope.
Example
Fetch the next page
```
const paginator = apiClient.donations.createDonationsPaginator(userId);
const firstPage = await paginator.getNext();
console.log(firstPage.data); // donations from the first page
```
Example
Iterate over paginator
```
const paginator = apiClient.donations.createDonationsPaginator(userId);

for await (const pageDonations of paginator) {
    console.log(pageDonations);
}
```
- Defined in api/src/api/donations/donation-alerts-donations-api.ts:134

getAllDonations

getAllDonations(
user: UserIdResolvable,
rateLimiterOptions?: RateLimiterRequestOptions,
): Promise<DonationAlertsDonation[]>
Fetches all donations associated with the specified user.
Parameters
- user: UserIdResolvable
  The ID of the user to fetch all donations for.
- OptionalrateLimiterOptions: RateLimiterRequestOptions
  Optional Rate Limiter configuration.
Returns Promise<DonationAlertsDonation[]>
A promise that resolves to an array of DonationAlertsDonation objects.
Remarks
Requires the oauth-donation-index scope.

This method retrieves all donation data for a user and may take longer to execute, especially for users with a large volume of donations. For better performance with large datasets, consider using the DonationAlertsDonationsApi#createDonationsPaginator method to fetch data in chunks.

Throws
HttpError if the API response returns a non-200 status code.

Throws
UnregisteredUserError if the user is not registered in the authentication provider.

Throws
MissingScopeError if the access token lacks the oauth-donation-index scope.
Example
```
const allDonations = await apiClient.donations.getAllDonations(userId);
console.log(`Retrieved ${allDonations.length} donations.`);
```
- Defined in api/src/api/donations/donation-alerts-donations-api.ts:93

getDonations

getDonations(
    user: UserIdResolvable,
    pagination?: DonationAlertsApiPagination,
    rateLimiterOptions?: RateLimiterRequestOptions,
): Promise<DonationAlertsDonation[]>
Fetches a single page of donation data for a specified user.
Parameters
- user: UserIdResolvable
  The ID of the user to fetch donations for.
- pagination: DonationAlertsApiPagination = {}
  Pagination options (e.g., page number to retrieve).
- OptionalrateLimiterOptions: RateLimiterRequestOptions
  Optional Rate Limiter configuration.
Returns Promise<DonationAlertsDonation[]>
A promise that resolves to an array of DonationAlertsDonation objects.
Remarks
Requires the oauth-donation-index scope.

If no pagination options are provided, it defaults to the first page.

Throws
HttpError if the HTTP status code is outside the range of 200–299.

Throws
UnregisteredUserError if the user is not registered in the authentication provider.

Throws
MissingScopeError if the access token lacks the oauth-donation-index scope.
Example
```
const donations = await apiClient.donations.getDonations(userId, { page: 1 });
donations.forEach(donation => console.log(donation.username, donation.amount, donation.currency));
```
- Defined in api/src/api/donations/donation-alerts-donations-api.ts:45

Class DonationAlertsDonationsApi

Remarks

Hierarchy

Index

Methods

Methods

createDonationsPaginator

Parameters

Returns DonationAlertsApiPaginator<DonationAlertsDonationData, DonationAlertsDonation>

Remarks

Example

Example

getAllDonations

Parameters

Returns Promise<DonationAlertsDonation[]>

Remarks

Throws

Throws

Throws

Example

getDonations

Parameters

Returns Promise<DonationAlertsDonation[]>

Remarks

Throws

Throws

Throws

Example

Settings

On This Page