These docs are for v1.0. Click to read the latest docs for v2.0.

Scopes

Each API endpoint has a specific scope for access. This allows you to request only what you need from the user for your application.

Scope

Endpoint

donations.create

POST /donations

donations.read

GET /donations

alerts.create

POST /alerts

legacy.token

GET /legacy/token

socket.token

GET /socket/token

points.read

GET /points

points.write

POST /points/subtract
POST /points/import
POST /points/add_to_all

alerts.write

POST /alerts/skip
POST /alerts/mute_volume
POST /alerts/unmute_volume
POST /alerts/pause_queue
POST /alerts/unpause_queue
POST /alerts/send_test_alert

credits.write

POST /credits/roll

profiles.write

GET /alert_profiles/get
POST /alert_profiles/activate

jar.write

POST /jar/empty

wheel.write

POST /wheel/spin

mediashare.control

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
PUT media-share/enable-requests
PUT media-share/disable-requests
PUT media-share/enable-autoplay
PUT media-share/disable-autoplay
PUT media-share/enable-autoshow
PUT media-share/disable-autoshow
PUT media-share/enable-moderation
PUT media-share/disable-moderation
PUT media-share/enable-backup
PUT media-share/disable-backup