Module get_streams

Available on crate feature helix only.

Gets information about active streams. get-streams

Accessing the endpoint

Notes

See also HelixClient::get_streams_from_logins and HelixClient::get_streams_from_ids

Request: GetStreamsRequest

To use this endpoint, construct a GetStreamsRequest with the GetStreamsRequest::user_ids(), GetStreamsRequest::user_logins() or GetStreamsRequest::game_ids() method.

use twitch_api::helix::streams::get_streams;
let request = get_streams::GetStreamsRequest::user_logins(&["justintvfan"]);

Response: Stream

Send the request to receive the response with HelixClient::req_get().

use twitch_api::helix::{self, streams::get_streams};
let client: helix::HelixClient<'static, client::DummyHttpClient> =
    helix::HelixClient::default();
let request = get_streams::GetStreamsRequest::user_logins(&["justintvfan"]);
let response: Vec<get_streams::Stream> = client.req_get(request, &token).await?.data;

You can also get the http::Request with request.create_request(&token, &client_id) and parse the http::Response with GetStreamsRequest::parse_response(None, &request.get_uri(), response)

Structs

GetStreamsRequest

Query Parameters for Get Streams

Stream

Return Values for Get Streams