Binance Web3 Connector JS
    Preparing search index...

    Interface PositionRespPositionDetail

    Position-level metadata. Present for concentrated-liquidity / locked / farming positions; null otherwise. Fields are null when not applicable to the position type.

    PositionRespPositionDetail

    interface PositionRespPositionDetail {
        active?: boolean | null;
        claimTypes?:
            | Web3WalletRestAPI.PositionRespPositionDetailClaimTypesEnum[]
            | null;
        nftId?: string
        | null;
        positionIndex?: string | null;
        proofs?: { [key: string]: string[] | undefined } | null;
        redemptionId?: string | null;
        stakeState?: string | null;
        tickLower?: string | null;
        tickUpper?: string | null;
        unlockTime?: string | null;
        unlockTimeReached?: boolean | null;
    }
    Index
    active? claimTypes? nftId? positionIndex? proofs? redemptionId? stakeState? tickLower? tickUpper? unlockTime? unlockTimeReached?
    active?: boolean | null

    Whether the position is currently in-range (active).

    PositionRespPositionDetail

    claimTypes?: Web3WalletRestAPI.PositionRespPositionDetailClaimTypesEnum[] | null

    Claim types available for this position. Values map to the claimType field of POST /transaction/claim and determine which companion fields a claim requires.

    PositionRespPositionDetail

    nftId?: string | null

    NFT token ID for concentrated-liquidity positions, prefixed with # (e.g. \"#7225901\"). Null for non-NFT positions. The # prefix may be passed as-is to a transaction build endpoint (lp-add / lp-remove / claim LP_FEE) — the service strips it automatically; passing the raw id without # is also accepted.

    PositionRespPositionDetail

    positionIndex?: string | null

    Position index (e.g. the Uniswap-V3-style position number).

    PositionRespPositionDetail

    proofs?: { [key: string]: string[] | undefined } | null

    Merkle proofs keyed by reward token address. Required when claiming PancakeSwap Infinity (V4) rewards.

    PositionRespPositionDetail

    redemptionId?: string | null

    Redemption record ID (for pending redemptions). Null when not a pending redemption.

    PositionRespPositionDetail

    stakeState?: string | null

    Staking lifecycle state. Complete value set: active (earning), deactivating (unstaking in progress, rewards stop), inactive (fully unstaked).

    PositionRespPositionDetail

    tickLower?: string | null

    Lower tick bound for concentrated-liquidity positions.

    PositionRespPositionDetail

    tickUpper?: string | null

    Upper tick bound for concentrated-liquidity positions.

    PositionRespPositionDetail

    unlockTime?: string | null

    Unix timestamp (seconds) when the position unlocks. Null if no lock.

    PositionRespPositionDetail

    unlockTimeReached?: boolean | null

    Whether the unlock time has been reached.

    PositionRespPositionDetail

    Settings
    Member Visibility

    On This Page
    Properties