The Disney Streaming Media Metadata Feed Specification is intended to provide partners of our streaming services the ability to ingest our content metadata catalog.
There is a meta section which provides pagination information to allow consumers to paginate through our catalog. There is then an items section which will contain all the items in our catalog.
Within the array of items, there are 5 top level entities distinguishable by content types movie, episode, event, sport or short-form.
Items with isVod = true are considered OnDemandContent. Items with isVod = false indicates it's LiveContent.
It is worth noting that for partners of our Video on Demand streaming services such as Disney+, there is no notion of live events so that section of the documentation can be ignored.
| Version | Revision Date | Changes |
|---|---|---|
| 0.1 | 2020-01-15 | Initial Spec Created |
| 0.2 | 2020-01-23 | Added seasonSequenceNumber and productionCountry to OnDemandContent. Removed CharacterDetails object. Updated field names in AudioTracks object |
| 0.3 | 2020-02-26 | Updated cardinality for family object |
| 0.4 | 2020-09-10 | Added masterId to the image object |
| 0.5 | 2021-03-10 | Added brands to OnDemandContent, Series, and Season schemas |
| 1.0 | 2021-05-17 | Added seriesType, sportsEvent, isVOD to OnDemandContent and LiveContent schemas. Added seriesType to Series and Season schemas. Updated Availability. Deprecated isOriginal field |
| 1.1 | 2022-05-02 | Moved sport and league to the top level and no longer in the sportEvent object. |
| 2.0 | 2024-03-01 | - Deprecated titleId field and Family object. - Following fields are now optional: releases, genres for Live Content, credits, ratings, episodeSequenceNumber, episodeSeriesSequenceNumber, sport name, league, image format. - License field under Availability is now an optional array and can include content based entitlement tiering. - Changes to deeplinks url format and parameters values. - Changes to Participant to include l10n variants for participant's name and character's name. |
To be used for paginating through the feed and provides additional metadata describing the feed
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| lastModifiedDate | Feed builder date in ISO 8601 Format. Time will be in UTC | Required | String | 2019-12-12T20:23:35Z |
| description | Feed Description | Optional | String | Disney Plus Catalog Feed |
| totalCount | Total number of items in the feed | Required | Number | 9000 |
| pageSize | Number of items in the response | Required | Number | 100 |
| pageNo | Current index of response | Required | Number | 2 |
| nextPageLink | Link to the next page of items. If last page then this field will not be present | Optional | String | https://disney-partner-feeds-prod.bamgrid.com/{partner}/mmfs-catalog/v2?pageNo=2&buildTime=2024-12-03T22:26:11.639-05:00 |
Represents all Video On Demand (VOD) media such as movies, episodes and shorts
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| contentType | Distinguishes episode, movie or short-form | Required | String | movie, episode or short-form |
| itemId | Unique identifier | Required | String | cf59009f-2760-4dda-9d16-830f6dc217cb |
| seasonId | Unique identifier of the season for an episode | Optional | String | 20a9e1d7-127c-4ff8-82c3-5a1f147823f2 |
| seriesId | Unique identifier of the series for an episode | Required when contentType = episode | String | dacs356a-198c-1fea-92c3-5a1f147974a3 |
| isDeleted | Indicates if an item is deleted and thus not playable | Optional | Boolean | true |
| isVOD | Indicates if the content is Live or VOD. Always set to true for OnDemandContent |
Optional | Boolean | true |
| episodeSequenceNumber | The number of the episode within a season | Optional | Number | 5 (s02e05) |
| episodeSeriesSequenceNumber | The number of the episode within the series as a whole | Optional | Number | 15 (s02e05) |
| seasonSequenceNumber | The number of the season within the series | Required. Will be defaulted to 0 if missing | Number | 2 (s02e05) |
| seriesType | Distinguishes different series formats | Optional | String | standard, studio-show, anthology |
| deeplinks | Deep links into the application for this piece of content. Deep linking will link to either playback or detail pages | 1..N | Deeplinks | see Deeplinks |
| texts | All textual metadata associated with an item | 1..N | Text | see Text |
| genres | Subject matter classification of the show. | 0..N | String | ["drama","comedy"] |
| ratings | Rating information | 0..N | Rating | see Rating |
| credits | Specifies the details of the cast and crew | 0..N | Participant | see Participant |
| sportEvent | sport-event details on a game or a match between competitors | Required when contentType = sports | SportEvent | see SportEvent |
| sport | Sport name | 0..N | NameText | see NameText |
| league | The official governing body associated with the sporting event | 0..N | NameText | see NameText |
| images | Artwork for content | 1..N | Image | see Image |
| availability | Media rights that dictate the availability of an item | 1..N | Availability | see Availability |
| alternateIds | Alternate ids associated with the item | 0..N | AlternateId | see AlternateId |
| linkedContent | References to linked content | 0..N | LinkedContent | see LinkedContent |
| subtitles | Array of Subtitle languages | 0..N | String | ["en","fr-FR"] |
| subtitlesForDeaf | Array of Subtitle languages for the deaf | 0..N | String | ["en","fr-FR"] |
| audioTracks | AudioTrack details including features/capabilities, narration languages, and Audio languages | 0..N | AudioTracks | see AudioTrack |
| resolution | The maximum resolution of the Video | Optional | String | HD |
| targetLanguage | IETF language tag indicating the intended target language of this particular edit/variant of the original program | Optional | String | en |
| originalLanguage | IETF language tag indicating the main spoken language of the original production | Optional | String | en |
| productionCountry | Country where this content was produced in ISO-3166 format | Optional | String | US |
| runTimeSeconds | Runtime of the content in seconds | Optional | Number | 7200 |
| releases | Release information of this item | 0..N | Release | see Release |
| labels | Regional labels disclaiming product placements, smoking, graphic content, and more found within the content | 0..N | Label | see Label |
| brands | Brands associated with the title | 0..N | String | ["Disney","Star"] |
| subBrands | Sub-brands associated with the title | 0..N | String | ["ABC"] |
Represents all live events that are scheduled, live or have already aired
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| contentType | Distinguishes episode, movie, event or sporting event | Required | String | movie, episode, event, sports or short-form |
| itemId | Unique identifier | Required | String | cf59009f-2760-4dda-9d16-830f6dc217cb |
| seasonId | Unique identifier of the season for an episode | Optional | String | 20a9e1d7-127c-4ff8-82c3-5a1f147823f2 |
| seriesId | Unique identifier of the series for an episode | Required when contentType = episode | String | dacs356a-198c-1fea-92c3-5a1f147974a3 |
| isDeleted | Indicates if an item is deleted and thus not playable, searchable or displayed | Optional | Boolean | true |
| isVOD | Indicates if the content is Live or VOD. Always set to false for LiveContent |
Optional | Boolean | false |
| episodeSequenceNumber | The number of the episode within a season | Optional | Number | 5 (s02e05) |
| episodeSeriesSequenceNumber | The number of the episode within the series as a whole | Optional | Number | 15 (s02e05) |
| seasonSequenceNumber | The number of the season within the series | Required. Will be defaulted to 0 if missing | Number | 2 (s02e05) |
| seriesType | Distinguishes different series formats | Optional | String | standard, studio-show, anthology |
| deeplinks | Deep links into the application for this piece of content. Deep linking will link to either playback or detail pages | 1..N | Deeplinks | see Deeplinks |
| texts | All textual metadata associated with an item | 1..N | Text | see Text |
| channel | Channel where airing is broadcast | Required for linear content | Channel | see Channel |
| linear | Indicates if an event is part of a linear broadcast | Required | Boolean | true |
| liveBroadcast | Indicates if this event is being broadcast live or if it was prerecorded | Required | Boolean | true |
| genres | Subject matter classification of the show | 0..N | String | ["drama","comedy"] |
| ratings | Rating information | 0..N | Rating | see Rating |
| sportEvent | sport-event details on a game or a match between competitors | Required when contentType = sports | SportEvent | see SportEvent |
| sport | Sport name | 0..N | NameText | see NameText |
| league | The official governing body associated with the sporting event | 0..N | NameText | see NameText |
| images | Artwork for content | 1..N | Image | see Image |
| availability | Media rights that dictate the availability of an item | 1..N | Availability | see Availability |
| alternateIds | Alternate ids associated with the item | 0..N | AlternateId | see AlternateId |
| linkedContent | References to linked content | 0..N | LinkedContent | see LinkedContent |
| subtitles | Array of Subtitle languages | 0..N | String | ["en","fr-FR"] |
| subtitlesForDeaf | Array of Subtitle languages for the deaf | 0..N | String | ["en","fr-FR"] |
| audioTracks | AudioTrack details including features/capabilities, narration languages, and Audio languages | 0..N | AudioTrack | see AudioTrack |
| resolution | The maximum resolution of the Video | Optional | String | HD |
| targetLanguage | IETF language tag indicating the intended target language of the airing | Optional | String | en |
| originalLanguage | IETF language tag indicating the main spoken language of the original production | Optional | String | en |
| productionCountry | Country where this content was produced in ISO-3166 format | Optional | String | US |
| runTimeSeconds | Runtime of the content in seconds, editorialized and intended for display | Optional | Number | 7200 |
| release | Release information of this item | Optional | Release | see Release |
| labels | Regional labels disclaiming product placements, smoking, graphic content, and more found within the content | 0..N | Label | see Label |
| brands | Brands associated with the title | 0..N | String | ["Disney","Star"] |
| subBrands | Sub-brands associated with the title | 0..N | String | ["ESPN"] |
Represents a season that is tied to episodic content
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| contentType | Distinguishes episodes, movies, series, season, etc. Will always be season for this content type | Required | String | season |
| itemId | Unique identifier | Required | String | cf59009f-2760-4dda-9d16-830f6dc217cb |
| seriesId | Unique identifier of the series for a season | Required | String | dacs356a-198c-1fea-92c3-5a1f147974a3 |
| isDeleted | Indicates if an item is deleted and thus should not be searchable or displayed | Optional | Boolean | true |
| seasonNumber | String based representation of the number of the season | Optional | String | s01 |
| seasonSequenceNumber | The number of the season within a series | Required | Number | 1 |
| seriesType | Distinguishes different series formats | Optional | String | standard, studio-show, anthology |
| deeplinks | Deep links into the application for this piece of content. Deep linking will link to either playback or detail pages | 1..N | Deeplinks | see Deeplinks |
| texts | All textual metadata associated with an item | 0..N | Text | see Text |
| genres | Subject matter classification of the show | 0..N | String | ["drama","comedy"] |
| ratings | Rating information | 0..N | Rating | see Rating schema below |
| credits | Specifies the details of the cast and crew | 0..N | Participant | see Participant |
| images | Artwork for content | 0..N | Image | see Image schema below |
| availability | Media rights that dictate the availability of an item | 1..N | Availability | see Availability |
| alternateIds | Alternate ids associated with the item | 0..N | AlternateId | see AlternateId |
| linkedContent | References to linked content | 0..N | LinkedContent | see LinkedContent |
| release | Release information of this item | Optional | Release | see Release |
| brands | Brands associated with the season | 0..N | String | ["Disney","Star"] |
| subBrands | Sub-brands associated with the title | 0..N | String | ["ESPN"] |
Represents a series that is tied to episodic content. All episodes and seasons will have a series associated with it
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| contentType | Distinguishes episodes, movies, series, season, etc. Will always be series for this content type | Required | String | series |
| seriesType | Distinguishes different series formats | Optional | String | standard, studio-show, anthology |
| itemId | Unique identifier | Required | String | cf59009f-2760-4dda-9d16-830f6dc217cb |
| isDeleted | Indicates if an item is deleted and thus should not be searchable or displayed | Optional | Boolean | true |
| deeplinks | Deep links into the application for this piece of content. Deep linking will link to either playback or detail pages | 1..N | Deeplinks | see Deeplinks |
| texts | All textual metadata associated with an item | 1..N | Text | see Text |
| genres | Subject matter classification of the show | 0..N | String | ["drama","comedy"] |
| ratings | Rating information | 0..N | Rating | see Rating schema below |
| credits | Specifies the details of the cast and crew | 0..N | Participant | see Participant |
| images | Artwork for content | 1..N | Image | see Image schema below |
| availability | Media rights that dictate the availability of an item | 1..N | Availability | see Availability |
| alternateIds | Alternate ids associated with the item | 0..N | AlternateId | see AlternateId |
| linkedContent | References to linked content | 0..N | LinkedContent | see LinkedContent |
| release | Release information of this item | Optional | Release | see Release |
| brands | Brands associated with the series | 0..N | String | ["Disney","Star"] |
| subBrands | Sub-brands associated with the title | 0..N | String | ["ESPN"] |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| altId | Alternate Id to the content | Required | String | 184281 |
| altRefType | Type of id | Required | String | radar |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| language | Audio track language | Required | String | en |
| trackType | Audio track type | Optional | String | Audio Description |
| renditionName | Used to describe the audio track | Optional | String | English [Audio Description] |
| features | Features of this audio track | 1..N | String | ["dolby_51","dolby_20"] |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| audienceType | Details on how the audience is applied, this could be a geographical restriction, a platform/device restriction | Optional | AudienceType | see AudienceType |
| action | Specifies if this policy grants or restricts access | Optional | PolicyActionType | see PolicyActionType |
| audienceValues | The value(s) against which the policy will be applied | 0..N | String | US (if audienceType is Region) |
| appears | Specifies the date/time that the associated content will be made available. Time will be in UTC | Optional | String | 2019-11-12T05:00:00Z |
| expires | Specifies the date/time that the associated content will be unavailable. Time will be in UTC | Optional | String | 2020-11-12T05:00:00Z |
| isOriginal | Specifies if this content is an original program for region-based availability | Optional | Boolean | true |
| license | To denote access tiering | Optional | 0..N | premiere-access, pay-per-view, hulu:sub_base, disney_plus_sub:espn_premium |
| tags | Additional information associated with the availability window | 0..N | AvailabilityTag | see AvailabilityTag |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| type | Type of the availability tag | Required | String | brandingRights |
| value | Value of the tag | Required | String | Disney+ Original |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| id | Unique identifier | Required | String | 60c391b4-1658-4330-a682-7f42071d70e9 |
| partnerId | Unique identifier of the user-facing channel for an airing | Required | String | espn_dtc |
| callSign | Call sign for an airing | Required | String | espn_dtc |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| type | Type of deeplink so consumers know possible platforms | Optional | String | universalLink |
| action | Determines whether this deeplink is to playback or detail pages | Required | String | playMedia, details |
| url | The Deeplink URL to the content. This could be a fully qualified URL, a base/partial URL, or a tokenized URL | Required | String | - https://www.disneyplus.com/play/5bfa1910-80b3-4ef5-a213-74b922caebbb - https://www.disneyplus.com/browse/entity-5bfa1910-80b3-4ef5-a213-74b922caebbb |
| params | Parameters that add playback options, or other values that can be used to build out the deeplink | 0..N | DeeplinkParameters | see DeeplinkParameters |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| field | Field name describing the value | Required | String | id, page |
| value | Value to be used when constructing the deeplink | Required | String | - 5bfa1910-80b3-4ef5-a213-74b922caebbb - entity-5bfa1910-80b3-4ef5-a213-74b922caebbb - play - browse |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| gameId | Unique Identifier | Required | String | 186d75c4-33c1-11ea-978f-2e728ce88125 |
| location | Location where game is taking place | Optional | String | Prudential Center |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| url | URL where image can be retrieved | Required | String | https://disney.images.edge.bamgrid.com/ripcut-delivery/v1/disney/disco/general/1bd27e12-37ef-4430-b2ed-5e3b7d9d44d2" |
| aspectRatio | The ratio of the width to the height of the image in decimal format | Required | String | 1.78 |
| masterId | The master ID of the Image | Optional | String | 1bd27e12-37ef-4430-b2ed-5e3b7d9d44d2 |
| type | Indicates the intended use of the image | Optional | String | tile |
| locales | An array of languages for which this image should be displayed | 1..N | String | ["en", "fr-FR"] |
| width | Width of the image | Required | Number | 1920 |
| height | Height of the image | Required | Number | 1080 |
| format | Image format | Optional | String | png |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| region | 2-char ISO country code (or other geographic area) that the label applies to. Global would be 'ZZ' | Required | String | FR |
| value | Descriptors such as product_placement_disclaimer, smoking_disclaimer, display_dub_talent, pse_disclaimer, and graphic_content_disclaimer | Required | String | smoking_disclaimer |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| refId | Reference Id to linked content (UID/itemId (contentId) of the linked content) | Required | String | 186d75c4-33c1-11ea-978f-2e728ce88125 |
| contentType | Content type of Internal linked content | Optional | String | Trailer |
| description | Description of the type of content | Optional | String | Sneak Speak - Trailer |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| names | The participant l10n names, formatted Firstname Lastname | 1..N | NameText | see NameText |
| role | Role in the feature | Required | String | Actor |
| order | Billing order | Optional | Number | 1 |
| characters | L10n names of character played by participant | 1..N | NameText | see NameText |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| value | The rating value | Required | String | PG-13 |
| system | The rating system | Required | String | MPAA |
| advisories | List of advisory codes specific to the rating system | 0..N | String | ["A","V"] |
| description | Non-localized, human-readable description of why content is rated as such | 0..N | String | for sequences of sci-fi action/violence |
| regions | List of 2-char ISO country code (or other geographic areas) | 0..N | String | ["US","FR"] |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| releaseType | Type of release | Optional | String | Original |
| territory | Region/country of release, If this value is absent, the release date can be considered a Global release date | Optional | String | US |
| releaseYear | Year the feature was released | Required | String | 2002 |
| releaseDate | The ISO date of original release. This applies to the version that is being released | Optional | String | 2019-11-12T05:00:00Z |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| teamId | Unique identifier | Required | String | 3222345 |
| teamName | Team name | Optional | String | New York Yankees |
| type | Determines if team is home or away | Optional | TeamType | see TeamType |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| locale | ietf locale code | Required | String | en |
| title | Title of the feature | Required | String | The Incredibles |
| sortTitle | Sortable version of the feature title separated by a comma. Should not be used for display | Optional | String | Incredibles, The |
| shortDescription | The brief title description | Optional | String | A young farm boy intercepts a distress call from the captive Princess Leia. |
| mediumDescription | The medium length title description | Optional | String | Young farm boy Luke Skywalker is thrust into a galaxy of adventure when he intercepts a distress call from the captive Princess Leia. The event launches him on a daring mission to rescue her from the clutches of Darth Vader and the evil Empire. |
| longDescription | The more verbose title description | Optional | String | Luke Skywalker begins a journey that will change the galaxy in Star Wars: Episode IV - A New Hope. Nineteen years after the formation of the Empire, Luke is thrust into the struggle of the Rebel Alliance when he meets Obi-Wan Kenobi, who has lived for years in seclusion on the desert planet of Tatooine. Obi-Wan begins Luke’s Jedi training as Luke joins him on a daring mission to rescue the beautiful Rebel leader Princess Leia from the clutches of Darth Vader and the evil Empire. Contains tobacco depictions. |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| competitors | List of competitors for the event. Competitors could be either teams or players | 0..N | Competitor | see Competitor |
| venue | The location of the event | Optional | Venue | see Venue |
| alternateIds | Alternate ids associated with the event/sport/league/venue such as espn guids | 0..N | AlternateId | see AlternateId |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| competitorType | Specifies the type of competitor | Required | String | team, player |
| homeAway | Home or Away, if applicable | Optional | String | home, away |
| competitor | Team/Player details | 1..N | NameText | see NameText |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| name | Venue name | 1..N | NameText | see NameText |
| city | The city the venue is located in | Optional | String | Lafayette |
| state | The state the venue is located in | Optional | String | Louisiana |
| zipcode | The zip code of the venue | Optional | String | 70506 |
| country | The Country the venue is located in | Optional | String | USA |
| Element | Description | Use | Type | Example |
|---|---|---|---|---|
| locale | ietf locale code | Required | String | en |
| name | Full name | Required | String | Baseball, Major League Baseball, David Ogden Stiers |
| abbreviation | The abbreviation for the name | Optional | String | MLB |
| shortName | Short name of the Team/Sport/League etc. | Optional | String | Baseball |
| Value | Description |
|---|---|
| Region | Policy applies to a country or region designated by a two-letter country codes defined in ISO 3166-1 |
| Zip | Policy applies to a region designated by 5 numerical digits indicating the postal codes used by the US Postal Service (USPS) |
| Authenticated | Per provider/distributor agreed upon scheme |
| CIDR | Policy applies to a Classless Inter-Domain Routing (CIDR) IPV4 address block range. Ref: http://tools.ietf.org/html/rfc4632 |
| Platform | Policy applies to client's device type and/or software platform |
| MVPD | Policy applies to client's MVPD agreement |
| Subscription | Policy applies to a specific subscription package |
| Value | Description |
|---|---|
| Allow | Used when policy is applying whitelist logic |
| Reject | Used when policy is applying blacklist logic |
| Value | Description |
|---|---|
| home | If team is the home team |
| away | If team is the away team |