@airnub/unusualwhales-api-client/dist/src/MarketApi.d.ts

A client library for interacting with the UnusualWhales API, written in TypeScript

import { AxiosInstance } from 'axios';
import { MarketHolidaysResponse, MarketTideResponse, SectorEtfsResponse, SectorType, TickersBySectorResponse, TotalOptionsVolumeResponse } from './types';
export declare class MarketApi {
    private axiosInstance;
    constructor(axiosInstance: AxiosInstance);
    /**
     * Market Holidays
     * Returns the market holidays.
     */
    getMarketHolidays(): Promise<MarketHolidaysResponse>;
    /**
     * Market Tide
     * Returns the market tide information.
     * @param date (Optional)
     * @param otmOnly (Optional)
     */
    getMarketTide(date?: string, otmOnly?: boolean): Promise<MarketTideResponse>;
    /**
     * Sector ETFs
     * Returns the current trading days statistics for the SPDR sector etfs
     */
    getSectorEtfs(): Promise<SectorEtfsResponse>;
    /**
     * Total Options Volume
     * Returns the total options volume and premium for all trade executions that happened on a given trading date.
     * @param limit (Optional)
     */
    getTotalOptionsVolume(limit?: number): Promise<TotalOptionsVolumeResponse>;
    /**
   * Tickers By Sector
   * Returns a list of tickers belonging to the specified sector.
   * @param sector  (Required)
   */
    getTickersBySector(sector: SectorType): Promise<TickersBySectorResponse>;
}