TV guide

List guide channels

GET/epg/channels/

read Read: looks, changes nothing. Scopes

The channels the guide holds, a page at a time (25 by default), the closest names first when searching. Accounts that may add or change streams.

Query parameters

  • countrystring

    A country code, such as UK.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    Part of the name, guide id or another name.

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
    • idstringrequiredread-only
    • namestringrequiredread-only
    • iconstring (uri)requiredread-only
    • countriesstring[]requiredread-only
    • has_guidebooleanrequiredread-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