TwitchApi.Search.SearchChannels (TwitchApi v0.1.2) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

This example searches for channels: This example searches for live channels:

requests:

curl -X GET 'https://api.twitch.tv/helix/search/channels?query=a_seagull'
-H'Authorization: Bearer 2gbdx6oar67tqtcmt49t3wpcgycthx'
-H'Client-Id: wbmytr93xzw8zbg0p1izqyzzc5mbiz' curl -X GET 'https://api.twitch.tv/helix/search/channels?query=loserfruit'
-H'Authorization: Bearer 2gbdx6oar67tqtcmt49t3wpcgycthx'
-H'Client-Id: wbmytr93xzw8zbg0p1izqyzzc5mbiz'

Example response from twitch api docs:

descriptions:

Search for channels response: Search for live channels response:

responses:

{"data":[{"broadcaster_language":"en","broadcaster_login":"a_seagull","display_name":"A_Seagull","game_id":"506442","game_name":"DOOM Eternal","id":"19070311","is_live":true,"tags_ids":["6ea6bca4-4712-4ab9-a906-e3336a9d8039"],"thumbnail_url":"https://static-cdn.jtvnw.net/jtv_user_pictures/a_seagull-profile_image-4d2d235688c7dc66-300x300.png","title":"a_seagull","started_at":"2020-03-18T17:56:00Z"}],"pagination":{}} {"data":[{"broadcaster_language":"en","broadcaster_login":"loserfruit","display_name":"Loserfruit","game_id":"498000","game_name":"House Flipper","id":"41245072","is_live":false,"tags_ids":[],"thumbnail_url":"https://static-cdn.jtvnw.net/jtv_user_pictures/fd17325a-7dc2-46c6-8617-e90ec259501c-profile_image-300x300.png","title":"loserfruit","started_at":""},...],"pagination":{"cursor":"Mg=="}}

Link to this section Summary

Types

Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.

Maximum number of objects to return.Maximum: 100Default: 20

Filter results for live streams only.Default: false

URl encoded search query

Functions

Description:

Returns a list of channels that match the query via channel name or description either entirely or partially.

Link to this section Types

Specs

after_query_param() :: %{after_query_param: String.t()}

Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.

Specs

first() :: %{first: integer()}

Maximum number of objects to return.Maximum: 100Default: 20

Specs

live_only() :: %{live_only: boolean()}

Filter results for live streams only.Default: false

Specs

query() :: %{query: String.t()}

URl encoded search query

Link to this section Functions

Specs

call(query() | first() | after_query_param() | live_only()) ::
  {:ok, Finch.Response.t()} | {:error, Exception.t()}

Description:

Returns a list of channels that match the query via channel name or description either entirely or partially.

Required authentication:

OAuth or App Access Token required

Required authorization: