All Classes and Interfaces
Class
Description
Base class for all Alpaca WebSocket stream clients.
Shared protocol logic for the three market-data WebSocket streams (stock, crypto, and news).
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
Automated customer account transfer service (cash)
Automated customer account transfer service (cash)
Automated customer account transfer service (stock)
Automated customer account transfer service (stock)
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.
Generated client for AccountActivitiesApi operations.
This property is included when the account's cash interest program had changed due to an enrollment, APR tier change, or unenrollment.
Use this property to change the account's configuration for the USD cash interest program.
The configuration of the account's USD cash interest program when creating an account.
AccountCashInterestProgram
The configuration and status of the account's USD cash interest program
Represents additional configuration settings for an account
The account configuration API provides custom configurations about your trading account settings.
The desired maximum options trading level.
The desired maximum options trading level.
all or none.
Generated client for AccountConfigurationsApi operations.
Represents the fields required to create a new account
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.
A document associated with an account
The type of the account document
Represents an account with all data available.
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.
values in USD.
This property is included when the account's FPSL information had changed due to an enrollment, tier change, or unenrollment.
AccountFPSLEventUS
AccountFPSLItem
AccountFPSLItemPost
The account's Fully Paid Securities Lending (FPSL) configuration.
The account's Fully Paid Securities Lending (FPSL) configuration.
The account's Fully Paid Securities Lending (FPSL) configuration.
AccountLimit
Generated client for AccountsApi operations.
Generated client for AccountsApi operations.
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 to certain account properties, sent over the events streaming API.
IRA Account only Possible values are: - traditional - roth
AccountTradingLimit
Possible values are: - trading - custodial - donor_advised - ira
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 an account activity, sent over the Event Streaming API.
Represents an account activity, sent over the Event Streaming API.
Represents the common fields for all Activity V2 Events
Represents the common fields for all Activity V2 Events
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 - CGD Capital gain distribution - 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 - OPCA Option corporate action - OPCSH Option cash deliverable for non-standard contracts - OPEXC Option exercise - OPEXP Option expiration - OPTRD Option trade - PTC Pass Thru Charge - PTR Pass Thru Rebate - REORG Reorg CA - SPIN Stock spinoff - SPLIT Stock split - FOPT Free of Payment Transfers
ActivityV2DetailNTA
ActivityV2DetailNTA
Activity details for a fill or partial_fill event
Activity details for a fill or partial_fill event
The execution type
The execution type
Represents what side of the transaction an order was on
Represents what side of the transaction an order was on
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.
The max options trading level set by admin for this account.
Represents a change to admin configurations, as broadcast over the **events** streaming API.
The correspondent level daily transfer limit override was changed
Advanced instructions for Direct Market Access (DMA) routing.
Advanced instructions for Elite Smart Router: https://docs.alpaca.markets/docs/alpaca-elite-smart-router
The advanced routing algorithm to use for the order.
The advanced routing algorithm to use for the order
Target exchange for order execution.
Target exchange for order execution
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
Result metadata for a generated REST API call completed through
AlpacaFutures.Immutable top-level facade for common Alpaca workflows.
Builder for immutable
AlpacaClient instances.Safe order workflows exposed by
AlpacaClient.Safe stock-market-data workflows exposed by
AlpacaClient.Entry point for creating pre-configured Alpaca API clients (REST and WebSocket).
Alpaca API credentials (key ID + secret key).
WebSocket client for the Alpaca real-time crypto pricing stream (
/v1beta3/crypto/us).Adapters from generated
*Async(..., ApiCallback<T>) REST methods to CompletableFuture.Factory for OkHttp client instances with Alpaca-recommended defaults.
WebSocket client for the Alpaca real-time news stream (
/v1beta1/news).Handwritten convenience facade for common Trading API order workflows.
A single paginated REST response page with HTTP metadata.
Helpers for Alpaca REST endpoints that return a
next_page_token.Options for bounded and defensive pagination helpers.
Builder for
AlpacaPaginationOptions.Behavior when a pagination sequence repeats a returned next-page token.
Parsed rate-limit metadata from Alpaca REST response headers.
Describes one retry decision made by
AlpacaRetryInterceptor.OkHttp interceptor that retries idempotent REST responses according to an
AlpacaRetryPolicy.Callback hooks for observing
AlpacaRetryInterceptor retry behavior.Immutable configuration for
AlpacaRetryInterceptor.Builder for
AlpacaRetryPolicy.Handwritten convenience facade for common Market Data stock workflows.
WebSocket client for the Alpaca real-time stock pricing stream (
/v2/{source}).Result of a stream's first authentication attempt.
Outcome categories for stream authentication.
Selects between the Alpaca production and sandbox WebSocket endpoints.
Reconnect policy for Alpaca WebSocket stream clients.
Builder for
AlpacaStreamReconnectPolicy.WebSocket client for the Alpaca real-time trading stream (
/stream).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.
API response returned by API call.
API response returned by API call.
API response returned by API call.
APRTier
Additional details of the APR tier
Assets are sorted by asset class, exchange and symbol.
Gets or Sets attributes
Borrow status for US equity assets.
active or inactive
Unique characteristic of an asset.
This represents the category to which the asset belongs to.
This represents the category to which the asset belongs to.
Defines the necessary conditions that must be met to initiate a position for a specific asset
The assets API serves as the master list of assets available for trade and data consumption from Alpaca.
Borrow status for US equity assets.
active or inactive
Generated client for AssetsApi operations.
Generated client for AssetsApi operations.
Bank
ABA (Domestic) or BIC (International)
QUEUED, SENT_TO_CLEARING, APPROVED, REJECTED, CANCELED
Additional wire instructions used to explicitly specify intermediary (correspondent) banks for international wire transfers.
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.
Beneficiary of an account
Status of the bond.
Selects between the Alpaca sandbox and production Broker REST API endpoints.
Streaming wrapper for Broker Events SSE endpoints.
Optional LocalDate-based filters for Broker SSE endpoints.
Optional OffsetDateTime-based filters for Broker SSE endpoints.
Receives lifecycle callbacks and typed events from a Broker Server-Sent Events stream.
Optional OffsetDateTime filters plus an event/account identifier.
Optional legacy LocalDate/numeric-ID/ULID filters plus an event/account identifier.
Optional LocalDate, numeric ID, and ULID filters for legacy Broker SSE endpoints.
Optional filters for Broker non-trading-activity SSE events.
Handle for a Broker SSE subscription.
Generated client for CalendarApi operations.
Generated client for CalendarApi operations.
A calendar day.
A calendar day.
The type of call on the bond refers to one of a variety of circumstances under which a callable bond may be called.
Represents the result of a request to cancel and order
Cash dividend.
Sub-type of the cash dividend.
Generated client for CashInterestApi operations.
Cash merger.
Cash dividend
Cash dividend
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
Approval status of KYC check
Represents the results of checking a Photo for CIPInfo
Overall status of the check.
Represents the result of checking to see if the applicant is in any watchlists for a CIPInfo
Clock
Clock
Generated client for ClockApi operations.
Clock response.
Clock response.
An enum to select how to interpret the value provided in the commission field.
CommonAcatActivityV2
CommonAcatActivityV2
CommonCaActivityV2
CommonCaActivityV2
CommonCDIVActivityV2
CommonCDIVActivityV2
CommonJournalActivityV2
CommonJournalActivityV2
CommonMAActivityV2
CommonMAActivityV2
CommonNCActivityV2
CommonNCActivityV2
CommonNTAActivityV2
CommonNTAActivityV2
CommonOPCAActivityV2
CommonOPCAActivityV2
CommonOptionsActivityV2
CommonOptionsActivityV2
CommonSDIVActivityV2
CommonSDIVActivityV2
CommonSpinoffActivityV2
CommonSpinoffActivityV2
CommonSplitActivityV2
CommonSplitActivityV2
CommonSplitStockActivityV2
CommonSplitStockActivityV2
CommonVOFSubtypeActivityV2
CommonVOFSubtypeActivityV2
Contact is the model for the account owner contact information.
CorporateActions
Generated client for CorporateActionsApi operations.
Generated client for CorporateActionsApi operations.
Generated client for CorporateActionsApi operations.
CorporateActionsResp
CorrespondentLimit
Represents the info for a country.
crypto risk rating of the country
the securities risk rating of the country
Generated client for CountryInfoApi operations.
How often the coupon is paid
The type of the coupon rate
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
Optional chain identifier.
CreateFundingWalletRecipientBankRequest
Bank account type.
Local payment routing system.
CreateFundingWalletWithdrawalRequest
Request to create a new instant funding transfer
Request to create a new settlement.
Journals API allows you to move cash or securities from one account to another.
Request to locate shares for a short sale.
CreateOrderRequest
Takes in a string/number values for stop_price and limit_price
Takes in a string/number value for limit_price
Request to create a new settlement.
[See main docs here](https://alpaca.markets/docs/api-references/broker-api/funding/transfers/#creating-a-transfer-entity)
Deprecated.
This model represents the fields you can specify when Creating or Updating/Replacing a Watchlist
Request format used for creating a new watchlist with a set of assets and name.
CreateWhitelistedAddressRequest
CreateWhitelistedAddressRequest
Optional chain identifier.
Generated client for CryptoApi operations.
OHLC aggregate of all the trades in a given interval.
An aggregated crypto price bar (minute, daily, or updated).
CryptoBarsResp
Chain identifier for multi-chain crypto assets.
Generated client for CryptoFundingApi operations.
Generated client for CryptoFundingApi operations.
Crypto location from where the historical market data is retrieved.
CryptoLatestBarsResp
Crypto location from where the latest market data is retrieved.
CryptoLatestOrderbooksResp
CryptoLatestQuotesResp
CryptoLatestTradesResp
Snapshot of the orderbook.
A full or incremental order book snapshot for a crypto pair (
T: "o").A single entry in a crypto orderbook.
A single price level in a crypto order book.
Generated client for CryptoPerpetualFuturesApi operations.
Crypto perpetual futures pricing data.
CryptoPerpLatestFuturesPricingResp
Crypto perpetual location.
The best bid and ask information for a given security.
A top-of-book quote from the Alpaca crypto exchange order book (
T: "q").CryptoQuotesResp
A snapshot provides the latest trade, latest quote, latest minute bar, latest daily bar and previous daily bar.
CryptoSnapshotsResp
Receives events from a crypto pricing WebSocket stream.
Describes which crypto data channels and pairs to subscribe to (or unsubscribe from).
A crypto trade.
A cryptocurrency trade executed on the Alpaca exchange (
T: "t").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
Cash withdrawal
Cash withdrawal
Represents Identity information for a minor that an account of type \"custodial\" is for
DailyCashInterest
DailyTradingLimit
The day count convention used to calculate accrued interest.
DemoFundingTransfer
DisclosureContextAnnotation
Specifies the type of disclosure annotation.
Disclosures fields denote if the account owner falls under each category defined by FINRA rule.
The industry sector of employment.
One of the following: `employed`, `unemployed`, `retired`, or `student`.
Dividend withholding for non resident aliens
Dividend withholding for non resident aliens
Substitute payment in lieu of dividend
Substitute payment in lieu of dividend
Generated client for DocumentsApi operations.
EoDCashInterestReportResponse
Error
Error
API error response.
Generated client for EventsApi operations.
Generated client for EventsApi operations.
Represents the exchange where an asset is traded.
Represents the current exchanges Alpaca supports.
Represents the current exchanges Alpaca supports.
ExchangeOfferActivityV2
ExchangeOfferActivityV2
Request to exercise an option contract for an account.
Response to an exercise request.
Fee
Fee
Status: * `invoice`
Status: * `withdrawal_fee`: Withdrawal fee * `fx_fee`: FX Fee * `network_fee` * `deposit_fee` * `ach_return_fee` * `parnter_fee` * `alpaca_fee`
Generated client for FixedIncomeApi operations.
FixedIncomeLatestPricesResp
FixedIncomeLatestQuotesResp
The price of the instrument as a percentage of its par value.
The best bid and ask information for a given fixed income security.
Redemption
Redemption
Free-of-payment (FOP) transfers
Free-of-payment (FOP) transfers
Generated client for ForexApi operations.
The response object of the latest forex rates.
A foreign exchange rate between two currencies at a given time.
ForexRatesResp
Forward split.
Forward stock split
Forward stock split
Aggregated FPSL interest and loan-activity counts for one account over a date range.
FPSL API error response
The interest's details.
A loan of a security by an account on a date.
Generated client for FpslProgramApi operations.
FPSLTier
Generated client for FundingApi operations.
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
Generated client for FundingWalletsApi operations.
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
GetOptionsContracts200Response
GetOptionsContracts200Response
GetV1AccountsAccountIdOnfidoSdkTokens200Response
GetV1AccountsPositions200Response
GetV1RebalancingRuns200Response
GetV1RebalancingSubscriptions200Response
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 all or part of their investments in this account to cash without significant loss in value.
The marital status of the user.
The user's investment risk tolerance.
IFFee
Status: * `partner`: The fee on a transfer that was allocated to the partner * `alpaca`: The fee on a transfer that was allocated to Alpaca
Generated client for IndexApi operations.
The response object of the latest index values.
The value of an index at a given point in time.
IndexValuesResp
InstantFunding
Generated client for InstantFundingApi operations.
Status: * `PENDING`: Created and waiting to be processed * `CANCELED`: Canceled * `EXECUTED`: All fees (including Partner fee) are transacted * `FAILED`: Failed mostly due to technical reasons * `COMPLETED`: All transactions are settled
Interest
Generated client for IpoApi operations.
Represents an IPO offering lifecycle event delivered over the IPO events streaming API (`/v2/events/ipos`).
The IPO event type.
An IPO (Initial Public Offering) offering exposed via the IPO discovery REST API.
Whether the offering is currently accepting orders.
Wrapper response returned by `GET /v1/ipos`.
Wrapper response returned by `GET /v1/ipos/{offering_reference}`.
Generated client for IraApi operations.
Always `Bearer`
Values: * `crypto`: Used to identify a crypto only account * `us_equity`: Used to identify an account that trades US equities, or both crypto and US equities.
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).
JITReportDownloadURL
Journal information specific to cash transfers.
Journal entry (cash)
Journal entry (cash)
JNLS
Journal entry (stock)
Journal entry (stock)
Represents a cash or security transfer between accounts, as specified by the `entry_type` parameter.
This enum represents the various kinds of Journal alpaca supports.
Generated client for JournalsApi operations.
Represents the status that a Journal instance can be in.
Represents a change in a Journal's status, sent over the events streaming api.
Represents a change in a Journal's status, sent over the events streaming api.
The type of idempotency key
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, ISO8601Utils will be used.
Gson TypeAdapter for java.util.Date type
If the dateFormat is null, ISO8601Utils will be used.
Gson TypeAdapter for java.util.Date type
If the dateFormat is null, ISO8601Utils 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).
Generated client for KycApi operations.
Hold information about the result of KYC.
A calendar day.
A calendar day.
LegacyClock
LegacyClock
Response to a successful request for a list of APR tiers.
Response to a successful request for a list of FPSL loans.
ListFundingDetails
Response to a successful request for locate quotes.
Response to a successful request for a list of locates.
Named parameters for the Trading API
GET /v2/orders endpoint.Builder for immutable
ListOrdersRequest instances.Sort direction for list-orders results.
Order status filter accepted by the list-orders endpoint.
Gets or Sets ListSortBy
ListTransfersResponse
A locate request and its current lifecycle status.
Locates API error response.
Machine-readable error code.
Current locate pricing and availability for a symbol.
Error returned for a symbol that could not be quoted.
Error code.
Generated client for LocatesApi operations.
Locate status.
Generated client for LogosApi operations.
Generated client for LogosApi operations.
A Limit Up – Limit Down (LULD) price band update (
T: "l").Merger and acquisition
Merger and acquisition
The market identifier (MIC, BIC, or acronym).
The market identifier (MIC, BIC, or acronym).
Market type (stocks or crypto).
Represents an individual leg of a multileg options order.
Represents an individual leg of a multi-leg options order.
A stock that is most active by either volume or trade count.
MostActivesResp
A symbol whose price moved significantly.
Contains list of market movers.
Name change.
Name change
Name change
Model representing a news article.
Generated client for NewsApi operations.
A real-time news article event (
T: "n").A model representing images for a news article.
Possible values for size are thumb, small and large.
NewsResp
Receives events from the real-time news WebSocket stream.
Describes which symbols to subscribe to news for.
NonTradeActivities
Gets or Sets activityType
The activity status.
NonTradeActivity
Valid only for non-trading activity types.
Represents a non-trade activity SSE event
Status of the event
OathClientResponse
ACTIVE or DISABLED
Generated client for OAuthApi operations.
This model is used for both the Issue and Authorize OAuth token routes
Option assignment
Option assignment
Options corporate action of Cash dividend
Options corporate action of Cash dividend
Options corporate action of forward-splits
Options corporate action of forward-splits
Options corporate action of Mergers & Acquisitions
Options corporate action of Mergers & Acquisitions
Options corporate action of name changes
Options corporate action of name changes
Options corporate action of reverse-splits
Options corporate action of reverse-splits
Options corporate action of stock dividend
Options corporate action of stock dividend
Options corporate action of spin-offs
Options corporate action of spin-offs
Options corporate action of unit-splits
Options corporate action of unit-splits
Option exercise
Option exercise
Option expiry
Option expiry
Generated client for OptionApi operations.
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 type of the option contract.
The style of the option contract.
The type of the option contract.
OptionDeliverable
OptionDeliverable
Indicates the settlement method that will be used: - **BTOB**: Broker to Broker - **CADF**: Cash Difference - **CAFX**: Cash Fixed - **CCC**: Correspondent Clearing Corp
Indicates the settlement method that will be used: - **BTOB**: Broker to Broker - **CADF**: Cash Difference - **CAFX**: Cash Fixed - **CCC**: Correspondent Clearing Corp
Indicates when the deliverable will be settled if the contract is exercised/assigned.
Indicates when the deliverable will be settled if the contract is exercised/assigned.
Type of deliverable, indicating whether it's cash or equity.
Type of deliverable, indicating whether it's cash or equity.
Gets or Sets option_feed
The greeks for the contract calculated using the Black-Scholes model.
OptionLatestQuotesResp
OptionLatestTradesResp
The best bid and ask information for a given option.
This property is included when the account's approved options level changes.
OptionsApprovalRequest
The desired option trading level.
OptionsApprovalResponse
The option trading level approved for this request.
The request option trading level.
The requester of the options approval request.
A list of options approval requests.
The request status.
A snapshot provides the latest trade and latest quote.
OptionSnapshotsResp
An option trade.
OptionTradesResp
Trading activity that is paired with the assignment/exercise
Trading activity that is paired with the assignment/exercise
Order
The Orders API allows a user to monitor, place and cancel their orders with Alpaca.
An order entity as returned within trade update events.
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.
OrderLeg
This is copy of Order response schemas as a workaround of displaying issue of nested Order recursively for legs
Generated client for OrdersApi operations.
Represents what side of the transaction an order was on.
Represents which side this order was on: - buy - sell Required for all order classes except for mleg.
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.
OvercontributedIRAAccount
A document associated with an owner of the account
The type of the owner document
The request to upload a document for an owner of the account
Partial call.
The type of lottery for the partial call.
Represents a request to patch an order.
PatchV1AccountsAccountIdOnfidoSdkRequest
PatchV1RebalancingPortfoliosPortfolioIdRequest
Gets or Sets phase
Gets or Sets phase
Portfolio
Current status of portfolio
Timeseries data for equity and profit loss information of the account.
Timeseries data for equity and profit loss information of the account.
Generated client for PortfolioHistoryApi operations.
Generated client for PortfolioHistoryApi operations.
PortfolioRun
system or api
full_rebalance or invest_cash
| 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
long
Represents the result of asking the api to close a position.
Represents the result of asking the api to close a position.
Represents the desired position strategy.
Represents the desired position strategy.
Generated client for PositionsApi operations.
PostOrderRequest
Takes in string/number values for stop_price and limit_price
Takes in a string/number value for limit_price
PostV1RebalancingPortfoliosRequest
PostV1RebalancingRunsRequest
PostV1RebalancingSubscriptionsRequest
PostV1TradingAccountsAccountIdWatchlistsWatchlistIdRequest
Calendar response.
Calendar response.
A market.
A market.
Generated client for RebalancingApi operations.
RebalancingConditions
Redemption.
The region to filter corporate actions by.
Reorganization (cash and/or multiple stock allocations).
A stock allocation leg in a reorganization.
Generated client for ReportingApi operations.
ReportsResponse
Reasons why the liquidation only flag was set
ReverseBatchJournalRequest
Only supports `JNLC` for now
ReverseBatchJournalRequestEntriesInner
Reverse split.
Reverse stock split
Reverse stock split
Rights distribution.
Rights distribution
Rights distribution
RightsSubscriptionElectionActivityV2
RightsSubscriptionElectionActivityV2
Generated client for ScreenerApi operations.
Stock dividend
Stock dividend
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.
SettlementAccount
A settlement response, either from creation or retrieval
Response to a successful settlements request
Values: * `PENDING`: Created and waiting to be processed * `AWAITING_ADDITIONAL_FUNDS`: Waiting for additional funds to be deposited * `COMPLETED`: All transactions are reconciled * `FAILED`: Attempt to process this settlement has failed.
SettlementTransfer
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.
Gets or Sets SortOrder
Spin-off.
Spinoff
Spinoff
A Standard & Poor's rating outlook indicates S&P's view regarding the potential direction of a long-term credit rating over the intermediate term (2 years for investment grade, 1 year for speculative grade)
Represents a change in a Funding entity's status, sent over the events streaming api.
Stock and cash merger.
Generated client for StockApi operations.
An auction
StockAuctionsResp
StockAuctionsRespSingle
OHLC aggregate of all the trades in a given interval.
An aggregated stock price bar (minute, daily, or updated).
StockBarsResp
StockBarsRespSingle
Opening and closing auction prices for a given day.
Stock dividend.
Gets or Sets stock_historical_feed
StockLatestBarsResp
StockLatestBarsRespSingle
Gets or Sets stock_latest_feed
StockLatestQuotesResp
StockLatestQuotesRespSingle
StockLatestTradesResp
StockLatestTradesRespSingle
Stock merger.
The best bid and ask information for a given security.
A National Best Bid and Offer (NBBO) quote update (
T: "q").StockQuotesResp
StockQuotesRespSingle
A snapshot provides the latest trade, latest quote, latest minute bar, current daily bar and previous daily bar.
StockSnapshotsRespSingle
Data source for the stock pricing stream.
Receives events from a stock pricing WebSocket stream.
Describes which stock data channels and symbols to subscribe to (or unsubscribe from).
- A: New York Stock Exchange - B: NYSE Arca, Bats, IEX and other regional exchanges - C: NASDAQ - N: Overnight - O: OTC
A stock trade.
A stock trade execution event (
T: "t").Named parameters for Market Data historical stock-trades endpoints.
Builder for immutable
StockTradesRequest instances.StockTradesResp
StockTradesRespSingle
A trading status update for a security (
T: "s").Represents that system event had occurred and sent over the events streaming api.
the machine readable type of the system event
Required if `tax_id` is set.
TenderOfferActivityV2
TenderOfferActivityV2
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.
Generated client for TokenizationApi operations.
Generated client for TokenizationApi operations.
The tokenized asset's issuer
The tokenized asset's issuer
TokenizationMintCallback
TokenizationMintRequest
TokenizationMintRequest
TokenizationMintResponse
TokenizationMintResponse
The token's blockchain network
The token's blockchain network
TokenizationRedeemRequest
TokenizationRedeemResponse
TokenizationRequest
TokenizationRequest
Status of the tokenization request
Status of the tokenization request
Tokenization request type
Tokenization request 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.
A trade cancellation or error event (
T: "x").A trade correction event (
T: "c").An order lifecycle event for the authenticated account.
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.
Represents filled qty/price of legs.
TradingActivities
Gets or Sets activityType
fill or partial_fill
Generated client for TradingApi operations.
Selects between the Alpaca paper and production Trading REST API endpoints.
Selects between the Alpaca live and paper trading WebSocket endpoints.
Receives events from the real-time trading WebSocket stream (
/stream).The complete set of trading streams to subscribe to.
Transaction
Transfers allow you to transfer money/balance into your end customers' account (deposits) or out (withdrawal).
- **INCOMING** Funds incoming to user's account (deposit).
Gets or Sets TransferDirection
TransferFee
This field is used for IRA Account only
TransferIRADetails
TransferIRATaxWithholding
- **QUEUED** Transfer is in queue to be processed.
Represents a change in a Transfer's status, sent over the events streaming api.
- **ach** Transfer via ACH (US Only).
Information about the transmitter to satisfy travel rule requirements.
The subtype of the treasury.
This model input is optional.
Unit split.
Unit split
Unit split
Represents the fields that are editable in an order replace/update call.
Request format used for updating an existing watchlist with a set of assets and/or a name.
A US corporate
UsCorporatesResp
Usd
USDAccountTradingLimit
Position values in USD.
Position values in USD.
UsTreasuriesResp
A US treasury
Use this property (instead of the content property) to upload W-8 BEN data in JSON format.
Estimated on-chain fee breakdown for a proposed crypto withdrawal, including the total fee and the underlying network (gas) fee.
WarrantExerciseElectionActivityV2
WarrantExerciseElectionActivityV2
Represents a set of securities observed by a user.
The watchlist API provides CRUD operation for the account's watchlist.
Generated client for WatchlistApi operations.
Generated client for WatchlistsApi operations.
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 APPROVED or PENDING.
Status of whitelisted address which is either APPROVED or PENDING.
Worthless removal.
Worthless Removal
Worthless Removal