xbox-webapi documentation
TRANSCRIPT
![Page 1: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/1.jpg)
Xbox-WebAPI DocumentationRelease 2.0.11
OpenXbox
Jun 13, 2021
![Page 2: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/2.jpg)
![Page 3: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/3.jpg)
Contents:
1 Authentication Manager - Authenticate with MS / XBL 1
2 Xbox Live Client - HTTP Client wrapper 3
3 Xbox Live language definitions 5
4 Xbox Live Providers - API Endpoints 74.1 Submodules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74.2 Module contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
5 Indices and tables 25
Python Module Index 27
Index 29
i
![Page 4: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/4.jpg)
ii
![Page 5: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/5.jpg)
CHAPTER 1
Authentication Manager - Authenticate with MS / XBL
Authentication Manager
Authenticate with Windows Live Server and Xbox Live.
class xbox.webapi.authentication.manager.AuthenticationManager(client_session:aio-http.client.ClientSession,client_id: str,client_secret:str, redirect_uri:str, scopes: Op-tional[List[str]]= None)
Bases: object
generate_authorization_url(state: Optional[str] = None)→ strGenerate Windows Live Authorization URL.
_oauth2_token_request(data: dict)→ xbox.webapi.authentication.models.OAuth2TokenResponseExecute token requests.
get_title_endpoints()→ xbox.webapi.authentication.models.TitleEndpointsResponse
refresh_oauth_token()→ xbox.webapi.authentication.models.OAuth2TokenResponseRefresh OAuth2 token.
refresh_tokens()→ NoneRefresh all tokens.
request_oauth_token(authorization_code: str)→ xbox.webapi.authentication.models.OAuth2TokenResponseRequest OAuth2 token.
request_tokens(authorization_code: str)→ NoneRequest all tokens.
request_user_token(relying_party: str = ’http://auth.xboxlive.com’, use_compact_ticket: bool =False)→ xbox.webapi.authentication.models.XAUResponse
Authenticate via access token and receive user token.
1
![Page 6: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/6.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
request_xsts_token(relying_party: str = ’http://xboxlive.com’) →xbox.webapi.authentication.models.XSTSResponse
Authorize via user token and receive final X token.
2 Chapter 1. Authentication Manager - Authenticate with MS / XBL
![Page 7: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/7.jpg)
CHAPTER 2
Xbox Live Client - HTTP Client wrapper
Xbox Live Client
Basic factory that stores XboxLiveLanguage, User authorization data and available Providers
class xbox.webapi.api.client.Session(auth_mgr: xbox.webapi.authentication.manager.AuthenticationManager)Bases: object
delete(url: str, **kwargs)→ aiohttp.client_reqrep.ClientResponse
get(url: str, **kwargs)→ aiohttp.client_reqrep.ClientResponse
head(url: str, **kwargs)→ aiohttp.client_reqrep.ClientResponse
options(url: str, **kwargs)→ aiohttp.client_reqrep.ClientResponse
patch(url: str, **kwargs)→ aiohttp.client_reqrep.ClientResponse
post(url: str, **kwargs)→ aiohttp.client_reqrep.ClientResponse
put(url: str, **kwargs)→ aiohttp.client_reqrep.ClientResponse
request(method: str, url: str, include_auth: bool = True, include_cv: bool = True, **kwargs) →aiohttp.client_reqrep.ClientResponse
Proxy Request and add Auth/CV headers.
class xbox.webapi.api.client.XboxLiveClient(auth_mgr: xbox.webapi.authentication.manager.AuthenticationManager,language: xbox.webapi.api.language.XboxLiveLanguage= <xbox.webapi.api.language.XboxLiveLanguageobject>)
Bases: object
xuidGets the Xbox User ID
Returns: Xbox user Id
languageGets the active Xbox Live Language
Returns: Active Xbox Live language
3
![Page 8: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/8.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
4 Chapter 2. Xbox Live Client - HTTP Client wrapper
![Page 9: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/9.jpg)
CHAPTER 3
Xbox Live language definitions
Language definitions
class xbox.webapi.api.language.XboxLiveLanguage(name, short_id, identifier, locale)Bases: object
__init__(name, short_id, identifier, locale)Initialize a new instance of XboxLiveLanguage
Parameters
• name (str) – Full name describing the language / country
• short_id (str) – Short Id (e.g. “AT” for Austria)
• identifier (str) – Identifier (e.g. “de_AT” for Austria)
• locale (str) – Locale (e.g. “de-AT” for Austria)
class xbox.webapi.api.language.DefaultXboxLiveLanguagesBases: object
Collection of locales compatible with XBL
Argentina = <xbox.webapi.api.language.XboxLiveLanguage object>
Australia = <xbox.webapi.api.language.XboxLiveLanguage object>
Austria = <xbox.webapi.api.language.XboxLiveLanguage object>
Belgium = <xbox.webapi.api.language.XboxLiveLanguage object>
Belgium_NL = <xbox.webapi.api.language.XboxLiveLanguage object>
Brazil = <xbox.webapi.api.language.XboxLiveLanguage object>
Canada = <xbox.webapi.api.language.XboxLiveLanguage object>
Canada_FR = <xbox.webapi.api.language.XboxLiveLanguage object>
Czech_Republic = <xbox.webapi.api.language.XboxLiveLanguage object>
Denmark = <xbox.webapi.api.language.XboxLiveLanguage object>
5
![Page 10: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/10.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
Finland = <xbox.webapi.api.language.XboxLiveLanguage object>
France = <xbox.webapi.api.language.XboxLiveLanguage object>
Germany = <xbox.webapi.api.language.XboxLiveLanguage object>
Greece = <xbox.webapi.api.language.XboxLiveLanguage object>
Hong_Kong = <xbox.webapi.api.language.XboxLiveLanguage object>
Hungary = <xbox.webapi.api.language.XboxLiveLanguage object>
India = <xbox.webapi.api.language.XboxLiveLanguage object>
Great_Britain = <xbox.webapi.api.language.XboxLiveLanguage object>
Israel = <xbox.webapi.api.language.XboxLiveLanguage object>
Italy = <xbox.webapi.api.language.XboxLiveLanguage object>
Japan = <xbox.webapi.api.language.XboxLiveLanguage object>
Mexico = <xbox.webapi.api.language.XboxLiveLanguage object>
Chile = <xbox.webapi.api.language.XboxLiveLanguage object>
Colombia = <xbox.webapi.api.language.XboxLiveLanguage object>
Netherlands = <xbox.webapi.api.language.XboxLiveLanguage object>
New_Zealand = <xbox.webapi.api.language.XboxLiveLanguage object>
Norway = <xbox.webapi.api.language.XboxLiveLanguage object>
Poland = <xbox.webapi.api.language.XboxLiveLanguage object>
Portugal = <xbox.webapi.api.language.XboxLiveLanguage object>
Russia = <xbox.webapi.api.language.XboxLiveLanguage object>
Saudi_Arabia = <xbox.webapi.api.language.XboxLiveLanguage object>
Singapore = <xbox.webapi.api.language.XboxLiveLanguage object>
Slovakia = <xbox.webapi.api.language.XboxLiveLanguage object>
South_Africa = <xbox.webapi.api.language.XboxLiveLanguage object>
Korea = <xbox.webapi.api.language.XboxLiveLanguage object>
Spain = <xbox.webapi.api.language.XboxLiveLanguage object>
Switzerland = <xbox.webapi.api.language.XboxLiveLanguage object>
Switzerland_FR = <xbox.webapi.api.language.XboxLiveLanguage object>
United_Arab_Emirates = <xbox.webapi.api.language.XboxLiveLanguage object>
United_States = <xbox.webapi.api.language.XboxLiveLanguage object>
Ireland = <xbox.webapi.api.language.XboxLiveLanguage object>
6 Chapter 3. Xbox Live language definitions
![Page 11: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/11.jpg)
CHAPTER 4
Xbox Live Providers - API Endpoints
4.1 Submodules
4.1.1 Acccount - Change your Gamertag
class xbox.webapi.api.provider.account.AccountProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
BASE_URL_USER_MGT = 'https://user.mgt.xboxlive.com'
BASE_URL_ACCOUNT = 'https://accounts.xboxlive.com'
HEADERS_USER_MGT = {'x-xbl-contract-version': '1'}
HEADERS_ACCOUNT = {'x-xbl-contract-version': '2'}
change_gamertag(xuid, gamertag, preview=False, **kwargs) →xbox.webapi.api.provider.account.models.ChangeGamertagResult
Change your gamertag.
XLE error codes: 200 - success 1020 - No free gamertag changes available
Parameters
• xuid (int) – Your Xuid as integer
• gamertag (str) – Desired gamertag name
• preview (bool) – Preview the change
Returns: ChangeGamertagResult
claim_gamertag(xuid, gamertag, **kwargs)→ xbox.webapi.api.provider.account.models.ClaimGamertagResultClaim gamertag
XLE error codes: 400 - Bad API request 401 - Unauthorized 409 - Gamertag unavailable 429 - Too manyrequests 200 - Gamertag available
7
![Page 12: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/12.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
Parameters
• xuid (int) – Your xuid as integer
• gamertag (str) – Desired gamertag
Returns: ClaimGamertagResult
4.1.2 Catalog - Microsoft Store Catalog
Store Catalog - Lookup Product Information
class xbox.webapi.api.provider.catalog.CatalogProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
CATALOG_URL = 'https://displaycatalog.mp.microsoft.com'
SEPERATOR = ','
get_product_from_alternate_id(id: str, id_type: xbox.webapi.api.provider.catalog.models.AlternateIdType,fields: xbox.webapi.api.provider.catalog.models.FieldsTemplate= <FieldsTemplate.DETAILS: ’de-tails’>, top: int = 25, **kwargs) →xbox.webapi.api.provider.catalog.models.CatalogResponse
Lookup product by Alternate ID.
get_products(big_ids: List[str], fields: xbox.webapi.api.provider.catalog.models.FieldsTemplate= <FieldsTemplate.DETAILS: ’details’>, **kwargs) →xbox.webapi.api.provider.catalog.models.CatalogResponse
Lookup product by Big IDs.
product_search(query: str, platform: xbox.webapi.api.provider.catalog.models.PlatformType= <PlatformType.XBOX: ’windows.xbox’>, top: int = 5, **kwargs) →xbox.webapi.api.provider.catalog.models.CatalogSearchResponse
Search for products by name.
4.1.3 CQS - Stump TV Streaming
CQS
Used for download stump (TV Streaming) data (RemoteTVInput ServiceChannel on Smartglass)
class xbox.webapi.api.provider.cqs.CQSProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
CQS_URL = 'https://cqs.xboxlive.com'
HEADERS_CQS = {'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': '1.b', 'x-xbl-device-type': 'WindowsPhone', 'x-xbl-isautomated-client': 'true'}
get_channel_list(locale_info: str, headend_id: str, **kwargs) →xbox.webapi.api.provider.cqs.models.CqsChannelListResponse
Get stump channel list
Parameters
• locale_info – Locale string (format: “en-US”)
• headend_id – Headend id
Returns Channel List Response
Return type CqsChannelListResponse
8 Chapter 4. Xbox Live Providers - API Endpoints
![Page 13: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/13.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
get_schedule(locale_info: str, headend_id: str, start_date: str, duration_minutes:int, channel_skip: int, channel_count: int, **kwargs) →xbox.webapi.api.provider.cqs.models.CqsScheduleResponse
Get stump epg data
Parameters
• locale_info – Locale string (format: “en-US”)
• headend_id – Headend id
• start_date – Start date (format: 2016-07-11T21:50:00.000Z)
• duration_minutes – Schedule duration to download
• channel_skip – Count of channels to skip
• channel_count – Count of channels to get data for
Returns Schedule Response
Return type CqsScheduleResponse
4.1.4 EPLists - Manage Xbox Live Pins
EPLists - Mainly used for XBL Pins
class xbox.webapi.api.provider.lists.ListsProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
LISTS_URL = 'https://eplists.xboxlive.com'
HEADERS_LISTS = {'Content-Type': 'application/json', 'x-xbl-contract-version': '2'}
SEPERATOR = '.'
get_items(xuid: str, listname: str = ’XBLPins’, **kwargs) →xbox.webapi.api.provider.lists.models.ListsResponse
Get items from specific list, defaults to “XBLPins”
Parameters
• xuid (str/int) – Xbox User Id
• listname (str) – Name of list to edit
Returns List Response
Return type ListsResponse
insert_items(xuid: str, post_body: dict, listname: str = ’XBLPins’, **kwargs) →xbox.webapi.api.provider.lists.models.ListMetadata
Insert items to specific list, defaults to “XBLPins”
Parameters
• xuid (str/int) – Xbox User Id
• listname (str) – Name of list to edit
Returns List Metadata Response
Return type ListMetadata
remove_items(xuid: str, post_body: dict, listname: str = ’XBLPins’, **kwargs) →xbox.webapi.api.provider.lists.models.ListMetadata
Remove items from specific list, defaults to “XBLPins”
4.1. Submodules 9
![Page 14: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/14.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
Parameters
• xuid (str/int) – Xbox User Id
• listname (str) – Name of list to edit
Returns List Metadata Response
Return type ListMetadata
4.1.5 Profile - Get Userprofile information
Profile
Get Userprofiles by XUID or Gamertag
class xbox.webapi.api.provider.profile.ProfileProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
PROFILE_URL = 'https://profile.xboxlive.com'
HEADERS_PROFILE = {'x-xbl-contract-version': '3'}
SEPARATOR = ','
get_profile_by_gamertag(gamertag: str, **kwargs)→ xbox.webapi.api.provider.profile.models.ProfileResponseGet Userprofile by gamertag
Parameters gamertag – Gamertag to get profile for
Returns Profile Response
Return type ProfileResponse
get_profile_by_xuid(target_xuid: str, **kwargs)→ xbox.webapi.api.provider.profile.models.ProfileResponseGet Userprofile by xuid
Parameters target_xuid – XUID to get profile for
Returns Profile Response
Return type ProfileResponse
get_profiles(xuid_list: List[str], **kwargs)→ xbox.webapi.api.provider.profile.models.ProfileResponseGet profile info for list of xuids
Parameters xuid_list (list) – List of xuids
Returns Profile Response
Return type ProfileResponse
4.1.6 Achievements - Get info about gameprogress
Achievements
Get Xbox 360 and Xbox One Achievement data
class xbox.webapi.api.provider.achievements.AchievementsProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
ACHIEVEMENTS_URL = 'https://achievements.xboxlive.com'
HEADERS_GAME_360_PROGRESS = {'x-xbl-contract-version': '1'}
10 Chapter 4. Xbox Live Providers - API Endpoints
![Page 15: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/15.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
HEADERS_GAME_PROGRESS = {'x-xbl-contract-version': '2'}
get_achievements_detail_item(xuid, service_config_id, achievement_id, **kwargs) →xbox.webapi.api.provider.achievements.models.AchievementResponse
Get achievement detail for specific item
Parameters
• xuid (str) – Xbox User Id
• service_config_id (str) – Service Config Id
• achievement_id (str) – Achievement Id
Returns Achievement Response
Return type AchievementResponse
get_achievements_xbox360_all(xuid, title_id, **kwargs) →xbox.webapi.api.provider.achievements.models.Achievement360Response
Get all achievements for specific X360 title Id
Parameters
• xuid (str) – Xbox User Id
• title_id (str) – Xbox 360 Title Id
Returns Achievement 360 Response
Return type Achievement360Response
get_achievements_xbox360_earned(xuid, title_id, **kwargs) →xbox.webapi.api.provider.achievements.models.Achievement360Response
Get earned achievements for specific X360 title id
Parameters
• xuid (str) – Xbox User Id
• title_id (str) – Xbox 360 Title Id
Returns Achievement 360 Response
Return type Achievement360Response
get_achievements_xbox360_recent_progress_and_info(xuid, **kwargs) →xbox.webapi.api.provider.achievements.models.Achievement360ProgressResponse
Get recent achievement progress and information
Parameters xuid (str) – Xbox User Id
Returns Achievement 360 Response
Return type Achievement360Response
get_achievements_xboxone_gameprogress(xuid, title_id, **kwargs) →xbox.webapi.api.provider.achievements.models.AchievementResponse
Get gameprogress for Xbox One title
Parameters
• xuid (str) – Xbox User Id
• title_id (str) – Xbox One Title Id
Returns Achievement Response
Return type AchievementResponse
4.1. Submodules 11
![Page 16: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/16.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
get_achievements_xboxone_recent_progress_and_info(xuid, **kwargs) →xbox.webapi.api.provider.achievements.models.RecentProgressResponse
Get recent achievement progress and information
Parameters xuid (str) – Xbox User Id
Returns Recent Progress Response
Return type RecentProgressResponse
4.1.7 Usersearch - Search users / gamertags
Usersearch - Search for gamertags / userprofiles
class xbox.webapi.api.provider.usersearch.UserSearchProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
USERSEARCH_URL = 'https://usersearch.xboxlive.com'
HEADERS_USER_SEARCH = {'x-xbl-contract-version': '1'}
get_live_search(query: str, **kwargs)→ xbox.webapi.api.provider.usersearch.models.UserSearchResponseGet userprofiles for search query
Parameters query – Search query
Returns User Search Response
Return type UserSearchResponse
4.1.8 Gameclips - Own, from Community, by XUID
Gameclips - Get gameclip info
class xbox.webapi.api.provider.gameclips.GameclipProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
GAMECLIPS_METADATA_URL = 'https://gameclipsmetadata.xboxlive.com'
HEADERS_GAMECLIPS_METADATA = {'x-xbl-contract-version': '1'}
get_recent_clips_by_xuid(xuid: str, title_id: str = None, skip_items:int = 0, max_items: int = 25, **kwargs) →xbox.webapi.api.provider.gameclips.models.GameclipsResponse
Get clips by XUID, optionally filter for title Id
Parameters
• xuid – XUID of user to get clips from
• title_id – Optional title id filter
• skip_items – Item count to skip
• max_items – Maximum item count to load
Returns Game clip Response
Return type GameclipsResponse
get_recent_community_clips_by_title_id(title_id: str, **kwargs) →xbox.webapi.api.provider.gameclips.models.GameclipsResponse
Get recent community clips by Title Id
12 Chapter 4. Xbox Live Providers - API Endpoints
![Page 17: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/17.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
Parameters title_id – Title Id to get clips for
Returns Game clip Response
Return type GameclipsResponse
get_recent_own_clips(title_id: str = None, skip_items: int = 0, max_items: int = 25, **kwargs)→ xbox.webapi.api.provider.gameclips.models.GameclipsResponse
Get own recent clips, optionally filter for title Id
Parameters
• title_id – Title ID to filter
• skip_items – Item count to skip
• max_items – Maximum item count to load
Returns Game clip Response
Return type GameclipsResponse
get_saved_clips_by_xuid(xuid: str, title_id: str = None, skip_items:int = 0, max_items: int = 25, **kwargs) →xbox.webapi.api.provider.gameclips.models.GameclipsResponse
Get saved clips by XUID, optionally filter for title Id
Parameters
• xuid – XUID of user to get screenshots from
• title_id – Optional title id filter
• skip_items – Item count to skip
• max_items – Maximum item count to load
Returns Game clip Response
Return type GameclipsResponse
get_saved_community_clips_by_title_id(title_id: str, **kwargs) →xbox.webapi.api.provider.gameclips.models.GameclipsResponse
Get saved community clips by Title Id
Parameters title_id – Title Id to get screenshots for
Returns Game clip Response
Return type GameclipsResponse
get_saved_own_clips(title_id: str = None, skip_items: int = 0, max_items: int = 25, **kwargs)→ xbox.webapi.api.provider.gameclips.models.GameclipsResponse
Get own saved clips, optionally filter for title Id an
Parameters
• title_id – Optional Title ID to filter
• skip_items – Item count to skip
• max_items – Maximum item count to load
Returns Game clip Response
Return type GameclipsResponse
4.1. Submodules 13
![Page 18: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/18.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
4.1.9 People - Get friendlist info
People - Access friendlist from own profiles and others
class xbox.webapi.api.provider.people.PeopleProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
SOCIAL_URL = 'https://social.xboxlive.com'
HEADERS_SOCIAL = {'x-xbl-contract-version': '2'}
PEOPLE_URL = 'https://peoplehub.xboxlive.com'
HEADERS_PEOPLE = {'Accept-Language': 'overwrite in __init__', 'x-xbl-contract-version': '3'}
SEPERATOR = ','
__init__(client)Initialize Baseclass, set ‘Accept-Language’ header from client instance
Parameters client (XboxLiveClient) – Instance of client
get_friend_recommendations(**kwargs)→ xbox.webapi.api.provider.people.models.PeopleResponseGet recommended friends
Returns People Response
Return type PeopleResponse
get_friends_by_xuid(xuid: str, decoration_fields: List[xbox.webapi.api.provider.people.models.PeopleDecoration]= None, **kwargs)→ xbox.webapi.api.provider.people.models.PeopleResponse
Get friendlist of own profile
Returns People Response
Return type PeopleResponse
get_friends_own(decoration_fields: List[xbox.webapi.api.provider.people.models.PeopleDecoration]= None, **kwargs)→ xbox.webapi.api.provider.people.models.PeopleResponse
Get friendlist of own profile
Returns People Response
Return type PeopleResponse
get_friends_own_batch(xuids: List[str], decoration_fields: List[xbox.webapi.api.provider.people.models.PeopleDecoration]= None, **kwargs)→ xbox.webapi.api.provider.people.models.PeopleResponse
Get friends metadata by providing a list of XUIDs
Parameters xuids – List of XUIDs
Returns People Response
Return type PeopleResponse
get_friends_summary_by_gamertag(gamertag: str, **kwargs) →xbox.webapi.api.provider.people.models.PeopleSummaryResponse
Get friendlist summary of user by gamertag
Parameters gamertag – Gamertag to request friendlist from
Returns People Summary Response
Return type PeopleSummaryResponse
get_friends_summary_by_xuid(xuid: str, **kwargs)→ xbox.webapi.api.provider.people.models.PeopleSummaryResponseGet friendlist summary of user by xuid
14 Chapter 4. Xbox Live Providers - API Endpoints
![Page 19: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/19.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
Parameters xuid – XUID to request summary from
Returns People Summary Response
Return type PeopleSummaryResponse
get_friends_summary_own(**kwargs)→ xbox.webapi.api.provider.people.models.PeopleSummaryResponseGet friendlist summary of own profile
Returns People Summary Response
Return type PeopleSummaryResponse
4.1.10 Presence - Get online status of friends
Presence - Get online status of friends
class xbox.webapi.api.provider.presence.PresenceProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
PRESENCE_URL = 'https://userpresence.xboxlive.com'
HEADERS_PRESENCE = {'Accept': 'application/json', 'x-xbl-contract-version': '3'}
get_presence(xuid, presence_level: xbox.webapi.api.provider.presence.models.PresenceLevel= <PresenceLevel.USER: ’user’>, **kwargs) →xbox.webapi.api.provider.presence.models.PresenceItem
Get presence for given xuid
Parameters
• xuid – XUID
• presence_level – Filter level
Returns Presence Response
Return type PresenceItem
get_presence_batch(xuids: List[str], online_only: bool = False, pres-ence_level: xbox.webapi.api.provider.presence.models.PresenceLevel= <PresenceLevel.USER: ’user’>, **kwargs) →List[xbox.webapi.api.provider.presence.models.PresenceItem]
Get presence for list of xuids
Parameters
• xuids – List of XUIDs
• online_only – Only get online profiles
• presence_level – Filter level
Returns: List[PresenceItem]: List of presence items
get_presence_own(presence_level: xbox.webapi.api.provider.presence.models.PresenceLevel= <PresenceLevel.ALL: ’all’>, **kwargs) →xbox.webapi.api.provider.presence.models.PresenceItem
Get presence of own profile
Parameters presence_level – Filter level
Returns Presence Response
Return type PresenceItem
4.1. Submodules 15
![Page 20: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/20.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
4.1.11 Message - Read and send messages
Message - Read and send messages
TODO: Support group messaging
class xbox.webapi.api.provider.message.MessageProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
MSG_URL = 'https://xblmessaging.xboxlive.com'
HEADERS_MESSAGE = {'x-xbl-contract-version': '1'}
HEADERS_HORIZON = {'x-xbl-contract-version': '2'}
delete_conversation(conversation_id: str, horizon: str, **kwargs)→ boolDelete message
NOTE: Returns HTTP Status Code 200 on success
Parameters
• conversation_id – Message Id
• horizon – Delete horizon from get conversation response
Returns: True on success, False otherwise
delete_message(conversation_id: str, message_id: str, **kwargs)→ boolDelete message
NOTE: Returns HTTP Status Code 200 on success
Parameters
• conversation_id – Conversation Id
• message_id – Message Id
Returns: True on success, False otherwise
get_conversation(xuid: str, max_items: int = 100, **kwargs) →xbox.webapi.api.provider.message.models.ConversationResponse
Get detailed conversation info
Parameters xuid – Xuid of user having a conversation with
Returns Conversation Response
Return type ConversationResponse
get_inbox(**kwargs)→ xbox.webapi.api.provider.message.models.InboxResponseGet messages
Returns Inbox Response
Return type InboxResponse
send_message(xuid: str, message_text: str, **kwargs) →xbox.webapi.api.provider.message.models.SendMessageResponse
Send message to an xuid
Parameters
• xuid – Xuid
• message_text – Message text
Returns Send Message Response
16 Chapter 4. Xbox Live Providers - API Endpoints
![Page 21: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/21.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
Return type SendMessageResponse
4.1.12 Userstats - Get game statistics
Userstats - Get game statistics
class xbox.webapi.api.provider.userstats.UserStatsProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
USERSTATS_URL = 'https://userstats.xboxlive.com'
HEADERS_USERSTATS = {'x-xbl-contract-version': '2'}
HEADERS_USERSTATS_WITH_METADATA = {'x-xbl-contract-version': '3'}
SEPERATOR = ','
get_stats(xuid: str, service_config_id: str, stats_fields: Op-tional[List[xbox.webapi.api.provider.userstats.models.GeneralStatsField]] = None,**kwargs)→ xbox.webapi.api.provider.userstats.models.UserStatsResponse
Get userstats
Parameters
• xuid – Xbox User Id
• service_config_id – Service Config Id of Game (scid)
• stats_fields – List of stats fields to acquire
Returns User Stats Response
Return type UserStatsResponse
get_stats_batch(xuids: List[str], title_id: str, stats_fields: Op-tional[List[xbox.webapi.api.provider.userstats.models.GeneralStatsField]] =None, **kwargs)→ xbox.webapi.api.provider.userstats.models.UserStatsResponse
Get userstats in batch mode
Parameters
• xuids – List of XUIDs to get stats for
• title_id – Game Title Id
• stats_fields – List of stats fields to acquire
Returns User Stats Response
Return type UserStatsResponse
get_stats_batch_by_scid(xuids: List[str], service_config_id: str, stats_fields: Op-tional[List[xbox.webapi.api.provider.userstats.models.GeneralStatsField]]= None, **kwargs)→ xbox.webapi.api.provider.userstats.models.UserStatsResponse
Get userstats in batch mode, via scid
Parameters
• xuids – List of XUIDs to get stats for
• service_config_id – Service Config Id of Game (scid)
• stats_fields – List of stats fields to acquire
Returns User Stats Response
Return type UserStatsResponse
4.1. Submodules 17
![Page 22: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/22.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
get_stats_with_metadata(xuid: str, service_config_id: str, stats_fields: Op-tional[List[xbox.webapi.api.provider.userstats.models.GeneralStatsField]]= None, **kwargs)→ xbox.webapi.api.provider.userstats.models.UserStatsResponse
Get userstats including metadata for each stat (if available)
Parameters
• xuid – Xbox User Id
• service_config_id – Service Config Id of Game (scid)
• stats_fields – List of stats fields to acquire
Returns User Stats Response
Return type UserStatsResponse
4.1.13 Screenshots - Get screenshot info
Screenshots - Get screenshot info
class xbox.webapi.api.provider.screenshots.ScreenshotsProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
SCREENSHOTS_METADATA_URL = 'https://screenshotsmetadata.xboxlive.com'
HEADERS_SCREENSHOTS_METADATA = {'x-xbl-contract-version': '5'}
get_recent_community_screenshots_by_title_id(title_id: str, **kwargs) →xbox.webapi.api.provider.screenshots.models.ScreenshotResponse
Get recent community screenshots by Title Id
Parameters title_id – Title Id to get screenshots for
Returns Screenshot Response
Return type ScreenshotResponse
get_recent_own_screenshots(title_id: str = None, skip_items: int =0, max_items: int = 25, **kwargs) →xbox.webapi.api.provider.screenshots.models.ScreenshotResponse
Get own recent screenshots, optionally filter for title Id
Parameters
• title_id – Title ID to filter
• skip_items – Item count to skip
• max_items – Maximum item count to load
Returns Screenshot Response
Return type ScreenshotResponse
get_recent_screenshots_by_xuid(xuid: str, title_id: str = None, skip_items:int = 0, max_items: int = 25, **kwargs) →xbox.webapi.api.provider.screenshots.models.ScreenshotResponse
Get recent screenshots by XUID, optionally filter for title Id
Parameters
• xuid – XUID of user to get screenshots from
• title_id – Optional title id filter
18 Chapter 4. Xbox Live Providers - API Endpoints
![Page 23: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/23.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
• skip_items – Item count to skip
• max_items – Maximum item count to load
Returns Screenshot Response
Return type ScreenshotResponse
get_saved_community_screenshots_by_title_id(title_id: str, **kwargs) →xbox.webapi.api.provider.screenshots.models.ScreenshotResponse
Get saved community screenshots by Title Id
Parameters title_id – Title Id to get screenshots for
Returns Screenshot Response
Return type ScreenshotResponse
get_saved_own_screenshots(title_id: str = None, skip_items: int =0, max_items: int = 25, **kwargs) →xbox.webapi.api.provider.screenshots.models.ScreenshotResponse
Get own saved screenshots, optionally filter for title Id an
Parameters
• title_id – Optional Title ID to filter
• skip_items – Item count to skip
• max_items – Maximum item count to load
Returns Screenshot Response
Return type ScreenshotResponse
get_saved_screenshots_by_xuid(xuid: str, title_id: str = None, skip_items:int = 0, max_items: int = 25, **kwargs) →xbox.webapi.api.provider.screenshots.models.ScreenshotResponse
Get saved screenshots by XUID, optionally filter for title Id
Parameters
• xuid – XUID of user to get screenshots from
• title_id – Optional title id filter
• skip_items – Item count to skip
• max_items – Maximum item count to load
Returns Screenshot Response
Return type ScreenshotResponse
4.1.14 Titlehub - Get Title history and info
Titlehub - Get Title history and info
class xbox.webapi.api.provider.titlehub.TitlehubProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
TITLEHUB_URL = 'https://titlehub.xboxlive.com'
SEPARATOR = ','
__init__(client)Initialize Baseclass, set ‘Accept-Language’ header from client instance
4.1. Submodules 19
![Page 24: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/24.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
Parameters client (XboxLiveClient) – Instance of client
get_title_history(xuid: str, fields: Optional[List[xbox.webapi.api.provider.titlehub.models.TitleFields]]= None, max_items: Optional[int] = 5, **kwargs) →xbox.webapi.api.provider.titlehub.models.TitleHubResponse
Get recently played titles
Parameters
• xuid – Xuid
• fields – List of titlefield
• max_items – Maximum items
Returns Title Hub Response
Return type TitleHubResponse
get_title_info(title_id: str, fields: Optional[List[xbox.webapi.api.provider.titlehub.models.TitleFields]]= None, **kwargs)→ xbox.webapi.api.provider.titlehub.models.TitleHubResponse
Get info for specific title
Parameters
• title_id – Title Id
• fields – List of title fields
Returns Title Hub Response
Return type TitleHubResponse
get_titles_batch(pfns: List[str], fields: Optional[List[xbox.webapi.api.provider.titlehub.models.TitleFields]]= None, **kwargs)→ xbox.webapi.api.provider.titlehub.models.TitleHubResponse
Get Title info via PFN ids
Parameters
• pfns – List of Package family names (e.g. ‘Microsoft.XboxApp_8wekyb3d8bbwe’)
• fields – List of title fields
Returns Title Hub Response
Return type TitleHubResponse
4.1.15 Smartglass - Control your Xbox
SmartGlass - Control Registered Devices
class xbox.webapi.api.provider.smartglass.SmartglassProvider(client)Bases: xbox.webapi.api.provider.baseprovider.BaseProvider
SG_URL = 'https://xccs.xboxlive.com'
HEADERS_SG = {'skillplatform': 'RemoteManagement', 'x-xbl-contract-version': '4'}
__init__(client)Initialize Baseclass, create smartglass session id
Args: Instance of XBL client
_fetch_list(list_name: str, params: Optional[dict] = None, **kwargs) → aio-http.client_reqrep.ClientResponse
Fetch arbitrary list
20 Chapter 4. Xbox Live Providers - API Endpoints
![Page 25: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/25.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
Parameters
• list_name – name of list
• params – query params
Returns HTTP Response
Return type aiohttp.ClientResponse
_send_one_shot_command(device_id: str, command_type: str, command: str,params: Optional[List[dict]] = None, **kwargs) →xbox.webapi.api.provider.smartglass.models.CommandResponse
Send One Shot command to console
Parameters
• device_id – ID of console (from console list)
• type – type of command
• command – name of command
• params – command parameters
Returns: Command Response
get_console_list(include_storage_devices: bool = True, **kwargs) →xbox.webapi.api.provider.smartglass.models.SmartglassConsoleList
Get Console list
Parameters include_storage_devices – Include a list of storage devices in the response
Returns: Console List
get_console_status(device_id: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.SmartglassConsoleStatusGet Console Status
Parameters device_id – ID of console (from console list)
Returns: Console Status
get_installed_apps(device_id: Optional[str] = None, **kwargs) →xbox.webapi.api.provider.smartglass.models.InstalledPackagesList
Get Installed Apps
Parameters device_id – ID of console (from console list)
Returns: Installed Apps
get_op_status(device_id: str, op_id: str, **kwargs) →xbox.webapi.api.provider.smartglass.models.OperationStatusResponse
Get Operation Status
Parameters
• device_id – ID of console (from console list)
• op_id – Operation ID (from previous command)
Returns: Operation Status
get_storage_devices(device_id: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.StorageDevicesListGet Installed Apps
Parameters device_id – ID of console (from console list)
Returns: Storage Devices list
4.1. Submodules 21
![Page 26: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/26.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
go_back(device_id: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponseGo Back
Parameters device_id – ID of console (from console list)
Returns Command Response
Return type SmartglassConsoleStatus
go_home(device_id: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponseGo Home
Parameters device_id – ID of console (from console list)
Returns: Command Response
insert_text(device_id: str, text: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponseInsert Text
Parameters device_id – ID of console (from console list)
Returns: Command Response
launch_app(device_id: str, one_store_product_id: str, **kwargs) →xbox.webapi.api.provider.smartglass.models.CommandResponse
Launch Application
Parameters
• device_id – ID of console (from console list)
• one_store_product_id – OneStoreProductID for the app to launch
Returns: Command Response
mute(device_id: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponseMute
Parameters device_id – ID of console (from console list)
Returns: Command Response
next(device_id: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponseNext (media controls)
Parameters device_id – ID of console (from console list)
Returns: Command Response
pause(device_id: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponsePause (media controls)
Parameters device_id – ID of console (from console list)
Returns: Command Response
play(device_id: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponsePlay (media controls)
Parameters device_id – ID of console (from console list)
Returns: Command Response
press_button(device_id: str, button: xbox.webapi.api.provider.smartglass.models.InputKeyType,**kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponse
Press Button
Parameters device_id – ID of console (from console list)
22 Chapter 4. Xbox Live Providers - API Endpoints
![Page 27: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/27.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
Returns: Command Response
previous(device_id: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponsePrevious (media controls)
Parameters device_id – ID of console (from console list)
Returns: Command Response
reboot(device_id: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponseReboot Console
Parameters device_id – ID of console (from console list)
Returns: Command Response
show_guide_tab(device_id: str, tab: xbox.webapi.api.provider.smartglass.models.GuideTab= <GuideTab.Guide: ’Guide’>, **kwargs) →xbox.webapi.api.provider.smartglass.models.CommandResponse
Show Guide Tab
Parameters device_id – ID of console (from console list)
Returns: Command Response
show_tv_guide(device_id: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponseShow TV Guide
Parameters device_id – ID of console (from console list)
Returns: Command Response
turn_off(device_id: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponseTurn Off Console
Parameters device_id – ID of console (from console list)
Returns: Command Response
unmute(device_id: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponseUnmute
Parameters device_id – ID of console (from console list)
Returns: Command Response
volume(device_id: str, direction: xbox.webapi.api.provider.smartglass.models.VolumeDirection,amount: int = 1, **kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponse
Adjust Volume
Parameters device_id – ID of console (from console list)
Returns: Command Response
wake_up(device_id: str, **kwargs)→ xbox.webapi.api.provider.smartglass.models.CommandResponseWake Up Console
Parameters device_id – ID of console (from console list)
Returns: Command Response
4.2 Module contents
4.2. Module contents 23
![Page 28: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/28.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
24 Chapter 4. Xbox Live Providers - API Endpoints
![Page 29: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/29.jpg)
CHAPTER 5
Indices and tables
• genindex
• modindex
• search
25
![Page 30: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/30.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
26 Chapter 5. Indices and tables
![Page 31: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/31.jpg)
Python Module Index
xxbox.webapi.api.client, 3xbox.webapi.api.language, 5xbox.webapi.api.provider, 23xbox.webapi.api.provider.account, 7xbox.webapi.api.provider.achievements,
10xbox.webapi.api.provider.catalog, 8xbox.webapi.api.provider.cqs, 8xbox.webapi.api.provider.gameclips, 12xbox.webapi.api.provider.lists, 9xbox.webapi.api.provider.message, 16xbox.webapi.api.provider.people, 14xbox.webapi.api.provider.presence, 15xbox.webapi.api.provider.profile, 10xbox.webapi.api.provider.screenshots,
18xbox.webapi.api.provider.smartglass, 20xbox.webapi.api.provider.titlehub, 19xbox.webapi.api.provider.usersearch, 12xbox.webapi.api.provider.userstats, 17xbox.webapi.authentication.manager, 1
27
![Page 32: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/32.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
28 Python Module Index
![Page 33: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/33.jpg)
Index
Symbols__init__() (xbox.webapi.api.language.XboxLiveLanguage
method), 5__init__() (xbox.webapi.api.provider.people.PeopleProvider
method), 14__init__() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 20__init__() (xbox.webapi.api.provider.titlehub.TitlehubProvider
method), 19_fetch_list() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 20_oauth2_token_request()
(xbox.webapi.authentication.manager.AuthenticationManagermethod), 1
_send_one_shot_command()(xbox.webapi.api.provider.smartglass.SmartglassProvidermethod), 21
AAccountProvider (class in
xbox.webapi.api.provider.account), 7ACHIEVEMENTS_URL (xbox.webapi.api.provider.achievements.AchievementsProvider
attribute), 10AchievementsProvider (class in
xbox.webapi.api.provider.achievements),10
Argentina (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 5
Australia (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 5
Austria (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 5
AuthenticationManager (class inxbox.webapi.authentication.manager), 1
BBASE_URL_ACCOUNT (xbox.webapi.api.provider.account.AccountProvider
attribute), 7BASE_URL_USER_MGT
(xbox.webapi.api.provider.account.AccountProviderattribute), 7
Belgium (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 5
Belgium_NL (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 5
Brazil (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 5
CCanada (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 5Canada_FR (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 5CATALOG_URL (xbox.webapi.api.provider.catalog.CatalogProvider
attribute), 8CatalogProvider (class in
xbox.webapi.api.provider.catalog), 8change_gamertag()
(xbox.webapi.api.provider.account.AccountProvidermethod), 7
Chile (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 6
claim_gamertag() (xbox.webapi.api.provider.account.AccountProvidermethod), 7
Colombia (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 6
CQS_URL (xbox.webapi.api.provider.cqs.CQSProviderattribute), 8
CQSProvider (class in xbox.webapi.api.provider.cqs),8
Czech_Republic (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 5
DDefaultXboxLiveLanguages (class in
xbox.webapi.api.language), 5delete() (xbox.webapi.api.client.Session method), 3delete_conversation()
(xbox.webapi.api.provider.message.MessageProvider
29
![Page 34: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/34.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
method), 16delete_message() (xbox.webapi.api.provider.message.MessageProvider
method), 16Denmark (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 5
FFinland (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 5France (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6
GGameclipProvider (class in
xbox.webapi.api.provider.gameclips), 12GAMECLIPS_METADATA_URL
(xbox.webapi.api.provider.gameclips.GameclipProviderattribute), 12
generate_authorization_url()(xbox.webapi.authentication.manager.AuthenticationManagermethod), 1
Germany (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 6
get() (xbox.webapi.api.client.Session method), 3get_achievements_detail_item()
(xbox.webapi.api.provider.achievements.AchievementsProvidermethod), 11
get_achievements_xbox360_all()(xbox.webapi.api.provider.achievements.AchievementsProvidermethod), 11
get_achievements_xbox360_earned()(xbox.webapi.api.provider.achievements.AchievementsProvidermethod), 11
get_achievements_xbox360_recent_progress_and_info()(xbox.webapi.api.provider.achievements.AchievementsProvidermethod), 11
get_achievements_xboxone_gameprogress()(xbox.webapi.api.provider.achievements.AchievementsProvidermethod), 11
get_achievements_xboxone_recent_progress_and_info()(xbox.webapi.api.provider.achievements.AchievementsProvidermethod), 11
get_channel_list()(xbox.webapi.api.provider.cqs.CQSProvidermethod), 8
get_console_list()(xbox.webapi.api.provider.smartglass.SmartglassProvidermethod), 21
get_console_status()(xbox.webapi.api.provider.smartglass.SmartglassProvidermethod), 21
get_conversation()(xbox.webapi.api.provider.message.MessageProvidermethod), 16
get_friend_recommendations()(xbox.webapi.api.provider.people.PeopleProvidermethod), 14
get_friends_by_xuid()(xbox.webapi.api.provider.people.PeopleProvidermethod), 14
get_friends_own()(xbox.webapi.api.provider.people.PeopleProvidermethod), 14
get_friends_own_batch()(xbox.webapi.api.provider.people.PeopleProvidermethod), 14
get_friends_summary_by_gamertag()(xbox.webapi.api.provider.people.PeopleProvidermethod), 14
get_friends_summary_by_xuid()(xbox.webapi.api.provider.people.PeopleProvidermethod), 14
get_friends_summary_own()(xbox.webapi.api.provider.people.PeopleProvidermethod), 15
get_inbox() (xbox.webapi.api.provider.message.MessageProvidermethod), 16
get_installed_apps()(xbox.webapi.api.provider.smartglass.SmartglassProvidermethod), 21
get_items() (xbox.webapi.api.provider.lists.ListsProvidermethod), 9
get_live_search()(xbox.webapi.api.provider.usersearch.UserSearchProvidermethod), 12
get_op_status() (xbox.webapi.api.provider.smartglass.SmartglassProvidermethod), 21
get_presence() (xbox.webapi.api.provider.presence.PresenceProvidermethod), 15
get_presence_batch()(xbox.webapi.api.provider.presence.PresenceProvidermethod), 15
get_presence_own()(xbox.webapi.api.provider.presence.PresenceProvidermethod), 15
get_product_from_alternate_id()(xbox.webapi.api.provider.catalog.CatalogProvidermethod), 8
get_products() (xbox.webapi.api.provider.catalog.CatalogProvidermethod), 8
get_profile_by_gamertag()(xbox.webapi.api.provider.profile.ProfileProvidermethod), 10
get_profile_by_xuid()(xbox.webapi.api.provider.profile.ProfileProvidermethod), 10
get_profiles() (xbox.webapi.api.provider.profile.ProfileProvidermethod), 10
30 Index
![Page 35: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/35.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
get_recent_clips_by_xuid()(xbox.webapi.api.provider.gameclips.GameclipProvidermethod), 12
get_recent_community_clips_by_title_id()(xbox.webapi.api.provider.gameclips.GameclipProvidermethod), 12
get_recent_community_screenshots_by_title_id()(xbox.webapi.api.provider.screenshots.ScreenshotsProvidermethod), 18
get_recent_own_clips()(xbox.webapi.api.provider.gameclips.GameclipProvidermethod), 13
get_recent_own_screenshots()(xbox.webapi.api.provider.screenshots.ScreenshotsProvidermethod), 18
get_recent_screenshots_by_xuid()(xbox.webapi.api.provider.screenshots.ScreenshotsProvidermethod), 18
get_saved_clips_by_xuid()(xbox.webapi.api.provider.gameclips.GameclipProvidermethod), 13
get_saved_community_clips_by_title_id()(xbox.webapi.api.provider.gameclips.GameclipProvidermethod), 13
get_saved_community_screenshots_by_title_id()(xbox.webapi.api.provider.screenshots.ScreenshotsProvidermethod), 19
get_saved_own_clips()(xbox.webapi.api.provider.gameclips.GameclipProvidermethod), 13
get_saved_own_screenshots()(xbox.webapi.api.provider.screenshots.ScreenshotsProvidermethod), 19
get_saved_screenshots_by_xuid()(xbox.webapi.api.provider.screenshots.ScreenshotsProvidermethod), 19
get_schedule() (xbox.webapi.api.provider.cqs.CQSProvidermethod), 8
get_stats() (xbox.webapi.api.provider.userstats.UserStatsProvidermethod), 17
get_stats_batch()(xbox.webapi.api.provider.userstats.UserStatsProvidermethod), 17
get_stats_batch_by_scid()(xbox.webapi.api.provider.userstats.UserStatsProvidermethod), 17
get_stats_with_metadata()(xbox.webapi.api.provider.userstats.UserStatsProvidermethod), 18
get_storage_devices()(xbox.webapi.api.provider.smartglass.SmartglassProvidermethod), 21
get_title_endpoints()(xbox.webapi.authentication.manager.AuthenticationManager
method), 1get_title_history()
(xbox.webapi.api.provider.titlehub.TitlehubProvidermethod), 20
get_title_info() (xbox.webapi.api.provider.titlehub.TitlehubProvidermethod), 20
get_titles_batch()(xbox.webapi.api.provider.titlehub.TitlehubProvidermethod), 20
go_back() (xbox.webapi.api.provider.smartglass.SmartglassProvidermethod), 21
go_home() (xbox.webapi.api.provider.smartglass.SmartglassProvidermethod), 22
Great_Britain (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 6
Greece (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 6
Hhead() (xbox.webapi.api.client.Session method), 3HEADERS_ACCOUNT (xbox.webapi.api.provider.account.AccountProvider
attribute), 7HEADERS_CQS (xbox.webapi.api.provider.cqs.CQSProvider
attribute), 8HEADERS_GAME_360_PROGRESS
(xbox.webapi.api.provider.achievements.AchievementsProviderattribute), 10
HEADERS_GAME_PROGRESS(xbox.webapi.api.provider.achievements.AchievementsProviderattribute), 10
HEADERS_GAMECLIPS_METADATA(xbox.webapi.api.provider.gameclips.GameclipProviderattribute), 12
HEADERS_HORIZON (xbox.webapi.api.provider.message.MessageProviderattribute), 16
HEADERS_LISTS (xbox.webapi.api.provider.lists.ListsProviderattribute), 9
HEADERS_MESSAGE (xbox.webapi.api.provider.message.MessageProviderattribute), 16
HEADERS_PEOPLE (xbox.webapi.api.provider.people.PeopleProviderattribute), 14
HEADERS_PRESENCE (xbox.webapi.api.provider.presence.PresenceProviderattribute), 15
HEADERS_PROFILE (xbox.webapi.api.provider.profile.ProfileProviderattribute), 10
HEADERS_SCREENSHOTS_METADATA(xbox.webapi.api.provider.screenshots.ScreenshotsProviderattribute), 18
HEADERS_SG (xbox.webapi.api.provider.smartglass.SmartglassProviderattribute), 20
HEADERS_SOCIAL (xbox.webapi.api.provider.people.PeopleProviderattribute), 14
HEADERS_USER_MGT (xbox.webapi.api.provider.account.AccountProviderattribute), 7
Index 31
![Page 36: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/36.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
HEADERS_USER_SEARCH(xbox.webapi.api.provider.usersearch.UserSearchProviderattribute), 12
HEADERS_USERSTATS(xbox.webapi.api.provider.userstats.UserStatsProviderattribute), 17
HEADERS_USERSTATS_WITH_METADATA(xbox.webapi.api.provider.userstats.UserStatsProviderattribute), 17
Hong_Kong (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 6
Hungary (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 6
IIndia (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6insert_items() (xbox.webapi.api.provider.lists.ListsProvider
method), 9insert_text() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 22Ireland (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6Israel (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6Italy (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6
JJapan (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6
KKorea (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6
Llanguage (xbox.webapi.api.client.XboxLiveClient at-
tribute), 3launch_app() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 22LISTS_URL (xbox.webapi.api.provider.lists.ListsProvider
attribute), 9ListsProvider (class in
xbox.webapi.api.provider.lists), 9
MMessageProvider (class in
xbox.webapi.api.provider.message), 16Mexico (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6MSG_URL (xbox.webapi.api.provider.message.MessageProvider
attribute), 16
mute() (xbox.webapi.api.provider.smartglass.SmartglassProvidermethod), 22
NNetherlands (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6New_Zealand (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6next() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 22Norway (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6
Ooptions() (xbox.webapi.api.client.Session method), 3
Ppatch() (xbox.webapi.api.client.Session method), 3pause() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 22PEOPLE_URL (xbox.webapi.api.provider.people.PeopleProvider
attribute), 14PeopleProvider (class in
xbox.webapi.api.provider.people), 14play() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 22Poland (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6Portugal (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6post() (xbox.webapi.api.client.Session method), 3PRESENCE_URL (xbox.webapi.api.provider.presence.PresenceProvider
attribute), 15PresenceProvider (class in
xbox.webapi.api.provider.presence), 15press_button() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 22previous() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 23product_search() (xbox.webapi.api.provider.catalog.CatalogProvider
method), 8PROFILE_URL (xbox.webapi.api.provider.profile.ProfileProvider
attribute), 10ProfileProvider (class in
xbox.webapi.api.provider.profile), 10put() (xbox.webapi.api.client.Session method), 3
Rreboot() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 23refresh_oauth_token()
(xbox.webapi.authentication.manager.AuthenticationManagermethod), 1
32 Index
![Page 37: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/37.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
refresh_tokens() (xbox.webapi.authentication.manager.AuthenticationManagermethod), 1
remove_items() (xbox.webapi.api.provider.lists.ListsProvidermethod), 9
request() (xbox.webapi.api.client.Session method), 3request_oauth_token()
(xbox.webapi.authentication.manager.AuthenticationManagermethod), 1
request_tokens() (xbox.webapi.authentication.manager.AuthenticationManagermethod), 1
request_user_token()(xbox.webapi.authentication.manager.AuthenticationManagermethod), 1
request_xsts_token()(xbox.webapi.authentication.manager.AuthenticationManagermethod), 1
Russia (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 6
SSaudi_Arabia (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6SCREENSHOTS_METADATA_URL
(xbox.webapi.api.provider.screenshots.ScreenshotsProviderattribute), 18
ScreenshotsProvider (class inxbox.webapi.api.provider.screenshots), 18
send_message() (xbox.webapi.api.provider.message.MessageProvidermethod), 16
SEPARATOR (xbox.webapi.api.provider.profile.ProfileProviderattribute), 10
SEPARATOR (xbox.webapi.api.provider.titlehub.TitlehubProviderattribute), 19
SEPERATOR (xbox.webapi.api.provider.catalog.CatalogProviderattribute), 8
SEPERATOR (xbox.webapi.api.provider.lists.ListsProviderattribute), 9
SEPERATOR (xbox.webapi.api.provider.people.PeopleProviderattribute), 14
SEPERATOR (xbox.webapi.api.provider.userstats.UserStatsProviderattribute), 17
Session (class in xbox.webapi.api.client), 3SG_URL (xbox.webapi.api.provider.smartglass.SmartglassProvider
attribute), 20show_guide_tab() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 23show_tv_guide() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 23Singapore (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6Slovakia (xbox.webapi.api.language.DefaultXboxLiveLanguages
attribute), 6SmartglassProvider (class in
xbox.webapi.api.provider.smartglass), 20
SOCIAL_URL (xbox.webapi.api.provider.people.PeopleProviderattribute), 14
South_Africa (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 6
Spain (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 6
Switzerland (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 6
Switzerland_FR (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 6
TTITLEHUB_URL (xbox.webapi.api.provider.titlehub.TitlehubProvider
attribute), 19TitlehubProvider (class in
xbox.webapi.api.provider.titlehub), 19turn_off() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 23
UUnited_Arab_Emirates
(xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 6
United_States (xbox.webapi.api.language.DefaultXboxLiveLanguagesattribute), 6
unmute() (xbox.webapi.api.provider.smartglass.SmartglassProvidermethod), 23
USERSEARCH_URL (xbox.webapi.api.provider.usersearch.UserSearchProviderattribute), 12
UserSearchProvider (class inxbox.webapi.api.provider.usersearch), 12
USERSTATS_URL (xbox.webapi.api.provider.userstats.UserStatsProviderattribute), 17
UserStatsProvider (class inxbox.webapi.api.provider.userstats), 17
Vvolume() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 23
Wwake_up() (xbox.webapi.api.provider.smartglass.SmartglassProvider
method), 23
Xxbox.webapi.api.client (module), 3xbox.webapi.api.language (module), 5xbox.webapi.api.provider (module), 23xbox.webapi.api.provider.account (mod-
ule), 7xbox.webapi.api.provider.achievements
(module), 10xbox.webapi.api.provider.catalog (mod-
ule), 8
Index 33
![Page 38: Xbox-WebAPI Documentation](https://reader035.vdocument.in/reader035/viewer/2022062806/62b8a04220bb665d4a554720/html5/thumbnails/38.jpg)
Xbox-WebAPI Documentation, Release 2.0.11
xbox.webapi.api.provider.cqs (module), 8xbox.webapi.api.provider.gameclips (mod-
ule), 12xbox.webapi.api.provider.lists (module), 9xbox.webapi.api.provider.message (mod-
ule), 16xbox.webapi.api.provider.people (module),
14xbox.webapi.api.provider.presence (mod-
ule), 15xbox.webapi.api.provider.profile (mod-
ule), 10xbox.webapi.api.provider.screenshots
(module), 18xbox.webapi.api.provider.smartglass
(module), 20xbox.webapi.api.provider.titlehub (mod-
ule), 19xbox.webapi.api.provider.usersearch
(module), 12xbox.webapi.api.provider.userstats (mod-
ule), 17xbox.webapi.authentication.manager (mod-
ule), 1XboxLiveClient (class in xbox.webapi.api.client), 3XboxLiveLanguage (class in
xbox.webapi.api.language), 5xuid (xbox.webapi.api.client.XboxLiveClient attribute),
3
34 Index