Binance Connector JS
    Preparing search index...

    AuthApi - interface

    AuthApi

    interface AuthApiInterface {
        sessionLogon(
            requestParameters?: SessionLogonRequest,
        ): Promise<WebsocketApiResponse<SessionLogonResponse>[]>;
        sessionLogout(
            requestParameters?: SessionLogoutRequest,
        ): Promise<WebsocketApiResponse<SessionLogoutResponse>[]>;
        sessionStatus(
            requestParameters?: SessionStatusRequest,
        ): Promise<WebsocketApiResponse<SessionStatusResponse>>;
    }

    Implemented by

    Index

    Methods

    • Authenticate WebSocket connection using the provided API key.

      After calling session.logon, you can omit apiKey and signature parameters for future requests that require them.

      Note that only one API key can be authenticated. Calling session.logon multiple times changes the current authenticated API key. Weight: 2

      Parameters

      Returns Promise<WebsocketApiResponse<SessionLogonResponse>[]>

      AuthApiInterface

    • Forget the API key previously authenticated. If the connection is not authenticated, this request does nothing.

      Note that the WebSocket connection stays open after session.logout request. You can continue using the connection, but now you will have to explicitly provide the apiKey and signature parameters where needed. Weight: 2

      Parameters

      Returns Promise<WebsocketApiResponse<SessionLogoutResponse>[]>

      AuthApiInterface