Welcome to the TipeeeStream API documentation !

The TipeeeStream API allows you to read data for streamers using TipeeeStream : get the list of your donations, subscribers (Twitch and Hitbox), followers (Twitch and Hitbox), hosting (Twitch) and other information.
You can also write data and trigger events for an user.

First, what is an API? Well, for this section, more information is provided here.

Reading the API

To read The TipeeeStream API endpoints, you need to provide the API Key available in your account.

The endpoints url :

https://api.tipeeestream.com/v1.0/{endpoint}

Authenticating

To post data on TipeeeStream with the API, you need to authenticate your users using OAuth 2.

Read section

Getting real-time events with sockets

TipeeeStream provides events in real time using sockets. You also need your api Key to listen to TipeeeStream events.

Read section