- Everything is https and json. There are no api keys.
- Rate limit: 60 requests a minute per ip on
doink.tv/api/app/*. Over that you get a429with{"error":"slow down"}. - Errors are
{"error":"..."}with a 4xx or 5xx status. - Fields get added over time. Ignore the ones you do not know.
- The channel reads below can be called from a browser on any site (
access-control-allow-origin: *). The stream endpoints cannot: call them from an app or a server. - Questions, or something you need that is not here: inbox@doink.tv or the discord.
channels
Base: https://doink.tv. A channel's page is https://doink.tv/<handle>.
GET /api/app/browse
Every channel that is live right now, newest first. Cached for 5 seconds.
{
"channels": [
{
"channel_id": "…",
"handle": "philip",
"title": "walking around",
"live_started_at": "2026-11-20 07:15:02",
"viewers": 12,
"thumb": "https://…/thumb/live.webp?b=…",
"offline_media": null
}
]
}
GET /api/app/search?q=<text>
Channels whose handle contains q (first 25 characters used), live ones first, 25 at most. Offline channels are included.
GET /api/app/channel/<handle>
One channel. {"channel": null} if there is no such channel.
{
"channel": {
"channel_id": "…",
"handle": "philip",
"title": "walking around",
"is_live": 1,
"live_started_at": "2026-11-20 07:15:02",
"thumb": "https://…/thumb/live.webp?b=…",
"offline_media": null
}
}
| field | what it is |
|---|---|
handle | the channel's name and its address. People can change it; channel_id does not change. |
is_live | 1 or 0. |
live_started_at | utc, YYYY-MM-DD HH:MM:SS. Null if the channel has never been live. |
viewers | browse only. |
thumb | a recent frame of the live stream, refreshed about once a minute. Null when offline. |
display_name | the same as handle. Kept for old clients; use handle. |
streaming to doink
For encoder and camera apps. A streamer's stream key is on their dashboard and starts with dk_.
| protocol | url |
|---|---|
| srtla | srtla://<region>.ingest.doink.tv:5000?streamid=publish:<key> |
| srt | srt://<region>.ingest.doink.tv:8890?streamid=publish:<key> |
| rtmp | rtmp://<region>.ingest.doink.tv:1935/<key> |
Send h.264 video, constant bitrate, 8000 kbps at most, with a keyframe every 2 seconds. The regions come from the request below.
Treat the stream key like a password. Anyone holding it can stream as that channel, end its stream, and act as the streamer in its chat.
with just the stream key
Base: https://doink.tv. Send the key as Authorization: Bearer dk_….
| request | what it does |
|---|---|
GET /api/app/stream | the channel's handle and where to stream. See below. |
POST /api/app/stream/end | ends the stream now, also when the fallback is keeping it online. {"ok":true}. |
{
"handle": "philip",
"srtlaUrl": "srtla://fr.ingest.doink.tv:5000?streamid=publish:dk_…",
"regions": [
{ "region": "fr", "label": "france", "srtlaUrl": "srtla://fr.ingest.doink.tv:5000?streamid=publish:dk_…" },
{ "region": "us-east", "label": "us, east", "srtlaUrl": "srtla://us-east.ingest.doink.tv:5000?streamid=publish:dk_…" }
]
}
srtlaUrlis the region nearest to whoever makes the request, so make it from the device that will stream.regionsis every region there is, for letting the streamer pick. The list changes as regions are added, so read it instead of hardcoding it.
A wrong key is a 401. Anything else with a stream key is a 403.
with a sign-in
Signed-in apps can also change the title, switch the fallback on and off, rotate the stream key and manage multistream targets. Sign-in is set up per app. If you are building one and want it, email us.