Method EconomyGetVirtualCurrencyBalances

EconomyGetVirtualCurrencyBalances(String)

Gets the amount of currencies that the player has in their account.

Declaration

public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.CurrencySnapshot,Den.Dev.Grunt.Models.RawResponseContainer>> EconomyGetVirtualCurrencyBalances (string player);

Parameters

Type	Name	Description
System.String	player	The unique player XUID, in the format "xuid(XUID_VALUE)".

Returns

Type	Description
System.Threading.Tasks.Task<HaloApiResultContainer<CurrencySnapshot,RawResponseContainer>>	If successful, returns an instance of CurrencySnapshot that contains the balances. Otherwise, returns null.

Examples

Here is an example response from the API, as snapshotted on 6/14/2022:

{
    "Currencies": [
        {
            "Amount": 0,
            "CurrencyPath": "Currency/Currencies/cR.json"
        },
        {
            "Amount": 3,
            "CurrencyPath": "Currency/Currencies/rerollcurrency.json"
        },
        {
            "Amount": 9,
            "CurrencyPath": "Currency/Currencies/xpboost.json"
        },
        {
            "Amount": 0,
            "CurrencyPath": "Currency/Currencies/xpgrant.json"
        }
    ]
}