AmendOcoLegOrderRequest

  • lifetime
    Type: string
    required

    The order lifetime. The time for which the order is valid. Call orders destinations endpoint for complete list including lifetime and pricingInstruction options.

  • orderNumber
    Type: number
    required

    Order number of the leg order to be amended.

  • pricingInstruction
    Type: string
    required

    Represents the price attribute and order attribute of the market order, ie, Limit, Market. Call orders destinations endpoint for complete list including lifetime and pricingInstruction options.

  • side
    Type: string enum
    required

    The side of the order.

    values
    • Buy
    • Sell
    • Short
  • dataFields
    Type: object · DataFieldsProperties

    Properties that can be added on dataFields property. FixedContigentOrder properties can only be used when the destination is 'FIXED CO'. TrailingContingentOrder properties can only be used whtn the destination is 'TRAILING CO'.

    • brokerageOverride.minimum
      Type: string | null

      A flat $value brokerage override, excluding GST, to 2 decimal places. Applies to Limit or MarketToLimit pricingInstruction only. Overrides the current order only, does not modify the default rate for future trades.

    • brokerageOverride.schedule
      Type: string Format: string

      Schedule for brokerage override.

    • fixedContingentOrder.expiryDate
      Type: string Format: date-time

      Optional value to set the expiry date of the contingent order. Can only be used when Destination is 'FIXED CO'; otherwise, it will be ignored.

    • fixedContingentOrder.triggerCondition
      Type: string enum

      The condition that will trigger the order creation. Required when Destination is 'FIXED CO'; otherwise, it will be ignored.

      values
      • Greater
      • Less
      • GreaterOrEqual
      • LessOrEqual
    • fixedContingentOrder.triggerPrice
      Type: string Format: double

      The price that will trigger the order creation. Required when Destination is 'FIXED CO'; otherwise, it will be ignored.

    • fixedContingentOrder.triggerPriceType
      Type: string enum

      The type of price that will trigger the order creation. Required when Destination is 'FIXED CO'; otherwise, it will be ignored.

      values
      • Last
      • Bid
      • Ask
    • fixedContingentOrder.triggerSecurity
      Type: string

      Security in the form of 'securityCode.exchange' that will trigger the order creation. Required when Destination is 'FIXED CO'; otherwise, it will be ignored.

    • originOfOrder
      Type: string
      max length:  
      512

      String value that tells the origin of order.

    • trailingContingentOrder.expiryDate
      Type: string Format: date-time

      Optional value to set the expiry date of the contingent order. Can only be used when Destination is 'TRAILING CO'; otherwise, it will be ignored.

    • trailingContingentOrder.limitOffset
      Type: string

      The unit or percentage to limit the offset. Optional, use only when Destination is 'TRAILING CO'; otherwise, it will be ignored.

    • trailingContingentOrder.limitOffsetType
      Type: string enum

      The type of unit which the offset limit would apply to. Optional, use only when Destination is 'TRAILING CO'; otherwise, it will be ignored. Default value is 'PRICE'.

      values
      • Price
      • Percentage
      • PriceStep
    • trailingContingentOrder.trailingDirection
      Type: string enum

      The direction to recalculate the trigger price. Optional, use only when Destination is 'TRAILING CO'; otherwise, it will be ignored. Default value is 'Up'.

      values
      • Up
      • Down
    • trailingContingentOrder.trailingOffset
      Type: string

      The number of units or percentage where the user would like the stop to be set from the current price. Required when Destination is 'TRAILING CO'; otherwise, it will be ignored.

    • trailingContingentOrder.trailingOffsetType
      Type: string enum

      The type of unit which trailing offset would apply to. Optional, use only when Destination is 'TRAILING CO'; otherwise, it will be ignored. Default value is 'Price'.

      values
      • Price
      • Percentage
      • PriceStep
    • trailingContingentOrder.trailingPrice
      Type: string

      The base price for trailing orders. Optional, use only when Destination is 'TRAILING CO'; otherwise, it will be ignored.

    • trailingContingentOrder.trailingStep
      Type: string

      The unit or percentage movement that will cause the trailing price to be reset or recalculated. Optional, use only when Destination is 'TRAILING CO'; otherwise, it will be ignored. Default value is '1'.

    • trailingContingentOrder.trailingStepType
      Type: string enum

      The type of unit which trailing step would apply to. Optional, use only when Destination is 'TRAILING CO'; otherwise, it will be ignored.

      values
      • Price
      • Percentage
      • PriceStep
    • trailingContingentOrder.triggerSecurity
      Type: string

      Security in the form of 'securityCode.exchange' that will trigger the order creation. Required when Destination is 'TRAILING CO'; otherwise, it will be ignored.

  • expiryDateTime
    Type: string Format: date-time

    Date and time the order will be removed from the market if it hasn't fully traded. (Exchange time).

  • notes
    Type: string
    max length:  
    512

    Custom notes to attach to the order.

  • orderPrice
    Type: number Format: double

    The order price.

  • orderVolume
    Type: number Format: double

    The order volume.