Skip to content

Tokens HTTP Routes

TokensRouteHttpRequests

Source code in src/bungio/http/routes/tokens.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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
class TokensRouteHttpRequests:
    request: Callable[..., Coroutine]

    async def force_drops_repair(self, auth: AuthData, *args, **kwargs) -> dict:
        """
        Twitch Drops self-repair function - scans twitch for drops not marked as fulfilled and resyncs them.

        Warning: Requires Authentication.
            Required oauth2 scopes: PartnerOfferGrant

        Args:
            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="/Tokens/Partner/ForceDropsRepair/", method="POST", auth=auth))

    async def claim_partner_offer(
        self, partner_offer_id: str, bungie_net_membership_id: int, transaction_id: str, auth: AuthData, *args, **kwargs
    ) -> dict:
        """
        Claim a partner offer as the authenticated user.

        Warning: Requires Authentication.
            Required oauth2 scopes: PartnerOfferGrant

        Args:
            partner_offer_id: _No description given by bungie._
            bungie_net_membership_id: _No description given by bungie._
            transaction_id: _No description given by bungie._
            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
        """

        data = {
            "PartnerOfferId": partner_offer_id,
            "BungieNetMembershipId": bungie_net_membership_id,
            "TransactionId": transaction_id,
        }

        return await self.request(Route(path="/Tokens/Partner/ClaimOffer/", method="POST", data=data, auth=auth))

    async def apply_missing_partner_offers_without_claim(
        self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData, *args, **kwargs
    ) -> dict:
        """
        Apply a partner offer to the targeted user. This endpoint does not claim a new offer, but any already claimed offers will be applied to the game if not already.

        Warning: Requires Authentication.
            Required oauth2 scopes: PartnerOfferGrant

        Args:
            partner_application_id: The partner application identifier.
            target_bnet_membership_id: The bungie.net user to apply missing offers to. If not self, elevated permissions are required.
            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"/Tokens/Partner/ApplyMissingOffers/{partner_application_id}/{target_bnet_membership_id}/",
                method="POST",
                auth=auth,
            )
        )

    async def get_partner_offer_sku_history(
        self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData, *args, **kwargs
    ) -> dict:
        """
        Returns the partner sku and offer history of the targeted user. Elevated permissions are required to see users that are not yourself.

        Warning: Requires Authentication.
            Required oauth2 scopes: PartnerOfferGrant

        Args:
            partner_application_id: The partner application identifier.
            target_bnet_membership_id: The bungie.net user to apply missing offers to. If not self, elevated permissions are required.
            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"/Tokens/Partner/History/{partner_application_id}/{target_bnet_membership_id}/",
                method="GET",
                auth=auth,
            )
        )

    async def get_partner_reward_history(
        self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData, *args, **kwargs
    ) -> dict:
        """
        Returns the partner rewards history of the targeted user, both partner offers and Twitch drops.

        Warning: Requires Authentication.
            Required oauth2 scopes: PartnerOfferGrant

        Args:
            partner_application_id: The partner application identifier.
            target_bnet_membership_id: The bungie.net user to return reward history for.
            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"/Tokens/Partner/History/{target_bnet_membership_id}/Application/{partner_application_id}/",
                method="GET",
                auth=auth,
            )
        )

    async def get_bungie_rewards_for_user(self, membership_id: int, auth: AuthData, *args, **kwargs) -> dict:
        """
        Returns the bungie rewards for the targeted user.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadAndApplyTokens

        Args:
            membership_id: bungie.net user membershipId for requested user rewards. If not self, elevated permissions are required.
            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"/Tokens/Rewards/GetRewardsForUser/{membership_id}/", method="GET", auth=auth)
        )

    async def get_bungie_rewards_for_platform_user(
        self, membership_id: int, membership_type: int, auth: AuthData, *args, **kwargs
    ) -> dict:
        """
        Returns the bungie rewards for the targeted user when a platform membership Id and Type are used.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadAndApplyTokens

        Args:
            membership_id: users platform membershipId for requested user rewards. If not self, elevated permissions are required.
            membership_type: The target Destiny 2 membership type.
            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"/Tokens/Rewards/GetRewardsForPlatformUser/{membership_id}/{membership_type}/",
                method="GET",
                auth=auth,
            )
        )

    async def get_bungie_rewards_list(self, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
        """
        Returns a list of the current bungie rewards

        Args:
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        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="/Tokens/Rewards/BungieRewards/", method="GET", auth=auth))

apply_missing_partner_offers_without_claim(partner_application_id, target_bnet_membership_id, auth, *args, **kwargs) async

Apply a partner offer to the targeted user. This endpoint does not claim a new offer, but any already claimed offers will be applied to the game if not already.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name Type Description Default
partner_application_id int

The partner application identifier.

 required
target_bnet_membership_id int

The bungie.net user to apply missing offers to. If not self, elevated permissions are required.

 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/tokens.py 
 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
async def apply_missing_partner_offers_without_claim(
    self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Apply a partner offer to the targeted user. This endpoint does not claim a new offer, but any already claimed offers will be applied to the game if not already.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

    Args:
        partner_application_id: The partner application identifier.
        target_bnet_membership_id: The bungie.net user to apply missing offers to. If not self, elevated permissions are required.
        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"/Tokens/Partner/ApplyMissingOffers/{partner_application_id}/{target_bnet_membership_id}/",
            method="POST",
            auth=auth,
        )
    )

claim_partner_offer(partner_offer_id, bungie_net_membership_id, transaction_id, auth, *args, **kwargs) async

Claim a partner offer as the authenticated user.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name Type Description Default
partner_offer_id str

No description given by bungie.

 required
bungie_net_membership_id int

No description given by bungie.

 required
transaction_id str

No description given by bungie.

 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/tokens.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
64
65
66
67
68
69
async def claim_partner_offer(
    self, partner_offer_id: str, bungie_net_membership_id: int, transaction_id: str, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Claim a partner offer as the authenticated user.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

    Args:
        partner_offer_id: _No description given by bungie._
        bungie_net_membership_id: _No description given by bungie._
        transaction_id: _No description given by bungie._
        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
    """

    data = {
        "PartnerOfferId": partner_offer_id,
        "BungieNetMembershipId": bungie_net_membership_id,
        "TransactionId": transaction_id,
    }

    return await self.request(Route(path="/Tokens/Partner/ClaimOffer/", method="POST", data=data, auth=auth))

force_drops_repair(auth, *args, **kwargs) async

Twitch Drops self-repair function - scans twitch for drops not marked as fulfilled and resyncs them.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name Type Description Default
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/tokens.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
async def force_drops_repair(self, auth: AuthData, *args, **kwargs) -> dict:
    """
    Twitch Drops self-repair function - scans twitch for drops not marked as fulfilled and resyncs them.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

    Args:
        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="/Tokens/Partner/ForceDropsRepair/", method="POST", auth=auth))

get_bungie_rewards_for_platform_user(membership_id, membership_type, auth, *args, **kwargs) async

Returns the bungie rewards for the targeted user when a platform membership Id and Type are used.

Requires Authentication.

Required oauth2 scopes: ReadAndApplyTokens

Parameters:

Name Type Description Default
membership_id int

users platform membershipId for requested user rewards. If not self, elevated permissions are required.

 required
membership_type int

The target Destiny 2 membership type.

 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/tokens.py 
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
async def get_bungie_rewards_for_platform_user(
    self, membership_id: int, membership_type: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Returns the bungie rewards for the targeted user when a platform membership Id and Type are used.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadAndApplyTokens

    Args:
        membership_id: users platform membershipId for requested user rewards. If not self, elevated permissions are required.
        membership_type: The target Destiny 2 membership type.
        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"/Tokens/Rewards/GetRewardsForPlatformUser/{membership_id}/{membership_type}/",
            method="GET",
            auth=auth,
        )
    )

get_bungie_rewards_for_user(membership_id, auth, *args, **kwargs) async

Returns the bungie rewards for the targeted user.

Requires Authentication.

Required oauth2 scopes: ReadAndApplyTokens

Parameters:

Name Type Description Default
membership_id int

bungie.net user membershipId for requested user rewards. If not self, elevated permissions are required.

 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/tokens.py 
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
async def get_bungie_rewards_for_user(self, membership_id: int, auth: AuthData, *args, **kwargs) -> dict:
    """
    Returns the bungie rewards for the targeted user.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadAndApplyTokens

    Args:
        membership_id: bungie.net user membershipId for requested user rewards. If not self, elevated permissions are required.
        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"/Tokens/Rewards/GetRewardsForUser/{membership_id}/", method="GET", auth=auth)
    )

get_bungie_rewards_list(auth=None, *args, **kwargs) async

Returns a list of the current bungie rewards

Parameters:

Name Type Description Default
auth Optional[AuthData]

Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

 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/tokens.py 
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
async def get_bungie_rewards_list(self, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Returns a list of the current bungie rewards

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    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="/Tokens/Rewards/BungieRewards/", method="GET", auth=auth))

get_partner_offer_sku_history(partner_application_id, target_bnet_membership_id, auth, *args, **kwargs) async

Returns the partner sku and offer history of the targeted user. Elevated permissions are required to see users that are not yourself.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name Type Description Default
partner_application_id int

The partner application identifier.

 required
target_bnet_membership_id int

The bungie.net user to apply missing offers to. If not self, elevated permissions are required.

 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/tokens.py 
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
async def get_partner_offer_sku_history(
    self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Returns the partner sku and offer history of the targeted user. Elevated permissions are required to see users that are not yourself.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

    Args:
        partner_application_id: The partner application identifier.
        target_bnet_membership_id: The bungie.net user to apply missing offers to. If not self, elevated permissions are required.
        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"/Tokens/Partner/History/{partner_application_id}/{target_bnet_membership_id}/",
            method="GET",
            auth=auth,
        )
    )

get_partner_reward_history(partner_application_id, target_bnet_membership_id, auth, *args, **kwargs) async

Returns the partner rewards history of the targeted user, both partner offers and Twitch drops.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name Type Description Default
partner_application_id int

The partner application identifier.

 required
target_bnet_membership_id int

The bungie.net user to return reward history for.

 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/tokens.py 
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
async def get_partner_reward_history(
    self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Returns the partner rewards history of the targeted user, both partner offers and Twitch drops.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

    Args:
        partner_application_id: The partner application identifier.
        target_bnet_membership_id: The bungie.net user to return reward history for.
        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"/Tokens/Partner/History/{target_bnet_membership_id}/Application/{partner_application_id}/",
            method="GET",
            auth=auth,
        )
    )