Modules
Orderly network perp.positions
Orderly SDKs / Modules / @orderly.network/perp / positions
Namespace: positions
@orderly.network/perp.positionsTable of contents
Type Aliases
- LiqPriceInputs
- MMInputs
- MMRInputs
- TotalUnsettlementPnLInputs
- UnrealPnLInputs
- UnrealPnLROIInputs
- UnsettlementPnLInputs
Functions
- MMR
- estOffsetForTP
- estPnLForSL
- estPnLForTP
- estPriceForTP
- estPriceFromOffsetForTP
- liqPrice
- maintenanceMargin
- notional
- totalNotional
- totalUnrealizedPnL
- totalUnsettlementPnL
- unrealizedPnL
- unrealizedPnLROI
- unsettlementPnL
Type Aliases
LiqPriceInputs
Ƭ LiqPriceInputs:Object
Type declaration
| Name | Type |
|---|---|
MMR | number |
markPrice | number |
positionQty | number |
positions | Pick<PositionExt, "position_qty" | "mark_price" | "mmr">[] |
totalCollateral | number |
Defined in
positions.ts:89MMInputs
Ƭ MMInputs:Object
Type declaration
| Name | Type |
|---|---|
MMR | number |
markPrice | number |
positionQty | number |
Defined in
positions.ts:130MMRInputs
Ƭ MMRInputs:Object
Type declaration
| Name | Type |
|---|---|
IMRFactor | number |
IMR_factor_power | number |
baseIMR | number |
baseMMR | number |
positionNotional | number |
Defined in
positions.ts:213TotalUnsettlementPnLInputs
Ƭ TotalUnsettlementPnLInputs:Object
Type declaration
| Name | Type |
|---|---|
positions | Position & { sum_unitary_funding: number }[] |
sumUnitaryFunding | number |
Defined in
positions.ts:178UnrealPnLInputs
Ƭ UnrealPnLInputs:Object
Type declaration
| Name | Type |
|---|---|
markPrice | number |
openPrice | number |
qty | number |
Defined in
positions.ts:26UnrealPnLROIInputs
Ƭ UnrealPnLROIInputs:Object
Type declaration
| Name | Type |
|---|---|
IMR | number |
openPrice | number |
positionQty | number |
unrealizedPnL | number |
Defined in
positions.ts:43UnsettlementPnLInputs
Ƭ UnsettlementPnLInputs:Object
Type declaration
| Name | Type |
|---|---|
costPosition | number |
lastSumUnitaryFunding | number |
markPrice | number |
positionQty | number |
sumUnitaryFunding | number |
Defined in
positions.ts:147Functions
MMR
▸ MMR(inputs): number
Calculates the maintenance margin requirement (MMR) of a position.
Parameters
| Name | Type | Description |
|---|---|---|
inputs | MMRInputs | The inputs for calculating the MMR. |
Returns
number
The MMR of the position.
Defined in
positions.ts:226estOffsetForTP
▸ estOffsetForTP(inputs): number
Calculates the estimated offset for take profit.
Parameters
| Name | Type |
|---|---|
inputs | Object |
inputs.entryPrice | number |
inputs.price | number |
Returns
number
Defined in
positions.ts:276estPnLForSL
▸ estPnLForSL(inputs): number
Calculates the PnL for stop loss.
Parameters
| Name | Type |
|---|---|
inputs | Object |
inputs.entryPrice | number |
inputs.positionQty | number |
Returns
number
Defined in
positions.ts:296estPnLForTP
▸ estPnLForTP(inputs): number
Calculates the profit or loss for take profit.
Parameters
| Name | Type |
|---|---|
inputs | Object |
inputs.entryPrice | number |
inputs.positionQty | number |
inputs.price | number |
Returns
number
The profit or loss for take profit.
Defined in
positions.ts:249estPriceForTP
▸ estPriceForTP(inputs): number
Calculates the estimated price for take profit.
Parameters
| Name | Type |
|---|---|
inputs | Object |
inputs.entryPrice | number |
inputs.pnl | number |
inputs.positionQty | number |
Returns
number
Defined in
positions.ts:262estPriceFromOffsetForTP
▸ estPriceFromOffsetForTP(inputs): number
Calculates the estimated price from offset for take profit.
Parameters
| Name | Type |
|---|---|
inputs | Object |
inputs.entryPrice | number |
inputs.offset | number |
Returns
number
Defined in
positions.ts:286liqPrice
▸ liqPrice(inputs): number | null
Calculates the liquidation price of a single position.
Parameters
| Name | Type | Description |
|---|---|---|
inputs | LiqPriceInputs | The inputs for calculating the liquidation price. |
Returns
number | null
The liquidation price of the position.
Defined in
positions.ts:102maintenanceMargin
▸ maintenanceMargin(inputs): number
Calculates the maintenance margin of a position.
Parameters
| Name | Type | Description |
|---|---|---|
inputs | MMInputs | The inputs for calculating the maintenance margin. |
Returns
number
The maintenance margin of the position.
Defined in
positions.ts:141notional
▸ notional(qty, mark_price): number
Calculates the notional value of a single position.
Parameters
| Name | Type | Description |
|---|---|---|
qty | number | The quantity of the position. |
mark_price | number | The price of the position. |
Returns
number
The notional value of the position.
Defined in
positions.ts:11totalNotional
▸ totalNotional(positions): number
Calculates the total notional value of all positions.
Parameters
| Name | Type | Description |
|---|---|---|
positions | Position[] | The array of positions. |
Returns
number
The total notional value of all positions.
Defined in
positions.ts:20totalUnrealizedPnL
▸ totalUnrealizedPnL(positions): number
Calculates the total unrealized profit or loss of all positions.
Parameters
| Name | Type | Description |
|---|---|---|
positions | Position[] | The array of positions. |
Returns
number
The total unrealized profit or loss of all positions.
Defined in
positions.ts:76totalUnsettlementPnL
▸ totalUnsettlementPnL(positions): number
Calculates the total unrealized profit or loss of all positions.
Parameters
| Name | Type | Description |
|---|---|---|
positions | Position & { sum_unitary_funding: number }[] | The array of positions. |
Returns
number
The total unrealized profit or loss of all positions.
Defined in
positions.ts:190unrealizedPnL
▸ unrealizedPnL(inputs): number
Calculates the unrealized profit or loss of a single position.
Parameters
| Name | Type | Description |
|---|---|---|
inputs | UnrealPnLInputs | The inputs for calculating the unrealized profit or loss. |
Returns
number
The unrealized profit or loss of the position.
Defined in
positions.ts:37unrealizedPnLROI
▸ unrealizedPnLROI(inputs): number
Calculates the return on investment (ROI) of a single position’s unrealized profit or loss.
Parameters
| Name | Type | Description |
|---|---|---|
inputs | UnrealPnLROIInputs | The inputs for calculating the ROI. |
Returns
number
The ROI of the position’s unrealized profit or loss.
Defined in
positions.ts:55unsettlementPnL
▸ unsettlementPnL(inputs): number
Calculates the unrealized profit or loss of each position.
Parameters
| Name | Type | Description |
|---|---|---|
inputs | UnsettlementPnLInputs | The inputs for calculating the unrealized profit or loss. |
Returns
number
The unrealized profit or loss of each position.