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

Class CryptoPerpetualFuturesApi

java.lang.Object

markets.alpaca.client.openapi.data.api.CryptoPerpetualFuturesApi

public class CryptoPerpetualFuturesApi
extends Object

Generated client for CryptoPerpetualFuturesApi 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

• cryptoPerpLatestBars: Latest bars
• cryptoPerpLatestFuturesPricing: Latest pricing
• cryptoPerpLatestOrderbooks: Latest orderbook
• cryptoPerpLatestQuotes: Latest quotes
• cryptoPerpLatestTrades: Latest trades

Constructor Summary

Constructors

Constructor	Description
CryptoPerpetualFuturesApi()
CryptoPerpetualFuturesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
CryptoLatestBarsResp	cryptoPerpLatestBars(CryptoPerpLoc loc, String symbols)	Latest bars The latest bars endpoint returns the latest bar data for the crypto perpetual futures symbols provided.
okhttp3.Call	cryptoPerpLatestBarsAsync(CryptoPerpLoc loc, String symbols, ApiCallback<CryptoLatestBarsResp> _callback)	Latest bars (asynchronously) The latest bars endpoint returns the latest bar data for the crypto perpetual futures symbols provided.
okhttp3.Call	cryptoPerpLatestBarsCall(CryptoPerpLoc loc, String symbols, ApiCallback _callback)	Build call for cryptoPerpLatestBars
ApiResponse<CryptoLatestBarsResp>	cryptoPerpLatestBarsWithHttpInfo(CryptoPerpLoc loc, String symbols)	Latest bars The latest bars endpoint returns the latest bar data for the crypto perpetual futures symbols provided.
CryptoPerpLatestFuturesPricingResp	cryptoPerpLatestFuturesPricing(CryptoPerpLoc loc, String symbols)	Latest pricing The latest futures pricing endpoint returns the latest pricing data for the crypto perpetual futures symbols provided.
okhttp3.Call	cryptoPerpLatestFuturesPricingAsync(CryptoPerpLoc loc, String symbols, ApiCallback<CryptoPerpLatestFuturesPricingResp> _callback)	Latest pricing (asynchronously) The latest futures pricing endpoint returns the latest pricing data for the crypto perpetual futures symbols provided.
okhttp3.Call	cryptoPerpLatestFuturesPricingCall(CryptoPerpLoc loc, String symbols, ApiCallback _callback)	Build call for cryptoPerpLatestFuturesPricing
ApiResponse<CryptoPerpLatestFuturesPricingResp>	cryptoPerpLatestFuturesPricingWithHttpInfo(CryptoPerpLoc loc, String symbols)	Latest pricing The latest futures pricing endpoint returns the latest pricing data for the crypto perpetual futures symbols provided.
CryptoLatestOrderbooksResp	cryptoPerpLatestOrderbooks(CryptoPerpLoc loc, String symbols)	Latest orderbook The latest orderbook endpoint returns the latest bid and ask orderbook for the crypto perpetual futures symbols provided.
okhttp3.Call	cryptoPerpLatestOrderbooksAsync(CryptoPerpLoc loc, String symbols, ApiCallback<CryptoLatestOrderbooksResp> _callback)	Latest orderbook (asynchronously) The latest orderbook endpoint returns the latest bid and ask orderbook for the crypto perpetual futures symbols provided.
okhttp3.Call	cryptoPerpLatestOrderbooksCall(CryptoPerpLoc loc, String symbols, ApiCallback _callback)	Build call for cryptoPerpLatestOrderbooks
ApiResponse<CryptoLatestOrderbooksResp>	cryptoPerpLatestOrderbooksWithHttpInfo(CryptoPerpLoc loc, String symbols)	Latest orderbook The latest orderbook endpoint returns the latest bid and ask orderbook for the crypto perpetual futures symbols provided.
CryptoLatestQuotesResp	cryptoPerpLatestQuotes(CryptoPerpLoc loc, String symbols)	Latest quotes The latest quotes endpoint returns the latest bid and ask prices for the crypto perpetual futures symbols provided.
okhttp3.Call	cryptoPerpLatestQuotesAsync(CryptoPerpLoc loc, String symbols, ApiCallback<CryptoLatestQuotesResp> _callback)	Latest quotes (asynchronously) The latest quotes endpoint returns the latest bid and ask prices for the crypto perpetual futures symbols provided.
okhttp3.Call	cryptoPerpLatestQuotesCall(CryptoPerpLoc loc, String symbols, ApiCallback _callback)	Build call for cryptoPerpLatestQuotes
ApiResponse<CryptoLatestQuotesResp>	cryptoPerpLatestQuotesWithHttpInfo(CryptoPerpLoc loc, String symbols)	Latest quotes The latest quotes endpoint returns the latest bid and ask prices for the crypto perpetual futures symbols provided.
CryptoLatestTradesResp	cryptoPerpLatestTrades(CryptoPerpLoc loc, String symbols)	Latest trades The latest trades endpoint returns the latest trade data for the crypto perpetual futures symbols provided.
okhttp3.Call	cryptoPerpLatestTradesAsync(CryptoPerpLoc loc, String symbols, ApiCallback<CryptoLatestTradesResp> _callback)	Latest trades (asynchronously) The latest trades endpoint returns the latest trade data for the crypto perpetual futures symbols provided.
okhttp3.Call	cryptoPerpLatestTradesCall(CryptoPerpLoc loc, String symbols, ApiCallback _callback)	Build call for cryptoPerpLatestTrades
ApiResponse<CryptoLatestTradesResp>	cryptoPerpLatestTradesWithHttpInfo(CryptoPerpLoc loc, String symbols)	Latest trades The latest trades endpoint returns the latest trade data for the crypto perpetual futures symbols provided.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
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

