Syntax

exchange.GetAccount

Requests the exchange account information. GetAccount() is a member function of the exchange object exchange and acts only on the account bound to that exchange object (with several accounts, use exchanges[i].GetAccount() to pick one).


    
    
    
exchange.GetAccount()

Examples

Get the available and frozen balance of the current account.


    javascript
    
    
function main() {
    var account = exchange.GetAccount()
    if (!account) return
    Log("Available", account.Balance, "Frozen", account.FrozenBalance)
    // Output: Available <available quote currency> Frozen <frozen quote currency>
}


    python
    
    
def main():
    account = exchange.GetAccount()
    if not account:
        return
    Log("Available", account["Balance"], "Frozen", account["FrozenBalance"])
    # Output: Available <available quote currency> Frozen <frozen quote currency>


    rust
    
    
fn main() {
    let Ok(account) = exchange.GetAccount() else { return };
    Log!("Available", account.Balance, "Frozen", account.FrozenBalance);
    // Output: Available <available quote currency> Frozen <frozen quote currency>
}

Set the trading pair and contract code, and get the current account information.


    javascript
    
    
function main(){
    // Switch the trading pair
    exchange.IO("currency", "BTC_USDT")
    // Taking OKX Futures as an example, set the contract to the current-week contract. The current
    // trading pair is BTC_USDT, so the current contract is the USDT-margined current-week contract
    // of BTC
    exchange.SetContractType("this_week")
    // Get the current account asset data
    var account = exchange.GetAccount()
    // Available balance with USDT as margin
    Log(account.Balance)
    // Frozen amount with USDT as margin
    Log(account.FrozenBalance)
    // Current asset equity
    Log(account.Equity)
    // Unrealized profit and loss of all positions with the current assets as margin
    Log(account.UPnL)
}


    python
    
    
def main():
    exchange.IO("currency", "BTC_USDT")
    exchange.SetContractType("this_week")
    account = exchange.GetAccount()
    Log(account["Balance"])
    Log(account["FrozenBalance"])
    Log(account["Equity"])
    Log(account["UPnL"])


    rust
    
    
fn main() {
    // Switch the trading pair
    exchange.IO(("currency", "BTC_USDT")).unwrap();
    // Taking OKX Futures as an example, set the contract to the current-week contract. The current
    // trading pair is BTC_USDT, so the current contract is the USDT-margined current-week contract
    // of BTC
    exchange.SetContractType("this_week").unwrap();
    // Get the current account asset data
    let account = exchange.GetAccount().unwrap();
    // Available balance with USDT as margin
    Log!(account.Balance);
    // Frozen amount with USDT as margin
    Log!(account.FrozenBalance);
    // Current asset equity
    Log!(account.Equity);
    // Unrealized profit and loss of all positions with the current assets as margin
    Log!(account.UPnL);
}

Returns

Type	Description
`Account` / null value	Queries the account asset information. Returns the `Account` structure when the query succeeds, and returns a null value when the query fails.