EDS - Entertainment Discovery Services¶

EDS (Entertainment Discovery Services)

Used for searching the Xbox Live Marketplace

class xbox.webapi.api.provider.eds.EDSProvider(client)¶

Bases: xbox.webapi.api.provider.baseprovider.BaseProvider

EDS_URL = 'https://eds.xboxlive.com'¶

HEADERS_EDS = {'Accept': 'application/json', 'Cache-Control': 'no-cache', 'Pragma': 'no-cache', 'x-xbl-client-type': 'Companion', 'x-xbl-client-version': '2.0', 'x-xbl-contract-version': '3.2', 'x-xbl-device-type': 'WindowsPhone', 'x-xbl-isautomated-client': 'true'}¶

SEPERATOR = '.'¶

get_appchannel_channel_list(lineup_id)¶

Get AppChannel channel list

Parameters:	lineup_id (str) – Lineup ID
Returns:	HTTP Response
Return type:	`requests.Response`

get_appchannel_schedule(lineup_id, start_time, end_time, max_items, skip_items)¶

Get AppChannel schedule / EPG

Parameters:	lineup_id (str) – Lineup ID start_time (str) – Start time (format: 2016-07-11T21:50:00.000Z) end_time (str) – End time (format: 2016-07-11T21:50:00.000Z) max_items (int) – Maximum number of items skip_items (int) – Count of items to skip
Returns:	HTTP Response
Return type:	`requests.Response`

get_browse_query(order_by, desired, **kwargs)¶

Get a browse query

Parameters:	order_by (str/`OrderBy`) – Fieldname to use for sorting the result desired (str/list) – Desired Media Item Types, members of (`MediaItemType`) **kwargs – Additional query parameters

Returns:

get_recommendations(desired, **kwargs)¶

Get recommended content suggestions

Parameters:	desired (str/list) – Desired Media Item Types, members of (`MediaItemType`) **kwargs – Additional query parameters
Returns:	HTTP Response
Return type:	`requests.Response`

get_related(id, desired, **kwargs)¶

Get related content for a specific Id

Parameters:	id (str) – Id of original content to get related content for desired (str/list) – Desired Media Item Types, members of (`MediaItemType`) **kwargs – Additional query parameters
Returns:	HTTP Response
Return type:	`requests.Response`

get_fields(desired, **kwargs)¶

Get Fields

Parameters:	desired (str) – Desired **kwargs – Additional query parameters
Returns:	HTTP Response
Return type:	`requests.Response`

get_details(ids, mediagroup, **kwargs)¶

Get details for a list of IDs in a specific media group

Parameters:	ids (str/list) – List of ids to get details for mediagroup (str) – Member of `MediaGroup` **kwargs – Additional query parameters
Returns:	HTTP Response
Return type:	`requests.Response`

get_crossmediagroup_search(search_query, max_items, **kwargs)¶

Do a crossmedia-group search (search for content for multiple devices)

Parameters:	search_query (str) – Query string max_items (int) – Maximum itemcount **kwargs – Additional query parameters
Returns:	HTTP Response
Return type:	`requests.Response`

get_singlemediagroup_search(search_query, max_items, media_item_types, **kwargs)¶

Do a singlemedia-group search

Parameters:	search_query (str) – Query string max_items (int) – Maximum itemcount media_item_types (str/list) – Desired Media Item Types, members of (`MediaItemType`) **kwargs – Additional query parameters
Returns:	HTTP Response
Return type:	`requests.Response`

class xbox.webapi.api.provider.eds.MediaItemType¶

Bases: xbox.webapi.common.enum.StrEnum

Media Item Type, used as parameter for EDS API

XBOX360_GAME = 'Xbox360Game'¶

XBOX360_GAME_CONTENT = 'Xbox360GameContent'¶

XBOX360_GAME_DEMO = 'Xbox360GameDemo'¶

XBOX_GAME_TRIAL = 'XboxGameTrial'¶

XBOX_THEME = 'XboxTheme'¶

XBOX_ORIGINAL_GAME = 'XboxOriginalGame'¶

