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

Class LogosApi

java.lang.Object

markets.alpaca.client.openapi.broker.api.LogosApi

public class LogosApi
extends Object

Generated client for LogosApi 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

• getV1beta1LogosSymbol: Get Logo

Constructor Summary

Constructors

Constructor	Description
LogosApi()
LogosApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	getV1beta1LogosSymbol(String symbol, String placeholder)	Get Logo Alpaca's Logo API serves uniform logo images for select stock and crypto symbols.
okhttp3.Call	getV1beta1LogosSymbolAsync(String symbol, String placeholder, ApiCallback<Void> _callback)	Get Logo (asynchronously) Alpaca's Logo API serves uniform logo images for select stock and crypto symbols.
okhttp3.Call	getV1beta1LogosSymbolCall(String symbol, String placeholder, ApiCallback _callback)	Build call for getV1beta1LogosSymbol
ApiResponse<Void>	getV1beta1LogosSymbolWithHttpInfo(String symbol, String placeholder)	Get Logo Alpaca's Logo API serves uniform logo images for select stock and crypto symbols.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LogosApi

public LogosApi()

LogosApi

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

getV1beta1LogosSymbolCall

public okhttp3.Call getV1beta1LogosSymbolCall(@Nonnull
 String symbol,
 @Nullable
 String placeholder,
 ApiCallback _callback)
                                       throws ApiException

Build call for getV1beta1LogosSymbol

Parameters:

symbol - Stock or crypto symbol (e.g. AAPL, BTCUSD, etc.) (required)

placeholder - True by default, will return sample placeholder images with the first letter of the asset symbol. If false, 404 will be returned for symbols which do not contain an image. (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	The API response will return the raw image as a binary	-

getV1beta1LogosSymbol

public void getV1beta1LogosSymbol(@Nonnull
 String symbol,
 @Nullable
 String placeholder)
                           throws ApiException

Get Logo Alpaca's Logo API serves uniform logo images for select stock and crypto symbols. Note: For Logo API pricing details, reach out to sales@alpaca.markets The API response will return the raw image as a binary

Parameters:

symbol - Stock or crypto symbol (e.g. AAPL, BTCUSD, etc.) (required)

placeholder - True by default, will return sample placeholder images with the first letter of the asset symbol. If false, 404 will be returned for symbols which do not contain an image. (optional)

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	The API response will return the raw image as a binary	-

getV1beta1LogosSymbolWithHttpInfo

public ApiResponse<Void> getV1beta1LogosSymbolWithHttpInfo(@Nonnull
 String symbol,
 @Nullable
 String placeholder)
                                                    throws ApiException

Get Logo Alpaca's Logo API serves uniform logo images for select stock and crypto symbols. Note: For Logo API pricing details, reach out to sales@alpaca.markets The API response will return the raw image as a binary

Parameters:

symbol - Stock or crypto symbol (e.g. AAPL, BTCUSD, etc.) (required)

placeholder - True by default, will return sample placeholder images with the first letter of the asset symbol. If false, 404 will be returned for symbols which do not contain an image. (optional)

Returns:

ApiResponse<Void>

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	The API response will return the raw image as a binary	-

getV1beta1LogosSymbolAsync

public okhttp3.Call getV1beta1LogosSymbolAsync(@Nonnull
 String symbol,
 @Nullable
 String placeholder,
 ApiCallback<Void> _callback)
                                        throws ApiException

Get Logo (asynchronously) Alpaca's Logo API serves uniform logo images for select stock and crypto symbols. Note: For Logo API pricing details, reach out to sales@alpaca.markets The API response will return the raw image as a binary

Parameters:

symbol - Stock or crypto symbol (e.g. AAPL, BTCUSD, etc.) (required)

placeholder - True by default, will return sample placeholder images with the first letter of the asset symbol. If false, 404 will be returned for symbols which do not contain an image. (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	The API response will return the raw image as a binary	-