Package markets.alpaca.client.openapi.data.model
package markets.alpaca.client.openapi.data.model
Generated request and response models for the Market Data 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 specCommon fields present on every `ca` payload regardless of `event_type`.Capital-gains distribution payload delivered when `event_type == capital_gains_distribution_corporateaction_event`.Cash dividend payload delivered when `event_type == cash_dividend_corporateaction_event`.Optional sub-classification of the dividend.Cash merger payload delivered when `event_type == cash_merger_corporateaction_event`.Partial redemption of an equity issue where the issuer calls back only a fraction of outstanding shares -- typically allocated to holders via a lottery.How called shares were allocated among holders.Forward stock split payload delivered when `event_type == forward_split_corporateaction_event`.Name/ticker change payload delivered when `event_type == name_change_corporateaction_event`.Full redemption payload delivered when `event_type == redemption_corporateaction_event`.General-purpose corporate restructuring (e.g.A single replacement-security leg of a [`ca_event_reorganization`](#/components/schemas/ca_event_reorganization) payload.Reverse stock split payload delivered when `event_type == reverse_split_corporateaction_event`.Rights distribution payload delivered when `event_type == rights_distribution_corporateaction_event`.Spin-off payload delivered when `event_type == spin_off_corporateaction_event`.Merger paying a mix of stock and cash.Stock dividend payload delivered when `event_type == stock_dividend_corporateaction_event`.All-stock merger payload delivered when `event_type == stock_merger_corporateaction_event`.Unit split payload delivered when `event_type == unit_split_corporateaction_event`.Worthless removal payload delivered when `event_type == worthless_removal_corporateaction_event`.Capital gains distribution paid by a fund.Cash dividend.Sub-type of the cash dividend.Cash merger.Kind of mutation that produced this event on the upstream corporate actions store: - `insert`: a new corporate action was created.Common envelope fields shared by every variant of [`corporate_action_event`](#/components/schemas/corporate_action_event).`corporate_action_event` envelope specialized to `event_type == capital_gains_distribution_corporateaction_event`.Gets or Sets eventType`corporate_action_event` envelope specialized to `event_type == cash_dividend_corporateaction_event`.Gets or Sets eventType`corporate_action_event` envelope specialized to `event_type == cash_merger_corporateaction_event`.Gets or Sets eventType`corporate_action_event` envelope specialized to `event_type == equity_partial_call_corporateaction_event`.Gets or Sets eventType`corporate_action_event` envelope specialized to `event_type == forward_split_corporateaction_event`.Gets or Sets eventType`corporate_action_event` envelope specialized to `event_type == name_change_corporateaction_event`.Gets or Sets eventType`corporate_action_event` envelope specialized to `event_type == redemption_corporateaction_event`.Gets or Sets eventTypeEnvelope-level classification derived from `metadata.global` on the upstream corporate-action record.`corporate_action_event` envelope specialized to `event_type == reorganization_corporateaction_event`.Gets or Sets eventType`corporate_action_event` envelope specialized to `event_type == reverse_split_corporateaction_event`.Gets or Sets eventType`corporate_action_event` envelope specialized to `event_type == rights_distribution_corporateaction_event`.Gets or Sets eventType`corporate_action_event` envelope specialized to `event_type == spin_off_corporateaction_event`.Gets or Sets eventType`corporate_action_event` envelope specialized to `event_type == stock_and_cash_merger_corporateaction_event`.Gets or Sets eventType`corporate_action_event` envelope specialized to `event_type == stock_dividend_corporateaction_event`.Gets or Sets eventType`corporate_action_event` envelope specialized to `event_type == stock_merger_corporateaction_event`.Gets or Sets eventTypeDiscriminator that determines the shape of the `ca` field on a [`corporate_action_event`](#/components/schemas/corporate_action_event).`corporate_action_event` envelope specialized to `event_type == unit_split_corporateaction_event`.Gets or Sets eventType`corporate_action_event` envelope specialized to `event_type == worthless_removal_corporateaction_event`.Gets or Sets eventTypeCorporateActionsCorporateActionsRespOHLC aggregate of all the trades in a given interval.CryptoBarsRespCrypto location from where the historical market data is retrieved.CryptoLatestBarsRespCrypto location from where the latest market data is retrieved.CryptoLatestOrderbooksRespCryptoLatestQuotesRespCryptoLatestTradesRespSnapshot of the orderbook.A single entry in a crypto orderbook.The best bid and ask information for a given security.CryptoQuotesRespA snapshot provides the latest trade, latest quote, latest minute bar, latest daily bar and previous daily bar.CryptoSnapshotsRespA crypto trade.CryptoTradesRespControls which corporate actions are returned based on data quality.Latest fixed-income prices keyed by ISIN.Latest fixed-income best bid and ask quotes keyed by ISIN.The price of the instrument as a percentage of its par value.The best bid and ask information for a given fixed income security.The response object of the latest forex rates.A foreign exchange rate between two currencies at a given time.ForexRatesRespForward split.Market type (stocks or crypto).A stock that is most active by either volume or trade count.MostActivesRespA symbol whose price moved significantly.Contains list of market movers.Name change.Model representing a news article.A model representing images for a news article.Possible values for size are thumb, small and large.NewsRespOHLC aggregate of all the trades in a given interval.OptionBarsRespGets or Sets option_feedThe greeks for the contract calculated using the Black-Scholes model.OptionLatestQuotesRespOptionLatestTradesRespThe best bid and ask information for a given option.A snapshot provides the latest trade and latest quote.OptionSnapshotsRespAn option trade.OptionTradesRespPartial call.The type of lottery for the partial call.Redemption.The region to filter corporate actions by.Reorganization (cash and/or multiple stock allocations).A stock allocation leg in a reorganization.Reverse split.Rights distribution.Sort data in ascending or descending order.Spin-off.Stock and cash merger.An auctionStockAuctionsRespStockAuctionsRespSingleOHLC aggregate of all the trades in a given interval.StockBarsRespStockBarsRespSingleOpening and closing auction prices for a given day.Stock dividend.Gets or Sets stock_historical_feedStockLatestBarsRespStockLatestBarsRespSingleGets or Sets stock_latest_feedStockLatestQuotesRespStockLatestQuotesRespSingleStockLatestTradesRespStockLatestTradesRespSingleStock merger.The best bid and ask information for a given security.StockQuotesRespStockQuotesRespSingleA snapshot provides the latest trade, latest quote, latest minute bar, current daily bar and previous daily bar.StockSnapshotsRespSingle- A: New York Stock Exchange - B: NYSE Arca, Bats, IEX and other regional exchanges - C: NASDAQ - N: Overnight - O: OTCA stock trade.StockTradesRespStockTradesRespSingleUnit split.Worthless removal.