@openpit/engine
    Preparing search index...

    Class AccountAdjustmentPositionOperation

    Position-scoped adjustment operation: instrument, collateral, price, mode, and leverage.

    Index
    constructor
    averageEntryPrice collateralAsset leverage mode settlementAsset underlyingAsset
    [dispose] clone free
    • get averageEntryPrice(): Price | undefined

      The account-currency average entry price, or undefined.

      Returns Price | undefined

    • set averageEntryPrice(
          value: string | number | bigint | Price | null | undefined,
      ): void

      Sets the account-currency average entry price (accepts a value object or DecimalInput). No FX is applied.

      Errors

      Throws ParamError on an invalid value.

      Parameters

      • value: string | number | bigint | Price | null | undefined

      Returns void

    • get collateralAsset(): string | undefined

      The collateral asset, or undefined.

      Returns string | undefined

    • set collateralAsset(value: string | null | undefined): void

      Sets the collateral asset.

      Errors

      Throws AssetError when the asset string is empty.

      Parameters

      • value: string | null | undefined

      Returns void

    • get leverage(): Leverage | undefined

      The leverage multiplier, or undefined.

      Returns Leverage | undefined

    • set leverage(
          value: string | number | bigint | Leverage | null | undefined,
      ): void

      Sets the leverage (accepts a Leverage object or a number/bigint/string multiplier).

      Errors

      Throws ParamError on an out-of-range leverage value.

      Parameters

      • value: string | number | bigint | Leverage | null | undefined

      Returns void

    • get mode(): string | undefined

      The position mode wire string ("netting"/"hedged"), or undefined.

      Returns string | undefined

    • set mode(value: "netting" | "hedged" | null | undefined): void

      Sets the position mode from its wire string.

      Errors

      Throws ParamError when value is not "netting"/"hedged".

      Parameters

      • value: "netting" | "hedged" | null | undefined

      Returns void

    • get settlementAsset(): string | undefined

      The settlement asset, or undefined.

      Returns string | undefined

    • set settlementAsset(value: string | null | undefined): void

      Sets the settlement asset.

      Errors

      Throws AssetError when the asset string is empty.

      Parameters

      • value: string | null | undefined

      Returns void

    • get underlyingAsset(): string | undefined

      The underlying asset, or undefined.

      Returns string | undefined

    • set underlyingAsset(value: string | null | undefined): void

      Sets the underlying asset.

      Errors

      Throws AssetError when the asset string is empty.

      Parameters

      • value: string | null | undefined

      Returns void

    • Returns void

    • Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods