Firstrade API Node - v1.0.2
    Preparing search index...

    Interface PlaceOrderOptions

    Options for placing an equity order.

    interface PlaceOrderOptions {
        account: string;
        dryRun?: boolean;
        duration: Duration;
        notional?: boolean;
        orderInstruction?: OrderInstructions;
        orderType: OrderType;
        price?: number;
        priceType: PriceType;
        quantity?: number;
        stopPrice?: number;
        symbol: string;
    }
    Index

    Properties

    account: string

    The account number to place the order in.

    dryRun?: boolean

    If True, the order will not be placed but will be built and validated. Defaults to True.

    duration: Duration

    The duration of the order.

    notional?: boolean

    If True, the order will be placed based on a notional dollar amount rather than share quantity. Defaults to False.

    orderInstruction?: OrderInstructions

    Additional order instructions (e.g., AON, OPG).

    orderType: OrderType

    The type of order.

    price?: number

    The price at which to buy or sell the shares.

    priceType: PriceType

    The price type for the order.

    quantity?: number

    The number of shares to buy or sell.

    stopPrice?: number

    The stop price for stop orders.

    symbol: string

    The ticker symbol for the order.