Show / Hide Table of Contents

Interface IAccount

Encapsulates full account information from Alpaca REST API.

Namespace: Alpaca.Markets
Assembly: Alpaca.Markets.dll
Syntax
public interface IAccount

Properties

| Improve this Doc View Source

AccountId

Gets unique account identifier.

Declaration
Guid AccountId { get; }
Property Value
Type Description
Guid
| Improve this Doc View Source

AccountNumber

Gets account number (string identifier).

Declaration
String? AccountNumber { get; }
Property Value
Type Description
System.Nullable<String>
| Improve this Doc View Source

AccruedFees

Gets fees collected value (if any).

Declaration
Decimal? AccruedFees { get; }
Property Value
Type Description
System.Nullable<Decimal>
| Improve this Doc View Source

BuyingPower

Current available buying power.

Declaration
Decimal? BuyingPower { get; }
Property Value
Type Description
System.Nullable<Decimal>
| Improve this Doc View Source

CreatedAtUtc

Gets timestamp of account creation event in UTC.

Declaration
DateTime CreatedAtUtc { get; }
Property Value
Type Description
DateTime
| Improve this Doc View Source

CryptoStatus

Gets updated crypto account status.

Declaration
AccountStatus CryptoStatus { get; }
Property Value
Type Description
AccountStatus
| Improve this Doc View Source

Currency

Gets main account currency.

Declaration
String? Currency { get; }
Property Value
Type Description
System.Nullable<String>
| Improve this Doc View Source

DayTradeCount

the current number of day trades that have been made in the last 5 trading days (inclusive of today).

Declaration
UInt64 DayTradeCount { get; }
Property Value
Type Description
UInt64
| Improve this Doc View Source

DayTradingBuyingPower

Your buying power for day trades (continuously updated value).

Declaration
Decimal? DayTradingBuyingPower { get; }
Property Value
Type Description
System.Nullable<Decimal>
| Improve this Doc View Source

Equity

Cash + LongMarketValue + ShortMarketValue.

Declaration
Decimal? Equity { get; }
Property Value
Type Description
System.Nullable<Decimal>
| Improve this Doc View Source

InitialMargin

Reg T initial margin requirement (continuously updated value).

Declaration
Decimal? InitialMargin { get; }
Property Value
Type Description
System.Nullable<Decimal>
| Improve this Doc View Source

IsAccountBlocked

Returns true if account is completely blocked.

Declaration
Boolean IsAccountBlocked { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsDayPatternTrader

Returns true if account is linked to pattern day trader.

Declaration
Boolean IsDayPatternTrader { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsTradingBlocked

Returns true if account trading functions are blocked.

Declaration
Boolean IsTradingBlocked { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsTransfersBlocked

Returns true if account transfer functions are blocked.

Declaration
Boolean IsTransfersBlocked { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

LastEquity

Equity as of previous trading day at 16:00:00 ET.

Declaration
Decimal LastEquity { get; }
Property Value
Type Description
Decimal
| Improve this Doc View Source

LastMaintenanceMargin

Your maintenance margin requirement on the previous trading day

Declaration
Decimal LastMaintenanceMargin { get; }
Property Value
Type Description
Decimal
| Improve this Doc View Source

LongMarketValue

Real-time MtM value of all long positions held in the account.

Declaration
Decimal? LongMarketValue { get; }
Property Value
Type Description
System.Nullable<Decimal>
| Improve this Doc View Source

MaintenanceMargin

Maintenance margin requirement (continuously updated value).

Declaration
Decimal MaintenanceMargin { get; }
Property Value
Type Description
Decimal
| Improve this Doc View Source

Multiplier

Buying power multiplier that represents account margin classification.

Declaration
Multiplier Multiplier { get; }
Property Value
Type Description
Multiplier
| Improve this Doc View Source

NonMarginableBuyingPower

Your non-marginable buying power for day trades (useful for crypto-trading).

Declaration
Decimal? NonMarginableBuyingPower { get; }
Property Value
Type Description
System.Nullable<Decimal>
| Improve this Doc View Source

OptionsApprovedLevel

Gets the options trading level that was approved for this account.

Declaration
OptionsTradingLevel? OptionsApprovedLevel { get; }
Property Value
Type Description
System.Nullable<OptionsTradingLevel>
| Improve this Doc View Source

OptionsBuyingPower

Gets the option buying power that was approved for this account.

Declaration
Decimal? OptionsBuyingPower { get; }
Property Value
Type Description
System.Nullable<Decimal>
| Improve this Doc View Source

OptionsTradingLevel

Gets the effective options trading level of the account. This is the minimum between the OptionsApprovedLevel and the MaxOptionsTradingLevel.

Declaration
OptionsTradingLevel? OptionsTradingLevel { get; }
Property Value
Type Description
System.Nullable<OptionsTradingLevel>
| Improve this Doc View Source

PendingTransferIn

Gets cash pending transfer in.

Declaration
Decimal? PendingTransferIn { get; }
Property Value
Type Description
System.Nullable<Decimal>
| Improve this Doc View Source

PendingTransferOut

Gets cash pending transfer out.

Declaration
Decimal? PendingTransferOut { get; }
Property Value
Type Description
System.Nullable<Decimal>
| Improve this Doc View Source

RegulationBuyingPower

Your buying power under Regulation T (your excess equity - equity minus margin value - times your margin multiplier).

Declaration
Decimal? RegulationBuyingPower { get; }
Property Value
Type Description
System.Nullable<Decimal>
| Improve this Doc View Source

ShortingEnabled

Flag to denote whether or not the account is permitted to short.

Declaration
Boolean ShortingEnabled { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

ShortMarketValue

Real-time MtM value of all short positions held in the account.

Declaration
Decimal? ShortMarketValue { get; }
Property Value
Type Description
System.Nullable<Decimal>
| Improve this Doc View Source

Sma

Value of special memorandum account.

Declaration
Decimal Sma { get; }
Property Value
Type Description
Decimal
| Improve this Doc View Source

Status

Gets updated account status.

Declaration
AccountStatus Status { get; }
Property Value
Type Description
AccountStatus
| Improve this Doc View Source

TradableCash

Gets amount of money available for trading.

Declaration
Decimal TradableCash { get; }
Property Value
Type Description
Decimal
| Improve this Doc View Source

TradeSuspendedByUser

User setting. If true, the account is not allowed to place orders.

Declaration
Boolean TradeSuspendedByUser { get; }
Property Value
Type Description
Boolean
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX