Interface GeneralApiInterface

GeneralApi - interface GeneralApi

interface GeneralApiInterface {
    exchangeInfo(
        requestParameters?: SpotRestAPI.ExchangeInfoRequest,
    ): Promise<RestApiResponse<SpotRestAPI.ExchangeInfoResponse>>;
    executionRules(
        requestParameters?: SpotRestAPI.ExecutionRulesRequest,
    ): Promise<RestApiResponse<SpotRestAPI.ExecutionRulesResponse>>;
    ping(): Promise<RestApiResponse<void>>;
    time(): Promise<RestApiResponse<SpotRestAPI.TimeResponse>>;
}

Implemented by

SpotRestAPI.GeneralApi

Index

Methods

exchangeInfo executionRules ping time

Methods

exchangeInfo

exchangeInfo(
requestParameters?: SpotRestAPI.ExchangeInfoRequest,
): Promise<RestApiResponse<SpotRestAPI.ExchangeInfoResponse>>
Current exchange trading rules and symbol information Weight: 20
Parameters
- OptionalrequestParameters: SpotRestAPI.ExchangeInfoRequest
  Request parameters.
Returns Promise<RestApiResponse<SpotRestAPI.ExchangeInfoResponse>>
Throws
Memberof
GeneralApiInterface
- Defined in clients/spot/src/rest-api/modules/general-api.ts:192

executionRules

executionRules(
requestParameters?: SpotRestAPI.ExecutionRulesRequest,
): Promise<RestApiResponse<SpotRestAPI.ExecutionRulesResponse>>
Weight: Parameter Weight

symbol 2

symbols 2 for each symbol, capped at a max of 40

symbolStatus 40

None 40
Parameters
- OptionalrequestParameters: SpotRestAPI.ExecutionRulesRequest
  Request parameters.
Returns Promise<RestApiResponse<SpotRestAPI.ExecutionRulesResponse>>
Throws
Memberof
GeneralApiInterface
- Defined in clients/spot/src/rest-api/modules/general-api.ts:210

ping

ping(): Promise<RestApiResponse<void>>
Test connectivity to the Rest API. Weight: 1

Returns Promise<RestApiResponse<void>>
Throws
Memberof
GeneralApiInterface
- Defined in clients/spot/src/rest-api/modules/general-api.ts:222

time

time(): Promise<RestApiResponse<SpotRestAPI.TimeResponse>>
Test connectivity to the Rest API and get the current server time. Weight: 1

Returns Promise<RestApiResponse<SpotRestAPI.TimeResponse>>
Throws
Memberof
GeneralApiInterface
- Defined in clients/spot/src/rest-api/modules/general-api.ts:232