All Classes and Interfaces
Class
Description
Abstract class for oneOf,anyOf schemas defined in OpenAPI spec
Abstract class for oneOf,anyOf schemas defined in OpenAPI spec
Abstract class for oneOf,anyOf schemas defined in OpenAPI spec
Represents high level account info.
The account API serves important information related to an account, including account status, funds available for trade, funds available for withdrawal, and various flags relevant to an account’s ability to trade.
The options trading level that was approved for this account.
The effective options trading level of the account.
The beneficiary of the account.
Represents additional configuration settings for an account
The account configuration API provides custom configurations about your trading account settings.
both, entry, or exit.
both, entry, or exit.
The desired maximum options trading level.
The desired maximum options trading level.
all or none.
Represents the fields required to create a new account
If an account has documents on the application submission, it has the ApplicationDocument model in exchange with DocumentUploadRequest.
Represents an account with all data available.
Designates the current status of this account Possible Values: - **INACTIVE** Account not set to trade given asset.
An enum representing the various possible account status values.
Represents a change in an Account's status, sent over the events streaming api.
Possible values are: - trading - custodial - donor_advised
AccountUpdateRequest
ACHRelationship
Must be CHECKING or SAVINGS
Gets or Sets status
Base for activity types
Valid only for non-trading activity types.
Valid only for trading activity types.
Represents the various kinds of activity.
- FILL Order fills (both partial and full fills) - TRANS Cash transactions (both CSD and CSW) - MISC Miscellaneous or rarely used activity types (All types except those in TRANS, DIV, or FILL) - ACATC ACATS IN/OUT (Cash) - ACATS ACATS IN/OUT (Securities) - CFEE Crypto fee - CSD Cash deposit(+) - CSW Cash withdrawal(-) - DIV Dividends - DIVCGL Dividend (capital gain long term) - DIVCGS Dividend (capital gain short term) - DIVFEE Dividend fee - DIVFT Dividend adjusted (Foreign Tax Withheld) - DIVNRA Dividend adjusted (NRA Withheld) - DIVROC Dividend return of capital - DIVTW Dividend adjusted (Tefra Withheld) - DIVTXEX Dividend (tax exempt) - FEE Fee denominated in USD - INT Interest (credit/margin) - INTNRA Interest adjusted (NRA Withheld) - INTTW Interest adjusted (Tefra Withheld) - JNL Journal entry - JNLC Journal entry (cash) - JNLS Journal entry (stock) - MA Merger/Acquisition - NC Name change - OPASN Option assignment - OPEXC Option exercise - OPEXP Option expiration - OPTRD Option trade - PTC Pass Thru Charge - PTR Pass Thru Rebate - REORG Reorg CA - SC Symbol change - SSO Stock spinoff - SSP Stock split
AddAssetToWatchlistByNameRequest
AddAssetToWatchlistRequest
Represents structure of an Identifier for all AdminAction type
Gets or Sets AdminActionBelongsToKind
Category of the Admin Action
Variable schema type which depends on the type
Variable schema type which depends on the type
Represents structure of an Creator's Identifier for all AdminAction type
Gets or Sets AdminActionCreatedByKind
Represents general fields for all AdminAction type
Represents structure of a LegacyNote type AdminAction
Represents structure of a Liquidation type AdminAction
Represents structure of a TransactionCancel type AdminAction
Type of the Admin Action
Visibility of the Admin Action
These configurations show account properties that are overriden either by Alpaca Broker Operations or an automated process.
AggregatePositionResponse
Agreement
- margin_agreement: Alpaca Margin Agreement - account_agreement: Alpaca Account Agreement - customer_agreement: Alpaca Customer Agreement - crypto_agreement: Alpaca Crypto agreement - options_agreement: Alpaca Option agreement - custodial_customer_agreement: Alpaca Custodial Customer agreement
AlpacaAPI is the main class used to interface with the various Alpaca API endpoints.A builder for
AlpacaAPIAlpacaBrokerAPI is the class used to interface with the Alpaca Broker API endpoints.AlpacaMarketDataAPI is the class used to interface with the Alpaca Market Data API endpoints.AlpacaTraderAPI is the class used to interface with the Alpaca Trader API endpoints.AlpacaWebsocket represents an abstract websocket for Alpaca.AlpacaWebsocketInterface defines an interface for Alpaca websockets.AlpacaWebsocketStateListener is an interface to listen for various state changes in an WebSocket
instance.The announcements endpoint contains public information on previous and upcoming dividends, mergers, spinoffs, and stock splits.
Announcements have both a type and a subtype to categorize them.
Announcements have both a type and a subtype to categorize them.
Callback for asynchronous API call.
Callback for asynchronous API call.
Callback for asynchronous API call.
ApiClient class.
ApiClient class.
ApiClient class.
ApiException class.
ApiException class.
ApiException class.
APIKeyUtil is a utility class for Alpaca API keys.API response returned by API call.
API response returned by API call.
API response returned by API call.
If an account has documents on the application submission, it has the ApplicationDocument model in exchange with DocumentUpload.
Assets are sorted by asset class, exchange and symbol.
Gets or Sets attributes
active or inactive
This represents the category to which the asset belongs to.
This represents the category to which the asset belongs to.
The assets API serves as the master list of assets available for trade and data consumption from Alpaca.
Gets or Sets attributes
active or inactive
Bank
ABA (Domestic) or BIC (International)
QUEUED, SENT_TO_CLEARING, APPROVED, CANCELED
BankInformation
BatchCreateFundingWalletRequest
BatchCreateFundingWalletResponse
Journals API allows you to move cash or securities from one account to another.
Only supports `JNLC` for now
BatchJournalRequestEntriesInner
A Journal object with an extra attribute error_message in the case when a specific account fails to receive a journal.
Cash dividend.
Cash merger.
CACorporateActions
CACorporateActionsResp
Forward split.
The calendar API serves the full list of market days from 1970 to 2029.
Calendar
Forward split.
Represents the result of a request to cancel and order
Forward split.
Reverse split.
Spin-off.
Stock and cash merger.
Stock dividend.
Stock merger.
Unit split.
Forward split.
Represents results of checking a document for CIPInfo
CIPIdentity
Customer Identification Program (CIP) information for an account applicant.
Represents Know Your Customer (KYC) info for a CIPInfo
Represents the results of checking a Photo for CIPInfo
Represents the result of checking to see if the applicant is in any watchlists for a CIPInfo
Represents the current market time and open/close events.
Clock
Contact is the model for the account owner contact information.
Represents the info for a country.
crypto risk rating of the country
the securities risk rating of the country
Represents the fields used in creation of a new ACHRelationship.
Must be `CHECKING` or `SAVINGS`
Represents the possible fields to send when creating a new associated Bank resource for an account
ABA (Domestic) or BIC (International)
CreateCryptoTransferRequest
CreateCryptoTransferRequest
CreateFundingWalletWithdrawalRequest
Journals API allows you to move cash or securities from one account to another.
CreateOrderRequest
Takes in a string/number values for stop_price and limit_price
Takes in a string/number value for limit_price
[See main docs here](https://alpaca.markets/docs/api-references/broker-api/funding/transfers/#creating-a-transfer-entity)
This model represents the fields you can specify when Creating or Updating/Replacing a Watchlist
CreateWhitelistedAddressRequest
CreateWhitelistedAddressRequest
OHLC aggregate of all the trades in a given interval.
CryptoBarsResp
CryptoLatestBarsResp
CryptoLatestOrderbooksResp
CryptoLatestQuotesResp
CryptoLatestTradesResp
Crypto location
CryptoMarketDataListener defines a listener interface for CryptoMarketDataWebsocketInterface
messages.CryptoMarketDataListenerAdapter is an adapter for CryptoMarketDataListener.CryptoMarketDataWebsocket is an implementation for CryptoMarketDataWebsocketInterface.Snapshot of the orderbook.
A single entry in a crypto orderbook
The best bid and ask information for a given security.
CryptoQuotesResp
A snapshot provides the latest trade, latest quote, latest minute bar, current daily bar and previous daily bar.
CryptoSnapshotsResp
A crypto trade
CryptoTradesResp
Transfers allow you to transfer assets into your end customer's account (deposits) or out (withdrawal).
Transfers allow you to transfer assets into your end customer's account (deposits) or out (withdrawal).
Gets or Sets CryptoTransferStatus
Gets or Sets CryptoTransferStatus
CryptoWallet
CryptoWallet
Represents Identity information for a minor that an account of type \"custodial\" is for
DailyTradingLimit
DemoFundingTransfer
DisclosureContextAnnotation
Specifies the type of disclosure annotation.
Disclosures fields denote if the account owner falls under each category defined by FINRA rule.
One of the following: `employed`, `unemployed`, `retired`, or `student`.
DocumentInner
- identity_verification: identity verification document - address_verification: address verification document - date_of_birth_verification: date of birth verification document - tax_id_verification: tax ID verification document - account_approval_letter: 407 approval letter - cip_result: initial CIP result - w8ben: W-8 BEN tax form - w9: W9 tax form - limited_trading_authorization:
If an account has documents after the submission, it has the Document model in exchange with DocumentUpload.
If an account has to replace documents after the submission, it has to use the Document model instead of DocumentUploadRequest.
Error
Error
EventsApiSSE add SSE support to EventsApi.Represents the exchange where an asset is traded.
Represents the current exchanges Alpaca supports.
Status: * `invoice`
Status: * `withdrawal_fee`: Withdrawal fee * `fx_fee`: FX Fee * `network_fee` * `deposit_fee` * `ach_return_fee` * `parnter_fee` * `alpaca_fee`
The response object of the latest forex rates
A foreign exchange rate between two currencies at a given time
ForexRatesResp
Gets funding details that can be used to settle and collect funds in each available currency.
Status: * `swift_wire`: SWIFT wire * `local_rails`: Local scheme
Status: * `BIC`: bic_swift * `ACH`: ach_routing_code * `ABA`: aba * `ROUTING`: routing_code * `SORT_CODE`: sort_code
FundingWallet
FundingWalletRecipientBank
Status: * `active`: The funding wallet is ready * `pending`: The funding wallet is being processed * `disabled`: The funding wallet is disabled
FundingWalletTransfer
Status: * `incoming`: incoming amount * `outgoing`: outgoing amount
Status: * `PENDING`: Created and waiting to be processed * `CANCELED`: Canceled * `FAILED`: Failed mostly due to technical reasons * `COMPLETE`: Transfer has settled
GetCryptoTransferEstimate200Response
GetCryptoTransferEstimate200Response
GetOptionsContracts200Response
GetOptionsContracts200Response
GetV1AccountsAccountIdOnfidoSdkTokens200Response
GetV1AccountsPositions200Response
GetV1ReportingEodPositions200Response
GetV1TradingAccountsAccountIdOrdersEstimationRequest
GetV1TransfersJitLedgerIdBalances200Response
GetV2CorporateActionsAnnouncements200ResponseInner
GetV2CorporateActionsAnnouncementsId200Response
Identity is the model to provide account owner’s identity information.
Gets or Sets fundingSource
The user's level of expertise and familiarity with investing in Options.
The user's level of expertise and familiarity with investing in US Equities.
The user's investment objective.
The expected period of time the user plan to invest to achieve his/her financial goal(s)
The user's ability to quickly and easily convert to cash all or a portion of the investments in this account without experiencing significant loss in value.
The user's investment risk tolerance.
Always `Bearer`
JITLedgerAccount
JIT Securities reports are made available through the API and can be accessed within the hour after 11:30 PM EST on the trade date (T+0).
Journal information specific to cash transfers.
JNLS
Represents a cash or security transfer between accounts, as specified by the `entry_type` parameter.
JournalData
This enum represents the various kinds of Journal alpaca supports.
Represents the status that a Journal instance can be in.
Represents a change in a Journal's status, sent over the events streaming api.
Gson TypeAdapter for Byte Array type
Gson TypeAdapter for Byte Array type
Gson TypeAdapter for Byte Array type
Gson TypeAdapter for java.util.Date type
If the dateFormat is null, DateTimeFormatter will be used.
Gson TypeAdapter for java.util.Date type
If the dateFormat is null, DateTimeFormatter will be used.
Gson TypeAdapter for java.util.Date type
If the dateFormat is null, DateTimeFormatter will be used.
Gson TypeAdapter for JSR310 LocalDate type
Gson TypeAdapter for JSR310 LocalDate type
Gson TypeAdapter for JSR310 LocalDate type
Gson TypeAdapter for JSR310 OffsetDateTime type
Gson TypeAdapter for JSR310 OffsetDateTime type
Gson TypeAdapter for JSR310 OffsetDateTime type
Gson TypeAdapter for java.sql.Date type
If the dateFormat is null, a simple "yyyy-MM-dd" format will be used
(more efficient than SimpleDateFormat).
Gson TypeAdapter for java.sql.Date type
If the dateFormat is null, a simple "yyyy-MM-dd" format will be used
(more efficient than SimpleDateFormat).
Gson TypeAdapter for java.sql.Date type
If the dateFormat is null, a simple "yyyy-MM-dd" format will be used
(more efficient than SimpleDateFormat).
Hold information about the result of KYC.
ListFundingDetails
ListTransfersResponse
Model representing a news article from the Alpaca Market Data API
A model representing images for news article.
Possible values for size are thumb, small and large.
NewsMarketDataListener defines a listener interface for NewsMarketDataWebsocketInterface messages.NewsMarketDataListenerAdapter is an adapter for NewsMarketDataListener.NewsMarketDataWebsocket is an implementation for NewsMarketDataWebsocketInterface.NewsResp
NonTradeActivities
NonTradeActivity
Valid only for non-trading activity types.
OathClientResponse
ACTIVE or DISABLED
This model is used for both the Issue and Authorize OAuth token routes
OHLC aggregate of all the trades in a given interval.
OptionBarsResp
OptionContract
OptionContract
The status of the option contract.
The status of the option contract.
The style of the option contract.
The style of the option contract.
The type of the option contract.
The type of the option contract.
Gets or Sets OptionFeed
OptionLatestQuotesResp
OptionLatestTradesResp
The best bid and ask information for a given option.
OptionsApprovalRequest
The desired option trading level.
OptionsApprovalResponse
The request option trading level.
The request status.
A snapshot provides the latest trade and latest quote.
OptionSnapshotsResp
An option trade
OptionTradesResp
Order
The Orders API allows a user to monitor, place and cancel their orders with Alpaca.
The order classes supported by Alpaca vary based on the order's security type.
The order classes supported by Alpaca vary based on the order's security type.
Represents the result of asking the api to cancel an Order.
Represents what side of the transaction an order was on.
Represents which side this order was on: - buy - sell
Gets or Sets OrderStatus
An order executed through Alpaca can experience several status changes during its lifecycle.
The order types supported by Alpaca vary based on the order's security type.
The order types supported by Alpaca vary based on the order's security type.
Represents a request to patch an order.
PatchV1AccountsAccountIdOnfidoSdkRequest
PatchV1RebalancingPortfoliosPortfolioIdRequest
PDTRemoval
The request status
PDTStatus
Portfolio
Timeseries data for equity and profit loss information of the account.
Timeseries data for equity and profit loss information of the account.
PortfolioRun
| Status | Final | Represented State | Notes | |:------------------:|:-----:|:--------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------:| | QUEUED | No | The run has been queued, waiting for our system to process it.
PortfolioSubscription
PortfolioWeights
Position
The positions API provides information about an account’s current open positions.
Gets or Sets side
Represents the result of asking the api to close a position.
Represents the result of asking the api to close a position.
PostOrderRequest
PostV1RebalancingPortfoliosRequest
PostV1RebalancingRunsRequest
PostV1RebalancingSubscriptionsRequest
PostV1TradingAccountsAccountIdWatchlistsWatchlistIdRequest
RebalancingConditions
Reasons why the liquidation only flag was set
ReverseBatchJournalRequest
ReverseBatchJournalRequestEntriesInner
Market type (stocks or crypto)
A stock that is most active by either volume or trade count.
ScreenerMostActivesResp
A symbol whose price moved significantly
Contains list of market movers
Representing a Server configuration.
Representing a Server configuration.
Representing a Server configuration.
Representing a Server Variable for server URL template substitution.
Representing a Server Variable for server URL template substitution.
Representing a Server Variable for server URL template substitution.
Skipped orders model contains information for such orders that the rebalancing engine didn’t send to our order system due to some validation issues.
Sort data in ascending or descending order.
SSEListener is a listener interface for server-sent events (SSE).SSEListenerAdapter and adapter for SSEListener.SSERequest is a EventSource wrapper class.Gets or Sets StockAdjustment
An auction
StockAuctionsResp
StockAuctionsRespSingle
OHLC aggregate of all the trades in a given interval.
StockBarsResp
StockBarsRespSingle
Opening and closing auction prices for a given day.
Gets or Sets StockFeed
StockLatestBarsResp
StockLatestBarsRespSingle
StockLatestQuotesResp
StockLatestQuotesRespSingle
StockLatestTradesResp
StockLatestTradesRespSingle
StockMarketDataListener defines a listener interface for StockMarketDataWebsocketInterface messages.StockMarketDataListenerAdapter is an adapter for StockMarketDataListener.StockMarketDataWebsocket is an implementation for StockMarketDataWebsocketInterface.The best bid and ask information for a given security.
StockQuotesResp
StockQuotesRespSingle
A snapshot provides the latest trade, latest quote, latest minute bar, current daily bar and previous daily bar.
StockSnapshotsRespSingle
Tape A is the New York Stock Exchange, Tape B is NYSE Arca, Bats, IEX and other regional exchanges, Tape C is NASDAQ, Tape O is OTC.
A stock trade
StockTradesResp
StockTradesRespSingle
Required if `tax_id` is set.
The Time-In-Force values supported by Alpaca vary based on the order's security type.
The Time-In-Force values supported by Alpaca vary based on the order's security type.
This is an extended version of the Account model found [in the trading api](https://alpaca.markets/docs/api-references/trading-api/account/#account-entity).
The options trading level that was approved for this account.
The effective options trading level of the account.
TradeActivity
Valid only for trading activity types.
Represents an update to an order/trade, sent over the events streaming api.
**Common events** These are the events that are the expected results of actions you may have taken by sending API requests.
Represents an update to an order/trade, sent over the events streaming api.
TradingActivities
fill or partial_fill
Transaction
Transfers allow you to transfer money/balance into your end customers' account (deposits) or out (withdrawal).
TransferData
Gets or Sets direction
Gets or Sets timing
Gets or Sets transferType
- **INCOMING** Funds incoming to user’s account (deposit).
Gets or Sets TransferDirection
TransferFee
TransferResource
Gets or Sets direction
Gets or Sets status
Gets or Sets type
- **QUEUED** Transfer is in queue to be processed.
Represents a change in a Transfer's status, sent over the events streaming api.
Only `immediate` is currently supported.
**NOTE:** The Sandbox environment currently only supports `ach` - **ach** Transfer via ACH (US Only).
This model input is optional.
UntypedACHTransferData
Gets or Sets direction
UntypedTransferData
Gets or Sets direction
UntypedWireTransferData
Gets or Sets direction
Represents the fields that are editable in an order replace/update call.
UpdatesListener defines a listener interface for UpdatesWebsocketInterface messages.UpdatesWebsocket is an AlpacaWebsocket implementation and provides the
UpdatesWebsocketInterface interface for
Updates Streaming.Request format used for creating a new watchlist or updating an existing watchlist with a set of assets and name.
Usd
Account balances in USD.
Position values in USD.
W-8BEN documents model.
Represents a set of securities observed by a user.
The watchlist API provides CRUD operation for the account’s watchlist.
WhitelistedAddress
WhitelistedAddress
Status of whitelisted address which is either ACTIVE or PENDING.
Status of whitelisted address which is either ACTIVE or PENDING.