IClientInfo (JForex API 2.12.46 API)

```
public interface IClientInfo
```
Contains the account's clients information.

Author:

aburenin

Method Summary

Methods
Modifier and Type	Method and Description
`ICurrency`	`getAccountCurrency()` Returns account currency
`double`	`getBalance()` Returns client's investment balance in the trader base currency. The last client investment balance available is the balance for the previous end-of-day processing.
`double`	`getBaseEquity()` Returns current client's base investment equity (No open Profit/Loss) in the trader base currency. 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.
`String`	`getClientId()` Returns client id
`IAccount.AccountState`	`getClientState()` Returns client state
`Currency`	`getCurrency()` Deprecated. Use `getAccountCurrency()` instead
`double`	`getEquity()` Returns current client's investment equity in the trader base currency. 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
`double`	`getRatio()` Returns the client's market share - a double value with a positive sign, greater than or equal to 0.0 and less than or equal to 1.0.
`double`	`getStopLossLevel()` Returns client's equity stop loss level.

- Method Detail
  - getClientId
```
String getClientId()
```
    Returns client id
    
    Returns:
    client id
  - getClientState
```
IAccount.AccountState getClientState()
```
    Returns client state
    
    Returns:
    client state
  - getCurrency
```
@Deprecated
Currency getCurrency()
```
    Deprecated. Use getAccountCurrency() instead
  - getAccountCurrency
```
ICurrency getAccountCurrency()
```
    Returns account currency
    
    Returns:
    account currency
  - getStopLossLevel
```
double getStopLossLevel()
```
    Returns client's equity stop loss level. The equity stop loss level is in the client base currency and define an absolute level of equity from or under which the client will be stopped and their exposures closed.
    
    Returns:
    client's equity stop loss level
  - getEquity
```
double getEquity()
```
    Returns current client's investment equity in the trader base currency.
    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 client's base investment equity (No open Profit/Loss) in the trader base currency.
    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 client's investment balance in the trader base currency.
    The last client investment balance available is the balance for the previous end-of-day processing.
    
    Returns:
    balance
  - getRatio
```
double getRatio()
```
    Returns the client's market share - a double value with a positive sign, greater than or equal to 0.0 and less than or equal to 1.0.
    
    Returns:
    the client's market share x satisfying to 0.0 <= x <= 1.0 (multiplied by 100 shows the active client ratio in percentages)

Interface IClientInfo

Method Summary

Method Detail

getClientId

getClientState

getCurrency

getAccountCurrency

getStopLossLevel

getEquity

getBaseEquity

getBalance

getRatio