THIS IS AN UNOFFICIAL, FAN-MADE WRAPPER. IT IS IN NO WAY ENDORSED BY TWITCH.TV
Swift Twitch is a library intended for client-facing applications interaction with the New Twitch API, Helix. This library aims to ease API interaction by returning typed data values to help you finish your application without headaches.
For example, after a non-empty Get Videos
call, you can do the following:
let firstVideoData: VideoData = getVideosData.videoData.first!
let title: String = firstVideoData.title
let viewCount: Int = firstVideoData.viewCount
❤️ Pull requests are very welcome ❤️
You can run the following API calls:
API Method | Swift Function |
---|---|
Get Extension Analytics | Twitch.Analytics.getExtensionAnalytics |
Get Game Analytics | Twitch.Analytics.getGameAnalytics |
Get Bits Leaderboard | Twitch.Bits.getBitsLeaderboard |
Create Clip | Twitch.Clips.createClip |
Get Clips | Twitch.Clips.getClips |
Get Top Games | Twitch.Games.getTopGames |
Get Games | Twitch.Games.getGames |
Get Streams | Twitch.Streams.getStreams |
Get Streams Metadata | Twitch.Streams.getStreamsMetadata |
Create Stream Marker | Twitch.Streams.createStreamMarker |
Get Stream Markers | Twitch.Streams.getStreamMarkers |
Get Users | Twitch.Users.getUsers |
Get Users Follows | Twitch.Users.getUsersFollows |
Update User | Twitch.Users.updateUser |
Get User Extensions | Twitch.Users.getUserExtensions |
Get Videos | Twitch.Videos.getVideos |
New Twitch API (Helix) Documentation
- If the above link is not working, clone this repo and open
docs/index.html
How to check if a user is following another user
import SwiftTwitch
class AwesomeClass {
func spectacularFunction() {
TwitchTokenManager.shared.accessToken = "$SomeValidToken"
let user1Id = "1234"
let user2Id = "5678"
Twitch.Users.getUsersFollows(followerId: user1Id, followedId: user2Id) { result in
switch result {
case .success(let getUsersFollowsData):
/* If the total = 1, we know that user1 is following user2
as it is documented in the Twitch API docs. */
if getUsersFollowsData.total == 1 {
print("User \(user1Id) is following user \(user2Id)!")
} else {
print("User \(user1Id) is not following user \(user2Id)")
}
case .failure(let data, let response, let error):
print("The API call failed! Unable to determine relationship.")
}
}
}
}
In order to use this library, you must first have an application register on the Twitch Developer portal. You can register your application quickly on Twitch's official application creation dashboard. After this step, there are two methods to retrieving API keys.
To manually retrieve an access token, please utilize this guide by Twitch.
I'm in the process of creating an pain-free way to retrieve tokens with a separate library! Feel free to email me at chris@chrisperkins.me
and I'll inform you when the library is public.
Now that you have an access token, you can provide it to the application in the following manner:
TwitchTokenManager.shared.accessToken = "$Your_Token"
Once this command is run, all of your API calls are now automatically authenticated! Now go make some API calls. :)
I made a separate library for that! Please see TwitchPlayer!
For Twitch Swift support, feel free to open up an issue or email me at chris@chrisperkins.me
. For API-based support, please visit The Twitch Developer Forums
-
Install CocoaPods
-
Add this repo to your
Podfile
target 'Example' do # IMPORTANT: Make sure use_frameworks! is included at the top of the file use_frameworks! pod 'SwiftTwitch' end
-
Run
pod install
in the podfile directory from your terminal -
Open up the
.xcworkspace
that CocoaPods created -
Done!
To run the example project, clone the repo, and run pod install
from the Example directory. After that, open the resulting .xcworkspace
file and go nuts!
The example project is a simple Videos browser for a pre-selected user on Twitch. To run the example project properly, you will need an access token. Set this access token in TwitchVideosTableViewController
's viewDidLoad
method.
Thank you so much for wanting to contribute! There are a couple of things you can do if you want to help out the project.
Layout of helpful contributions
-
Helper functions for verbosity
Examples:
getUserWithIDFollowers(_ userId: String)
to get the users that are following the usergetUserWithIDFollowings(_ userId: String)
to get the users that are being followed by the user
Both of these functions are just wrapped around my pre-existing
getUsersFollows
method, but they make the code that uses them more explicit. -
Additional Documentation
- Some documentation regarding the Helix API in this library is lacking. It would be awesome to have someone go back and double-check the functions as they use the library.
-
Missing functions
-
Currently, we're missing the following Twitch API functions:
I was actually unsure how to implement these nicely due to their weird way of indexing. If you know what to do, you would be an amazing help.
-
-
Anything you think would be nice! I'll most likely agree with the user (you). 😊
SwiftTwitch is available under the MIT license. See the LICENSE file for more info.