TwitchApi.Tags.GetAllStreamTags (TwitchApi v0.1.2) View Source
⛔ This module is autogenerated please do not modify manually.
Example request from twitch api docs:
descriptions:
This gets the first page of stream tags that Twitch defines.
requests:
curl -X GET 'https://api.twitch.tv/helix/tags/streams'
-H'Authorization: Bearer 2gbdx6oar67tqtcmt49t3wpcgycthx'
-H'Client-Id: uo6dggojyb8d6soh92zknwmi5ej1q2'
Example response from twitch api docs:
descriptions:
responses:
{"data":[{"tag_id":"621fb5bf-5498-4d8f-b4ac-db4d40d401bf","is_auto":false,"localization_names":{"bg-bg":"Изчистване на 1 кредит","cs-cz":"1 čistý kredit","da-dk":"1 credit klaret","de-de":"Mit 1 Leben abschließen","el-gr":"1 μόνο πίστωση","en-us":"1 Credit Clear",...},"localization_descriptions":{"bg-bg":"За потоци с акцент върху завършване на аркадна игра с монети, в която не се използва продължаване","cs-cz":"Pro vysílání s důrazem na plnění mincových arkádových her bez použití pokračování.","da-dk":"Til streams med vægt på at gennemføre et arkadespil uden at bruge continues","de-de":"Für Streams mit dem Ziel, ein Coin-op-Arcade-Game mit nur einem Leben abzuschließen.","el-gr":"Για μεταδόσεις με έμφαση στην ολοκλήρωση παλαιού τύπου ηλεκτρονικών παιχνιδιών που λειτουργούν με κέρμα, χωρίς να χρησιμοποιούν συνέχειες","en-us":"For streams with an emphasis on completing a coin-op arcade game without using any continues",...}},...],"pagination":{"cursor":"eyJiI..."}}
Twitch CLI examples that:# Gets the first page of stream tags.
twitch api get /tags/streams
Get the specified stream tags.
twitch api get /tags/streams -qtag_id=39490173-ed5f-4271-96a8-26ab546ee1e9 -qtag_id=233f4789-1ad0-403c-aaf9-7d37a22264e7
Link to this section Summary
Types
The cursor used to get the next page of results. The pagination object in the response contains the cursor’s value.The after and tag_id query parameters are mutually exclusive.
The maximum number of tags to return per page.Maximum: 100. Default: 20.
An ID that identifies a specific tag to return. Include the query parameter for each tag you want returned. For example, tag_id=123&tag_id=456. You may specify a maximum of 100 IDs.
Link to this section Types
Specs
after_query_param() :: %{after_query_param: String.t()}
The cursor used to get the next page of results. The pagination object in the response contains the cursor’s value.The after and tag_id query parameters are mutually exclusive.
Specs
first() :: %{first: integer()}
The maximum number of tags to return per page.Maximum: 100. Default: 20.
Specs
tag_id() :: %{tag_id: String.t()}
An ID that identifies a specific tag to return. Include the query parameter for each tag you want returned. For example, tag_id=123&tag_id=456. You may specify a maximum of 100 IDs.
Link to this section Functions
Specs
call(after_query_param() | first() | tag_id()) :: {:ok, Finch.Response.t()} | {:error, Exception.t()}
Description:
Gets the list of all stream tags that Twitch defines. You can also filter the list by one or more tag IDs.
Required authentication:
Requires an application OAuth access token.