Binance Connector JS
    Preparing search index...
    Index

    Constructors

    Methods

    • Place a new equity order. Supports all combinations of LIMIT / MARKET × BUY / SELL. For LIMIT BUY orders the commission fee is automatically computed and reserved by the server at placement time — callers submit price and quantity only, no fee field is required.

      Field combination matrix*

      | Side | OrderType | Required | Forbidden | | ---- | --------- | -------- | --------- | | BUY | LIMIT | price, quantity, tradingSession | notional | | BUY | MARKET | notional | price, quantity, tradingSession | | SELL | LIMIT | price, quantity, tradingSession | notional | | SELL | MARKET | quantity | price, notional, tradingSession |

      Fractional shares*: when quantity has a decimal component, or an order is placed by notional, it is treated as a fractional-share order. A fractional-share GTC order must be paired with tradingSession = EXTENDED or 24H.

      Rate limit: 200 requests / min (UID).

      Weight: 1

      Security Type: TRADE

      Parameters

      Returns Promise<RestApiResponse<PlaceEquityOrderResponse>>

    • Generic function to send a request.

      Type Parameters

      • T

      Parameters

      • endpoint: string

        The API endpoint to call.

      • method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH"

        HTTP method to use (GET, POST, DELETE, etc.).

      • queryParams: Record<string, unknown> = {}

        Query parameters for the request.

      • bodyParams: Record<string, unknown> = {}

        Body parameters for the request.

      Returns Promise<RestApiResponse<T>>

      A promise resolving to the response data object.

    • Generic function to send a signed request.

      Type Parameters

      • T

      Parameters

      • endpoint: string

        The API endpoint to call.

      • method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH"

        HTTP method to use (GET, POST, DELETE, etc.).

      • queryParams: Record<string, unknown> = {}

        Query parameters for the request.

      • bodyParams: Record<string, unknown> = {}

        Body parameters for the request.

      Returns Promise<RestApiResponse<T>>

      A promise resolving to the response data object.

    • Mint a tokenized asset from an underlying equity holding. The caller's underlying equity (e.g. AAPL) is burned (or locked), and the corresponding tokenized asset (e.g. AAPLB) is credited. The tokenized asset is resolved server-side from underlyingAsset; callers only provide the underlying ticker and quantity. Mint is asynchronous: the endpoint returns an issuerRequestId immediately with a transient status; poll /tokenized/convert-status to observe the terminal state, or inspect /tokenized/history for the full record. Rate limit: 50 requests / min (UID).

      Weight: 1

      Security Type: TRADE

      Parameters

      Returns Promise<RestApiResponse<TokenizedMintResponse>>

    • Redeem a tokenized asset back into the underlying equity. The caller's tokenized asset (e.g. AAPLB) is burned, and the corresponding underlying equity (e.g. AAPL) is released. The underlying asset is resolved server-side from tokenizedAsset; callers only provide the tokenized asset and quantity. Redeem is asynchronous: the endpoint returns an issuerRequestId immediately with a transient status; poll /tokenized/convert-status to observe the terminal state, or inspect /tokenized/history for the full record. Rate limit: 200 requests / min (UID).

      Weight: 1

      Security Type: TRADE

      Parameters

      Returns Promise<RestApiResponse<TokenizedRedeemResponse>>