Show / Hide Table of Contents

Namespace Alpaca.Markets

Classes

Alpaca.Markets.

Supported bar duration for Alpaca Data API.

AccountActivitiesRequest

Encapsulates request parameters for ListAccountActivitiesAsync(AccountActivitiesRequest, CancellationToken) call.

AdvancedOrderBase

Encapsulates base data for advanced order types, never used directly by any code.

AlpacaClientConfigurationBase

Configuration parameters object for all REST API client instances.

AlpacaCryptoDataClientConfiguration

Configuration parameters object for IAlpacaCryptoDataClient instance.

AlpacaCryptoStreamingClientConfiguration

Configuration parameters object for IAlpacaCryptoStreamingClient instance.

AlpacaDataClientConfiguration

Configuration parameters object for IAlpacaDataClient instance.

AlpacaDataStreamingClientConfiguration

Configuration parameters object for IAlpacaDataStreamingClient instance.

AlpacaNewsStreamingClientConfiguration

Configuration parameters object for IAlpacaNewsStreamingClient implementation.

AlpacaOptionsDataClientConfiguration

Configuration parameters object for IAlpacaOptionsDataClient instance.

AlpacaStreamingClientConfiguration

Configuration parameters object for IAlpacaStreamingClient instance.

AlpacaTradingClientConfiguration

Configuration parameters object for IAlpacaTradingClient instance.

AnnouncementExtensions

Set of extensions methods for the IAnnouncement interface.

AnnouncementsRequest

Encapsulates request parameters for ListAnnouncementsAsync(AnnouncementsRequest, CancellationToken) call.

AssetsRequest

Encapsulates request parameters for ListAssetsAsync(AssetsRequest, CancellationToken) call.

BracketOrder

A bracket order is a chain of three orders that can be used to manage your position entry and exit. It is a common use case of an OTOCO (One Triggers OCO {One Cancels Other}) order.

CalendarRequest

Encapsulates request parameters for ListCalendarAsync(CalendarRequest, CancellationToken) call.

ChangeOrderRequest

Encapsulates request parameters for PatchOrderAsync(ChangeOrderRequest, CancellationToken) call.

ChangeWatchListRequest<TKey>

Encapsulates request parameters for AddAssetIntoWatchListByIdAsync(ChangeWatchListRequest<Guid>, CancellationToken), AddAssetIntoWatchListByNameAsync(ChangeWatchListRequest<String>, CancellationToken), DeleteAssetFromWatchListByIdAsync(ChangeWatchListRequest<Guid>, CancellationToken), and DeleteAssetFromWatchListByNameAsync(ChangeWatchListRequest<String>, CancellationToken) calls.

CorporateActionsRequest

Encapsulates request parameters for ListCorporateActionsAsync(CorporateActionsRequest, CancellationToken) call.

DeleteAllPositionsRequest

Encapsulates request parameters for DeleteAllPositionsAsync(DeleteAllPositionsRequest, CancellationToken) call.

DeletePositionRequest

Encapsulates request parameters for DeletePositionAsync(DeletePositionRequest, CancellationToken) call.

EnvironmentExtensions

Collection of helper extension methods for IEnvironment interface.

Environments

Provides single entry point for obtaining information about different environments.

HistoricalAuctionsRequest

Encapsulates request parameters for ListHistoricalQuotesAsync(TRequest, CancellationToken) and GetHistoricalQuotesAsync(TRequest, CancellationToken) calls.

HistoricalBarsRequest

Encapsulates request parameters for ListHistoricalBarsAsync(TRequest, CancellationToken) and GetHistoricalBarsAsync(TRequest, CancellationToken) calls.

HistoricalCryptoBarsRequest

Encapsulates request parameters for ListHistoricalBarsAsync(TRequest, CancellationToken) and GetHistoricalBarsAsync(TRequest, CancellationToken) calls.

HistoricalCryptoQuotesRequest

