Bbci

BBC iPlayer Business Layer

The definitive iPlayer API.

Media & content#openapi#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The definitive iPlayer API.

Endpoints 30

A to Z

  • GETProgrammes by initial title character/atoz/:letter/programmes?rights=web&page=0&per_page=0&initial_child_count=4&sort=title&sort_direction=asc&availability=availableGet the Programmes whose title begins with the given initial character.

Categories

  • GETGet categories/categories?lang=enGet the list of all the categories in TV & iPlayer.
  • GETGet sub-categories/categories/:category?lang=enGet sub-categories

Episodes

  • GETList all the episodes for a category./categories/:category/episodes?lang=en&rights=web&availability=available&page=0&per_page=0&sort=recentGet the list of all the episodes for a given category in TV & iPlayer.
  • GETGet Clips/clips/:pid?rights=web&availability=availableGet Clips
  • GETEpisode for a given pid./episodes/:pid?rights=web&availability=available&mixin=liveGet the episode for a given episode identifier.
  • GETGet Onward Journey/episodes/:pid/next?rights=web&availability=availableGet Onward Journey (next programme)
  • GETGet Follow-ups (post-rolls)/episodes/:pid/postrolls?rights=web&availability=availableGet Follow-ups (post-rolls)
  • GETGet Trailers (pre-rolls)/episodes/:pid/prerolls?rights=web&availability=availableGet Trailers (pre-rolls)
  • GETGet programme recommendations/episodes/:pid/recommendations?rights=web&availability=available&page=0&per_page=0Get programme recommendations
  • GETGet programmes popular/groups/popular/episodes?rights=web&page=0&per_page=0&initial_child_count=4&sort=string&sort_direction=asc&availability=available&mixin=liveGet programmes popular
  • GETGet episodes by group, brand or series/groups/:pid/episodes?rights=web&page=0&per_page=0&initial_child_count=4&sort=string&sort_direction=asc&availability=available&mixin=liveGet episodes by group, brand or series
  • GETChild episodes for a given programme pid./programmes/:pid/episodes?rights=web&availability=available&initial_child_count=4Get the child episodes belonging to a given programme identifier.

Programmes (TLEOs)

  • GETList the highlights for a category./categories/:category/highlights?lang=en&rights=web&availability=available&mixin=liveGet the editorial highlights of a given category in TV & iPlayer.
  • GETList all the programmes for a category./categories/:category/programmes?lang=en&rights=web&availability=available&page=0&per_page=0Get the list of all the Programmes (TLEOs) for a given category in TV & iPlayer.
  • GETGet broadcasts by channel/channels/:channel/broadcasts?lang=en&rights=web&availability=available&mixin=live&per_page=0&from=stringGet broadcasts by channel
  • GETGet programmes by channel/channels/:channel/programmes?lang=en&rights=web&availability=available&page=0&per_page=0Get programmes by channel
  • GETGet programme highlights/home/highlights?lang=en&rights=web&availability=available&mixin=liveGet programme highlights
  • GETProgramme for a given pid./programmes/:pid?rights=web&availability=available&initial_child_count=4Get the programme for a given programme identifier.

Channels

  • GETList all the channels./channels?region=string&lang=enGet the list of all the channels TV & iPlayer.
  • GETList the highlights for a channel./channels/:channel/highlights?lang=en&rights=web&availability=available&live=true&mixin=liveGet the editorial highlights of a given channel in TV & iPlayer.
  • GETGet schedule by channel/channels/:channel/schedule/:date?lang=en&rights=web&availability=availableGet schedule by channel

Regions

  • GETList all regions/regions?lang=enGet the list of all the regions TV & iPlayer.

Metadata

  • GETGet schema/schema/ibl.jsonGet schema
  • GETGet status/statusGet the current iPlayer business layer status. This tells the caller the status of the iPlayer data, but not necessarily the overall status of the website. In…

Search

  • GETSearch/search?q=string&lang=en&rights=web&availability=availableSearch
  • GETSearch-suggest/search-suggest?q=string&lang=en&rights=web&availability=availableSearch-suggest

User

  • GETGet user store purchases/user/purchases?identity_cookie=0.0Get user store purchases
  • GETGet user store recommendations/user/recommendations?identity_cookie=0.0Get user store recommendations
  • GETGet user watching/user/watching?identity_cookie=0.0Get user watching

API details

Base URL
https://ibl.api.bbci.co.uk/ibl/v1
http://ibl.api.bbci.co.uk/ibl/v1
Authentication
An API key in the api_key query parameter
HTTP Basic authentication (username and password)
Operations
30 operations on 30 pathsGET 30
Main resources
Episodes 10Programmes (TLEOs) 6Channels 3User 3Categories 2Metadata 2Search 2A to Z 1Regions 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the BBC iPlayer Business Layer in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the BBC iPlayer Business Layer collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the api_key query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Programmes by initial title character” (GET /atoz/:letter/programmes?rights=web&page=0&per_page=0&initial_child_count=4&sort=title&sort_direction=asc&availability=available), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the BBC iPlayer Business Layer?

The definitive iPlayer API. It is listed under Media & content and has 30 endpoints.

Who publishes the BBC iPlayer Business Layer?

It is listed from Bbci's public API description (an OpenAPI document), not published by Bbci on Swastik Codes. Anyone who controls bbci.co.uk can claim the profile by adding a DNS TXT record.

What is the base URL of the BBC iPlayer Business Layer?

Its description lists 2 base URLs: https://ibl.api.bbci.co.uk/ibl/v1, http://ibl.api.bbci.co.uk/ibl/v1. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the BBC iPlayer Business Layer?

It accepts 2 methods: an API key in the api_key query parameter; HTTP Basic authentication (username and password).

How many endpoints does the BBC iPlayer Business Layer have?

30 operations on 30 paths (30 GET). The largest groups are Episodes, Programmes (TLEOs), Channels, User.

Is forking the BBC iPlayer Business Layer free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.