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

Class ForexApi

java.lang.Object
markets.alpaca.client.openapi.data.api.ForexApi
public class ForexApi extends Object
Generated client for ForexApi 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

  • latestRates: Latest rates for currency pairs
  • rates: Historical rates for currency pairs

  • Constructor Details

    • ForexApi

      public ForexApi()

    • ForexApi

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

    • latestRatesCall

      public okhttp3.Call latestRatesCall(@Nonnull String currencyPairs, ApiCallback _callback) throws ApiException
      Build call for latestRates
      Parameters:
      currencyPairs - (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/). -

    • latestRates

      public ForexLatestRatesResp latestRates(@Nonnull String currencyPairs) throws ApiException
      Latest rates for currency pairs Get the latest forex rates for the given currency pairs.
      Parameters:
      currencyPairs - (required)
      Returns:
      ForexLatestRatesResp
      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/). -

    • latestRatesWithHttpInfo

      public ApiResponse<ForexLatestRatesResp> latestRatesWithHttpInfo(@Nonnull String currencyPairs) throws ApiException
      Latest rates for currency pairs Get the latest forex rates for the given currency pairs.
      Parameters:
      currencyPairs - (required)
      Returns:
      ApiResponse<ForexLatestRatesResp>
      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/). -

    • latestRatesAsync

      public okhttp3.Call latestRatesAsync(@Nonnull String currencyPairs, ApiCallback<ForexLatestRatesResp> _callback) throws ApiException
      Latest rates for currency pairs (asynchronously) Get the latest forex rates for the given currency pairs.
      Parameters:
      currencyPairs - (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/). -

    • ratesCall

      public okhttp3.Call ratesCall(@Nonnull String currencyPairs, @Nullable String timeframe, @Nullable OffsetDateTime start, @Nullable OffsetDateTime end, @Nullable Integer limit, @Nullable Sort sort, @Nullable String pageToken, ApiCallback _callback) throws ApiException
      Build call for rates
      Parameters:
      currencyPairs - (required)
      timeframe - (optional, default to 1Min)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. Default: the beginning of the current day, but at least 15 minutes ago if the user doesn't have real-time access for the feed. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. Default: the current time if the user has a real-time access for the feed, otherwise 15 minutes before the current time. (optional)
      limit - The maximum number of data points to return in the response page. The API may return less, even if there are more available data points in the requested interval. Always check the `next_page_token` for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      pageToken - The pagination token from which to continue. The value to pass here is returned in specific requests when more data is available, usually because of a response result limit. (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/). -

    • rates

      public ForexRatesResp rates(@Nonnull String currencyPairs, @Nullable String timeframe, @Nullable OffsetDateTime start, @Nullable OffsetDateTime end, @Nullable Integer limit, @Nullable Sort sort, @Nullable String pageToken) throws ApiException
      Historical rates for currency pairs Get historical forex rates for the given currency pairs in the given time interval and at the given timeframe (snapshot frequency).
      Parameters:
      currencyPairs - (required)
      timeframe - (optional, default to 1Min)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. Default: the beginning of the current day, but at least 15 minutes ago if the user doesn't have real-time access for the feed. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. Default: the current time if the user has a real-time access for the feed, otherwise 15 minutes before the current time. (optional)
      limit - The maximum number of data points to return in the response page. The API may return less, even if there are more available data points in the requested interval. Always check the `next_page_token` for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      pageToken - The pagination token from which to continue. The value to pass here is returned in specific requests when more data is available, usually because of a response result limit. (optional)
      Returns:
      ForexRatesResp
      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/). -

    • ratesWithHttpInfo

      public ApiResponse<ForexRatesResp> ratesWithHttpInfo(@Nonnull String currencyPairs, @Nullable String timeframe, @Nullable OffsetDateTime start, @Nullable OffsetDateTime end, @Nullable Integer limit, @Nullable Sort sort, @Nullable String pageToken) throws ApiException
      Historical rates for currency pairs Get historical forex rates for the given currency pairs in the given time interval and at the given timeframe (snapshot frequency).
      Parameters:
      currencyPairs - (required)
      timeframe - (optional, default to 1Min)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. Default: the beginning of the current day, but at least 15 minutes ago if the user doesn't have real-time access for the feed. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. Default: the current time if the user has a real-time access for the feed, otherwise 15 minutes before the current time. (optional)
      limit - The maximum number of data points to return in the response page. The API may return less, even if there are more available data points in the requested interval. Always check the `next_page_token` for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      pageToken - The pagination token from which to continue. The value to pass here is returned in specific requests when more data is available, usually because of a response result limit. (optional)
      Returns:
      ApiResponse<ForexRatesResp>
      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/). -

    • ratesAsync

      public okhttp3.Call ratesAsync(@Nonnull String currencyPairs, @Nullable String timeframe, @Nullable OffsetDateTime start, @Nullable OffsetDateTime end, @Nullable Integer limit, @Nullable Sort sort, @Nullable String pageToken, ApiCallback<ForexRatesResp> _callback) throws ApiException
      Historical rates for currency pairs (asynchronously) Get historical forex rates for the given currency pairs in the given time interval and at the given timeframe (snapshot frequency).
      Parameters:
      currencyPairs - (required)
      timeframe - (optional, default to 1Min)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. Default: the beginning of the current day, but at least 15 minutes ago if the user doesn't have real-time access for the feed. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. Default: the current time if the user has a real-time access for the feed, otherwise 15 minutes before the current time. (optional)
      limit - The maximum number of data points to return in the response page. The API may return less, even if there are more available data points in the requested interval. Always check the `next_page_token` for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      pageToken - The pagination token from which to continue. The value to pass here is returned in specific requests when more data is available, usually because of a response result limit. (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/). -