Binance Web3 Connector JS
    Preparing search index...

    Interface PositionResp

    A single DeFi position with underlying asset and token breakdown.

    PositionResp

    interface PositionResp {
        assetType?: string | null;
        investmentIds?: string[];
        positionDetail?: PositionRespPositionDetail | null;
        positionId?: string;
        positionValue?: string;
        tokenList?: PositionRespTokenList;
        underlyingAssetId?: string;
        underlyingAssetName?: string;
    }
    Index
    assetType? investmentIds? positionDetail? positionId? positionValue? tokenList? underlyingAssetId? underlyingAssetName?
    assetType?: string | null

    Asset structure type. Null for a regular position; locked for a locked position (e.g. locked staking — check unlockTime on positionDetail); farming for a MasterChef-style farming position (rewards accrue under the farming_reward token group).

    PositionResp

    investmentIds?: string[]

    Related investment IDs (64-char hex, no 0x prefix). Use with POST /api/v1/defi/data/investment/detail. Usually a single entry; a position can relate to several investments when the pool stacks products on top of each other (e.g. a farming position wraps the underlying LP investment plus its incentive product, or a staked vault layers a receipt token over the base deposit). When there are several, query each with investment/detail and pick by the action you want to perform — redeeming the principal uses the base investment, claiming farming incentives uses the incentive one.

    PositionResp

    positionDetail?: PositionRespPositionDetail | null

    PositionResp

    positionId?: string

    Unique position identifier (64-char hex, no 0x prefix).

    PositionResp

    positionValue?: string

    Total position value in USD (sum of all token values; may be negative for borrow positions).

    PositionResp

    tokenList?: PositionRespTokenList

    PositionResp

    underlyingAssetId?: string

    Underlying asset identifier (64-char hex, no 0x prefix). Hashed from the pool and underlying token addresses.

    PositionResp

    underlyingAssetName?: string

    Display name of the underlying asset (e.g. "USDT-USDC", "lisUSD").

    PositionResp

    Settings
    Member Visibility

    On This Page
    Properties