@master-chief/alpaca-ts/dist/services/screener.d.ts

A TypeScript Node.js library for the https://alpaca.markets REST API and WebSocket streams.

import type { BaseHttpRequest } from "../rest/BaseHttpRequest.js";
import type { CancelablePromise } from "../rest/CancelablePromise.js";
import type { MarketMoversResponse } from "../entities/MarketMoversResponse.js";
/**
 * Get Top Market Movers by Market type
 * Returns top market movers for stocks. By default will return top 5 market gainers and losers.
 * @returns MarketMoversResponse OK
 * @throws ApiError
 */
export declare const getScreenerMovers: (httpRequest: BaseHttpRequest, { marketType, top, }: {
    /**
     * Screen specific market (stocks or crypto)
     */
    marketType: "stocks" | "crypto";
    /**
     * Number of top market movers to fetch (gainers and losers). Will return number top for each. By default 10 gainers and 10 losers.
     */
    top?: number;
}) => CancelablePromise<MarketMoversResponse>;