Streamlabs API

Guides
API Reference
Support

Streamlabs API

Welcome to the Streamlabs API developer hub. You'll find comprehensive guides and documentation to help you start working with Streamlabs API as quickly as possible. Let's jump right in!

Get Started

HomeGuidesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API LogsTutorials

Documentation

Getting Started
OAuth 2
Register your application
Connecting to an account
Submit your application
Obtain an access_token

API Outline

Tiers
Scopes
Pagination
Currency Codes

Examples

Posting donations
Triggering alerts
Socket API
Loyalty Points

Documentation

Getting Started
OAuth 2
Register your application
Connecting to an account
Submit your application
Obtain an access_token

API Outline

Tiers
Scopes
Pagination
Currency Codes

Examples

Posting donations
Triggering alerts
Socket API
Loyalty Points

Streamlabs OBS

API reference
Repository

Authentication

get
/authorize
post
/token

Users

get
/user

Donations

get
/donations
post
/donations

Alerts

post
/alerts
post
/alerts/skip
post
/alerts/mute_volume
post
/alerts/unmute_volume
post
/alerts/pause_queue
post
/alerts/unpause_queue
post
/alerts/send_test_alert
post
/alerts/show_video
post
/alerts/hide_video

Sockets

get
/socket/token

Other

get
/legacy/token

Points

get
/points
post
/points/subtract
post
/points/import
get
/points/group_get_points
post
/points/group_subtract_points
post
/points/add_to_all
get
/points/user_points
post
/points/user_point_edit
post
/points/reset

Alert profiles

get
/alert_profiles/get
post
/alert_profiles/activate

Credits

post
/credits/roll

Jar

post
/jar/empty

Wheel

post
/wheel/spin

Media Share

put
/media-share/play-media
put
/media-share/pause-media
put
/media-share/volume-up
put
/media-share/volume-down
put
/media-share/skip-video
put
/media-share/playback-video
patch
/media-share/enable-requests
patch
/media-share/disable-requests
patch
/media-share/enable-autoshow
patch
/media-share/disable-autoshow
patch
/media-share/enable-autoplay
patch
/media-share/disable-autoplay
patch
/media-share/enable-moderation
patch
/media-share/disable-moderation
patch
/media-share/enable-backup-playlist
patch
/media-share/disable-backup-playlist

Tiers

Tier	maxAttempts	decayMinutes
TESTING	5	1
APPROVED	2400	1
unlimited	unlimited	1

Updated 2 years ago

Tiers

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.