Orderly SDKs / Modules / @orderly.network/types / BaseAlgoOrderEntity

​

Interface: BaseAlgoOrderEntity<T>

@orderly.network/types.BaseAlgoOrderEntity

​

Type parameters

Name	Type
T	extends AlgoOrderRootType

​

Hierarchy

• OrderEntity ↳ BaseAlgoOrderEntity

​

Table of contents

​

Properties

• algo_order_id
• algo_type
• broker_id
• child_orders
• client_order_id
• isStopOrder
• is_activated
• order_amount
• order_price
• order_quantity
• order_tag
• order_type
• order_type_ext
• price
• quantity
• reduce_only
• side
• sl_trigger_price
• symbol
• total
• tp_trigger_price
• trigger_price
• trigger_price_type
• type
• visible_quantity

​

Properties

​

algo_order_id

• Optional algo_order_id: number

​

Defined in

packages/types/src/order.ts:99

---

​

algo_type

• algo_type: AlgoOrderRootType

​

Overrides

OrderEntity.algo_type

​

Defined in

packages/types/src/order.ts:92

---

​

broker_id

• Optional broker_id: string

​

Inherited from

OrderEntity.broker_id

​

Defined in

packages/types/src/order.ts:74

---

​

child_orders

• child_orders: Partial<Omit<AlgoOrderEntity<T>, "algo_type" | "type">> & { algo_type: AlgoOrderType ; type: OrderType }[]

​

Defined in

packages/types/src/order.ts:93

---

​

client_order_id

• Optional client_order_id: string

​

Defined in

packages/types/src/order.ts:100

---

​

isStopOrder

• Optional isStopOrder: boolean

​

Inherited from

OrderEntity.isStopOrder

​

Defined in

packages/types/src/order.ts:79

---

​

is_activated

• Optional is_activated: boolean

​

Defined in

packages/types/src/order.ts:111

---

​

order_amount

• Optional order_amount: number

​

Inherited from

OrderEntity.order_amount

​

Defined in

packages/types/src/order.ts:69

---

​

order_price

• Optional order_price: string | number

​

Inherited from

OrderEntity.order_price

​

Defined in

packages/types/src/order.ts:67

---

​

order_quantity

• Optional order_quantity: string | number

​

Inherited from

OrderEntity.order_quantity

​

Defined in

packages/types/src/order.ts:68

---

​

order_tag

• Optional order_tag: string

​

Overrides

OrderEntity.order_tag

​

Defined in

packages/types/src/order.ts:101

---

​

order_type

• order_type: OrderType

​

Inherited from

OrderEntity.order_type

​

Defined in

packages/types/src/order.ts:64

---

​

order_type_ext

• Optional order_type_ext: OrderType

​

Inherited from

OrderEntity.order_type_ext

​

Defined in

packages/types/src/order.ts:66

---

​

price

• Optional price: string | number

​

Defined in

packages/types/src/order.ts:102

---

​

quantity

• quantity: string | number

​

Defined in

packages/types/src/order.ts:103

---

​

reduce_only

• Optional reduce_only: boolean

​

Overrides

OrderEntity.reduce_only

​

Defined in

packages/types/src/order.ts:104

---

​

side

• side: OrderSide

​

Overrides

OrderEntity.side

​

Defined in

packages/types/src/order.ts:105

---

​

sl_trigger_price

• Optional sl_trigger_price: string | number

​

Defined in

packages/types/src/order.ts:113

---

​

symbol

• symbol: string

​

Overrides

OrderEntity.symbol

​

Defined in

packages/types/src/order.ts:106

---

​

total

• Optional total: string | number

​

Inherited from

OrderEntity.total

​

Defined in

packages/types/src/order.ts:77

---

​

tp_trigger_price

• Optional tp_trigger_price: string | number

​

Defined in

packages/types/src/order.ts:112

---

​

trigger_price

• trigger_price: string | number

​

Overrides

OrderEntity.trigger_price

​

Defined in

packages/types/src/order.ts:107

---

​

trigger_price_type

• trigger_price_type: MARK_PRICE

​

Defined in

packages/types/src/order.ts:108

---

​

type

• type: OrderType

​

Defined in

packages/types/src/order.ts:109

---

​

visible_quantity

• Optional visible_quantity: number

​

Overrides

OrderEntity.visible_quantity

​

Defined in

packages/types/src/order.ts:110