BBC Nitro API
BBC Nitro is the BBC's application programming interface (API) for BBC Programmes Metadata.
Media & content#openapi#media#open-data
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
BBC Nitro is the BBC's application programming interface (API) for BBC Programmes Metadata.
Endpoints 25
feeds
- GETDiscover details of on-demand availability for programmes and their versions
/availabilities?sort=scheduled_start&sort_direction=ascending&availability=available&descendants_of=string&media_set=string&page=1&page_size=10&territory=uk&debug=trueDiscover details of on-demand availability for programmes and their versions - GETBuild schedules and find metadata for TV and radio broadcasts
/broadcasts?sort=start_date&sort_direction=ascending&mixin=titles&authority=string&descendants_of=string&end_from=2024-01-01T00:00:00Z&end_to=2024-01-01T00:00:00Z&format=string&genre=string&id=string&item=string&page=1&page_size=10&people=string&pid=string&q=string&schedule_day=2024-01-01&schedule_day_from=2024-01-01&schedule_day_to=2024-01-01&service_master_brand=string&sid=string&start_from=2024-01-01T00:00:00Z&start_to=2024-01-01T00:00:00Z&version=stringFetch metadata about linear Broadcasts and Services, allowing the generation of Television and Radio schedules and other datasets for broadcast items. Use… - GETFind metadata for curated groups: seasons, collections, galleries or franchises
/groups?sort=pid&sort_direction=descending&mixin=alternate_images&for_descendants_of=string&for_programme=string&group=string&group_type=collection&member=string&page=1&page_size=10&partner_id=string&partner_pid=s0000001&pid=string&q=string&embargoed=includeLong-lived curated collections of programmes and more, including Collections, Seasons, Franchises and Galleries - GETFind metadata for images
/images?sort=group_position&sort_direction=ascending&group=string&image_type=standard&is_alternate_image_for=string&is_image_for=string&page=1&page_size=10&partner_id=string&partner_pid=s0000001&pid=string&q=string&embargoed=includeFind metadata for images, particularly those in galleries - GETLook inside programmes to find segments: chapters, tracks and more
/items?sort=pid&sort_direction=descending&mixin=contributions&authority=string&id=string&id_type=string&item_type=chapter&page=1&page_size=10&partner_id=string&partner_pid=s0000001&people=string&pid=string&programme=string&q=string&segment_event=stringLook inside programmes to find segments: chapters, tracks and more - GETList all Master Brands
/master_brands?sort=mid&sort_direction=ascending&mixin=images&mid=string&page=1&page_size=10&partner_id=string&partner_pid=s0000001&q=stringList all Master Brands - GETFind the people behind and in programmes: cast, crew, guests and more
/people?authority=string&has_external_id=true&id=string&id_type=string&page=1&page_size=10&partner_id=string&partner_pid=s0000001&pid=string&programme=string&q=stringThe People feed allows you to search for the people and groups that contribute to programmes. This is the starting point for cast and crew credits, as well as… - GETLook inside pips entities
/pips?page=1&page_size=10&q=stringLook inside pips entities - GETExposes programme information for a single pid
/programme_details?page=1&page_size=10&partner_pid=string&pid=stringExposes programme information for a single pid - GETStart here for programmes metadata: Brands, Series, Episodes and Clips
/programmes?sort=group_position&sort_direction=ascending&mixin=alternate_images&audio_described=true&availability=available&availability_entity_type=episode&availability_from=2024-01-01T00:00:00Z&availability_type=ondemand&children_of=string&descendants_of=string&duration=short&entity_type=brand&format=string&genre=string&group=string&initial_letter=string&initial_letter_end=string&initial_letter_start=string&initial_letter_strict=string&item=string&master_brand=string&media_set=string&media_type=audio&page=1&page_size=10&partner_id=string&partner_pid=s0000001&payment_type=free&people=string&pid=string&promoted_for=string&q=string&signed=exclusive&tag_name=string&tag_scheme=string&tleo=true&version=string&embargoed=includeFetch metadata about Programmes (brands, series, episodes, clips). By applying different filter restrictions this feed can be used in many ways, for example… - GETDiscover metadata for content promotions
/promotions?mixin=related_links&context=string&page=1&page_size=10&partner_id=string&partner_pid=s0000001&pid=string&promoted_by=string&promoted_for=string&q=string&status=currentDetails of short-term editorially curated "promotions", for instance those programmes featured on iPlayer today - GETBuild schedules and find metadata for TV and radio broadcasts and webcasts
/schedules?sort=start_date&sort_direction=ascending&mixin=ancestor_titles&authority=string&descendants_of=string&end_from=2024-01-01T00:00:00Z&end_to=2024-01-01T00:00:00Z&format=string&genre=string&group=string&id=string&id_type=string&item=string&page=1&page_size=10&partner_id=string&partner_pid=s0000001&people=string&pid=string&q=string&repeat=true&schedule_day=2024-01-01&schedule_day_from=2024-01-01&schedule_day_to=2024-01-01&service_master_brand=string&sid=string&start_from=2024-01-01T00:00:00Z&start_to=2024-01-01T00:00:00Z&version=stringDates, Times, Schedules: when and where are programmes being shown? - GETInformation about the linear services used for broadcast transmissions
/services?end_from=2024-01-01T00:00:00Z&end_to=2024-01-01T00:00:00Z&mid=string&page=1&page_size=10&partner_id=string&partner_pid=s0000001&q=string&service_type=Interactive&sid=string&start_from=2024-01-01T00:00:00Z&start_to=2024-01-01T00:00:00ZThe services feed exposes the linear broadcast "services" from PIPs. These are the actual services which broadcast programmes (eg bbc_one_oxford is the… - GETMetadata on editorial programme versions: original, signed, audio-described, etc
/versions?availability=available&descendants_of=string&media_set=string&page=1&page_size=10&partner_id=string&partner_pid=s0000001&payment_type=free&pid=string&embargoed=includeThe versions feed exposes editorial "Versions" of programmes. These are concepts used to capture different presentations of an overall programme: for example,…
schema
- GETGet API definition
/Get API definition - GETGet Schema definition
/schemaGet Schema definition
Raw
- GETGet raw brand
/v1/brands/:pidGet raw brand - GETGet raw brand franchise
/v1/brands/:pid/franchises/Get raw brand franchises - GETGet raw episode
/v1/episodes/:pidGet raw episode - GETGet raw ancestors
/v1/episodes/:pid/ancestors/Get raw ancestors - GETGet raw formats
/v1/episodes/:pid/formats/Get raw formats - GETGet raw genre groups
/v1/episodes/:pid/genre_groups/Get raw genre groups - GETGet raw image
/v1/images/:pidGet raw image - GETGet raw masterbrand
/v1/master_brands/:mbidGet raw masterbrand - GETGet raw promotion
/v1/promotions/:pidGet raw promotion
API details
- Base URL
https://programmes.api.bbc.com- Authentication
- An API key in the api_key query parameter
- Operations
- 25 operations on 25 pathsGET 25
- Main resources
- feeds 14Raw 9schema 2
- Response formats
application/jsonapplication/xml- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the BBC Nitro API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the BBC Nitro API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Discover details of on-demand availability for programmes and their versions” (GET /availabilities?sort=scheduled_start&sort_direction=ascending&availability=available&descendants_of=string&media_set=string&page=1&page_size=10&territory=uk&debug=true), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the BBC Nitro API?
BBC Nitro is the BBC's application programming interface (API) for BBC Programmes Metadata. It is listed under Media & content and has 25 endpoints.
Who publishes the BBC Nitro API?
It is listed from BBC's public API description (an OpenAPI document), not published by BBC on Swastik Codes. Anyone who controls bbc.co.uk can claim the profile by adding a DNS TXT record.
What is the base URL of the BBC Nitro API?
Requests go to https://programmes.api.bbc.com. Endpoint paths are added to this base URL.
How do I authenticate with the BBC Nitro API?
With an API key in the api_key query parameter.
How many endpoints does the BBC Nitro API have?
25 operations on 25 paths (25 GET). The largest groups are feeds, Raw, schema.
Is forking the BBC Nitro API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.