Package net.jacobpeterson.alpaca.openapi.marketdata.api

Class LogosApi

java.lang.Object

net.jacobpeterson.alpaca.openapi.marketdata.api.LogosApi

public class LogosApi
extends Object

Constructor Summary

Constructors

Constructor	Description
LogosApi()
LogosApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
File	logos(String symbol, Boolean placeholder)	Logos Get the image of the company logo for the given symbol
protected okhttp3.Call	logosAsync(String symbol, Boolean placeholder, ApiCallback<File> _callback)	Logos (asynchronously) Get the image of the company logo for the given symbol
protected okhttp3.Call	logosCall(String symbol, Boolean placeholder, ApiCallback _callback)	Build call for logos
protected ApiResponse<File>	logosWithHttpInfo(String symbol, Boolean placeholder)	Logos Get the image of the company logo for the given symbol

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

logosCall

protected okhttp3.Call logosCall(String symbol,
 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 - (optional, default to true)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

logos

public File logos(String symbol,
 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 - (optional, default to true)

Returns:

File

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

logosWithHttpInfo

protected ApiResponse<File> logosWithHttpInfo(String symbol,
 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 - (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

logosAsync

protected okhttp3.Call logosAsync(String symbol,
 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 - (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