Skip to content

API Reference


API Reference / OrderPreviewResult

Interface: OrderPreviewResult ​

Defined in: src/agent/OrderPreview.ts:9

Properties ​

valid ​

valid: boolean

Defined in: src/agent/OrderPreview.ts:10


errors ​

errors: string[]

Defined in: src/agent/OrderPreview.ts:11


warnings ​

warnings: string[]

Defined in: src/agent/OrderPreview.ts:12


action ​

action: "place_order"

Defined in: src/agent/OrderPreview.ts:13


risk ​

risk: "live_order_requires_confirmation"

Defined in: src/agent/OrderPreview.ts:14


requires ​

requires: string[]

Defined in: src/agent/OrderPreview.ts:15


summary ​

summary: string

Defined in: src/agent/OrderPreview.ts:16


riskChecks? ​

optional riskChecks?: object[]

Defined in: src/agent/OrderPreview.ts:17

check ​

check: string

message ​

message: string


order ​

order: Record<string, unknown>

Defined in: src/agent/OrderPreview.ts:18

Community project — not affiliated with Dhan. MIT License.