Interface Quote

An OTC quote.

interface Quote {
    expiration: { expires: Date; started: Date };
    quotation: Amount;
    size?: string;
    sourceName?: string;
    totalAmount?: Amount;
    authorize(
        orderOpts: QuoteOrderOpts,
        confirmedRiskHint: boolean,
        authenticationMethodId?: string,
        signal?: AbortSignal_2,
    ): Promise<AuthorizedOrder>;
    buildDetailedOrderCostEstimationToken?(orderOpts: QuoteOrderOpts): string;
    createOrderCalculationObservable?(
        orderOpts: QuoteOrderOpts,
    ): Observable<CalculationResult>;
    estimateOrderCosts?(
        orderOpts: QuoteOrderOpts,
        signal?: AbortSignal_2,
    ): Promise<OrderCostEstimation>;
}

Index

Properties

expiration quotation size? sourceName? totalAmount?

Methods

authorize buildDetailedOrderCostEstimationToken? createOrderCalculationObservable? estimateOrderCosts?

Properties

expiration

expiration: { expires: Date; started: Date }

quotation

quotation: Amount

`Optional`size

size?: string

`Optional`sourceName

sourceName?: string

`Optional`totalAmount

totalAmount?: Amount

Methods

authorize

authorize(
    orderOpts: QuoteOrderOpts,
    confirmedRiskHint: boolean,
    authenticationMethodId?: string,
    signal?: AbortSignal_2,
): Promise<AuthorizedOrder>
Parameters
- orderOpts: QuoteOrderOpts
- confirmedRiskHint: boolean
- OptionalauthenticationMethodId: string
- Optionalsignal: AbortSignal_2
Returns Promise<AuthorizedOrder>

`Optional`buildDetailedOrderCostEstimationToken

buildDetailedOrderCostEstimationToken?(orderOpts: QuoteOrderOpts): string
If defined, the detailed cost statement for this quote can be loaded by passing the token generated by this function to getDetailedCostEstimationTable of the session. Building the token is a local operation.

See OrderCostEstimation for how to present the cost statement.
Parameters
- orderOpts: QuoteOrderOpts
Returns string

`Optional`createOrderCalculationObservable

createOrderCalculationObservable?(
orderOpts: QuoteOrderOpts,
): Observable<CalculationResult>
Parameters
- orderOpts: QuoteOrderOpts
Returns Observable<CalculationResult>

`Optional`estimateOrderCosts

estimateOrderCosts?(
orderOpts: QuoteOrderOpts,
signal?: AbortSignal_2,
): Promise<OrderCostEstimation>
Estimate the costs of accepting this quote. If defined, call it immediately after the quote has been received, so that the summary fields of OrderCostEstimation can be displayed together with the quote.

For quote orders, this is used instead of PreparedInstrument.estimateOrderCosts.
Parameters
- orderOpts: QuoteOrderOpts
- Optionalsignal: AbortSignal_2
Returns Promise<OrderCostEstimation>