CryptoPerpetualFuturesApi

public CryptoPerpetualFuturesApi()

CryptoPerpetualFuturesApi

public CryptoPerpetualFuturesApi(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)

cryptoPerpLatestBarsCall

public okhttp3.Call cryptoPerpLatestBarsCall(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols,
 ApiCallback _callback)
                                      throws ApiException

Build call for cryptoPerpLatestBars

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

_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/).	-

cryptoPerpLatestBars

public CryptoLatestBarsResp cryptoPerpLatestBars(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols)
                                          throws ApiException

Latest bars The latest bars endpoint returns the latest bar data for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

Returns:

CryptoLatestBarsResp

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/).	-

cryptoPerpLatestBarsWithHttpInfo

public ApiResponse<CryptoLatestBarsResp> cryptoPerpLatestBarsWithHttpInfo(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols)
                                                                   throws ApiException

Latest bars The latest bars endpoint returns the latest bar data for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

Returns:

ApiResponse<CryptoLatestBarsResp>

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/).	-

cryptoPerpLatestBarsAsync

public okhttp3.Call cryptoPerpLatestBarsAsync(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols,
 ApiCallback<CryptoLatestBarsResp> _callback)
                                       throws ApiException

Latest bars (asynchronously) The latest bars endpoint returns the latest bar data for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

_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/).	-

cryptoPerpLatestFuturesPricingCall

public okhttp3.Call cryptoPerpLatestFuturesPricingCall(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols,
 ApiCallback _callback)
                                                throws ApiException

Build call for cryptoPerpLatestFuturesPricing

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

_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/).	-

cryptoPerpLatestFuturesPricing

public CryptoPerpLatestFuturesPricingResp cryptoPerpLatestFuturesPricing(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols)
                                                                  throws ApiException

Latest pricing The latest futures pricing endpoint returns the latest pricing data for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

Returns:

CryptoPerpLatestFuturesPricingResp

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/).	-

cryptoPerpLatestFuturesPricingWithHttpInfo

public ApiResponse<CryptoPerpLatestFuturesPricingResp> cryptoPerpLatestFuturesPricingWithHttpInfo(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols)
                                                                                           throws ApiException

Latest pricing The latest futures pricing endpoint returns the latest pricing data for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

Returns:

ApiResponse<CryptoPerpLatestFuturesPricingResp>

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/).	-

cryptoPerpLatestFuturesPricingAsync

public okhttp3.Call cryptoPerpLatestFuturesPricingAsync(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols,
 ApiCallback<CryptoPerpLatestFuturesPricingResp> _callback)
                                                 throws ApiException

