BBC Nitro is the BBC's application programming interface (API) for BBC Programmes Metadata.
Nitro Raw
Get raw brand franchises
Name | Data Type | Description |
---|---|---|
pid
|
string |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Get raw brand
Name | Data Type | Description |
---|---|---|
pid
|
string |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Get raw ancestors
Name | Data Type | Description |
---|---|---|
pid
|
string |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Get raw formats
Name | Data Type | Description |
---|---|---|
pid
|
string |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Get raw genre groups
Name | Data Type | Description |
---|---|---|
pid
|
string |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Get raw episode
Name | Data Type | Description |
---|---|---|
pid
|
string |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Get raw image
Name | Data Type | Description |
---|---|---|
pid
|
string |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Get raw masterbrand
Name | Data Type | Description |
---|---|---|
mbid
|
string |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Get raw promotion
Name | Data Type | Description |
---|---|---|
pid
|
string |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Nitro data feeds
Discover details of on-demand availability for programmes and their versions
Name | Data Type | Description |
---|---|---|
debug
|
boolean |
Turn on debug information (undocumented) |
territory
|
array |
filter for availabilities in given territory |
page_size
|
integer Default value: 10 Maximum: 300 |
number of results in each page |
page
|
integer Default value: 1 Minimum: 1 |
which page of results to return |
media_set
|
array |
filter for subset of availabilities with media set |
descendants_of
|
array |
filter for subset of availabilities that have PID as ancestor |
availability
|
array |
filter for subset of availabilities |
sort_direction
|
string Allowed values: - ascending - descending |
Sort direction |
sort
|
string Allowed values: - scheduled_start |
Sorts:
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Fetch metadata about linear Broadcasts and Services, allowing the generation of Television and Radio schedules and other datasets for broadcast items. Use /schedules instead of this feed as it is more efficient. Broadcasts will be deprecated in the future.
Name | Data Type | Description |
---|---|---|
version
|
array |
filter for subset of broadcasts with given PID as their parent version |
start_to
|
dateTime |
filter for subset of broadcasts that start on or earlier than the specified datetime |
start_from
|
dateTime |
filter for subset of broadcasts that start on or later than the specified datetime |
sid
|
array |
filter for subset of broadcasts that are on the specified linear service |
service_master_brand
|
array |
filter for subset of broadcasts with given service master brand |
schedule_day_to
|
date |
filter for subset of broadcasts that start on or before the specified day (BBC time) |
schedule_day_from
|
date |
filter for subset of broadcasts that start on or after the specified day (BBC time) |
schedule_day
|
date |
filter for subset of broadcasts that start on the specified day (BBC time) |
q
|
string |
filter for subset of broadcasts matching supplied keyword/phrase (boolean operators permitted) |
pid
|
array |
filter for subset of broadcasts having given PID |
people
|
string |
filter for subset of broadcasts that have given contributor |
page_size
|
integer Default value: 10 Maximum: 300 |
number of results in each page |
page
|
integer Default value: 1 Minimum: 1 |
which page of results to return |
item
|
array |
filter for subset of broadcasts with the given item performed on it |
id
|
array |
filter for subset of broadcasts that have given identifier |
genre
|
array |
filter for subset of broadcasts that are classified in the given genre ID |
format
|
array |
filter for subset of broadcasts that are classified in the given format ID |
end_to
|
dateTime |
filter for subset of broadcasts that end on or earlier than the specified datetime |
end_from
|
dateTime |
filter for subset of broadcasts that end on or later than the specified datetime |
descendants_of
|
array |
filter for subset of broadcasts that are descendants of the given programme PID |
authority
|
array |
filter for subset of broadcasts that have given authority |
mixin
|
array |
Mixins:
|
sort_direction
|
string Allowed values: - ascending - descending |
Sort direction |
sort
|
string Allowed values: - start_date |
Sorts:
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Long-lived curated collections of programmes and more, including Collections, Seasons, Franchises and Galleries
Name | Data Type | Description |
---|---|---|
embargoed
|
string Allowed values: - include - exclude - only |
Control return of embargoed items (undocumented) |
q
|
string |
filter for subset of groups matching supplied keyword/phrase (boolean operators permitted) |
pid
|
array |
filter for subset of seasons, collections, galleries or franchises having given PID |
partner_pid
|
array |
filter for groups by partner PID |
partner_id
|
array |
filter for groups by partner ID |
page_size
|
integer Default value: 10 Maximum: 300 |
number of results in each page |
page
|
integer Default value: 1 Minimum: 1 |
which page of results to return |
member
|
string Pattern: ^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$ Minimum: 8 |
filter for subset of groups which contain an entity with the given pid as a member |
group_type
|
array |
filter for subset of groups that have the given group type |
group
|
string Pattern: ^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$ Minimum: 8 |
filter for subset of groups which belong to the given group pid |
for_programme
|
string Pattern: ^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$ Minimum: 8 |
filter for subset of groups directly related to a given programme |
for_descendants_of
|
string Pattern: ^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$ Minimum: 8 |
filter for groups related to given programme or its descendants |
mixin
|
array |
Mixins:
|
sort_direction
|
string Allowed values: - descending |
Sort direction |
sort
|
string Allowed values: - pid |
Sorts:
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Find metadata for images, particularly those in galleries
Name | Data Type | Description |
---|---|---|
embargoed
|
string Allowed values: - include - exclude - only |
Control return of embargoed items (undocumented) |
q
|
string |
filter for subset of images matching supplied keyword/phrase (boolean operators permitted) |
pid
|
array |
filter for subset of images having given PID |
partner_pid
|
array |
filter for images by partner PID |
partner_id
|
array |
filter for images by partner ID |
page_size
|
integer Default value: 10 Maximum: 300 |
number of results in each page |
page
|
integer Default value: 1 Minimum: 1 |
which page of results to return |
is_image_for
|
string Pattern: ^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$ Minimum: 8 |
filter for images by entity PID |
is_alternate_image_for
|
string Pattern: ^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$ Minimum: 8 |
filter for alternate images by entity PID |
image_type
|
array |
filter for images by type |
group
|
string Pattern: ^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$ Minimum: 8 |
filter for images belonging to the given group (i.e. Gallery) |
sort_direction
|
string Allowed values: - ascending - descending |
Sort direction |
sort
|
string Allowed values: - group_position - pid |
Sorts:
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Look inside programmes to find segments: chapters, tracks and more
Name | Data Type | Description |
---|---|---|
segment_event
|
string |
filter for item with the given segment_event |
q
|
string |
filter for subset of items matching supplied keyword/phrase (boolean operators permitted) |
programme
|
string Pattern: ^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$ Minimum: 8 |
filter for subset of items that are part of the given programme |
pid
|
array |
filter for subset of items matching one of the given PIDs |
people
|
string |
filter for subset of items that have specified person involved |
partner_pid
|
array |
filter for items by partner PID |
partner_id
|
array |
filter for items by partner ID |
page_size
|
integer Default value: 10 Maximum: 300 |
number of results in each page |
page
|
integer Default value: 1 Minimum: 1 |
which page of results to return |
item_type
|
array |
filter for specific type(s) of items |
id_type
|
string |
filter for subset of items that have given an ID of the given type |
id
|
array |
filter for subset of items having given ID |
authority
|
string |
filter for subset of items that have an ID issued by the given authority |
mixin
|
array |
Mixins:
|
sort_direction
|
string Allowed values: - descending |
Sort direction |
sort
|
string Allowed values: - pid |
Sorts:
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
List all Master Brands
Name | Data Type | Description |
---|---|---|
q
|
string |
filter for subset of masterbrands matching supplied keyword/phrase (boolean operators permitted) |
partner_pid
|
array |
filter for masterbrands by partner PID |
partner_id
|
array |
filter for masterbrands by partner ID |
page_size
|
integer Default value: 10 Maximum: 300 |
number of results in each page |
page
|
integer Default value: 1 Minimum: 1 |
which page of results to return |
mid
|
array |
filter for subset of masterbrands that have given identifier |
mixin
|
array |
Mixins:
|
sort_direction
|
string Allowed values: - ascending |
Sort direction |
sort
|
string Allowed values: - mid |
Sorts:
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
The 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 finding contributors using external IDs (such as Wikipedia URLs)
Name | Data Type | Description |
---|---|---|
q
|
string |
filter for subset of people matching supplied keyword/phrase (boolean operators permitted) |
programme
|
string |
filter for subset of people that have contributed to the given programme pid |
pid
|
array |
filter for subset of people having given PID |
partner_pid
|
array |
filter for people by partner PID |
partner_id
|
array |
filter for people by partner ID |
page_size
|
integer Default value: 10 Maximum: 300 |
number of results in each page |
page
|
integer Default value: 1 Minimum: 1 |
which page of results to return |
id_type
|
string |
filter for subset of people that have given an ID of the given type |
id
|
array |
filter for subset of people having given ID |
has_external_id
|
array |
filter for people who have an external identifier |
authority
|
string |
filter for subset of people that have an ID issued by the given authority |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Look inside pips entities
Name | Data Type | Description |
---|---|---|
q
|
string |
filter for subset of programmes matching supplied keyword/phrase (boolean operators permitted) |
page_size
|
integer Default value: 10 Maximum: 300 |
number of results in each page |
page
|
integer Default value: 1 Minimum: 1 |
which page of results to return |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Exposes programme information for a single pid
Name | Data Type | Description |
---|---|---|
pid
|
string Pattern: ^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$ Minimum: 8 |
Filter for programme information for the provided PID |
partner_pid
|
string Pattern: ^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$ Minimum: 8 |
Filter for programme information by partner PID |
page_size
|
integer Default value: 10 Maximum: 300 |
number of results in each page |
page
|
integer Default value: 1 Minimum: 1 |
which page of results to return |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Fetch metadata about Programmes (brands, series, episodes, clips). By applying different filter restrictions this feed can be used in many ways, for example to retrieve all series belonging to a brand, all the episodes and/or clips for a specific series, or any TLEO objects for a masterbrand. Other filters permit restricting to specific formats and/or genres, and you can request specific versions (for example Signed or Audio-Described). Parameters may be combined in any way suitable for your application.
Name | Data Type | Description |
---|---|---|
embargoed
|
string Allowed values: - include - exclude - only |
Control return of embargoed items (undocumented) |
version
|
array |
filter for subset of programmes with given PID as one of their versions |
tleo
|
array |
filter for subset of programmes that are TLEOs |
tag_scheme
|
string |
filter for subset of programmes with a tag |
tag_name
|
string |
filter for subset of programmes with tag |
signed
|
array |
filter for subset of programmes that are signed |
q
|
string |
filter for subset of programmes matching supplied keyword/phrase (boolean operators permitted) |
promoted_for
|
string |
filter for subset of programmes which are promoted for given service |
pid
|
array |
filter for subset of programmes having given PID |
people
|
string Pattern: ^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$ Minimum: 8 |
filter for subset of programmes with contributions by given people PID |
payment_type
|
array |
filter for a subset of programmes that are of the given payment_type |
partner_pid
|
array |
filter for programmes by partner PID |
partner_id
|
array |
filter for programmes by partner ID |
page_size
|
integer Default value: 10 Maximum: 300 |
number of results in each page |
page
|
integer Default value: 1 Minimum: 1 |
which page of results to return |
media_type
|
array |
filter for subset of programmes with media type |
media_set
|
string |
filter for subset of programmes with media set |
master_brand
|
array |
filter for subset of programmes with master_brand |
item
|
array |
filter for subset of programmes with linked to versions which have the given item pids |
initial_letter_strict
|
array |
filter for subset of programmes with title beginning with initial letter |
initial_letter_start
|
string Minimum: 1 Maximum: 1 |
Programmes with (librarian) titles whose initial letter is equal/after given letter. Use with initial_letter_end for range. |
initial_letter_end
|
string Minimum: 1 Maximum: 1 |
Programmes with (librarian) titles whose initial letter is equal/before given letter. Use with initial_letter_start for a range |
initial_letter
|
string Minimum: 1 Maximum: 1 |
filter for subset of programmes with title beginning with initial letter librarian style (ignoring leading 'The', 'An' (Welsh), etc) 0-9 a-z |
group
|
string Pattern: ^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$ Minimum: 8 |
filter for subset of programmes which belong to the given group pid |
genre
|
array |
filter for subset of programmes with genre |
format
|
array |
filter for subset of programmes with format |
entity_type
|
array |
filter for subset of programmes that have given entity type |
duration
|
array |
filter for subset of programmes that have given duration |
descendants_of
|
array |
filter for subset of programmes that have PID as ancestor |
children_of
|
array |
filter for subset of programmes that have PID as immediate parent |
availability_type
|
array |
filter for a subset of programmes that are available for a given type |
availability_from
Deprecated |
dateTime |
filter for subset of programmes that are available after or at the specified datetime |
availability_entity_type
|
array |
additional filter when availability=available |
availability
|
array |
filter for subset of programmes that have availability |
audio_described
|
array |
filter for subset of programmes that are audio-described |
mixin
|
array |
Mixins:
|
sort_direction
|
string Allowed values: - ascending - descending |
Sort direction |
sort
|
string Allowed values: - group_position - pid - position - promotion - release_date - relevance - scheduled_start - strict_title - title - tree |
Sorts:
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Details of short-term editorially curated "promotions", for instance those programmes featured on iPlayer today
Name | Data Type | Description |
---|---|---|
status
|
array |
filter for subset of promotions with status |
q
|
string |
filter for subset of promotions matching supplied keyword/phrase (boolean operators permitted) |
promoted_for
|
array |
filter for subset of promotions having given promoted for |
promoted_by
|
array |
filter for subset of promotions having given promoted by |
pid
|
array |
filter for subset of promotions having given PID |
partner_pid
|
array |
filter for promotions by partner PID |
partner_id
|
array |
filter for promotions by partner ID |
page_size
|
integer Default value: 10 Maximum: 300 |
number of results in each page |
page
|
integer Default value: 1 Minimum: 1 |
which page of results to return |
context
|
string Pattern: ^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$ Minimum: 8 |
filter for subset of promotions belonging to a given context |
mixin
|
array |
Mixins:
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Dates, Times, Schedules: when and where are programmes being shown?
Name | Data Type | Description |
---|---|---|
version
|
array |
filter for subset of broadcasts and webcasts with given PID as their parent version |
start_to
|
dateTime |
filter for subset of broadcasts and webcasts that start on or earlier than the specified datetime |
start_from
|
dateTime |
filter for subset of broadcasts and webcasts that start on or later than the specified datetime |
sid
|
array |
filter for subset of broadcasts and webcasts that are on the specified linear service |
service_master_brand
|
array |
filter for subset of broadcasts and webcasts with given service master brand |
schedule_day_to
|
date |
filter for subset of broadcasts and webcasts that start on or before the specified day (BBC time) |
schedule_day_from
|
date |
filter for subset of broadcasts and webcasts that start on or after the specified day (BBC time) |
schedule_day
|
date |
filter for subset of broadcasts and webcasts that start on the specified day (BBC time) |
repeat
|
boolean |
filter to show either only repeats or non-repeats |
q
|
string |
filter for subset of broadcasts and webcasts matching supplied keyword/phrase (boolean operators permitted) |
pid
|
array |
filter for subset of broadcasts and webcasts having given PID |
people
|
string |
filter for subset of broadcasts and webcasts that have given contributor |
partner_pid
|
array |
filter for broadcasts and webcasts by partner PID |
partner_id
|
array |
filter for broadcasts and webcasts by partner ID |
page_size
|
integer Default value: 10 Maximum: 300 |
number of results in each page |
page
|
integer Default value: 1 Minimum: 1 |
which page of results to return |
item
|
array |
filter for subset of broadcasts and webcasts with the given item performed on it |
id_type
|
array |
filter for subset of broadcasts and webcasts that have given id type |
id
|
array |
filter for subset of broadcasts and webcasts that have given identifier |
group
|
string Pattern: ^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$ Minimum: 8 |
filter for subset of broadcasts and webcasts that have programmes in the given group |
genre
|
array |
filter for subset of broadcasts and webcasts that are classified in the given genre ID |
format
|
array |
filter for subset of broadcasts and webcasts that are classified in the given format ID |
end_to
|
dateTime |
filter for subset of broadcasts and webcasts that end on or earlier than the specified datetime |
end_from
|
dateTime |
filter for subset of broadcasts and webcasts that end on or later than the specified datetime |
descendants_of
|
array |
filter for subset of broadcasts and webcasts that are descendants of the given programme PID |
authority
|
array |
filter for subset of broadcasts and webcasts that have given authority |
mixin
|
array |
Mixins:
|
sort_direction
|
string Allowed values: - ascending - descending |
Sort direction |
sort
|
string Allowed values: - start_date |
Sorts:
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
The services feed exposes the linear broadcast "services" from PIPs. These are the actual services which broadcast programmes (eg bbc_one_oxford is the service for BBC One in Oxford).
Name | Data Type | Description |
---|---|---|
start_to
|
dateTime |
Return services that start earlier than the specified datetime |
start_from
|
dateTime |
Return services that start on or later than the specified datetime |
sid
|
array |
filter for specified linear service |
service_type
|
array |
filter for specified type of linear services |
q
|
string |
filter for subset of services matching supplied keyword/phrase (boolean operators permitted) |
partner_pid
|
array |
filter for services by partner PID |
partner_id
|
array |
filter for services by partner ID |
page_size
|
integer Default value: 10 Maximum: 300 |
number of results in each page |
page
|
integer Default value: 1 Minimum: 1 |
which page of results to return |
mid
|
array |
filter for services by masterbrand MID |
end_to
|
dateTime |
filter for subset of broadcasts that end on or earlier than the specified datetime |
end_from
|
dateTime |
Return services that end on or later than the specified datetime |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
The versions feed exposes editorial "Versions" of programmes. These are concepts used to capture different presentations of an overall programme: for example, versions of a programme may include one with sign language, one with audio description, one edited for content and more. Versions are also important to understand for broadcasts: a linear broadcast or an ondemand is always of a specific version, not merely of a programme.
Name | Data Type | Description |
---|---|---|
embargoed
|
string Allowed values: - include - exclude - only |
Control return of embargoed items (undocumented) |
pid
|
array |
filter for subset of versions having given PID |
payment_type
|
array |
filter for a subset of versions that are of the given payment_type |
partner_pid
|
array |
filter for versions by partner PID |
partner_id
|
array |
filter for versions by partner ID |
page_size
|
integer Default value: 10 Maximum: 300 |
number of results in each page |
page
|
integer Default value: 1 Minimum: 1 |
which page of results to return |
media_set
|
array |
filter for subset of versions with availability in the given media set |
descendants_of
|
array |
filter for subset of versions having given programme PID |
availability
|
array |
filter for subset of versions that have availability |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
nitro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Nitro metadata
Get API definition
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Get Schema definition
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
ErrorModel | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
fault
|
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
accurate_programme_time
|
dateRange | |||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
accurate_time
|
broadcastTime | |||||||||||||||||||||||
Properties
Extends
dateRange
Properties
|
Name | Data Type | Description |
---|---|---|
actual_start
|
dateTime |
Name | Data Type | Description |
---|---|---|
advertising_allowed
|
string Pattern: [a-z0-9_]+
|
Name | Data Type | Description |
---|---|---|
filter
|
array [object] |
Name | Data Type | Description |
---|---|---|
alternate_images
|
Name | Data Type | Description |
---|---|---|
series
|
array [object] Maximum: 5 |
|
episode
|
||
brand
|
Name | Data Type | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ancestors
|
reference | ||||||||||||||||||||||||||
Properties
Extends
referenceAttributes
Properties
|
Name | Data Type | Description |
---|---|---|
series
|
array [object] Maximum: 5 |
|
episode
|
||
brand
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status
|
status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
scheduled_time
|
scheduled_time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
revocation_status
|
revocation_status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
media_set
|
array [media_set] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
media_availability_time
|
media_availability_time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
availability_type
|
availability_type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
availability_of
|
array [availability_of] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
availability-debug
|
availability-debug | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
actual_start
|
actual_start | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
accurate_programme_time
|
accurate_programme_time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
territory
|
string | ||||||||||||||||||||||||||||||||||||||||
service
|
serviceReference | ||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||
media_profile_groups
|
media_profile_groups | ||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||
availability_of
|
pidReference | ||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
availability
|
array [object] |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
type
|
string | |||||
result_type
|
string | |||||
pid
|
pid | |||||
|
||||||
href
|
string |
Name | Data Type | Description |
---|---|---|
availability_type
|
Allowed values: - ondemand - simulcast - webcast |
Name | Data Type | Description |
---|---|---|
media_sets
|
Name | Data Type | Description |
---|---|---|
availabilities
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
available_versions_element
|
available_versions_element | ||||||||
Properties
|
|||||||||
available
|
integer |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
available_versions_element
|
available_versions_element | ||||||||
Properties
|
|||||||||
available
|
integer |
Name | Data Type | Description |
---|---|---|
version
|
array [object] |
Name | Data Type | Description |
---|---|---|
media_sets
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
available_versions_element
|
available_versions_element | ||||||||
Properties
|
|||||||||
available
|
integer |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
uri
|
uri | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_time
|
updated_time | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
title
|
title | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
synopses
|
synopses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
release_date_group
|
release_date_group | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
related_links
|
related_links | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
programme_type
|
programme_type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
programme_formats
|
programme_formats | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previous_next_mixin
|
previous_next_mixin | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pid
|
pid | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
partner
|
partner | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
master_brand_link
|
master_brand_link | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items_for
|
items_for | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_embeddable
|
is_embeddable | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
images_mixin
|
images_mixin | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
image_link
|
image_link | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
identifiers
|
identifiers | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
genre_groupings
|
genre_groupings | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
franchises
|
franchises | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expected_child_count
|
expected_child_count | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
embargoed
|
embargoed | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|