Binance Connector JS
    Preparing search index...

    GeneralApi - interface

    GeneralApi

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

    Implemented by

    Index

    Methods

    • Query current exchange trading rules, rate limits, and symbol information.

      Weight(IP): 20

      Security Type: NONE

      Notes: Data Source:* Memory

      Notes:* If the value provided to symbol or symbols do not exist, the endpoint will throw an error saying the symbol is invalid. All parameters are optional. Only one of symbol, symbols, permissions parameters can be specified. Without parameters, exchangeInfo displays all symbols with ["SPOT", "MARGIN", "LEVERAGED"] permissions. In order to list all active symbols on the exchange, you need to explicitly request all permissions. permissions accepts either a list of permissions, or a single permission name. E.g. "SPOT".

      Examples of Symbol Permissions Interpretation from the Response:*

      [["A","B"]] means you may place an order if your account has either permission "A" or permission "B". [["A"],["B"]] means you can place an order if your account has permission "A" and permission "B". [["A"],["B","C"]] means you can place an order if your account has permission "A" and permission "B" or permission "C". (Inclusive or is applied here, not exclusive or, so your account may have both permission "B" and permission "C".)

      Parameters

      Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.ExchangeInfoResponse>>

      GeneralApiInterface

    • Test connectivity to the WebSocket API.

      Note: You can use regular WebSocket ping frames to test connectivity as well, WebSocket API will respond with pong frames as soon as possible. ping request along with time is a safe way to test request-response handling in your application.

      Weight(IP): 1

      Security Type: NONE

      Notes: Data Source:* Memory

      Parameters

      • OptionalrequestParameters: PingRequest

        Request parameters.

      Returns Promise<WebsocketApiResponse<PingResponse>>

      GeneralApiInterface