Skip to content

Fireteam HTTP Routes

FireteamRouteHttpRequests

Source code in src/bungio/http/routes/fireteam.py 
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
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
146
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
class FireteamRouteHttpRequests:
    request: Callable[..., Coroutine]

    async def get_active_private_clan_fireteam_count(self, group_id: int, auth: AuthData, *args, **kwargs) -> dict:
        """
        Gets a count of all active non-public fireteams for the specified clan. Maximum value returned is 25.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadGroups

        Args:
            group_id: The group id of the clan.
            auth: Authentication information.

        Raises:
            NotFound: 404 request
            BadRequest: 400 request
            InvalidAuthentication: If authentication is invalid
            TimeoutException: If no connection could be made
            BungieDead: Servers are down
            AuthenticationTooSlow: The authentication key has expired
            BungieException: Relaying the bungie error

        Returns:
            The json response
        """

        return await self.request(Route(path=f"/Fireteam/Clan/{group_id}/ActiveCount/", method="GET", auth=auth))

    async def get_available_clan_fireteams(
        self,
        activity_type: int,
        date_range: int,
        group_id: int,
        page: int,
        platform: int,
        public_only: int,
        slot_filter: int,
        auth: AuthData,
        exclude_immediate: Optional[bool] = None,
        lang_filter: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        Gets a listing of all of this clan's fireteams that are have available slots. Caller is not checked for join criteria so caching is maximized.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadGroups

        Args:
            activity_type: The activity type to filter by.
            date_range: The date range to grab available fireteams.
            group_id: The group id of the clan.
            page: Zero based page
            platform: The platform filter.
            public_only: Determines public/private filtering.
            slot_filter: Filters based on available slots
            auth: Authentication information.
            exclude_immediate: If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.
            lang_filter: An optional language filter.

        Raises:
            NotFound: 404 request
            BadRequest: 400 request
            InvalidAuthentication: If authentication is invalid
            TimeoutException: If no connection could be made
            BungieDead: Servers are down
            AuthenticationTooSlow: The authentication key has expired
            BungieException: Relaying the bungie error

        Returns:
            The json response
        """

        return await self.request(
            Route(
                path=f"/Fireteam/Clan/{group_id}/Available/{platform}/{activity_type}/{date_range}/{slot_filter}/{public_only}/{page}/",
                method="GET",
                auth=auth,
                exclude_immediate=exclude_immediate,
                lang_filter=lang_filter,
            )
        )

    async def search_public_available_clan_fireteams(
        self,
        activity_type: int,
        date_range: int,
        page: int,
        platform: int,
        slot_filter: int,
        auth: AuthData,
        exclude_immediate: Optional[bool] = None,
        lang_filter: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        Gets a listing of all public fireteams starting now with open slots. Caller is not checked for join criteria so caching is maximized.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadGroups

        Args:
            activity_type: The activity type to filter by.
            date_range: The date range to grab available fireteams.
            page: Zero based page
            platform: The platform filter.
            slot_filter: Filters based on available slots
            auth: Authentication information.
            exclude_immediate: If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.
            lang_filter: An optional language filter.

        Raises:
            NotFound: 404 request
            BadRequest: 400 request
            InvalidAuthentication: If authentication is invalid
            TimeoutException: If no connection could be made
            BungieDead: Servers are down
            AuthenticationTooSlow: The authentication key has expired
            BungieException: Relaying the bungie error

        Returns:
            The json response
        """

        return await self.request(
            Route(
                path=f"/Fireteam/Search/Available/{platform}/{activity_type}/{date_range}/{slot_filter}/{page}/",
                method="GET",
                auth=auth,
                exclude_immediate=exclude_immediate,
                lang_filter=lang_filter,
            )
        )

    async def get_my_clan_fireteams(
        self,
        group_id: int,
        include_closed: bool,
        page: int,
        platform: int,
        auth: AuthData,
        group_filter: Optional[bool] = None,
        lang_filter: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        Gets a listing of all fireteams that caller is an applicant, a member, or an alternate of.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadGroups

        Args:
            group_id: The group id of the clan. (This parameter is ignored unless the optional query parameter groupFilter is true).
            include_closed: If true, return fireteams that have been closed.
            page: Deprecated parameter, ignored.
            platform: The platform filter.
            auth: Authentication information.
            group_filter: If true, filter by clan. Otherwise, ignore the clan and show all of the user's fireteams.
            lang_filter: An optional language filter.

        Raises:
            NotFound: 404 request
            BadRequest: 400 request
            InvalidAuthentication: If authentication is invalid
            TimeoutException: If no connection could be made
            BungieDead: Servers are down
            AuthenticationTooSlow: The authentication key has expired
            BungieException: Relaying the bungie error

        Returns:
            The json response
        """

        return await self.request(
            Route(
                path=f"/Fireteam/Clan/{group_id}/My/{platform}/{include_closed}/{page}/",
                method="GET",
                auth=auth,
                group_filter=group_filter,
                lang_filter=lang_filter,
            )
        )

    async def get_clan_fireteam(self, fireteam_id: int, group_id: int, auth: AuthData, *args, **kwargs) -> dict:
        """
        Gets a specific fireteam.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadGroups

        Args:
            fireteam_id: The unique id of the fireteam.
            group_id: The group id of the clan.
            auth: Authentication information.

        Raises:
            NotFound: 404 request
            BadRequest: 400 request
            InvalidAuthentication: If authentication is invalid
            TimeoutException: If no connection could be made
            BungieDead: Servers are down
            AuthenticationTooSlow: The authentication key has expired
            BungieException: Relaying the bungie error

        Returns:
            The json response
        """

        return await self.request(
            Route(path=f"/Fireteam/Clan/{group_id}/Summary/{fireteam_id}/", method="GET", auth=auth)
        )

get_active_private_clan_fireteam_count(group_id, auth, *args, **kwargs) async

Gets a count of all active non-public fireteams for the specified clan. Maximum value returned is 25.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name Type Description Default
group_id int

The group id of the clan.

 required
auth AuthData

Authentication information.

 required

Raises:

Type Description
NotFound

404 request
BadRequest

400 request
InvalidAuthentication

If authentication is invalid
TimeoutException

If no connection could be made
BungieDead

Servers are down
AuthenticationTooSlow

The authentication key has expired
BungieException

Relaying the bungie error

Returns:

Type Description
dict

The json response
Source code in src/bungio/http/routes/fireteam.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
async def get_active_private_clan_fireteam_count(self, group_id: int, auth: AuthData, *args, **kwargs) -> dict:
    """
    Gets a count of all active non-public fireteams for the specified clan. Maximum value returned is 25.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        group_id: The group id of the clan.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/Fireteam/Clan/{group_id}/ActiveCount/", method="GET", auth=auth))

get_available_clan_fireteams(activity_type, date_range, group_id, page, platform, public_only, slot_filter, auth, exclude_immediate=None, lang_filter=None, *args, **kwargs) async

Gets a listing of all of this clan's fireteams that are have available slots. Caller is not checked for join criteria so caching is maximized.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name Type Description Default
activity_type int

The activity type to filter by.

 required
date_range int

The date range to grab available fireteams.

 required
group_id int

The group id of the clan.

 required
page int

Zero based page

 required
platform int

The platform filter.

 required
public_only int

Determines public/private filtering.

 required
slot_filter int

Filters based on available slots

 required
auth AuthData

Authentication information.

 required
exclude_immediate Optional[bool]

If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.

 None
lang_filter Optional[str]

An optional language filter.

 None

Raises:

Type Description
NotFound

404 request
BadRequest

400 request
InvalidAuthentication

If authentication is invalid
TimeoutException

If no connection could be made
BungieDead

Servers are down
AuthenticationTooSlow

The authentication key has expired
BungieException

Relaying the bungie error

Returns:

Type Description
dict

The json response
Source code in src/bungio/http/routes/fireteam.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
async def get_available_clan_fireteams(
    self,
    activity_type: int,
    date_range: int,
    group_id: int,
    page: int,
    platform: int,
    public_only: int,
    slot_filter: int,
    auth: AuthData,
    exclude_immediate: Optional[bool] = None,
    lang_filter: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Gets a listing of all of this clan's fireteams that are have available slots. Caller is not checked for join criteria so caching is maximized.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        activity_type: The activity type to filter by.
        date_range: The date range to grab available fireteams.
        group_id: The group id of the clan.
        page: Zero based page
        platform: The platform filter.
        public_only: Determines public/private filtering.
        slot_filter: Filters based on available slots
        auth: Authentication information.
        exclude_immediate: If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.
        lang_filter: An optional language filter.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Fireteam/Clan/{group_id}/Available/{platform}/{activity_type}/{date_range}/{slot_filter}/{public_only}/{page}/",
            method="GET",
            auth=auth,
            exclude_immediate=exclude_immediate,
            lang_filter=lang_filter,
        )
    )

get_clan_fireteam(fireteam_id, group_id, auth, *args, **kwargs) async

Gets a specific fireteam.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name Type Description Default
fireteam_id int

The unique id of the fireteam.

 required
group_id int

The group id of the clan.

 required
auth AuthData

Authentication information.

 required

Raises:

Type Description
NotFound

404 request
BadRequest

400 request
InvalidAuthentication

If authentication is invalid
TimeoutException

If no connection could be made
BungieDead

Servers are down
AuthenticationTooSlow

The authentication key has expired
BungieException

Relaying the bungie error

Returns:

Type Description
dict

The json response
Source code in src/bungio/http/routes/fireteam.py 
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
async def get_clan_fireteam(self, fireteam_id: int, group_id: int, auth: AuthData, *args, **kwargs) -> dict:
    """
    Gets a specific fireteam.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        fireteam_id: The unique id of the fireteam.
        group_id: The group id of the clan.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Fireteam/Clan/{group_id}/Summary/{fireteam_id}/", method="GET", auth=auth)
    )

get_my_clan_fireteams(group_id, include_closed, page, platform, auth, group_filter=None, lang_filter=None, *args, **kwargs) async

Gets a listing of all fireteams that caller is an applicant, a member, or an alternate of.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name Type Description Default
group_id int

The group id of the clan. (This parameter is ignored unless the optional query parameter groupFilter is true).

 required
include_closed bool

If true, return fireteams that have been closed.

 required
page int

Deprecated parameter, ignored.

 required
platform int

The platform filter.

 required
auth AuthData

Authentication information.

 required
group_filter Optional[bool]

If true, filter by clan. Otherwise, ignore the clan and show all of the user's fireteams.

 None
lang_filter Optional[str]

An optional language filter.

 None

Raises:

Type Description
NotFound

404 request
BadRequest

400 request
InvalidAuthentication

If authentication is invalid
TimeoutException

If no connection could be made
BungieDead

Servers are down
AuthenticationTooSlow

The authentication key has expired
BungieException

Relaying the bungie error

Returns:

Type Description
dict

The json response
Source code in src/bungio/http/routes/fireteam.py 
144
145
146
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
async def get_my_clan_fireteams(
    self,
    group_id: int,
    include_closed: bool,
    page: int,
    platform: int,
    auth: AuthData,
    group_filter: Optional[bool] = None,
    lang_filter: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Gets a listing of all fireteams that caller is an applicant, a member, or an alternate of.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        group_id: The group id of the clan. (This parameter is ignored unless the optional query parameter groupFilter is true).
        include_closed: If true, return fireteams that have been closed.
        page: Deprecated parameter, ignored.
        platform: The platform filter.
        auth: Authentication information.
        group_filter: If true, filter by clan. Otherwise, ignore the clan and show all of the user's fireteams.
        lang_filter: An optional language filter.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Fireteam/Clan/{group_id}/My/{platform}/{include_closed}/{page}/",
            method="GET",
            auth=auth,
            group_filter=group_filter,
            lang_filter=lang_filter,
        )
    )

search_public_available_clan_fireteams(activity_type, date_range, page, platform, slot_filter, auth, exclude_immediate=None, lang_filter=None, *args, **kwargs) async

Gets a listing of all public fireteams starting now with open slots. Caller is not checked for join criteria so caching is maximized.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name Type Description Default
activity_type int

The activity type to filter by.

 required
date_range int

The date range to grab available fireteams.

 required
page int

Zero based page

 required
platform int

The platform filter.

 required
slot_filter int

Filters based on available slots

 required
auth AuthData

Authentication information.

 required
exclude_immediate Optional[bool]

If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.

 None
lang_filter Optional[str]

An optional language filter.

 None

Raises:

Type Description
NotFound

404 request
BadRequest

400 request
InvalidAuthentication

If authentication is invalid
TimeoutException

If no connection could be made
BungieDead

Servers are down
AuthenticationTooSlow

The authentication key has expired
BungieException

Relaying the bungie error

Returns:

Type Description
dict

The json response
Source code in src/bungio/http/routes/fireteam.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
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
async def search_public_available_clan_fireteams(
    self,
    activity_type: int,
    date_range: int,
    page: int,
    platform: int,
    slot_filter: int,
    auth: AuthData,
    exclude_immediate: Optional[bool] = None,
    lang_filter: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Gets a listing of all public fireteams starting now with open slots. Caller is not checked for join criteria so caching is maximized.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        activity_type: The activity type to filter by.
        date_range: The date range to grab available fireteams.
        page: Zero based page
        platform: The platform filter.
        slot_filter: Filters based on available slots
        auth: Authentication information.
        exclude_immediate: If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.
        lang_filter: An optional language filter.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Fireteam/Search/Available/{platform}/{activity_type}/{date_range}/{slot_filter}/{page}/",
            method="GET",
            auth=auth,
            exclude_immediate=exclude_immediate,
            lang_filter=lang_filter,
        )
    )