Interface IDEXWallet

The Standard wallet response shape.

See

interface IDEXWallet {
    wallet: string;
    equity: string;
    freeCollateral: string;
    heldCollateral: string;
    availableCollateral: string;
    buyingPower: string;
    leverage: string;
    marginRatio: string;
    quoteBalance: string;
    unrealizedPnL: string;
    makerFeeRate: string;
    takerFeeRate: string;
    positions?: IDEXPosition[];
}

Properties

wallet equity freeCollateral heldCollateral availableCollateral buyingPower leverage marginRatio quoteBalance unrealizedPnL makerFeeRate takerFeeRate positions?

Properties

wallet

wallet: string

Address of the wallet

equity

equity: string

Total account value

freeCollateral

freeCollateral: string

equity - initial margin requirement collateral funds beyond the baseline requirements of open positions

heldCollateral

heldCollateral: string

Free collateral committed to open limit orders

availableCollateral

availableCollateral: string

Free collateral available for order placement or withdrawal

buyingPower

buyingPower: string

(freeCollateral) * (maximum market leverage)

leverage

leverage: string

total absolute position notional value / equity

marginRatio

marginRatio: string

total maintenance margin requirement / equity

quoteBalance

quoteBalance: string

Quote token balance (USDC)

unrealizedPnL

unrealizedPnL: string

Unrealized PnL of all open positions in quote terms at the mark price.

makerFeeRate

makerFeeRate: string

Maker trade fee rate with promotions applied

  • Overrides the "Get Exchange" and "Get Markets" endpoint's maker fee rate.
  • Effective fee rate will be the lowest of the three

takerFeeRate

takerFeeRate: string

Taker trade fee rate with promotions applied

  • Overrides the "Get Exchange" and "Get Markets" endpoint's taker fee rate.
  • Effective fee rate will be the lowest of the three

Optional positions

positions?: IDEXPosition[]

Positions will be included if the request indicated it was interested in them

Settings

Member Visibility

Theme

On This Page

walletequityfreeCollateralheldCollateralavailableCollateralbuyingPowerleveragemarginRatioquoteBalanceunrealizedPnLmakerFeeRatetakerFeeRatepositions