Latest pricing (asynchronously) The latest futures pricing endpoint returns the latest pricing data for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

_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/).	-

cryptoPerpLatestOrderbooksCall

public okhttp3.Call cryptoPerpLatestOrderbooksCall(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols,
 ApiCallback _callback)
                                            throws ApiException

Build call for cryptoPerpLatestOrderbooks

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

_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/).	-

cryptoPerpLatestOrderbooks

public CryptoLatestOrderbooksResp cryptoPerpLatestOrderbooks(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols)
                                                      throws ApiException

Latest orderbook The latest orderbook endpoint returns the latest bid and ask orderbook for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

Returns:

CryptoLatestOrderbooksResp

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/).	-

cryptoPerpLatestOrderbooksWithHttpInfo

public ApiResponse<CryptoLatestOrderbooksResp> cryptoPerpLatestOrderbooksWithHttpInfo(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols)
                                                                               throws ApiException

Latest orderbook The latest orderbook endpoint returns the latest bid and ask orderbook for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

Returns:

ApiResponse<CryptoLatestOrderbooksResp>

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/).	-

cryptoPerpLatestOrderbooksAsync

public okhttp3.Call cryptoPerpLatestOrderbooksAsync(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols,
 ApiCallback<CryptoLatestOrderbooksResp> _callback)
                                             throws ApiException

Latest orderbook (asynchronously) The latest orderbook endpoint returns the latest bid and ask orderbook for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

_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/).	-

cryptoPerpLatestQuotesCall

public okhttp3.Call cryptoPerpLatestQuotesCall(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols,
 ApiCallback _callback)
                                        throws ApiException

Build call for cryptoPerpLatestQuotes

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

_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/).	-

cryptoPerpLatestQuotes

public CryptoLatestQuotesResp cryptoPerpLatestQuotes(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols)
                                              throws ApiException

Latest quotes The latest quotes endpoint returns the latest bid and ask prices for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

Returns:

CryptoLatestQuotesResp

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/).	-

cryptoPerpLatestQuotesWithHttpInfo

public ApiResponse<CryptoLatestQuotesResp> cryptoPerpLatestQuotesWithHttpInfo(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols)
                                                                       throws ApiException

Latest quotes The latest quotes endpoint returns the latest bid and ask prices for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

Returns:

ApiResponse<CryptoLatestQuotesResp>

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/).	-

cryptoPerpLatestQuotesAsync

public okhttp3.Call cryptoPerpLatestQuotesAsync(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols,
 ApiCallback<CryptoLatestQuotesResp> _callback)
                                         throws ApiException

Latest quotes (asynchronously) The latest quotes endpoint returns the latest bid and ask prices for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

_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/).	-

cryptoPerpLatestTradesCall

public okhttp3.Call cryptoPerpLatestTradesCall(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols,
 ApiCallback _callback)
                                        throws ApiException

Build call for cryptoPerpLatestTrades

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

_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/).	-

cryptoPerpLatestTrades

public CryptoLatestTradesResp cryptoPerpLatestTrades(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols)
                                              throws ApiException

Latest trades The latest trades endpoint returns the latest trade data for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

Returns:

CryptoLatestTradesResp

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/).	-

cryptoPerpLatestTradesWithHttpInfo

public ApiResponse<CryptoLatestTradesResp> cryptoPerpLatestTradesWithHttpInfo(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols)
                                                                       throws ApiException

Latest trades The latest trades endpoint returns the latest trade data for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

Returns:

ApiResponse<CryptoLatestTradesResp>

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/).	-

cryptoPerpLatestTradesAsync

public okhttp3.Call cryptoPerpLatestTradesAsync(@Nonnull
 CryptoPerpLoc loc,
 @Nonnull
 String symbols,
 ApiCallback<CryptoLatestTradesResp> _callback)
                                         throws ApiException

Latest trades (asynchronously) The latest trades endpoint returns the latest trade data for the crypto perpetual futures symbols provided.

Parameters:

loc - Crypto perpetual location. (required)

symbols - A comma-separated list of crypto symbols. (required)

_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/).	-