Get Hype Train Status
Gets the active Hype Train status for the specified Twitch channel and saves the active Hype Train object. For more information on what the response contains, check out the Response Body table in the Twitch API Reference Guide for Get Hype Train Status.
This is an Async (Purple) Command, which operates differently from standard commands.
This command returns nothing if there isn't an active Hype Train, leaving your variable with the result of
undefined.
| Box Name | Type | Description |
|---|---|---|
| Channel | Dropdown | Twitch channel to get the Hype Train status from. This can be left empty to use the default account. |
| Save Variable As | String | Variable name to save the response as. |
Response Data:
| Variable Name | Type | Description |
|---|---|---|
| id | String | Hype Train event ID. |
| event_type | String | Type of Hype Train event. |
| event_timestamp | String | Time in Twitch format when the event happened. |
| version | String | Hype Train event version. |
| total | Number | Current total progress. |
| progress | Number | Current progress toward the next level. |
| goal | Number | Progress required for the next level. |
| level | Number | Current Hype Train level. |
| top_contributions | Array | Top contribution objects returned by Twitch. |
| last_contribution | Object | Most recent contribution object returned by Twitch. |
| expires_at | String | Time in Twitch format when the current Hype Train expires. |
| started_at | String | Time in Twitch format when the current Hype Train started. |
| cooldown_ends_at | String | Time in Twitch format when the cooldown ends. |
Requires the
channel:read:hype_train Twitch scope.