TwitchApi

API Wrapper for the New Twitch API (TwitchApi)

This package is NOT ready for production.

If you decide to use this, ensure you pull from the specific commit hash that works for your application; I'll be updating master quite frequently with breaking changes.

Installation

Not available in hex (yet)

def deps do
  [
    {:twitch_api, "~> 0.1.0"}
  ]
end

Description

The Twitch Api has a few API's that have their own requirements - this package handles all of them in isolation with the same client.

The default API's are:

• https://api.twitch.tv/helix
• https://api.twitch.tv/extensions
• https://id.twitch.tv

Environment Variables

The TwitchApi.Client may use environment variables to bootstrap with new/0 otherwise defaults will be used. See the following environment variables:

TWITCH_API_CLIENT_ID=
TWITCH_API_CLIENT_SECRET=
TWITCH_API_EXTENSION_CLIENT_ID=
TWITCH_API_EXTENSION_CLIENT_SECRET=
TWITCH_API_HELIX_ENDPOINT=
TWITCH_API_EXTENSION_ENDPOINT=
TWITCH_API_ID_ENDPOINT=
TWITCH_API_HELIX_WEBHOOK_CALLBACK_URL=

You may also use config:

config :twitch_api,
  client_id: System.get_env("TWITCH_API_CLIENT_ID"),
  client_secret: System.get_env("TWITCH_API_CLIENT_SECRET"),
  extension_client_id: System.get_env("TWITCH_API_EXTENSION_CLIENT_ID"),
  extension_client_secret: System.get_env("TWITCH_API_EXTENSION_CLIENT_SECRET"),
  id_endpoint: System.get_env("TWITCH_API_ID_ENDPOINT"),
  helix_endpoint: System.get_env("TWITCH_API_HELIX_ENDPOINT"),
  extension_endpoint: System.get_env("TWITCH_API_EXTENSION_ENDPOINT"),
  webhook_callback_url: System.get_env("TWITCH_API_HELIX_WEBHOOK_CALLBACK_URL", nil)

In Progress

x is complete

- is in progress or needs tests

HELIX

?	Resource	Endpoint
[ ]	Analytics	Extension Analytics
[ ]	Analytics	Game Analytics
[ ]	Bits	Bits Leaderboard
[ ]	Bits	Extension Transactions
[ ]	Clips	Create Clip
[ ]	Clips	Get Clip
[ ]	Entitlements	Create Entitlement x
[ ]	Entitlements	Get Code Status
[ ]	Entitlements	Redeem Code
[x]	Games	Get Top Games
[x]	Games	Get Games
[ ]	Moderation	Check Automod Status
[ ]	Moderation	Get Banned Events
[ ]	Moderation	Get Banned Users
[ ]	Moderation	Get Moderators
[ ]	Moderation	Get Moderator Events
[X]	Streams	Get Streams
[ ]	Streams	Get Streams Metadata
[ ]	Streams	Create Stream Marker
[ ]	Streams	Get Stream Markers
[ ]	Subscriptions	Get Broadcasters Subs
[ ]	Tags	Get All Stream Tags
[ ]	Tags	Get Stream Tags
[ ]	Tags	Replace Stream Tags
[X]	Users	Get Users
[X]	Users	Get Users Follows
[ ]	Users	Update User
[ ]	Users	Get User Extensions
[ ]	Users	Update User Extensions
[ ]	Videos	Get Videos
[-]	Webhooks	Get Webhook Subscriptions

ID/OAuth

?	Resource	Endpoint
[X]	Token	oauth2/token

Webhooks - In Progress

?	Resource	Endpoint
[-]	Hub	Subscribe
[-]	Hub	Unsubscribe

Docs

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/twitch_api.