Class GeneralApi

GeneralApi - object-oriented interface GeneralApi

Implements

SpotWebsocketAPI.GeneralApiInterface

Index

Constructors

Methods

exchangeInfo ping time

Constructors

constructor

new GeneralApi(websocketBase: WebsocketAPIBase): SpotWebsocketAPI.GeneralApi
Parameters
- websocketBase: WebsocketAPIBase
Returns SpotWebsocketAPI.GeneralApi
- Defined in clients/spot/src/websocket-api/modules/general-api.ts:149

Methods

exchangeInfo

exchangeInfo(
requestParameters?: SpotWebsocketAPI.ExchangeInfoRequest,
): Promise<WebsocketApiResponse<SpotWebsocketAPI.ExchangeInfoResponse>>
Query current exchange trading rules, rate limits, and symbol information. Weight: 20
Parameters
- requestParameters: SpotWebsocketAPI.ExchangeInfoRequest = {}
  Request parameters.
Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.ExchangeInfoResponse>>
Memberof
GeneralApi

See
Binance API Documentation
Implementation of GeneralApiInterface.exchangeInfo
- Defined in clients/spot/src/websocket-api/modules/general-api.ts:163

ping

ping(
requestParameters?: PingRequest,
): Promise<WebsocketApiResponse<PingResponse>>
Test connectivity to the WebSocket API. Weight: 1
Parameters
- requestParameters: PingRequest = {}
  Request parameters.
Returns Promise<WebsocketApiResponse<PingResponse>>
Memberof
GeneralApi

See
Binance API Documentation
Implementation of GeneralApiInterface.ping
- Defined in clients/spot/src/websocket-api/modules/general-api.ts:183

time

time(
requestParameters?: TimeRequest,
): Promise<WebsocketApiResponse<SpotWebsocketAPI.TimeResponse>>
Test connectivity to the WebSocket API and get the current server time. Weight: 1
Parameters
- requestParameters: TimeRequest = {}
  Request parameters.
Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.TimeResponse>>
Memberof
GeneralApi

See
Binance API Documentation
Implementation of GeneralApiInterface.time
- Defined in clients/spot/src/websocket-api/modules/general-api.ts:201