Skip to content

Latest commit

 

History

History
602 lines (402 loc) · 64.1 KB

README.md

File metadata and controls

602 lines (402 loc) · 64.1 KB

Feeds

(feeds)

Overview

Nitro data feeds

Available Operations

  • listAvailability - Discover details of on-demand availability for programmes and their versions
  • listBroadcasts - Build schedules and find metadata for TV and radio broadcasts
  • listGroups - Find metadata for curated groups: seasons, collections, galleries or franchises
  • listImages - Find metadata for images
  • listItems - Look inside programmes to find segments: chapters, tracks and more
  • listMasterbrands - List all Master Brands
  • listPeople - Find the people behind and in programmes: cast, crew, guests and more
  • listPips - Look inside pips entities
  • getProgramme - Exposes programme information for a single pid
  • listProgrammes - Start here for programmes metadata: Brands, Series, Episodes and Clips
  • listPromotions - Discover metadata for content promotions
  • listSchedules - Build schedules and find metadata for TV and radio broadcasts and webcasts
  • listServices - Information about the linear services used for broadcast transmissions
  • listVersions - Metadata on editorial programme versions: original, signed, audio-described, etc

listAvailability

Discover details of on-demand availability for programmes and their versions

Example Usage

import { Bbc } from "github.com/speakeasy-sdks/bbc-typescript";

const bbc = new Bbc({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await bbc.feeds.listAvailability({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description
request operations.ListAvailabilityRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.ListAvailabilityResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

listBroadcasts

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.

Example Usage

import { Bbc } from "github.com/speakeasy-sdks/bbc-typescript";

const bbc = new Bbc({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await bbc.feeds.listBroadcasts({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description
request operations.ListBroadcastsRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.ListBroadcastsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

listGroups

Long-lived curated collections of programmes and more, including Collections, Seasons, Franchises and Galleries

Example Usage

import { Bbc } from "github.com/speakeasy-sdks/bbc-typescript";

const bbc = new Bbc({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await bbc.feeds.listGroups({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description
request operations.ListGroupsRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.ListGroupsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

listImages

Find metadata for images, particularly those in galleries

Example Usage

import { Bbc } from "github.com/speakeasy-sdks/bbc-typescript";

const bbc = new Bbc({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await bbc.feeds.listImages({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description
request operations.ListImagesRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.ListImagesResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

listItems

Look inside programmes to find segments: chapters, tracks and more

Example Usage

import { Bbc } from "github.com/speakeasy-sdks/bbc-typescript";

const bbc = new Bbc({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await bbc.feeds.listItems({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description
request operations.ListItemsRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.ListItemsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

listMasterbrands

List all Master Brands

Example Usage

import { Bbc } from "github.com/speakeasy-sdks/bbc-typescript";

const bbc = new Bbc({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await bbc.feeds.listMasterbrands({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description
request operations.ListMasterbrandsRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.ListMasterbrandsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

listPeople

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)

Example Usage

import { Bbc } from "github.com/speakeasy-sdks/bbc-typescript";

const bbc = new Bbc({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await bbc.feeds.listPeople({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description
request operations.ListPeopleRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.ListPeopleResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

listPips

Look inside pips entities

Example Usage

import { Bbc } from "github.com/speakeasy-sdks/bbc-typescript";

const bbc = new Bbc({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await bbc.feeds.listPips(1, 10, "<value>");

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description
page number ➖ which page of results to return
pageSize number ➖ number of results in each page
q string ➖ filter for subset of programmes matching supplied keyword/phrase (boolean operators permitted)
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.ListPipsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

getProgramme

Exposes programme information for a single pid

Example Usage

import { Bbc } from "github.com/speakeasy-sdks/bbc-typescript";

const bbc = new Bbc({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await bbc.feeds.getProgramme(1, 10, "<value>", "<value>");

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description
page number ➖ which page of results to return
pageSize number ➖ number of results in each page
partnerPid string ➖ Filter for programme information by partner PID
pid string ➖ Filter for programme information for the provided PID
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.ListProgrammeDetailsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

listProgrammes

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.

Example Usage

import { Bbc } from "github.com/speakeasy-sdks/bbc-typescript";

const bbc = new Bbc({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await bbc.feeds.listProgrammes({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description
request operations.ListProgrammesRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.ListProgrammesResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

listPromotions

Details of short-term editorially curated "promotions", for instance those programmes featured on iPlayer today

Example Usage

import { Bbc } from "github.com/speakeasy-sdks/bbc-typescript";

const bbc = new Bbc({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await bbc.feeds.listPromotions({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description
request operations.ListPromotionsRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.ListPromotionsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

listSchedules

Dates, Times, Schedules: when and where are programmes being shown?

Example Usage

import { Bbc } from "github.com/speakeasy-sdks/bbc-typescript";

const bbc = new Bbc({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await bbc.feeds.listSchedules({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description
request operations.ListSchedulesRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.ListSchedulesResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

listServices

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).

Example Usage

import { Bbc } from "github.com/speakeasy-sdks/bbc-typescript";

const bbc = new Bbc({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await bbc.feeds.listServices({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description
request operations.ListServicesRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.ListServicesResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

listVersions

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.

Example Usage

import { Bbc } from "github.com/speakeasy-sdks/bbc-typescript";

const bbc = new Bbc({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await bbc.feeds.listVersions({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description
request operations.ListVersionsRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.ListVersionsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /