Twitch API2 | Rust library for talking with the new Twitch API aka. "Helix", TMI and more!

You can see current unpublished docs here: ![local-docs]

See examples for examples.

```rust ,norun use twitchapi2::{TwitchClient, helix::channels::GetChannelInformationRequest}; use twitchoauth2::{AccessToken, Scope, TwitchToken, tokens::errors::TokenError, UserToken, client::reqwesthttp_client};

[tokio::main]

async fn main() -> Result<(), Box> { let clientid = twitchoauth2::ClientId::new("validclientid".tostring()); let token = UserToken::fromexisting( reqwesthttpclient, AccessToken::new("mytoken".tostring()), None, ) .await?; let client: TwitchClient = TwitchClient::default(); let req = GetChannelInformationRequest::builder() .broadcasterid("12826") .build();

println!("{:?}", &client.helix.req_get(req, &token).await?.data.unwrap().title);

Ok(())

} ```

Goals

This crate aims to target

Helix
- Partially implemented, see implemented endpoints
TMI
- Implemented, see implemented endpoints
Webhooks
PubSub (without a client)
- Partially implemented, see implemented topics
Extensions

This crate should also be able to be used for

some v5 Kraken services
GraphQL
Useful undocumented Helix endpoints, i.e endpoints mobile Twitch app uses. Including working "hidden" endpoints

There are no current plans to support

Drops (except what is in Helix)
Twitch IRC Chat, use museun/twitchchat
Authentication, use Emilgardis/twitch_oauth2

Implemented endpoints

Helix

Moderation

| Endpoint | | | | :--------------------- | :---------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ✔ Check AutoMod Status | POST https://api.twitch.tv/helix/moderation/enforcements/status | ![docs-rs] ![twitch-reference] | | ✔ Get Banned Users | GET https://api.twitch.tv/helix/moderation/banned | ![docs-rs] ![twitch-reference] | | ✔ Get Banned Events | GET https://api.twitch.tv/helix/moderation/banned/events | ![docs-rs] ![twitch-reference] | | ✔ Get Moderators | GET https://api.twitch.tv/helix/moderation/moderators | ![docs-rs] ![twitch-reference] | | ✔ Get Moderator Events | GET https://api.twitch.tv/helix/moderation/moderators/events | ![docs-rs] ![twitch-reference] |

Channels

| Endpoint | | | | :--------------------------- | :----------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ✔ Start Commercial | POST https://api.twitch.tv/helix/channels/commercial | ![docs-rs] ![twitch-reference] | | ✔ Get Channel Information | GET https://api.twitch.tv/helix/channels | ![docs-rs] ![twitch-reference] | | ✔ Modify Channel Information | PATCH https://api.twitch.tv/helix/channels | ![docs-rs] ![twitch-reference] |

Analytics

| Endpoint | | | | :------------------------ | :----------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 🔨 Get Extension Analytics | GET https://api.twitch.tv/helix/analytics/extensions | ![twitch-reference] | | 🔨 Get Game Analytics | GET https://api.twitch.tv/helix/analytics/games | ![twitch-reference] |

Bits

Extensions

| Endpoint | | | | :--------------------------- | :-------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 🔨 Get Extension Transactions | GET https://api.twitch.tv/helix/extensions/transactions | ![twitch-reference] |

Clips

Entitlements

| Endpoint | | | | :------------------------------------- | :----------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 🔨 Create Entitlement Grants Upload URL | POST https://api.twitch.tv/helix/entitlements/upload | ![twitch-reference] | | 🔨 Get Code Status | GET https://api.twitch.tv/helix/entitlements/codes | ![twitch-reference] | | 🔨 Redeem Code | POST https://api.twitch.tv/helix/entitlements/code | ![twitch-reference] |

Games

Search

| Endpoint | | | | :------------------ | :-------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ✔ Search Categories | GET https://api.twitch.tv/helix/search/categories | ![docs-rs] ![twitch-reference] | | ✔ Search Channels | GET https://api.twitch.tv/helix/search/channels | ![docs-rs] ![twitch-reference] |

Streams

Subscriptions

| Endpoint | | | | :------------------------------ | :---------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ✔ Get Broadcaster Subscriptions | GET https://api.twitch.tv/helix/subscriptions | ![docs-rs] ![twitch-reference] |

Users

Videos

| Endpoint | | | | :----------- | :--------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- | | ✔ Get Videos | GET https://api.twitch.tv/helix/videos | ![docs-rs] ![twitch-reference] |

Webhooks

| Endpoint | | | | :-------------------------- | :------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | 🔨 Get Webhook Subscriptions | GET https://api.twitch.tv/helix/webhooks/subscriptions | ![twitch-reference] |

Hypetrain

| Endpoint | | | | :---------------------- | :------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 🔨 Get Hype Train Events | GET https://api.twitch.tv/helix/hypetrain/events | ![twitch-reference] |

TMI

| Endpoint | | | :------------- | :-------------------------------------------------------- | | ✔ Get Chatters | https://tmi.twitch.tv/group/user/{broadcaster}/chatters | | ✔ Get Hosts | https://tmi.twitch.tv/hosts |

PubSub

License

^{Licensed under either of Apache License, Version
2.0 or MIT license at your option.}

_{Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.}