com.lmax.api.account
Interface AccountStateEvent


public interface AccountStateEvent

A event that contains all of the top level information about an account's current state.


Method Summary
 long getAccountId()
          Get the account id that this event pertains to.
 FixedPointNumber getAvailableFunds()
          Get the account's available funds.
 FixedPointNumber getAvailableToWithdraw()
          Get the amount that this account is available to withdraw.
 FixedPointNumber getBalance()
          Get the accounts current balance.
 FixedPointNumber getMargin()
          Get the account's total margin.
 FixedPointNumber getUnrealisedProfitAndLoss()
          Get a signed amount that is the account's unrealised profit (or loss).
 java.util.Map<java.lang.String,FixedPointNumber> getWallets()
          Get the account's balances by currency.
 

Method Detail

getAccountId

long getAccountId()
Get the account id that this event pertains to.

Returns:
account id

getBalance

FixedPointNumber getBalance()
Get the accounts current balance.

Returns:
account balance

getAvailableFunds

FixedPointNumber getAvailableFunds()
Get the account's available funds.

Returns:
available funds

getAvailableToWithdraw

FixedPointNumber getAvailableToWithdraw()
Get the amount that this account is available to withdraw.

Returns:
available to withdraw

getUnrealisedProfitAndLoss

FixedPointNumber getUnrealisedProfitAndLoss()
Get a signed amount that is the account's unrealised profit (or loss).

Returns:
unrealised profit (or loss)

getMargin

FixedPointNumber getMargin()
Get the account's total margin.

Returns:
margin

getWallets

java.util.Map<java.lang.String,FixedPointNumber> getWallets()
Get the account's balances by currency. The map is keyed by 3 letter currency symbol, e.g. GBP.

Returns:
map of currency code to wallet balance