minimusdocs
Help center

Providers

List providers

GET/streams/providers/

read Read: looks, changes nothing. Scopes

Every provider with its status, connections, counts and last sync, a page at a time. Panel operators only.

Query parameters

  • orderingstring

    name, kind, address, status, expires_at, last_sync_at, next_sync_at, sync_every_minutes, linked_streams, gone_links, connections or created_at; - in front for descending.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    Part of the name, address or username.

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
    • idintegerrequiredread-only
    • namestringrequiredread-only
    • kindstringrequiredread-only
    • addressstringrequiredread-only
    • usernamestringrequiredread-only
    • is_enabledbooleanrequiredread-only

      Off: the provider is neither checked nor synced.

    • statusstringrequiredread-only
    • status_detailstringrequiredread-only
    • checked_atstring (date-time)requiredread-onlycan be null
    • connectionsobjectrequiredread-only
      • activeintegerrequiredcan be null

        Connections in use, as the provider said.

      • maxintegerrequiredcan be null

        Connections the line allows.

      • oursintegerrequired

        Connections this panel's servers hold on it now.

    • expires_atstring (date-time)requiredread-onlycan be null
    • expires_knownbooleanrequiredread-only

      Whether expires_at is what the provider said (null: never expires) rather than nothing known: it refused the login, could not be reached, or is an M3U, which says nothing about an expiry.

    • is_trialbooleanrequiredread-only
    • account_created_atstring (date-time)requiredread-onlycan be null
    • countsobjectrequiredread-only
      • liveintegerrequired

        Channels.

      • moviesintegerrequired
      • seriesintegerrequired

        TV shows.

    • sync_every_minutesintegerrequiredread-only
    • last_sync_started_atstring (date-time)requiredread-onlycan be null
    • last_sync_atstring (date-time)requiredread-onlycan be null
    • last_sync_okbooleanrequiredread-onlycan be null
    • last_sync_summaryanyrequiredread-only
    • next_sync_atstring (date-time)requiredread-onlycan be null
    • syncingbooleanrequiredread-only
    • linked_streamsintegerrequiredread-only

      Default: 0

    • gone_linksintegerrequiredread-only

      Default: 0

    • use_livebooleanrequiredread-only

      Its live channels are offered for streams to follow. Off: a provider for its films or TV shows only.

    • import_moviesbooleanrequiredread-only

      After each sync, the provider's new films are added to Films.

    • import_seriesbooleanrequiredread-only

      After each sync, the provider's new shows and episodes are added to TV shows.

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