Class CountryInfoApi

java.lang.Object
markets.alpaca.client.openapi.broker.api.CountryInfoApi

public class CountryInfoApi extends Object
Generated client for CountryInfoApi 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

  • queryCountryInfos: Retrieve countries information
  • Constructor Details

    • CountryInfoApi

      public CountryInfoApi()
    • CountryInfoApi

      public CountryInfoApi(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)
    • queryCountryInfosCall

      public okhttp3.Call queryCountryInfosCall(ApiCallback _callback) throws ApiException
      Build call for queryCountryInfos
      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 Returns the countries information as a map -
    • queryCountryInfos

      public Map<String,CountryInfo> queryCountryInfos() throws ApiException
      Retrieve countries information The Country Info API serves country information for every supported countries including risk ratings and supported crypto states where applicable.
      Returns:
      Map<String, CountryInfo>
      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 countries information as a map -
    • queryCountryInfosWithHttpInfo

      public ApiResponse<Map<String,CountryInfo>> queryCountryInfosWithHttpInfo() throws ApiException
      Retrieve countries information The Country Info API serves country information for every supported countries including risk ratings and supported crypto states where applicable.
      Returns:
      ApiResponse<Map<String, CountryInfo>>
      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 countries information as a map -
    • queryCountryInfosAsync

      public okhttp3.Call queryCountryInfosAsync(ApiCallback<Map<String,CountryInfo>> _callback) throws ApiException
      Retrieve countries information (asynchronously) The Country Info API serves country information for every supported countries including risk ratings and supported crypto states where applicable.
      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 Returns the countries information as a map -