Package markets.alpaca.client.openapi.broker.model

Class AdminConfigurations

java.lang.Object
markets.alpaca.client.openapi.broker.model.AdminConfigurations
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class AdminConfigurations extends Object implements Serializable
These configurations show account properties that are overriden either by Alpaca Broker Operations or an automated process. These values cannot be modified by the Broker Partners. This schema represents the current, effective value of each configuration (e.g. as returned by the get trading account endpoint). For the shape of the payloads broadcast by the **events** streaming API when these values change, see [AdminConfigurationsEvent](#/components/schemas/AdminConfigurationsEvent).
See Also:

  • Field Details

    • SERIALIZED_NAME_ACCT_DAILY_TRANSFER_LIMIT

      public static final String SERIALIZED_NAME_ACCT_DAILY_TRANSFER_LIMIT
      See Also:

    • SERIALIZED_NAME_ALLOW_INSTANT_ACH

      public static final String SERIALIZED_NAME_ALLOW_INSTANT_ACH
      See Also:

    • SERIALIZED_NAME_DISABLE_ALGODASH_ACCESS

      public static final String SERIALIZED_NAME_DISABLE_ALGODASH_ACCESS
      See Also:

    • SERIALIZED_NAME_DISABLE_API_KEY

      public static final String SERIALIZED_NAME_DISABLE_API_KEY
      See Also:

    • SERIALIZED_NAME_DISABLE_CRYPTO

      public static final String SERIALIZED_NAME_DISABLE_CRYPTO
      See Also:

    • SERIALIZED_NAME_DISABLE_DAY_TRADING

      public static final String SERIALIZED_NAME_DISABLE_DAY_TRADING
      See Also:

    • SERIALIZED_NAME_DISABLE_FRACTIONAL

      public static final String SERIALIZED_NAME_DISABLE_FRACTIONAL
      See Also:

    • SERIALIZED_NAME_DISABLE_SHORTING

      public static final String SERIALIZED_NAME_DISABLE_SHORTING
      See Also:

    • SERIALIZED_NAME_INCOMING_TRANSFERS_BLOCKED

      public static final String SERIALIZED_NAME_INCOMING_TRANSFERS_BLOCKED
      See Also:

    • SERIALIZED_NAME_MAX_MARGIN_MULTIPLIER

      public static final String SERIALIZED_NAME_MAX_MARGIN_MULTIPLIER
      See Also:

    • SERIALIZED_NAME_MAX_OPTIONS_TRADING_LEVEL

      public static final String SERIALIZED_NAME_MAX_OPTIONS_TRADING_LEVEL
      See Also:

    • SERIALIZED_NAME_OUTGOING_TRANSFERS_BLOCKED

      public static final String SERIALIZED_NAME_OUTGOING_TRANSFERS_BLOCKED
      See Also:

    • SERIALIZED_NAME_RESTRICT_TO_LIQUIDATION_REASONS

      public static final String SERIALIZED_NAME_RESTRICT_TO_LIQUIDATION_REASONS
      See Also:

    • openapiFields

      public static HashSet<String> openapiFields

    • openapiRequiredFields

      public static HashSet<String> openapiRequiredFields

  • Constructor Details

    • AdminConfigurations

      public AdminConfigurations()

  • Method Details

    • acctDailyTransferLimit

      public AdminConfigurations acctDailyTransferLimit(@Nullable BigDecimal acctDailyTransferLimit)

    • getAcctDailyTransferLimit

      @Nullable public BigDecimal getAcctDailyTransferLimit()
      Override the correspondent level daily transfer limits
      Returns:
      acctDailyTransferLimit

    • setAcctDailyTransferLimit

      public void setAcctDailyTransferLimit(@Nullable BigDecimal acctDailyTransferLimit)

    • allowInstantAch

      public AdminConfigurations allowInstantAch(@Nullable Boolean allowInstantAch)

    • getAllowInstantAch

      @Nullable public Boolean getAllowInstantAch()
      If true, the account is allowed to perform instant ACH
      Returns:
      allowInstantAch

    • setAllowInstantAch

      public void setAllowInstantAch(@Nullable Boolean allowInstantAch)

    • disableAlgodashAccess

      public AdminConfigurations disableAlgodashAccess(@Nullable Boolean disableAlgodashAccess)

    • getDisableAlgodashAccess

      @Nullable public Boolean getDisableAlgodashAccess()
      If true, the account is allowed to access algo dash
      Returns:
      disableAlgodashAccess

    • setDisableAlgodashAccess

      public void setDisableAlgodashAccess(@Nullable Boolean disableAlgodashAccess)

    • disableApiKey

      public AdminConfigurations disableApiKey(@Nullable Boolean disableApiKey)

    • getDisableApiKey

      @Nullable public Boolean getDisableApiKey()
      If true, the account's API key will be disabled
      Returns:
      disableApiKey

    • setDisableApiKey

      public void setDisableApiKey(@Nullable Boolean disableApiKey)

    • disableCrypto

      public AdminConfigurations disableCrypto(@Nullable Boolean disableCrypto)

    • getDisableCrypto

      @Nullable public Boolean getDisableCrypto()
      If true, the account is not allowed to trade cryptos
      Returns:
      disableCrypto

    • setDisableCrypto

      public void setDisableCrypto(@Nullable Boolean disableCrypto)

    • disableDayTrading

      public AdminConfigurations disableDayTrading(@Nullable Boolean disableDayTrading)

    • getDisableDayTrading

      @Nullable public Boolean getDisableDayTrading()
      If true, the account is not allowed to day trade (e.g. buy and sell the same security on the same day)
      Returns:
      disableDayTrading

    • setDisableDayTrading

      public void setDisableDayTrading(@Nullable Boolean disableDayTrading)

    • disableFractional

      public AdminConfigurations disableFractional(@Nullable Boolean disableFractional)

    • getDisableFractional

      @Nullable public Boolean getDisableFractional()
      If true, the account cannot create orders for fractional share positions
      Returns:
      disableFractional

    • setDisableFractional

      public void setDisableFractional(@Nullable Boolean disableFractional)

    • disableShorting

      public AdminConfigurations disableShorting(@Nullable Boolean disableShorting)

    • getDisableShorting

      @Nullable public Boolean getDisableShorting()
      If true the account is not allowed to create short position orders
      Returns:
      disableShorting

    • setDisableShorting

      public void setDisableShorting(@Nullable Boolean disableShorting)

    • incomingTransfersBlocked

      public AdminConfigurations incomingTransfersBlocked(@Nullable Boolean incomingTransfersBlocked)

    • getIncomingTransfersBlocked

      @Nullable public Boolean getIncomingTransfersBlocked()
      If true, incoming transfers to this account are rejected
      Returns:
      incomingTransfersBlocked

    • setIncomingTransfersBlocked

      public void setIncomingTransfersBlocked(@Nullable Boolean incomingTransfersBlocked)

    • maxMarginMultiplier

      public AdminConfigurations maxMarginMultiplier(@Nullable String maxMarginMultiplier)

    • getMaxMarginMultiplier

      @Nullable public String getMaxMarginMultiplier()
      The max margin multiplier set by admin for this account. Can be \"1\", \"2\", or \"4\".
      Returns:
      maxMarginMultiplier

    • setMaxMarginMultiplier

      public void setMaxMarginMultiplier(@Nullable String maxMarginMultiplier)

    • maxOptionsTradingLevel

      public AdminConfigurations maxOptionsTradingLevel(@Nullable AdminConfigurations.MaxOptionsTradingLevelEnum maxOptionsTradingLevel)

    • getMaxOptionsTradingLevel

      @Nullable public AdminConfigurations.MaxOptionsTradingLevelEnum getMaxOptionsTradingLevel()
      The max options trading level set by admin for this account. 0=disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles.
      Returns:
      maxOptionsTradingLevel

    • setMaxOptionsTradingLevel

      public void setMaxOptionsTradingLevel(@Nullable AdminConfigurations.MaxOptionsTradingLevelEnum maxOptionsTradingLevel)

    • outgoingTransfersBlocked

      public AdminConfigurations outgoingTransfersBlocked(@Nullable Boolean outgoingTransfersBlocked)

    • getOutgoingTransfersBlocked

      @Nullable public Boolean getOutgoingTransfersBlocked()
      If true, outgoing transfers from this account are rejected
      Returns:
      outgoingTransfersBlocked

    • setOutgoingTransfersBlocked

      public void setOutgoingTransfersBlocked(@Nullable Boolean outgoingTransfersBlocked)

    • restrictToLiquidationReasons

      public AdminConfigurations restrictToLiquidationReasons(@Nullable RestrictToLiquidationReasons restrictToLiquidationReasons)

    • getRestrictToLiquidationReasons

      @Nullable public RestrictToLiquidationReasons getRestrictToLiquidationReasons()
      Get restrictToLiquidationReasons
      Returns:
      restrictToLiquidationReasons

    • setRestrictToLiquidationReasons

      public void setRestrictToLiquidationReasons(@Nullable RestrictToLiquidationReasons restrictToLiquidationReasons)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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