FAST catalog Specification¶
Specification¶
Field | Type | Description | Required |
---|---|---|---|
channel |
Channel[] |
Yes | |
metadata |
Metadata[] |
Yes |
Channel
type¶
Field | Type | Description | Required |
---|---|---|---|
countries |
string[] |
List of countries where the FAST channel is available at. | Yes |
descriptions |
Description[] |
Localized descriptions of the channel. | |
genre |
string[] |
Channel genre list. | Yes |
id |
string |
Uniquely identifies the channel. Immutable value. | Yes |
images |
ChannelImage[] |
||
monetization_type |
enum |
It is always ads . |
Yes |
order |
number |
Channel order on the lineup. | Yes |
titles |
Title[] |
For channels, we only include the US version of the title. |
Yes |
url |
string |
Public page URL that forwards to channel playback. | Yes |
ChannelImage
type¶
Field | Type | Description | Required |
---|---|---|---|
height |
number |
Height in pixels | |
language |
string |
Image language in ISO 639-1 format. Can be undefined if the language is neutral. | |
type |
enum |
Can either be clearLogo or art (horizontal) |
Yes |
url |
string |
URL to the image resource | Yes |
width |
number |
Width in pixels |
Metadata
type¶
Field | Type | Description | Required |
---|---|---|---|
availabilities |
Availability[] |
Airings information for this metadata. Includes airings across several channels. | Yes |
credits |
Credit[] |
Cast and crew. | |
descriptions |
Description[] |
Localized summaries of the content. | |
external_ids |
ExternalID[] |
External IDs that the partner may choose to be shared with to better match content. | |
genre |
string[] |
Genre list. | |
id |
string |
Uniquely identifies the content. Immutable value. | Yes |
images |
Image[] |
||
ratings |
Rating[] |
List of ratings by rating systems. | |
release_date |
string |
Date in ISO 8601 format (only date segment) | Yes |
runtime |
number |
Duration of the content, in minutes. | |
series_info |
SeriesInfo |
This field is populated when the metadata belongs to a season or episode . |
|
titles |
Title[] |
Localized titles of the content. | Yes |
type |
enum |
Type of the metadata object. Can either be movie , show , season or episode . |
Yes |
Availability
type¶
Field | Type | Description | Required |
---|---|---|---|
available_ending |
string |
Date in ISO 8601 format (including time). | Yes |
available_starting |
string |
Date in ISO 8601 format (including time). | Yes |
channel_id |
string |
ID of the channel this airing belongs to. | Yes |
delivery_method |
enum |
Always live for FAST catalogs. |
Yes |
monetization_type |
enum |
It is always ads . |
Yes |
Credit
type¶
Field | Type | Description | Required |
---|---|---|---|
person_image |
string |
URL to the person's image | |
person_name |
string |
Yes | |
role |
string |
Role that the person performs in the title. | |
type |
enum |
Can either be actor or director . |
Yes |
Description
type¶
Field | Type | Description | Required |
---|---|---|---|
country |
string |
Country of the description, in ISO 3166-1 alpha-2 code. | Yes |
description |
string |
Description of the content in the language specified in language field. |
Yes |
language |
string |
Description language in ISO 639-1 format. This can be undefined. | Yes |
ExternalID type¶
Field | Type | Description | Required |
---|---|---|---|
id |
string |
Identifier of the content according to the source specified in type . |
Yes |
type |
string |
Source of the identifier. Can either be gracenote , imdb or tmdb . |
Yes |
Image
type¶
Field | Type | Description | Required |
---|---|---|---|
height |
number |
Height in pixels | |
language |
string |
Image language in ISO 639-1 format. Can be undefined if the language is neutral. | |
type |
enum |
Can either be coverPoster (vertical) or coverArt (horizontal) |
Yes |
url |
string |
URL to the image resource | Yes |
width |
number |
Width in pixels |
Rating
type¶
Field | Type | Description | Required |
---|---|---|---|
country |
string |
Country of the rating, in ISO 3166-1 alpha-2 code. | Yes |
rating |
string |
Rating value. | Yes |
rating_body |
string |
Code of the rating system. For instance, for US this value is MPAA . |
Yes |
SeriesInfo
type¶
Field | Type | Description | Required |
---|---|---|---|
episode_number |
number |
Episode order. This field is only defined on a season . |
|
number_of_episodes |
number |
Number of episodes in a season. This field is only defined on a season and episode . |
|
season_id |
string |
ID of the season an episode belongs to. |
|
season_number |
number |
Season order. This field is only defined on a season . |
|
show_id |
string |
ID of the show an episode or season belongs to. |
Yes for season and episode |
Title
type¶
Field | Type | Description | Required |
---|---|---|---|
country |
string |
Country of the title, in ISO 3166-1 alpha-2 code. | Yes |
language |
string |
Title language in ISO 639-1 format. This can be undefined. | |
title |
string |
Title of the content in the language specified in language field. |
Yes |
Examples¶
Channel example¶
- The channel only works in Great Britain.
- This URL takes directly to the playback page.
Metadata example¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
|
- Airings can come from multiple channels for this specific movie, as we can see in this example.