> ## Documentation Index
> Fetch the complete documentation index at: https://staging-docs.orderly.network/llms.txt
> Use this file to discover all available pages before exploring further.

# Orderly network perp.orderUtils

[Orderly SDKs](/sdks/tech-doc/README) / [Modules](/sdks/tech-doc/modules) / [@orderly.network/perp](/sdks/tech-doc/modules/orderly_network_perp) / orderUtils

# Namespace: orderUtils

[@orderly.network/perp](/sdks/tech-doc/modules/orderly_network_perp).orderUtils

## Table of contents

### Type Aliases

* [EstimatedLeverageInputs](/sdks/tech-doc/modules/orderly_network_perp.orderUtils#estimatedleverageinputs)
* [EstimatedLiquidationPriceInputs](/sdks/tech-doc/modules/orderly_network_perp.orderUtils#estimatedliquidationpriceinputs)

### Functions

* [estLeverage](/sdks/tech-doc/modules/orderly_network_perp.orderUtils#estleverage)
* [estLiqPrice](/sdks/tech-doc/modules/orderly_network_perp.orderUtils#estliqprice)
* [maxPrice](/sdks/tech-doc/modules/orderly_network_perp.orderUtils#maxprice)
* [minPrice](/sdks/tech-doc/modules/orderly_network_perp.orderUtils#minprice)
* [orderFee](/sdks/tech-doc/modules/orderly_network_perp.orderUtils#orderfee)
* [scropePrice](/sdks/tech-doc/modules/orderly_network_perp.orderUtils#scropeprice)

## Type Aliases

### EstimatedLeverageInputs

Ƭ **EstimatedLeverageInputs**: `Object`

#### Type declaration

| Name              | Type                                                                                                                                           |
| :---------------- | :--------------------------------------------------------------------------------------------------------------------------------------------- |
| `newOrder`        | \{ `price`: `number` ; `qty`: `number` ; `symbol`: `string` }                                                                                  |
| `newOrder.price`  | `number`                                                                                                                                       |
| `newOrder.qty`    | `number`                                                                                                                                       |
| `newOrder.symbol` | `string`                                                                                                                                       |
| `positions`       | `Pick`\<[`PositionExt`](/sdks/tech-doc/interfaces/orderly_network_types.API.PositionExt), `"position_qty"` \| `"mark_price"` \| `"symbol"`>\[] |
| `totalCollateral` | `number`                                                                                                                                       |

#### Defined in

[order.ts:157](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/perp/src/order.ts#L157)

***

### EstimatedLiquidationPriceInputs

Ƭ **EstimatedLiquidationPriceInputs**: `Object`

#### Type declaration

| Name              | Type                                                                                                                                                      |
| :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `IMR_Factor`      | `number`                                                                                                                                                  |
| `baseIMR`         | `number`                                                                                                                                                  |
| `baseMMR`         | `number`                                                                                                                                                  |
| `markPrice`       | `number`                                                                                                                                                  |
| `newOrder`        | \{ `price`: `number` ; `qty`: `number` ; `symbol`: `string` }                                                                                             |
| `newOrder.price`  | `number`                                                                                                                                                  |
| `newOrder.qty`    | `number`                                                                                                                                                  |
| `newOrder.symbol` | `string`                                                                                                                                                  |
| `orderFee`        | `number`                                                                                                                                                  |
| `positions`       | `Pick`\<[`PositionExt`](/sdks/tech-doc/interfaces/orderly_network_types.API.PositionExt), `"position_qty"` \| `"mark_price"` \| `"symbol"` \| `"mmr"`>\[] |
| `totalCollateral` | `number`                                                                                                                                                  |

#### Defined in

[order.ts:51](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/perp/src/order.ts#L51)

## Functions

### estLeverage

▸ **estLeverage**(`inputs`): `number` | `null`

Estimated leverage

#### Parameters

| Name     | Type                                                                                                        | Description            |
| :------- | :---------------------------------------------------------------------------------------------------------- | :--------------------- |
| `inputs` | [`EstimatedLeverageInputs`](/sdks/tech-doc/modules/orderly_network_perp.orderUtils#estimatedleverageinputs) | EstimtedLeverageInputs |

#### Returns

`number` | `null`

number

#### Defined in

[order.ts:175](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/perp/src/order.ts#L175)

***

### estLiqPrice

▸ **estLiqPrice**(`inputs`): `number`

Estimated liquidation price

#### Parameters

| Name     | Type                                                                                                                        |
| :------- | :-------------------------------------------------------------------------------------------------------------------------- |
| `inputs` | [`EstimatedLiquidationPriceInputs`](/sdks/tech-doc/modules/orderly_network_perp.orderUtils#estimatedliquidationpriceinputs) |

#### Returns

`number`

#### Defined in

[order.ts:74](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/perp/src/order.ts#L74)

***

### maxPrice

▸ **maxPrice**(`markprice`, `range`): `number`

Maximum price when placing an order

#### Parameters

| Name        | Type     |
| :---------- | :------- |
| `markprice` | `number` |
| `range`     | `number` |

#### Returns

`number`

#### Defined in

[order.ts:8](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/perp/src/order.ts#L8)

***

### minPrice

▸ **minPrice**(`markprice`, `range`): `number`

Minimum price when placing an order

#### Parameters

| Name        | Type     |
| :---------- | :------- |
| `markprice` | `number` |
| `range`     | `number` |

#### Returns

`number`

#### Defined in

[order.ts:15](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/perp/src/order.ts#L15)

***

### orderFee

▸ **orderFee**(`inputs`): `number`

Calculate the order fee

#### Parameters

| Name                        | Type     | Description    |
| :-------------------------- | :------- | :------------- |
| `inputs`                    | `Object` | -              |
| `inputs.futuresTakeFeeRate` | `number` | -              |
| `inputs.price`              | `number` | -              |
| `inputs.qty`                | `number` | Order quantity |

#### Returns

`number`

#### Defined in

[order.ts:37](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/perp/src/order.ts#L37)

***

### scropePrice

▸ **scropePrice**(`price`, `scrope`, `side`): `number`

Scrope price when placing an order

#### Parameters

| Name     | Type                |
| :------- | :------------------ |
| `price`  | `number`            |
| `scrope` | `number`            |
| `side`   | `"BUY"` \| `"SELL"` |

#### Returns

`number`

number

#### Defined in

[order.ts:23](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/perp/src/order.ts#L23)