Package markets.alpaca.client.openapi.broker.model
package markets.alpaca.client.openapi.broker.model
Generated request and response models for the Broker 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)Account type, as represented by DTCCAutomated customer account transfer service (stock)An asset included in an ACATS transfer.Asset typeStatusCash balanceCurrency of the cash balance.Contra account detailsA contra broker or bank participating in ACATS, identified by its DTCC account number.ACATS participant typeTransfer status as tracked by DTCCACATS transfer typeEquity asset requested in a partial transfer.Position type.Body for responses with HTTP status codes indicating an errorRequest body for initiating an incoming ACATS transfer.Response returned when an ACATS transfer has been accepted for processing.Transfer typeResponse containing the list of valid ACATS contra brokers.A page of ACATS transfers, with optional pagination tokens.Position type.Why the transfer was rejected, only present on transfers in rejected statusRejection reason, as returned by DTCCList of securities to transferSort direction for list results.Status detailsAn ACATS transfer and its current status.Transfer directionTransfer status as tracked by AlpacaRepresents high level account info.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.AccountCashInterestProgramThe configuration and status of the account's USD cash interest programRepresents additional configuration settings for an accountThe desired maximum options trading level.all or none.Fields accepted when creating an 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.The account type to create.A document associated with an accountThe type of the account documentRepresents 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.AccountFPSLEventUSAccountFPSLItemAccountFPSLItemPostThe 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.AccountLimitDesignates the current status of this account Possible Values: - **INACTIVE** Account not set to trade given asset.Represents a change to certain account properties, sent over the events streaming API.IRA Account only Possible values are: - traditional - rothAccountTradingLimitThe account type returned for the account.AccountUpdateRequestACHRelationshipMust be CHECKING or SAVINGSGets or Sets statusBase for activity typesValid only for non-trading activity types.Valid only for trading activity types.Represents an account activity, sent over the Event Streaming API.Represents the common fields for all Activity V2 EventsRepresents the various kinds of activity.Activity details for a fill or partial_fill eventThe execution typeRepresents what side of the transaction an order was onRepresents structure of an Identifier for all AdminAction typeGets or Sets AdminActionBelongsToKindCategory of the Admin ActionVariable schema type which depends on the typeVariable schema type which depends on the typeRepresents structure of an Creator's Identifier for all AdminAction typeGets or Sets AdminActionCreatedByKindRepresents general fields for all AdminAction typeRepresents structure of a LegacyNote type AdminActionRepresents structure of a Liquidation type AdminActionRepresents structure of a TransactionCancel type AdminActionType of the Admin ActionVisibility of the Admin ActionThese configurations show account properties that are overridden 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 changedMax margin multiplier was changed by admin to this valueMax options trading level was changed by admin to this value.Advanced instructions for Direct Market Access (DMA) routing.The advanced routing algorithm to use for the order.Target exchange for order execution.AggregatePositionResponseAgreement- 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 agreementThe 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.APRTierAdditional details of the APR tierAssets are sorted by asset class, exchange and symbol.Gets or Sets attributesBorrow status for US equity assets.active or inactiveThis represents the category to which the asset belongs to.Defines the necessary conditions that must be met to initiate a position for a specific assetBankABA (Domestic) or BIC (International)QUEUED, SENT_TO_CLEARING, APPROVED, REJECTED, CANCELEDAdditional wire instructions used to explicitly specify intermediary (correspondent) banks for international wire transfers.BatchCreateFundingWalletRequestBatchCreateFundingWalletResponseJournals API allows you to move cash or securities from one account to another.Only supports `JNLC` for nowBatchJournalRequestEntriesInnerA cash journal result returned by the forward batch endpoint.Cash journal discriminator value.A securities journal result that preserves discriminator-complete batch response modeling, although current public batch requests support JNLC only.Securities journal discriminator value.Beneficiary of an accountStatus of the bond.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.Cash-dividend related details.Indicates if related to a non-US security.Indicates if this is a special dividend.Capital gains distribution.Represents results of checking a document for CIPInfoCIPIdentityCustomer Identification Program (CIP) information for an account applicant.Represents Know Your Customer (KYC) info for a CIPInfoApproval status of KYC checkRepresents the results of checking a Photo for CIPInfoOverall status of the check.Represents the result of checking to see if the applicant is in any watchlists for a CIPInfoClockClock response.An enum to select how to interpret the value provided in the commission field.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 cashCommonSDIVActivityV2CommonSpinoffActivityV2CommonSplitActivityV2CommonSplitStockActivityV2CommonVOFSubtypeActivityV2Contact is the model for the account owner contact information.CorrespondentLimitRepresents the info for a country.crypto risk rating of the countrythe securities risk rating of the countryHow often the coupon is paidThe type of the coupon rateRepresents 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 accountABA (Domestic) or BIC (International)CreateCryptoTransferRequestOptional chain identifier.CreateFundingWalletRecipientBankRequestBank account type.Local payment routing system.CreateFundingWalletWithdrawalRequestRequest to create a new instant funding transferRequest to create a new settlement.Journals API allows you to move cash or securities from one account to another.CreateOrderRequestTakes in a string/number values for stop_price and limit_priceTakes in a string/number value for limit_priceRequest to create a new settlement.[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 WatchlistCreateWhitelistedAddressRequestOptional chain identifier.Transfers allow you to transfer assets into your end customer's account (deposits) or out (withdrawal).Gets or Sets CryptoTransferStatusCryptoWalletCash withdrawalRepresents Identity information for a minor that an account of type \"custodial\" is forDailyCashInterestCorrespondent-level daily net buying limit and the real-time amount currently consuming it.The day count convention used to calculate accrued interest.DemoFundingTransferDisclosureContextAnnotationSpecifies 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 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.An asset class that can be enabled on a brokerage account, i.e.EoDCashInterestReportResponseErrorRepresents the exchange where an asset is traded.ExchangeOfferActivityV2Request to exercise an option contract for an account.Response to an exercise request.FeeStatus: * `invoice`Status: * `withdrawal_fee`: Withdrawal fee * `fx_fee`: FX Fee * `network_fee` * `deposit_fee` * `ach_return_fee` * `parnter_fee` * `alpaca_fee`Fixed income interest (INT/FI)Distinguishes coupon payments from accrued interest on INT/FI activities.RedemptionFree-of-payment (FOP) transfersForward stock splitAggregated FPSL interest and loan-activity counts for one account over a date range.FPSL API error responseThe interest's details.A loan of a security by an account on a date.FPSLTierTransfers the entire account.Gets or Sets typeGets funding details that can be used to settle and collect funds in each available currency.Status: * `swift_wire`: SWIFT wire * `local_rails`: Local schemeStatus: * `BIC`: bic_swift * `ACH`: ach_routing_code * `ABA`: aba * `ROUTING`: routing_code * `SORT_CODE`: sort_codeFundingWalletFundingWalletRecipientBankStatus: * `active`: The funding wallet is ready * `pending`: The funding wallet is being processed * `disabled`: The funding wallet is disabledFundingWalletTransferStatus: * `incoming`: incoming amount * `outgoing`: outgoing amountStatus: * `PENDING`: Created and waiting to be processed * `CANCELED`: Canceled * `FAILED`: Failed mostly due to technical reasons * `COMPLETE`: Transfer has settledGetCryptoTransferEstimate200ResponseGetOptionsContracts200ResponseGetV1AccountsAccountIdOnfidoSdkTokens200ResponseGetV1AccountsPositions200ResponseGetV1RebalancingRuns200ResponseGetV1RebalancingSubscriptions200ResponseGetV1ReportingEodPositions200ResponseGetV1TradingAccountsAccountIdOrdersEstimationRequestGetV1TransfersJitLedgerIdBalances200ResponseIdentity is the model to provide account owner's identity information.Gets or Sets fundingSourceThe 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.IFFeeStatus: * `partner`: The fee on a transfer that was allocated to the partner * `alpaca`: The fee on a transfer that was allocated to AlpacaInstantFundingStatus: * `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 settledInterestRepresents 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}`.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.JITLedgerAccountJIT 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).JITReportDownloadURLA cash journal response with all shared Journal fields.Cash journal discriminator value.Journal entry (cash)A securities journal response with all shared Journal fields.Securities journal discriminator value.Journal entry (stock)Shared response fields returned for cash and securities journals.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.Represents a change in a Journal's status, sent over the events streaming api.The type of idempotency keyPrevious journal status in stream status-change events.Holds information about the result of KYC.A calendar day.LegacyClockResponse to a successful request for a list of APR tiers.Response to a successful request for a list of FPSL loans.ListFundingDetailsGets or Sets ListSortByListTransfersResponseMerger and acquisitionThe market identifier (MIC, BIC, or acronym).Instant funding memopostRepresents an individual leg of a multileg options order.Name changeNonTradeActivityValid only for non-trading activity types.Represents a non-trade activity SSE eventStatus of the event.OathClientResponseACTIVE or DISABLEDThis model is used for both the Issue and Authorize OAuth token routesOn 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.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.This property is included when the account's approved options level changes.OptionsApprovalRequestThe desired option trading level.OptionsApprovalResponseThe 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.Trading activity that is paired with the assignment/exerciseOrderThe order classes supported by Alpaca vary based on the order's security type.Represents the result of asking the api to cancel an Order.OrderLegRepresents what side of the transaction an order was on.Gets or Sets OrderStatusThe order types supported by Alpaca vary based on the order's security type.OvercontributedIRAAccountA document associated with an owner of the accountThe type of the owner documentThe request to upload a document for an owner of the accountPartialTransferAnyOfPartialTransferAnyOf1PartialTransferAnyOf1SecuritiesPatchV1AccountsAccountIdOnfidoSdkRequestPatchV1RebalancingPortfoliosPortfolioIdRequestGets or Sets phasePortfolioCurrent status of portfolioTimeseries data for equity and profit loss information of the account.PortfolioRunsystem or apifull_rebalance or invest_cash| Status | Final | Represented State | Notes | |:------------------:|:-----:|:--------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------:| | QUEUED | No | The run has been queued, waiting for our system to process it.PortfolioSubscriptionPortfolioWeightRequestOneOfGets or Sets typePortfolioWeightRequestOneOf1Gets or Sets typePortfolioWeightsType of weight entry in a portfolio.PositionGets or Sets sideRepresents the result of asking the api to close a position.Represents the desired position strategy.PostV1RebalancingPortfoliosRequestPostV1RebalancingRunsRequestThe kind of rebalance run to create.PostV1RebalancingSubscriptionsRequestPostV1TradingAccountsAccountIdWatchlistsWatchlistIdRequestCalendar response.A market.RebalancingConditionsReorganization (REO)ReportsResponseReasons why the liquidation only flag was setReverseBatchJournalRequestOnly supports `JNLC` for nowReverseBatchJournalRequestEntriesInnerReverse stock splitRights distributionRightsSubscriptionElectionActivityV2Stock dividendPaginated VASP directory search results.SettlementAccountA settlement response, either from creation or retrievalResponse to a successful settlements requestValues: * `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.SettlementTransferSkipped orders model contains information for such orders that the rebalancing engine didn't send to our order system due to some validation issues.Gets or Sets SortOrderSpinoffA 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.Represents that system event had occurred and sent over the events streaming api.the machine readable type of the system eventAn Enum of the various kinds of Tax ID formats Alpaca supports.TenderOfferActivityV2The Time-In-Force values supported by Alpaca vary based on the order's security type.The tokenized asset's issuerTokenizationMintCallbackTokenizationMintRequestTokenizationMintResponseThe token's blockchain networkTokenizationRedeemRequestTokenizationRedeemResponseTokenizationRequestStatus of the tokenization requestTokenization request typeThis 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.TradeActivityValid only for trading activity types.**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.TransactionTransfers allow you to transfer money/balance into your end customers' account (deposits) or out (withdrawal).- **INCOMING** Funds incoming to user's account (deposit).TransferFeeThis field is used for IRA Account onlyTransferIRADetailsTransferIRATaxWithholding- **QUEUED** Transfer is in queue to be processed.Represents a change in a Transfer's status, sent over the events streaming api.Previous transfer status in stream status-change events.- **ach** Transfer via ACH (US Only).Information about the transmitter to satisfy travel rule requirements.Allowed 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.The subtype of the treasury.This model input is optional.Unit splitRepresents the fields that are editable in an order replace/update call.Travel rule information to associate with a whitelisted address.A US corporateUsCorporatesRespUsdUSDAccountTradingLimitPosition values in USD.UsTreasuriesRespA US treasuryVirtual Asset Service Provider returned by the directory search.Use this property (instead of the content property) to upload W-8 BEN data in JSON format.A wallet error response.WarrantExerciseElectionActivityV2Represents a set of securities observed by a user.Represents a set of securities observed by a user.WhitelistedAddressStatus of whitelisted address which is either APPROVED or PENDING.Worthless Removal