Package markets.alpaca.client.openapi.data.api

Class ScreenerApi

java.lang.Object

markets.alpaca.client.openapi.data.api.ScreenerApi

public class ScreenerApi
extends Object

Generated client for ScreenerApi operations.

This class is generated from the configured OpenAPI spec. Operation method Javadocs include OAS summaries, descriptions, parameters, return types, response details, and external documentation links when present in the spec.

Operations

• mostActives: Most active stocks
• movers: Top market movers

Constructor Summary

Constructors

Constructor	Description
ScreenerApi()
ScreenerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
MostActivesResp	mostActives(String by, Integer top)	Most active stocks Returns the most active stocks by volume or trade count based on real time SIP data.
okhttp3.Call	mostActivesAsync(String by, Integer top, ApiCallback<MostActivesResp> _callback)	Most active stocks (asynchronously) Returns the most active stocks by volume or trade count based on real time SIP data.
okhttp3.Call	mostActivesCall(String by, Integer top, ApiCallback _callback)	Build call for mostActives
ApiResponse<MostActivesResp>	mostActivesWithHttpInfo(String by, Integer top)	Most active stocks Returns the most active stocks by volume or trade count based on real time SIP data.
MoversResp	movers(MarketType marketType, Integer top)	Top market movers Returns the top market movers (gainers and losers) based on real time SIP data.
okhttp3.Call	moversAsync(MarketType marketType, Integer top, ApiCallback<MoversResp> _callback)	Top market movers (asynchronously) Returns the top market movers (gainers and losers) based on real time SIP data.
okhttp3.Call	moversCall(MarketType marketType, Integer top, ApiCallback _callback)	Build call for movers
ApiResponse<MoversResp>	moversWithHttpInfo(MarketType marketType, Integer top)	Top market movers Returns the top market movers (gainers and losers) based on real time SIP data.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScreenerApi

public ScreenerApi()

ScreenerApi

public ScreenerApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

mostActivesCall

public okhttp3.Call mostActivesCall(@Nullable
 String by,
 @Nullable
 Integer top,
 ApiCallback _callback)
                             throws ApiException

Build call for mostActives

Parameters:

by - The metric used for ranking the most active stocks. (optional, default to volume)

top - The number of top most active stocks to fetch per day. (optional, default to 10)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
400	One of the request parameters is invalid. See the returned message for details.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	The requested resource is forbidden.	-
429	Too many requests. You hit the rate limit. Use the X-RateLimit-... response headers to make sure you're under the rate limit.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on [Slack](https://alpaca.markets/slack) or on the [Community Forum](https://forum.alpaca.markets/).	-

mostActives

public MostActivesResp mostActives(@Nullable
 String by,
 @Nullable
 Integer top)
                            throws ApiException

Most active stocks Returns the most active stocks by volume or trade count based on real time SIP data. By default, returns the top 10 symbols by volume.

Parameters:

by - The metric used for ranking the most active stocks. (optional, default to volume)

top - The number of top most active stocks to fetch per day. (optional, default to 10)

Returns:

MostActivesResp

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
400	One of the request parameters is invalid. See the returned message for details.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	The requested resource is forbidden.	-
429	Too many requests. You hit the rate limit. Use the X-RateLimit-... response headers to make sure you're under the rate limit.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on [Slack](https://alpaca.markets/slack) or on the [Community Forum](https://forum.alpaca.markets/).	-

mostActivesWithHttpInfo

public ApiResponse<MostActivesResp> mostActivesWithHttpInfo(@Nullable
 String by,
 @Nullable
 Integer top)
                                                     throws ApiException

Most active stocks Returns the most active stocks by volume or trade count based on real time SIP data. By default, returns the top 10 symbols by volume.

Parameters:

by - The metric used for ranking the most active stocks. (optional, default to volume)

top - The number of top most active stocks to fetch per day. (optional, default to 10)

Returns:

ApiResponse<MostActivesResp>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
400	One of the request parameters is invalid. See the returned message for details.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	The requested resource is forbidden.	-
429	Too many requests. You hit the rate limit. Use the X-RateLimit-... response headers to make sure you're under the rate limit.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on [Slack](https://alpaca.markets/slack) or on the [Community Forum](https://forum.alpaca.markets/).	-

mostActivesAsync

public okhttp3.Call mostActivesAsync(@Nullable
 String by,
 @Nullable
 Integer top,
 ApiCallback<MostActivesResp> _callback)
                              throws ApiException

Most active stocks (asynchronously) Returns the most active stocks by volume or trade count based on real time SIP data. By default, returns the top 10 symbols by volume.

