Balance (balance)

Get user account balance

Auth Scope(s): read, trading_information

balance(account: Optional[str] = None, subscribe: Optional[Union[bool, int]] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int
Parameters:
  • account (Optional[str]) – [Optional] If set to all, return the balances of all accounts one by one; if set to current, return the balance of current account; if set as an account id, return the balance of that account.
  • subscribe (Optional[Union[bool, int]]) – [Optional] If set to 1, will send updates whenever the balance changes.
  • passthrough (Optional[Any]) – [Optional] Used to pass data through the websocket, which may be retrieved via the echo_req output field.
  • req_id (Optional[int]) – [Optional] Used to map request to response.
Returns:

req_id
Return type:

int

Example

binary.api.balance(
    subscribe=1
)

See also