@master-chief/alpaca-ts
Version:
A TypeScript Node.js library for the https://alpaca.markets REST API and WebSocket streams.
22 lines • 772 B
JavaScript
/**
* Get Logo for symbol
* Returns logo image resource for provided symbol.
* @returns binary Returns the requested logo as an image.
* @throws ApiError
*/
export const getLogo = (httpRequest, { cryptoOrStockSymbol, placeholder = true, }) => {
return httpRequest.request({
method: "GET",
url: "/v1beta1/logos/{crypto_or_stock_symbol}",
path: {
crypto_or_stock_symbol: cryptoOrStockSymbol,
},
query: {
placeholder: placeholder,
},
errors: {
404: `No Logo was found for this symbol. This code will only be returned if you set \`placeholder\` to false. Otherwise we will generate a placeholder image for this symbol`,
},
});
};
//# sourceMappingURL=logos.js.map