@reactivemarkets/switchboard-sdk/lib/domain/iQuoteRequestBuilder.d.ts

SDK for the Reactive Markets Switchboard

import { SecurityType, Side } from "@reactivemarkets/switchboard-api";
import { IMessageBuilder } from "./iMessageBuilder";
export interface IQuoteRequestBuilder extends IMessageBuilder {
    /**
     * The trading account.
     * @param account
     */
    account(account: string): IQuoteRequestBuilder;
    /**
     * Specify a client request id.
     * @param requestId The request id.
     */
    requestId(requestId?: string): IQuoteRequestBuilder;
    /**
     * Instrument symbol.
     * @param symbol The instrument symbol.
     */
    symbol(symbol: string): IQuoteRequestBuilder;
    /**
     * Exchange or venue symbol.
     * @param venue The venue symbol.
     */
    venue(venue?: string): IQuoteRequestBuilder;
    /**
     * Tenor symbol, for swaps refers to the near leg.
     * @param tenor The tenor.
     */
    tenor(tenor?: string): IQuoteRequestBuilder;
    /**
     * Security Type. Defaults to Spot.
     * @param securityType
     */
    securityType(securityType: SecurityType): IQuoteRequestBuilder;
    /**
     * Quote request duration in milliseconds.
     * @param expireTime
     */
    expireTime(expireTime?: number): IQuoteRequestBuilder;
    /**
     * Quote side. If none, this is a two-way request.
     * @param side
     */
    side(side: Side): IQuoteRequestBuilder;
    /**
     * Quote currency.
     * @param ccy currency
     */
    ccy(ccy?: string): IQuoteRequestBuilder;
    /**
     * Quote quantity. MUST be greater than zero.
     * @param qty
     */
    qty(qty: number): IQuoteRequestBuilder;
    /**
     * The fixing date in YYYYMMDD format.
     * @param date
     */
    fixingDate(date?: number): IQuoteRequestBuilder;
    /**
     * Swaps only, refers to the far leg.
     * @param tenor
     */
    farTenor(tenor?: string): IQuoteRequestBuilder;
    /**
     * Swaps only, far leg quantity.
     * @param qty
     */
    farQty(qty?: number): IQuoteRequestBuilder;
    /**
     * Swaps only, far leg fixing date in YYYYMMDD format.
     * @param date
     */
    farFixingDate(date?: number): IQuoteRequestBuilder;
    /**
     * List of quote venues. Ignored if venue is not AGG.
     * @param venues
     */
    execVenues(venues?: string[]): IQuoteRequestBuilder;
}