Binance Connector JS
    Preparing search index...

    Interface OrderCancelReplaceRequest

    Request parameters for orderCancelReplace operation in TradeApi. OrderCancelReplaceRequest

    interface OrderCancelReplaceRequest {
        cancelNewClientOrderId?: string;
        cancelOrderId?: number | bigint;
        cancelOrigClientOrderId?: string;
        cancelReplaceMode: SpotWebsocketAPI.OrderCancelReplaceCancelReplaceModeEnum;
        cancelRestrictions?: SpotWebsocketAPI.OrderCancelReplaceCancelRestrictionsEnum;
        icebergQty?: number;
        id?: string;
        newClientOrderId?: string;
        newOrderRespType?: SpotWebsocketAPI.OrderCancelReplaceNewOrderRespTypeEnum;
        orderRateLimitExceededMode?: SpotWebsocketAPI.OrderCancelReplaceOrderRateLimitExceededModeEnum;
        pegOffsetType?: PRICE_LEVEL;
        pegOffsetValue?: number;
        pegPriceType?: SpotWebsocketAPI.OrderCancelReplacePegPriceTypeEnum;
        price?: number;
        quantity?: number;
        quoteOrderQty?: number;
        recvWindow?: number;
        selfTradePreventionMode?: SpotWebsocketAPI.OrderCancelReplaceSelfTradePreventionModeEnum;
        side: SpotWebsocketAPI.OrderCancelReplaceSideEnum;
        stopPrice?: number;
        strategyId?: number | bigint;
        strategyType?: number;
        symbol: string;
        timeInForce?: SpotWebsocketAPI.OrderCancelReplaceTimeInForceEnum;
        trailingDelta?: number;
        type: SpotWebsocketAPI.OrderCancelReplaceTypeEnum;
    }
    Index

    Properties

    cancelNewClientOrderId? cancelOrderId? cancelOrigClientOrderId? cancelReplaceMode cancelRestrictions? icebergQty? id? newClientOrderId? newOrderRespType? orderRateLimitExceededMode? pegOffsetType? pegOffsetValue? pegPriceType? price? quantity? quoteOrderQty? recvWindow? selfTradePreventionMode? side stopPrice? strategyId? strategyType? symbol timeInForce? trailingDelta? type

    Properties

    cancelNewClientOrderId?: string

    Used to uniquely identify this cancel. Automatically generated by default.

    TradeApiOrderCancelReplace

    cancelOrderId?: number | bigint

    Either cancelOrderId or cancelOrigClientOrderId must be sent.

    If both cancelOrderId and cancelOrigClientOrderId parameters are provided, the cancelOrderId is searched first, then the cancelOrigClientOrderId from that result is checked against that order.

    If both conditions are not met the request will be rejected.

    TradeApiOrderCancelReplace

    cancelOrigClientOrderId?: string

    Either cancelOrderId or cancelOrigClientOrderId must be sent.

    If both cancelOrderId and cancelOrigClientOrderId parameters are provided, the cancelOrderId is searched first, then the cancelOrigClientOrderId from that result is checked against that order.

    If both conditions are not met the request will be rejected.

    TradeApiOrderCancelReplace

    cancelReplaceMode: SpotWebsocketAPI.OrderCancelReplaceCancelReplaceModeEnum

    The allowed values are:
    STOP_ON_FAILURE - If the cancel request fails, the new order placement will not be attempted.
    ALLOW_FAILURE - new order placement will be attempted even if cancel request fails.

    TradeApiOrderCancelReplace

    cancelRestrictions?: SpotWebsocketAPI.OrderCancelReplaceCancelRestrictionsEnum

    Supported values:
    ONLY_NEW - Cancel will succeed if the order status is NEW.
    ONLY_PARTIALLY_FILLED - Cancel will succeed if order status is PARTIALLY_FILLED.

    TradeApiOrderCancelReplace

    icebergQty?: number

    Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order.

    TradeApiOrderCancelReplace

    id?: string

    Client-generated request identifier.

    TradeApiOrderCancelReplace

    newClientOrderId?: string

    Used to identify the new order.

    TradeApiOrderCancelReplace

    newOrderRespType?: SpotWebsocketAPI.OrderCancelReplaceNewOrderRespTypeEnum

    Allowed values:
    ACK, RESULT, FULL
    MARKET and LIMIT orders types default to FULL; all other orders default to ACK

    TradeApiOrderCancelReplace

    orderRateLimitExceededMode?: SpotWebsocketAPI.OrderCancelReplaceOrderRateLimitExceededModeEnum

    Supported values:
    DO_NOTHING (default)- will only attempt to cancel the order if account has not exceeded the unfilled order rate limit
    CANCEL_ONLY - will always cancel the order

    TradeApiOrderCancelReplace

    pegOffsetType?: PRICE_LEVEL

    Only PRICE_LEVEL is supported
    See Pegged Orders

    TradeApiOrderCancelReplace

    pegOffsetValue?: number

    Price level to peg the price to (max: 100)
    See Pegged Orders

    TradeApiOrderCancelReplace

    pegPriceType?: SpotWebsocketAPI.OrderCancelReplacePegPriceTypeEnum

    PRIMARY_PEG or MARKET_PEG
    See Pegged Orders

    TradeApiOrderCancelReplace

    price?: number

    TradeApiOrderCancelReplace

    quantity?: number

    TradeApiOrderCancelReplace

    quoteOrderQty?: number

    TradeApiOrderCancelReplace

    recvWindow?: number

    Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.

    TradeApiOrderCancelReplace

    selfTradePreventionMode?: SpotWebsocketAPI.OrderCancelReplaceSelfTradePreventionModeEnum

    The allowed enums is dependent on what is configured on the symbol. The possible supported values are: STP Modes.

    TradeApiOrderCancelReplace

    side: SpotWebsocketAPI.OrderCancelReplaceSideEnum

    Please see Enums for supported values.

    TradeApiOrderCancelReplace

    stopPrice?: number

    Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.

    TradeApiOrderCancelReplace

    strategyId?: number | bigint

    TradeApiOrderCancelReplace

    strategyType?: number

    The value cannot be less than 1000000.

    TradeApiOrderCancelReplace

    symbol: string

    TradeApiOrderCancelReplace

    timeInForce?: SpotWebsocketAPI.OrderCancelReplaceTimeInForceEnum

    Please see Enums for supported values.

    TradeApiOrderCancelReplace

    trailingDelta?: number

    See Trailing Stop order FAQ

    TradeApiOrderCancelReplace

    type: SpotWebsocketAPI.OrderCancelReplaceTypeEnum

    Please see Enums for supported values.

    TradeApiOrderCancelReplace

    Settings

    Member Visibility

    On This Page

    Properties