Interface OpenAlgoLiveConfig

interface OpenAlgoLiveConfig {
    apiKey: string;
    baseUrl: string;
    fetchImpl?: (
        input: RequestInfo | URL,
        init?: RequestInit,
    ) => Promise<Response>;
    socketFactory?: SocketFactory;
    volumeMode?: VolumeMode;
    wsUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey baseUrl fetchImpl? socketFactory? volumeMode? wsUrl

Properties

apiKey

apiKey: string

baseUrl

baseUrl: string

OptionalfetchImpl

fetchImpl?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>

Injectable fetch (defaults to global fetch); lets the adapter be tested offline.

Type declaration

    • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

    • MDN Reference

      Parameters

      • input: RequestInfo | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

OptionalsocketFactory

socketFactory?: SocketFactory

Inject a custom socket (tests, React Native, non-browser runtimes).

OptionalvolumeMode

volumeMode?: VolumeMode

Volume accounting for the live candle builder (default 'ltq-sum').

wsUrl

wsUrl: string

WS proxy URL, e.g. ws://127.0.0.1:8765.

Settings

Member Visibility

On This Page

Properties