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

Class FpslProgramApi

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

  • getV1FpslAnalyticsAccountLoans: Read FPSL Loans Analytics for an Account
  • getV1ListFpslLoans: List FPSL Loans
  • getV1ListFpslTiers: List FPSL Tiers

  • Constructor Details

    • FpslProgramApi

      public FpslProgramApi()

    • FpslProgramApi

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

    • getV1FpslAnalyticsAccountLoansCall

      public okhttp3.Call getV1FpslAnalyticsAccountLoansCall(@Nonnull UUID accountId, @Nullable LocalDate start, @Nullable LocalDate end, ApiCallback _callback) throws ApiException
      Build call for getV1FpslAnalyticsAccountLoans
      Parameters:
      accountId - The account identifier (account UUID). (required)
      start - Filter loans after or on this start date (inclusive). Defaults to the first day of the current month, New York timezone. (optional)
      end - Filter loans before this end date (exclusive). Defaults to the day after the current date, New York timezone. (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 Returns the aggregated FPSL loan analytics for the account. -
      400 One of the request parameters is invalid. See the returned message for details. -
      401 Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key. -
      403 User has no access to a resource. -
      500 Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum. -

    • getV1FpslAnalyticsAccountLoans

      public FPSLAnalyticsLoansResponse getV1FpslAnalyticsAccountLoans(@Nonnull UUID accountId, @Nullable LocalDate start, @Nullable LocalDate end) throws ApiException
      Read FPSL Loans Analytics for an Account Returns aggregated FPSL interest and loan-activity counts for one account over a date range. Use this for \"earned so far this month\" customer UIs and for supervisory spot-checks against your internal accrual model. The `{account_id}` path parameter accepts a account UUID (aggregation for that account).
      Parameters:
      accountId - The account identifier (account UUID). (required)
      start - Filter loans after or on this start date (inclusive). Defaults to the first day of the current month, New York timezone. (optional)
      end - Filter loans before this end date (exclusive). Defaults to the day after the current date, New York timezone. (optional)
      Returns:
      FPSLAnalyticsLoansResponse
      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 Returns the aggregated FPSL loan analytics for the account. -
      400 One of the request parameters is invalid. See the returned message for details. -
      401 Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key. -
      403 User has no access to a resource. -
      500 Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum. -

    • getV1FpslAnalyticsAccountLoansWithHttpInfo

      public ApiResponse<FPSLAnalyticsLoansResponse> getV1FpslAnalyticsAccountLoansWithHttpInfo(@Nonnull UUID accountId, @Nullable LocalDate start, @Nullable LocalDate end) throws ApiException
      Read FPSL Loans Analytics for an Account Returns aggregated FPSL interest and loan-activity counts for one account over a date range. Use this for \"earned so far this month\" customer UIs and for supervisory spot-checks against your internal accrual model. The `{account_id}` path parameter accepts a account UUID (aggregation for that account).
      Parameters:
      accountId - The account identifier (account UUID). (required)
      start - Filter loans after or on this start date (inclusive). Defaults to the first day of the current month, New York timezone. (optional)
      end - Filter loans before this end date (exclusive). Defaults to the day after the current date, New York timezone. (optional)
      Returns:
      ApiResponse<FPSLAnalyticsLoansResponse>
      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 Returns the aggregated FPSL loan analytics for the account. -
      400 One of the request parameters is invalid. See the returned message for details. -
      401 Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key. -
      403 User has no access to a resource. -
      500 Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum. -

    • getV1FpslAnalyticsAccountLoansAsync

      public okhttp3.Call getV1FpslAnalyticsAccountLoansAsync(@Nonnull UUID accountId, @Nullable LocalDate start, @Nullable LocalDate end, ApiCallback<FPSLAnalyticsLoansResponse> _callback) throws ApiException
      Read FPSL Loans Analytics for an Account (asynchronously) Returns aggregated FPSL interest and loan-activity counts for one account over a date range. Use this for \"earned so far this month\" customer UIs and for supervisory spot-checks against your internal accrual model. The `{account_id}` path parameter accepts a account UUID (aggregation for that account).
      Parameters:
      accountId - The account identifier (account UUID). (required)
      start - Filter loans after or on this start date (inclusive). Defaults to the first day of the current month, New York timezone. (optional)
      end - Filter loans before this end date (exclusive). Defaults to the day after the current date, New York timezone. (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 Returns the aggregated FPSL loan analytics for the account. -
      400 One of the request parameters is invalid. See the returned message for details. -
      401 Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key. -
      403 User has no access to a resource. -
      500 Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum. -

    • getV1ListFpslLoansCall

      public okhttp3.Call getV1ListFpslLoansCall(@Nullable UUID accountId, @Nullable LocalDate start, @Nullable LocalDate end, @Nullable String pageToken, @Nullable Integer limit, ApiCallback _callback) throws ApiException
      Build call for getV1ListFpslLoans
      Parameters:
      accountId - The account identifier (optional)
      start - Filter loans after or on this start date. (optional)
      end - Filter loans before this end date. (optional)
      pageToken - The pagination token used to continue retrieving results. This value is returned in certain responses when additional data is available, typically due to a response size limit. (optional)
      limit - The maximum number of data points to return in the response page. (optional, default to 1000)
      _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 Returns a list of FPSL loans for the account, or an empty list if no loans are found. -
      400 One of the request parameters is invalid. See the returned message for details. -
      401 Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key. -
      403 User has no access to a resource. -
      500 Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum. -

    • getV1ListFpslLoans

      public ListFPSLLoansResponse getV1ListFpslLoans(@Nullable UUID accountId, @Nullable LocalDate start, @Nullable LocalDate end, @Nullable String pageToken, @Nullable Integer limit) throws ApiException
      List FPSL Loans Returns a list of all FPSL loans that match the specified filter criteria, ordered in ascending order by `date`, `account_number`, and `symbol`. Each entry represents a loan of a `symbol` on a given `date`, made on behalf of the specified `account_number`.
      Parameters:
      accountId - The account identifier (optional)
      start - Filter loans after or on this start date. (optional)
      end - Filter loans before this end date. (optional)
      pageToken - The pagination token used to continue retrieving results. This value is returned in certain responses when additional data is available, typically due to a response size limit. (optional)
      limit - The maximum number of data points to return in the response page. (optional, default to 1000)
      Returns:
      ListFPSLLoansResponse
      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 Returns a list of FPSL loans for the account, or an empty list if no loans are found. -
      400 One of the request parameters is invalid. See the returned message for details. -
      401 Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key. -
      403 User has no access to a resource. -
      500 Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum. -

    • getV1ListFpslLoansWithHttpInfo

      public ApiResponse<ListFPSLLoansResponse> getV1ListFpslLoansWithHttpInfo(@Nullable UUID accountId, @Nullable LocalDate start, @Nullable LocalDate end, @Nullable String pageToken, @Nullable Integer limit) throws ApiException
      List FPSL Loans Returns a list of all FPSL loans that match the specified filter criteria, ordered in ascending order by `date`, `account_number`, and `symbol`. Each entry represents a loan of a `symbol` on a given `date`, made on behalf of the specified `account_number`.
      Parameters:
      accountId - The account identifier (optional)
      start - Filter loans after or on this start date. (optional)
      end - Filter loans before this end date. (optional)
      pageToken - The pagination token used to continue retrieving results. This value is returned in certain responses when additional data is available, typically due to a response size limit. (optional)
      limit - The maximum number of data points to return in the response page. (optional, default to 1000)
      Returns:
      ApiResponse<ListFPSLLoansResponse>
      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 Returns a list of FPSL loans for the account, or an empty list if no loans are found. -
      400 One of the request parameters is invalid. See the returned message for details. -
      401 Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key. -
      403 User has no access to a resource. -
      500 Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum. -

    • getV1ListFpslLoansAsync

      public okhttp3.Call getV1ListFpslLoansAsync(@Nullable UUID accountId, @Nullable LocalDate start, @Nullable LocalDate end, @Nullable String pageToken, @Nullable Integer limit, ApiCallback<ListFPSLLoansResponse> _callback) throws ApiException
      List FPSL Loans (asynchronously) Returns a list of all FPSL loans that match the specified filter criteria, ordered in ascending order by `date`, `account_number`, and `symbol`. Each entry represents a loan of a `symbol` on a given `date`, made on behalf of the specified `account_number`.
      Parameters:
      accountId - The account identifier (optional)
      start - Filter loans after or on this start date. (optional)
      end - Filter loans before this end date. (optional)
      pageToken - The pagination token used to continue retrieving results. This value is returned in certain responses when additional data is available, typically due to a response size limit. (optional)
      limit - The maximum number of data points to return in the response page. (optional, default to 1000)
      _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 Returns a list of FPSL loans for the account, or an empty list if no loans are found. -
      400 One of the request parameters is invalid. See the returned message for details. -
      401 Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key. -
      403 User has no access to a resource. -
      500 Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum. -

    • getV1ListFpslTiersCall

      public okhttp3.Call getV1ListFpslTiersCall(ApiCallback _callback) throws ApiException
      Build call for getV1ListFpslTiers
      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 FPSL 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. -

    • getV1ListFpslTiers

      public List<FPSLTier> getV1ListFpslTiers() throws ApiException
      List FPSL Tiers List all available FPSL tiers. These tiers may be assigned to an account.
      Returns:
      List<FPSLTier>
      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 FPSL 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. -

    • getV1ListFpslTiersWithHttpInfo

      public ApiResponse<List<FPSLTier>> getV1ListFpslTiersWithHttpInfo() throws ApiException
      List FPSL Tiers List all available FPSL tiers. These tiers may be assigned to an account.
      Returns:
      ApiResponse<List<FPSLTier>>
      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 FPSL 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. -

    • getV1ListFpslTiersAsync

      public okhttp3.Call getV1ListFpslTiersAsync(ApiCallback<List<FPSLTier>> _callback) throws ApiException
      List FPSL Tiers (asynchronously) List all available FPSL tiers. These tiers may be assigned to an account.
      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 FPSL 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. -