Encapsulates request parameters for ListHistoricalQuotesAsync(TRequest, CancellationToken) and GetHistoricalQuotesAsync(TRequest, CancellationToken) calls.

HistoricalCryptoTradesRequest

Encapsulates request parameters for ListHistoricalTradesAsync(TRequest, CancellationToken) and GetHistoricalTradesAsync(TRequest, CancellationToken) calls.

HistoricalOptionBarsRequest

Encapsulates request parameters for ListHistoricalBarsAsync(TRequest, CancellationToken) and GetHistoricalBarsAsync(TRequest, CancellationToken) calls.

HistoricalOptionTradesRequest

Encapsulates request parameters for ListHistoricalTradesAsync(TRequest, CancellationToken) and GetHistoricalTradesAsync(TRequest, CancellationToken) calls.

HistoricalQuotesRequest

Encapsulates request parameters for ListHistoricalQuotesAsync(TRequest, CancellationToken) and GetHistoricalQuotesAsync(TRequest, CancellationToken) calls.

HistoricalRequestBase

Encapsulates base logic for all historical data requests on Alpaca Data API v2.

HistoricalRequestBaseExtensions

Set of extension methods for HistoricalRequestBase inheritors' initialization.

HistoricalTradesRequest

Encapsulates request parameters for ListHistoricalTradesAsync(TRequest, CancellationToken) and GetHistoricalTradesAsync(TRequest, CancellationToken) calls.

IntervalCalenderExtensions

Set of extensions methods for the IIntervalCalendar interface.

IntervalExtensions

Set of extensions methods for the Alpaca.Markets.Interval<TItem> structure.

LatestBestBidOfferListRequest

Encapsulates data for latest crypto XBBO request on Alpaca Data API v2.

LatestBestBidOfferRequest

Encapsulates data for latest crypto XBBO request on Alpaca Data API v2.

LatestDataListRequest

Encapsulates data for latest crypto data requests on Alpaca Data API v2.

LatestDataRequest

Encapsulates data for latest crypto data requests on Alpaca Data API v2.

LatestMarketDataListRequest

Encapsulates data for latest stock data requests on Alpaca Data API v2.

LatestMarketDataRequest

Encapsulates data for latest stock data requests on Alpaca Data API v2.

LatestOptionsDataRequest

Encapsulates data for latest options data requests on Alpaca Data API v2.

LatestOrderBooksRequest

Encapsulates data for latest crypto XBBO request on Alpaca Data API v2.

LimitOrder

A limit order is an order to buy or sell at a specified price or better.

ListOrdersRequest

Encapsulates request parameters for ListOrdersAsync(ListOrdersRequest, CancellationToken) call.

MarketOrder

A market order is a request to buy or sell a security at the currently available market price.

NewOrderRequest

Encapsulates request parameters for PostOrderAsync(NewOrderRequest, CancellationToken) call.

NewsArticlesRequest

Encapsulates request parameters for call.

NewWatchListRequest

Encapsulates request parameters for CreateWatchListAsync(NewWatchListRequest, CancellationToken) call.

OAuthKey

OAuth key for Alpaca API authentication.

OneCancelsOtherOrder

OCO (One-Cancels-Other) is another type of advanced order type. This is a set of two orders with the same side (buy/buy or sell/sell) and currently only exit order is supported. In other words, this is the second part of the bracket orders where the entry order is already filled, and you can submit the take-profit and stop-loss in one order submission.

OptionChainRequest

Encapsulates data for latest options data requests on Alpaca Data API v2.

OptionContractsRequest

Encapsulates request parameters for ListOptionContractsAsync(OptionContractsRequest, CancellationToken) call.

OptionSnapshotRequest

Encapsulates data for latest options data requests on Alpaca Data API v2.

OrderBase

Encapsulates base data for any order types, never used directly by any code.

OrderBaseExtensions

Set of extensions methods for implementing the fluent interface for the OrderBase inheritors.

OrderExtensions

Set of extension methods for IOrder interface.

