Package markets.alpaca.client.openapi.trading.model
package markets.alpaca.client.openapi.trading.model
Generated request and response models for the Trading API.
Do not edit this package by hand. It is autogenerated from the pinned
OpenAPI spec under specs/. Regenerate with ./gradlew generateApis
or ./gradlew adoptOpenApi / ./gradlew adoptOpenApiBreaking.
Model class and accessor Javadocs are generated from OpenAPI schema descriptions, property descriptions, enum values, nullability, and deprecation metadata when those fields are present in the spec.
-
ClassDescriptionAbstract class for oneOf,anyOf schemas defined in OpenAPI specAutomated customer account transfer service (cash)Automated customer account transfer service (stock)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 account configuration API provides custom configurations about your trading account settings.The desired maximum options trading level.An enum representing the various possible account status values.Represents an account activity, sent over the Event Streaming API.Represents the common fields for all Activity V2 Events- 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 gains distribution - CSD Cash deposit(+) - CSW Cash withdrawal(-) - DIV Dividends - DIVCGL Dividend (capital gains long term) - DIVCGS Dividend (capital gains 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 - REO Reorganization - REORG Worthless removal CA - SPIN Stock spinoff - SPLIT Stock split - FOPT Free of Payment Transfers - OCT On chain transactions (blockchain deposits/withdrawals)Activity details for a fill or partial_fill eventThe execution typeRepresents what side of the transaction an order was onRequest format used for appending an asset to an existing watchlist.Advanced instructions for Elite Smart Router: https://docs.alpaca.markets/docs/alpaca-elite-smart-routerThe advanced routing algorithm to use for the orderTarget exchange for order executionUnique characteristic of an asset.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.Borrow status for US equity assets.active or inactiveA calendar day.Represents the result of a request to cancel and orderCash-dividend related details.Indicates if related to a non-US security.Indicates if this is a special dividend.Capital gains distribution.ClockClock response.CommonAcatActivityV2CommonCaActivityV2CommonCDIVActivityV2Indicates if related to a non-US security.Indicates if this is a special dividend.Fixed income interest fields (INT/FI).Shared fields for journal non-trade activity records.CommonMAActivityV2CommonNCActivityV2Shared fields for non-trade (NTA) activity records.CommonOPCAActivityV2CommonOptionsActivityV2Reorganization (REO) activity sub-types: - **REOS**: Stock only (1 or more stock legs) - **REOC**: Cash only (one cash leg) - **REOSC**: Stock and cashCommonSDIVActivityV2CommonSpinoffActivityV2CommonSplitActivityV2CommonSplitStockActivityV2CommonVOFSubtypeActivityV2The type of corporate action.A corporate action announcement.CreateCryptoTransferRequestRequest to locate shares for a short sale.Represents a request to create an order.Takes in string/number values for stop_price and limit_priceTakes in a string/number value for limit_priceRequest format used for creating a new watchlist with a set of assets and name.Request format used for whitelisting a crypto address for transfers.Chain identifier for multi-chain crypto assets.Transfers allow you to transfer assets into your end customer's account (deposits) or out (withdrawal).Gets or Sets CryptoTransferStatusCryptoWalletCash withdrawalDividend withholding for non resident aliensSubstitute payment in lieu of dividendIndicates if related to a non-US security.Indicates if this is a special dividend.Dividend tax withholding (e.g.ErrorAPI error response.Represents the current exchanges Alpaca supports.Represents the current exchanges Alpaca supports.ExchangeOfferActivityV2FeeFixed income interest (INT/FI)Distinguishes coupon payments from accrued interest on INT/FI activities.RedemptionFree-of-payment (FOP) transfersForward stock splitJournal entry (cash)Journal entry (stock)A calendar day.LegacyClockResponse to a successful request for locate quotes.Response to a successful request for a list of locates.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.Locate status.Merger and acquisitionThe market identifier (MIC, BIC, or acronym).Instant funding memopostRepresents an individual leg of a multi-leg options order.Name changeNonTradeActivitiesGets or Sets activityTypeThe activity status.On chain transaction (blockchain deposit/withdrawal)Option assignmentOptions corporate action of cash dividend or return of capitalIndicates if related to a non-US security.Indicates if this is a special dividend.Options corporate action of forward-splitsOptions corporate action of Mergers & AcquisitionsOptions corporate action of name changesOptions corporate action of reverse-splitsOptions corporate action of stock dividendOptions corporate action of spin-offsOptions corporate action of unit-splitsOption cash deliverable for non-standard contractsOption exerciseOption expiryOptionContractThe status of the option contract.Paginated list of option contracts.The style of the option contract.The type of the option contract.OptionDeliverableIndicates the settlement method that will be used: - **BTOB**: Broker to Broker - **CADF**: Cash Difference - **CAFX**: Cash Fixed - **CCC**: Correspondent Clearing CorpIndicates when the deliverable will be settled if the contract is exercised/assigned.Type of deliverable, indicating whether it's cash or equity.Trading activity that is paired with the assignment/exerciseThe 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.This is copy of Order response schemas as a workaround of displaying issue of nested Order recursively for legsRepresents which side this order was on: - buy - sell Required for all order classes except for mleg.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.Represents a request to patch an order.Gets or Sets phaseTimeseries data for equity and profit loss information of the account.The positions API provides information about an account's current open positions.longRepresents the result of asking the api to close a position.Represents the desired position strategy.Calendar response.A market.Reorganization (REO)Reverse stock splitRights distributionRightsSubscriptionElectionActivityV2Stock dividendPaginated VASP directory search results.SpinoffTenderOfferActivityV2The Time-In-Force values supported by Alpaca vary based on the order's security type.The tokenized asset's issuerTokenizationMintRequestTokenizationMintResponseThe token's blockchain networkTokenizationRequestStatus of the tokenization requestTokenization request typeTradingActivitiesGets or Sets activityTypefill or partial_fillGets or Sets TransferDirectionAllowed value for a travel rule field that accepts a fixed set of choices.Travel rule information pertaining to the wallet being whitelisted.Information about a beneficiary VASP that is not available in the VASP directory.Action the client must take to satisfy travel rule requirements.Gets or Sets typeRequest field required to complete a travel rule action.Gets or Sets valueTypeTravel rule validation failure and the actions required to correct it.Machine-readable code identifying the travel rule validation failure.Unit splitRequest format used for updating an existing watchlist with a set of assets and/or a name.Travel rule information to associate with a whitelisted address.Position values in USD.Virtual Asset Service Provider returned by the directory search.A wallet error response.Estimated on-chain fee breakdown for a proposed crypto withdrawal, including the total fee and the underlying network (gas) fee.WarrantExerciseElectionActivityV2The watchlist API provides CRUD operation for the account's watchlist.The watchlist API provides CRUD operation for the account's watchlist.WhitelistedAddressStatus of whitelisted address which is either APPROVED or PENDING.Worthless Removal