Interface IAlpacaScreenerClient

Provides unified type-safe access for Alpaca Screener API via HTTP/REST.

Namespace: Alpaca.Markets

Assembly: Alpaca.Markets.dll

Syntax

public interface IAlpacaScreenerClient

Methods

GetTopMarketMoversAsync(Nullable<Int32>, CancellationToken)

Returns top market movers (gainers and losers) and corresponding price change values.

Declaration

Task<IMarketMovers> GetTopMarketMoversAsync(Int32? numberOfLosersAndGainersInResponse = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.Nullable<Int32>	numberOfLosersAndGainersInResponse	Number of top market movers to fetch (gainers and losers). Will return number top for each. By default 10 gainers and 10 losers.
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<IMarketMovers>	Read-only market movers collections.

Exceptions

Type	Condition
RestClientErrorException	The response contains an error message or the received response cannot be deserialized properly due to JSON schema mismatch.