Binance Connector JS
    Preparing search index...

    Interface SpotAlgoApiInterface

    SpotAlgoApi - interface SpotAlgoApi

    interface SpotAlgoApiInterface {
        cancelAlgoOrderSpotAlgo(
            requestParameters?: CancelAlgoOrderSpotAlgoRequest,
        ): Promise<RestApiResponse<CancelAlgoOrderSpotAlgoResponse>>;
        queryCurrentAlgoOpenOrdersSpotAlgo(
            requestParameters?: QueryCurrentAlgoOpenOrdersSpotAlgoRequest,
        ): Promise<RestApiResponse<QueryCurrentAlgoOpenOrdersSpotAlgoResponse>>;
        queryHistoricalAlgoOrdersSpotAlgo(
            requestParameters?: QueryHistoricalAlgoOrdersSpotAlgoRequest,
        ): Promise<RestApiResponse<QueryHistoricalAlgoOrdersSpotAlgoResponse>>;
        querySubOrdersSpotAlgo(
            requestParameters: QuerySubOrdersSpotAlgoRequest,
        ): Promise<RestApiResponse<QuerySubOrdersSpotAlgoResponse>>;
        timeWeightedAveragePriceSpotAlgo(
            requestParameters: TimeWeightedAveragePriceSpotAlgoRequest,
        ): Promise<RestApiResponse<TimeWeightedAveragePriceSpotAlgoResponse>>;
        volumeParticipation(
            requestParameters: VolumeParticipationRequest,
        ): Promise<RestApiResponse<VolumeParticipationResponse>>;
    }

    Implemented by

    Index

    Methods

    cancelAlgoOrderSpotAlgo queryCurrentAlgoOpenOrdersSpotAlgo queryHistoricalAlgoOrdersSpotAlgo querySubOrdersSpotAlgo timeWeightedAveragePriceSpotAlgo volumeParticipation

    Methods

    • Place a new spot VP (Volume Participation) order with Algo service. A VP order automatically slices the total quantity over time, targeting a percentage of the market volume.

      Weight(UID): 3000

      Security Type: TRADE

      Notes:

      • VP orders do not accept price or timeInForce; pricing is determined algorithmically based on market volume.
      • urgency controls the participation rate: LOW = passive, MEDIUM = neutral, HIGH = aggressive.
      • Receiving "success": true does not guarantee execution; use the query order endpoints (GET /sapi/v1/algo/spot/openOrders or GET /sapi/v1/algo/spot/historicalOrders) to check the final status.
      • You need to enable the Spot Trading permission for the API key requesting this endpoint.
      • Base URL: https://api.binance.com

      Parameters

      Returns Promise<RestApiResponse<VolumeParticipationResponse>>

      SpotAlgoApiInterface

    Settings

    Member Visibility

    On This Page

    Methods