Package markets.alpaca.client.openapi.trading.model

Class AdvancedInstructions

java.lang.Object
markets.alpaca.client.openapi.trading.model.AdvancedInstructions
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class AdvancedInstructions extends Object implements Serializable
Advanced instructions for Elite Smart Router: https://docs.alpaca.markets/docs/alpaca-elite-smart-router
See Also:

  • Field Details

  • Constructor Details

    • AdvancedInstructions

      public AdvancedInstructions()

  • Method Details

    • algorithm

      public AdvancedInstructions algorithm(@Nullable AdvancedInstructions.AlgorithmEnum algorithm)

    • getAlgorithm

      @Nullable public AdvancedInstructions.AlgorithmEnum getAlgorithm()
      The advanced routing algorithm to use for the order
      Returns:
      algorithm

    • setAlgorithm

      public void setAlgorithm(@Nullable AdvancedInstructions.AlgorithmEnum algorithm)

    • destination

      public AdvancedInstructions destination(@Nullable AdvancedInstructions.DestinationEnum destination)

    • getDestination

      @Nullable public AdvancedInstructions.DestinationEnum getDestination()
      Target exchange for order execution
      Returns:
      destination

    • setDestination

      public void setDestination(@Nullable AdvancedInstructions.DestinationEnum destination)

    • displayQty

      public AdvancedInstructions displayQty(@Nullable BigDecimal displayQty)

    • getDisplayQty

      @Nullable public BigDecimal getDisplayQty()
      Maximum shares/contracts displayed on the exchange at any time. Must be in round lot increments
      Returns:
      displayQty

    • setDisplayQty

      public void setDisplayQty(@Nullable BigDecimal displayQty)

    • endTime

      public AdvancedInstructions endTime(@Nullable OffsetDateTime endTime)

    • getEndTime

      @Nullable public OffsetDateTime getEndTime()
      When the algorithm is to be done executing. Must be within current market trading hours
      Returns:
      endTime

    • setEndTime

      public void setEndTime(@Nullable OffsetDateTime endTime)

    • maxPercentage

      public AdvancedInstructions maxPercentage(@Nullable BigDecimal maxPercentage)

    • getMaxPercentage

      @Nullable public BigDecimal getMaxPercentage()
      Maximum percentage of the ticker's period volume this order might participate in. Must be 0 < max_percentage < 1, with up to 3 decimal points precision.
      Returns:
      maxPercentage

    • setMaxPercentage

      public void setMaxPercentage(@Nullable BigDecimal maxPercentage)

    • startTime

      public AdvancedInstructions startTime(@Nullable OffsetDateTime startTime)

    • getStartTime

      @Nullable public OffsetDateTime getStartTime()
      When the algorithm is to start executing. Must be within current market trading hours
      Returns:
      startTime

    • setStartTime

      public void setStartTime(@Nullable OffsetDateTime startTime)

    • putAdditionalProperty

      public AdvancedInstructions putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the AdvancedInstructions instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to AdvancedInstructions

    • fromJson

      public static AdvancedInstructions fromJson(String jsonString) throws IOException
      Create an instance of AdvancedInstructions given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of AdvancedInstructions
      Throws:
      IOException - if the JSON string is invalid with respect to AdvancedInstructions

    • toJson

      public String toJson()
      Convert an instance of AdvancedInstructions to an JSON string
      Returns:
      JSON string