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

Class CreateLocateRequest

java.lang.Object
markets.alpaca.client.openapi.trading.model.CreateLocateRequest
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CreateLocateRequest extends Object implements Serializable
Request to locate shares for a short sale.
See Also:

  • Field Details

  • Constructor Details

    • CreateLocateRequest

      public CreateLocateRequest()

  • Method Details

    • allOrNone

      public CreateLocateRequest allOrNone(@Nullable Boolean allOrNone)

    • getAllOrNone

      @Nullable public Boolean getAllOrNone()
      Reject the locate unless the full requested quantity is available.
      Returns:
      allOrNone

    • setAllOrNone

      public void setAllOrNone(@Nullable Boolean allOrNone)

    • limitPrice

      public CreateLocateRequest limitPrice(@Nullable String limitPrice)

    • getLimitPrice

      @Nullable public String getLimitPrice()
      Maximum acceptable locate fee per share, as a decimal string in USD. If omitted, any quoted fee is accepted.
      Returns:
      limitPrice

    • setLimitPrice

      public void setLimitPrice(@Nullable String limitPrice)

    • qty

      public CreateLocateRequest qty(@Nonnull Long qty)

    • getQty

      @Nonnull public Long getQty()
      Number of shares to locate. Must be positive and in round lots of 100; invalid quantities return HTTP 400. minimum: 1
      Returns:
      qty

    • setQty

      public void setQty(@Nonnull Long qty)

    • symbol

      public CreateLocateRequest symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      Stock symbol.
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • putAdditionalProperty

      public CreateLocateRequest 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 CreateLocateRequest 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 CreateLocateRequest

    • fromJson

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

    • toJson

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