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

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

import { AxiosInstance } from 'axios';
import { OptionsScreenerResponse, OptionsScreenerQueryParams, StockScreenerResponse, StockScreenerQueryParams } from './types';
export declare class ScreenerApi {
    private axiosInstance;
    constructor(axiosInstance: AxiosInstance);
    /**
     * Hottest Chains
     * A contract screener endpoint to screen the market for contracts by a variety of filter options.
     * @param params OptionContractsQueryParams
     */
    getOptionContracts(params?: OptionsScreenerQueryParams): Promise<OptionsScreenerResponse>;
    /**
     * Stock Screener
     * A stock screener endpoint to screen the market for stocks by a variety of filter options.
     * @param params StocksQueryParams
     */
    getStocks(params?: StockScreenerQueryParams): Promise<StockScreenerResponse>;
}