Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/age-rs/libtwitch-rs
Twitch API library written in Rust
https://github.com/age-rs/libtwitch-rs
api-wrapper rust twitch twitch-api
Last synced: about 1 month ago
JSON representation
Twitch API library written in Rust
- Host: GitHub
- URL: https://github.com/age-rs/libtwitch-rs
- Owner: age-rs
- License: lgpl-3.0
- Archived: true
- Fork: true (hatmatter/twitch_api)
- Created: 2019-09-15T14:06:39.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-03T18:40:59.000Z (almost 3 years ago)
- Last Synced: 2024-08-09T23:48:46.042Z (4 months ago)
- Topics: api-wrapper, rust, twitch, twitch-api
- Language: Rust
- Homepage: https://docs.rs/libtwitch-rs/
- Size: 172 KB
- Stars: 13
- Watchers: 1
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-twitch-dev - age-rs/libtwitch-rs - Twitch API library written in Rust. (Libraries / Rust)
README
# Archived
The Twitch v5 API is scheduled to be shutdown at the end of February
2022.
## libtwitch-rs [![docs.rs][5]][6] [![crates.io version][1]][2] [![dependency status][3]][4] ![GNU LGPLv3][lgpl-logo]
A Rust library for the Twitch APIv5 (Kraken).
# Contributing
Help for this project is highly appreciated. This was built against Twitch APIv5 (Kraken).
Take a look into the [issues](https://github.com/simonsan/libtwitch-rs/issues) if you want to contribute to the project.
Fork it, implement your changes and make a Pull-Request against the `feature-dev` branch of this repo.
# Usage
```
use libtwitch_rs;
use libtwitch_rs::users;
...
let mut c = libtwitch_rs::new(String::from(CLIENTID));
c.set_oauth_token(TOKEN);
if let Some(user) = match users::get(&c) {
Ok(r) => { assert!(r.email.is_some()); Some(r) },
Err(r) => { println!("{:?}", r); assert!(false); None }
} {
let user_id = user.id.to_string();
match users::get_by_id(&c, &user_id) {
Ok(r) => assert_eq!(r.name, user.name),
Err(r) => { println!("{:?}", r); assert!(false); }
}
}
```
# Supported API versions
__Important Note:__ Kraken is deprecated and Helix (the new API version)
is out of scope of this repository currently.
Endpoints | Kraken/v5 |
:----------------:|:------------------:|
Analytics | :heavy_minus_sign: |
Bits | :heavy_check_mark: |
Channels | :heavy_check_mark: |
Chat | :heavy_check_mark: |
Clips | :heavy_check_mark: |
Collections | :heavy_check_mark: |
Entitlements | :heavy_minus_sign: |
Games | :heavy_check_mark: |
Ingests | :heavy_check_mark: |
Moderation | :heavy_minus_sign: |
Search | :heavy_check_mark: |
Streams | :heavy_check_mark: |
Subscriptions | :heavy_minus_sign: |
Tags | :heavy_minus_sign: |
Teams | :heavy_check_mark: |
Users | :heavy_check_mark: |
Videos | :heavy_check_mark: |
Webhooks | :heavy_minus_sign: |
# Links
## Helpful Documentation
- [Token test, infos incl. Channel_ID](https://codepen.io/Alca/pen/VwwazOK)
- [Achieve Authorization for a bot](http://web.archive.org/web/20191016034229/https://d-fischer.github.io/twitch-chat-client/docs/examples/basic-bot.html)
- [Twitch API Guide](https://dev.twitch.tv/docs/api/guide)
## Token Generation
- [Token generator](https://twitchtokengenerator.com/)
- [Twitch IRC OAuth generator](https://twitchapps.com/tmi/)
## Repositories:
- [Twitch library (C#)](https://github.com/TwitchLib/TwitchLib)
- [Twitch library (PHP)](https://github.com/Dkamps18/PHP-Twitch-lib/)
- [Python Twitch client](https://github.com/tsifrer/python-twitch-client)
- [TwitchIO, Twtich Bot/API wrapper (Python)](https://github.com/TwitchIO/TwitchIO)
# License
GNU LGPL-3.0-or-later; see [copying.md](copying.md) and [legal/LGPL-v3](legal/LGPL-v3).
[1]: https://img.shields.io/crates/v/libtwitch-rs.svg?style=flat-square
[2]: https://crates.io/crates/libtwitch-rs
[3]: https://deps.rs/repo/github/age-rs/libtwitch-rs/status.svg
[4]: https://deps.rs/repo/github/age-rs/libtwitch-rs
[5]: https://docs.rs/libtwitch-rs/badge.svg
[6]: https://docs.rs/libtwitch-rs/latest/
[lgpl-logo]: https://www.gnu.org/graphics/lgplv3-88x31.png