Class AccountTradingLimit

java.lang.Object
markets.alpaca.client.openapi.broker.model.AccountTradingLimit
All Implemented Interfaces:
Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class AccountTradingLimit extends Object implements Serializable
AccountTradingLimit
See Also:
  • Field Details

  • Constructor Details

    • AccountTradingLimit

      public AccountTradingLimit()
  • Method Details

    • available

      public AccountTradingLimit available(@Nullable BigDecimal available)
    • getAvailable

      @Nullable public BigDecimal getAvailable()
      The remaining net buying limit that can be used for trading.
      Returns:
      available
    • setAvailable

      public void setAvailable(@Nullable BigDecimal available)
    • dailyNetLimit

      public AccountTradingLimit dailyNetLimit(@Nullable BigDecimal dailyNetLimit)
    • getDailyNetLimit

      @Nullable public BigDecimal getDailyNetLimit()
      The net buying limit that can be reached before further trading activity is restricted. Please reach out to learn more about how this limit is determined.
      Returns:
      dailyNetLimit
    • setDailyNetLimit

      public void setDailyNetLimit(@Nullable BigDecimal dailyNetLimit)
    • held

      public AccountTradingLimit held(@Nullable BigDecimal held)
    • getHeld

      @Nullable public BigDecimal getHeld()
      The limit that is currently being held for open orders
      Returns:
      held
    • setHeld

      public void setHeld(@Nullable BigDecimal held)
    • swapRate

      public AccountTradingLimit swapRate(@Nullable BigDecimal swapRate)
    • getSwapRate

      @Nullable public BigDecimal getSwapRate()
      The swap rate is applicable for Local Currency Trading (LCT) accounts
      Returns:
      swapRate
    • setSwapRate

      public void setSwapRate(@Nullable BigDecimal swapRate)
    • usd

      public AccountTradingLimit usd(@Nullable USDAccountTradingLimit usd)
    • getUsd

      @Nullable public USDAccountTradingLimit getUsd()
      Get usd
      Returns:
      usd
    • setUsd

      public void setUsd(@Nullable USDAccountTradingLimit usd)
    • used

      public AccountTradingLimit used(@Nullable BigDecimal used)
    • getUsed

      @Nullable public BigDecimal getUsed()
      The real time net value of cash inflows (buy trades, etc.) with cash outflows (sell trades, etc). This will be dynamic throughout the day based on user activity, with executed orders being reset at the start of the next trading day.
      Returns:
      used
    • setUsed

      public void setUsed(@Nullable BigDecimal used)
    • putAdditionalProperty

      public AccountTradingLimit 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 AccountTradingLimit 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 AccountTradingLimit
    • fromJson

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

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