Interface ExchangesApiBeta

PFI Exchanges API

interface ExchangesApi {
    getClose(opts): Promise<undefined | Close>;
    getExchange(opts): Promise<undefined | Exchange>;
    getExchanges(opts?): Promise<Exchange[]>;
    getOrder(opts): Promise<undefined | Order>;
    getOrderStatuses(opts): Promise<OrderStatus[]>;
    getQuote(opts): Promise<undefined | Quote>;
    getRfq(opts): Promise<undefined | Rfq>;
}

Methods

getClose getExchange getExchanges getOrder getOrderStatuses getQuote getRfq

Methods

getClose

  • getClose(opts): Promise<undefined | Close>

  • Retrieve the Close reason if found

    Parameters

    • opts: {
          exchangeId: string;
      }
      • exchangeId: string

    Returns Promise<undefined | Close>

getExchange

  • getExchange(opts): Promise<undefined | Exchange>

  • Retrieve a single exchange if found

    Parameters

    • opts: {
          id: string;
      }
      • id: string

    Returns Promise<undefined | Exchange>

getExchanges

getOrder

  • getOrder(opts): Promise<undefined | Order>

  • Retrieve an Order if found

    Parameters

    • opts: {
          exchangeId: string;
      }
      • exchangeId: string

    Returns Promise<undefined | Order>

getOrderStatuses

  • getOrderStatuses(opts): Promise<OrderStatus[]>

  • Retrieve the OrderStatuses if found

    Parameters

    • opts: {
          exchangeId: string;
      }
      • exchangeId: string

    Returns Promise<OrderStatus[]>

getQuote

  • getQuote(opts): Promise<undefined | Quote>

  • Retrieve a Quote if found

    Parameters

    • opts: {
          exchangeId: string;
      }
      • exchangeId: string

    Returns Promise<undefined | Quote>

getRfq

  • getRfq(opts): Promise<undefined | Rfq>

  • Retrieve a RFQ if found

    Parameters

    • opts: {
          exchangeId: string;
      }
      • exchangeId: string

    Returns Promise<undefined | Rfq>

Settings

Member Visibility

Theme

On This Page

getClosegetExchangegetExchangesgetOrdergetOrderStatusesgetQuotegetRfq