Chartbreaker
    Preparing search index...

    Interface Broker

    The Broker provides some meta information and a descriptor (login) of how to acquire a sessionToken which can then be used to create a session via createSession.

    interface Broker {
        brokerName: string;
        isTotalValueAllowed: boolean;
        login: LoginDescriptor;
        sessionExpiredMessage: string;
        supportsOrderListExecutionDetails?: boolean;
        supportsOrderListHistoryCommission?: boolean;
        supportsOrderListHistoryPurchaseQuotationAndDate?: boolean;
        supportsPositionComments?: boolean;
        supportsPositionDividends?: boolean;
        supportsRealtimeMode: boolean;
        supportsSessionTan: boolean;
        supportsSessionTanEnd: boolean;
        supportsSwaps?: boolean;
        type: BrokerType;
        createRealMoneyOrderCreatedObservable(): Observable<void>;
        createSession(sessionToken: string, sessionConfig: SessionConfig): Session;
        createTracking?(env: string): Tracking;
        getSupportedExchangeIds(): null | string[];
    }
    Index

    Properties

    brokerName isTotalValueAllowed login sessionExpiredMessage supportsOrderListExecutionDetails? supportsOrderListHistoryCommission? supportsOrderListHistoryPurchaseQuotationAndDate? supportsPositionComments? supportsPositionDividends? supportsRealtimeMode supportsSessionTan supportsSessionTanEnd supportsSwaps? type

    Methods

    createRealMoneyOrderCreatedObservable createSession createTracking? getSupportedExchangeIds

    Properties

    brokerName: string

    Internal name of the broker

    isTotalValueAllowed: boolean

    If true, RealtimeCalculator will calculate the totalValue based on the (on realtime quotes calculated) positionValue

    login: LoginDescriptor

    Describes how to obtain a SessionToken.

    sessionExpiredMessage: string

    Default Message to show when a session is expired.

    supportsOrderListExecutionDetails?: boolean

    If true, executed order lists for portfolios of this broker are expected to have the executions array filled. Some brokers do not provide this in lists, so that those details can only be fetched using individual getOrder calls.

    supportsOrderListHistoryCommission?: boolean

    If true, the orderList of type "history" will show the commissions column

    supportsOrderListHistoryPurchaseQuotationAndDate?: boolean

    If true, the orderList of type "history" will show the purchaseQuotation and purchaseDateTime column

    supportsPositionComments?: boolean

    True if positions can have comments.

    supportsPositionDividends?: boolean

    If true, positions of this broker are expected to have the dividends and

    supportsRealtimeMode: boolean

    True if it is possible to subscribe realtime quotes for positions.

    supportsSessionTan: boolean

    True if Session TANs are supported by this broker.

    supportsSessionTanEnd: boolean

    True if Session TANs can be ended without logout.

    supportsSwaps?: boolean

    If true, the positionList and orderList of type "history" will show the swaps column

    type: BrokerType

    Type of the broker (Online or CfdFx)

    Methods

    • Create a nobservable which emits whenever an order is created in a real money portfolio.

      Returns Observable<void>

    • Create a session from credentials that have been acquired during the login process (or persisted from a previous session).

      Parameters

      Returns Session

    • Create a tracking utility based on the selected environment.

      Parameters

      • env: string

      Returns Tracking

    • Get a list of exchanges generally supported by this broker. The list can be used to offer the user to set default exchanges without an active session. When null is returned, no information is available.

      Returns null | string[]

    Settings

    Member Visibility

    On This Page

    Properties
    Methods