Parameters:

by - The metric used for ranking the most active stocks. (optional, default to volume)

top - The number of top most active stocks to fetch per day. (optional, default to 10)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
400	One of the request parameters is invalid. See the returned message for details.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	The requested resource is forbidden.	-
429	Too many requests. You hit the rate limit. Use the X-RateLimit-... response headers to make sure you're under the rate limit.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on [Slack](https://alpaca.markets/slack) or on the [Community Forum](https://forum.alpaca.markets/).	-

moversCall

public okhttp3.Call moversCall(@Nonnull
 MarketType marketType,
 @Nullable
 Integer top,
 ApiCallback _callback)
                        throws ApiException

Build call for movers

Parameters:

marketType - Screen-specific market (stocks or crypto). (required)

top - Number of top market movers to fetch (gainers and losers). Will return this number of results for each. By default, 10 gainers and 10 losers. (optional, default to 10)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
400	One of the request parameters is invalid. See the returned message for details.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	The requested resource is forbidden.	-
429	Too many requests. You hit the rate limit. Use the X-RateLimit-... response headers to make sure you're under the rate limit.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on [Slack](https://alpaca.markets/slack) or on the [Community Forum](https://forum.alpaca.markets/).	-

movers

public MoversResp movers(@Nonnull
 MarketType marketType,
 @Nullable
 Integer top)
                  throws ApiException

Top market movers Returns the top market movers (gainers and losers) based on real time SIP data. The change for each symbol is calculated from the previous closing price and the latest closing price. For stocks, the endpoint resets at market open. Until then, it shows the previous market day's movers. The data is split-adjusted. Only tradable symbols in exchanges are included. For crypto, the endpoint resets at midnight.

Parameters:

marketType - Screen-specific market (stocks or crypto). (required)

top - Number of top market movers to fetch (gainers and losers). Will return this number of results for each. By default, 10 gainers and 10 losers. (optional, default to 10)

Returns:

MoversResp

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
400	One of the request parameters is invalid. See the returned message for details.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	The requested resource is forbidden.	-
429	Too many requests. You hit the rate limit. Use the X-RateLimit-... response headers to make sure you're under the rate limit.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on [Slack](https://alpaca.markets/slack) or on the [Community Forum](https://forum.alpaca.markets/).	-

moversWithHttpInfo

public ApiResponse<MoversResp> moversWithHttpInfo(@Nonnull
 MarketType marketType,
 @Nullable
 Integer top)
                                           throws ApiException

Top market movers Returns the top market movers (gainers and losers) based on real time SIP data. The change for each symbol is calculated from the previous closing price and the latest closing price. For stocks, the endpoint resets at market open. Until then, it shows the previous market day's movers. The data is split-adjusted. Only tradable symbols in exchanges are included. For crypto, the endpoint resets at midnight.

Parameters:

marketType - Screen-specific market (stocks or crypto). (required)

top - Number of top market movers to fetch (gainers and losers). Will return this number of results for each. By default, 10 gainers and 10 losers. (optional, default to 10)

Returns:

ApiResponse<MoversResp>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
400	One of the request parameters is invalid. See the returned message for details.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	The requested resource is forbidden.	-
429	Too many requests. You hit the rate limit. Use the X-RateLimit-... response headers to make sure you're under the rate limit.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on [Slack](https://alpaca.markets/slack) or on the [Community Forum](https://forum.alpaca.markets/).	-

moversAsync

public okhttp3.Call moversAsync(@Nonnull
 MarketType marketType,
 @Nullable
 Integer top,
 ApiCallback<MoversResp> _callback)
                         throws ApiException

Top market movers (asynchronously) Returns the top market movers (gainers and losers) based on real time SIP data. The change for each symbol is calculated from the previous closing price and the latest closing price. For stocks, the endpoint resets at market open. Until then, it shows the previous market day's movers. The data is split-adjusted. Only tradable symbols in exchanges are included. For crypto, the endpoint resets at midnight.

Parameters:

marketType - Screen-specific market (stocks or crypto). (required)

top - Number of top market movers to fetch (gainers and losers). Will return this number of results for each. By default, 10 gainers and 10 losers. (optional, default to 10)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
400	One of the request parameters is invalid. See the returned message for details.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	The requested resource is forbidden.	-
429	Too many requests. You hit the rate limit. Use the X-RateLimit-... response headers to make sure you're under the rate limit.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on [Slack](https://alpaca.markets/slack) or on the [Community Forum](https://forum.alpaca.markets/).	-