Package markets.alpaca.client.openapi.data.api

Class LogosApi

java.lang.Object

markets.alpaca.client.openapi.data.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

• logos: Logos

Constructor Summary

Constructors

Constructor	Description
LogosApi()
LogosApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
File	logos(String symbol, Boolean placeholder)	Logos Get the image of the company logo for the given symbol.
okhttp3.Call	logosAsync(String symbol, Boolean placeholder, ApiCallback<File> _callback)	Logos (asynchronously) Get the image of the company logo for the given symbol.
okhttp3.Call	logosCall(String symbol, Boolean placeholder, ApiCallback _callback)	Build call for logos
ApiResponse<File>	logosWithHttpInfo(String symbol, Boolean placeholder)	Logos Get the image of the company logo for the given symbol.
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)

logosCall

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

Build call for logos

Parameters:

symbol - A unique series of letters assigned to a security for trading purposes. (required)

placeholder - If true, returns a placeholder image when no logo is available. Defaults to true. (optional, default to true)

_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	OK	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
400	One of the request parameters is invalid. See the returned message for details.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	The requested resource is forbidden.	-
429	Too many requests. You hit the rate limit. Use the X-RateLimit-... response headers to make sure you're under the rate limit.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on [Slack](https://alpaca.markets/slack) or on the [Community Forum](https://forum.alpaca.markets/).	-

logos

public File logos(@Nonnull
 String symbol,
 @Nullable
 Boolean placeholder)
           throws ApiException

Logos Get the image of the company logo for the given symbol.

Parameters:

symbol - A unique series of letters assigned to a security for trading purposes. (required)

placeholder - If true, returns a placeholder image when no logo is available. Defaults to true. (optional, default to true)

Returns:

File

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	OK	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
400	One of the request parameters is invalid. See the returned message for details.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	The requested resource is forbidden.	-
429	Too many requests. You hit the rate limit. Use the X-RateLimit-... response headers to make sure you're under the rate limit.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on [Slack](https://alpaca.markets/slack) or on the [Community Forum](https://forum.alpaca.markets/).	-

logosWithHttpInfo

public ApiResponse<File> logosWithHttpInfo(@Nonnull
 String symbol,
 @Nullable
 Boolean placeholder)
                                    throws ApiException

Logos Get the image of the company logo for the given symbol.

Parameters:

symbol - A unique series of letters assigned to a security for trading purposes. (required)

placeholder - If true, returns a placeholder image when no logo is available. Defaults to true. (optional, default to true)

Returns:

ApiResponse<File>

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	OK	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
400	One of the request parameters is invalid. See the returned message for details.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	The requested resource is forbidden.	-
429	Too many requests. You hit the rate limit. Use the X-RateLimit-... response headers to make sure you're under the rate limit.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on [Slack](https://alpaca.markets/slack) or on the [Community Forum](https://forum.alpaca.markets/).	-

logosAsync

public okhttp3.Call logosAsync(@Nonnull
 String symbol,
 @Nullable
 Boolean placeholder,
 ApiCallback<File> _callback)
                        throws ApiException

Logos (asynchronously) Get the image of the company logo for the given symbol.

Parameters:

symbol - A unique series of letters assigned to a security for trading purposes. (required)

placeholder - If true, returns a placeholder image when no logo is available. Defaults to true. (optional, default to true)

_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	OK	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
400	One of the request parameters is invalid. See the returned message for details.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	The requested resource is forbidden.	-
429	Too many requests. You hit the rate limit. Use the X-RateLimit-... response headers to make sure you're under the rate limit.	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset -
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on [Slack](https://alpaca.markets/slack) or on the [Community Forum](https://forum.alpaca.markets/).	-