UNPKG

@master-chief/alpaca-ts

Version:

A TypeScript Node.js library for the https://alpaca.markets REST API and WebSocket streams.

19 lines (18 loc) 782 B
import type { CancelablePromise } from "../rest/CancelablePromise.js"; import type { BaseHttpRequest } from "../rest/BaseHttpRequest.js"; /** * Get Logo for symbol * Returns logo image resource for provided symbol. * @returns binary Returns the requested logo as an image. * @throws ApiError */ export declare const getLogo: (httpRequest: BaseHttpRequest, { cryptoOrStockSymbol, placeholder, }: { /** * The crypto or stock symbol to query for. Note, currently all crypto symbols must be appended with "USD", ie "BTCUSD" would be how you query for BTC. */ cryptoOrStockSymbol: string; /** * If true then the api will generate a placeholder image if no logo was found. Defaults to true */ placeholder?: boolean; }) => CancelablePromise<Blob>;