OrderSideExtensions

Set of extensions methods for creating the OrderBase inheritors.

Pagination

Encapsulates all data required for the pagination support in Alpaca Data API v2

PortfolioHistoryRequest

Encapsulates request parameters for GetPortfolioHistoryAsync(PortfolioHistoryRequest, CancellationToken) call.

RequestValidationException

Represents exception information for request input data validation errors.

RestClientErrorException

Represents Alpaca REST and Streaming API specific error information.

SecretKey

Secret API key for Alpaca API authentication.

SecurityKey

Base class for 'security key' abstraction.

SimpleOrderBase

Encapsulates base data for ordinal order types, never used directly by any code.

SnapshotDataListRequest

Encapsulates data for snapshot crypto data requests on Alpaca Data API v2.

SnapshotDataRequest

Encapsulates data for snapshot crypto data requests on Alpaca Data API v2.

StopLimitOrder

A stop-limit order is a conditional trade over a set time frame that combines the features of a stop order with those of a limit order and is used to mitigate risk. The stop-limit order will be executed at a specified limit price, or better, after a given stop price has been reached.

See https://alpaca.markets/docs/trading/orders/#stop-limit-order

StopLossOrder

Encapsulates data required for placing stop loss order on the Alpaca REST API.

StopOrder

A stop (market) order is an order to buy or sell a security when its price moves past a particular point, ensuring a higher probability of achieving a predetermined entry or exit price.

See https://alpaca.markets/docs/trading/orders/#stop-order

StreamingClientConfiguration

