IAccount (JForex API 2.12.46 API)

```
public interface IAccount
```
Methods of this interface allows to retrieve account information such as current equity

Author:

Denis Larka

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class IAccount.AccountState
Account state: OK, MARGIN_CLOSING, MARGIN_CALL, OK_NO_MARGIN_CALL, DISABLED, BLOCKED.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IAccount.AccountState` Account state: OK, MARGIN_CLOSING, MARGIN_CALL, OK_NO_MARGIN_CALL, DISABLED, BLOCKED.

Method Summary

Methods
Modifier and Type	Method and Description
`ICurrency`	`getAccountCurrency()` Returns account currency
`String`	`getAccountId()` Returns account id
`IAccount.AccountState`	`getAccountState()` Returns account state
`double`	`getBalance()` Returns account balance.
`double`	`getBaseEquity()` Returns current base equity (No open Profit/Loss).
`Set<String>`	`getClientIds()` Deprecated. use `getClients()`
`Set<IClientInfo>`	`getClients()` In case of manager account, returns client info objects for managed accounts.
`double`	`getCreditLine()` Returns current available credit.
`Currency`	`getCurrency()` Deprecated. Use `getAccountCurrency()` instead
`double`	`getEquity()` Returns current equity.
`double`	`getLeverage()` Returns current leverage.
`int`	`getMarginCutLevel()` Returns maximum use of leverage exceeding which will result in margin cut
`int`	`getOverWeekEndLeverage()` Returns maximum use of leverage exceeding which will result in margin cut.
`double`	`getStopLossLevel()` Returns account's equity stop loss level.
`double`	`getUsedMargin()` Returns used margin in account currency
`double`	`getUseOfLeverage()` Returns current use of leverage.
`String`	`getUserName()` Returns user name
`boolean`	`isConnected()` Returns true if account is connected to server
`boolean`	`isGlobal()` Returns true if account is global account

- Method Detail
  - getCurrency
```
Currency getCurrency()
```
    Deprecated. Use getAccountCurrency() instead
  - getAccountCurrency
```
ICurrency getAccountCurrency()
```
    Returns account currency
    
    Returns:
    account currency
  - getEquity
```
double getEquity()
```
    Returns current equity. Value returned by this function is for information purposes and can be incorrect right after order changes, as it is updated about every 5 seconds
    
    Returns:
    equity
  - getBaseEquity
```
double getBaseEquity()
```
    Returns current base equity (No open Profit/Loss).
    Value returned by this function is for information purposes and can be incorrect right after order changes, as it is updated about every 5 seconds.
    
    Returns:
    base equity - equity without open positions' profit/loss
  - getBalance
```
double getBalance()
```
    Returns account balance. The last account balance available is the balance for the previous end-of-day processing.
    
    Returns:
    balance
  - getLeverage
```
double getLeverage()
```
    Returns current leverage. This is fixed value that is set when you sign contract with Dukascopy. Usually has value of 100
    
    Returns:
    leverage
  - getUseOfLeverage
```
double getUseOfLeverage()
```
    Returns current use of leverage. Value returned by this function is for information purposes and can be incorrect right after order changes, as it is updated about every 5 seconds
    
    Returns:
    leverage
  - getCreditLine
```
double getCreditLine()
```
    Returns current available credit. Value returned by this function is for information purposes and can be incorrect right after order changes, as it is updated about every 5 seconds
    
    Returns:
    available credit
  - getMarginCutLevel
```
int getMarginCutLevel()
```
    Returns maximum use of leverage exceeding which will result in margin cut
    
    Returns:
    maximum use of leverage before margin cuts
  - getOverWeekEndLeverage
```
int getOverWeekEndLeverage()
```
    Returns maximum use of leverage exceeding which will result in margin cut. Value effective before weekends
    
    Returns:
    maximum use of leverage before margin cuts at weekends
  - isGlobal
```
boolean isGlobal()
```
    Returns true if account is global account
    
    Returns:
    true if account is global account
  - getAccountId
```
String getAccountId()
```
    Returns account id
    
    Returns:
    account id
  - getClientIds
```
@Deprecated
Set<String> getClientIds()
```
    Deprecated. use getClients()
    
    In case of manager account, returns managed accounts client ids. In case of self trader account, returns own client id.
    
    Returns:
    set of client ids
  - getClients
```
Set<IClientInfo> getClients()
```
    In case of manager account, returns client info objects for managed accounts. In case of self trader account, returns client info object for own account.
    
    Returns:
    a set of clients
  - getAccountState
```
IAccount.AccountState getAccountState()
```
    Returns account state
    
    Returns:
    account state
  - getStopLossLevel
```
double getStopLossLevel()
```
    Returns account's equity stop loss level. The equity stop loss level is in the account base currency and define an absolute level of equity from or under which the account will be stopped and their exposures closed.
    
    Returns:
    account equity stop loss level
  - isConnected
```
boolean isConnected()
```
    Returns true if account is connected to server
    
    Returns:
    true if account is connected to server, false - otherwise
  - getUserName
```
String getUserName()
```
    Returns user name
    
    Returns:
    user name
  - getUsedMargin
```
double getUsedMargin()
```
    Returns used margin in account currency
    
    Returns:
    used margin

Interface IAccount

Nested Class Summary

Method Summary

Method Detail

getCurrency

getAccountCurrency

getEquity

getBaseEquity

getBalance

getLeverage

getUseOfLeverage

getCreditLine

getMarginCutLevel

getOverWeekEndLeverage

isGlobal

getAccountId

getClientIds

getClients

getAccountState

getStopLossLevel

isConnected

getUserName

getUsedMargin