Chartbreaker
    Preparing search index...

    Interface Exchange

    interface Exchange {
        additionalExchangeIds?: string[];
        allowsComment?: boolean;
        allowsIfDoneLimit?: boolean;
        allowsQuoteModeLimit?: boolean;
        allowsStopLoss?: boolean | Direction;
        allowsTakeProfit?: boolean | Direction;
        allowsTakeProfitXorStopLoss?: boolean;
        brokerExchangeId: string;
        cashQuotationsByOrderModel?: { [k: string]: CashQuotation[] };
        clearingAccountNoOptions?: Options;
        currencyIso: string;
        defaultValidityByOrderModel?: Partial<Record<OrderModel, OrderValidity>>;
        exchangeId?: string;
        hideOrderModel?: boolean;
        label: string;
        legalMessagesToConfirmByOrderModel?: Partial<Record<OrderModel, string>>;
        noValidityForOrderModels?: OrderModel[];
        orderExtensionsByOrderModel?: { [k: string]: OrderExtension[] };
        orderModelsBuy: OrderModel[];
        orderModelsSell: OrderModel[];
        orderModelsTakeProfitStopLoss?: OrderModel[];
        pxTransactionCrossRate?: PxTransactionCrossRate;
        validityTypes?: OrderValidityType[];
        validityTypesByOrderModel?: Partial<
            Record<OrderModel, OrderValidityType[]>,
        >;
    }
    Index

    Properties

    additionalExchangeIds? allowsComment? allowsIfDoneLimit? allowsQuoteModeLimit? allowsStopLoss? allowsTakeProfit? allowsTakeProfitXorStopLoss? brokerExchangeId cashQuotationsByOrderModel? clearingAccountNoOptions? currencyIso defaultValidityByOrderModel? exchangeId? hideOrderModel? label legalMessagesToConfirmByOrderModel? noValidityForOrderModels? orderExtensionsByOrderModel? orderModelsBuy orderModelsSell orderModelsTakeProfitStopLoss? pxTransactionCrossRate? validityTypes? validityTypesByOrderModel?

    Properties

    additionalExchangeIds?: string[]

    If more than one external ExchangeId can be matched, contains the additional matching exchange ids.

    allowsComment?: boolean

    True if the exchange allows to add a comment to orders.

    allowsIfDoneLimit?: boolean

    If this is true, limit buy orders may have the additional "ifDoneLimit" set.

    allowsQuoteModeLimit?: boolean

    If true, quote orders can be created with quoteMode=limit and quoteOrderOpts.quoteLimit set to a limit.

    allowsStopLoss?: boolean | Direction

    Whether stopLoss is allowed. true to allow for both buy and sell, 'buy' or 'sell' to only allow it for the given direction.

    allowsTakeProfit?: boolean | Direction

    Whether takeProfit is allowed. true to allow for both buy and sell, 'buy' or 'sell' to only allow it for the given direction.

    allowsTakeProfitXorStopLoss?: boolean

    If both allowsTakeProfit and allowsStopLoss are true, it is possible that the broker only supports either take profit or stop loss, not a combination of both values. In this case, allowsTakeProfitXorStopLoss is true. The frontend should reflect this in the UI (e.g. by disabling the other field as soon as one is filled out).

    brokerExchangeId: string

    internal id of the exchange (at the given broker)

    cashQuotationsByOrderModel?: { [k: string]: CashQuotation[] }
    clearingAccountNoOptions?: Options

    If set, the user can choose from these options for their cashAccountId. The order must have clearingAccountNo set to one of the option's id.

    This overrides the field PreparedInstrument.clearingAccountNoOptions!

    currencyIso: string
    defaultValidityByOrderModel?: Partial<Record<OrderModel, OrderValidity>>

    If present, contains default values for validity based on the orderModel.

    exchangeId?: string

    matching exchange id as defined per the "instruments" dependency, if at least one can be matched.

    hideOrderModel?: boolean

    only one orderModel is available and it should not be displayed to the user (e.g. for fund orders...)

    label: string
    legalMessagesToConfirmByOrderModel?: Partial<Record<OrderModel, string>>

    Legal messages that have to be confirmed by the user actively before creating an order, by orderModel.

    noValidityForOrderModels?: OrderModel[]

    No validity setting available for the given orderModels for this exchange.

    please use validityTypesByOrderModel instead.

    orderExtensionsByOrderModel?: { [k: string]: OrderExtension[] }
    orderModelsBuy: OrderModel[]
    orderModelsSell: OrderModel[]
    orderModelsTakeProfitStopLoss?: OrderModel[]

    If defined and allowsTakeProfit or allowsStopLoss, availability of TP/SL is restricted to these OrderModels.

    pxTransactionCrossRate?: PxTransactionCrossRate

    for orderModel "pxTransaction", field "pxCrossRate" should contain the given cross rate, if this is set.

    validityTypes?: OrderValidityType[]

    please use validityTypesByOrderModel instead.

    validityTypesByOrderModel?: Partial<Record<OrderModel, OrderValidityType[]>>

    Settings

    Member Visibility

    On This Page

    Properties