XBOX_GAMER_TILE = 'XboxGamerTile'¶

XBOX_ARCADE_GAME = 'XboxArcadeGame'¶

XBOX_GAME_CONSUMABLE = 'XboxGameConsumable'¶

XBOX_GAME_VIDEO = 'XboxGameVideo'¶

XBOX_GAME_TRAILER = 'XboxGameTrailer'¶

XBOX_BUNDLE = 'XboxBundle'¶

XBOX_XNA_GAME = 'XboxXnaCommunityGame'¶

XBOX_MARKETPLACE = 'XboxMarketplace'¶

XBOX_APP = 'XboxApp'¶

XBOXONE_GAME = 'DGame'¶

XBOXONE_GAME_DEMO = 'DGameDemo'¶

XBOXONE_CONSUMABLE = 'DConsumable'¶

XBOXONE_DURABLE = 'DDurable'¶

XBOXONE_APP = 'DApp'¶

XBOXONE_ACTIVITY = 'DActivity'¶

XBOXONE_NATIVE_APP = 'DNativeApp'¶

METRO_GAME = 'MetroGame'¶

METRO_GAME_CONTENT = 'MetroGameContent'¶

METRO_GAME_CONSUMABLE = 'MetroGameConsumable'¶

AVATAR_ITEM = 'AvatarItem'¶

MOBILE_GAME = 'MobileGame'¶

XBOX_MOBILE_PDLC = 'XboxMobilePDLC'¶

XBOX_MOBILE_CONSUMABLE = 'XboxMobileConsumable'¶

TV_SHOW = 'TVShow'¶

TV_EPISODE = 'TVEpisode'¶

TV_SERIES = 'TVSeries'¶

TV_SEASON = 'TVSeason'¶

MUSIC_ALBUM = 'Album'¶

MUSIC_TRACK = 'Track'¶

MUSIC_VIDEO = 'MusicVideo'¶

MUSIC_ARTIST = 'MusicArtist'¶

WEB_GAME = 'WebGame'¶

WEB_VIDEO = 'WebVideo'¶

WEB_VIDEO_COLLECTION = 'WebVideoCollection'¶

GAME_LAYER = 'GameLayer'¶

GAME_ACTIVITY = 'GameActivity'¶

APP_ACTIVITY = 'AppActivity'¶

VIDEO_LAYER = 'VideoLayer'¶

VIDEO_ACTIVITY = 'VideoActivity'¶

SUBSCRIPTION = 'Subscription'¶

class xbox.webapi.api.provider.eds.MediaGroup¶

Bases: xbox.webapi.common.enum.StrEnum

Media Group, used as parameter for EDS API

GameType: Xbox360Game, XboxGameTrial, Xbox360GameContent, Xbox360GameDemo, XboxTheme, XboxOriginalGame, XboxGamerTile, XboxArcadeGame, XboxGameConsumable, XboxGameVideo, XboxGameTrailer, XboxBundle, XboxXnaCommunityGame, XboxMarketplace, AvatarItem, MobileGame, XboxMobilePDLC, XboxMobileConsumable, WebGame, MetroGame, MetroGameContent, MetroGameConsumable, DGame, DGameDemo, DConsumable, DDurable

AppType: XboxApp, DApp MovieType: Movie TVType: TVShow (one-off TV shows), TVEpisode, TVSeries, TVSeason MusicType: Album, Track, MusicVideo MusicArtistType: MusicArtist WebVideoType: WebVideo, WebVideoCollection EnhancedContentType: GameLayer, GameActivity, AppActivity, VideoLayer, VideoActivity, DActivity, DNativeApp SubscriptionType: Subscription

GAME_TYPE = 'GameType'¶

APP_TYPE = 'AppType'¶

MOVIE_TYPE = 'MovieType'¶

TV_TYPE = 'TVType'¶

MUSIC_TYPE = 'MusicType'¶

MUSIC_ARTIST_TYPE = 'MusicArtistType'¶

WEB_VIDEO_TYPE = 'WebVideoType'¶

ENHANCED_CONTENT_TYPE = 'EnhancedContentType'¶

