Interface BracketOrderRequest

An entry whose stop and target legs the provider places and links itself.

interface BracketOrderRequest {
    account?: string;
    clientToken?: string;
    duration?: OrderDuration;
    exchange?: string;
    expiresAt?: number;
    leverage?: number;
    price?: number;
    product?: "CNC" | "NRML" | "MIS";
    qty: number;
    side: OrderSide;
    stopLoss: number;
    symbol: string;
    takeProfit: number;
    triggerPrice?: number;
    type: OrderType;
}

Hierarchy (View Summary)

Properties

account? clientToken? duration? exchange? expiresAt? leverage? price? product? qty side stopLoss symbol takeProfit triggerPrice? type

Properties

Optionalaccount

account?: string

The account the order is for. Needs the accounts feature; never dropped on the way to the wire.

OptionalclientToken

clientToken?: string

Idempotency token; a retry with the same token is never double-sent.

Optionalduration

duration?: OrderDuration

Time in force. Omitted leaves the provider's own default. Needs the provider to list it.

Optionalexchange

exchange?: string

OptionalexpiresAt

expiresAt?: number

When a GTD order lapses, UTC seconds. Only with GTD.

Optionalleverage

leverage?: number

Margin multiplier to request. Needs the leverage feature.

Optionalprice

price?: number

Optionalproduct

product?: "CNC" | "NRML" | "MIS"

Product: CNC (delivery), NRML (F&O carry), MIS (intraday). Required by OpenAlgo.

qty

qty: number

side

side: OrderSide

stopLoss

stopLoss: number

Trigger of the protective stop leg.

symbol

symbol: string

takeProfit

takeProfit: number

Limit price of the target leg.

OptionaltriggerPrice

triggerPrice?: number

type

type: OrderType

Settings

Member Visibility

On This Page

Properties