Методы API

Музыка

Текущий трек музыкального виджета и его скип через API DonateX.

Текущий трек

GEThttps://donatex.gg/api/v1/music/current

Состояние музыкального виджета и первый трек в очереди. Метод всегда отвечает 200 — даже если виджета нет.

Трек попадает в очередь, когда его донат показали на стриме или скипнули через API.

OAuth-токену нужен scope donations.read. External token работает без scopes.

Ответы

isPlayingboolean

Играет ли музыка: трек есть, виджет подключён и не на паузе

hasTrackboolean

Есть ли трек в очереди

widgetConnectedboolean

Открыт ли музыкальный виджет в OBS

isPausedboolean

На паузе ли виджет

widgetIduuid | null

ID музыкального виджета; null, если его нет

donationIduuid | null

ID доната с текущим треком

musicLinkstring | null

Ссылка на текущий трек

Общие для всех методов: 401 — нет токена или он недействителен, 403 — у OAuth-токена нет нужного scope, 429 — превышен лимит запросов. Подробнее об ошибках

GET/v1/music/current

curl "https://donatex.gg/api/v1/music/current" \
  -H "Authorization: Bearer $DONATEX_TOKEN"

{
  "isPlaying": true,
  "hasTrack": true,
  "widgetConnected": true,
  "isPaused": false,
  "widgetId": "e57f0a2a-2b6f-4b5e-b7f0-5a1b51b5ef8a",
  "donationId": "4fd9677b-8b17-4c9d-9a9f-c2a7a3f9960b",
  "musicLink": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
}

Скип трека

POSThttps://donatex.gg/api/v1/music/skip-current

Пропускает текущий трек музыкального виджета и помечает его воспроизведённым.

OAuth-токену нужен scope donations.write. External token работает без scopes.

Ответы

skippedboolean

Удалось ли скипнуть трек

hasTrackboolean

Был ли трек в очереди

widgetIduuid | null

ID музыкального виджета

donationIduuid | null

ID доната скипнутого трека

musicLinkstring | null

Ссылка на скипнутый трек

markedAsPlayedboolean

Удалось ли пометить трек воспроизведённым. Есть только при skipped: true

Общие для всех методов: 401 — нет токена или он недействителен, 403 — у OAuth-токена нет нужного scope, 429 — превышен лимит запросов. Подробнее об ошибках

POST/v1/music/skip-current

curl -X POST "https://donatex.gg/api/v1/music/skip-current" \
  -H "Authorization: Bearer $DONATEX_TOKEN"

{
  "skipped": true,
  "hasTrack": true,
  "widgetId": "e57f0a2a-2b6f-4b5e-b7f0-5a1b51b5ef8a",
  "donationId": "4fd9677b-8b17-4c9d-9a9f-c2a7a3f9960b",
  "musicLink": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
  "markedAsPlayed": true
}

Назад

Топ донатеров

Дальше

Профиль