Class CountryInfoApi
java.lang.Object
markets.alpaca.client.openapi.broker.api.CountryInfoApi
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintRetrieve countries information The Country Info API serves country information for every supported countries including risk ratings and supported crypto states where applicable.okhttp3.CallqueryCountryInfosAsync(ApiCallback<Map<String, CountryInfo>> _callback) Retrieve countries information (asynchronously) The Country Info API serves country information for every supported countries including risk ratings and supported crypto states where applicable.okhttp3.CallqueryCountryInfosCall(ApiCallback _callback) Build call for queryCountryInfosRetrieve countries information The Country Info API serves country information for every supported countries including risk ratings and supported crypto states where applicable.voidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex)
-
Constructor Details
-
CountryInfoApi
public CountryInfoApi() -
CountryInfoApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
queryCountryInfosCall
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
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
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 ApiExceptionRetrieve 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 -
-