Skip to content

Gameclips provider

Gameclips - Get gameclip info

pythonxbox.api.provider.gameclips.GameclipProvider(client)

Bases: BaseProvider

Source code in src/pythonxbox/api/provider/baseprovider.py 
14
15
16
17
18
19
20
21
def __init__(self, client: "XboxLiveClient") -> None:
    """
    Initialize an the BaseProvider

    Args:
        client (:class:`XboxLiveClient`): Instance of XboxLiveClient
    """
    self.client = client

GAMECLIPS_METADATA_URL = 'https://gameclipsmetadata.xboxlive.com' class-attribute instance-attribute

HEADERS_GAMECLIPS_METADATA = {'x-xbl-contract-version': '1'} class-attribute instance-attribute

get_recent_community_clips_by_title_id(title_id, **kwargs) async

Get recent community clips by Title Id

Parameters:

Name Type Description Default
title_id str

Title Id to get clips for

 required

Returns:

Type Description
GameclipsResponse

class:GameclipsResponse: Game clip Response
Source code in src/pythonxbox/api/provider/gameclips/__init__.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
async def get_recent_community_clips_by_title_id(
    self, title_id: str, **kwargs
) -> GameclipsResponse:
    """
    Get recent community clips by Title Id

    Args:
        title_id: Title Id to get clips for

    Returns:
        :class:`GameclipsResponse`: Game clip Response
    """
    url = self.GAMECLIPS_METADATA_URL + f"/public/titles/{title_id}/clips"
    params = {"qualifier": "created"}
    resp = await self.client.session.get(
        url, params=params, headers=self.HEADERS_GAMECLIPS_METADATA, **kwargs
    )
    resp.raise_for_status()
    return GameclipsResponse.model_validate_json(resp.text)

get_recent_own_clips(title_id=None, skip_items=0, max_items=25, **kwargs) async

Get own recent clips, optionally filter for title Id

Parameters:

Name Type Description Default
title_id str | None

Title ID to filter

 None
skip_items int

Item count to skip

 0
max_items int

Maximum item count to load

 25

Returns:

Type Description
GameclipsResponse

class:GameclipsResponse: Game clip Response
Source code in src/pythonxbox/api/provider/gameclips/__init__.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
async def get_recent_own_clips(
    self,
    title_id: str | None = None,
    skip_items: int = 0,
    max_items: int = 25,
    **kwargs,
) -> GameclipsResponse:
    """
    Get own recent clips, optionally filter for title Id

    Args:
        title_id: Title ID to filter
        skip_items: Item count to skip
        max_items: Maximum item count to load

    Returns:
        :class:`GameclipsResponse`: Game clip Response
    """
    url = self.GAMECLIPS_METADATA_URL + "/users/me"
    if title_id:
        url += f"/titles/{title_id}"
    url += "/clips"

    params = {"skipItems": skip_items, "maxItems": max_items}
    resp = await self.client.session.get(
        url, params=params, headers=self.HEADERS_GAMECLIPS_METADATA, **kwargs
    )
    resp.raise_for_status()
    return GameclipsResponse.model_validate_json(resp.text)

get_recent_clips_by_xuid(xuid, title_id=None, skip_items=0, max_items=25, **kwargs) async

Get clips by XUID, optionally filter for title Id

Parameters:

Name Type Description Default
xuid str

XUID of user to get clips from

 required
title_id str | None

Optional title id filter

 None
skip_items int

Item count to skip

 0
max_items int

Maximum item count to load

 25

Returns:

Type Description
GameclipsResponse

class:GameclipsResponse: Game clip Response
Source code in src/pythonxbox/api/provider/gameclips/__init__.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
async def get_recent_clips_by_xuid(
    self,
    xuid: str,
    title_id: str | None = None,
    skip_items: int = 0,
    max_items: int = 25,
    **kwargs,
) -> GameclipsResponse:
    """
    Get clips by XUID, optionally filter for title Id

    Args:
        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:
        :class:`GameclipsResponse`: Game clip Response
    """
    url = self.GAMECLIPS_METADATA_URL + f"/users/xuid({xuid})"
    if title_id:
        url += f"/titles/{title_id}"
    url += "/clips"

    params = {"skipItems": skip_items, "maxItems": max_items}
    resp = await self.client.session.get(
        url, params=params, headers=self.HEADERS_GAMECLIPS_METADATA, **kwargs
    )
    resp.raise_for_status()
    return GameclipsResponse.model_validate_json(resp.text)