Configuration parameters object for Alpaca.Markets.StreamingClientBase`1 class.

TakeProfitOrder

Encapsulates data required for placing take profit order on the Alpaca REST API.

ThrottleParameters

Helper class for storing parameters required for initializing rate throttler in IAlpacaTradingClient class.

TimeInterval

Encapsulates implementations of the ITimeInterval interface and helper methods for it.

TrailingStopOrder

Trailing stop orders allow you to continuously and automatically keep updating the stop price threshold based on the stock price movement.

See https://alpaca.markets/docs/trading/orders/#trailing-stop-orders

UpdateWatchListRequest

Encapsulates request parameters for UpdateWatchListByIdAsync(UpdateWatchListRequest, CancellationToken) call.

Interfaces

IAccount

Encapsulates full account information from Alpaca REST API.

IAccountActivity

Encapsulates account activity information from Alpaca REST API.

IAccountConfiguration

Encapsulates account configuration settings from Alpaca REST API.

IActiveStock

Encapsulates the single active stock information from Alpaca APIs.

IAlpacaCryptoDataClient

Provides unified type-safe access for Alpaca Crypto Data API via HTTP/REST.

IAlpacaCryptoStreamingClient

Provides unified type-safe access for Alpaca crypto data streaming API via websockets.

IAlpacaDataClient

Provides unified type-safe access for Alpaca Data API via HTTP/REST.

IAlpacaDataStreamingClient

Provides unified type-safe access for Alpaca data streaming API via websockets.

IAlpacaDataSubscription

Encapsulates generic Alpaca Data streaming API subscription item.

IAlpacaDataSubscription<TApi>

Encapsulates strongly-typed Alpaca Data streaming API subscription item.

IAlpacaNewsStreamingClient

Provides unified type-safe access for Alpaca data streaming API via websockets.

IAlpacaOptionsDataClient

Provides unified type-safe access for Alpaca Options Data API via HTTP/REST.

IAlpacaScreenerClient

Provides unified type-safe access for Alpaca Screener API via HTTP/REST.

IAlpacaStreamingClient

Provides unified type-safe access for Alpaca streaming API.

IAlpacaTradingClient

Provides unified type-safe access for Alpaca Trading API via HTTP/REST.

IAnnouncement

Encapsulates corporate action announcement information from Alpaca REST API.

IAsset

Encapsulates asset information from Alpaca REST API.

IAuction

Encapsulates the basic auction information from Alpaca APIs.

IAuctionEntry

Encapsulates the auction entry information from Alpaca APIs.

IBar

Encapsulates basic bar information for Alpaca APIs.

ICalendar

Encapsulates single trading day information from Alpaca REST API.

ICashDividend

Encapsulates the cash dividend information from Alpaca APIs.

ICashMerger

Encapsulates the cash merger information from Alpaca APIs.

IClock

Encapsulates current trading date information from Alpaca REST API.

ICorporateActionsResponse

Encapsulates the historical corporate action response page with different corporate action types inside.

ICorrection

Encapsulates trade correction information from Alpaca APIs.

IDictionaryPage<TItem>

Encapsulates single page response in Alpaca Data API v2.

IEnvironment

Provides URLs for different APIs available for this SDK on specific environment.

IErrorInformation

Encapsulates extended error information from Alpaca error REST response.

IExclusiveTimeInterval

Represents the exclusive version of the interface.

IForwardSplit

Encapsulates the forward split information from Alpaca APIs.

IGreeks

Options Greeks are a set of risk measures that are used in the options market to evaluate the risk and reward of an option.

IHistoricalBarsClient<TRequest>

Provides unified type-safe access for Alpaca Crypto Data API via HTTP/REST.

IHistoricalQuotesClient<TRequest>

Provides unified type-safe access for Alpaca Crypto Data API via HTTP/REST.

IHistoricalRequest

Provides unified type-safe access to the historical data request parameters.

IHistoricalRequest<TRequest, TItem>

Provides unified type-safe access to the historical data request parameters.

IHistoricalTradesClient<TRequest>

Provides unified type-safe access for Alpaca Crypto Data API via HTTP/REST.

IInclusiveTimeInterval

Represents the inclusive version of the ITimeInterval interface.

IIntervalCalendar

Encapsulates single trading day information from Alpaca REST API.

ILimitUpLimitDown

Encapsulates the basic LULD update information from Alpaca APIs.

IMarketMover

Encapsulates the single market mover information from Alpaca APIs.

IMarketMovers

Encapsulates two lists of market movers from Alpaca APIs.

IMultiPage<TItems>

Encapsulates single page response in Alpaca Data API v2.

INameChange

Encapsulates the name change information from Alpaca APIs.

INewsArticle

Encapsulates the basic news article information from Alpaca APIs.

IOptionContract

IOptionSnapshot

Encapsulates option snapshot information from the Alpaca REST API.

IOrder

Encapsulates order information from Alpaca REST API.

IOrderActionStatus

Encapsulates order action status information from Alpaca REST API.

IOrderBook

Encapsulates the basic order book information from Alpaca APIs.

IOrderBookEntry

Encapsulates the order book price/size pair information.

IPage<TItems>

Encapsulates single page response in Alpaca Data API v2.

IPortfolioHistory

Encapsulates portfolio history information from Alpaca REST API.

IPortfolioHistoryItem

Encapsulates portfolio history information item from Alpaca REST API.

IPosition

Encapsulates position information from Alpaca REST API.

IPositionActionStatus

Encapsulates position action status information from Alpaca REST API.

IQuote

Encapsulates the basic quote information from Alpaca APIs.

IRateLimitProvider

Encapsulates access to the latest available rate limit information for this client.

IRateLimitValues

Provides information about client-specific rate limit values.

IRedemption

Encapsulates the redemption information from Alpaca APIs.

IRequestWithTimeInterval<TInterval>

Encapsulates access point for setting time interval filtering on request instance.

IReverseSplit

Encapsulates the reverse split information from Alpaca APIs.

IRightsDistribution

Encapsulates the right distribution information from Alpaca APIs.

ISnapshot

Encapsulates snapshot information from the Alpaca REST API.

ISpinOff

Encapsulates the spin-off information from Alpaca APIs.

IStatus

Encapsulates the basic trading status update information from Alpaca APIs.

IStockAndCashMerger

Encapsulates the stock and cash merger information from Alpaca APIs.

IStockDividend

Encapsulates the stock dividend information from Alpaca APIs.

IStockMerger

Encapsulates the stock merger information from Alpaca APIs.

IStopLoss

Encapsulates the price information about the stop loss order.

IStreamingClient

Provides unified type-safe access for websocket streaming APIs.

IStreamingDataClient

Provides unified type-safe access for websocket streaming APIs with data subscriptions.

ISubscriptionHandler

Provides unified type-safe access for subscribing/unsubscribing streaming events.

ITakeProfit

Encapsulates the price information about the take profit order.

ITimeInterval

Encapsulates time interval (from and till date/time points) for filtering requires.

ITrade

Encapsulates the basic trade information from Alpaca APIs.

ITradeUpdate

Encapsulates trade update information from Alpaca streaming API.

IUnitSplit

Encapsulates the unit split information from Alpaca APIs.

IWatchList

Encapsulates watch list information from Alpaca REST API.

IWebSocket

Encapsulates asynchronous interface of web socket client.

IWorthlessRemoval

Encapsulates the worthless removal information from Alpaca APIs.

Enums

AccountActivityType

Types of account activities

AccountStatus

User account status in Alpaca REST API.

Adjustment

Supported bar corporate action adjustment types for Alpaca Data API.

AssetAttributes

Unique asset characteristics for Alpaca REST API.

AssetClass

Supported asset classes for Alpaca REST API.

AssetStatus

Single asset status in Alpaca REST API.

AuthStatus

Authorization status for Alpaca streaming API.

BarTimeFrameUnit

Supported bar duration for Alpaca Data API.

CorporateActionDateType

Corporate action type in Alpaca REST API.

CorporateActionFilterType

Supported bar corporate action adjustment types for Alpaca Data API.

CorporateActionSubType

Corporate action sub type in Alpaca REST API.

CorporateActionType

Corporate action type in Alpaca REST API.

CryptoExchange

Crypto currency exchanges supported by Alpaca REST API.

DayTradeMarginCallProtection

Day trade margin call protection mode for account. See more information here: https://docs.alpaca.markets/user-protections/#day-trade-margin-call-dtmc-protection-at-alpaca

Exchange

Exchanges supported by Alpaca REST API.

HistoryPeriodUnit

Period units for portfolio history in the Alpaca REST API.

IntradayProfitLoss

Intraday profit/loss calculation for portfolio history in the Alpaca REST API.

IntradayReporting

Intraday reporting styles for portfolio history in the Alpaca REST API.

MarketDataFeed

Supported market feed data types for Alpaca Data API.

Multiplier

Account multiplier value (enum values can be cast to related integer values).

OptionsFeed

Supported options feed for Alpaca REST API.

OptionsTradingLevel

Options trading level for Alpaca REST API.

OptionStyle

Supported option contract styles for Alpaca REST API.

OptionType

Supported option contract types for Alpaca REST API.

OrderClass

Order class for advanced orders in the Alpaca REST API.

OrderSide

Order side in Alpaca REST API.

OrderStatus

Order status in Alpaca REST API.

OrderStatusFilter

Order statuses filter for ListOrdersAsync(ListOrdersRequest, CancellationToken) call from Alpaca REST API.

OrderType

Supported order types in Alpaca REST API.

PositionIntent

Position intent for order placement in Alpaca REST API.

PositionSide

Position side in Alpaca REST API.

SortDirection

Supported sort directions in Alpaca REST API.

TakerSide

Possible crypto taker side types for Alpaca Crypto Data API.

Tape

Supported tape types for Alpaca Data API.

TimeFrame

Supported bar duration for Alpaca REST API.

TimeInForce

Supported order durations in Alpaca REST API. See Alpaca Trading Documentation for more information.

TradeConfirmEmail

Notification level for order fill emails.

TradeEvent

Trade event in Alpaca trade update stream

In This Article
Back to top Generated by DocFX