Binance Connector JS
    Preparing search index...

    Class ConfigurationWebsocketAPI

    Index

    Constructors

    constructor

    Properties

    agent? apiKey apiSecret? autoSessionReLogon? compression? mode? poolSize? privateKey? privateKeyPassphrase? reconnectDelay? timeout? timeUnit? wsURL?

    Constructors

    Properties

    agent?: boolean | Agent

    websocket agent

    false

    ConfigurationWebsocketAPI

    apiKey: string

    The API key used for authentication.

    ConfigurationWebsocketAPI

    apiSecret?: string

    The API secret used for authentication.

    ConfigurationWebsocketAPI

    autoSessionReLogon?: boolean

    auto session re-logon on reconnects/renewals

    true

    ConfigurationWebsocketAPI

    compression?: boolean

    use compression for websocket messages

    true

    ConfigurationWebsocketAPI

    mode?: "single" | "pool"

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

    'single'

    ConfigurationWebsocketAPI

    poolSize?: number

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

    1

    ConfigurationWebsocketAPI

    privateKey?: string | Buffer<ArrayBufferLike>

    private key

    ConfigurationWebsocketAPI

    privateKeyPassphrase?: string

    private key passphrase

    ConfigurationWebsocketAPI

    reconnectDelay?: number

    reconnction delay

    5000

    ConfigurationWebsocketAPI

    timeout?: number

    set a timeout (in milliseconds) for the request

    5000

    ConfigurationWebsocketAPI

    timeUnit?: TimeUnit

    timeUnit (used only on SPOT API)

    ConfigurationWebsocketAPI

    wsURL?: string

    override websocket url

    ConfigurationWebsocketAPI

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties