Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Cryma/TwitchApi.Net
C# Wrapper for the Twitch Helix API
https://github.com/Cryma/TwitchApi.Net
api csharp helix twitch wrapper
Last synced: 8 days ago
JSON representation
C# Wrapper for the Twitch Helix API
- Host: GitHub
- URL: https://github.com/Cryma/TwitchApi.Net
- Owner: Cryma
- License: mit
- Created: 2019-11-08T17:39:03.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-24T14:36:19.000Z (over 2 years ago)
- Last Synced: 2024-05-28T13:08:13.507Z (about 1 month ago)
- Topics: api, csharp, helix, twitch, wrapper
- Language: C#
- Homepage:
- Size: 106 KB
- Stars: 10
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-twitch-dev - Cryma/TwitchApi.Net - C# Wrapper for the Twitch Helix API. (Libraries / C#)
README
# TwitchApi.Net
[](https://www.nuget.org/packages/TwitchApi.Net/)
[](https://www.nuget.org/packages/TwitchApi.Net/)
TwitchApi.Net aims to provide easy, thread-safe access to the Twitch Helix API. Under the hood it is targeting `netstandard2.0`, so it can be use with either .NET Framework or .NET Core. The libray also ships with a rate-limit bypass, which enforces waits between requests so you won't exceed the Helix API rate-limiting.
# Authentication
As of May 01, 2020, all requests have to contain a valid OAuth token, accompanied by the assosicated client ID.
To assist with that change, you have the option to provide an client secret so that TwitchApi.Net can handle the request and maintenance of an OAuth token.
# Installation
To install this library via [NuGet](https://www.nuget.org/packages/TwitchApi.Net/), use:
```ps
Install-Package TwitchApi.Net
```
# Example Usage
```cs
var twitchApi = new TwitchApiBuilder("CLIENT_ID")
.WithAccessToken("ACCESS_TOKEN") // Either specify a valid OAuth token.
.WithClientSecret("CLIENT_SECRET") // Or specify a client secret. (automatic OAuth token handling)
.WithRateLimitBypass() // Optional rate limit bypass
.Build();
```
# Supported Helix API sections
* [Clips](https://dev.twitch.tv/docs/api/reference#get-clips)
* [Users](https://dev.twitch.tv/docs/api/reference#get-users)
* [User Follows](https://dev.twitch.tv/docs/api/reference#get-users-follows)
* [Games](https://dev.twitch.tv/docs/api/reference#get-games)
* [Top Games](https://dev.twitch.tv/docs/api/reference#get-top-games)
* [Streams](https://dev.twitch.tv/docs/api/reference#get-streams)
* [Videos](https://dev.twitch.tv/docs/api/reference#get-videos)
# MIT License
Copyright (c) 2020 Fabian Vowie
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.