SUBSCRIPTION_TYPE = 'SubscriptionType'¶

class xbox.webapi.api.provider.eds.ScheduleDetailsField¶

Bases: xbox.webapi.common.enum.StrEnum

Schedule Details Field, used as parameter for EDS API

NAME = 'Name'¶

ID = 'Id'¶

IMAGES = 'Images'¶

DESCRIPTION = 'Description'¶

PARENTAL_RATING = 'ParentalRating'¶

PARENT_SERIES = 'ParentSeries'¶

SCHEDULE_INFO = 'ScheduleInformation'¶

class xbox.webapi.api.provider.eds.Domain¶

Bases: xbox.webapi.common.enum.StrEnum

Domain, used as parameter for EDS API

XBOX_360 = 'Xbox360'¶

XBOX_ONE = 'Modern'¶

class xbox.webapi.api.provider.eds.IdType¶

Bases: xbox.webapi.common.enum.StrEnum

ID Type, used as parameter for EDS API

CANONICAL = 'Canonical'¶

XBOX_HEX_TITLE = 'XboxHexTitle'¶

SCOPED_MEDIA_ID = 'ScopedMediaId'¶

ZUNE_CATALOG = 'ZuneCatalog'¶

ZUNE_MEDIA_INSTANCE = 'ZuneMediaInstance'¶

AMG = 'AMG'¶

MEDIA_NET = 'MediaNet'¶

PROVIDER_CONTENT_ID = 'ProviderContentId'¶

class xbox.webapi.api.provider.eds.ClientType¶

Bases: xbox.webapi.common.enum.StrEnum

Client Type, used as parameter for EDS API

C13 = 'C13'¶

COMMERCIAL_SERVICE = 'CommercialService'¶

COMPANION = 'Companion'¶

CONSOLE = 'Console'¶

EDITORIAL = 'Editorial'¶

FIRST_PARTY_APP = '1stPartyApp'¶

MO_LIVE = 'MoLive'¶

WINDOWS_PHONE_7 = 'PhoneROM'¶

RECOMMENDATION_SERVICE = 'RecommendationService'¶

SAS = 'SAS'¶

SDS = 'SDS'¶

SUBSCRIPTION_SERVICE = 'SubscriptionService'¶

X8 = 'X8'¶

X13 = 'X13'¶

WEBBLEND = 'Webblend'¶

XBOX_COM = 'XboxCom'¶

class xbox.webapi.api.provider.eds.DeviceType¶

Bases: xbox.webapi.common.enum.StrEnum

Device Type, used as parameter for EDS API

XBOX360 = 'Xbox360'¶

XBOXONE = 'XboxDurango'¶

XBOX = 'Xbox'¶

IOS = 'iOS'¶

IPHONE = 'iPhone'¶

IPAD = 'iPad'¶

ANDROID = 'Android'¶

ANDROID_PHONE = 'AndroidPhone'¶

ANDROID_SLATE = 'AndroidSlate'¶

WIN_PC = 'WindowsPC'¶

WIN_PHONE = 'WindowsPhone'¶

SERVICE = 'Service'¶

WEB = 'Web'¶

class xbox.webapi.api.provider.eds.OrderBy¶

Bases: xbox.webapi.common.enum.StrEnum

The orderBy parameter determines how the items being returned should be sorted

PLAY_COUNT_DAILY = 'PlayCountDaily'¶

FREE_AND_PAID_COUNT_DAILY = 'FreeAndPaidCountDaily'¶

PAID_COUNT_ALL_TIME = 'PaidCountAllTime'¶

PAID_COUNT_DAILY = 'PaidCountDaily'¶

DIGITAL_RELEASE_DATE = 'DigitalReleaseDate'¶

RELEASE_DATE = 'ReleaseDate'¶

USER_RATINGS = 'UserRatings'¶

class xbox.webapi.api.provider.eds.SubscriptionLevel¶

Bases: xbox.webapi.common.enum.StrEnum

The subscriptionLevel parameter determines the type of subscription the user has

GOLD = 'gold'¶

SILVER = 'silver'¶