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

Class FixedIncomeApi

java.lang.Object

markets.alpaca.client.openapi.data.api.FixedIncomeApi

public class FixedIncomeApi
extends Object

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

• fixedIncomeLatestPrices: Latest prices
• fixedIncomeLatestQuotes: Latest quotes

Constructor Summary

Constructors

Constructor	Description
FixedIncomeApi()
FixedIncomeApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
FixedIncomeLatestPricesResp	fixedIncomeLatestPrices(String isins)	Latest prices This endpoint returns the latest prices for the given fixed income securities.
okhttp3.Call	fixedIncomeLatestPricesAsync(String isins, ApiCallback<FixedIncomeLatestPricesResp> _callback)	Latest prices (asynchronously) This endpoint returns the latest prices for the given fixed income securities.
okhttp3.Call	fixedIncomeLatestPricesCall(String isins, ApiCallback _callback)	Build call for fixedIncomeLatestPrices
ApiResponse<FixedIncomeLatestPricesResp>	fixedIncomeLatestPricesWithHttpInfo(String isins)	Latest prices This endpoint returns the latest prices for the given fixed income securities.
FixedIncomeLatestQuotesResp	fixedIncomeLatestQuotes(String isins, Integer tradeSize)	Latest quotes This endpoint returns the latest quotes for the given fixed income securities.
okhttp3.Call	fixedIncomeLatestQuotesAsync(String isins, Integer tradeSize, ApiCallback<FixedIncomeLatestQuotesResp> _callback)	Latest quotes (asynchronously) This endpoint returns the latest quotes for the given fixed income securities.
okhttp3.Call	fixedIncomeLatestQuotesCall(String isins, Integer tradeSize, ApiCallback _callback)	Build call for fixedIncomeLatestQuotes
ApiResponse<FixedIncomeLatestQuotesResp>	fixedIncomeLatestQuotesWithHttpInfo(String isins, Integer tradeSize)	Latest quotes This endpoint returns the latest quotes for the given fixed income securities.
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

FixedIncomeApi

public FixedIncomeApi()

FixedIncomeApi

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

fixedIncomeLatestPricesCall

public okhttp3.Call fixedIncomeLatestPricesCall(@Nonnull
 String isins,
 ApiCallback _callback)
                                         throws ApiException

Build call for fixedIncomeLatestPrices

Parameters:

isins - A comma-separated list of ISINs with a limit of 1000. (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/).	-

fixedIncomeLatestPrices

public FixedIncomeLatestPricesResp fixedIncomeLatestPrices(@Nonnull
 String isins)
                                                    throws ApiException

Latest prices This endpoint returns the latest prices for the given fixed income securities.

Parameters:

isins - A comma-separated list of ISINs with a limit of 1000. (required)

Returns:

FixedIncomeLatestPricesResp

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

fixedIncomeLatestPricesWithHttpInfo

public ApiResponse<FixedIncomeLatestPricesResp> fixedIncomeLatestPricesWithHttpInfo(@Nonnull
 String isins)
                                                                             throws ApiException

Latest prices This endpoint returns the latest prices for the given fixed income securities.

Parameters:

isins - A comma-separated list of ISINs with a limit of 1000. (required)

Returns:

ApiResponse<FixedIncomeLatestPricesResp>

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

fixedIncomeLatestPricesAsync

public okhttp3.Call fixedIncomeLatestPricesAsync(@Nonnull
 String isins,
 ApiCallback<FixedIncomeLatestPricesResp> _callback)
                                          throws ApiException

Latest prices (asynchronously) This endpoint returns the latest prices for the given fixed income securities.

Parameters:

isins - A comma-separated list of ISINs with a limit of 1000. (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/).	-

fixedIncomeLatestQuotesCall

public okhttp3.Call fixedIncomeLatestQuotesCall(@Nonnull
 String isins,
 @Nullable
 Integer tradeSize,
 ApiCallback _callback)
                                         throws ApiException

Build call for fixedIncomeLatestQuotes

Parameters:

isins - A comma-separated list of ISINs with a limit of 100. (required)

tradeSize - Filters to best bid/ask where the minimum trade size is less than or equal to the given numeric value. For any negative value the best bid/ask will be returned for the smallest trade size on either side. (optional)

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

fixedIncomeLatestQuotes

public FixedIncomeLatestQuotesResp fixedIncomeLatestQuotes(@Nonnull
 String isins,
 @Nullable
 Integer tradeSize)
                                                    throws ApiException

Latest quotes This endpoint returns the latest quotes for the given fixed income securities.

Parameters:

isins - A comma-separated list of ISINs with a limit of 100. (required)

tradeSize - Filters to best bid/ask where the minimum trade size is less than or equal to the given numeric value. For any negative value the best bid/ask will be returned for the smallest trade size on either side. (optional)

Returns:

FixedIncomeLatestQuotesResp

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

fixedIncomeLatestQuotesWithHttpInfo

public ApiResponse<FixedIncomeLatestQuotesResp> fixedIncomeLatestQuotesWithHttpInfo(@Nonnull
 String isins,
 @Nullable
 Integer tradeSize)
                                                                             throws ApiException

Latest quotes This endpoint returns the latest quotes for the given fixed income securities.

Parameters:

isins - A comma-separated list of ISINs with a limit of 100. (required)

tradeSize - Filters to best bid/ask where the minimum trade size is less than or equal to the given numeric value. For any negative value the best bid/ask will be returned for the smallest trade size on either side. (optional)

Returns:

ApiResponse<FixedIncomeLatestQuotesResp>

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

fixedIncomeLatestQuotesAsync

public okhttp3.Call fixedIncomeLatestQuotesAsync(@Nonnull
 String isins,
 @Nullable
 Integer tradeSize,
 ApiCallback<FixedIncomeLatestQuotesResp> _callback)
                                          throws ApiException

Latest quotes (asynchronously) This endpoint returns the latest quotes for the given fixed income securities.

Parameters:

isins - A comma-separated list of ISINs with a limit of 100. (required)

tradeSize - Filters to best bid/ask where the minimum trade size is less than or equal to the given numeric value. For any negative value the best bid/ask will be returned for the smallest trade size on either side. (optional)

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