Interface GeneralApiInterface

GeneralApi - interface

GeneralApi

interface GeneralApiInterface {
    exchangeInfo(
        requestParameters?: SpotWebsocketAPI.ExchangeInfoRequest,
    ): Promise<WebsocketApiResponse<SpotWebsocketAPI.ExchangeInfoResponse>>;
    ping(
        requestParameters?: PingRequest,
    ): Promise<WebsocketApiResponse<PingResponse>>;
    time(
        requestParameters?: TimeRequest,
    ): Promise<WebsocketApiResponse<SpotWebsocketAPI.TimeResponse>>;
}

Implemented by

SpotWebsocketAPI.GeneralApi

Index

Methods

exchangeInfo ping time

Methods

exchangeInfo

exchangeInfo(
requestParameters?: SpotWebsocketAPI.ExchangeInfoRequest,
): Promise<WebsocketApiResponse<SpotWebsocketAPI.ExchangeInfoResponse>>
Query current exchange trading rules, rate limits, and symbol information. Weight: 20
Parameters
- OptionalrequestParameters: SpotWebsocketAPI.ExchangeInfoRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.ExchangeInfoResponse>>
Memberof
GeneralApiInterface
- Defined in clients/spot/src/websocket-api/modules/general-api.ts:38

ping

ping(
requestParameters?: PingRequest,
): Promise<WebsocketApiResponse<PingResponse>>
Test connectivity to the WebSocket API. Weight: 1
Parameters
- OptionalrequestParameters: PingRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<PingResponse>>
Memberof
GeneralApiInterface
- Defined in clients/spot/src/websocket-api/modules/general-api.ts:52

time

time(
requestParameters?: TimeRequest,
): Promise<WebsocketApiResponse<SpotWebsocketAPI.TimeResponse>>
Test connectivity to the WebSocket API and get the current server time. Weight: 1
Parameters
- OptionalrequestParameters: TimeRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.TimeResponse>>
Memberof
GeneralApiInterface
- Defined in clients/spot/src/websocket-api/modules/general-api.ts:64