Package markets.alpaca.client.openapi.broker.api

Class CashInterestApi

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

  • getV1GetEodCashInterestReport: Retrieve EOD Cash Interest Details
  • getV1ListAprTiers: List APR Tiers

  • Constructor Details

    • CashInterestApi

      public CashInterestApi()

    • CashInterestApi

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

    • getV1GetEodCashInterestReportCall

      public okhttp3.Call getV1GetEodCashInterestReportCall(@Nullable UUID accountId, @Nullable LocalDate date, @Nullable LocalDate after, @Nullable LocalDate before, @Nullable String direction, @Nullable Integer pageSize, @Nullable String pageToken, ApiCallback _callback) throws ApiException
      Build call for getV1GetEodCashInterestReport
      Parameters:
      accountId - Account globally unique identifier. If not provided, the report will be generated for all accounts. (optional)
      date - A date in the format YYYY-MM-DD. If not provided, the report will be generated for the most recent date this report is available. (optional)
      after - A date in the format YYYY-MM-DD, valid only if account_id is provided and date is not provided. If not provided, this will use `before` value. If neither is provided the most recent available date is used for both `before` and `after`. (optional)
      before - A date in the format YYYY-MM-DD, valid only if account_id is provided and date is not provided. If not provided, this will use the most recent available date. (optional)
      direction - The direction to use for sorting responses, either `asc` or `desc`. Only valid for account_id queries, for which only sorting by date is supported. Defaults to `desc`. (optional)
      pageSize - The page size, used for paginating responses. Defaults to 1000, with a maximum of 10,000. (optional, default to 1000)
      pageToken - A token used to retrieve the next page for paginated queries. If provided the response will begin at the next page of the results for the response from which the `next_page_token` is used. (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 Successful response, returns a list of daily interest accruals and an optional next page token. -
      400 A client error occurred. Please check the provided request parameters and try again. -
      401 Unauthorized. Please check your API key and try again. -
      429 Too many requests. Please wait a moment and try again. -
      500 A server error occurred. Please contact Alpaca. -

    • getV1GetEodCashInterestReport

      public EoDCashInterestReportResponse getV1GetEodCashInterestReport(@Nullable UUID accountId, @Nullable LocalDate date, @Nullable LocalDate after, @Nullable LocalDate before, @Nullable String direction, @Nullable Integer pageSize, @Nullable String pageToken) throws ApiException
      Retrieve EOD Cash Interest Details This API retrieves a list of cash interest details for the given date(s) for a single account or all accounts. End-of-day (EOD) details are typically accessible after 8:00pm Eastern Time (ET) and reflect that day's ending state across cash balances, accrued interest, accrued fees, as well as additional ancillary details.
      Parameters:
      accountId - Account globally unique identifier. If not provided, the report will be generated for all accounts. (optional)
      date - A date in the format YYYY-MM-DD. If not provided, the report will be generated for the most recent date this report is available. (optional)
      after - A date in the format YYYY-MM-DD, valid only if account_id is provided and date is not provided. If not provided, this will use `before` value. If neither is provided the most recent available date is used for both `before` and `after`. (optional)
      before - A date in the format YYYY-MM-DD, valid only if account_id is provided and date is not provided. If not provided, this will use the most recent available date. (optional)
      direction - The direction to use for sorting responses, either `asc` or `desc`. Only valid for account_id queries, for which only sorting by date is supported. Defaults to `desc`. (optional)
      pageSize - The page size, used for paginating responses. Defaults to 1000, with a maximum of 10,000. (optional, default to 1000)
      pageToken - A token used to retrieve the next page for paginated queries. If provided the response will begin at the next page of the results for the response from which the `next_page_token` is used. (optional)
      Returns:
      EoDCashInterestReportResponse
      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 Successful response, returns a list of daily interest accruals and an optional next page token. -
      400 A client error occurred. Please check the provided request parameters and try again. -
      401 Unauthorized. Please check your API key and try again. -
      429 Too many requests. Please wait a moment and try again. -
      500 A server error occurred. Please contact Alpaca. -

    • getV1GetEodCashInterestReportWithHttpInfo

      public ApiResponse<EoDCashInterestReportResponse> getV1GetEodCashInterestReportWithHttpInfo(@Nullable UUID accountId, @Nullable LocalDate date, @Nullable LocalDate after, @Nullable LocalDate before, @Nullable String direction, @Nullable Integer pageSize, @Nullable String pageToken) throws ApiException
      Retrieve EOD Cash Interest Details This API retrieves a list of cash interest details for the given date(s) for a single account or all accounts. End-of-day (EOD) details are typically accessible after 8:00pm Eastern Time (ET) and reflect that day's ending state across cash balances, accrued interest, accrued fees, as well as additional ancillary details.
      Parameters:
      accountId - Account globally unique identifier. If not provided, the report will be generated for all accounts. (optional)
      date - A date in the format YYYY-MM-DD. If not provided, the report will be generated for the most recent date this report is available. (optional)
      after - A date in the format YYYY-MM-DD, valid only if account_id is provided and date is not provided. If not provided, this will use `before` value. If neither is provided the most recent available date is used for both `before` and `after`. (optional)
      before - A date in the format YYYY-MM-DD, valid only if account_id is provided and date is not provided. If not provided, this will use the most recent available date. (optional)
      direction - The direction to use for sorting responses, either `asc` or `desc`. Only valid for account_id queries, for which only sorting by date is supported. Defaults to `desc`. (optional)
      pageSize - The page size, used for paginating responses. Defaults to 1000, with a maximum of 10,000. (optional, default to 1000)
      pageToken - A token used to retrieve the next page for paginated queries. If provided the response will begin at the next page of the results for the response from which the `next_page_token` is used. (optional)
      Returns:
      ApiResponse<EoDCashInterestReportResponse>
      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 Successful response, returns a list of daily interest accruals and an optional next page token. -
      400 A client error occurred. Please check the provided request parameters and try again. -
      401 Unauthorized. Please check your API key and try again. -
      429 Too many requests. Please wait a moment and try again. -
      500 A server error occurred. Please contact Alpaca. -

    • getV1GetEodCashInterestReportAsync

      public okhttp3.Call getV1GetEodCashInterestReportAsync(@Nullable UUID accountId, @Nullable LocalDate date, @Nullable LocalDate after, @Nullable LocalDate before, @Nullable String direction, @Nullable Integer pageSize, @Nullable String pageToken, ApiCallback<EoDCashInterestReportResponse> _callback) throws ApiException
      Retrieve EOD Cash Interest Details (asynchronously) This API retrieves a list of cash interest details for the given date(s) for a single account or all accounts. End-of-day (EOD) details are typically accessible after 8:00pm Eastern Time (ET) and reflect that day's ending state across cash balances, accrued interest, accrued fees, as well as additional ancillary details.
      Parameters:
      accountId - Account globally unique identifier. If not provided, the report will be generated for all accounts. (optional)
      date - A date in the format YYYY-MM-DD. If not provided, the report will be generated for the most recent date this report is available. (optional)
      after - A date in the format YYYY-MM-DD, valid only if account_id is provided and date is not provided. If not provided, this will use `before` value. If neither is provided the most recent available date is used for both `before` and `after`. (optional)
      before - A date in the format YYYY-MM-DD, valid only if account_id is provided and date is not provided. If not provided, this will use the most recent available date. (optional)
      direction - The direction to use for sorting responses, either `asc` or `desc`. Only valid for account_id queries, for which only sorting by date is supported. Defaults to `desc`. (optional)
      pageSize - The page size, used for paginating responses. Defaults to 1000, with a maximum of 10,000. (optional, default to 1000)
      pageToken - A token used to retrieve the next page for paginated queries. If provided the response will begin at the next page of the results for the response from which the `next_page_token` is used. (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 Successful response, returns a list of daily interest accruals and an optional next page token. -
      400 A client error occurred. Please check the provided request parameters and try again. -
      401 Unauthorized. Please check your API key and try again. -
      429 Too many requests. Please wait a moment and try again. -
      500 A server error occurred. Please contact Alpaca. -

    • getV1ListAprTiersCall

      public okhttp3.Call getV1ListAprTiersCall(ApiCallback _callback) throws ApiException
      Build call for getV1ListAprTiers
      Parameters:
      _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 Successful response, returns a list of APR tiers or none if no tiers are available. -
      401 Unauthorized. Please check your API key and try again. -
      429 Too many requests. Please wait a moment and try again. -
      500 A server error occurred. Please contact Alpaca. -

    • getV1ListAprTiers

      public ListAPRTiersResponse getV1ListAprTiers() throws ApiException
      List APR Tiers List all available APR tiers. These tiers may be assigned to an account, and will be used to determine the interest rate paid on uninvested cash balances.
      Returns:
      ListAPRTiersResponse
      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 Successful response, returns a list of APR tiers or none if no tiers are available. -
      401 Unauthorized. Please check your API key and try again. -
      429 Too many requests. Please wait a moment and try again. -
      500 A server error occurred. Please contact Alpaca. -

    • getV1ListAprTiersWithHttpInfo

      public ApiResponse<ListAPRTiersResponse> getV1ListAprTiersWithHttpInfo() throws ApiException
      List APR Tiers List all available APR tiers. These tiers may be assigned to an account, and will be used to determine the interest rate paid on uninvested cash balances.
      Returns:
      ApiResponse<ListAPRTiersResponse>
      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 Successful response, returns a list of APR tiers or none if no tiers are available. -
      401 Unauthorized. Please check your API key and try again. -
      429 Too many requests. Please wait a moment and try again. -
      500 A server error occurred. Please contact Alpaca. -

    • getV1ListAprTiersAsync

      public okhttp3.Call getV1ListAprTiersAsync(ApiCallback<ListAPRTiersResponse> _callback) throws ApiException
      List APR Tiers (asynchronously) List all available APR tiers. These tiers may be assigned to an account, and will be used to determine the interest rate paid on uninvested cash balances.
      Parameters:
      _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 Successful response, returns a list of APR tiers or none if no tiers are available. -
      401 Unauthorized. Please check your API key and try again. -
      429 Too many requests. Please wait a moment and try again. -
      500 A server error occurred. Please contact Alpaca. -