Interface AuthApiInterface

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

AuthApi

Index

Methods

sessionLogon sessionLogout sessionStatus

Methods

sessionLogon

sessionLogon(
requestParameters?: SessionLogonRequest,
): Promise<WebsocketApiResponse<SessionLogonResponse>[]>
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.

Note:* Only Ed25519 keys are supported for this feature.

Weight(IP): 2

Security Type: USER_DATA

Notes: Data Source:* Memory
Parameters
- OptionalrequestParameters: SessionLogonRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<SessionLogonResponse>[]>
Memberof
AuthApiInterface
- Defined in clients/spot/src/websocket-api/modules/auth-api.ts:47

sessionLogout

sessionLogout(
requestParameters?: SessionLogoutRequest,
): Promise<WebsocketApiResponse<SessionLogoutResponse>[]>
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(IP): 2

Security Type: NONE

Notes: Data Source:* Memory
Parameters
- OptionalrequestParameters: SessionLogoutRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<SessionLogoutResponse>[]>
Memberof
AuthApiInterface
- Defined in clients/spot/src/websocket-api/modules/auth-api.ts:69

sessionStatus

sessionStatus(
requestParameters?: SessionStatusRequest,
): Promise<WebsocketApiResponse<SessionStatusResponse>>
Query the status of the WebSocket connection, inspecting which API key (if any) is used to authorize requests.

Weight(IP): 2

Security Type: NONE

Notes: Data Source:* Memory
Parameters
- OptionalrequestParameters: SessionStatusRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<SessionStatusResponse>>
Memberof
AuthApiInterface
- Defined in clients/spot/src/websocket-api/modules/auth-api.ts:90