Account (alpaca-java 5.0.13 API)

java.lang.Object
- io.github.mainstringargs.domain.alpaca.account.Account

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AccountUpdate
```
public class Account
extends java.lang.Object
implements java.io.Serializable
```
See https://docs.alpaca.markets/api-documentation/api-v2/account/

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Account()` No args constructor for use in serialization
Account(java.lang.String id, java.lang.String accountNumber, AccountStatus status, java.lang.String currency, java.lang.String cash, java.lang.String portfolioValue, java.lang.Boolean patternDayTrader, java.lang.Boolean tradeSuspendedByUser, java.lang.Boolean tradingBlocked, java.lang.Boolean transfersBlocked, java.lang.Boolean accountBlocked, java.time.ZonedDateTime createdAt, java.lang.Boolean shortingEnabled, java.lang.String longMarketValue, java.lang.String shortMarketValue, java.lang.String equity, java.lang.String lastEquity, java.lang.String multiplier, java.lang.String buyingPower, java.lang.String initialMargin, java.lang.String maintenanceMargin, java.lang.String sma, java.lang.Integer daytradeCount, java.lang.String lastMaintenanceMargin, java.lang.String daytradingBuyingPower, java.lang.String regtBuyingPower)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object other)`
`java.lang.Boolean`	`getAccountBlocked()` If true, the account activity by user is prohibited.
`java.lang.String`	`getAccountNumber()` Account number.
`java.lang.String`	`getBuyingPower()` Current available $ buying power; If multiplier = 4, this is your daytrade buying power which is calculated as (last_equity - (last) maintenance_margin) * 4; If multiplier = 2, buying_power = max(equity – initial_margin,0) * 2; If multiplier = 1, buying_power = cash
`java.lang.String`	`getCash()` Cash balance
`java.time.ZonedDateTime`	`getCreatedAt()` Timestamp this account was created at
`java.lang.String`	`getCurrency()` “USD”
`java.lang.Integer`	`getDaytradeCount()` The current number of daytrades that have been made in the last 5 trading days (inclusive of today)
`java.lang.String`	`getDaytradingBuyingPower()` Your buying power for day trades (continuously updated value)
`java.lang.String`	`getEquity()` Cash + long_market_value + short_market_value
`java.lang.String`	`getId()` Account ID.
`java.lang.String`	`getInitialMargin()` Reg T initial margin requirement (continuously updated value)
`java.lang.String`	`getLastEquity()` Equity as of previous trading day at 16:00:00 ET
`java.lang.String`	`getLastMaintenanceMargin()` Your maintenance margin requirement on the previous trading day
`java.lang.String`	`getLongMarketValue()` Real-time MtM value of all long positions held in the account
`java.lang.String`	`getMaintenanceMargin()` Maintenance margin requirement (continuously updated value)
`java.lang.String`	`getMultiplier()` Buying power multiplier that represents account margin classification; valid values 1 (standard limited margin account with 1x buying power), 2 (reg T margin account with 2x intraday and overnight buying power; this is the default for all non-PDT accounts with $2,000 or more equity), 4 (PDT account with 4x intraday buying power and 2x reg T overnight buying power)
`java.lang.Boolean`	`getPatternDayTrader()` Whether or not the account has been flagged as a pattern day trader
`java.lang.String`	`getPortfolioValue()` Total value of cash + holding positions (This field is deprecated.
`java.lang.String`	`getRegtBuyingPower()` Your buying power under Regulation T (your excess equity - equity minus margin value - times your margin multiplier)
`java.lang.Boolean`	`getShortingEnabled()` Flag to denote whether or not the account is permitted to short
`java.lang.String`	`getShortMarketValue()` Real-time MtM value of all short positions held in the account
`java.lang.String`	`getSma()` Value of special memorandum account (will be used at a later date to provide additional buying_power)
`AccountStatus`	`getStatus()` See Account Status
`java.lang.Boolean`	`getTradeSuspendedByUser()` User setting.
`java.lang.Boolean`	`getTradingBlocked()` If true, the account is not allowed to place orders.
`java.lang.Boolean`	`getTransfersBlocked()` If true, the account is not allowed to request money transfers.
`int`	`hashCode()`
`void`	`setAccountBlocked(java.lang.Boolean accountBlocked)` If true, the account activity by user is prohibited.
`void`	`setAccountNumber(java.lang.String accountNumber)` Account number.
`void`	`setBuyingPower(java.lang.String buyingPower)` Current available $ buying power; If multiplier = 4, this is your daytrade buying power which is calculated as (last_equity - (last) maintenance_margin) * 4; If multiplier = 2, buying_power = max(equity – initial_margin,0) * 2; If multiplier = 1, buying_power = cash
`void`	`setCash(java.lang.String cash)` Cash balance
`void`	`setCreatedAt(java.time.ZonedDateTime createdAt)` Timestamp this account was created at
`void`	`setCurrency(java.lang.String currency)` “USD”
`void`	`setDaytradeCount(java.lang.Integer daytradeCount)` The current number of daytrades that have been made in the last 5 trading days (inclusive of today)
`void`	`setDaytradingBuyingPower(java.lang.String daytradingBuyingPower)` Your buying power for day trades (continuously updated value)
`void`	`setEquity(java.lang.String equity)` Cash + long_market_value + short_market_value
`void`	`setId(java.lang.String id)` Account ID.
`void`	`setInitialMargin(java.lang.String initialMargin)` Reg T initial margin requirement (continuously updated value)
`void`	`setLastEquity(java.lang.String lastEquity)` Equity as of previous trading day at 16:00:00 ET
`void`	`setLastMaintenanceMargin(java.lang.String lastMaintenanceMargin)` Your maintenance margin requirement on the previous trading day
`void`	`setLongMarketValue(java.lang.String longMarketValue)` Real-time MtM value of all long positions held in the account
`void`	`setMaintenanceMargin(java.lang.String maintenanceMargin)` Maintenance margin requirement (continuously updated value)
`void`	`setMultiplier(java.lang.String multiplier)` Buying power multiplier that represents account margin classification; valid values 1 (standard limited margin account with 1x buying power), 2 (reg T margin account with 2x intraday and overnight buying power; this is the default for all non-PDT accounts with $2,000 or more equity), 4 (PDT account with 4x intraday buying power and 2x reg T overnight buying power)
`void`	`setPatternDayTrader(java.lang.Boolean patternDayTrader)` Whether or not the account has been flagged as a pattern day trader
`void`	`setPortfolioValue(java.lang.String portfolioValue)` Total value of cash + holding positions (This field is deprecated.
`void`	`setRegtBuyingPower(java.lang.String regtBuyingPower)` Your buying power under Regulation T (your excess equity - equity minus margin value - times your margin multiplier)
`void`	`setShortingEnabled(java.lang.Boolean shortingEnabled)` Flag to denote whether or not the account is permitted to short
`void`	`setShortMarketValue(java.lang.String shortMarketValue)` Real-time MtM value of all short positions held in the account
`void`	`setSma(java.lang.String sma)` Value of special memorandum account (will be used at a later date to provide additional buying_power)
`void`	`setStatus(AccountStatus status)` See Account Status
`void`	`setTradeSuspendedByUser(java.lang.Boolean tradeSuspendedByUser)` User setting.
`void`	`setTradingBlocked(java.lang.Boolean tradingBlocked)` If true, the account is not allowed to place orders.
`void`	`setTransfersBlocked(java.lang.Boolean transfersBlocked)` If true, the account is not allowed to request money transfers.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Account
```
public Account()
```
    No args constructor for use in serialization
  - Account
```
public Account(java.lang.String id,
               java.lang.String accountNumber,
               AccountStatus status,
               java.lang.String currency,
               java.lang.String cash,
               java.lang.String portfolioValue,
               java.lang.Boolean patternDayTrader,
               java.lang.Boolean tradeSuspendedByUser,
               java.lang.Boolean tradingBlocked,
               java.lang.Boolean transfersBlocked,
               java.lang.Boolean accountBlocked,
               java.time.ZonedDateTime createdAt,
               java.lang.Boolean shortingEnabled,
               java.lang.String longMarketValue,
               java.lang.String shortMarketValue,
               java.lang.String equity,
               java.lang.String lastEquity,
               java.lang.String multiplier,
               java.lang.String buyingPower,
               java.lang.String initialMargin,
               java.lang.String maintenanceMargin,
               java.lang.String sma,
               java.lang.Integer daytradeCount,
               java.lang.String lastMaintenanceMargin,
               java.lang.String daytradingBuyingPower,
               java.lang.String regtBuyingPower)
```
    Parameters:
    
    tradingBlocked -
    
    sma -
    
    tradeSuspendedByUser -
    
    portfolioValue -
    
    equity -
    
    initialMargin -
    
    createdAt -
    
    buyingPower -
    
    maintenanceMargin -
    
    currency -
    
    id -
    
    cash -
    
    lastMaintenanceMargin -
    
    daytradingBuyingPower -
    
    longMarketValue -
    
    shortingEnabled -
    
    multiplier -
    
    lastEquity -
    
    shortMarketValue -
    
    accountNumber -
    
    patternDayTrader -
    
    daytradeCount -
    
    transfersBlocked -
    
    regtBuyingPower -
    
    accountBlocked -
    
    status -
- Method Detail
  - getId
```
public java.lang.String getId()
```
    Account ID.
  - setId
```
public void setId(java.lang.String id)
```
    Account ID.
  - getAccountNumber
```
public java.lang.String getAccountNumber()
```
    Account number.
  - setAccountNumber
```
public void setAccountNumber(java.lang.String accountNumber)
```
    Account number.
  - getStatus
```
public AccountStatus getStatus()
```
    See Account Status
  - setStatus
```
public void setStatus(AccountStatus status)
```
    See Account Status
  - getCurrency
```
public java.lang.String getCurrency()
```
    “USD”
  - setCurrency
```
public void setCurrency(java.lang.String currency)
```
    “USD”
  - getCash
```
public java.lang.String getCash()
```
    Cash balance
  - setCash
```
public void setCash(java.lang.String cash)
```
    Cash balance
  - getPortfolioValue
```
public java.lang.String getPortfolioValue()
```
    Total value of cash + holding positions (This field is deprecated. It is equivalent to the equity field.)
  - setPortfolioValue
```
public void setPortfolioValue(java.lang.String portfolioValue)
```
    Total value of cash + holding positions (This field is deprecated. It is equivalent to the equity field.)
  - getPatternDayTrader
```
public java.lang.Boolean getPatternDayTrader()
```
    Whether or not the account has been flagged as a pattern day trader
  - setPatternDayTrader
```
public void setPatternDayTrader(java.lang.Boolean patternDayTrader)
```
    Whether or not the account has been flagged as a pattern day trader
  - getTradeSuspendedByUser
```
public java.lang.Boolean getTradeSuspendedByUser()
```
    User setting. If true, the account is not allowed to place orders.
  - setTradeSuspendedByUser
```
public void setTradeSuspendedByUser(java.lang.Boolean tradeSuspendedByUser)
```
    User setting. If true, the account is not allowed to place orders.
  - getTradingBlocked
```
public java.lang.Boolean getTradingBlocked()
```
    If true, the account is not allowed to place orders.
  - setTradingBlocked
```
public void setTradingBlocked(java.lang.Boolean tradingBlocked)
```
    If true, the account is not allowed to place orders.
  - getTransfersBlocked
```
public java.lang.Boolean getTransfersBlocked()
```
    If true, the account is not allowed to request money transfers.
  - setTransfersBlocked
```
public void setTransfersBlocked(java.lang.Boolean transfersBlocked)
```
    If true, the account is not allowed to request money transfers.
  - getAccountBlocked
```
public java.lang.Boolean getAccountBlocked()
```
    If true, the account activity by user is prohibited.
  - setAccountBlocked
```
public void setAccountBlocked(java.lang.Boolean accountBlocked)
```
    If true, the account activity by user is prohibited.
  - getCreatedAt
```
public java.time.ZonedDateTime getCreatedAt()
```
    Timestamp this account was created at
  - setCreatedAt
```
public void setCreatedAt(java.time.ZonedDateTime createdAt)
```
    Timestamp this account was created at
  - getShortingEnabled
```
public java.lang.Boolean getShortingEnabled()
```
    Flag to denote whether or not the account is permitted to short
  - setShortingEnabled
```
public void setShortingEnabled(java.lang.Boolean shortingEnabled)
```
    Flag to denote whether or not the account is permitted to short
  - getLongMarketValue
```
public java.lang.String getLongMarketValue()
```
    Real-time MtM value of all long positions held in the account
  - setLongMarketValue
```
public void setLongMarketValue(java.lang.String longMarketValue)
```
    Real-time MtM value of all long positions held in the account
  - getShortMarketValue
```
public java.lang.String getShortMarketValue()
```
    Real-time MtM value of all short positions held in the account
  - setShortMarketValue
```
public void setShortMarketValue(java.lang.String shortMarketValue)
```
    Real-time MtM value of all short positions held in the account
  - getEquity
```
public java.lang.String getEquity()
```
    Cash + long_market_value + short_market_value
  - setEquity
```
public void setEquity(java.lang.String equity)
```
    Cash + long_market_value + short_market_value
  - getLastEquity
```
public java.lang.String getLastEquity()
```
    Equity as of previous trading day at 16:00:00 ET
  - setLastEquity
```
public void setLastEquity(java.lang.String lastEquity)
```
    Equity as of previous trading day at 16:00:00 ET
  - getMultiplier
```
public java.lang.String getMultiplier()
```
    Buying power multiplier that represents account margin classification; valid values 1 (standard limited margin account with 1x buying power), 2 (reg T margin account with 2x intraday and overnight buying power; this is the default for all non-PDT accounts with $2,000 or more equity), 4 (PDT account with 4x intraday buying power and 2x reg T overnight buying power)
  - setMultiplier
```
public void setMultiplier(java.lang.String multiplier)
```
    Buying power multiplier that represents account margin classification; valid values 1 (standard limited margin account with 1x buying power), 2 (reg T margin account with 2x intraday and overnight buying power; this is the default for all non-PDT accounts with $2,000 or more equity), 4 (PDT account with 4x intraday buying power and 2x reg T overnight buying power)
  - getBuyingPower
```
public java.lang.String getBuyingPower()
```
    Current available $ buying power; If multiplier = 4, this is your daytrade buying power which is calculated as (last_equity - (last) maintenance_margin) * 4; If multiplier = 2, buying_power = max(equity – initial_margin,0) * 2; If multiplier = 1, buying_power = cash
  - setBuyingPower
```
public void setBuyingPower(java.lang.String buyingPower)
```
    Current available $ buying power; If multiplier = 4, this is your daytrade buying power which is calculated as (last_equity - (last) maintenance_margin) * 4; If multiplier = 2, buying_power = max(equity – initial_margin,0) * 2; If multiplier = 1, buying_power = cash
  - getInitialMargin
```
public java.lang.String getInitialMargin()
```
    Reg T initial margin requirement (continuously updated value)
  - setInitialMargin
```
public void setInitialMargin(java.lang.String initialMargin)
```
    Reg T initial margin requirement (continuously updated value)
  - getMaintenanceMargin
```
public java.lang.String getMaintenanceMargin()
```
    Maintenance margin requirement (continuously updated value)
  - setMaintenanceMargin
```
public void setMaintenanceMargin(java.lang.String maintenanceMargin)
```
    Maintenance margin requirement (continuously updated value)
  - getSma
```
public java.lang.String getSma()
```
    Value of special memorandum account (will be used at a later date to provide additional buying_power)
  - setSma
```
public void setSma(java.lang.String sma)
```
    Value of special memorandum account (will be used at a later date to provide additional buying_power)
  - getDaytradeCount
```
public java.lang.Integer getDaytradeCount()
```
    The current number of daytrades that have been made in the last 5 trading days (inclusive of today)
  - setDaytradeCount
```
public void setDaytradeCount(java.lang.Integer daytradeCount)
```
    The current number of daytrades that have been made in the last 5 trading days (inclusive of today)
  - getLastMaintenanceMargin
```
public java.lang.String getLastMaintenanceMargin()
```
    Your maintenance margin requirement on the previous trading day
  - setLastMaintenanceMargin
```
public void setLastMaintenanceMargin(java.lang.String lastMaintenanceMargin)
```
    Your maintenance margin requirement on the previous trading day
  - getDaytradingBuyingPower
```
public java.lang.String getDaytradingBuyingPower()
```
    Your buying power for day trades (continuously updated value)
  - setDaytradingBuyingPower
```
public void setDaytradingBuyingPower(java.lang.String daytradingBuyingPower)
```
    Your buying power for day trades (continuously updated value)
  - getRegtBuyingPower
```
public java.lang.String getRegtBuyingPower()
```
    Your buying power under Regulation T (your excess equity - equity minus margin value - times your margin multiplier)
  - setRegtBuyingPower
```
public void setRegtBuyingPower(java.lang.String regtBuyingPower)
```
    Your buying power under Regulation T (your excess equity - equity minus margin value - times your margin multiplier)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object

Class Account

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Account

Account

Method Detail

getId

setId

getAccountNumber

setAccountNumber

getStatus

setStatus

getCurrency

setCurrency

getCash

setCash

getPortfolioValue

setPortfolioValue

getPatternDayTrader

setPatternDayTrader

getTradeSuspendedByUser

setTradeSuspendedByUser

getTradingBlocked

setTradingBlocked

getTransfersBlocked

setTransfersBlocked

getAccountBlocked

setAccountBlocked

getCreatedAt

setCreatedAt

getShortingEnabled

setShortingEnabled

getLongMarketValue

setLongMarketValue

getShortMarketValue

setShortMarketValue

getEquity

setEquity

getLastEquity

setLastEquity

getMultiplier

setMultiplier

getBuyingPower

setBuyingPower

getInitialMargin

setInitialMargin

getMaintenanceMargin

setMaintenanceMargin

getSma

setSma

getDaytradeCount

setDaytradeCount

getLastMaintenanceMargin

setLastMaintenanceMargin

getDaytradingBuyingPower

setDaytradingBuyingPower

getRegtBuyingPower

setRegtBuyingPower

toString

hashCode

equals