Class AccountAdjustmentPositionOperation

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

Constructors

constructor

Accessors

averageEntryPrice collateralAsset leverage mode settlementAsset underlyingAsset

Methods

[dispose] clone free

Constructors

constructor

Accessors

averageEntryPrice

  • get averageEntryPrice(): undefined | Price

  • The average entry price, or undefined.

    Returns undefined | Price

  • set averageEntryPrice(value): void

  • Sets the average entry price (accepts a value object or DecimalInput).

    Errors

    Throws ParamError on an invalid value.

    Parameters

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

    Returns void

collateralAsset

  • get collateralAsset(): undefined | string

  • The collateral asset, or undefined.

    Returns undefined | string

  • set collateralAsset(value): void

  • Sets the collateral asset.

    Errors

    Throws AssetError when the asset string is empty.

    Parameters

    • value: undefined | null | string

    Returns void

leverage

  • get leverage(): undefined | Leverage

  • The leverage multiplier, or undefined.

    Returns undefined | Leverage

  • set leverage(value): 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:
          | undefined
          | null
          | string
          | number
          | bigint
          | Leverage

    Returns void

mode

  • get mode(): undefined | string

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

    Returns undefined | string

  • set mode(value): void

  • Sets the position mode from its wire string.

    Errors

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

    Parameters

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

    Returns void

settlementAsset

  • get settlementAsset(): undefined | string

  • The settlement asset, or undefined.

    Returns undefined | string

  • set settlementAsset(value): void

  • Sets the settlement asset.

    Errors

    Throws AssetError when the asset string is empty.

    Parameters

    • value: undefined | null | string

    Returns void

underlyingAsset

  • get underlyingAsset(): undefined | string

  • The underlying asset, or undefined.

    Returns undefined | string

  • set underlyingAsset(value): void

  • Sets the underlying asset.

    Errors

    Throws AssetError when the asset string is empty.

    Parameters

    • value: undefined | null | string

    Returns void

Methods

[dispose]

  • [dispose](): void

  • Returns void

clone

free

  • free(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods