Binance Connector JS
    Preparing search index...

    Class ConfigurationWebsocketStreams

    Index

    Constructors

    Properties

    agent?: boolean | Agent

    websocket agent

    false
    

    ConfigurationWebsocketStreams

    apiKey?: string

    The API key used for authentication (signed websocket streams only).

    ConfigurationWebsocketStreams

    apiSecret?: string

    The API secret used for HMAC signing (signed websocket streams only).

    ConfigurationWebsocketStreams

    compression?: boolean

    use compression for websocket messages

    true
    

    ConfigurationWebsocketAPI

    mode?: "single" | "pool"

    the mode of the connection, either 'single' or 'pool'.

    single
    

    ConfigurationWebsocketStreams

    poolSize?: number

    the size of the connection pool, if the mode is set to 'pool'.

    1
    

    ConfigurationWebsocketStreams

    privateKey?: string | Buffer<ArrayBufferLike>

    private key used for RSA / ED25519 signing (signed websocket streams only)

    ConfigurationWebsocketStreams

    privateKeyPassphrase?: string

    private key passphrase (signed websocket streams only)

    ConfigurationWebsocketStreams

    reconnectDelay?: number

    reconnction delay

    5000
    

    ConfigurationWebsocketStreams

    timeUnit?: TimeUnit

    timeUnit (used only on SPOT API)

    ConfigurationWebsocketStreams

    wsURL?: string

    override websocket url

    ConfigurationWebsocketStreams