get_saved_community_clips_by_title_id(title_id, **kwargs) async

Get saved community clips by Title Id

Parameters:

Name Type Description Default
title_id str

Title Id to get screenshots for

 required

Returns:

Type Description
GameclipsResponse

class:GameclipsResponse: Game clip Response
Source code in src/pythonxbox/api/provider/gameclips/__init__.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
async def get_saved_community_clips_by_title_id(
    self, title_id: str, **kwargs
) -> GameclipsResponse:
    """
    Get saved community clips by Title Id

    Args:
        title_id: Title Id to get screenshots for

    Returns:
        :class:`GameclipsResponse`: Game clip Response
    """
    url = self.GAMECLIPS_METADATA_URL + f"/public/titles/{title_id}/clips/saved"
    params = {"qualifier": "created"}
    resp = await self.client.session.get(
        url, params=params, headers=self.HEADERS_GAMECLIPS_METADATA, **kwargs
    )
    resp.raise_for_status()
    return GameclipsResponse.model_validate_json(resp.text)

get_saved_own_clips(title_id=None, skip_items=0, max_items=25, **kwargs) async

Get own saved clips, optionally filter for title Id an

Parameters:

Name Type Description Default
title_id str | None

Optional Title ID to filter

 None
skip_items int

Item count to skip

 0
max_items int

Maximum item count to load

 25

Returns:

Type Description
GameclipsResponse

class:GameclipsResponse: Game clip Response
Source code in src/pythonxbox/api/provider/gameclips/__init__.py 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
async def get_saved_own_clips(
    self,
    title_id: str | None = None,
    skip_items: int = 0,
    max_items: int = 25,
    **kwargs,
) -> GameclipsResponse:
    """
    Get own saved clips, optionally filter for title Id an

    Args:
        title_id: Optional Title ID to filter
        skip_items: Item count to skip
        max_items: Maximum item count to load

    Returns:
        :class:`GameclipsResponse`: Game clip Response
    """
    url = self.GAMECLIPS_METADATA_URL + "/users/me"
    if title_id:
        url += f"/titles/{title_id}"
    url += "/clips/saved"

    params = {"skipItems": skip_items, "maxItems": max_items}
    resp = await self.client.session.get(
        url, params=params, headers=self.HEADERS_GAMECLIPS_METADATA, **kwargs
    )
    resp.raise_for_status()
    return GameclipsResponse.model_validate_json(resp.text)

get_saved_clips_by_xuid(xuid, title_id=None, skip_items=0, max_items=25, **kwargs) async

Get saved clips by XUID, optionally filter for title Id

Parameters:

Name Type Description Default
xuid str

XUID of user to get screenshots from

 required
title_id str | None

Optional title id filter

 None
skip_items int

Item count to skip

 0
max_items int

Maximum item count to load

 25

Returns:

Type Description
GameclipsResponse

class:GameclipsResponse: Game clip Response
Source code in src/pythonxbox/api/provider/gameclips/__init__.py 
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
async def get_saved_clips_by_xuid(
    self,
    xuid: str,
    title_id: str | None = None,
    skip_items: int = 0,
    max_items: int = 25,
    **kwargs,
) -> GameclipsResponse:
    """
    Get saved clips by XUID, optionally filter for title Id

    Args:
        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:
        :class:`GameclipsResponse`: Game clip Response
    """
    url = self.GAMECLIPS_METADATA_URL + f"/users/xuid({xuid})"
    if title_id:
        url += f"/titles/{title_id}"
    url += "/clips/saved"

    params = {"skipItems": skip_items, "maxItems": max_items}
    resp = await self.client.session.get(
        url, params=params, headers=self.HEADERS_GAMECLIPS_METADATA, **kwargs
    )
    resp.raise_for_status()
    return GameclipsResponse.model_validate_json(resp.text)