minimusdocs
Help center

Sources

List sources

GET/streams/sources/

read Read: looks, changes nothing. Scopes

Sources a page at a time (page, page_size up to 200), newest first. An account that does not see the whole catalogue gets only the sources it created.

Query parameters

  • healthstring

    How the servers last found it.

    One of: "down" "online" "unknown"

  • is_activeboolean

    Only turned-on (true) or turned-off (false) sources.

  • orderingstring

    Which field to use when ordering the results.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    Part of the name or the address.

  • unusedboolean

    Only sources no stream reads from.

Response

200 OK

  • countintegerrequired

    How many there are in all, on every page.

  • nextstring (uri)can be null

    The next page, or null on the last one.

  • previousstring (uri)can be null

    The page before, or null on the first one.

  • resultsobject[]required
    • idstring (uuid)requiredread-only
    • namestringrequired
    • urlstring (uri)required
    • is_activeboolean
    • qualitystringcan be null

      e.g., 720p, 1080p, 4K

    • bitrateintegercan be null

      Bitrate in kbps

    • healthstringrequiredread-only

      How the servers last found it: online while a server plays from it, down after one failed to, unknown until a server has tried.

    • health_atstring (date-time)requiredread-onlycan be null

      When a server last said how it found it.

    • probed_video_codecstringrequiredread-only

      e.g. h264, hevc. Empty until a server has read the source.

    • probed_audio_codecstringrequiredread-only
    • probed_fpsnumberrequiredread-onlycan be null

      Null when the source declares a variable or unknown rate.

    • probed_widthintegerrequiredread-onlycan be null
    • probed_heightintegerrequiredread-onlycan be null
    • probed_audio_tracksintegerrequiredread-onlycan be null

      Number of audio streams — language alternatives.

    • probed_atstring (date-time)requiredread-onlycan be null

      When a server last read these, as a stream started on it.

    • streams_countintegerrequiredread-only

      How many streams read from it.

    • created_bystring (uuid)requiredread-onlycan be null
    • created_by_usernamestringrequiredread-only
    • created_atstring (date-time)requiredread-only
    • updated_atstring (date-time)requiredread-only

Errors

  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means