Pending media queue

Video requests waiting to play, oldest first, plus playback state. Requires media:read.

GET/media/queue

Authorization

AuthorizationBearer token (tp_live_...) · headerrequired

A TipPage API key, created in Dashboard → Settings → Developer.

Responses

200Queue state and items.

is_pausedboolean

visibleboolean

Whether the media player is shown on the overlay.

currently_playingboolean

current_order_idstring | null

itemsQueueMediaItem[]

Show properties

Array of QueueMediaItem

order_idstring

donor_namestring

media_urlstring<uri>

media_start_timeinteger

Start offset in seconds.

video_titlestring | null

video_thumbnailstring<uri> | null

video_durationinteger

Duration in seconds (0 = unknown).

platformstring

requested_viastring

tip | chat | admin | channel_point | ...

is_replayboolean

queued_atstring<date-time>

401Missing or invalid API key (`missing_api_key` / `invalid_api_key`).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

403The key lacks the required scope (`missing_scope`).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

required_scopestring

429Rate limit exceeded - check the `RateLimit-*` headers.

errorstring

Request

curl -X GET "https://api.tippage.com/v1/media/queue" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.tippage.com/v1/media/queue", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.tippage.com/v1/media/queue",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "is_paused": true,
  "visible": true,
  "currently_playing": true,
  "current_order_id": "string",
  "items": [
    {
      "order_id": "string",
      "donor_name": "string",
      "media_url": "http://example.com",
      "media_start_time": 0,
      "video_title": "string",
      "video_thumbnail": "http://example.com",
      "video_duration": 0,
      "platform": "youtube",
      "requested_via": "string",
      "is_replay": true,
      "queued_at": "2019-08-24T14:15:22Z"
    }
  ]
}