@alpaca-open-api/core 0.1.0-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api-routing.d.ts +13 -0
- package/dist/generated/authx/client.d.ts +37 -0
- package/dist/generated/authx/model/clientId.d.ts +13 -0
- package/dist/generated/authx/model/errorCode.d.ts +45 -0
- package/dist/generated/authx/model/errorResponse.d.ts +13 -0
- package/dist/generated/authx/model/errorResponseField.d.ts +10 -0
- package/dist/generated/authx/model/index.d.ts +15 -0
- package/dist/generated/authx/model/tokenRequest.d.ts +26 -0
- package/dist/generated/authx/model/tokenRequestClientAssertionType.d.ts +13 -0
- package/dist/generated/authx/model/tokenRequestGrantType.d.ts +15 -0
- package/dist/generated/authx/model/tokenResponse.d.ts +17 -0
- package/dist/generated/authx/model/tokenResponseTokenType.d.ts +13 -0
- package/dist/generated/broker/client.d.ts +3825 -0
- package/dist/generated/broker/model/aCHRelationship.d.ts +34 -0
- package/dist/generated/broker/model/aCHRelationshipBankAccountType.d.ts +16 -0
- package/dist/generated/broker/model/aCHRelationshipStatus.d.ts +15 -0
- package/dist/generated/broker/model/aPRTier.d.ts +27 -0
- package/dist/generated/broker/model/aPRTierDetails.d.ts +18 -0
- package/dist/generated/broker/model/acatcActivityV2.d.ts +13 -0
- package/dist/generated/broker/model/acatsActivityV2.d.ts +16 -0
- package/dist/generated/broker/model/account.d.ts +57 -0
- package/dist/generated/broker/model/accountCashInterestEvent.d.ts +23 -0
- package/dist/generated/broker/model/accountCashInterestPatch.d.ts +19 -0
- package/dist/generated/broker/model/accountCashInterestPost.d.ts +17 -0
- package/dist/generated/broker/model/accountCashInterestProgram.d.ts +21 -0
- package/dist/generated/broker/model/accountCashInterestResponse.d.ts +14 -0
- package/dist/generated/broker/model/accountConfigurations.d.ts +38 -0
- package/dist/generated/broker/model/accountConfigurationsDtbpCheck.d.ts +17 -0
- package/dist/generated/broker/model/accountConfigurationsMaxOptionsTradingLevel.d.ts +17 -0
- package/dist/generated/broker/model/accountConfigurationsTradeConfirmEmail.d.ts +15 -0
- package/dist/generated/broker/model/accountCreationRequest.d.ts +63 -0
- package/dist/generated/broker/model/accountCreationRequestInvestmentObjective.d.ts +18 -0
- package/dist/generated/broker/model/accountCreationRequestInvestmentTimeHorizon.d.ts +18 -0
- package/dist/generated/broker/model/accountCreationRequestLiquidityNeeds.d.ts +17 -0
- package/dist/generated/broker/model/accountCreationRequestRiskTolerance.d.ts +16 -0
- package/dist/generated/broker/model/accountDocument.d.ts +19 -0
- package/dist/generated/broker/model/accountDocumentType.d.ts +20 -0
- package/dist/generated/broker/model/accountDocumentTypeParameter.d.ts +17 -0
- package/dist/generated/broker/model/accountExtended.d.ts +78 -0
- package/dist/generated/broker/model/accountExtendedInvestmentObjective.d.ts +18 -0
- package/dist/generated/broker/model/accountExtendedInvestmentTimeHorizon.d.ts +18 -0
- package/dist/generated/broker/model/accountExtendedLiquidityNeeds.d.ts +17 -0
- package/dist/generated/broker/model/accountExtendedRiskTolerance.d.ts +16 -0
- package/dist/generated/broker/model/accountExtendedUsd.d.ts +13 -0
- package/dist/generated/broker/model/accountFPSLEvent.d.ts +15 -0
- package/dist/generated/broker/model/accountFPSLEventUS.d.ts +17 -0
- package/dist/generated/broker/model/accountFPSLItem.d.ts +19 -0
- package/dist/generated/broker/model/accountFPSLItemPost.d.ts +11 -0
- package/dist/generated/broker/model/accountFPSLPatch.d.ts +20 -0
- package/dist/generated/broker/model/accountFPSLPost.d.ts +16 -0
- package/dist/generated/broker/model/accountFPSLResponse.d.ts +15 -0
- package/dist/generated/broker/model/accountLimit.d.ts +13 -0
- package/dist/generated/broker/model/accountStatus.d.ts +48 -0
- package/dist/generated/broker/model/accountStatusEvent.d.ts +63 -0
- package/dist/generated/broker/model/accountSubType.d.ts +20 -0
- package/dist/generated/broker/model/accountTradingLimit.d.ts +21 -0
- package/dist/generated/broker/model/accountType.d.ts +22 -0
- package/dist/generated/broker/model/accountUpdateRequest.d.ts +33 -0
- package/dist/generated/broker/model/activity.d.ts +18 -0
- package/dist/generated/broker/model/activityEventV2.d.ts +16 -0
- package/dist/generated/broker/model/activityEventV2CommonFields.d.ts +53 -0
- package/dist/generated/broker/model/activitySubType.d.ts +80 -0
- package/dist/generated/broker/model/activityType.d.ts +103 -0
- package/dist/generated/broker/model/activityV2DetailNTA.d.ts +44 -0
- package/dist/generated/broker/model/activityV2DetailTRD.d.ts +36 -0
- package/dist/generated/broker/model/activityV2DetailTRDExecutionType.d.ts +16 -0
- package/dist/generated/broker/model/activityV2DetailTRDSide.d.ts +15 -0
- package/dist/generated/broker/model/adminActionBelongsTo.d.ts +15 -0
- package/dist/generated/broker/model/adminActionBelongsToKind.d.ts +13 -0
- package/dist/generated/broker/model/adminActionCategory.d.ts +15 -0
- package/dist/generated/broker/model/adminActionCreatedBy.d.ts +15 -0
- package/dist/generated/broker/model/adminActionCreatedByKind.d.ts +11 -0
- package/dist/generated/broker/model/adminActionEventGeneral.d.ts +32 -0
- package/dist/generated/broker/model/adminActionLegacyNote.d.ts +17 -0
- package/dist/generated/broker/model/adminActionLiquidation.d.ts +21 -0
- package/dist/generated/broker/model/adminActionTransactionCancel.d.ts +19 -0
- package/dist/generated/broker/model/adminActionType.d.ts +16 -0
- package/dist/generated/broker/model/adminActionVisibility.d.ts +16 -0
- package/dist/generated/broker/model/adminConfigurations.d.ts +82 -0
- package/dist/generated/broker/model/adminConfigurationsMaxMarginMultiplier.d.ts +16 -0
- package/dist/generated/broker/model/adminConfigurationsMaxOptionsTradingLevel.d.ts +16 -0
- package/dist/generated/broker/model/afterParameter.d.ts +11 -0
- package/dist/generated/broker/model/aggregatePositionResponse.d.ts +27 -0
- package/dist/generated/broker/model/agreement.d.ts +21 -0
- package/dist/generated/broker/model/agreementType.d.ts +23 -0
- package/dist/generated/broker/model/announcement.d.ts +90 -0
- package/dist/generated/broker/model/announcementCASubType.d.ts +60 -0
- package/dist/generated/broker/model/announcementCAType.d.ts +27 -0
- package/dist/generated/broker/model/asset.d.ts +71 -0
- package/dist/generated/broker/model/assetAttributesItem.d.ts +18 -0
- package/dist/generated/broker/model/assetBorrowStatus.d.ts +15 -0
- package/dist/generated/broker/model/assetClass.d.ts +17 -0
- package/dist/generated/broker/model/assetClassParameter.d.ts +12 -0
- package/dist/generated/broker/model/assetClassParameterItem.d.ts +14 -0
- package/dist/generated/broker/model/assetEntryRequirements.d.ts +28 -0
- package/dist/generated/broker/model/assetStatus.d.ts +15 -0
- package/dist/generated/broker/model/authorizeOAuthTokenResponse.d.ts +26 -0
- package/dist/generated/broker/model/badRequestResponse.d.ts +12 -0
- package/dist/generated/broker/model/bank.d.ts +38 -0
- package/dist/generated/broker/model/bankAdditionalFields.d.ts +18 -0
- package/dist/generated/broker/model/bankBankCodeType.d.ts +15 -0
- package/dist/generated/broker/model/bankStatus.d.ts +18 -0
- package/dist/generated/broker/model/batchCreateFundingWalletRequest.d.ts +11 -0
- package/dist/generated/broker/model/batchCreateFundingWalletResponse.d.ts +11 -0
- package/dist/generated/broker/model/batchJournalRequest.d.ts +27 -0
- package/dist/generated/broker/model/batchJournalRequestEntriesItem.d.ts +26 -0
- package/dist/generated/broker/model/batchJournalRequestEntryType.d.ts +14 -0
- package/dist/generated/broker/model/batchJournalResponse.d.ts +15 -0
- package/dist/generated/broker/model/beneficiary.d.ts +21 -0
- package/dist/generated/broker/model/bic.d.ts +14 -0
- package/dist/generated/broker/model/bondStatus.d.ts +16 -0
- package/dist/generated/broker/model/cDIVActivityV2.d.ts +18 -0
- package/dist/generated/broker/model/cIPDocument.d.ts +63 -0
- package/dist/generated/broker/model/cIPIdentity.d.ts +41 -0
- package/dist/generated/broker/model/cIPInfo.d.ts +31 -0
- package/dist/generated/broker/model/cIPPhoto.d.ts +39 -0
- package/dist/generated/broker/model/cIPPhotoStatus.d.ts +15 -0
- package/dist/generated/broker/model/cIPProvider.d.ts +16 -0
- package/dist/generated/broker/model/cIPResult.d.ts +11 -0
- package/dist/generated/broker/model/cIPStatus.d.ts +15 -0
- package/dist/generated/broker/model/cIPWatchlist.d.ts +26 -0
- package/dist/generated/broker/model/cSWActivityV2.d.ts +15 -0
- package/dist/generated/broker/model/calendarDay.d.ts +32 -0
- package/dist/generated/broker/model/calendarParams.d.ts +24 -0
- package/dist/generated/broker/model/callType.d.ts +17 -0
- package/dist/generated/broker/model/cipkyc.d.ts +51 -0
- package/dist/generated/broker/model/cipkycApprovalStatus.d.ts +15 -0
- package/dist/generated/broker/model/clock.d.ts +23 -0
- package/dist/generated/broker/model/clockParams.d.ts +59 -0
- package/dist/generated/broker/model/clockResp.d.ts +14 -0
- package/dist/generated/broker/model/closeAllPositionsForAccountParams.d.ts +13 -0
- package/dist/generated/broker/model/closePositionForAccountBySymbolParams.d.ts +17 -0
- package/dist/generated/broker/model/commissionType.d.ts +26 -0
- package/dist/generated/broker/model/commonAcatActivityV2.d.ts +18 -0
- package/dist/generated/broker/model/commonCDIVActivityV2.d.ts +44 -0
- package/dist/generated/broker/model/commonCaActivityV2.d.ts +19 -0
- package/dist/generated/broker/model/commonJournalActivityV2.d.ts +12 -0
- package/dist/generated/broker/model/commonMAActivityV2.d.ts +31 -0
- package/dist/generated/broker/model/commonNCActivityV2.d.ts +17 -0
- package/dist/generated/broker/model/commonNTAActivityV2.d.ts +16 -0
- package/dist/generated/broker/model/commonOPCAActivityV2.d.ts +20 -0
- package/dist/generated/broker/model/commonOptionsActivityV2.d.ts +9 -0
- package/dist/generated/broker/model/commonSDIVActivityV2.d.ts +30 -0
- package/dist/generated/broker/model/commonSpinoffActivityV2.d.ts +45 -0
- package/dist/generated/broker/model/commonSplitActivityV2.d.ts +22 -0
- package/dist/generated/broker/model/commonSplitStockActivityV2.d.ts +15 -0
- package/dist/generated/broker/model/commonVOFSubtypeActivityV2.d.ts +17 -0
- package/dist/generated/broker/model/contact.d.ts +26 -0
- package/dist/generated/broker/model/correspondentLimit.d.ts +12 -0
- package/dist/generated/broker/model/countryInfo.d.ts +25 -0
- package/dist/generated/broker/model/countryInfoCryptoRiskRating.d.ts +17 -0
- package/dist/generated/broker/model/countryInfoSecuritiesRiskRating.d.ts +17 -0
- package/dist/generated/broker/model/countryInfos.d.ts +14 -0
- package/dist/generated/broker/model/couponFrequency.d.ts +18 -0
- package/dist/generated/broker/model/couponType.d.ts +16 -0
- package/dist/generated/broker/model/createACHRelationshipRequest.d.ts +39 -0
- package/dist/generated/broker/model/createACHRelationshipRequestBankAccountType.d.ts +16 -0
- package/dist/generated/broker/model/createBankRequest.d.ts +32 -0
- package/dist/generated/broker/model/createBankRequestBankCodeType.d.ts +15 -0
- package/dist/generated/broker/model/createCryptoTransferRequest.d.ts +17 -0
- package/dist/generated/broker/model/createCryptoTransferRequestChain.d.ts +18 -0
- package/dist/generated/broker/model/createFundingWalletRecipientBankBody.d.ts +38 -0
- package/dist/generated/broker/model/createFundingWalletRecipientBankBodyAccountType.d.ts +15 -0
- package/dist/generated/broker/model/createFundingWalletRecipientBankBodyRoutingCodeType.d.ts +22 -0
- package/dist/generated/broker/model/createFundingWalletWithdrawalRequest.d.ts +13 -0
- package/dist/generated/broker/model/createIFTransferRequest.d.ts +15 -0
- package/dist/generated/broker/model/createJITSettlementRequest.d.ts +20 -0
- package/dist/generated/broker/model/createJournalRequest.d.ts +69 -0
- package/dist/generated/broker/model/createOrderRequest.d.ts +78 -0
- package/dist/generated/broker/model/createOrderRequestStopLoss.d.ts +14 -0
- package/dist/generated/broker/model/createOrderRequestTakeProfit.d.ts +13 -0
- package/dist/generated/broker/model/createSettlementRequest.d.ts +16 -0
- package/dist/generated/broker/model/createTransferRequest.d.ts +45 -0
- package/dist/generated/broker/model/createTransferRequestTiming.d.ts +15 -0
- package/dist/generated/broker/model/createWatchlistRequest.d.ts +16 -0
- package/dist/generated/broker/model/createWhitelistedAddressBody.d.ts +16 -0
- package/dist/generated/broker/model/createWhitelistedAddressBodyChain.d.ts +18 -0
- package/dist/generated/broker/model/cryptoTransfer.d.ts +36 -0
- package/dist/generated/broker/model/cryptoTransferStatus.d.ts +13 -0
- package/dist/generated/broker/model/cryptoWallet.d.ts +13 -0
- package/dist/generated/broker/model/currency.d.ts +27 -0
- package/dist/generated/broker/model/custodialAccountMinorIdentity.d.ts +23 -0
- package/dist/generated/broker/model/custodialAccountType.d.ts +17 -0
- package/dist/generated/broker/model/dIVNRAActivityV2.d.ts +19 -0
- package/dist/generated/broker/model/dIVSPDActivityV2.d.ts +52 -0
- package/dist/generated/broker/model/dailyCashInterest.d.ts +19 -0
- package/dist/generated/broker/model/dailyTradingLimit.d.ts +13 -0
- package/dist/generated/broker/model/dayCount.d.ts +30 -0
- package/dist/generated/broker/model/demoFundingTransfer.d.ts +13 -0
- package/dist/generated/broker/model/directionParameter.d.ts +12 -0
- package/dist/generated/broker/model/disclosureContextAnnotation.d.ts +28 -0
- package/dist/generated/broker/model/disclosureContextAnnotationContextType.d.ts +16 -0
- package/dist/generated/broker/model/disclosures.d.ts +47 -0
- package/dist/generated/broker/model/disclosuresEmploymentSector.d.ts +32 -0
- package/dist/generated/broker/model/disclosuresEmploymentStatus.d.ts +17 -0
- package/dist/generated/broker/model/doNotExerciseRequest.d.ts +14 -0
- package/dist/generated/broker/model/doNotExerciseResponse.d.ts +15 -0
- package/dist/generated/broker/model/endParameter.d.ts +11 -0
- package/dist/generated/broker/model/eoDCashInterestReportResponse.d.ts +13 -0
- package/dist/generated/broker/model/error.d.ts +11 -0
- package/dist/generated/broker/model/exchange.d.ts +32 -0
- package/dist/generated/broker/model/exchangeOfferActivityV2.d.ts +10 -0
- package/dist/generated/broker/model/exerciseRequest.d.ts +18 -0
- package/dist/generated/broker/model/exerciseResponse.d.ts +17 -0
- package/dist/generated/broker/model/fEEActivityV2.d.ts +15 -0
- package/dist/generated/broker/model/fOPTActivityV2.d.ts +19 -0
- package/dist/generated/broker/model/fPSLAnalyticsLoansResponse.d.ts +20 -0
- package/dist/generated/broker/model/fPSLError.d.ts +13 -0
- package/dist/generated/broker/model/fPSLInterest.d.ts +19 -0
- package/dist/generated/broker/model/fPSLLoan.d.ts +34 -0
- package/dist/generated/broker/model/fPSLTier.d.ts +23 -0
- package/dist/generated/broker/model/feePaymentMethod.d.ts +15 -0
- package/dist/generated/broker/model/feePaymentType.d.ts +15 -0
- package/dist/generated/broker/model/feeType.d.ts +27 -0
- package/dist/generated/broker/model/fixedIncomeRedemptionActivityV2.d.ts +26 -0
- package/dist/generated/broker/model/forbiddenResponse.d.ts +11 -0
- package/dist/generated/broker/model/forwardSplitActivityV2.d.ts +30 -0
- package/dist/generated/broker/model/fundingDetail.d.ts +24 -0
- package/dist/generated/broker/model/fundingDetailPaymentType.d.ts +17 -0
- package/dist/generated/broker/model/fundingDetailRoutingCodeType.d.ts +23 -0
- package/dist/generated/broker/model/fundingWallet.d.ts +13 -0
- package/dist/generated/broker/model/fundingWalletRecipientBank.d.ts +40 -0
- package/dist/generated/broker/model/fundingWalletStatus.d.ts +19 -0
- package/dist/generated/broker/model/fundingWalletTransfer.d.ts +29 -0
- package/dist/generated/broker/model/fundingWalletTransferDirection.d.ts +17 -0
- package/dist/generated/broker/model/fundingWalletTransferStatus.d.ts +22 -0
- package/dist/generated/broker/model/getAccountACHRelationshipsParams.d.ts +13 -0
- package/dist/generated/broker/model/getAccountActivitiesByTypeParams.d.ts +40 -0
- package/dist/generated/broker/model/getAccountActivitiesCategory.d.ts +12 -0
- package/dist/generated/broker/model/getAccountActivitiesParams.d.ts +50 -0
- package/dist/generated/broker/model/getAllAccountsEntities.d.ts +17 -0
- package/dist/generated/broker/model/getAllAccountsParams.d.ts +35 -0
- package/dist/generated/broker/model/getAllJournalsEntryType.d.ts +12 -0
- package/dist/generated/broker/model/getAllJournalsParams.d.ts +39 -0
- package/dist/generated/broker/model/getAllJournalsStatus.d.ts +19 -0
- package/dist/generated/broker/model/getAllOrdersForAccountParams.d.ts +50 -0
- package/dist/generated/broker/model/getAllOrdersForAccountStatus.d.ts +13 -0
- package/dist/generated/broker/model/getAssetEntryRequirementsParams.d.ts +13 -0
- package/dist/generated/broker/model/getAssetsAssetClass.d.ts +12 -0
- package/dist/generated/broker/model/getAssetsAttributesItem.d.ts +18 -0
- package/dist/generated/broker/model/getAssetsParams.d.ts +34 -0
- package/dist/generated/broker/model/getAssetsStatus.d.ts +13 -0
- package/dist/generated/broker/model/getCorporateAnnouncementsDateType.d.ts +14 -0
- package/dist/generated/broker/model/getCorporateAnnouncementsParams.d.ts +41 -0
- package/dist/generated/broker/model/getCryptoTransferEstimate200.d.ts +10 -0
- package/dist/generated/broker/model/getCryptoTransferEstimateParams.d.ts +25 -0
- package/dist/generated/broker/model/getDocsForAccountParams.d.ts +22 -0
- package/dist/generated/broker/model/getOAuthClientParams.d.ts +22 -0
- package/dist/generated/broker/model/getOAuthClientResponseType.d.ts +12 -0
- package/dist/generated/broker/model/getOptionsContracts200.d.ts +13 -0
- package/dist/generated/broker/model/getOptionsContractsParams.d.ts +70 -0
- package/dist/generated/broker/model/getOptionsContractsStatus.d.ts +12 -0
- package/dist/generated/broker/model/getOptionsContractsStyle.d.ts +12 -0
- package/dist/generated/broker/model/getOptionsContractsType.d.ts +12 -0
- package/dist/generated/broker/model/getOrderByClientOrderIdForAccountParams.d.ts +13 -0
- package/dist/generated/broker/model/getRecipientBanksParams.d.ts +12 -0
- package/dist/generated/broker/model/getRecipientBanksStatus.d.ts +12 -0
- package/dist/generated/broker/model/getTokenizationRequestsBrokerParams.d.ts +41 -0
- package/dist/generated/broker/model/getTokenizationRequestsBrokerStatus.d.ts +13 -0
- package/dist/generated/broker/model/getTokenizationRequestsBrokerType.d.ts +12 -0
- package/dist/generated/broker/model/getTransfersForAccountDirection.d.ts +12 -0
- package/dist/generated/broker/model/getTransfersForAccountParams.d.ts +16 -0
- package/dist/generated/broker/model/getV1AccountsAccountIdOnfidoSdkTokens200.d.ts +10 -0
- package/dist/generated/broker/model/getV1AccountsAccountIdOnfidoSdkTokensParams.d.ts +17 -0
- package/dist/generated/broker/model/getV1AccountsPositions200.d.ts +12 -0
- package/dist/generated/broker/model/getV1AccountsPositions200Positions.d.ts +10 -0
- package/dist/generated/broker/model/getV1AccountsPositionsParams.d.ts +13 -0
- package/dist/generated/broker/model/getV1EventsNtaParams.d.ts +27 -0
- package/dist/generated/broker/model/getV1FpslAnalyticsAccountLoansParams.d.ts +17 -0
- package/dist/generated/broker/model/getV1GetEodCashInterestReportParams.d.ts +39 -0
- package/dist/generated/broker/model/getV1InstantFundingAccountLimitsParams.d.ts +13 -0
- package/dist/generated/broker/model/getV1InstantFundingListParams.d.ts +47 -0
- package/dist/generated/broker/model/getV1InstantFundingReportsParams.d.ts +17 -0
- package/dist/generated/broker/model/getV1InstantFundingSettlementsParams.d.ts +13 -0
- package/dist/generated/broker/model/getV1JitSettlementsParams.d.ts +13 -0
- package/dist/generated/broker/model/getV1ListFpslLoansParams.d.ts +31 -0
- package/dist/generated/broker/model/getV1RebalancingPortfoliosParams.d.ts +30 -0
- package/dist/generated/broker/model/getV1RebalancingPortfoliosStatus.d.ts +13 -0
- package/dist/generated/broker/model/getV1RebalancingRunsParams.d.ts +29 -0
- package/dist/generated/broker/model/getV1RebalancingSubscriptions200.d.ts +13 -0
- package/dist/generated/broker/model/getV1RebalancingSubscriptionsParams.d.ts +25 -0
- package/dist/generated/broker/model/getV1ReportingEodAggregatePositionsParams.d.ts +21 -0
- package/dist/generated/broker/model/getV1ReportingEodPositions200.d.ts +16 -0
- package/dist/generated/broker/model/getV1ReportingEodPositions200Positions.d.ts +14 -0
- package/dist/generated/broker/model/getV1ReportingEodPositionsParams.d.ts +31 -0
- package/dist/generated/broker/model/getV1TradingAccountsAccountIdAccountPortfolioHistoryIntradayReporting.d.ts +13 -0
- package/dist/generated/broker/model/getV1TradingAccountsAccountIdAccountPortfolioHistoryParams.d.ts +98 -0
- package/dist/generated/broker/model/getV1TradingAccountsAccountIdAccountPortfolioHistoryPnlReset.d.ts +12 -0
- package/dist/generated/broker/model/getV1TradingAccountsAccountIdOrdersEstimationBody.d.ts +18 -0
- package/dist/generated/broker/model/getV1TransfersJitLedgerIdBalances200.d.ts +23 -0
- package/dist/generated/broker/model/getV1TransfersJitLedgerIdBalancesParams.d.ts +17 -0
- package/dist/generated/broker/model/getV1TransfersJitReportsAssetClass.d.ts +12 -0
- package/dist/generated/broker/model/getV1TransfersJitReportsParams.d.ts +28 -0
- package/dist/generated/broker/model/getV1TransfersJitReportsReportType.d.ts +17 -0
- package/dist/generated/broker/model/getV1TransfersJitReportsResponseType.d.ts +12 -0
- package/dist/generated/broker/model/getV1beta1LogosSymbolParams.d.ts +13 -0
- package/dist/generated/broker/model/iFFee.d.ts +13 -0
- package/dist/generated/broker/model/iFFeeType.d.ts +17 -0
- package/dist/generated/broker/model/iPOEvent.d.ts +40 -0
- package/dist/generated/broker/model/iPOEventPayload.d.ts +13 -0
- package/dist/generated/broker/model/iPOEventVerb.d.ts +19 -0
- package/dist/generated/broker/model/iPOOffering.d.ts +60 -0
- package/dist/generated/broker/model/iPOOfferingAvailability.d.ts +21 -0
- package/dist/generated/broker/model/iPOOfferingListResponse.d.ts +20 -0
- package/dist/generated/broker/model/iPOOfferingResponse.d.ts +14 -0
- package/dist/generated/broker/model/identity.d.ts +88 -0
- package/dist/generated/broker/model/identityFundingSourceItem.d.ts +16 -0
- package/dist/generated/broker/model/identityInvestmentExperienceWithOptions.d.ts +16 -0
- package/dist/generated/broker/model/identityInvestmentExperienceWithStocks.d.ts +16 -0
- package/dist/generated/broker/model/identityInvestmentObjective.d.ts +19 -0
- package/dist/generated/broker/model/identityInvestmentTimeHorizon.d.ts +19 -0
- package/dist/generated/broker/model/identityLiquidityNeeds.d.ts +18 -0
- package/dist/generated/broker/model/identityMaritalStatus.d.ts +17 -0
- package/dist/generated/broker/model/identityRiskTolerance.d.ts +17 -0
- package/dist/generated/broker/model/index.d.ts +540 -0
- package/dist/generated/broker/model/instantFunding.d.ts +24 -0
- package/dist/generated/broker/model/instantFundingStatus.d.ts +23 -0
- package/dist/generated/broker/model/interest.d.ts +16 -0
- package/dist/generated/broker/model/issueOAuthTokenResponse.d.ts +16 -0
- package/dist/generated/broker/model/issueOAuthTokenResponseTokenType.d.ts +14 -0
- package/dist/generated/broker/model/jITAssetClass.d.ts +18 -0
- package/dist/generated/broker/model/jITLedgerAccount.d.ts +16 -0
- package/dist/generated/broker/model/jITReport.d.ts +42 -0
- package/dist/generated/broker/model/jITReportDownloadURL.d.ts +15 -0
- package/dist/generated/broker/model/jNLCActivityV2.d.ts +12 -0
- package/dist/generated/broker/model/jNLSActivityV2.d.ts +15 -0
- package/dist/generated/broker/model/jnlc.d.ts +31 -0
- package/dist/generated/broker/model/jnlcEntryType.d.ts +14 -0
- package/dist/generated/broker/model/jnls.d.ts +33 -0
- package/dist/generated/broker/model/jnlsEntryType.d.ts +14 -0
- package/dist/generated/broker/model/journal.d.ts +28 -0
- package/dist/generated/broker/model/journalEntryType.d.ts +25 -0
- package/dist/generated/broker/model/journalStatus.d.ts +43 -0
- package/dist/generated/broker/model/journalStatusEvent.d.ts +28 -0
- package/dist/generated/broker/model/journalStatusEventV2.d.ts +35 -0
- package/dist/generated/broker/model/journalStatusEventV2IdempotencyKeyType.d.ts +15 -0
- package/dist/generated/broker/model/kYCResultType.d.ts +41 -0
- package/dist/generated/broker/model/kYCResults.d.ts +20 -0
- package/dist/generated/broker/model/legacyCalendarDay.d.ts +24 -0
- package/dist/generated/broker/model/legacyCalendarParams.d.ts +24 -0
- package/dist/generated/broker/model/legacyClock.d.ts +17 -0
- package/dist/generated/broker/model/legacyDateTypeParameter.d.ts +12 -0
- package/dist/generated/broker/model/legacyEndParameter.d.ts +11 -0
- package/dist/generated/broker/model/legacyPublicCalendarResp.d.ts +9 -0
- package/dist/generated/broker/model/legacyStartParameter.d.ts +11 -0
- package/dist/generated/broker/model/listAPRTiersResponse.d.ts +15 -0
- package/dist/generated/broker/model/listCryptoFundingWalletsChain.d.ts +15 -0
- package/dist/generated/broker/model/listCryptoFundingWalletsNetwork.d.ts +12 -0
- package/dist/generated/broker/model/listCryptoFundingWalletsParams.d.ts +21 -0
- package/dist/generated/broker/model/listFPSLLoansResponse.d.ts +20 -0
- package/dist/generated/broker/model/listFundingDetails.d.ts +11 -0
- package/dist/generated/broker/model/listFundingDetailsParams.d.ts +18 -0
- package/dist/generated/broker/model/listIPOOfferingsAvailability.d.ts +13 -0
- package/dist/generated/broker/model/listIPOOfferingsParams.d.ts +31 -0
- package/dist/generated/broker/model/listSortBy.d.ts +13 -0
- package/dist/generated/broker/model/listTransfersResponse.d.ts +11 -0
- package/dist/generated/broker/model/mAActivityV2.d.ts +22 -0
- package/dist/generated/broker/model/mLegOrderLeg.d.ts +20 -0
- package/dist/generated/broker/model/market.d.ts +45 -0
- package/dist/generated/broker/model/marketAcronym.d.ts +11 -0
- package/dist/generated/broker/model/marketName.d.ts +11 -0
- package/dist/generated/broker/model/marketTimezone.d.ts +11 -0
- package/dist/generated/broker/model/marketsParameter.d.ts +51 -0
- package/dist/generated/broker/model/mic.d.ts +14 -0
- package/dist/generated/broker/model/n400Response.d.ts +11 -0
- package/dist/generated/broker/model/n401Response.d.ts +11 -0
- package/dist/generated/broker/model/n403Response.d.ts +11 -0
- package/dist/generated/broker/model/n429Response.d.ts +11 -0
- package/dist/generated/broker/model/n500Response.d.ts +11 -0
- package/dist/generated/broker/model/nCActivityV2.d.ts +16 -0
- package/dist/generated/broker/model/nextPageToken.d.ts +12 -0
- package/dist/generated/broker/model/nonTradeActivity.d.ts +34 -0
- package/dist/generated/broker/model/nonTradeActivityEvent.d.ts +45 -0
- package/dist/generated/broker/model/nonTradeActivityEventStatus.d.ts +16 -0
- package/dist/generated/broker/model/nonTradeActivityStatus.d.ts +16 -0
- package/dist/generated/broker/model/notAuthorizedResponse.d.ts +12 -0
- package/dist/generated/broker/model/notFoundResponse.d.ts +12 -0
- package/dist/generated/broker/model/oAuthTokenRequest.d.ts +22 -0
- package/dist/generated/broker/model/oPASNActivityV2.d.ts +12 -0
- package/dist/generated/broker/model/oPEXCActivityV2.d.ts +12 -0
- package/dist/generated/broker/model/oPEXPActivityV2.d.ts +12 -0
- package/dist/generated/broker/model/oPTRDActivityV2.d.ts +12 -0
- package/dist/generated/broker/model/oathClientResponse.d.ts +24 -0
- package/dist/generated/broker/model/oathClientResponseStatus.d.ts +15 -0
- package/dist/generated/broker/model/onfidoSDKOutcome.d.ts +14 -0
- package/dist/generated/broker/model/opcaCDIVActivityV2.d.ts +13 -0
- package/dist/generated/broker/model/opcaFSPLITActivityV2.d.ts +31 -0
- package/dist/generated/broker/model/opcaMAActivityV2.d.ts +13 -0
- package/dist/generated/broker/model/opcaNCActivityV2.d.ts +13 -0
- package/dist/generated/broker/model/opcaRSPLITActivityV2.d.ts +28 -0
- package/dist/generated/broker/model/opcaSDIVActivityV2.d.ts +13 -0
- package/dist/generated/broker/model/opcaSPINActivityV2.d.ts +13 -0
- package/dist/generated/broker/model/opcaUSPLITActivityV2.d.ts +29 -0
- package/dist/generated/broker/model/optionContract.d.ts +61 -0
- package/dist/generated/broker/model/optionContractStatus.d.ts +15 -0
- package/dist/generated/broker/model/optionContractStyle.d.ts +15 -0
- package/dist/generated/broker/model/optionContractType.d.ts +15 -0
- package/dist/generated/broker/model/optionDeliverable.d.ts +47 -0
- package/dist/generated/broker/model/optionDeliverableSettlementMethod.d.ts +21 -0
- package/dist/generated/broker/model/optionDeliverableSettlementType.d.ts +19 -0
- package/dist/generated/broker/model/optionDeliverableType.d.ts +15 -0
- package/dist/generated/broker/model/optionsApprovalEvent.d.ts +16 -0
- package/dist/generated/broker/model/optionsApprovalRequest.d.ts +12 -0
- package/dist/generated/broker/model/optionsApprovalRequestLevel.d.ts +16 -0
- package/dist/generated/broker/model/optionsApprovalResponse.d.ts +32 -0
- package/dist/generated/broker/model/optionsApprovalResponseApprovedLevel.d.ts +19 -0
- package/dist/generated/broker/model/optionsApprovalResponseRequestedLevel.d.ts +17 -0
- package/dist/generated/broker/model/optionsApprovalResponseRequester.d.ts +15 -0
- package/dist/generated/broker/model/optionsApprovalStatus.d.ts +21 -0
- package/dist/generated/broker/model/optionsApprovalsList.d.ts +17 -0
- package/dist/generated/broker/model/order.d.ts +147 -0
- package/dist/generated/broker/model/orderClass.d.ts +23 -0
- package/dist/generated/broker/model/orderClosedResponse.d.ts +18 -0
- package/dist/generated/broker/model/orderLeg.d.ts +142 -0
- package/dist/generated/broker/model/orderLegLegsItem.d.ts +10 -0
- package/dist/generated/broker/model/orderLegUsd.d.ts +13 -0
- package/dist/generated/broker/model/orderSide.d.ts +22 -0
- package/dist/generated/broker/model/orderStatus.d.ts +26 -0
- package/dist/generated/broker/model/orderType.d.ts +22 -0
- package/dist/generated/broker/model/orderUsd.d.ts +13 -0
- package/dist/generated/broker/model/overcontributedIRAAccount.d.ts +15 -0
- package/dist/generated/broker/model/ownerDocument.d.ts +19 -0
- package/dist/generated/broker/model/ownerDocumentType.d.ts +27 -0
- package/dist/generated/broker/model/ownerDocumentUploadRequest.d.ts +22 -0
- package/dist/generated/broker/model/pDTRemoval.d.ts +23 -0
- package/dist/generated/broker/model/pDTRemovalStatus.d.ts +15 -0
- package/dist/generated/broker/model/pDTStatus.d.ts +23 -0
- package/dist/generated/broker/model/pageTokenParameter.d.ts +11 -0
- package/dist/generated/broker/model/patchV1AccountsAccountIdOnfidoSdkBody.d.ts +15 -0
- package/dist/generated/broker/model/patchV1RebalancingPortfoliosPortfolioIdBody.d.ts +21 -0
- package/dist/generated/broker/model/phase.d.ts +15 -0
- package/dist/generated/broker/model/portfolio.d.ts +29 -0
- package/dist/generated/broker/model/portfolioHistory.d.ts +40 -0
- package/dist/generated/broker/model/portfolioHistoryCashflow.d.ts +13 -0
- package/dist/generated/broker/model/portfolioRun.d.ts +42 -0
- package/dist/generated/broker/model/portfolioRunInitiatedFrom.d.ts +15 -0
- package/dist/generated/broker/model/portfolioRunStatus.d.ts +30 -0
- package/dist/generated/broker/model/portfolioRunType.d.ts +15 -0
- package/dist/generated/broker/model/portfolioStatus.d.ts +16 -0
- package/dist/generated/broker/model/portfolioSubscription.d.ts +19 -0
- package/dist/generated/broker/model/portfolioWeights.d.ts +15 -0
- package/dist/generated/broker/model/position.d.ts +51 -0
- package/dist/generated/broker/model/positionClosedResponse.d.ts +20 -0
- package/dist/generated/broker/model/positionIntent.d.ts +17 -0
- package/dist/generated/broker/model/positionSide.d.ts +12 -0
- package/dist/generated/broker/model/postV1RebalancingPortfoliosBody.d.ts +21 -0
- package/dist/generated/broker/model/postV1RebalancingRunsBody.d.ts +15 -0
- package/dist/generated/broker/model/postV1RebalancingSubscriptionsBody.d.ts +13 -0
- package/dist/generated/broker/model/postV1TradingAccountsAccountIdWatchlistsWatchlistIdBody.d.ts +11 -0
- package/dist/generated/broker/model/publicCalendarResp.d.ts +17 -0
- package/dist/generated/broker/model/publicMarket.d.ts +22 -0
- package/dist/generated/broker/model/rebalancingConditions.d.ts +17 -0
- package/dist/generated/broker/model/reportsResponse.d.ts +16 -0
- package/dist/generated/broker/model/requestListOptionsApprovalsApprovedLevel.d.ts +14 -0
- package/dist/generated/broker/model/requestListOptionsApprovalsParams.d.ts +41 -0
- package/dist/generated/broker/model/requestListOptionsApprovalsRequestedLevel.d.ts +14 -0
- package/dist/generated/broker/model/restrictToLiquidationReasons.d.ts +23 -0
- package/dist/generated/broker/model/reverseBatchJournalRequest.d.ts +16 -0
- package/dist/generated/broker/model/reverseBatchJournalRequestEntriesItem.d.ts +15 -0
- package/dist/generated/broker/model/reverseBatchJournalRequestEntryType.d.ts +14 -0
- package/dist/generated/broker/model/reverseSplitActivityV2.d.ts +27 -0
- package/dist/generated/broker/model/rightsDistributionActivityV2.d.ts +44 -0
- package/dist/generated/broker/model/rightsSubscriptionElectionActivityV2.d.ts +10 -0
- package/dist/generated/broker/model/sDIVActivityV2.d.ts +20 -0
- package/dist/generated/broker/model/settlementAccount.d.ts +14 -0
- package/dist/generated/broker/model/settlementResponse.d.ts +29 -0
- package/dist/generated/broker/model/settlementStatus.d.ts +23 -0
- package/dist/generated/broker/model/settlementTransfer.d.ts +12 -0
- package/dist/generated/broker/model/settlementsResponse.d.ts +14 -0
- package/dist/generated/broker/model/skippedOrder.d.ts +24 -0
- package/dist/generated/broker/model/sortOrder.d.ts +12 -0
- package/dist/generated/broker/model/sortParameter.d.ts +12 -0
- package/dist/generated/broker/model/spOutlook.d.ts +19 -0
- package/dist/generated/broker/model/spinoffActivityV2.d.ts +18 -0
- package/dist/generated/broker/model/startParameter.d.ts +11 -0
- package/dist/generated/broker/model/statusFundingEvent.d.ts +112 -0
- package/dist/generated/broker/model/streetAddress.d.ts +8 -0
- package/dist/generated/broker/model/subscribeToActivitiesSSEParams.d.ts +19 -0
- package/dist/generated/broker/model/subscribeToAdminActionSSEParams.d.ts +19 -0
- package/dist/generated/broker/model/subscribeToFundingStatusSSEParams.d.ts +19 -0
- package/dist/generated/broker/model/subscribeToIPOEventsSSEParams.d.ts +25 -0
- package/dist/generated/broker/model/subscribeToJournalStatusSSEParams.d.ts +22 -0
- package/dist/generated/broker/model/subscribeToJournalStatusV2SSEParams.d.ts +20 -0
- package/dist/generated/broker/model/subscribeToSystemEventV2SSEParams.d.ts +19 -0
- package/dist/generated/broker/model/subscribeToTradeSSEParams.d.ts +21 -0
- package/dist/generated/broker/model/subscribeToTradeV2SSEParams.d.ts +19 -0
- package/dist/generated/broker/model/subscribeToTransferStatusSSEParams.d.ts +21 -0
- package/dist/generated/broker/model/suscribeToAccountStatusSSEParams.d.ts +22 -0
- package/dist/generated/broker/model/symbolsParameter.d.ts +11 -0
- package/dist/generated/broker/model/systemEventV2.d.ts +23 -0
- package/dist/generated/broker/model/systemEventV2Type.d.ts +15 -0
- package/dist/generated/broker/model/taxIdType.d.ts +194 -0
- package/dist/generated/broker/model/tenderOfferActivityV2.d.ts +10 -0
- package/dist/generated/broker/model/timeInForce.d.ts +41 -0
- package/dist/generated/broker/model/timeParameter.d.ts +11 -0
- package/dist/generated/broker/model/timezoneParameter.d.ts +11 -0
- package/dist/generated/broker/model/tokenizationIssuer.d.ts +15 -0
- package/dist/generated/broker/model/tokenizationMintCallback.d.ts +21 -0
- package/dist/generated/broker/model/tokenizationMintRequest.d.ts +19 -0
- package/dist/generated/broker/model/tokenizationMintResponse.d.ts +24 -0
- package/dist/generated/broker/model/tokenizationNetwork.d.ts +21 -0
- package/dist/generated/broker/model/tokenizationRedeemRequest.d.ts +27 -0
- package/dist/generated/broker/model/tokenizationRedeemResponse.d.ts +32 -0
- package/dist/generated/broker/model/tokenizationRequest.d.ts +49 -0
- package/dist/generated/broker/model/tokenizationRequestStatus.d.ts +16 -0
- package/dist/generated/broker/model/tokenizationRequestType.d.ts +15 -0
- package/dist/generated/broker/model/tradeAccount.d.ts +153 -0
- package/dist/generated/broker/model/tradeAccountOptionsApprovedLevel.d.ts +18 -0
- package/dist/generated/broker/model/tradeAccountOptionsTradingLevel.d.ts +19 -0
- package/dist/generated/broker/model/tradeActivity.d.ts +30 -0
- package/dist/generated/broker/model/tradeActivityType.d.ts +15 -0
- package/dist/generated/broker/model/tradeUpdateEvent.d.ts +45 -0
- package/dist/generated/broker/model/tradeUpdateEventType.d.ts +67 -0
- package/dist/generated/broker/model/tradeUpdateEventV2.d.ts +55 -0
- package/dist/generated/broker/model/tradeUpdateEventV2Leg.d.ts +27 -0
- package/dist/generated/broker/model/transaction.d.ts +27 -0
- package/dist/generated/broker/model/transfer.d.ts +65 -0
- package/dist/generated/broker/model/transferDirection.d.ts +18 -0
- package/dist/generated/broker/model/transferFee.d.ts +16 -0
- package/dist/generated/broker/model/transferIRA.d.ts +16 -0
- package/dist/generated/broker/model/transferIRADetails.d.ts +15 -0
- package/dist/generated/broker/model/transferIRATaxWithholding.d.ts +11 -0
- package/dist/generated/broker/model/transferStatus.d.ts +39 -0
- package/dist/generated/broker/model/transferStatusEvent.d.ts +34 -0
- package/dist/generated/broker/model/transferTiming.d.ts +20 -0
- package/dist/generated/broker/model/transferType.d.ts +18 -0
- package/dist/generated/broker/model/transmitterInfo.d.ts +26 -0
- package/dist/generated/broker/model/treasurySubtype.d.ts +19 -0
- package/dist/generated/broker/model/trustedContact.d.ts +48 -0
- package/dist/generated/broker/model/uSDAccountTradingLimit.d.ts +17 -0
- package/dist/generated/broker/model/uSDPosition.d.ts +32 -0
- package/dist/generated/broker/model/unitSplitActivityV2.d.ts +30 -0
- package/dist/generated/broker/model/untilParameter.d.ts +11 -0
- package/dist/generated/broker/model/updateOrderRequest.d.ts +46 -0
- package/dist/generated/broker/model/usCorporate.d.ts +136 -0
- package/dist/generated/broker/model/usCorporatesParams.d.ts +23 -0
- package/dist/generated/broker/model/usCorporatesResp.d.ts +11 -0
- package/dist/generated/broker/model/usTreasuriesParams.d.ts +21 -0
- package/dist/generated/broker/model/usTreasuriesResp.d.ts +11 -0
- package/dist/generated/broker/model/usTreasury.d.ts +60 -0
- package/dist/generated/broker/model/usd.d.ts +10 -0
- package/dist/generated/broker/model/w8benDocument.d.ts +55 -0
- package/dist/generated/broker/model/wRMActivityV2.d.ts +19 -0
- package/dist/generated/broker/model/warrantExerciseElectionActivityV2.d.ts +10 -0
- package/dist/generated/broker/model/watchlist.d.ts +28 -0
- package/dist/generated/broker/model/watchlistWithoutAsset.d.ts +25 -0
- package/dist/generated/broker/model/whitelistedAddress.d.ts +22 -0
- package/dist/generated/broker/model/whitelistedAddressStatus.d.ts +15 -0
- package/dist/generated/data/client.d.ts +1896 -0
- package/dist/generated/data/model/caId.d.ts +12 -0
- package/dist/generated/data/model/casCusipsParameter.d.ts +12 -0
- package/dist/generated/data/model/casEndParameter.d.ts +12 -0
- package/dist/generated/data/model/casIdsParameter.d.ts +12 -0
- package/dist/generated/data/model/casLimitParameter.d.ts +14 -0
- package/dist/generated/data/model/casRegionParameter.d.ts +10 -0
- package/dist/generated/data/model/casStartParameter.d.ts +12 -0
- package/dist/generated/data/model/casSymbolsParameter.d.ts +12 -0
- package/dist/generated/data/model/casTypesParameter.d.ts +29 -0
- package/dist/generated/data/model/cashDividend.d.ts +37 -0
- package/dist/generated/data/model/cashDividendSubType.d.ts +16 -0
- package/dist/generated/data/model/cashMerger.d.ts +31 -0
- package/dist/generated/data/model/corporateActions.d.ts +40 -0
- package/dist/generated/data/model/corporateActionsParams.d.ts +85 -0
- package/dist/generated/data/model/corporateActionsResp.d.ts +14 -0
- package/dist/generated/data/model/cryptoBar.d.ts +29 -0
- package/dist/generated/data/model/cryptoBarsParams.d.ts +58 -0
- package/dist/generated/data/model/cryptoBarsResp.d.ts +14 -0
- package/dist/generated/data/model/cryptoBarsRespBars.d.ts +12 -0
- package/dist/generated/data/model/cryptoHistoricalLoc.d.ts +19 -0
- package/dist/generated/data/model/cryptoLatestBarsParams.d.ts +15 -0
- package/dist/generated/data/model/cryptoLatestBarsResp.d.ts +12 -0
- package/dist/generated/data/model/cryptoLatestBarsRespBars.d.ts +12 -0
- package/dist/generated/data/model/cryptoLatestLoc.d.ts +19 -0
- package/dist/generated/data/model/cryptoLatestOrderbooksParams.d.ts +15 -0
- package/dist/generated/data/model/cryptoLatestOrderbooksResp.d.ts +12 -0
- package/dist/generated/data/model/cryptoLatestOrderbooksRespOrderbooks.d.ts +12 -0
- package/dist/generated/data/model/cryptoLatestQuotesParams.d.ts +15 -0
- package/dist/generated/data/model/cryptoLatestQuotesResp.d.ts +12 -0
- package/dist/generated/data/model/cryptoLatestQuotesRespQuotes.d.ts +12 -0
- package/dist/generated/data/model/cryptoLatestTradesParams.d.ts +15 -0
- package/dist/generated/data/model/cryptoLatestTradesResp.d.ts +12 -0
- package/dist/generated/data/model/cryptoLatestTradesRespTrades.d.ts +12 -0
- package/dist/generated/data/model/cryptoOrderbook.d.ts +18 -0
- package/dist/generated/data/model/cryptoOrderbookEntry.d.ts +17 -0
- package/dist/generated/data/model/cryptoPerpFuturesPricing.d.ts +25 -0
- package/dist/generated/data/model/cryptoPerpLatestBarsParams.d.ts +15 -0
- package/dist/generated/data/model/cryptoPerpLatestFuturesPricingParams.d.ts +15 -0
- package/dist/generated/data/model/cryptoPerpLatestFuturesPricingResp.d.ts +12 -0
- package/dist/generated/data/model/cryptoPerpLatestFuturesPricingRespPricing.d.ts +12 -0
- package/dist/generated/data/model/cryptoPerpLatestOrderbooksParams.d.ts +15 -0
- package/dist/generated/data/model/cryptoPerpLatestQuotesParams.d.ts +15 -0
- package/dist/generated/data/model/cryptoPerpLatestTradesParams.d.ts +15 -0
- package/dist/generated/data/model/cryptoPerpLoc.d.ts +15 -0
- package/dist/generated/data/model/cryptoPerpSymbolsParameter.d.ts +12 -0
- package/dist/generated/data/model/cryptoQuote.d.ts +23 -0
- package/dist/generated/data/model/cryptoQuotesParams.d.ts +47 -0
- package/dist/generated/data/model/cryptoQuotesResp.d.ts +14 -0
- package/dist/generated/data/model/cryptoQuotesRespQuotes.d.ts +12 -0
- package/dist/generated/data/model/cryptoSnapshot.d.ts +21 -0
- package/dist/generated/data/model/cryptoSnapshotsParams.d.ts +15 -0
- package/dist/generated/data/model/cryptoSnapshotsResp.d.ts +12 -0
- package/dist/generated/data/model/cryptoSnapshotsRespSnapshots.d.ts +12 -0
- package/dist/generated/data/model/cryptoSymbolsParameter.d.ts +12 -0
- package/dist/generated/data/model/cryptoTrade.d.ts +23 -0
- package/dist/generated/data/model/cryptoTradesParams.d.ts +47 -0
- package/dist/generated/data/model/cryptoTradesResp.d.ts +14 -0
- package/dist/generated/data/model/cryptoTradesRespTrades.d.ts +12 -0
- package/dist/generated/data/model/currency.d.ts +14 -0
- package/dist/generated/data/model/date.d.ts +12 -0
- package/dist/generated/data/model/dueBillRedemptionDate.d.ts +12 -0
- package/dist/generated/data/model/effectiveDate.d.ts +12 -0
- package/dist/generated/data/model/endParameter.d.ts +13 -0
- package/dist/generated/data/model/exDate.d.ts +12 -0
- package/dist/generated/data/model/expirationDate.d.ts +9 -0
- package/dist/generated/data/model/fixedIncomeLatestPricesParams.d.ts +15 -0
- package/dist/generated/data/model/fixedIncomeLatestPricesResp.d.ts +12 -0
- package/dist/generated/data/model/fixedIncomeLatestPricesRespPrices.d.ts +12 -0
- package/dist/generated/data/model/fixedIncomeLatestQuotesParams.d.ts +19 -0
- package/dist/generated/data/model/fixedIncomeLatestQuotesResp.d.ts +12 -0
- package/dist/generated/data/model/fixedIncomeLatestQuotesRespQuotes.d.ts +12 -0
- package/dist/generated/data/model/fixedIncomePrice.d.ts +21 -0
- package/dist/generated/data/model/fixedIncomeQuote.d.ts +35 -0
- package/dist/generated/data/model/forexCurrencyPairs.d.ts +12 -0
- package/dist/generated/data/model/forexCurrencyPairsParameter.d.ts +10 -0
- package/dist/generated/data/model/forexLatestRatesResp.d.ts +15 -0
- package/dist/generated/data/model/forexLatestRatesRespRates.d.ts +12 -0
- package/dist/generated/data/model/forexRate.d.ts +21 -0
- package/dist/generated/data/model/forexRatesResp.d.ts +14 -0
- package/dist/generated/data/model/forexRatesRespRates.d.ts +12 -0
- package/dist/generated/data/model/forexTimeframe.d.ts +16 -0
- package/dist/generated/data/model/forexTimeframeParameter.d.ts +10 -0
- package/dist/generated/data/model/forwardSplit.d.ts +33 -0
- package/dist/generated/data/model/index.d.ts +241 -0
- package/dist/generated/data/model/indexLatestValuesParams.d.ts +15 -0
- package/dist/generated/data/model/indexLatestValuesResp.d.ts +15 -0
- package/dist/generated/data/model/indexLatestValuesRespValues.d.ts +12 -0
- package/dist/generated/data/model/indexSymbolsParameter.d.ts +12 -0
- package/dist/generated/data/model/indexValue.d.ts +17 -0
- package/dist/generated/data/model/indexValuesParams.d.ts +47 -0
- package/dist/generated/data/model/indexValuesResp.d.ts +14 -0
- package/dist/generated/data/model/indexValuesRespValues.d.ts +12 -0
- package/dist/generated/data/model/isin.d.ts +13 -0
- package/dist/generated/data/model/isinsParameter.d.ts +12 -0
- package/dist/generated/data/model/latestRatesParams.d.ts +7 -0
- package/dist/generated/data/model/limitParameter.d.ts +15 -0
- package/dist/generated/data/model/logosParams.d.ts +14 -0
- package/dist/generated/data/model/marketType.d.ts +16 -0
- package/dist/generated/data/model/mostActive.d.ts +18 -0
- package/dist/generated/data/model/mostActivesByParameter.d.ts +13 -0
- package/dist/generated/data/model/mostActivesParams.d.ts +22 -0
- package/dist/generated/data/model/mostActivesResp.d.ts +15 -0
- package/dist/generated/data/model/mostActivesTopParameter.d.ts +12 -0
- package/dist/generated/data/model/mover.d.ts +21 -0
- package/dist/generated/data/model/moversParams.d.ts +17 -0
- package/dist/generated/data/model/moversResp.d.ts +22 -0
- package/dist/generated/data/model/moversTopParameter.d.ts +12 -0
- package/dist/generated/data/model/n400Response.d.ts +12 -0
- package/dist/generated/data/model/n401Response.d.ts +12 -0
- package/dist/generated/data/model/n403Response.d.ts +12 -0
- package/dist/generated/data/model/n429Response.d.ts +12 -0
- package/dist/generated/data/model/n500Response.d.ts +12 -0
- package/dist/generated/data/model/nameChange.d.ts +26 -0
- package/dist/generated/data/model/news.d.ts +54 -0
- package/dist/generated/data/model/newsImage.d.ts +24 -0
- package/dist/generated/data/model/newsImageSize.d.ts +18 -0
- package/dist/generated/data/model/newsParams.d.ts +50 -0
- package/dist/generated/data/model/newsResp.d.ts +14 -0
- package/dist/generated/data/model/newsSortParameter.d.ts +13 -0
- package/dist/generated/data/model/nextPageToken.d.ts +13 -0
- package/dist/generated/data/model/optionBar.d.ts +29 -0
- package/dist/generated/data/model/optionBarsParams.d.ts +58 -0
- package/dist/generated/data/model/optionBarsResp.d.ts +15 -0
- package/dist/generated/data/model/optionBarsRespBars.d.ts +12 -0
- package/dist/generated/data/model/optionChainParams.d.ts +64 -0
- package/dist/generated/data/model/optionChainType.d.ts +13 -0
- package/dist/generated/data/model/optionConditions.d.ts +11 -0
- package/dist/generated/data/model/optionExchanges.d.ts +11 -0
- package/dist/generated/data/model/optionFeed.d.ts +13 -0
- package/dist/generated/data/model/optionFeedParameter.d.ts +10 -0
- package/dist/generated/data/model/optionGreeks.d.ts +18 -0
- package/dist/generated/data/model/optionLatestQuotesParams.d.ts +12 -0
- package/dist/generated/data/model/optionLatestQuotesResp.d.ts +12 -0
- package/dist/generated/data/model/optionLatestQuotesRespQuotes.d.ts +12 -0
- package/dist/generated/data/model/optionLatestTradesParams.d.ts +12 -0
- package/dist/generated/data/model/optionLatestTradesResp.d.ts +12 -0
- package/dist/generated/data/model/optionLatestTradesRespTrades.d.ts +12 -0
- package/dist/generated/data/model/optionLimitParameter.d.ts +14 -0
- package/dist/generated/data/model/optionQuote.d.ts +29 -0
- package/dist/generated/data/model/optionSnapshot.d.ts +25 -0
- package/dist/generated/data/model/optionSnapshotsParams.d.ts +32 -0
- package/dist/generated/data/model/optionSnapshotsResp.d.ts +14 -0
- package/dist/generated/data/model/optionSnapshotsRespSnapshots.d.ts +12 -0
- package/dist/generated/data/model/optionSymbolsParameter.d.ts +12 -0
- package/dist/generated/data/model/optionTrade.d.ts +22 -0
- package/dist/generated/data/model/optionTradesParams.d.ts +47 -0
- package/dist/generated/data/model/optionTradesResp.d.ts +15 -0
- package/dist/generated/data/model/optionTradesRespTrades.d.ts +12 -0
- package/dist/generated/data/model/optionUpdatedSinceParameter.d.ts +13 -0
- package/dist/generated/data/model/pageTokenParameter.d.ts +12 -0
- package/dist/generated/data/model/partialCall.d.ts +34 -0
- package/dist/generated/data/model/partialCallLotteryType.d.ts +16 -0
- package/dist/generated/data/model/payableDate.d.ts +12 -0
- package/dist/generated/data/model/processDate.d.ts +12 -0
- package/dist/generated/data/model/ratesParams.d.ts +56 -0
- package/dist/generated/data/model/recordDate.d.ts +12 -0
- package/dist/generated/data/model/redemption.d.ts +26 -0
- package/dist/generated/data/model/region.d.ts +21 -0
- package/dist/generated/data/model/reorganization.d.ts +29 -0
- package/dist/generated/data/model/reorganizationStockMovement.d.ts +18 -0
- package/dist/generated/data/model/reverseSplit.d.ts +33 -0
- package/dist/generated/data/model/rightsDistribution.d.ts +35 -0
- package/dist/generated/data/model/sort.d.ts +16 -0
- package/dist/generated/data/model/sortParameter.d.ts +10 -0
- package/dist/generated/data/model/spinOff.d.ts +36 -0
- package/dist/generated/data/model/startParameter.d.ts +13 -0
- package/dist/generated/data/model/stockAdjustmentParameter.d.ts +20 -0
- package/dist/generated/data/model/stockAndCashMerger.d.ts +33 -0
- package/dist/generated/data/model/stockAsofParameter.d.ts +18 -0
- package/dist/generated/data/model/stockAuction.d.ts +23 -0
- package/dist/generated/data/model/stockAuctionFeed.d.ts +9 -0
- package/dist/generated/data/model/stockAuctionFeedParameter.d.ts +10 -0
- package/dist/generated/data/model/stockAuctionSingleParams.d.ts +63 -0
- package/dist/generated/data/model/stockAuctionsParams.d.ts +68 -0
- package/dist/generated/data/model/stockAuctionsResp.d.ts +15 -0
- package/dist/generated/data/model/stockAuctionsRespAuctions.d.ts +12 -0
- package/dist/generated/data/model/stockAuctionsRespSingle.d.ts +16 -0
- package/dist/generated/data/model/stockBar.d.ts +29 -0
- package/dist/generated/data/model/stockBarSingleParams.d.ts +91 -0
- package/dist/generated/data/model/stockBarsParams.d.ts +96 -0
- package/dist/generated/data/model/stockBarsResp.d.ts +15 -0
- package/dist/generated/data/model/stockBarsRespBars.d.ts +12 -0
- package/dist/generated/data/model/stockBarsRespSingle.d.ts +16 -0
- package/dist/generated/data/model/stockConditions.d.ts +11 -0
- package/dist/generated/data/model/stockCurrencyParameter.d.ts +12 -0
- package/dist/generated/data/model/stockDailyAuctions.d.ts +20 -0
- package/dist/generated/data/model/stockDividend.d.ts +30 -0
- package/dist/generated/data/model/stockExchanges.d.ts +11 -0
- package/dist/generated/data/model/stockHistoricalFeed.d.ts +15 -0
- package/dist/generated/data/model/stockHistoricalFeedParameter.d.ts +10 -0
- package/dist/generated/data/model/stockLatestBarSingleParams.d.ts +29 -0
- package/dist/generated/data/model/stockLatestBarsParams.d.ts +34 -0
- package/dist/generated/data/model/stockLatestBarsResp.d.ts +13 -0
- package/dist/generated/data/model/stockLatestBarsRespBars.d.ts +12 -0
- package/dist/generated/data/model/stockLatestBarsRespSingle.d.ts +14 -0
- package/dist/generated/data/model/stockLatestFeed.d.ts +17 -0
- package/dist/generated/data/model/stockLatestFeedParameter.d.ts +10 -0
- package/dist/generated/data/model/stockLatestQuoteSingleParams.d.ts +29 -0
- package/dist/generated/data/model/stockLatestQuotesParams.d.ts +34 -0
- package/dist/generated/data/model/stockLatestQuotesResp.d.ts +13 -0
- package/dist/generated/data/model/stockLatestQuotesRespQuotes.d.ts +12 -0
- package/dist/generated/data/model/stockLatestQuotesRespSingle.d.ts +14 -0
- package/dist/generated/data/model/stockLatestTradeSingleParams.d.ts +29 -0
- package/dist/generated/data/model/stockLatestTradesParams.d.ts +34 -0
- package/dist/generated/data/model/stockLatestTradesResp.d.ts +13 -0
- package/dist/generated/data/model/stockLatestTradesRespSingle.d.ts +14 -0
- package/dist/generated/data/model/stockLatestTradesRespTrades.d.ts +12 -0
- package/dist/generated/data/model/stockMerger.d.ts +32 -0
- package/dist/generated/data/model/stockMetaConditionsParams.d.ts +15 -0
- package/dist/generated/data/model/stockMetaConditionsTape.d.ts +14 -0
- package/dist/generated/data/model/stockQuote.d.ts +31 -0
- package/dist/generated/data/model/stockQuoteSingleParams.d.ts +67 -0
- package/dist/generated/data/model/stockQuotesParams.d.ts +72 -0
- package/dist/generated/data/model/stockQuotesResp.d.ts +15 -0
- package/dist/generated/data/model/stockQuotesRespQuotes.d.ts +12 -0
- package/dist/generated/data/model/stockQuotesRespSingle.d.ts +16 -0
- package/dist/generated/data/model/stockSnapshot.d.ts +21 -0
- package/dist/generated/data/model/stockSnapshotSingleParams.d.ts +29 -0
- package/dist/generated/data/model/stockSnapshotsParams.d.ts +34 -0
- package/dist/generated/data/model/stockSnapshotsResp.d.ts +12 -0
- package/dist/generated/data/model/stockSnapshotsRespSingle.d.ts +13 -0
- package/dist/generated/data/model/stockSymbolsParameter.d.ts +12 -0
- package/dist/generated/data/model/stockTape.d.ts +23 -0
- package/dist/generated/data/model/stockTrade.d.ts +34 -0
- package/dist/generated/data/model/stockTradeSingleParams.d.ts +67 -0
- package/dist/generated/data/model/stockTradesParams.d.ts +72 -0
- package/dist/generated/data/model/stockTradesResp.d.ts +15 -0
- package/dist/generated/data/model/stockTradesRespSingle.d.ts +16 -0
- package/dist/generated/data/model/stockTradesRespTrades.d.ts +12 -0
- package/dist/generated/data/model/timeframeParameter.d.ts +18 -0
- package/dist/generated/data/model/timestamp.d.ts +12 -0
- package/dist/generated/data/model/tradeSizeParameter.d.ts +12 -0
- package/dist/generated/data/model/unitSplit.d.ts +36 -0
- package/dist/generated/data/model/worthlessRemoval.d.ts +23 -0
- package/dist/generated/trading/client.d.ts +1186 -0
- package/dist/generated/trading/model/acatcActivityV2.d.ts +13 -0
- package/dist/generated/trading/model/acatsActivityV2.d.ts +16 -0
- package/dist/generated/trading/model/account.d.ts +102 -0
- package/dist/generated/trading/model/accountConfigurations.d.ts +40 -0
- package/dist/generated/trading/model/accountConfigurationsDtbpCheck.d.ts +17 -0
- package/dist/generated/trading/model/accountConfigurationsMaxOptionsTradingLevel.d.ts +17 -0
- package/dist/generated/trading/model/accountOptionsApprovedLevel.d.ts +18 -0
- package/dist/generated/trading/model/accountOptionsTradingLevel.d.ts +19 -0
- package/dist/generated/trading/model/accountStatus.d.ts +37 -0
- package/dist/generated/trading/model/activityEventV2.d.ts +16 -0
- package/dist/generated/trading/model/activityEventV2CommonFields.d.ts +51 -0
- package/dist/generated/trading/model/activitySubType.d.ts +80 -0
- package/dist/generated/trading/model/activityType.d.ts +167 -0
- package/dist/generated/trading/model/activityV2DetailNTA.d.ts +44 -0
- package/dist/generated/trading/model/activityV2DetailTRD.d.ts +36 -0
- package/dist/generated/trading/model/activityV2DetailTRDExecutionType.d.ts +16 -0
- package/dist/generated/trading/model/activityV2DetailTRDSide.d.ts +15 -0
- package/dist/generated/trading/model/addAssetToWatchlistBody.d.ts +11 -0
- package/dist/generated/trading/model/addAssetToWatchlistByNameBody.d.ts +11 -0
- package/dist/generated/trading/model/addAssetToWatchlistByNameParams.d.ts +13 -0
- package/dist/generated/trading/model/advancedInstructions.d.ts +26 -0
- package/dist/generated/trading/model/advancedInstructionsAlgorithm.d.ts +16 -0
- package/dist/generated/trading/model/advancedInstructionsDestination.d.ts +16 -0
- package/dist/generated/trading/model/assetClass.d.ts +17 -0
- package/dist/generated/trading/model/assets.d.ts +74 -0
- package/dist/generated/trading/model/assetsAttributesItem.d.ts +18 -0
- package/dist/generated/trading/model/assetsBorrowStatus.d.ts +15 -0
- package/dist/generated/trading/model/assetsStatus.d.ts +15 -0
- package/dist/generated/trading/model/bic.d.ts +14 -0
- package/dist/generated/trading/model/bondStatus.d.ts +16 -0
- package/dist/generated/trading/model/cDIVActivityV2.d.ts +18 -0
- package/dist/generated/trading/model/cSWActivityV2.d.ts +15 -0
- package/dist/generated/trading/model/calendarDay.d.ts +32 -0
- package/dist/generated/trading/model/calendarParams.d.ts +24 -0
- package/dist/generated/trading/model/callType.d.ts +17 -0
- package/dist/generated/trading/model/canceledOrderResponse.d.ts +16 -0
- package/dist/generated/trading/model/clock.d.ts +23 -0
- package/dist/generated/trading/model/clockParams.d.ts +59 -0
- package/dist/generated/trading/model/clockResp.d.ts +14 -0
- package/dist/generated/trading/model/commonAcatActivityV2.d.ts +18 -0
- package/dist/generated/trading/model/commonCDIVActivityV2.d.ts +44 -0
- package/dist/generated/trading/model/commonCaActivityV2.d.ts +19 -0
- package/dist/generated/trading/model/commonJournalActivityV2.d.ts +12 -0
- package/dist/generated/trading/model/commonMAActivityV2.d.ts +31 -0
- package/dist/generated/trading/model/commonNCActivityV2.d.ts +17 -0
- package/dist/generated/trading/model/commonNTAActivityV2.d.ts +16 -0
- package/dist/generated/trading/model/commonOPCAActivityV2.d.ts +20 -0
- package/dist/generated/trading/model/commonOptionsActivityV2.d.ts +9 -0
- package/dist/generated/trading/model/commonSDIVActivityV2.d.ts +30 -0
- package/dist/generated/trading/model/commonSpinoffActivityV2.d.ts +45 -0
- package/dist/generated/trading/model/commonSplitActivityV2.d.ts +22 -0
- package/dist/generated/trading/model/commonSplitStockActivityV2.d.ts +15 -0
- package/dist/generated/trading/model/commonVOFSubtypeActivityV2.d.ts +17 -0
- package/dist/generated/trading/model/couponFrequency.d.ts +18 -0
- package/dist/generated/trading/model/couponType.d.ts +16 -0
- package/dist/generated/trading/model/createCryptoTransferRequest.d.ts +18 -0
- package/dist/generated/trading/model/createCryptoTransferRequestChain.d.ts +18 -0
- package/dist/generated/trading/model/createWhitelistedAddressBody.d.ts +16 -0
- package/dist/generated/trading/model/createWhitelistedAddressBodyChain.d.ts +18 -0
- package/dist/generated/trading/model/createWhitelistedPerpAddressBody.d.ts +13 -0
- package/dist/generated/trading/model/cryptoTransfer.d.ts +36 -0
- package/dist/generated/trading/model/cryptoTransferStatus.d.ts +13 -0
- package/dist/generated/trading/model/cryptoWallet.d.ts +13 -0
- package/dist/generated/trading/model/dIVNRAActivityV2.d.ts +19 -0
- package/dist/generated/trading/model/dIVSPDActivityV2.d.ts +52 -0
- package/dist/generated/trading/model/dayCount.d.ts +30 -0
- package/dist/generated/trading/model/deleteAllOpenPositionsParams.d.ts +13 -0
- package/dist/generated/trading/model/deleteOpenPositionParams.d.ts +17 -0
- package/dist/generated/trading/model/deleteWatchlistByNameParams.d.ts +13 -0
- package/dist/generated/trading/model/endParameter.d.ts +11 -0
- package/dist/generated/trading/model/error.d.ts +11 -0
- package/dist/generated/trading/model/exchange.d.ts +28 -0
- package/dist/generated/trading/model/exchangeForPosition.d.ts +31 -0
- package/dist/generated/trading/model/exchangeOfferActivityV2.d.ts +10 -0
- package/dist/generated/trading/model/fEEActivityV2.d.ts +15 -0
- package/dist/generated/trading/model/fOPTActivityV2.d.ts +19 -0
- package/dist/generated/trading/model/fixedIncomeRedemptionActivityV2.d.ts +26 -0
- package/dist/generated/trading/model/forwardSplitActivityV2.d.ts +30 -0
- package/dist/generated/trading/model/getAccountActivitiesByActivityTypeDirection.d.ts +12 -0
- package/dist/generated/trading/model/getAccountActivitiesByActivityTypeParams.d.ts +36 -0
- package/dist/generated/trading/model/getAccountActivitiesCategory.d.ts +12 -0
- package/dist/generated/trading/model/getAccountActivitiesDirection.d.ts +12 -0
- package/dist/generated/trading/model/getAccountActivitiesParams.d.ts +46 -0
- package/dist/generated/trading/model/getAccountPortfolioHistoryIntradayReporting.d.ts +13 -0
- package/dist/generated/trading/model/getAccountPortfolioHistoryParams.d.ts +98 -0
- package/dist/generated/trading/model/getAccountPortfolioHistoryPnlReset.d.ts +12 -0
- package/dist/generated/trading/model/getAllOrdersAssetClassItem.d.ts +14 -0
- package/dist/generated/trading/model/getAllOrdersDirection.d.ts +12 -0
- package/dist/generated/trading/model/getAllOrdersParams.d.ts +58 -0
- package/dist/generated/trading/model/getAllOrdersStatus.d.ts +13 -0
- package/dist/generated/trading/model/getCryptoPerpAccountLeverage200.d.ts +12 -0
- package/dist/generated/trading/model/getCryptoPerpAccountLeverageParams.d.ts +13 -0
- package/dist/generated/trading/model/getCryptoPerpAccountVitals200.d.ts +17 -0
- package/dist/generated/trading/model/getCryptoPerpTransferEstimate200.d.ts +10 -0
- package/dist/generated/trading/model/getCryptoPerpTransferEstimateParams.d.ts +25 -0
- package/dist/generated/trading/model/getCryptoTransferEstimate200.d.ts +10 -0
- package/dist/generated/trading/model/getCryptoTransferEstimateParams.d.ts +25 -0
- package/dist/generated/trading/model/getOptionsContracts200.d.ts +13 -0
- package/dist/generated/trading/model/getOptionsContractsParams.d.ts +70 -0
- package/dist/generated/trading/model/getOptionsContractsStatus.d.ts +12 -0
- package/dist/generated/trading/model/getOptionsContractsStyle.d.ts +12 -0
- package/dist/generated/trading/model/getOptionsContractsType.d.ts +12 -0
- package/dist/generated/trading/model/getOrderByClientOrderIdParams.d.ts +13 -0
- package/dist/generated/trading/model/getOrderByOrderIDParams.d.ts +13 -0
- package/dist/generated/trading/model/getTokenizationRequestsIssuer.d.ts +11 -0
- package/dist/generated/trading/model/getTokenizationRequestsParams.d.ts +41 -0
- package/dist/generated/trading/model/getTokenizationRequestsStatus.d.ts +13 -0
- package/dist/generated/trading/model/getTokenizationRequestsType.d.ts +12 -0
- package/dist/generated/trading/model/getV2AssetsAttributesItem.d.ts +18 -0
- package/dist/generated/trading/model/getV2AssetsParams.d.ts +36 -0
- package/dist/generated/trading/model/getV2CorporateActionsAnnouncements200Item.d.ts +26 -0
- package/dist/generated/trading/model/getV2CorporateActionsAnnouncementsId200.d.ts +25 -0
- package/dist/generated/trading/model/getV2CorporateActionsAnnouncementsParams.d.ts +33 -0
- package/dist/generated/trading/model/getWatchlistByNameParams.d.ts +13 -0
- package/dist/generated/trading/model/index.d.ts +231 -0
- package/dist/generated/trading/model/jNLCActivityV2.d.ts +12 -0
- package/dist/generated/trading/model/jNLSActivityV2.d.ts +15 -0
- package/dist/generated/trading/model/legacyCalendarDay.d.ts +24 -0
- package/dist/generated/trading/model/legacyCalendarParams.d.ts +24 -0
- package/dist/generated/trading/model/legacyClock.d.ts +17 -0
- package/dist/generated/trading/model/legacyDateTypeParameter.d.ts +12 -0
- package/dist/generated/trading/model/legacyEndParameter.d.ts +11 -0
- package/dist/generated/trading/model/legacyPublicCalendarResp.d.ts +9 -0
- package/dist/generated/trading/model/legacyStartParameter.d.ts +11 -0
- package/dist/generated/trading/model/listCryptoFundingWalletsChain.d.ts +15 -0
- package/dist/generated/trading/model/listCryptoFundingWalletsNetwork.d.ts +12 -0
- package/dist/generated/trading/model/listCryptoFundingWalletsParams.d.ts +24 -0
- package/dist/generated/trading/model/listCryptoPerpFundingWalletsParams.d.ts +10 -0
- package/dist/generated/trading/model/mAActivityV2.d.ts +22 -0
- package/dist/generated/trading/model/mLegOrderLeg.d.ts +20 -0
- package/dist/generated/trading/model/market.d.ts +45 -0
- package/dist/generated/trading/model/marketAcronym.d.ts +11 -0
- package/dist/generated/trading/model/marketName.d.ts +11 -0
- package/dist/generated/trading/model/marketTimezone.d.ts +11 -0
- package/dist/generated/trading/model/marketsParameter.d.ts +51 -0
- package/dist/generated/trading/model/mic.d.ts +14 -0
- package/dist/generated/trading/model/n400Response.d.ts +11 -0
- package/dist/generated/trading/model/n401Response.d.ts +11 -0
- package/dist/generated/trading/model/n403Response.d.ts +11 -0
- package/dist/generated/trading/model/n429Response.d.ts +11 -0
- package/dist/generated/trading/model/n500Response.d.ts +11 -0
- package/dist/generated/trading/model/nCActivityV2.d.ts +16 -0
- package/dist/generated/trading/model/nextPageToken.d.ts +12 -0
- package/dist/generated/trading/model/nonTradeActivities.d.ts +34 -0
- package/dist/generated/trading/model/nonTradeActivitiesStatus.d.ts +16 -0
- package/dist/generated/trading/model/oPASNActivityV2.d.ts +12 -0
- package/dist/generated/trading/model/oPEXCActivityV2.d.ts +12 -0
- package/dist/generated/trading/model/oPEXPActivityV2.d.ts +12 -0
- package/dist/generated/trading/model/oPTRDActivityV2.d.ts +12 -0
- package/dist/generated/trading/model/opcaCDIVActivityV2.d.ts +13 -0
- package/dist/generated/trading/model/opcaFSPLITActivityV2.d.ts +31 -0
- package/dist/generated/trading/model/opcaMAActivityV2.d.ts +13 -0
- package/dist/generated/trading/model/opcaNCActivityV2.d.ts +13 -0
- package/dist/generated/trading/model/opcaRSPLITActivityV2.d.ts +28 -0
- package/dist/generated/trading/model/opcaSDIVActivityV2.d.ts +13 -0
- package/dist/generated/trading/model/opcaSPINActivityV2.d.ts +13 -0
- package/dist/generated/trading/model/opcaUSPLITActivityV2.d.ts +29 -0
- package/dist/generated/trading/model/optionContract.d.ts +61 -0
- package/dist/generated/trading/model/optionContractStatus.d.ts +15 -0
- package/dist/generated/trading/model/optionContractStyle.d.ts +15 -0
- package/dist/generated/trading/model/optionContractType.d.ts +15 -0
- package/dist/generated/trading/model/optionDeliverable.d.ts +47 -0
- package/dist/generated/trading/model/optionDeliverableSettlementMethod.d.ts +21 -0
- package/dist/generated/trading/model/optionDeliverableSettlementType.d.ts +19 -0
- package/dist/generated/trading/model/optionDeliverableType.d.ts +15 -0
- package/dist/generated/trading/model/order.d.ts +129 -0
- package/dist/generated/trading/model/orderClass.d.ts +24 -0
- package/dist/generated/trading/model/orderLeg.d.ts +125 -0
- package/dist/generated/trading/model/orderLegLegsItem.d.ts +10 -0
- package/dist/generated/trading/model/orderSide.d.ts +18 -0
- package/dist/generated/trading/model/orderStatus.d.ts +82 -0
- package/dist/generated/trading/model/orderType.d.ts +22 -0
- package/dist/generated/trading/model/pageTokenParameter.d.ts +11 -0
- package/dist/generated/trading/model/patchOrderRequest.d.ts +47 -0
- package/dist/generated/trading/model/phase.d.ts +15 -0
- package/dist/generated/trading/model/portfolioHistory.d.ts +40 -0
- package/dist/generated/trading/model/portfolioHistoryCashflow.d.ts +13 -0
- package/dist/generated/trading/model/position.d.ts +86 -0
- package/dist/generated/trading/model/positionClosedReponse.d.ts +18 -0
- package/dist/generated/trading/model/positionIntent.d.ts +17 -0
- package/dist/generated/trading/model/postOrderBody.d.ts +59 -0
- package/dist/generated/trading/model/postOrderBodyStopLoss.d.ts +14 -0
- package/dist/generated/trading/model/postOrderBodyTakeProfit.d.ts +13 -0
- package/dist/generated/trading/model/publicCalendarResp.d.ts +17 -0
- package/dist/generated/trading/model/publicMarket.d.ts +22 -0
- package/dist/generated/trading/model/reverseSplitActivityV2.d.ts +27 -0
- package/dist/generated/trading/model/rightsDistributionActivityV2.d.ts +44 -0
- package/dist/generated/trading/model/rightsSubscriptionElectionActivityV2.d.ts +10 -0
- package/dist/generated/trading/model/sDIVActivityV2.d.ts +20 -0
- package/dist/generated/trading/model/setCryptoPerpAccountLeverage200.d.ts +12 -0
- package/dist/generated/trading/model/setCryptoPerpAccountLeverageParams.d.ts +17 -0
- package/dist/generated/trading/model/spOutlook.d.ts +19 -0
- package/dist/generated/trading/model/spinoffActivityV2.d.ts +18 -0
- package/dist/generated/trading/model/startParameter.d.ts +11 -0
- package/dist/generated/trading/model/subscribeToActivitiesSSEParams.d.ts +19 -0
- package/dist/generated/trading/model/tenderOfferActivityV2.d.ts +10 -0
- package/dist/generated/trading/model/timeInForce.d.ts +41 -0
- package/dist/generated/trading/model/timeParameter.d.ts +11 -0
- package/dist/generated/trading/model/timezoneParameter.d.ts +11 -0
- package/dist/generated/trading/model/tokenizationIssuer.d.ts +15 -0
- package/dist/generated/trading/model/tokenizationMintRequest.d.ts +19 -0
- package/dist/generated/trading/model/tokenizationMintResponse.d.ts +24 -0
- package/dist/generated/trading/model/tokenizationNetwork.d.ts +21 -0
- package/dist/generated/trading/model/tokenizationRequest.d.ts +49 -0
- package/dist/generated/trading/model/tokenizationRequestStatus.d.ts +16 -0
- package/dist/generated/trading/model/tokenizationRequestType.d.ts +15 -0
- package/dist/generated/trading/model/tradingActivities.d.ts +34 -0
- package/dist/generated/trading/model/tradingActivitiesType.d.ts +15 -0
- package/dist/generated/trading/model/transferDirection.d.ts +12 -0
- package/dist/generated/trading/model/treasurySubtype.d.ts +19 -0
- package/dist/generated/trading/model/unitSplitActivityV2.d.ts +30 -0
- package/dist/generated/trading/model/updateWatchlistByNameParams.d.ts +13 -0
- package/dist/generated/trading/model/updateWatchlistRequest.d.ts +16 -0
- package/dist/generated/trading/model/usCorporate.d.ts +136 -0
- package/dist/generated/trading/model/usCorporatesParams.d.ts +23 -0
- package/dist/generated/trading/model/usCorporatesResp.d.ts +11 -0
- package/dist/generated/trading/model/usTreasuriesParams.d.ts +21 -0
- package/dist/generated/trading/model/usTreasuriesResp.d.ts +11 -0
- package/dist/generated/trading/model/usTreasury.d.ts +60 -0
- package/dist/generated/trading/model/wRMActivityV2.d.ts +19 -0
- package/dist/generated/trading/model/warrantExerciseElectionActivityV2.d.ts +10 -0
- package/dist/generated/trading/model/watchlist.d.ts +26 -0
- package/dist/generated/trading/model/watchlistWithoutAsset.d.ts +23 -0
- package/dist/generated/trading/model/whitelistedAddress.d.ts +22 -0
- package/dist/generated/trading/model/whitelistedAddressStatus.d.ts +15 -0
- package/dist/index.d.ts +22 -0
- package/dist/index.js +6329 -0
- package/dist/mutator.d.ts +18 -0
- package/package.json +47 -0
|
@@ -0,0 +1,3825 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v8.18.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Broker API
|
|
5
|
+
* Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
|
|
6
|
+
* OpenAPI spec version: 1.1.1
|
|
7
|
+
*/
|
|
8
|
+
import type { ACHRelationship, Account, AccountConfigurations, AccountCreationRequest, AccountDocument, AccountExtended, AccountLimit, AccountStatusEvent, AccountTradingLimit, AccountUpdateRequest, Activity, ActivityEventV2, AdminActionLegacyNote, AdminActionLiquidation, AdminActionTransactionCancel, AggregatePositionResponse, Announcement, Asset, AssetEntryRequirements, AuthorizeOAuthTokenResponse, BadRequestResponse, Bank, BatchCreateFundingWalletRequest, BatchCreateFundingWalletResponse, BatchJournalRequest, BatchJournalResponse, CIPInfo, CalendarParams, ClockParams, ClockResp, CloseAllPositionsForAccountParams, ClosePositionForAccountBySymbolParams, CorrespondentLimit, CountryInfos, CreateACHRelationshipRequest, CreateBankRequest, CreateCryptoTransferRequest, CreateFundingWalletRecipientBankBody, CreateFundingWalletWithdrawalRequest, CreateIFTransferRequest, CreateJITSettlementRequest, CreateJournalRequest, CreateOrderRequest, CreateSettlementRequest, CreateTransferRequest, CreateWatchlistRequest, CreateWhitelistedAddressBody, CryptoTransfer, CryptoWallet, DailyTradingLimit, DemoFundingTransfer, DoNotExerciseRequest, DoNotExerciseResponse, EoDCashInterestReportResponse, Error, ExerciseRequest, ExerciseResponse, FPSLAnalyticsLoansResponse, FPSLError, FPSLTier, ForbiddenResponse, FundingWallet, FundingWalletRecipientBank, FundingWalletTransfer, GetAccountACHRelationshipsParams, GetAccountActivitiesByTypeParams, GetAccountActivitiesParams, GetAllAccountsParams, GetAllJournalsParams, GetAllOrdersForAccountParams, GetAssetEntryRequirementsParams, GetAssetsParams, GetCorporateAnnouncementsParams, GetCryptoTransferEstimate200, GetCryptoTransferEstimateParams, GetDocsForAccountParams, GetOAuthClientParams, GetOptionsContracts200, GetOptionsContractsParams, GetOrderByClientOrderIdForAccountParams, GetRecipientBanksParams, GetTokenizationRequestsBrokerParams, GetTransfersForAccountParams, GetV1AccountsAccountIdOnfidoSdkTokens200, GetV1AccountsAccountIdOnfidoSdkTokensParams, GetV1AccountsPositions200, GetV1AccountsPositionsParams, GetV1EventsNtaParams, GetV1FpslAnalyticsAccountLoansParams, GetV1GetEodCashInterestReportParams, GetV1InstantFundingAccountLimitsParams, GetV1InstantFundingListParams, GetV1InstantFundingReportsParams, GetV1InstantFundingSettlementsParams, GetV1JitSettlementsParams, GetV1ListFpslLoansParams, GetV1RebalancingPortfoliosParams, GetV1RebalancingRunsParams, GetV1RebalancingSubscriptions200, GetV1RebalancingSubscriptionsParams, GetV1ReportingEodAggregatePositionsParams, GetV1ReportingEodPositions200, GetV1ReportingEodPositionsParams, GetV1TradingAccountsAccountIdAccountPortfolioHistoryParams, GetV1TradingAccountsAccountIdOrdersEstimationBody, GetV1TransfersJitLedgerIdBalances200, GetV1TransfersJitLedgerIdBalancesParams, GetV1TransfersJitReportsParams, GetV1beta1LogosSymbolParams, IPOEvent, IPOOfferingListResponse, IPOOfferingResponse, InstantFunding, IssueOAuthTokenResponse, JITLedgerAccount, JITReport, JITReportDownloadURL, Journal, JournalStatusEvent, JournalStatusEventV2, LegacyCalendarParams, LegacyClock, LegacyPublicCalendarResp, ListAPRTiersResponse, ListCryptoFundingWalletsParams, ListFPSLLoansResponse, ListFundingDetails, ListFundingDetailsParams, ListIPOOfferingsParams, ListTransfersResponse, N400Response, N401Response, N403Response, N429Response, N500Response, NonTradeActivityEvent, NotAuthorizedResponse, NotFoundResponse, OAuthTokenRequest, OathClientResponse, OptionContract, OptionsApprovalRequest, OptionsApprovalResponse, OptionsApprovalsList, Order, OrderClosedResponse, OvercontributedIRAAccount, OwnerDocumentUploadRequest, PDTRemoval, PDTStatus, PatchV1AccountsAccountIdOnfidoSdkBody, PatchV1RebalancingPortfoliosPortfolioIdBody, Portfolio, PortfolioHistory, PortfolioRun, PortfolioSubscription, Position, PositionClosedResponse, PostV1RebalancingPortfoliosBody, PostV1RebalancingRunsBody, PostV1RebalancingSubscriptionsBody, PostV1TradingAccountsAccountIdWatchlistsWatchlistIdBody, PublicCalendarResp, ReportsResponse, RequestListOptionsApprovalsParams, ReverseBatchJournalRequest, SettlementResponse, SettlementsResponse, StatusFundingEvent, SubscribeToActivitiesSSEParams, SubscribeToAdminActionSSEParams, SubscribeToFundingStatusSSEParams, SubscribeToIPOEventsSSEParams, SubscribeToJournalStatusSSEParams, SubscribeToJournalStatusV2SSEParams, SubscribeToSystemEventV2SSEParams, SubscribeToTradeSSEParams, SubscribeToTradeV2SSEParams, SubscribeToTransferStatusSSEParams, SuscribeToAccountStatusSSEParams, SystemEventV2, TokenizationMintCallback, TokenizationMintRequest, TokenizationMintResponse, TokenizationRedeemRequest, TokenizationRedeemResponse, TokenizationRequest, TradeAccount, TradeUpdateEvent, TradeUpdateEventV2, Transfer, TransferStatusEvent, UpdateOrderRequest, UsCorporatesParams, UsCorporatesResp, UsTreasuriesParams, UsTreasuriesResp, Watchlist, WatchlistWithoutAsset, WhitelistedAddress } from './model/index.js';
|
|
9
|
+
export type HTTPStatusCode1xx = 100 | 101 | 102 | 103;
|
|
10
|
+
export type HTTPStatusCode2xx = 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207;
|
|
11
|
+
export type HTTPStatusCode3xx = 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308;
|
|
12
|
+
export type HTTPStatusCode4xx = 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451;
|
|
13
|
+
export type HTTPStatusCode5xx = 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
14
|
+
export type HTTPStatusCodes = HTTPStatusCode1xx | HTTPStatusCode2xx | HTTPStatusCode3xx | HTTPStatusCode4xx | HTTPStatusCode5xx;
|
|
15
|
+
export type getFundingWalletResponse200 = {
|
|
16
|
+
data: FundingWallet;
|
|
17
|
+
status: 200;
|
|
18
|
+
};
|
|
19
|
+
export type getFundingWalletResponseDefault = {
|
|
20
|
+
data: Error;
|
|
21
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
22
|
+
};
|
|
23
|
+
export type getFundingWalletResponseSuccess = (getFundingWalletResponse200) & {
|
|
24
|
+
headers: Headers;
|
|
25
|
+
};
|
|
26
|
+
export type getFundingWalletResponseError = (getFundingWalletResponseDefault) & {
|
|
27
|
+
headers: Headers;
|
|
28
|
+
};
|
|
29
|
+
export type getFundingWalletResponse = (getFundingWalletResponseSuccess | getFundingWalletResponseError);
|
|
30
|
+
export declare const getGetFundingWalletUrl: (accountId: string) => string;
|
|
31
|
+
/**
|
|
32
|
+
* Returns the funding wallet for the specified account. Responds with 404 if the account has not been onboarded to funding wallets or a wallet has not been created.
|
|
33
|
+
* @summary Retrieve funding wallet
|
|
34
|
+
*/
|
|
35
|
+
export declare const getFundingWallet: (accountId: string, options?: RequestInit) => Promise<getFundingWalletResponse>;
|
|
36
|
+
export type createFundingWalletResponse200 = {
|
|
37
|
+
data: FundingWallet;
|
|
38
|
+
status: 200;
|
|
39
|
+
};
|
|
40
|
+
export type createFundingWalletResponseDefault = {
|
|
41
|
+
data: Error;
|
|
42
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
43
|
+
};
|
|
44
|
+
export type createFundingWalletResponseSuccess = (createFundingWalletResponse200) & {
|
|
45
|
+
headers: Headers;
|
|
46
|
+
};
|
|
47
|
+
export type createFundingWalletResponseError = (createFundingWalletResponseDefault) & {
|
|
48
|
+
headers: Headers;
|
|
49
|
+
};
|
|
50
|
+
export type createFundingWalletResponse = (createFundingWalletResponseSuccess | createFundingWalletResponseError);
|
|
51
|
+
export declare const getCreateFundingWalletUrl: (accountId: string) => string;
|
|
52
|
+
/**
|
|
53
|
+
* Creates a funding wallet for the specified account. The request is rejected if the account already has a funding wallet.
|
|
54
|
+
* @summary Creates a funding wallet
|
|
55
|
+
*/
|
|
56
|
+
export declare const createFundingWallet: (accountId: string, options?: RequestInit) => Promise<createFundingWalletResponse>;
|
|
57
|
+
export type listFundingDetailsResponse200 = {
|
|
58
|
+
data: ListFundingDetails[];
|
|
59
|
+
status: 200;
|
|
60
|
+
};
|
|
61
|
+
export type listFundingDetailsResponseDefault = {
|
|
62
|
+
data: Error;
|
|
63
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
64
|
+
};
|
|
65
|
+
export type listFundingDetailsResponseSuccess = (listFundingDetailsResponse200) & {
|
|
66
|
+
headers: Headers;
|
|
67
|
+
};
|
|
68
|
+
export type listFundingDetailsResponseError = (listFundingDetailsResponseDefault) & {
|
|
69
|
+
headers: Headers;
|
|
70
|
+
};
|
|
71
|
+
export type listFundingDetailsResponse = (listFundingDetailsResponseSuccess | listFundingDetailsResponseError);
|
|
72
|
+
export declare const getListFundingDetailsUrl: (accountId: string, params?: ListFundingDetailsParams) => string;
|
|
73
|
+
/**
|
|
74
|
+
* Returns a list of funding details if it exists. Query parameters must be passed to create a new funding details object if none exist.
|
|
75
|
+
* @summary Retrieve funding details
|
|
76
|
+
*/
|
|
77
|
+
export declare const listFundingDetails: (accountId: string, params?: ListFundingDetailsParams, options?: RequestInit) => Promise<listFundingDetailsResponse>;
|
|
78
|
+
export type deleteFundingWalletRecipientBankResponse200 = {
|
|
79
|
+
data: void;
|
|
80
|
+
status: 200;
|
|
81
|
+
};
|
|
82
|
+
export type deleteFundingWalletRecipientBankResponseDefault = {
|
|
83
|
+
data: Error;
|
|
84
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
85
|
+
};
|
|
86
|
+
export type deleteFundingWalletRecipientBankResponseSuccess = (deleteFundingWalletRecipientBankResponse200) & {
|
|
87
|
+
headers: Headers;
|
|
88
|
+
};
|
|
89
|
+
export type deleteFundingWalletRecipientBankResponseError = (deleteFundingWalletRecipientBankResponseDefault) & {
|
|
90
|
+
headers: Headers;
|
|
91
|
+
};
|
|
92
|
+
export type deleteFundingWalletRecipientBankResponse = (deleteFundingWalletRecipientBankResponseSuccess | deleteFundingWalletRecipientBankResponseError);
|
|
93
|
+
export declare const getDeleteFundingWalletRecipientBankUrl: (accountId: string) => string;
|
|
94
|
+
/**
|
|
95
|
+
* deletes a recipient bank.
|
|
96
|
+
* @summary Delete a recipient bank
|
|
97
|
+
*/
|
|
98
|
+
export declare const deleteFundingWalletRecipientBank: (accountId: string, options?: RequestInit) => Promise<deleteFundingWalletRecipientBankResponse>;
|
|
99
|
+
export type getFundingWalletRecipientBankResponse200 = {
|
|
100
|
+
data: void;
|
|
101
|
+
status: 200;
|
|
102
|
+
};
|
|
103
|
+
export type getFundingWalletRecipientBankResponseDefault = {
|
|
104
|
+
data: Error;
|
|
105
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
106
|
+
};
|
|
107
|
+
export type getFundingWalletRecipientBankResponseSuccess = (getFundingWalletRecipientBankResponse200) & {
|
|
108
|
+
headers: Headers;
|
|
109
|
+
};
|
|
110
|
+
export type getFundingWalletRecipientBankResponseError = (getFundingWalletRecipientBankResponseDefault) & {
|
|
111
|
+
headers: Headers;
|
|
112
|
+
};
|
|
113
|
+
export type getFundingWalletRecipientBankResponse = (getFundingWalletRecipientBankResponseSuccess | getFundingWalletRecipientBankResponseError);
|
|
114
|
+
export declare const getGetFundingWalletRecipientBankUrl: (accountId: string) => string;
|
|
115
|
+
/**
|
|
116
|
+
* Returns the recipient bank registered against the specified account's funding wallet. Responds with 404 if no recipient bank has been registered for the account.
|
|
117
|
+
* @summary Retrieve recipient bank
|
|
118
|
+
*/
|
|
119
|
+
export declare const getFundingWalletRecipientBank: (accountId: string, options?: RequestInit) => Promise<getFundingWalletRecipientBankResponse>;
|
|
120
|
+
export type createFundingWalletRecipientBankResponse200 = {
|
|
121
|
+
data: FundingWalletRecipientBank;
|
|
122
|
+
status: 200;
|
|
123
|
+
};
|
|
124
|
+
export type createFundingWalletRecipientBankResponseDefault = {
|
|
125
|
+
data: Error;
|
|
126
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
127
|
+
};
|
|
128
|
+
export type createFundingWalletRecipientBankResponseSuccess = (createFundingWalletRecipientBankResponse200) & {
|
|
129
|
+
headers: Headers;
|
|
130
|
+
};
|
|
131
|
+
export type createFundingWalletRecipientBankResponseError = (createFundingWalletRecipientBankResponseDefault) & {
|
|
132
|
+
headers: Headers;
|
|
133
|
+
};
|
|
134
|
+
export type createFundingWalletRecipientBankResponse = (createFundingWalletRecipientBankResponseSuccess | createFundingWalletRecipientBankResponseError);
|
|
135
|
+
export declare const getCreateFundingWalletRecipientBankUrl: (accountId: string) => string;
|
|
136
|
+
/**
|
|
137
|
+
* Creates a new recipient bank. Returns the new recipient bank entity on success. entity.
|
|
138
|
+
* @summary Create a recipient bank
|
|
139
|
+
*/
|
|
140
|
+
export declare const createFundingWalletRecipientBank: (accountId: string, createFundingWalletRecipientBankBody?: CreateFundingWalletRecipientBankBody, options?: RequestInit) => Promise<createFundingWalletRecipientBankResponse>;
|
|
141
|
+
export type getFundingWalletTransfersResponse200 = {
|
|
142
|
+
data: ListTransfersResponse;
|
|
143
|
+
status: 200;
|
|
144
|
+
};
|
|
145
|
+
export type getFundingWalletTransfersResponseDefault = {
|
|
146
|
+
data: Error;
|
|
147
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
148
|
+
};
|
|
149
|
+
export type getFundingWalletTransfersResponseSuccess = (getFundingWalletTransfersResponse200) & {
|
|
150
|
+
headers: Headers;
|
|
151
|
+
};
|
|
152
|
+
export type getFundingWalletTransfersResponseError = (getFundingWalletTransfersResponseDefault) & {
|
|
153
|
+
headers: Headers;
|
|
154
|
+
};
|
|
155
|
+
export type getFundingWalletTransfersResponse = (getFundingWalletTransfersResponseSuccess | getFundingWalletTransfersResponseError);
|
|
156
|
+
export declare const getGetFundingWalletTransfersUrl: (accountId: string) => string;
|
|
157
|
+
/**
|
|
158
|
+
* Returns all funding wallet transfers (deposits and withdrawals) associated with the specified account.
|
|
159
|
+
* @summary Retrieve funding wallet transfers
|
|
160
|
+
*/
|
|
161
|
+
export declare const getFundingWalletTransfers: (accountId: string, options?: RequestInit) => Promise<getFundingWalletTransfersResponse>;
|
|
162
|
+
export type getFundingWalletTransferByIDResponse200 = {
|
|
163
|
+
data: FundingWalletTransfer;
|
|
164
|
+
status: 200;
|
|
165
|
+
};
|
|
166
|
+
export type getFundingWalletTransferByIDResponse404 = {
|
|
167
|
+
data: void;
|
|
168
|
+
status: 404;
|
|
169
|
+
};
|
|
170
|
+
export type getFundingWalletTransferByIDResponseDefault = {
|
|
171
|
+
data: Error;
|
|
172
|
+
status: Exclude<HTTPStatusCodes, 200 | 404>;
|
|
173
|
+
};
|
|
174
|
+
export type getFundingWalletTransferByIDResponseSuccess = (getFundingWalletTransferByIDResponse200) & {
|
|
175
|
+
headers: Headers;
|
|
176
|
+
};
|
|
177
|
+
export type getFundingWalletTransferByIDResponseError = (getFundingWalletTransferByIDResponse404 | getFundingWalletTransferByIDResponseDefault) & {
|
|
178
|
+
headers: Headers;
|
|
179
|
+
};
|
|
180
|
+
export type getFundingWalletTransferByIDResponse = (getFundingWalletTransferByIDResponseSuccess | getFundingWalletTransferByIDResponseError);
|
|
181
|
+
export declare const getGetFundingWalletTransferByIDUrl: (accountId: string, transferId: string) => string;
|
|
182
|
+
/**
|
|
183
|
+
* Returns a single funding wallet transfer for the specified account by `transfer_id`. Responds with 404 if no matching transfer exists for the account.
|
|
184
|
+
* @summary Retrieve funding wallet transfer by ID
|
|
185
|
+
*/
|
|
186
|
+
export declare const getFundingWalletTransferByID: (accountId: string, transferId: string, options?: RequestInit) => Promise<getFundingWalletTransferByIDResponse>;
|
|
187
|
+
export type createFundingWalletWithdrawalResponse200 = {
|
|
188
|
+
data: FundingWalletTransfer;
|
|
189
|
+
status: 200;
|
|
190
|
+
};
|
|
191
|
+
export type createFundingWalletWithdrawalResponseDefault = {
|
|
192
|
+
data: Error;
|
|
193
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
194
|
+
};
|
|
195
|
+
export type createFundingWalletWithdrawalResponseSuccess = (createFundingWalletWithdrawalResponse200) & {
|
|
196
|
+
headers: Headers;
|
|
197
|
+
};
|
|
198
|
+
export type createFundingWalletWithdrawalResponseError = (createFundingWalletWithdrawalResponseDefault) & {
|
|
199
|
+
headers: Headers;
|
|
200
|
+
};
|
|
201
|
+
export type createFundingWalletWithdrawalResponse = (createFundingWalletWithdrawalResponseSuccess | createFundingWalletWithdrawalResponseError);
|
|
202
|
+
export declare const getCreateFundingWalletWithdrawalUrl: (accountId: string) => string;
|
|
203
|
+
/**
|
|
204
|
+
* Creates a withdrawal
|
|
205
|
+
* @summary Create a withdrawal
|
|
206
|
+
*/
|
|
207
|
+
export declare const createFundingWalletWithdrawal: (accountId: string, createFundingWalletWithdrawalRequest: CreateFundingWalletWithdrawalRequest, options?: RequestInit) => Promise<createFundingWalletWithdrawalResponse>;
|
|
208
|
+
export type batchCreateFundingWalletsResponse200 = {
|
|
209
|
+
data: BatchCreateFundingWalletResponse;
|
|
210
|
+
status: 200;
|
|
211
|
+
};
|
|
212
|
+
export type batchCreateFundingWalletsResponseDefault = {
|
|
213
|
+
data: Error;
|
|
214
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
215
|
+
};
|
|
216
|
+
export type batchCreateFundingWalletsResponseSuccess = (batchCreateFundingWalletsResponse200) & {
|
|
217
|
+
headers: Headers;
|
|
218
|
+
};
|
|
219
|
+
export type batchCreateFundingWalletsResponseError = (batchCreateFundingWalletsResponseDefault) & {
|
|
220
|
+
headers: Headers;
|
|
221
|
+
};
|
|
222
|
+
export type batchCreateFundingWalletsResponse = (batchCreateFundingWalletsResponseSuccess | batchCreateFundingWalletsResponseError);
|
|
223
|
+
export declare const getBatchCreateFundingWalletsUrl: () => string;
|
|
224
|
+
/**
|
|
225
|
+
* Creates funding wallets for a list of accounts in a single request. Every `account_id` in the request must belong to your firm, and the request is rejected if a funding wallet already exists for any of the supplied accounts.
|
|
226
|
+
* @summary Batch create funding wallets
|
|
227
|
+
*/
|
|
228
|
+
export declare const batchCreateFundingWallets: (batchCreateFundingWalletRequest: BatchCreateFundingWalletRequest, options?: RequestInit) => Promise<batchCreateFundingWalletsResponse>;
|
|
229
|
+
export type demoDepositFundingResponse200 = {
|
|
230
|
+
data: DemoFundingTransfer;
|
|
231
|
+
status: 200;
|
|
232
|
+
};
|
|
233
|
+
export type demoDepositFundingResponseDefault = {
|
|
234
|
+
data: Error;
|
|
235
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
236
|
+
};
|
|
237
|
+
export type demoDepositFundingResponseSuccess = (demoDepositFundingResponse200) & {
|
|
238
|
+
headers: Headers;
|
|
239
|
+
};
|
|
240
|
+
export type demoDepositFundingResponseError = (demoDepositFundingResponseDefault) & {
|
|
241
|
+
headers: Headers;
|
|
242
|
+
};
|
|
243
|
+
export type demoDepositFundingResponse = (demoDepositFundingResponseSuccess | demoDepositFundingResponseError);
|
|
244
|
+
export declare const getDemoDepositFundingUrl: () => string;
|
|
245
|
+
/**
|
|
246
|
+
* Simulates an inbound deposit into an account's funding wallet for end-to-end testing of the deposit flow.
|
|
247
|
+
*
|
|
248
|
+
* The transfer can only credit accounts that belong to your firm. Available in non-production (sandbox) environments only.
|
|
249
|
+
* @summary Create sandbox deposit transfer
|
|
250
|
+
*/
|
|
251
|
+
export declare const demoDepositFunding: (demoFundingTransfer: DemoFundingTransfer, options?: RequestInit) => Promise<demoDepositFundingResponse>;
|
|
252
|
+
export type getV1beta1LogosSymbolResponse200 = {
|
|
253
|
+
data: void;
|
|
254
|
+
status: 200;
|
|
255
|
+
};
|
|
256
|
+
export type getV1beta1LogosSymbolResponseSuccess = (getV1beta1LogosSymbolResponse200) & {
|
|
257
|
+
headers: Headers;
|
|
258
|
+
};
|
|
259
|
+
export type getV1beta1LogosSymbolResponse = (getV1beta1LogosSymbolResponseSuccess);
|
|
260
|
+
export declare const getGetV1beta1LogosSymbolUrl: (symbol: string, params?: GetV1beta1LogosSymbolParams) => string;
|
|
261
|
+
/**
|
|
262
|
+
* Alpaca's Logo API serves uniform logo images for select stock and crypto symbols.
|
|
263
|
+
*
|
|
264
|
+
* Note: For Logo API pricing details, reach out to sales@alpaca.markets
|
|
265
|
+
*
|
|
266
|
+
* The API response will return the raw image as a binary
|
|
267
|
+
* @summary Get Logo
|
|
268
|
+
*/
|
|
269
|
+
export declare const getV1beta1LogosSymbol: (symbol: string, params?: GetV1beta1LogosSymbolParams, options?: RequestInit) => Promise<getV1beta1LogosSymbolResponse>;
|
|
270
|
+
export type getAllAccountsResponse200 = {
|
|
271
|
+
data: AccountExtended[];
|
|
272
|
+
status: 200;
|
|
273
|
+
};
|
|
274
|
+
export type getAllAccountsResponseSuccess = (getAllAccountsResponse200) & {
|
|
275
|
+
headers: Headers;
|
|
276
|
+
};
|
|
277
|
+
export type getAllAccountsResponse = (getAllAccountsResponseSuccess);
|
|
278
|
+
export declare const getGetAllAccountsUrl: (params?: GetAllAccountsParams) => string;
|
|
279
|
+
/**
|
|
280
|
+
* Retrieves the first 1000 accounts that match the query parameters.
|
|
281
|
+
* Sorting is based on creation time.
|
|
282
|
+
* The created_after/created_before query parameters can be used to paginate the results.
|
|
283
|
+
* To further limit the size of the response, the entities query parameter can be used to specify which properties are included in the response.
|
|
284
|
+
* @summary Get All Accounts
|
|
285
|
+
*/
|
|
286
|
+
export declare const getAllAccounts: (params?: GetAllAccountsParams, options?: RequestInit) => Promise<getAllAccountsResponse>;
|
|
287
|
+
export type createAccountResponse200 = {
|
|
288
|
+
data: Account;
|
|
289
|
+
status: 200;
|
|
290
|
+
};
|
|
291
|
+
export type createAccountResponse400 = {
|
|
292
|
+
data: string;
|
|
293
|
+
status: 400;
|
|
294
|
+
};
|
|
295
|
+
export type createAccountResponse409 = {
|
|
296
|
+
data: void;
|
|
297
|
+
status: 409;
|
|
298
|
+
};
|
|
299
|
+
export type createAccountResponse422 = {
|
|
300
|
+
data: string;
|
|
301
|
+
status: 422;
|
|
302
|
+
};
|
|
303
|
+
export type createAccountResponseSuccess = (createAccountResponse200) & {
|
|
304
|
+
headers: Headers;
|
|
305
|
+
};
|
|
306
|
+
export type createAccountResponseError = (createAccountResponse400 | createAccountResponse409 | createAccountResponse422) & {
|
|
307
|
+
headers: Headers;
|
|
308
|
+
};
|
|
309
|
+
export type createAccountResponse = (createAccountResponseSuccess | createAccountResponseError);
|
|
310
|
+
export declare const getCreateAccountUrl: () => string;
|
|
311
|
+
/**
|
|
312
|
+
* Submit an account application with KYC information. This will create a trading account for the end user. The account status may or may not be ACTIVE immediately and you will receive account status updates on the event API.
|
|
313
|
+
*
|
|
314
|
+
* **Multi-Live Accounts (MLA)**: To open an additional account for an existing account holder, supply `primary_account_holder_id` at the top level instead of `contact`/`identity` data. In that case, supplying `contact` or `identity` returns HTTP 400. Only `account_type` of `trading` and `ira` are supported via this flow.
|
|
315
|
+
* @summary Create an Account
|
|
316
|
+
*/
|
|
317
|
+
export declare const createAccount: (accountCreationRequest: AccountCreationRequest, options?: RequestInit) => Promise<createAccountResponse>;
|
|
318
|
+
export type getAccountResponse200 = {
|
|
319
|
+
data: AccountExtended;
|
|
320
|
+
status: 200;
|
|
321
|
+
};
|
|
322
|
+
export type getAccountResponseSuccess = (getAccountResponse200) & {
|
|
323
|
+
headers: Headers;
|
|
324
|
+
};
|
|
325
|
+
export type getAccountResponse = (getAccountResponseSuccess);
|
|
326
|
+
export declare const getGetAccountUrl: (accountId: string) => string;
|
|
327
|
+
/**
|
|
328
|
+
* You can query a specific account that you submitted to Alpaca by passing into the query the account_id associated with the account you're retrieving.
|
|
329
|
+
* @summary Get An Account by ID
|
|
330
|
+
*/
|
|
331
|
+
export declare const getAccount: (accountId: string, options?: RequestInit) => Promise<getAccountResponse>;
|
|
332
|
+
export type patchAccountResponse200 = {
|
|
333
|
+
data: AccountExtended;
|
|
334
|
+
status: 200;
|
|
335
|
+
};
|
|
336
|
+
export type patchAccountResponse400 = {
|
|
337
|
+
data: string;
|
|
338
|
+
status: 400;
|
|
339
|
+
};
|
|
340
|
+
export type patchAccountResponse422 = {
|
|
341
|
+
data: string;
|
|
342
|
+
status: 422;
|
|
343
|
+
};
|
|
344
|
+
export type patchAccountResponseSuccess = (patchAccountResponse200) & {
|
|
345
|
+
headers: Headers;
|
|
346
|
+
};
|
|
347
|
+
export type patchAccountResponseError = (patchAccountResponse400 | patchAccountResponse422) & {
|
|
348
|
+
headers: Headers;
|
|
349
|
+
};
|
|
350
|
+
export type patchAccountResponse = (patchAccountResponseSuccess | patchAccountResponseError);
|
|
351
|
+
export declare const getPatchAccountUrl: (accountId: string) => string;
|
|
352
|
+
/**
|
|
353
|
+
* This operation updates account information.
|
|
354
|
+
*
|
|
355
|
+
* If all parameters are valid and updates have been made, it returns with status code 200. The response is the account model.
|
|
356
|
+
*
|
|
357
|
+
* **Multi-Live Accounts (MLA)**: The `primary_account_holder_id` field is read-only after the account is created. Omitting it or supplying the value already associated with the account is a no-op; supplying a different value returns HTTP 400.
|
|
358
|
+
* @summary Update an Account
|
|
359
|
+
*/
|
|
360
|
+
export declare const patchAccount: (accountId: string, accountUpdateRequest: AccountUpdateRequest, options?: RequestInit) => Promise<patchAccountResponse>;
|
|
361
|
+
export type getAccountACHRelationshipsResponse200 = {
|
|
362
|
+
data: ACHRelationship[];
|
|
363
|
+
status: 200;
|
|
364
|
+
};
|
|
365
|
+
export type getAccountACHRelationshipsResponseSuccess = (getAccountACHRelationshipsResponse200) & {
|
|
366
|
+
headers: Headers;
|
|
367
|
+
};
|
|
368
|
+
export type getAccountACHRelationshipsResponse = (getAccountACHRelationshipsResponseSuccess);
|
|
369
|
+
export declare const getGetAccountACHRelationshipsUrl: (accountId: string, params?: GetAccountACHRelationshipsParams) => string;
|
|
370
|
+
/**
|
|
371
|
+
* Returns a list of ACH Relationships for an account
|
|
372
|
+
* @summary Retrieve ACH Relationships for an account
|
|
373
|
+
*/
|
|
374
|
+
export declare const getAccountACHRelationships: (accountId: string, params?: GetAccountACHRelationshipsParams, options?: RequestInit) => Promise<getAccountACHRelationshipsResponse>;
|
|
375
|
+
export type createACHRelationshipForAccountResponse200 = {
|
|
376
|
+
data: ACHRelationship;
|
|
377
|
+
status: 200;
|
|
378
|
+
};
|
|
379
|
+
export type createACHRelationshipForAccountResponse400 = {
|
|
380
|
+
data: BadRequestResponse;
|
|
381
|
+
status: 400;
|
|
382
|
+
};
|
|
383
|
+
export type createACHRelationshipForAccountResponse401 = {
|
|
384
|
+
data: NotAuthorizedResponse;
|
|
385
|
+
status: 401;
|
|
386
|
+
};
|
|
387
|
+
export type createACHRelationshipForAccountResponse409 = {
|
|
388
|
+
data: Error;
|
|
389
|
+
status: 409;
|
|
390
|
+
};
|
|
391
|
+
export type createACHRelationshipForAccountResponseSuccess = (createACHRelationshipForAccountResponse200) & {
|
|
392
|
+
headers: Headers;
|
|
393
|
+
};
|
|
394
|
+
export type createACHRelationshipForAccountResponseError = (createACHRelationshipForAccountResponse400 | createACHRelationshipForAccountResponse401 | createACHRelationshipForAccountResponse409) & {
|
|
395
|
+
headers: Headers;
|
|
396
|
+
};
|
|
397
|
+
export type createACHRelationshipForAccountResponse = (createACHRelationshipForAccountResponseSuccess | createACHRelationshipForAccountResponseError);
|
|
398
|
+
export declare const getCreateACHRelationshipForAccountUrl: (accountId: string) => string;
|
|
399
|
+
/**
|
|
400
|
+
* Create a new ACHRelationship for an account
|
|
401
|
+
*
|
|
402
|
+
* If successful, will return 200 code with a newly created ACH Relationship entity.
|
|
403
|
+
* @summary Create an ACH Relationship
|
|
404
|
+
*/
|
|
405
|
+
export declare const createACHRelationshipForAccount: (accountId: string, createACHRelationshipRequest: CreateACHRelationshipRequest, options?: RequestInit) => Promise<createACHRelationshipForAccountResponse>;
|
|
406
|
+
export type deleteACHRelationshipFromAccountResponse204 = {
|
|
407
|
+
data: void;
|
|
408
|
+
status: 204;
|
|
409
|
+
};
|
|
410
|
+
export type deleteACHRelationshipFromAccountResponse400 = {
|
|
411
|
+
data: void;
|
|
412
|
+
status: 400;
|
|
413
|
+
};
|
|
414
|
+
export type deleteACHRelationshipFromAccountResponse404 = {
|
|
415
|
+
data: void;
|
|
416
|
+
status: 404;
|
|
417
|
+
};
|
|
418
|
+
export type deleteACHRelationshipFromAccountResponseSuccess = (deleteACHRelationshipFromAccountResponse204) & {
|
|
419
|
+
headers: Headers;
|
|
420
|
+
};
|
|
421
|
+
export type deleteACHRelationshipFromAccountResponseError = (deleteACHRelationshipFromAccountResponse400 | deleteACHRelationshipFromAccountResponse404) & {
|
|
422
|
+
headers: Headers;
|
|
423
|
+
};
|
|
424
|
+
export type deleteACHRelationshipFromAccountResponse = (deleteACHRelationshipFromAccountResponseSuccess | deleteACHRelationshipFromAccountResponseError);
|
|
425
|
+
export declare const getDeleteACHRelationshipFromAccountUrl: (accountId: string, achRelationshipId: string) => string;
|
|
426
|
+
/**
|
|
427
|
+
* Delete an existing ACH relationship for an account
|
|
428
|
+
* @summary Delete an existing ACH relationship
|
|
429
|
+
*/
|
|
430
|
+
export declare const deleteACHRelationshipFromAccount: (accountId: string, achRelationshipId: string, options?: RequestInit) => Promise<deleteACHRelationshipFromAccountResponse>;
|
|
431
|
+
export type postV1AccountsAccountIdActionsCloseResponse204 = {
|
|
432
|
+
data: void;
|
|
433
|
+
status: 204;
|
|
434
|
+
};
|
|
435
|
+
export type postV1AccountsAccountIdActionsCloseResponse404 = {
|
|
436
|
+
data: void;
|
|
437
|
+
status: 404;
|
|
438
|
+
};
|
|
439
|
+
export type postV1AccountsAccountIdActionsCloseResponseSuccess = (postV1AccountsAccountIdActionsCloseResponse204) & {
|
|
440
|
+
headers: Headers;
|
|
441
|
+
};
|
|
442
|
+
export type postV1AccountsAccountIdActionsCloseResponseError = (postV1AccountsAccountIdActionsCloseResponse404) & {
|
|
443
|
+
headers: Headers;
|
|
444
|
+
};
|
|
445
|
+
export type postV1AccountsAccountIdActionsCloseResponse = (postV1AccountsAccountIdActionsCloseResponseSuccess | postV1AccountsAccountIdActionsCloseResponseError);
|
|
446
|
+
export declare const getPostV1AccountsAccountIdActionsCloseUrl: (accountId: string) => string;
|
|
447
|
+
/**
|
|
448
|
+
* This operation closes an active account. The underlying records and information of the account are not deleted by this operation.
|
|
449
|
+
*
|
|
450
|
+
* **Before closing an account, you are responsible for closing all the positions and withdrawing all the money associated with that account. Learn more in the Positions Documentation.**
|
|
451
|
+
* @summary Close an Account
|
|
452
|
+
*/
|
|
453
|
+
export declare const postV1AccountsAccountIdActionsClose: (accountId: string, options?: RequestInit) => Promise<postV1AccountsAccountIdActionsCloseResponse>;
|
|
454
|
+
export type getV1AccountsAccountIdCipResponse200 = {
|
|
455
|
+
data: CIPInfo;
|
|
456
|
+
status: 200;
|
|
457
|
+
};
|
|
458
|
+
export type getV1AccountsAccountIdCipResponseSuccess = (getV1AccountsAccountIdCipResponse200) & {
|
|
459
|
+
headers: Headers;
|
|
460
|
+
};
|
|
461
|
+
export type getV1AccountsAccountIdCipResponse = (getV1AccountsAccountIdCipResponseSuccess);
|
|
462
|
+
export declare const getGetV1AccountsAccountIdCipUrl: (accountId: string) => string;
|
|
463
|
+
/**
|
|
464
|
+
* You can retrieve the CIP information you've submitted for a given account.
|
|
465
|
+
* @summary Retrieve CIP information
|
|
466
|
+
*/
|
|
467
|
+
export declare const getV1AccountsAccountIdCip: (accountId: string, options?: RequestInit) => Promise<getV1AccountsAccountIdCipResponse>;
|
|
468
|
+
export type postV1AccountsAccountIdCipResponse200 = {
|
|
469
|
+
data: void;
|
|
470
|
+
status: 200;
|
|
471
|
+
};
|
|
472
|
+
export type postV1AccountsAccountIdCipResponseSuccess = (postV1AccountsAccountIdCipResponse200) & {
|
|
473
|
+
headers: Headers;
|
|
474
|
+
};
|
|
475
|
+
export type postV1AccountsAccountIdCipResponse = (postV1AccountsAccountIdCipResponseSuccess);
|
|
476
|
+
export declare const getPostV1AccountsAccountIdCipUrl: (accountId: string) => string;
|
|
477
|
+
/**
|
|
478
|
+
* The customer identification program (CIP) API allows you to submit the CIP results received from your KYC provider.
|
|
479
|
+
*
|
|
480
|
+
* The minimum requirements to open an individual financial account are delimited and you must verify the true identity of the account holder at account opening:
|
|
481
|
+
*
|
|
482
|
+
* Name
|
|
483
|
+
* Date of birth
|
|
484
|
+
* Address
|
|
485
|
+
* Identification number (for a U.S. citizen, a taxpayer identification number)
|
|
486
|
+
* @summary Upload CIP information
|
|
487
|
+
*/
|
|
488
|
+
export declare const postV1AccountsAccountIdCip: (accountId: string, cIPInfo?: CIPInfo, options?: RequestInit) => Promise<postV1AccountsAccountIdCipResponse>;
|
|
489
|
+
export type getDocsForAccountResponse200 = {
|
|
490
|
+
data: AccountDocument[];
|
|
491
|
+
status: 200;
|
|
492
|
+
};
|
|
493
|
+
export type getDocsForAccountResponse404 = {
|
|
494
|
+
data: string;
|
|
495
|
+
status: 404;
|
|
496
|
+
};
|
|
497
|
+
export type getDocsForAccountResponseSuccess = (getDocsForAccountResponse200) & {
|
|
498
|
+
headers: Headers;
|
|
499
|
+
};
|
|
500
|
+
export type getDocsForAccountResponseError = (getDocsForAccountResponse404) & {
|
|
501
|
+
headers: Headers;
|
|
502
|
+
};
|
|
503
|
+
export type getDocsForAccountResponse = (getDocsForAccountResponseSuccess | getDocsForAccountResponseError);
|
|
504
|
+
export declare const getGetDocsForAccountUrl: (accountId: string, params?: GetDocsForAccountParams) => string;
|
|
505
|
+
/**
|
|
506
|
+
* This endpoint allows you to query all the account document based on an account ID. You can filter by date, or type of document.
|
|
507
|
+
*
|
|
508
|
+
* These account documents are tax statements, trade confirmations, etc, generated by the Alpaca system. They are distinct from the owner documents you upload and later access via the account object's documents property.
|
|
509
|
+
* @summary Retrieve a List of Account Documents
|
|
510
|
+
*/
|
|
511
|
+
export declare const getDocsForAccount: (accountId: string, params?: GetDocsForAccountParams, options?: RequestInit) => Promise<getDocsForAccountResponse>;
|
|
512
|
+
export type downloadDocFromAccountResponse301 = {
|
|
513
|
+
data: void;
|
|
514
|
+
status: 301;
|
|
515
|
+
};
|
|
516
|
+
export type downloadDocFromAccountResponse404 = {
|
|
517
|
+
data: void;
|
|
518
|
+
status: 404;
|
|
519
|
+
};
|
|
520
|
+
export type downloadDocFromAccountResponseError = (downloadDocFromAccountResponse301 | downloadDocFromAccountResponse404) & {
|
|
521
|
+
headers: Headers;
|
|
522
|
+
};
|
|
523
|
+
export type downloadDocFromAccountResponse = (downloadDocFromAccountResponseError);
|
|
524
|
+
export declare const getDownloadDocFromAccountUrl: (accountId: string, documentId: string) => string;
|
|
525
|
+
/**
|
|
526
|
+
* This endpoint downloads an account document based on the document ID. The document will be in PDF format.
|
|
527
|
+
*
|
|
528
|
+
* The operation returns a pre-signed downloadable link as a redirect with HTTP status code 301 if one is found.
|
|
529
|
+
*
|
|
530
|
+
* You can retrieve a JSON version of a monthly statement by passing in the header accept: application/json header.
|
|
531
|
+
*
|
|
532
|
+
* These account documents are tax statements, trade confirmations, etc, generated by the Alpaca system. They are distinct from the owner documents you upload and later access via the account object's documents property.
|
|
533
|
+
* @summary Download an Account Document
|
|
534
|
+
*/
|
|
535
|
+
export declare const downloadDocFromAccount: (accountId: string, documentId: string, options?: RequestInit) => Promise<downloadDocFromAccountResponse>;
|
|
536
|
+
export type uploadDocToAccountResponse204 = {
|
|
537
|
+
data: void;
|
|
538
|
+
status: 204;
|
|
539
|
+
};
|
|
540
|
+
export type uploadDocToAccountResponse400 = {
|
|
541
|
+
data: string;
|
|
542
|
+
status: 400;
|
|
543
|
+
};
|
|
544
|
+
export type uploadDocToAccountResponse404 = {
|
|
545
|
+
data: string;
|
|
546
|
+
status: 404;
|
|
547
|
+
};
|
|
548
|
+
export type uploadDocToAccountResponseSuccess = (uploadDocToAccountResponse204) & {
|
|
549
|
+
headers: Headers;
|
|
550
|
+
};
|
|
551
|
+
export type uploadDocToAccountResponseError = (uploadDocToAccountResponse400 | uploadDocToAccountResponse404) & {
|
|
552
|
+
headers: Headers;
|
|
553
|
+
};
|
|
554
|
+
export type uploadDocToAccountResponse = (uploadDocToAccountResponseSuccess | uploadDocToAccountResponseError);
|
|
555
|
+
export declare const getUploadDocToAccountUrl: (accountId: string) => string;
|
|
556
|
+
/**
|
|
557
|
+
* Upload documents for the primary account owner of an account.
|
|
558
|
+
*
|
|
559
|
+
* Documents are binary objects whose contents are encoded in base64. Each encoded content size is limited to 10MB if you use Alpaca for KYCaaS. If you perform your own KYC there are no document size limitations.
|
|
560
|
+
*
|
|
561
|
+
* As a convenience, documents of type w8ben may be uploaded as a JSON object using the content_data request property. The Alpaca system will then generate a formatted W-8 BEN document for subsequent downloads.
|
|
562
|
+
*
|
|
563
|
+
* Note that these owner documents are distinct from the account documents generated by Alpaca, such as tax statements and trade confirmations.
|
|
564
|
+
* @summary Upload Owner Documents for an Existing Account
|
|
565
|
+
*/
|
|
566
|
+
export declare const uploadDocToAccount: (accountId: string, ownerDocumentUploadRequest: OwnerDocumentUploadRequest[], options?: RequestInit) => Promise<uploadDocToAccountResponse>;
|
|
567
|
+
export type getV1AccountsAccountIdDocumentsW8benDocumentIdDownloadResponse301 = {
|
|
568
|
+
data: void;
|
|
569
|
+
status: 301;
|
|
570
|
+
};
|
|
571
|
+
export type getV1AccountsAccountIdDocumentsW8benDocumentIdDownloadResponse404 = {
|
|
572
|
+
data: void;
|
|
573
|
+
status: 404;
|
|
574
|
+
};
|
|
575
|
+
export type getV1AccountsAccountIdDocumentsW8benDocumentIdDownloadResponseError = (getV1AccountsAccountIdDocumentsW8benDocumentIdDownloadResponse301 | getV1AccountsAccountIdDocumentsW8benDocumentIdDownloadResponse404) & {
|
|
576
|
+
headers: Headers;
|
|
577
|
+
};
|
|
578
|
+
export type getV1AccountsAccountIdDocumentsW8benDocumentIdDownloadResponse = (getV1AccountsAccountIdDocumentsW8benDocumentIdDownloadResponseError);
|
|
579
|
+
export declare const getGetV1AccountsAccountIdDocumentsW8benDocumentIdDownloadUrl: (accountId: string, documentId: string) => string;
|
|
580
|
+
/**
|
|
581
|
+
* This endpoint allows you to download a W-8 BEN document for the primary owner of an account based on the document_id passed as a path parameter. The returned document is in PDF format.
|
|
582
|
+
*
|
|
583
|
+
* For certain individuals, a W-8 BEN form should be submitted at onboarding. If the individual is not a registered U.S. taxpayer (not subject to a W-9), the W-8 BEN form may need to be submitted. The IRS explains which individuals this applies to and provides instructions on completing the form. Every three years, in addition to the calendar year it was signed, a new W-8 BEN form must be submitted.
|
|
584
|
+
*
|
|
585
|
+
* The form can be submitted in JSON, JSONC, PNG, JPEG or PDF. If submitting it in JSON, please see the W-8 BEN completed with the corresponding field names for the API here.
|
|
586
|
+
*
|
|
587
|
+
* Note: The dates collected on the form are in a slightly different format than how they need to be submitted via Accounts API. It is requested by the user on the form in MM-DD-YYYY, but should be submitted as YYYY-MM-DD.
|
|
588
|
+
* @summary Download the W8BEN document for the primary owner of an account
|
|
589
|
+
*/
|
|
590
|
+
export declare const getV1AccountsAccountIdDocumentsW8benDocumentIdDownload: (accountId: string, documentId: string, options?: RequestInit) => Promise<getV1AccountsAccountIdDocumentsW8benDocumentIdDownloadResponse>;
|
|
591
|
+
export type patchV1AccountsAccountIdOnfidoSdkResponse200 = {
|
|
592
|
+
data: void;
|
|
593
|
+
status: 200;
|
|
594
|
+
};
|
|
595
|
+
export type patchV1AccountsAccountIdOnfidoSdkResponse404 = {
|
|
596
|
+
data: void;
|
|
597
|
+
status: 404;
|
|
598
|
+
};
|
|
599
|
+
export type patchV1AccountsAccountIdOnfidoSdkResponse422 = {
|
|
600
|
+
data: void;
|
|
601
|
+
status: 422;
|
|
602
|
+
};
|
|
603
|
+
export type patchV1AccountsAccountIdOnfidoSdkResponseSuccess = (patchV1AccountsAccountIdOnfidoSdkResponse200) & {
|
|
604
|
+
headers: Headers;
|
|
605
|
+
};
|
|
606
|
+
export type patchV1AccountsAccountIdOnfidoSdkResponseError = (patchV1AccountsAccountIdOnfidoSdkResponse404 | patchV1AccountsAccountIdOnfidoSdkResponse422) & {
|
|
607
|
+
headers: Headers;
|
|
608
|
+
};
|
|
609
|
+
export type patchV1AccountsAccountIdOnfidoSdkResponse = (patchV1AccountsAccountIdOnfidoSdkResponseSuccess | patchV1AccountsAccountIdOnfidoSdkResponseError);
|
|
610
|
+
export declare const getPatchV1AccountsAccountIdOnfidoSdkUrl: (accountId: string) => string;
|
|
611
|
+
/**
|
|
612
|
+
* This request allows you to send Alpaca the result of the Onfido SDK flow in your app. A notification of a successful outcome is required for Alpaca to continue the KYC process.
|
|
613
|
+
* @summary Update the Onfido SDK Outcome
|
|
614
|
+
*/
|
|
615
|
+
export declare const patchV1AccountsAccountIdOnfidoSdk: (accountId: string, patchV1AccountsAccountIdOnfidoSdkBody?: PatchV1AccountsAccountIdOnfidoSdkBody, options?: RequestInit) => Promise<patchV1AccountsAccountIdOnfidoSdkResponse>;
|
|
616
|
+
export type getV1AccountsAccountIdOnfidoSdkTokensResponse200 = {
|
|
617
|
+
data: GetV1AccountsAccountIdOnfidoSdkTokens200;
|
|
618
|
+
status: 200;
|
|
619
|
+
};
|
|
620
|
+
export type getV1AccountsAccountIdOnfidoSdkTokensResponse422 = {
|
|
621
|
+
data: void;
|
|
622
|
+
status: 422;
|
|
623
|
+
};
|
|
624
|
+
export type getV1AccountsAccountIdOnfidoSdkTokensResponseSuccess = (getV1AccountsAccountIdOnfidoSdkTokensResponse200) & {
|
|
625
|
+
headers: Headers;
|
|
626
|
+
};
|
|
627
|
+
export type getV1AccountsAccountIdOnfidoSdkTokensResponseError = (getV1AccountsAccountIdOnfidoSdkTokensResponse422) & {
|
|
628
|
+
headers: Headers;
|
|
629
|
+
};
|
|
630
|
+
export type getV1AccountsAccountIdOnfidoSdkTokensResponse = (getV1AccountsAccountIdOnfidoSdkTokensResponseSuccess | getV1AccountsAccountIdOnfidoSdkTokensResponseError);
|
|
631
|
+
export declare const getGetV1AccountsAccountIdOnfidoSdkTokensUrl: (accountId: string, params?: GetV1AccountsAccountIdOnfidoSdkTokensParams) => string;
|
|
632
|
+
/**
|
|
633
|
+
* Get an SDK token to activate the Onfido SDK flow within your app. You will have to keep track of the SDK token so you can pass it back when you upload the SDK outcome. We recommend storing the token in memory rather than persistent storage to reduce any unnecessary overhead in your app.
|
|
634
|
+
* @summary Retrieve an Onfido SDK Token
|
|
635
|
+
*/
|
|
636
|
+
export declare const getV1AccountsAccountIdOnfidoSdkTokens: (accountId: string, params?: GetV1AccountsAccountIdOnfidoSdkTokensParams, options?: RequestInit) => Promise<getV1AccountsAccountIdOnfidoSdkTokensResponse>;
|
|
637
|
+
export type requestOptionsForAccountResponse200 = {
|
|
638
|
+
data: OptionsApprovalResponse;
|
|
639
|
+
status: 200;
|
|
640
|
+
};
|
|
641
|
+
export type requestOptionsForAccountResponse400 = {
|
|
642
|
+
data: Error;
|
|
643
|
+
status: 400;
|
|
644
|
+
};
|
|
645
|
+
export type requestOptionsForAccountResponse401 = {
|
|
646
|
+
data: Error;
|
|
647
|
+
status: 401;
|
|
648
|
+
};
|
|
649
|
+
export type requestOptionsForAccountResponse422 = {
|
|
650
|
+
data: Error;
|
|
651
|
+
status: 422;
|
|
652
|
+
};
|
|
653
|
+
export type requestOptionsForAccountResponseSuccess = (requestOptionsForAccountResponse200) & {
|
|
654
|
+
headers: Headers;
|
|
655
|
+
};
|
|
656
|
+
export type requestOptionsForAccountResponseError = (requestOptionsForAccountResponse400 | requestOptionsForAccountResponse401 | requestOptionsForAccountResponse422) & {
|
|
657
|
+
headers: Headers;
|
|
658
|
+
};
|
|
659
|
+
export type requestOptionsForAccountResponse = (requestOptionsForAccountResponseSuccess | requestOptionsForAccountResponseError);
|
|
660
|
+
export declare const getRequestOptionsForAccountUrl: (accountId: string) => string;
|
|
661
|
+
/**
|
|
662
|
+
* This endpoint requests options trading for an account.
|
|
663
|
+
* Following submission, an assigned administrator will review the request.
|
|
664
|
+
* Upon approval, the account's options_approved_level parameter will be modified, granting the account the ability to participate in options trading.
|
|
665
|
+
* Note: This endpoint is only available for partners who have been enabled for Options BETA.
|
|
666
|
+
* @summary Request options trading for an account (BETA)
|
|
667
|
+
*/
|
|
668
|
+
export declare const requestOptionsForAccount: (accountId: string, optionsApprovalRequest: OptionsApprovalRequest, options?: RequestInit) => Promise<requestOptionsForAccountResponse>;
|
|
669
|
+
export type getRecipientBanksResponse200 = {
|
|
670
|
+
data: Bank[];
|
|
671
|
+
status: 200;
|
|
672
|
+
};
|
|
673
|
+
export type getRecipientBanksResponse400 = {
|
|
674
|
+
data: void;
|
|
675
|
+
status: 400;
|
|
676
|
+
};
|
|
677
|
+
export type getRecipientBanksResponseSuccess = (getRecipientBanksResponse200) & {
|
|
678
|
+
headers: Headers;
|
|
679
|
+
};
|
|
680
|
+
export type getRecipientBanksResponseError = (getRecipientBanksResponse400) & {
|
|
681
|
+
headers: Headers;
|
|
682
|
+
};
|
|
683
|
+
export type getRecipientBanksResponse = (getRecipientBanksResponseSuccess | getRecipientBanksResponseError);
|
|
684
|
+
export declare const getGetRecipientBanksUrl: (accountId: string, params?: GetRecipientBanksParams) => string;
|
|
685
|
+
/**
|
|
686
|
+
* Retrieves Bank Relationships for an account
|
|
687
|
+
* @summary Retrieve Bank Relationships for an Account
|
|
688
|
+
*/
|
|
689
|
+
export declare const getRecipientBanks: (accountId: string, params?: GetRecipientBanksParams, options?: RequestInit) => Promise<getRecipientBanksResponse>;
|
|
690
|
+
export type createRecipientBankResponse200 = {
|
|
691
|
+
data: Bank;
|
|
692
|
+
status: 200;
|
|
693
|
+
};
|
|
694
|
+
export type createRecipientBankResponse400 = {
|
|
695
|
+
data: void;
|
|
696
|
+
status: 400;
|
|
697
|
+
};
|
|
698
|
+
export type createRecipientBankResponse409 = {
|
|
699
|
+
data: void;
|
|
700
|
+
status: 409;
|
|
701
|
+
};
|
|
702
|
+
export type createRecipientBankResponseSuccess = (createRecipientBankResponse200) & {
|
|
703
|
+
headers: Headers;
|
|
704
|
+
};
|
|
705
|
+
export type createRecipientBankResponseError = (createRecipientBankResponse400 | createRecipientBankResponse409) & {
|
|
706
|
+
headers: Headers;
|
|
707
|
+
};
|
|
708
|
+
export type createRecipientBankResponse = (createRecipientBankResponseSuccess | createRecipientBankResponseError);
|
|
709
|
+
export declare const getCreateRecipientBankUrl: (accountId: string) => string;
|
|
710
|
+
/**
|
|
711
|
+
* If successful, retrieves Bank Relationships for an account
|
|
712
|
+
* @summary Create a Bank Relationship for an Account
|
|
713
|
+
*/
|
|
714
|
+
export declare const createRecipientBank: (accountId: string, createBankRequest: CreateBankRequest, options?: RequestInit) => Promise<createRecipientBankResponse>;
|
|
715
|
+
export type deleteRecipientBankResponse204 = {
|
|
716
|
+
data: void;
|
|
717
|
+
status: 204;
|
|
718
|
+
};
|
|
719
|
+
export type deleteRecipientBankResponse400 = {
|
|
720
|
+
data: void;
|
|
721
|
+
status: 400;
|
|
722
|
+
};
|
|
723
|
+
export type deleteRecipientBankResponse404 = {
|
|
724
|
+
data: void;
|
|
725
|
+
status: 404;
|
|
726
|
+
};
|
|
727
|
+
export type deleteRecipientBankResponseSuccess = (deleteRecipientBankResponse204) & {
|
|
728
|
+
headers: Headers;
|
|
729
|
+
};
|
|
730
|
+
export type deleteRecipientBankResponseError = (deleteRecipientBankResponse400 | deleteRecipientBankResponse404) & {
|
|
731
|
+
headers: Headers;
|
|
732
|
+
};
|
|
733
|
+
export type deleteRecipientBankResponse = (deleteRecipientBankResponseSuccess | deleteRecipientBankResponseError);
|
|
734
|
+
export declare const getDeleteRecipientBankUrl: (accountId: string, bankId: string) => string;
|
|
735
|
+
/**
|
|
736
|
+
* If successful, deletes Bank Relationship for an account
|
|
737
|
+
* @summary Delete a Bank Relationship for an Account
|
|
738
|
+
*/
|
|
739
|
+
export declare const deleteRecipientBank: (accountId: string, bankId: string, options?: RequestInit) => Promise<deleteRecipientBankResponse>;
|
|
740
|
+
export type postTokenizationCallbackMintResponse200 = {
|
|
741
|
+
data: TokenizationRequest;
|
|
742
|
+
status: 200;
|
|
743
|
+
};
|
|
744
|
+
export type postTokenizationCallbackMintResponse400 = {
|
|
745
|
+
data: Error;
|
|
746
|
+
status: 400;
|
|
747
|
+
};
|
|
748
|
+
export type postTokenizationCallbackMintResponse401 = {
|
|
749
|
+
data: Error;
|
|
750
|
+
status: 401;
|
|
751
|
+
};
|
|
752
|
+
export type postTokenizationCallbackMintResponse403 = {
|
|
753
|
+
data: Error;
|
|
754
|
+
status: 403;
|
|
755
|
+
};
|
|
756
|
+
export type postTokenizationCallbackMintResponse422 = {
|
|
757
|
+
data: Error;
|
|
758
|
+
status: 422;
|
|
759
|
+
};
|
|
760
|
+
export type postTokenizationCallbackMintResponseSuccess = (postTokenizationCallbackMintResponse200) & {
|
|
761
|
+
headers: Headers;
|
|
762
|
+
};
|
|
763
|
+
export type postTokenizationCallbackMintResponseError = (postTokenizationCallbackMintResponse400 | postTokenizationCallbackMintResponse401 | postTokenizationCallbackMintResponse403 | postTokenizationCallbackMintResponse422) & {
|
|
764
|
+
headers: Headers;
|
|
765
|
+
};
|
|
766
|
+
export type postTokenizationCallbackMintResponse = (postTokenizationCallbackMintResponseSuccess | postTokenizationCallbackMintResponseError);
|
|
767
|
+
export declare const getPostTokenizationCallbackMintUrl: (accountId: string) => string;
|
|
768
|
+
/**
|
|
769
|
+
* This endpoint is used by the issuer to confirm the minting of tokenized assets previously requested by the Authorized Participant.
|
|
770
|
+
* @summary Confirm Tokenized Asset Minted
|
|
771
|
+
*/
|
|
772
|
+
export declare const postTokenizationCallbackMint: (accountId: string, tokenizationMintCallback: TokenizationMintCallback, options?: RequestInit) => Promise<postTokenizationCallbackMintResponse>;
|
|
773
|
+
export type postTokenizationRedeemResponse200 = {
|
|
774
|
+
data: TokenizationRedeemResponse;
|
|
775
|
+
status: 200;
|
|
776
|
+
};
|
|
777
|
+
export type postTokenizationRedeemResponse400 = {
|
|
778
|
+
data: Error;
|
|
779
|
+
status: 400;
|
|
780
|
+
};
|
|
781
|
+
export type postTokenizationRedeemResponse401 = {
|
|
782
|
+
data: Error;
|
|
783
|
+
status: 401;
|
|
784
|
+
};
|
|
785
|
+
export type postTokenizationRedeemResponse403 = {
|
|
786
|
+
data: Error;
|
|
787
|
+
status: 403;
|
|
788
|
+
};
|
|
789
|
+
export type postTokenizationRedeemResponse422 = {
|
|
790
|
+
data: Error;
|
|
791
|
+
status: 422;
|
|
792
|
+
};
|
|
793
|
+
export type postTokenizationRedeemResponseSuccess = (postTokenizationRedeemResponse200) & {
|
|
794
|
+
headers: Headers;
|
|
795
|
+
};
|
|
796
|
+
export type postTokenizationRedeemResponseError = (postTokenizationRedeemResponse400 | postTokenizationRedeemResponse401 | postTokenizationRedeemResponse403 | postTokenizationRedeemResponse422) & {
|
|
797
|
+
headers: Headers;
|
|
798
|
+
};
|
|
799
|
+
export type postTokenizationRedeemResponse = (postTokenizationRedeemResponseSuccess | postTokenizationRedeemResponseError);
|
|
800
|
+
export declare const getPostTokenizationRedeemUrl: (accountId: string) => string;
|
|
801
|
+
/**
|
|
802
|
+
* This endpoint is used by the tokenized asset issuer to confirm the redemption of tokens previously held in the Authorized Participant's wallet. When the issuer invokes this endpoint, Alpaca will initiate a journal of the underlying asset into the Authorized Participant's account.
|
|
803
|
+
* @summary Redeem a Tokenized Asset
|
|
804
|
+
*/
|
|
805
|
+
export declare const postTokenizationRedeem: (accountId: string, tokenizationRedeemRequest: TokenizationRedeemRequest, options?: RequestInit) => Promise<postTokenizationRedeemResponse>;
|
|
806
|
+
export type postTokenizationMintBrokerResponse200 = {
|
|
807
|
+
data: TokenizationMintResponse;
|
|
808
|
+
status: 200;
|
|
809
|
+
};
|
|
810
|
+
export type postTokenizationMintBrokerResponse400 = {
|
|
811
|
+
data: Error;
|
|
812
|
+
status: 400;
|
|
813
|
+
};
|
|
814
|
+
export type postTokenizationMintBrokerResponse401 = {
|
|
815
|
+
data: Error;
|
|
816
|
+
status: 401;
|
|
817
|
+
};
|
|
818
|
+
export type postTokenizationMintBrokerResponse403 = {
|
|
819
|
+
data: Error;
|
|
820
|
+
status: 403;
|
|
821
|
+
};
|
|
822
|
+
export type postTokenizationMintBrokerResponse422 = {
|
|
823
|
+
data: Error;
|
|
824
|
+
status: 422;
|
|
825
|
+
};
|
|
826
|
+
export type postTokenizationMintBrokerResponseSuccess = (postTokenizationMintBrokerResponse200) & {
|
|
827
|
+
headers: Headers;
|
|
828
|
+
};
|
|
829
|
+
export type postTokenizationMintBrokerResponseError = (postTokenizationMintBrokerResponse400 | postTokenizationMintBrokerResponse401 | postTokenizationMintBrokerResponse403 | postTokenizationMintBrokerResponse422) & {
|
|
830
|
+
headers: Headers;
|
|
831
|
+
};
|
|
832
|
+
export type postTokenizationMintBrokerResponse = (postTokenizationMintBrokerResponseSuccess | postTokenizationMintBrokerResponseError);
|
|
833
|
+
export declare const getPostTokenizationMintBrokerUrl: (accountId: string) => string;
|
|
834
|
+
/**
|
|
835
|
+
* This endpoint is used by an Authorized Participant to request the minting of a tokenized asset. Alpaca will initiate a journal of the underlying asset from the Authorized Participant's account to the issuer's account.
|
|
836
|
+
* @summary Mint a Tokenized Asset
|
|
837
|
+
*/
|
|
838
|
+
export declare const postTokenizationMintBroker: (accountId: string, tokenizationMintRequest: TokenizationMintRequest, options?: RequestInit) => Promise<postTokenizationMintBrokerResponse>;
|
|
839
|
+
export type getTokenizationRequestsBrokerResponse200 = {
|
|
840
|
+
data: TokenizationRequest[];
|
|
841
|
+
status: 200;
|
|
842
|
+
};
|
|
843
|
+
export type getTokenizationRequestsBrokerResponse401 = {
|
|
844
|
+
data: Error;
|
|
845
|
+
status: 401;
|
|
846
|
+
};
|
|
847
|
+
export type getTokenizationRequestsBrokerResponse403 = {
|
|
848
|
+
data: Error;
|
|
849
|
+
status: 403;
|
|
850
|
+
};
|
|
851
|
+
export type getTokenizationRequestsBrokerResponse422 = {
|
|
852
|
+
data: Error;
|
|
853
|
+
status: 422;
|
|
854
|
+
};
|
|
855
|
+
export type getTokenizationRequestsBrokerResponseSuccess = (getTokenizationRequestsBrokerResponse200) & {
|
|
856
|
+
headers: Headers;
|
|
857
|
+
};
|
|
858
|
+
export type getTokenizationRequestsBrokerResponseError = (getTokenizationRequestsBrokerResponse401 | getTokenizationRequestsBrokerResponse403 | getTokenizationRequestsBrokerResponse422) & {
|
|
859
|
+
headers: Headers;
|
|
860
|
+
};
|
|
861
|
+
export type getTokenizationRequestsBrokerResponse = (getTokenizationRequestsBrokerResponseSuccess | getTokenizationRequestsBrokerResponseError);
|
|
862
|
+
export declare const getGetTokenizationRequestsBrokerUrl: (accountId: string, params?: GetTokenizationRequestsBrokerParams) => string;
|
|
863
|
+
/**
|
|
864
|
+
* Retrieve tokenization requests for the account. This endpoint may be used by the tokenized asset issuer or by an Authorized Participant (AP). The list can contain both mint and redeem requests.
|
|
865
|
+
* @summary List Tokenization Requests
|
|
866
|
+
*/
|
|
867
|
+
export declare const getTokenizationRequestsBroker: (accountId: string, params?: GetTokenizationRequestsBrokerParams, options?: RequestInit) => Promise<getTokenizationRequestsBrokerResponse>;
|
|
868
|
+
export type getTransfersForAccountResponse200 = {
|
|
869
|
+
data: Transfer[];
|
|
870
|
+
status: 200;
|
|
871
|
+
};
|
|
872
|
+
export type getTransfersForAccountResponseSuccess = (getTransfersForAccountResponse200) & {
|
|
873
|
+
headers: Headers;
|
|
874
|
+
};
|
|
875
|
+
export type getTransfersForAccountResponse = (getTransfersForAccountResponseSuccess);
|
|
876
|
+
export declare const getGetTransfersForAccountUrl: (accountId: string, params?: GetTransfersForAccountParams) => string;
|
|
877
|
+
/**
|
|
878
|
+
* You can query a list of transfers for an account.
|
|
879
|
+
*
|
|
880
|
+
*
|
|
881
|
+
* You can filter requested transfers by values such as direction and status.
|
|
882
|
+
*
|
|
883
|
+
* Returns a list of transfer entities ordered by created_at
|
|
884
|
+
* @summary Retrieve List of Transfers for an Account.
|
|
885
|
+
*/
|
|
886
|
+
export declare const getTransfersForAccount: (accountId: string, params?: GetTransfersForAccountParams, options?: RequestInit) => Promise<getTransfersForAccountResponse>;
|
|
887
|
+
export type createTransferForAccountResponse200 = {
|
|
888
|
+
data: Transfer;
|
|
889
|
+
status: 200;
|
|
890
|
+
};
|
|
891
|
+
export type createTransferForAccountResponse400 = {
|
|
892
|
+
data: Error;
|
|
893
|
+
status: 400;
|
|
894
|
+
};
|
|
895
|
+
export type createTransferForAccountResponse403 = {
|
|
896
|
+
data: Error;
|
|
897
|
+
status: 403;
|
|
898
|
+
};
|
|
899
|
+
export type createTransferForAccountResponse422 = {
|
|
900
|
+
data: Error;
|
|
901
|
+
status: 422;
|
|
902
|
+
};
|
|
903
|
+
export type createTransferForAccountResponseSuccess = (createTransferForAccountResponse200) & {
|
|
904
|
+
headers: Headers;
|
|
905
|
+
};
|
|
906
|
+
export type createTransferForAccountResponseError = (createTransferForAccountResponse400 | createTransferForAccountResponse403 | createTransferForAccountResponse422) & {
|
|
907
|
+
headers: Headers;
|
|
908
|
+
};
|
|
909
|
+
export type createTransferForAccountResponse = (createTransferForAccountResponseSuccess | createTransferForAccountResponseError);
|
|
910
|
+
export declare const getCreateTransferForAccountUrl: (accountId: string) => string;
|
|
911
|
+
/**
|
|
912
|
+
* Create a new transfer to deposit money into or withdraw money from an account.
|
|
913
|
+
*
|
|
914
|
+
* Two `transfer_type` values are accepted, and both are available in sandbox and production:
|
|
915
|
+
*
|
|
916
|
+
* - **`ach`** — supports both `INCOMING` (deposit) and `OUTGOING` (withdrawal) directions. A `relationship_id` from a previously created [ACH Relationship](https://docs.alpaca.markets/reference/createachrelationshipforaccount) is required.
|
|
917
|
+
* - **`wire`** — supports the `OUTGOING` (withdrawal) direction only. Incoming wires cannot be initiated through this endpoint; they are pushed in by the sending bank and recorded automatically. A `bank_id` from a previously created [Bank Relationship](https://docs.alpaca.markets/reference/createrecipientbank) is required, and the bank must be in `APPROVED` status before the transfer will progress past `QUEUED`.
|
|
918
|
+
*
|
|
919
|
+
* In the sandbox environment, ACH deposits and withdrawals settle instantly against virtual funds. Outgoing wire withdrawals are accepted and simulated end-to-end — no funds are transmitted to a bank, but the transfer progresses to `COMPLETE` and the account is debited against virtual funds. Sandbox wire withdrawals are asynchronous (not instant) and auto-complete on weekdays only; transfers submitted on a weekend will not progress until Monday. For more on funding accounts in sandbox, see [this tutorial](https://alpaca.markets/learn/fund-broker-api/).
|
|
920
|
+
* @summary Request a New Transfer
|
|
921
|
+
*/
|
|
922
|
+
export declare const createTransferForAccount: (accountId: string, createTransferRequest: CreateTransferRequest, options?: RequestInit) => Promise<createTransferForAccountResponse>;
|
|
923
|
+
export type deleteTransferResponse200 = {
|
|
924
|
+
data: void;
|
|
925
|
+
status: 200;
|
|
926
|
+
};
|
|
927
|
+
export type deleteTransferResponse404 = {
|
|
928
|
+
data: void;
|
|
929
|
+
status: 404;
|
|
930
|
+
};
|
|
931
|
+
export type deleteTransferResponseSuccess = (deleteTransferResponse200) & {
|
|
932
|
+
headers: Headers;
|
|
933
|
+
};
|
|
934
|
+
export type deleteTransferResponseError = (deleteTransferResponse404) & {
|
|
935
|
+
headers: Headers;
|
|
936
|
+
};
|
|
937
|
+
export type deleteTransferResponse = (deleteTransferResponseSuccess | deleteTransferResponseError);
|
|
938
|
+
export declare const getDeleteTransferUrl: (accountId: string, transferId: string) => string;
|
|
939
|
+
/**
|
|
940
|
+
* Request to close a transfer
|
|
941
|
+
* @summary Request to Close a Transfer
|
|
942
|
+
*/
|
|
943
|
+
export declare const deleteTransfer: (accountId: string, transferId: string, options?: RequestInit) => Promise<deleteTransferResponse>;
|
|
944
|
+
export type listCryptoFundingWalletsResponse200 = {
|
|
945
|
+
data: CryptoWallet;
|
|
946
|
+
status: 200;
|
|
947
|
+
};
|
|
948
|
+
export type listCryptoFundingWalletsResponseDefault = {
|
|
949
|
+
data: Error;
|
|
950
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
951
|
+
};
|
|
952
|
+
export type listCryptoFundingWalletsResponseSuccess = (listCryptoFundingWalletsResponse200) & {
|
|
953
|
+
headers: Headers;
|
|
954
|
+
};
|
|
955
|
+
export type listCryptoFundingWalletsResponseError = (listCryptoFundingWalletsResponseDefault) & {
|
|
956
|
+
headers: Headers;
|
|
957
|
+
};
|
|
958
|
+
export type listCryptoFundingWalletsResponse = (listCryptoFundingWalletsResponseSuccess | listCryptoFundingWalletsResponseError);
|
|
959
|
+
export declare const getListCryptoFundingWalletsUrl: (accountId: string, params?: ListCryptoFundingWalletsParams) => string;
|
|
960
|
+
/**
|
|
961
|
+
* Lists wallets for the account given in the path parameter. If an asset is specified and no wallet for the account and asset pair exists one will be created. If no asset is specified only existing wallets will be listed for the account. An account may have at most one wallet per asset.
|
|
962
|
+
* @summary Retrieve Crypto Funding Wallets
|
|
963
|
+
*/
|
|
964
|
+
export declare const listCryptoFundingWallets: (accountId: string, params?: ListCryptoFundingWalletsParams, options?: RequestInit) => Promise<listCryptoFundingWalletsResponse>;
|
|
965
|
+
export type listCryptoFundingTransfersResponse200 = {
|
|
966
|
+
data: CryptoTransfer;
|
|
967
|
+
status: 200;
|
|
968
|
+
};
|
|
969
|
+
export type listCryptoFundingTransfersResponseDefault = {
|
|
970
|
+
data: Error;
|
|
971
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
972
|
+
};
|
|
973
|
+
export type listCryptoFundingTransfersResponseSuccess = (listCryptoFundingTransfersResponse200) & {
|
|
974
|
+
headers: Headers;
|
|
975
|
+
};
|
|
976
|
+
export type listCryptoFundingTransfersResponseError = (listCryptoFundingTransfersResponseDefault) & {
|
|
977
|
+
headers: Headers;
|
|
978
|
+
};
|
|
979
|
+
export type listCryptoFundingTransfersResponse = (listCryptoFundingTransfersResponseSuccess | listCryptoFundingTransfersResponseError);
|
|
980
|
+
export declare const getListCryptoFundingTransfersUrl: (accountId: string) => string;
|
|
981
|
+
/**
|
|
982
|
+
* Returns an array of all transfers associated with the given account across all wallets.
|
|
983
|
+
* @summary Retrieve Crypto Funding Transfers
|
|
984
|
+
*/
|
|
985
|
+
export declare const listCryptoFundingTransfers: (accountId: string, options?: RequestInit) => Promise<listCryptoFundingTransfersResponse>;
|
|
986
|
+
export type createCryptoTransferForAccountResponse200 = {
|
|
987
|
+
data: CryptoTransfer;
|
|
988
|
+
status: 200;
|
|
989
|
+
};
|
|
990
|
+
export type createCryptoTransferForAccountResponseSuccess = (createCryptoTransferForAccountResponse200) & {
|
|
991
|
+
headers: Headers;
|
|
992
|
+
};
|
|
993
|
+
export type createCryptoTransferForAccountResponse = (createCryptoTransferForAccountResponseSuccess);
|
|
994
|
+
export declare const getCreateCryptoTransferForAccountUrl: (accountId: string) => string;
|
|
995
|
+
/**
|
|
996
|
+
* Creates a withdrawal request. Note that outgoing withdrawals must be sent to a whitelisted address and you must whitelist addresses at least 24 hours in advance. If you attempt to withdraw funds to a non-whitelisted address then the transfer will be rejected.
|
|
997
|
+
* @summary Request a New Withdrawal
|
|
998
|
+
*/
|
|
999
|
+
export declare const createCryptoTransferForAccount: (accountId: string, createCryptoTransferRequest: CreateCryptoTransferRequest, options?: RequestInit) => Promise<createCryptoTransferForAccountResponse>;
|
|
1000
|
+
export type getCryptoFundingTransferResponse200 = {
|
|
1001
|
+
data: CryptoTransfer;
|
|
1002
|
+
status: 200;
|
|
1003
|
+
};
|
|
1004
|
+
export type getCryptoFundingTransferResponseSuccess = (getCryptoFundingTransferResponse200) & {
|
|
1005
|
+
headers: Headers;
|
|
1006
|
+
};
|
|
1007
|
+
export type getCryptoFundingTransferResponse = (getCryptoFundingTransferResponseSuccess);
|
|
1008
|
+
export declare const getGetCryptoFundingTransferUrl: (accountId: string, transferId: string) => string;
|
|
1009
|
+
/**
|
|
1010
|
+
* Returns a specific wallet transfer by passing into the query the transfer_id.
|
|
1011
|
+
* @summary Retrieve a Crypto Funding Transfer
|
|
1012
|
+
*/
|
|
1013
|
+
export declare const getCryptoFundingTransfer: (accountId: string, transferId: string, options?: RequestInit) => Promise<getCryptoFundingTransferResponse>;
|
|
1014
|
+
export type listWhitelistedAddressResponse200 = {
|
|
1015
|
+
data: WhitelistedAddress;
|
|
1016
|
+
status: 200;
|
|
1017
|
+
};
|
|
1018
|
+
export type listWhitelistedAddressResponseDefault = {
|
|
1019
|
+
data: Error;
|
|
1020
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
1021
|
+
};
|
|
1022
|
+
export type listWhitelistedAddressResponseSuccess = (listWhitelistedAddressResponse200) & {
|
|
1023
|
+
headers: Headers;
|
|
1024
|
+
};
|
|
1025
|
+
export type listWhitelistedAddressResponseError = (listWhitelistedAddressResponseDefault) & {
|
|
1026
|
+
headers: Headers;
|
|
1027
|
+
};
|
|
1028
|
+
export type listWhitelistedAddressResponse = (listWhitelistedAddressResponseSuccess | listWhitelistedAddressResponseError);
|
|
1029
|
+
export declare const getListWhitelistedAddressUrl: (accountId: string) => string;
|
|
1030
|
+
/**
|
|
1031
|
+
* Returns the list of whitelisted withdrawal addresses for the specified account.
|
|
1032
|
+
* @summary An array of whitelisted addresses
|
|
1033
|
+
*/
|
|
1034
|
+
export declare const listWhitelistedAddress: (accountId: string, options?: RequestInit) => Promise<listWhitelistedAddressResponse>;
|
|
1035
|
+
export type createWhitelistedAddressResponse200 = {
|
|
1036
|
+
data: WhitelistedAddress;
|
|
1037
|
+
status: 200;
|
|
1038
|
+
};
|
|
1039
|
+
export type createWhitelistedAddressResponseSuccess = (createWhitelistedAddressResponse200) & {
|
|
1040
|
+
headers: Headers;
|
|
1041
|
+
};
|
|
1042
|
+
export type createWhitelistedAddressResponse = (createWhitelistedAddressResponseSuccess);
|
|
1043
|
+
export declare const getCreateWhitelistedAddressUrl: (accountId: string) => string;
|
|
1044
|
+
/**
|
|
1045
|
+
* Submits a new whitelisted withdrawal address for the specified account. The chain is derived from the supplied asset symbol and address, and the same address cannot be whitelisted twice on the same chain.
|
|
1046
|
+
*
|
|
1047
|
+
* Where travel rule reporting applies to the account, address details are validated against the travel rule provider before being persisted.
|
|
1048
|
+
*
|
|
1049
|
+
* Note that whitelisted addresses must wait at least 24 hours before they can be used as a withdrawal destination.
|
|
1050
|
+
* @summary Request a new whitelisted address
|
|
1051
|
+
*/
|
|
1052
|
+
export declare const createWhitelistedAddress: (accountId: string, createWhitelistedAddressBody: CreateWhitelistedAddressBody, options?: RequestInit) => Promise<createWhitelistedAddressResponse>;
|
|
1053
|
+
export type deleteWhitelistedAddressResponse200 = {
|
|
1054
|
+
data: void;
|
|
1055
|
+
status: 200;
|
|
1056
|
+
};
|
|
1057
|
+
export type deleteWhitelistedAddressResponseSuccess = (deleteWhitelistedAddressResponse200) & {
|
|
1058
|
+
headers: Headers;
|
|
1059
|
+
};
|
|
1060
|
+
export type deleteWhitelistedAddressResponse = (deleteWhitelistedAddressResponseSuccess);
|
|
1061
|
+
export declare const getDeleteWhitelistedAddressUrl: (accountId: string, whitelistedAddressId: string) => string;
|
|
1062
|
+
/**
|
|
1063
|
+
* Deletes a whitelisted withdrawal address from the specified account by ID. Subsequent withdrawals targeting the deleted address will be rejected.
|
|
1064
|
+
* @summary Delete a whitelisted address
|
|
1065
|
+
*/
|
|
1066
|
+
export declare const deleteWhitelistedAddress: (accountId: string, whitelistedAddressId: string, options?: RequestInit) => Promise<deleteWhitelistedAddressResponse>;
|
|
1067
|
+
export type getAccountActivitiesResponse200 = {
|
|
1068
|
+
data: Activity[];
|
|
1069
|
+
status: 200;
|
|
1070
|
+
};
|
|
1071
|
+
export type getAccountActivitiesResponseSuccess = (getAccountActivitiesResponse200) & {
|
|
1072
|
+
headers: Headers;
|
|
1073
|
+
};
|
|
1074
|
+
export type getAccountActivitiesResponse = (getAccountActivitiesResponseSuccess);
|
|
1075
|
+
export declare const getGetAccountActivitiesUrl: (params?: GetAccountActivitiesParams) => string;
|
|
1076
|
+
/**
|
|
1077
|
+
* Returns a list of activities
|
|
1078
|
+
*
|
|
1079
|
+
* Notes:
|
|
1080
|
+
* * Pagination is handled using the `page_token` and `page_size` parameters.
|
|
1081
|
+
* * `page_token` represents the ID of the last item on your current page of results.
|
|
1082
|
+
* For example, if the ID of the last activity in your first response is `20220203000000000::045b3b8d-c566-4bef-b741-2bf598dd6ae7`, you would pass that value as `page_token` to retrieve the next page of results.
|
|
1083
|
+
*
|
|
1084
|
+
* * If specified with a `direction` of `desc`, for example, the results will end before the activity with the specified ID.
|
|
1085
|
+
* * If specified with a `direction` of `asc`, results will begin with the activity immediately after the one specified.
|
|
1086
|
+
* * `page_size` is the maximum number of entries to return in the response.
|
|
1087
|
+
* * If `date` is not specified, the default and maximum value is 100.
|
|
1088
|
+
* * If `date` is specified, the default behavior is to return all results, and there is no maximum page size.
|
|
1089
|
+
* @summary Retrieve Account Activities
|
|
1090
|
+
*/
|
|
1091
|
+
export declare const getAccountActivities: (params?: GetAccountActivitiesParams, options?: RequestInit) => Promise<getAccountActivitiesResponse>;
|
|
1092
|
+
export type getAccountActivitiesByTypeResponse200 = {
|
|
1093
|
+
data: Activity[];
|
|
1094
|
+
status: 200;
|
|
1095
|
+
};
|
|
1096
|
+
export type getAccountActivitiesByTypeResponseSuccess = (getAccountActivitiesByTypeResponse200) & {
|
|
1097
|
+
headers: Headers;
|
|
1098
|
+
};
|
|
1099
|
+
export type getAccountActivitiesByTypeResponse = (getAccountActivitiesByTypeResponseSuccess);
|
|
1100
|
+
export declare const getGetAccountActivitiesByTypeUrl: (activityType: "FILL" | "ACATC" | "ACATS" | "CGD" | "CIL" | "CSD" | "CSW" | "DIV" | "DIVCGL" | "DIVCGS" | "DIVNRA" | "DIVROC" | "DIVTXEX" | "FEE" | "INT" | "MEM" | "JNLC" | "JNLS" | "MA" | "OPASN" | "OPCA" | "OPCSH" | "OPEXC" | "OPEXP" | "OPTRD" | "PTC" | "REORG" | "SPIN" | "SPLIT" | "FOPT", params?: GetAccountActivitiesByTypeParams) => string;
|
|
1101
|
+
/**
|
|
1102
|
+
* Retrieves an array of Activity by type.
|
|
1103
|
+
*
|
|
1104
|
+
* If {activity_type} is provided as part of the URL, category cannot be provided as query parameter. They are mutually exclusive.
|
|
1105
|
+
*
|
|
1106
|
+
* Notes:
|
|
1107
|
+
* * Pagination is handled using the `page_token` and `page_size` parameters.
|
|
1108
|
+
* * `page_token` represents the ID of the end of your current page of results.
|
|
1109
|
+
* for example if in your first response the id of the last Activiy item returned in the array was `20220203000000000::045b3b8d-c566-4bef-b741-2bf598dd6ae7`, you'd pass that value as `page_token` to get the next page of results
|
|
1110
|
+
*
|
|
1111
|
+
* * If specified with a `direction` of `desc`, for example, the results will end before the activity with the specified ID.
|
|
1112
|
+
* * If specified with a `direction` of `asc`, results will begin with the activity immediately after the one specified.
|
|
1113
|
+
* * `page_size` is the maximum number of entries to return in the response.
|
|
1114
|
+
* * If `date` is not specified, the default and maximum value is 100.
|
|
1115
|
+
* * If `date` is specified, the default behavior is to return all results, and there is no maximum page size.
|
|
1116
|
+
* @summary Retrieve Account Activities of Specific Type
|
|
1117
|
+
*/
|
|
1118
|
+
export declare const getAccountActivitiesByType: (activityType: "FILL" | "ACATC" | "ACATS" | "CGD" | "CIL" | "CSD" | "CSW" | "DIV" | "DIVCGL" | "DIVCGS" | "DIVNRA" | "DIVROC" | "DIVTXEX" | "FEE" | "INT" | "MEM" | "JNLC" | "JNLS" | "MA" | "OPASN" | "OPCA" | "OPCSH" | "OPEXC" | "OPEXP" | "OPTRD" | "PTC" | "REORG" | "SPIN" | "SPLIT" | "FOPT", params?: GetAccountActivitiesByTypeParams, options?: RequestInit) => Promise<getAccountActivitiesByTypeResponse>;
|
|
1119
|
+
export type listIRAExcessContritbutionsResponse200 = {
|
|
1120
|
+
data: OvercontributedIRAAccount[];
|
|
1121
|
+
status: 200;
|
|
1122
|
+
};
|
|
1123
|
+
export type listIRAExcessContritbutionsResponseDefault = {
|
|
1124
|
+
data: Error;
|
|
1125
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
1126
|
+
};
|
|
1127
|
+
export type listIRAExcessContritbutionsResponseSuccess = (listIRAExcessContritbutionsResponse200) & {
|
|
1128
|
+
headers: Headers;
|
|
1129
|
+
};
|
|
1130
|
+
export type listIRAExcessContritbutionsResponseError = (listIRAExcessContritbutionsResponseDefault) & {
|
|
1131
|
+
headers: Headers;
|
|
1132
|
+
};
|
|
1133
|
+
export type listIRAExcessContritbutionsResponse = (listIRAExcessContritbutionsResponseSuccess | listIRAExcessContritbutionsResponseError);
|
|
1134
|
+
export declare const getListIRAExcessContritbutionsUrl: () => string;
|
|
1135
|
+
/**
|
|
1136
|
+
* Returns all overcontributed IRA accounts
|
|
1137
|
+
* @summary Retrieve Excess Contributions
|
|
1138
|
+
*/
|
|
1139
|
+
export declare const listIRAExcessContritbutions: (options?: RequestInit) => Promise<listIRAExcessContritbutionsResponse>;
|
|
1140
|
+
export type requestListOptionsApprovalsResponse200 = {
|
|
1141
|
+
data: OptionsApprovalsList;
|
|
1142
|
+
status: 200;
|
|
1143
|
+
};
|
|
1144
|
+
export type requestListOptionsApprovalsResponse400 = {
|
|
1145
|
+
data: Error;
|
|
1146
|
+
status: 400;
|
|
1147
|
+
};
|
|
1148
|
+
export type requestListOptionsApprovalsResponse401 = {
|
|
1149
|
+
data: Error;
|
|
1150
|
+
status: 401;
|
|
1151
|
+
};
|
|
1152
|
+
export type requestListOptionsApprovalsResponse403 = {
|
|
1153
|
+
data: Error;
|
|
1154
|
+
status: 403;
|
|
1155
|
+
};
|
|
1156
|
+
export type requestListOptionsApprovalsResponseSuccess = (requestListOptionsApprovalsResponse200) & {
|
|
1157
|
+
headers: Headers;
|
|
1158
|
+
};
|
|
1159
|
+
export type requestListOptionsApprovalsResponseError = (requestListOptionsApprovalsResponse400 | requestListOptionsApprovalsResponse401 | requestListOptionsApprovalsResponse403) & {
|
|
1160
|
+
headers: Headers;
|
|
1161
|
+
};
|
|
1162
|
+
export type requestListOptionsApprovalsResponse = (requestListOptionsApprovalsResponseSuccess | requestListOptionsApprovalsResponseError);
|
|
1163
|
+
export declare const getRequestListOptionsApprovalsUrl: (params?: RequestListOptionsApprovalsParams) => string;
|
|
1164
|
+
/**
|
|
1165
|
+
* This endpoint retrieves options trading level approval requests. Query parameters can be specified to filter the results. If multiple query parameters are specified, the results will be filtered to include only those that match all of the specified parameters. Each query parameter can only be specified once.
|
|
1166
|
+
* @summary Retrieve options level approval requests (BETA)
|
|
1167
|
+
*/
|
|
1168
|
+
export declare const requestListOptionsApprovals: (params?: RequestListOptionsApprovalsParams, options?: RequestInit) => Promise<requestListOptionsApprovalsResponse>;
|
|
1169
|
+
export type getV1AccountsPositionsResponse200 = {
|
|
1170
|
+
data: GetV1AccountsPositions200;
|
|
1171
|
+
status: 200;
|
|
1172
|
+
};
|
|
1173
|
+
export type getV1AccountsPositionsResponseSuccess = (getV1AccountsPositionsResponse200) & {
|
|
1174
|
+
headers: Headers;
|
|
1175
|
+
};
|
|
1176
|
+
export type getV1AccountsPositionsResponse = (getV1AccountsPositionsResponseSuccess);
|
|
1177
|
+
export declare const getGetV1AccountsPositionsUrl: (params?: GetV1AccountsPositionsParams) => string;
|
|
1178
|
+
/**
|
|
1179
|
+
* Retrieves a list of the account's open positions.
|
|
1180
|
+
* This endpoint is deprecated and will be removed in the future. Please use the [GET /v1/reporting/eod/positions endpoint](https://docs.alpaca.markets/reference/get-v1-reporting-eod-positions) instead.
|
|
1181
|
+
* @deprecated
|
|
1182
|
+
* @summary Bulk Fetch All Accounts Positions
|
|
1183
|
+
*/
|
|
1184
|
+
export declare const getV1AccountsPositions: (params?: GetV1AccountsPositionsParams, options?: RequestInit) => Promise<getV1AccountsPositionsResponse>;
|
|
1185
|
+
export type getAssetsResponse200 = {
|
|
1186
|
+
data: Asset[];
|
|
1187
|
+
status: 200;
|
|
1188
|
+
};
|
|
1189
|
+
export type getAssetsResponseSuccess = (getAssetsResponse200) & {
|
|
1190
|
+
headers: Headers;
|
|
1191
|
+
};
|
|
1192
|
+
export type getAssetsResponse = (getAssetsResponseSuccess);
|
|
1193
|
+
export declare const getGetAssetsUrl: (params?: GetAssetsParams) => string;
|
|
1194
|
+
/**
|
|
1195
|
+
* Returns all assets
|
|
1196
|
+
* @summary Retrieve All Assets
|
|
1197
|
+
*/
|
|
1198
|
+
export declare const getAssets: (params?: GetAssetsParams, options?: RequestInit) => Promise<getAssetsResponse>;
|
|
1199
|
+
export type getAssetBySymbolOrIdResponse200 = {
|
|
1200
|
+
data: Asset;
|
|
1201
|
+
status: 200;
|
|
1202
|
+
};
|
|
1203
|
+
export type getAssetBySymbolOrIdResponse404 = {
|
|
1204
|
+
data: void;
|
|
1205
|
+
status: 404;
|
|
1206
|
+
};
|
|
1207
|
+
export type getAssetBySymbolOrIdResponseSuccess = (getAssetBySymbolOrIdResponse200) & {
|
|
1208
|
+
headers: Headers;
|
|
1209
|
+
};
|
|
1210
|
+
export type getAssetBySymbolOrIdResponseError = (getAssetBySymbolOrIdResponse404) & {
|
|
1211
|
+
headers: Headers;
|
|
1212
|
+
};
|
|
1213
|
+
export type getAssetBySymbolOrIdResponse = (getAssetBySymbolOrIdResponseSuccess | getAssetBySymbolOrIdResponseError);
|
|
1214
|
+
export declare const getGetAssetBySymbolOrIdUrl: (symbolOrAssetId: string) => string;
|
|
1215
|
+
/**
|
|
1216
|
+
* Returns the requested asset, if found
|
|
1217
|
+
* @summary Retrieve an Asset by ID
|
|
1218
|
+
*/
|
|
1219
|
+
export declare const getAssetBySymbolOrId: (symbolOrAssetId: string, options?: RequestInit) => Promise<getAssetBySymbolOrIdResponse>;
|
|
1220
|
+
export type getAssetEntryRequirementsResponse200 = {
|
|
1221
|
+
data: AssetEntryRequirements[];
|
|
1222
|
+
status: 200;
|
|
1223
|
+
};
|
|
1224
|
+
export type getAssetEntryRequirementsResponseSuccess = (getAssetEntryRequirementsResponse200) & {
|
|
1225
|
+
headers: Headers;
|
|
1226
|
+
};
|
|
1227
|
+
export type getAssetEntryRequirementsResponse = (getAssetEntryRequirementsResponseSuccess);
|
|
1228
|
+
export declare const getGetAssetEntryRequirementsUrl: (params: GetAssetEntryRequirementsParams) => string;
|
|
1229
|
+
/**
|
|
1230
|
+
* Returns all entry-requirements
|
|
1231
|
+
* @summary Retrieve Entry Requirements for requested assets
|
|
1232
|
+
*/
|
|
1233
|
+
export declare const getAssetEntryRequirements: (params: GetAssetEntryRequirementsParams, options?: RequestInit) => Promise<getAssetEntryRequirementsResponse>;
|
|
1234
|
+
export type usCorporatesResponse200 = {
|
|
1235
|
+
data: UsCorporatesResp;
|
|
1236
|
+
status: 200;
|
|
1237
|
+
};
|
|
1238
|
+
export type usCorporatesResponse400 = {
|
|
1239
|
+
data: N400Response;
|
|
1240
|
+
status: 400;
|
|
1241
|
+
};
|
|
1242
|
+
export type usCorporatesResponse401 = {
|
|
1243
|
+
data: N401Response;
|
|
1244
|
+
status: 401;
|
|
1245
|
+
};
|
|
1246
|
+
export type usCorporatesResponse403 = {
|
|
1247
|
+
data: N403Response;
|
|
1248
|
+
status: 403;
|
|
1249
|
+
};
|
|
1250
|
+
export type usCorporatesResponse429 = {
|
|
1251
|
+
data: N429Response;
|
|
1252
|
+
status: 429;
|
|
1253
|
+
};
|
|
1254
|
+
export type usCorporatesResponse500 = {
|
|
1255
|
+
data: N500Response;
|
|
1256
|
+
status: 500;
|
|
1257
|
+
};
|
|
1258
|
+
export type usCorporatesResponseSuccess = (usCorporatesResponse200) & {
|
|
1259
|
+
headers: Headers;
|
|
1260
|
+
};
|
|
1261
|
+
export type usCorporatesResponseError = (usCorporatesResponse400 | usCorporatesResponse401 | usCorporatesResponse403 | usCorporatesResponse429 | usCorporatesResponse500) & {
|
|
1262
|
+
headers: Headers;
|
|
1263
|
+
};
|
|
1264
|
+
export type usCorporatesResponse = (usCorporatesResponseSuccess | usCorporatesResponseError);
|
|
1265
|
+
export declare const getUsCorporatesUrl: (params?: UsCorporatesParams) => string;
|
|
1266
|
+
/**
|
|
1267
|
+
* Serves the list of US corporates available at Alpaca. The response is sorted by ISIN.
|
|
1268
|
+
* @summary Get US corporates
|
|
1269
|
+
*/
|
|
1270
|
+
export declare const usCorporates: (params?: UsCorporatesParams, options?: RequestInit) => Promise<usCorporatesResponse>;
|
|
1271
|
+
export type usTreasuriesResponse200 = {
|
|
1272
|
+
data: UsTreasuriesResp;
|
|
1273
|
+
status: 200;
|
|
1274
|
+
};
|
|
1275
|
+
export type usTreasuriesResponse400 = {
|
|
1276
|
+
data: N400Response;
|
|
1277
|
+
status: 400;
|
|
1278
|
+
};
|
|
1279
|
+
export type usTreasuriesResponse403 = {
|
|
1280
|
+
data: N403Response;
|
|
1281
|
+
status: 403;
|
|
1282
|
+
};
|
|
1283
|
+
export type usTreasuriesResponse429 = {
|
|
1284
|
+
data: N429Response;
|
|
1285
|
+
status: 429;
|
|
1286
|
+
};
|
|
1287
|
+
export type usTreasuriesResponse500 = {
|
|
1288
|
+
data: N500Response;
|
|
1289
|
+
status: 500;
|
|
1290
|
+
};
|
|
1291
|
+
export type usTreasuriesResponseSuccess = (usTreasuriesResponse200) & {
|
|
1292
|
+
headers: Headers;
|
|
1293
|
+
};
|
|
1294
|
+
export type usTreasuriesResponseError = (usTreasuriesResponse400 | usTreasuriesResponse403 | usTreasuriesResponse429 | usTreasuriesResponse500) & {
|
|
1295
|
+
headers: Headers;
|
|
1296
|
+
};
|
|
1297
|
+
export type usTreasuriesResponse = (usTreasuriesResponseSuccess | usTreasuriesResponseError);
|
|
1298
|
+
export declare const getUsTreasuriesUrl: (params?: UsTreasuriesParams) => string;
|
|
1299
|
+
/**
|
|
1300
|
+
* Serves the list of US treasuries available at Alpaca. The response is sorted by ISIN.
|
|
1301
|
+
* @summary Get US treasuries
|
|
1302
|
+
*/
|
|
1303
|
+
export declare const usTreasuries: (params?: UsTreasuriesParams, options?: RequestInit) => Promise<usTreasuriesResponse>;
|
|
1304
|
+
export type legacyCalendarResponse200 = {
|
|
1305
|
+
data: LegacyPublicCalendarResp;
|
|
1306
|
+
status: 200;
|
|
1307
|
+
};
|
|
1308
|
+
export type legacyCalendarResponse400 = {
|
|
1309
|
+
data: N400Response;
|
|
1310
|
+
status: 400;
|
|
1311
|
+
};
|
|
1312
|
+
export type legacyCalendarResponse429 = {
|
|
1313
|
+
data: N429Response;
|
|
1314
|
+
status: 429;
|
|
1315
|
+
};
|
|
1316
|
+
export type legacyCalendarResponse500 = {
|
|
1317
|
+
data: N500Response;
|
|
1318
|
+
status: 500;
|
|
1319
|
+
};
|
|
1320
|
+
export type legacyCalendarResponseSuccess = (legacyCalendarResponse200) & {
|
|
1321
|
+
headers: Headers;
|
|
1322
|
+
};
|
|
1323
|
+
export type legacyCalendarResponseError = (legacyCalendarResponse400 | legacyCalendarResponse429 | legacyCalendarResponse500) & {
|
|
1324
|
+
headers: Headers;
|
|
1325
|
+
};
|
|
1326
|
+
export type legacyCalendarResponse = (legacyCalendarResponseSuccess | legacyCalendarResponseError);
|
|
1327
|
+
export declare const getLegacyCalendarUrl: (params?: LegacyCalendarParams) => string;
|
|
1328
|
+
/**
|
|
1329
|
+
* The calendar API serves the full list of market days from 1970 to 2029. It can also be queried by specifying a start and/or end time to narrow down the results. In addition to the dates, the response also contains the specific open and close times for the market days, taking into account early closures.
|
|
1330
|
+
* @summary Get US Market Calendar
|
|
1331
|
+
*/
|
|
1332
|
+
export declare const legacyCalendar: (params?: LegacyCalendarParams, options?: RequestInit) => Promise<legacyCalendarResponse>;
|
|
1333
|
+
export type getV1ListAprTiersResponse200 = {
|
|
1334
|
+
data: ListAPRTiersResponse;
|
|
1335
|
+
status: 200;
|
|
1336
|
+
};
|
|
1337
|
+
export type getV1ListAprTiersResponse401 = {
|
|
1338
|
+
data: Error;
|
|
1339
|
+
status: 401;
|
|
1340
|
+
};
|
|
1341
|
+
export type getV1ListAprTiersResponse429 = {
|
|
1342
|
+
data: Error;
|
|
1343
|
+
status: 429;
|
|
1344
|
+
};
|
|
1345
|
+
export type getV1ListAprTiersResponse500 = {
|
|
1346
|
+
data: Error;
|
|
1347
|
+
status: 500;
|
|
1348
|
+
};
|
|
1349
|
+
export type getV1ListAprTiersResponseSuccess = (getV1ListAprTiersResponse200) & {
|
|
1350
|
+
headers: Headers;
|
|
1351
|
+
};
|
|
1352
|
+
export type getV1ListAprTiersResponseError = (getV1ListAprTiersResponse401 | getV1ListAprTiersResponse429 | getV1ListAprTiersResponse500) & {
|
|
1353
|
+
headers: Headers;
|
|
1354
|
+
};
|
|
1355
|
+
export type getV1ListAprTiersResponse = (getV1ListAprTiersResponseSuccess | getV1ListAprTiersResponseError);
|
|
1356
|
+
export declare const getGetV1ListAprTiersUrl: () => string;
|
|
1357
|
+
/**
|
|
1358
|
+
* List all available APR tiers. These tiers may be assigned to an account, and will be used to determine the interest rate paid on uninvested cash balances.
|
|
1359
|
+
* @summary List APR Tiers
|
|
1360
|
+
*/
|
|
1361
|
+
export declare const getV1ListAprTiers: (options?: RequestInit) => Promise<getV1ListAprTiersResponse>;
|
|
1362
|
+
export type legacyClockResponse200 = {
|
|
1363
|
+
data: LegacyClock;
|
|
1364
|
+
status: 200;
|
|
1365
|
+
};
|
|
1366
|
+
export type legacyClockResponse429 = {
|
|
1367
|
+
data: N429Response;
|
|
1368
|
+
status: 429;
|
|
1369
|
+
};
|
|
1370
|
+
export type legacyClockResponse500 = {
|
|
1371
|
+
data: N500Response;
|
|
1372
|
+
status: 500;
|
|
1373
|
+
};
|
|
1374
|
+
export type legacyClockResponseSuccess = (legacyClockResponse200) & {
|
|
1375
|
+
headers: Headers;
|
|
1376
|
+
};
|
|
1377
|
+
export type legacyClockResponseError = (legacyClockResponse429 | legacyClockResponse500) & {
|
|
1378
|
+
headers: Headers;
|
|
1379
|
+
};
|
|
1380
|
+
export type legacyClockResponse = (legacyClockResponseSuccess | legacyClockResponseError);
|
|
1381
|
+
export declare const getLegacyClockUrl: () => string;
|
|
1382
|
+
/**
|
|
1383
|
+
* The clock API serves the current market timestamp, whether or not the market is currently open, as well as the times of the next market open and close.
|
|
1384
|
+
* @summary Get US Market Clock
|
|
1385
|
+
*/
|
|
1386
|
+
export declare const legacyClock: (options?: RequestInit) => Promise<legacyClockResponse>;
|
|
1387
|
+
export type getCorporateAnnouncementsResponse200 = {
|
|
1388
|
+
data: Announcement[];
|
|
1389
|
+
status: 200;
|
|
1390
|
+
};
|
|
1391
|
+
export type getCorporateAnnouncementsResponse400 = {
|
|
1392
|
+
data: BadRequestResponse;
|
|
1393
|
+
status: 400;
|
|
1394
|
+
};
|
|
1395
|
+
export type getCorporateAnnouncementsResponseSuccess = (getCorporateAnnouncementsResponse200) & {
|
|
1396
|
+
headers: Headers;
|
|
1397
|
+
};
|
|
1398
|
+
export type getCorporateAnnouncementsResponseError = (getCorporateAnnouncementsResponse400) & {
|
|
1399
|
+
headers: Headers;
|
|
1400
|
+
};
|
|
1401
|
+
export type getCorporateAnnouncementsResponse = (getCorporateAnnouncementsResponseSuccess | getCorporateAnnouncementsResponseError);
|
|
1402
|
+
export declare const getGetCorporateAnnouncementsUrl: (params: GetCorporateAnnouncementsParams) => string;
|
|
1403
|
+
/**
|
|
1404
|
+
* This endpoint is deprecated, please use [the new corporate actions endpoint](https://docs.alpaca.markets/reference/corporateactions-1) instead.
|
|
1405
|
+
* @deprecated
|
|
1406
|
+
* @summary Retrieve Announcements
|
|
1407
|
+
*/
|
|
1408
|
+
export declare const getCorporateAnnouncements: (params: GetCorporateAnnouncementsParams, options?: RequestInit) => Promise<getCorporateAnnouncementsResponse>;
|
|
1409
|
+
export type getGETV1CorporateActionsAnnouncementsIdResponse200 = {
|
|
1410
|
+
data: void;
|
|
1411
|
+
status: 200;
|
|
1412
|
+
};
|
|
1413
|
+
export type getGETV1CorporateActionsAnnouncementsIdResponse400 = {
|
|
1414
|
+
data: void;
|
|
1415
|
+
status: 400;
|
|
1416
|
+
};
|
|
1417
|
+
export type getGETV1CorporateActionsAnnouncementsIdResponse422 = {
|
|
1418
|
+
data: void;
|
|
1419
|
+
status: 422;
|
|
1420
|
+
};
|
|
1421
|
+
export type getGETV1CorporateActionsAnnouncementsIdResponse500 = {
|
|
1422
|
+
data: void;
|
|
1423
|
+
status: 500;
|
|
1424
|
+
};
|
|
1425
|
+
export type getGETV1CorporateActionsAnnouncementsIdResponseSuccess = (getGETV1CorporateActionsAnnouncementsIdResponse200) & {
|
|
1426
|
+
headers: Headers;
|
|
1427
|
+
};
|
|
1428
|
+
export type getGETV1CorporateActionsAnnouncementsIdResponseError = (getGETV1CorporateActionsAnnouncementsIdResponse400 | getGETV1CorporateActionsAnnouncementsIdResponse422 | getGETV1CorporateActionsAnnouncementsIdResponse500) & {
|
|
1429
|
+
headers: Headers;
|
|
1430
|
+
};
|
|
1431
|
+
export type getGETV1CorporateActionsAnnouncementsIdResponse = (getGETV1CorporateActionsAnnouncementsIdResponseSuccess | getGETV1CorporateActionsAnnouncementsIdResponseError);
|
|
1432
|
+
export declare const getGetGETV1CorporateActionsAnnouncementsIdUrl: (id: string) => string;
|
|
1433
|
+
/**
|
|
1434
|
+
* This endpoint is deprecated, please use [the new corporate actions endpoint](https://docs.alpaca.markets/reference/corporateactions-1) instead.
|
|
1435
|
+
* @deprecated
|
|
1436
|
+
* @summary Retrieve a Specific Announcement
|
|
1437
|
+
*/
|
|
1438
|
+
export declare const getGETV1CorporateActionsAnnouncementsId: (id: string, options?: RequestInit) => Promise<getGETV1CorporateActionsAnnouncementsIdResponse>;
|
|
1439
|
+
export type queryCountryInfosResponse200 = {
|
|
1440
|
+
data: CountryInfos;
|
|
1441
|
+
status: 200;
|
|
1442
|
+
};
|
|
1443
|
+
export type queryCountryInfosResponseSuccess = (queryCountryInfosResponse200) & {
|
|
1444
|
+
headers: Headers;
|
|
1445
|
+
};
|
|
1446
|
+
export type queryCountryInfosResponse = (queryCountryInfosResponseSuccess);
|
|
1447
|
+
export declare const getQueryCountryInfosUrl: () => string;
|
|
1448
|
+
/**
|
|
1449
|
+
* The Country Info API serves country information for every supported countries including risk ratings and supported crypto states where applicable.
|
|
1450
|
+
* @summary Retrieve countries information
|
|
1451
|
+
*/
|
|
1452
|
+
export declare const queryCountryInfos: (options?: RequestInit) => Promise<queryCountryInfosResponse>;
|
|
1453
|
+
export type suscribeToAccountStatusSSEResponse200 = {
|
|
1454
|
+
data: AccountStatusEvent[];
|
|
1455
|
+
status: 200;
|
|
1456
|
+
};
|
|
1457
|
+
export type suscribeToAccountStatusSSEResponseSuccess = (suscribeToAccountStatusSSEResponse200) & {
|
|
1458
|
+
headers: Headers;
|
|
1459
|
+
};
|
|
1460
|
+
export type suscribeToAccountStatusSSEResponse = (suscribeToAccountStatusSSEResponseSuccess);
|
|
1461
|
+
export declare const getSuscribeToAccountStatusSSEUrl: (params?: SuscribeToAccountStatusSSEParams) => string;
|
|
1462
|
+
/**
|
|
1463
|
+
* The accounts events API provides streaming of account changes as they occur, via SSE (server sent events). Past events can also be queried.
|
|
1464
|
+
*
|
|
1465
|
+
* Events are generated for changes to the following account properties:
|
|
1466
|
+
* - account_blocked
|
|
1467
|
+
* - admin_configurations
|
|
1468
|
+
* - cash_interest
|
|
1469
|
+
* - crypto_status
|
|
1470
|
+
* - kyc_results
|
|
1471
|
+
* - options
|
|
1472
|
+
* - pattern_day_trader
|
|
1473
|
+
* - status
|
|
1474
|
+
* - trading_blocked
|
|
1475
|
+
*
|
|
1476
|
+
* Only the changed properties are included in the event payload.
|
|
1477
|
+
*
|
|
1478
|
+
* Query Parameter Rules:
|
|
1479
|
+
* - `since` is required if `until` specified
|
|
1480
|
+
* - `since_id` is required if `until_id` specified
|
|
1481
|
+
* - `since_ulid` is required if `until_ulid` specified
|
|
1482
|
+
* - `since`, `since_id` and `since_ulid` can't be used at the same time
|
|
1483
|
+
*
|
|
1484
|
+
* Behavior:
|
|
1485
|
+
* This API supports querying a range of events, starting now or in the past. If the end of the range is in the future or not specified, the connection is kept open and future events are pushed.
|
|
1486
|
+
*
|
|
1487
|
+
* To be specific:
|
|
1488
|
+
* - if `since`, `since_id` or `since_ulid` is not specified, this will not return any historic data
|
|
1489
|
+
* - if `until`, `until_id` or `until_ulid` is reached, the stream will end with a status of 200
|
|
1490
|
+
*
|
|
1491
|
+
* ---
|
|
1492
|
+
*
|
|
1493
|
+
* Note for people using the clients generated from this OAS spec. Currently OAS-3 doesn't have full support for representing SSE style responses from an API, so if you are using a generated client and don't specify a `since` and `until` there is a good chance the generated clients will hang waiting for the response to end.
|
|
1494
|
+
*
|
|
1495
|
+
* If you require the streaming capabilities we recommend not using the generated clients for this specific usecase until the OAS-3 standards come to a consensus on how to represent this correctly in OAS-3.
|
|
1496
|
+
* @summary Subscribe to Account Status Events (SSE)
|
|
1497
|
+
*/
|
|
1498
|
+
export declare const suscribeToAccountStatusSSE: (params?: SuscribeToAccountStatusSSEParams, options?: RequestInit) => Promise<suscribeToAccountStatusSSEResponse>;
|
|
1499
|
+
export type subscribeToJournalStatusSSEResponse200 = {
|
|
1500
|
+
data: JournalStatusEvent[];
|
|
1501
|
+
status: 200;
|
|
1502
|
+
};
|
|
1503
|
+
export type subscribeToJournalStatusSSEResponseSuccess = (subscribeToJournalStatusSSEResponse200) & {
|
|
1504
|
+
headers: Headers;
|
|
1505
|
+
};
|
|
1506
|
+
export type subscribeToJournalStatusSSEResponse = (subscribeToJournalStatusSSEResponseSuccess);
|
|
1507
|
+
export declare const getSubscribeToJournalStatusSSEUrl: (params?: SubscribeToJournalStatusSSEParams) => string;
|
|
1508
|
+
/**
|
|
1509
|
+
* The Events API provides event push as well as historical queries via SSE (server sent events).
|
|
1510
|
+
*
|
|
1511
|
+
* You can listen to journal status updates as they get processed by our backoffice.
|
|
1512
|
+
*
|
|
1513
|
+
* Historical events are streamed immediately if queried, and updates are pushed as events occur.
|
|
1514
|
+
*
|
|
1515
|
+
* Query Params Rules:
|
|
1516
|
+
* - `since` required if `until` specified
|
|
1517
|
+
* - `since_id` required if `until_id` specified
|
|
1518
|
+
* - `since_ulid` required if `until_ulid` specified
|
|
1519
|
+
* - `since`, `since_id` or `since_ulid` can't be used at the same time
|
|
1520
|
+
* Behavior:
|
|
1521
|
+
* - if `since`, `since_id` or `since_ulid` not specified this will not return any historic data
|
|
1522
|
+
* - if `until`, `until_id` or `until_ulid` reached stream will end (status 200)
|
|
1523
|
+
*
|
|
1524
|
+
* ---
|
|
1525
|
+
*
|
|
1526
|
+
* There is no compatibility between /v1/events/journals/status and /v2/events/journals/status, the ids (ulid) are always different, and the number of events might also different
|
|
1527
|
+
*
|
|
1528
|
+
* Please note that the new `/v2` endpoint, is the same as, and was originally available under `/v2beta1`.
|
|
1529
|
+
* We encourage all customers to adjust their codebase from that interim beta endpoint to the `/v2` stable endpoint.
|
|
1530
|
+
* In the near future we will setup permanent redirect from `/v2beta1` to `/v2` before we completely remove the beta endpoint.
|
|
1531
|
+
*
|
|
1532
|
+
* ---
|
|
1533
|
+
*
|
|
1534
|
+
* Note for people using the clients generated from this OAS spec. Currently OAS-3 doesn't have full support for representing SSE style responses from an API, so if you are using a generated client and don't specify a `since` and `until` there is a good chance the generated clients will hang waiting for the response to end.
|
|
1535
|
+
*
|
|
1536
|
+
* If you require the streaming capabilities we recommend not using the generated clients for this specific usecase until the OAS-3 standards come to a consensus on how to represent this correctly in OAS-3.
|
|
1537
|
+
* @summary Subscribe to Journal Events (SSE) (Legacy)
|
|
1538
|
+
*/
|
|
1539
|
+
export declare const subscribeToJournalStatusSSE: (params?: SubscribeToJournalStatusSSEParams, options?: RequestInit) => Promise<subscribeToJournalStatusSSEResponse>;
|
|
1540
|
+
export type getV1EventsNtaResponse200 = {
|
|
1541
|
+
data: NonTradeActivityEvent;
|
|
1542
|
+
status: 200;
|
|
1543
|
+
};
|
|
1544
|
+
export type getV1EventsNtaResponseSuccess = (getV1EventsNtaResponse200) & {
|
|
1545
|
+
headers: Headers;
|
|
1546
|
+
};
|
|
1547
|
+
export type getV1EventsNtaResponse = (getV1EventsNtaResponseSuccess);
|
|
1548
|
+
export declare const getGetV1EventsNtaUrl: (params?: GetV1EventsNtaParams) => string;
|
|
1549
|
+
/**
|
|
1550
|
+
* The Events API provides event push as well as historical queries via SSE (server sent events).
|
|
1551
|
+
*
|
|
1552
|
+
* You can listen to non-trading activities updates as they get processed by our backoffice, for both end-user and firm accounts.
|
|
1553
|
+
*
|
|
1554
|
+
* Historical events are streamed immediately if queried, and updates are pushed as events occur.
|
|
1555
|
+
*
|
|
1556
|
+
* You can listen to when NTAs are pushed such as CSDs, JNLC (journals) or FEEs.
|
|
1557
|
+
*
|
|
1558
|
+
* Query Params Rules:
|
|
1559
|
+
* - `since` required if `until` specified
|
|
1560
|
+
* - `since_id` required if `until_id` specified
|
|
1561
|
+
* - `since_ulid` required if `until_ulid` specified
|
|
1562
|
+
* - `since`, `since_id` or `since_ulid` can't be used at the same time
|
|
1563
|
+
* Behavior:
|
|
1564
|
+
* - if `since`, `since_id` or `since_ulid` not specified this will not return any historic data
|
|
1565
|
+
* - if `until`, `until_id` or `until_ulid` reached stream will end (status 200)'
|
|
1566
|
+
* @summary Subscribe to Non-Trading Activities Events (SSE)
|
|
1567
|
+
*/
|
|
1568
|
+
export declare const getV1EventsNta: (params?: GetV1EventsNtaParams, options?: RequestInit) => Promise<getV1EventsNtaResponse>;
|
|
1569
|
+
export type subscribeToTradeSSEResponse200 = {
|
|
1570
|
+
data: TradeUpdateEvent[];
|
|
1571
|
+
status: 200;
|
|
1572
|
+
};
|
|
1573
|
+
export type subscribeToTradeSSEResponse410 = {
|
|
1574
|
+
data: void;
|
|
1575
|
+
status: 410;
|
|
1576
|
+
};
|
|
1577
|
+
export type subscribeToTradeSSEResponseSuccess = (subscribeToTradeSSEResponse200) & {
|
|
1578
|
+
headers: Headers;
|
|
1579
|
+
};
|
|
1580
|
+
export type subscribeToTradeSSEResponseError = (subscribeToTradeSSEResponse410) & {
|
|
1581
|
+
headers: Headers;
|
|
1582
|
+
};
|
|
1583
|
+
export type subscribeToTradeSSEResponse = (subscribeToTradeSSEResponseSuccess | subscribeToTradeSSEResponseError);
|
|
1584
|
+
export declare const getSubscribeToTradeSSEUrl: (params?: SubscribeToTradeSSEParams) => string;
|
|
1585
|
+
/**
|
|
1586
|
+
* **Deprecation notice**
|
|
1587
|
+
*
|
|
1588
|
+
* As part of the deprecation process, the legacy trade events API is now only available for existing broker-partners at: `GET /v1/events/trades` only for compatibility reasons.
|
|
1589
|
+
*
|
|
1590
|
+
* All new broker partners will not have the option for the legacy trade event endpoint.
|
|
1591
|
+
*
|
|
1592
|
+
* All new broker partners will have to integrate with the new `/v2/events/trades` endpoint.
|
|
1593
|
+
*
|
|
1594
|
+
* Also, all existing broker partners are now recommended to upgrade to the `/v2/events/trades` endpoint, which provides faster event delivery times.
|
|
1595
|
+
*
|
|
1596
|
+
* For trade events of MLeg (multi-leg) order, please use the `/v2/events/trades` endpoint.
|
|
1597
|
+
*
|
|
1598
|
+
* Please note that the new `/v2` endpoint, is the same as, and was originally available under `/v2beta1`.
|
|
1599
|
+
* We encourage all customers to adjust their codebase from that interim beta endpoint to the `/v2` stable endpoint.
|
|
1600
|
+
* In the near future we will setup permanent redirect from `/v2beta1` to `/v2` before we completely remove the beta endpoint.
|
|
1601
|
+
*
|
|
1602
|
+
* ---
|
|
1603
|
+
*
|
|
1604
|
+
* The Events API provides event push as well as historical queries via SSE (server sent events).
|
|
1605
|
+
*
|
|
1606
|
+
* You can listen to events related to trade updates. Most market trades sent during market hours are filled instantly; you can listen to limit order updates through this endpoint.
|
|
1607
|
+
*
|
|
1608
|
+
* Historical events are streamed immediately if queried, and updates are pushed as events occur.
|
|
1609
|
+
*
|
|
1610
|
+
* Query Params Rules:
|
|
1611
|
+
* - `since` required if `until` specified
|
|
1612
|
+
* - `since_id` required if `until_id` specified
|
|
1613
|
+
* - `since_ulid` required if `until_ulid` specified
|
|
1614
|
+
* - `since`, `since_id` or `since_ulid` can't be used at the same time
|
|
1615
|
+
* Behavior:
|
|
1616
|
+
* - if `since`, `since_id` or `since_ulid` not specified this will not return any historic data
|
|
1617
|
+
* - if `until`, `until_id` or `until_ulid` reached stream will end (status 200)
|
|
1618
|
+
*
|
|
1619
|
+
* ---
|
|
1620
|
+
*
|
|
1621
|
+
* Note for people using the clients generated from this OAS spec. Currently OAS-3 doesn't have full support for representing SSE style responses from an API, so if you are using a generated client and don't specify a `since` and `until` there is a good chance the generated clients will hang waiting for the response to end.
|
|
1622
|
+
*
|
|
1623
|
+
* If you require the streaming capabilities we recommend not using the generated clients for this specific usecase until the OAS-3 standards come to a consensus on how to represent this correctly in OAS-3.
|
|
1624
|
+
*
|
|
1625
|
+
* ---
|
|
1626
|
+
*
|
|
1627
|
+
* **Deprecation note**
|
|
1628
|
+
*
|
|
1629
|
+
* Legacy event id (integer based) is unavailable for new broker partners, and it will be deprecated for existing brokers as well.
|
|
1630
|
+
* This deprecation is includes the `since_id` and `until_id` query parameter and the `event_id` field in the response.
|
|
1631
|
+
*
|
|
1632
|
+
* ---
|
|
1633
|
+
*
|
|
1634
|
+
* **Common events**
|
|
1635
|
+
*
|
|
1636
|
+
* These are the events that are the expected results of actions you may have taken by sending API requests.
|
|
1637
|
+
*
|
|
1638
|
+
* The meaning of the timestamp field changes for each type; the meanings have been specified here for which types the timestamp field will be present.
|
|
1639
|
+
*
|
|
1640
|
+
* - `accepted` Sent when an order is received and accepted by Alpaca
|
|
1641
|
+
* - `pending_new` Sent when the order has been received by Alpaca and routed to the exchanges, but has not yet been accepted for execution.
|
|
1642
|
+
* - `new` Sent when an order has been routed to exchanges for execution.
|
|
1643
|
+
* - `fill` Sent when your order has been completely filled.
|
|
1644
|
+
* - timestamp: The time at which the order was filled.
|
|
1645
|
+
* - `partial_fill` Sent when a number of shares less than the total remaining quantity on your order has been filled.
|
|
1646
|
+
* - timestamp: The time at which the shares were filled.
|
|
1647
|
+
* - `canceled` Sent when your requested cancellation of an order is processed.
|
|
1648
|
+
* - timestamp: The time at which the order was canceled.
|
|
1649
|
+
* - `expired` Sent when an order has reached the end of its lifespan, as determined by the order's time in force value.
|
|
1650
|
+
* - timestamp: The time at which the order expired.
|
|
1651
|
+
* - `done_for_day` Sent when the order is done executing for the day, and will not receive further updates until the next trading day.
|
|
1652
|
+
* - `replaced` Sent when your requested replacement of an order is processed.
|
|
1653
|
+
* - timestamp: The time at which the order was replaced.
|
|
1654
|
+
*
|
|
1655
|
+
* **Rarer events**
|
|
1656
|
+
*
|
|
1657
|
+
* These are events that may rarely be sent due to unexpected circumstances on the exchanges. It is unlikely you will need to design your code around them, but you may still wish to account for the possibility that they will occur.
|
|
1658
|
+
*
|
|
1659
|
+
* - `rejected` Sent when your order has been rejected.
|
|
1660
|
+
* - `held` For multi-leg orders, the secondary orders (stop loss, take profit) will enter this state while waiting to be triggered.
|
|
1661
|
+
* - `stopped` Sent when your order has been stopped, and a trade is guaranteed for the order, usually at a stated price or better, but has not yet occurred.
|
|
1662
|
+
* - `pending_cancel` Sent when the order is awaiting cancellation. Most cancellations will occur without the order entering this state.
|
|
1663
|
+
* - `pending_replace` Sent when the order is awaiting replacement.
|
|
1664
|
+
* - `calculated` Sent when the order has been completed for the day - it is either filled or done_for_day - but remaining settlement calculations are still pending.
|
|
1665
|
+
* - `suspended` Sent when the order has been suspended and is not eligible for trading.
|
|
1666
|
+
* - `order_replace_rejected` Sent when the order replace has been rejected.
|
|
1667
|
+
* - `order_cancel_rejected` Sent when the order cancel has been rejected.
|
|
1668
|
+
* - `trade_bust`: Sent when a previously reported execution has been canceled ("busted") by the upstream exchange.
|
|
1669
|
+
* - `trade_correct`: Sent when a previously reported trade has been corrected. For example, the exchange may have updated the price, quantity, or another execution parameter after the trade was initially reported.
|
|
1670
|
+
* @deprecated
|
|
1671
|
+
* @summary Subscribe to Trade Events (SSE) (Legacy)
|
|
1672
|
+
*/
|
|
1673
|
+
export declare const subscribeToTradeSSE: (params?: SubscribeToTradeSSEParams, options?: RequestInit) => Promise<subscribeToTradeSSEResponse>;
|
|
1674
|
+
export type subscribeToTransferStatusSSEResponse200 = {
|
|
1675
|
+
data: TransferStatusEvent[];
|
|
1676
|
+
status: 200;
|
|
1677
|
+
};
|
|
1678
|
+
export type subscribeToTransferStatusSSEResponse410 = {
|
|
1679
|
+
data: void;
|
|
1680
|
+
status: 410;
|
|
1681
|
+
};
|
|
1682
|
+
export type subscribeToTransferStatusSSEResponseSuccess = (subscribeToTransferStatusSSEResponse200) & {
|
|
1683
|
+
headers: Headers;
|
|
1684
|
+
};
|
|
1685
|
+
export type subscribeToTransferStatusSSEResponseError = (subscribeToTransferStatusSSEResponse410) & {
|
|
1686
|
+
headers: Headers;
|
|
1687
|
+
};
|
|
1688
|
+
export type subscribeToTransferStatusSSEResponse = (subscribeToTransferStatusSSEResponseSuccess | subscribeToTransferStatusSSEResponseError);
|
|
1689
|
+
export declare const getSubscribeToTransferStatusSSEUrl: (params?: SubscribeToTransferStatusSSEParams) => string;
|
|
1690
|
+
/**
|
|
1691
|
+
* **Deprecation notice**
|
|
1692
|
+
*
|
|
1693
|
+
* As part of the deprecation process, the legacy transfer events API is now only available for existing broker-partners at `GET /v1/events/transfers/status` and for compatibility reasons.
|
|
1694
|
+
*
|
|
1695
|
+
* All new broker partners will not have the option to use the legacy transfer events endpoint.
|
|
1696
|
+
*
|
|
1697
|
+
* They should integrate with the new `/v2/events/funding/status` endpoint instead.
|
|
1698
|
+
*
|
|
1699
|
+
* Also, all existing broker partners are now recommended to upgrade to the `/v2/events/funding/status` endpoint, which provides faster event delivery times.
|
|
1700
|
+
*
|
|
1701
|
+
* ---
|
|
1702
|
+
*
|
|
1703
|
+
* The Events API provides event push as well as historical queries via SSE (server sent events).
|
|
1704
|
+
*
|
|
1705
|
+
* You can listen to transfer status updates as they get processed by our backoffice, for both end-user and firm accounts.
|
|
1706
|
+
*
|
|
1707
|
+
* Historical events are streamed immediately if queried, and updates are pushed as events occur.
|
|
1708
|
+
*
|
|
1709
|
+
* Query Params Rules:
|
|
1710
|
+
* - `since` required if `until` specified
|
|
1711
|
+
* - `since_id` required if `until_id` specified
|
|
1712
|
+
* - `since_ulid` required if `until_ulid` specified
|
|
1713
|
+
* - `since`, `since_id` or `since_ulid` can't be used at the same time
|
|
1714
|
+
* Behavior:
|
|
1715
|
+
* - if `since`, `since_id` or `since_ulid` not specified this will not return any historic data
|
|
1716
|
+
* - if `until`, `until_id` or `until_ulid` reached stream will end (status 200)
|
|
1717
|
+
*
|
|
1718
|
+
* ---
|
|
1719
|
+
*
|
|
1720
|
+
* Note for people using the clients generated from this OAS spec. Currently OAS-3 doesn't have full support for representing SSE style responses from an API, so if you are using a generated client and don't specify a `since` and `until` there is a good chance the generated clients will hang waiting for the response to end.
|
|
1721
|
+
*
|
|
1722
|
+
* If you require the streaming capabilities we recommend not using the generated clients for this specific usecase until the OAS-3 standards come to a consensus on how to represent this correctly in OAS-3.
|
|
1723
|
+
* @deprecated
|
|
1724
|
+
* @summary Subscribe to Transfer Events (SSE) (Legacy)
|
|
1725
|
+
*/
|
|
1726
|
+
export declare const subscribeToTransferStatusSSE: (params?: SubscribeToTransferStatusSSEParams, options?: RequestInit) => Promise<subscribeToTransferStatusSSEResponse>;
|
|
1727
|
+
export type getV1FpslAnalyticsAccountLoansResponse200 = {
|
|
1728
|
+
data: FPSLAnalyticsLoansResponse;
|
|
1729
|
+
status: 200;
|
|
1730
|
+
};
|
|
1731
|
+
export type getV1FpslAnalyticsAccountLoansResponse400 = {
|
|
1732
|
+
data: FPSLError;
|
|
1733
|
+
status: 400;
|
|
1734
|
+
};
|
|
1735
|
+
export type getV1FpslAnalyticsAccountLoansResponse401 = {
|
|
1736
|
+
data: FPSLError;
|
|
1737
|
+
status: 401;
|
|
1738
|
+
};
|
|
1739
|
+
export type getV1FpslAnalyticsAccountLoansResponse403 = {
|
|
1740
|
+
data: FPSLError;
|
|
1741
|
+
status: 403;
|
|
1742
|
+
};
|
|
1743
|
+
export type getV1FpslAnalyticsAccountLoansResponse500 = {
|
|
1744
|
+
data: FPSLError;
|
|
1745
|
+
status: 500;
|
|
1746
|
+
};
|
|
1747
|
+
export type getV1FpslAnalyticsAccountLoansResponseSuccess = (getV1FpslAnalyticsAccountLoansResponse200) & {
|
|
1748
|
+
headers: Headers;
|
|
1749
|
+
};
|
|
1750
|
+
export type getV1FpslAnalyticsAccountLoansResponseError = (getV1FpslAnalyticsAccountLoansResponse400 | getV1FpslAnalyticsAccountLoansResponse401 | getV1FpslAnalyticsAccountLoansResponse403 | getV1FpslAnalyticsAccountLoansResponse500) & {
|
|
1751
|
+
headers: Headers;
|
|
1752
|
+
};
|
|
1753
|
+
export type getV1FpslAnalyticsAccountLoansResponse = (getV1FpslAnalyticsAccountLoansResponseSuccess | getV1FpslAnalyticsAccountLoansResponseError);
|
|
1754
|
+
export declare const getGetV1FpslAnalyticsAccountLoansUrl: (accountId: string, params?: GetV1FpslAnalyticsAccountLoansParams) => string;
|
|
1755
|
+
/**
|
|
1756
|
+
* Returns aggregated FPSL interest and loan-activity counts for one account over a date range. Use this for "earned so far this month" customer UIs and for supervisory spot-checks against your internal accrual model.
|
|
1757
|
+
*
|
|
1758
|
+
* The `{account_id}` path parameter accepts a account UUID (aggregation for that account).
|
|
1759
|
+
* @summary Read FPSL Loans Analytics for an Account
|
|
1760
|
+
*/
|
|
1761
|
+
export declare const getV1FpslAnalyticsAccountLoans: (accountId: string, params?: GetV1FpslAnalyticsAccountLoansParams, options?: RequestInit) => Promise<getV1FpslAnalyticsAccountLoansResponse>;
|
|
1762
|
+
export type getV1ListFpslLoansResponse200 = {
|
|
1763
|
+
data: ListFPSLLoansResponse;
|
|
1764
|
+
status: 200;
|
|
1765
|
+
};
|
|
1766
|
+
export type getV1ListFpslLoansResponse400 = {
|
|
1767
|
+
data: FPSLError;
|
|
1768
|
+
status: 400;
|
|
1769
|
+
};
|
|
1770
|
+
export type getV1ListFpslLoansResponse401 = {
|
|
1771
|
+
data: FPSLError;
|
|
1772
|
+
status: 401;
|
|
1773
|
+
};
|
|
1774
|
+
export type getV1ListFpslLoansResponse403 = {
|
|
1775
|
+
data: FPSLError;
|
|
1776
|
+
status: 403;
|
|
1777
|
+
};
|
|
1778
|
+
export type getV1ListFpslLoansResponse500 = {
|
|
1779
|
+
data: FPSLError;
|
|
1780
|
+
status: 500;
|
|
1781
|
+
};
|
|
1782
|
+
export type getV1ListFpslLoansResponseSuccess = (getV1ListFpslLoansResponse200) & {
|
|
1783
|
+
headers: Headers;
|
|
1784
|
+
};
|
|
1785
|
+
export type getV1ListFpslLoansResponseError = (getV1ListFpslLoansResponse400 | getV1ListFpslLoansResponse401 | getV1ListFpslLoansResponse403 | getV1ListFpslLoansResponse500) & {
|
|
1786
|
+
headers: Headers;
|
|
1787
|
+
};
|
|
1788
|
+
export type getV1ListFpslLoansResponse = (getV1ListFpslLoansResponseSuccess | getV1ListFpslLoansResponseError);
|
|
1789
|
+
export declare const getGetV1ListFpslLoansUrl: (params?: GetV1ListFpslLoansParams) => string;
|
|
1790
|
+
/**
|
|
1791
|
+
* Returns a list of all FPSL loans that match the specified filter criteria, ordered in ascending order by `date`, `account_number`, and `symbol`. Each entry represents a loan of a `symbol` on a given `date`, made on behalf of the specified `account_number`.
|
|
1792
|
+
* @summary List FPSL Loans
|
|
1793
|
+
*/
|
|
1794
|
+
export declare const getV1ListFpslLoans: (params?: GetV1ListFpslLoansParams, options?: RequestInit) => Promise<getV1ListFpslLoansResponse>;
|
|
1795
|
+
export type getV1ListFpslTiersResponse200 = {
|
|
1796
|
+
data: FPSLTier[];
|
|
1797
|
+
status: 200;
|
|
1798
|
+
};
|
|
1799
|
+
export type getV1ListFpslTiersResponse401 = {
|
|
1800
|
+
data: Error;
|
|
1801
|
+
status: 401;
|
|
1802
|
+
};
|
|
1803
|
+
export type getV1ListFpslTiersResponse429 = {
|
|
1804
|
+
data: Error;
|
|
1805
|
+
status: 429;
|
|
1806
|
+
};
|
|
1807
|
+
export type getV1ListFpslTiersResponse500 = {
|
|
1808
|
+
data: Error;
|
|
1809
|
+
status: 500;
|
|
1810
|
+
};
|
|
1811
|
+
export type getV1ListFpslTiersResponseSuccess = (getV1ListFpslTiersResponse200) & {
|
|
1812
|
+
headers: Headers;
|
|
1813
|
+
};
|
|
1814
|
+
export type getV1ListFpslTiersResponseError = (getV1ListFpslTiersResponse401 | getV1ListFpslTiersResponse429 | getV1ListFpslTiersResponse500) & {
|
|
1815
|
+
headers: Headers;
|
|
1816
|
+
};
|
|
1817
|
+
export type getV1ListFpslTiersResponse = (getV1ListFpslTiersResponseSuccess | getV1ListFpslTiersResponseError);
|
|
1818
|
+
export declare const getGetV1ListFpslTiersUrl: () => string;
|
|
1819
|
+
/**
|
|
1820
|
+
* List all available FPSL tiers. These tiers may be assigned to an account.
|
|
1821
|
+
* @summary List FPSL Tiers
|
|
1822
|
+
*/
|
|
1823
|
+
export declare const getV1ListFpslTiers: (options?: RequestInit) => Promise<getV1ListFpslTiersResponse>;
|
|
1824
|
+
export type getV1InstantFundingListResponse200 = {
|
|
1825
|
+
data: InstantFunding[];
|
|
1826
|
+
status: 200;
|
|
1827
|
+
};
|
|
1828
|
+
export type getV1InstantFundingListResponseDefault = {
|
|
1829
|
+
data: Error;
|
|
1830
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
1831
|
+
};
|
|
1832
|
+
export type getV1InstantFundingListResponseSuccess = (getV1InstantFundingListResponse200) & {
|
|
1833
|
+
headers: Headers;
|
|
1834
|
+
};
|
|
1835
|
+
export type getV1InstantFundingListResponseError = (getV1InstantFundingListResponseDefault) & {
|
|
1836
|
+
headers: Headers;
|
|
1837
|
+
};
|
|
1838
|
+
export type getV1InstantFundingListResponse = (getV1InstantFundingListResponseSuccess | getV1InstantFundingListResponseError);
|
|
1839
|
+
export declare const getGetV1InstantFundingListUrl: (params?: GetV1InstantFundingListParams) => string;
|
|
1840
|
+
/**
|
|
1841
|
+
* Returns a list of instant funding records based on the query parameters. The results are
|
|
1842
|
+
* paginated, sorted, and filtered based on the parameters provided.
|
|
1843
|
+
* @summary Get Instant Funding List
|
|
1844
|
+
*/
|
|
1845
|
+
export declare const getV1InstantFundingList: (params?: GetV1InstantFundingListParams, options?: RequestInit) => Promise<getV1InstantFundingListResponse>;
|
|
1846
|
+
export type postV1InstantFundingResponse200 = {
|
|
1847
|
+
data: InstantFunding;
|
|
1848
|
+
status: 200;
|
|
1849
|
+
};
|
|
1850
|
+
export type postV1InstantFundingResponse422 = {
|
|
1851
|
+
data: Error;
|
|
1852
|
+
status: 422;
|
|
1853
|
+
};
|
|
1854
|
+
export type postV1InstantFundingResponseDefault = {
|
|
1855
|
+
data: Error;
|
|
1856
|
+
status: Exclude<HTTPStatusCodes, 200 | 422>;
|
|
1857
|
+
};
|
|
1858
|
+
export type postV1InstantFundingResponseSuccess = (postV1InstantFundingResponse200) & {
|
|
1859
|
+
headers: Headers;
|
|
1860
|
+
};
|
|
1861
|
+
export type postV1InstantFundingResponseError = (postV1InstantFundingResponse422 | postV1InstantFundingResponseDefault) & {
|
|
1862
|
+
headers: Headers;
|
|
1863
|
+
};
|
|
1864
|
+
export type postV1InstantFundingResponse = (postV1InstantFundingResponseSuccess | postV1InstantFundingResponseError);
|
|
1865
|
+
export declare const getPostV1InstantFundingUrl: () => string;
|
|
1866
|
+
/**
|
|
1867
|
+
* Creates an instant funding request. The request will be processed and the funds will be
|
|
1868
|
+
* made available to the account in the form of a Memopost non trade activity. Upon settlement
|
|
1869
|
+
* the Memoposted will be corrected to a CSD activity.
|
|
1870
|
+
*
|
|
1871
|
+
* **Idempotency**: When the `Idempotency-Key` header is supplied, this endpoint is
|
|
1872
|
+
* idempotent. Multiple requests with the same key and identical request body will
|
|
1873
|
+
* create only one transfer. A subsequent request returns the previously created
|
|
1874
|
+
* transfer with the same response (no duplicate is created). If the same key is used
|
|
1875
|
+
* with a different request body, the API returns `422 Unprocessable Entity`.
|
|
1876
|
+
*
|
|
1877
|
+
* **Recommended for production**: Always supply `Idempotency-Key` when creating
|
|
1878
|
+
* transfers. This allows safe retries on timeouts, network errors, or 5xx responses
|
|
1879
|
+
* without risking duplicate transfers. Use a client-generated unique value (e.g. UUID).
|
|
1880
|
+
* @summary Create an instant funding request
|
|
1881
|
+
*/
|
|
1882
|
+
export declare const postV1InstantFunding: (createIFTransferRequest: CreateIFTransferRequest, options?: RequestInit) => Promise<postV1InstantFundingResponse>;
|
|
1883
|
+
export type deleteV1InstantFundingSingleResponse204 = {
|
|
1884
|
+
data: void;
|
|
1885
|
+
status: 204;
|
|
1886
|
+
};
|
|
1887
|
+
export type deleteV1InstantFundingSingleResponseDefault = {
|
|
1888
|
+
data: Error;
|
|
1889
|
+
status: Exclude<HTTPStatusCodes, 204>;
|
|
1890
|
+
};
|
|
1891
|
+
export type deleteV1InstantFundingSingleResponseSuccess = (deleteV1InstantFundingSingleResponse204) & {
|
|
1892
|
+
headers: Headers;
|
|
1893
|
+
};
|
|
1894
|
+
export type deleteV1InstantFundingSingleResponseError = (deleteV1InstantFundingSingleResponseDefault) & {
|
|
1895
|
+
headers: Headers;
|
|
1896
|
+
};
|
|
1897
|
+
export type deleteV1InstantFundingSingleResponse = (deleteV1InstantFundingSingleResponseSuccess | deleteV1InstantFundingSingleResponseError);
|
|
1898
|
+
export declare const getDeleteV1InstantFundingSingleUrl: (instantFundingId: string) => string;
|
|
1899
|
+
/**
|
|
1900
|
+
* Cancels a single instant funding request based on the ID supplied if possible.
|
|
1901
|
+
* @summary Cancel an instant funding request
|
|
1902
|
+
*/
|
|
1903
|
+
export declare const deleteV1InstantFundingSingle: (instantFundingId: string, options?: RequestInit) => Promise<deleteV1InstantFundingSingleResponse>;
|
|
1904
|
+
export type getV1InstantFundingSingleResponse200 = {
|
|
1905
|
+
data: InstantFunding;
|
|
1906
|
+
status: 200;
|
|
1907
|
+
};
|
|
1908
|
+
export type getV1InstantFundingSingleResponseDefault = {
|
|
1909
|
+
data: Error;
|
|
1910
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
1911
|
+
};
|
|
1912
|
+
export type getV1InstantFundingSingleResponseSuccess = (getV1InstantFundingSingleResponse200) & {
|
|
1913
|
+
headers: Headers;
|
|
1914
|
+
};
|
|
1915
|
+
export type getV1InstantFundingSingleResponseError = (getV1InstantFundingSingleResponseDefault) & {
|
|
1916
|
+
headers: Headers;
|
|
1917
|
+
};
|
|
1918
|
+
export type getV1InstantFundingSingleResponse = (getV1InstantFundingSingleResponseSuccess | getV1InstantFundingSingleResponseError);
|
|
1919
|
+
export declare const getGetV1InstantFundingSingleUrl: (instantFundingId: string) => string;
|
|
1920
|
+
/**
|
|
1921
|
+
* Returns an instant funding transfer based on the ID supplied.
|
|
1922
|
+
* @summary Get an instant funding request
|
|
1923
|
+
*/
|
|
1924
|
+
export declare const getV1InstantFundingSingle: (instantFundingId: string, options?: RequestInit) => Promise<getV1InstantFundingSingleResponse>;
|
|
1925
|
+
export type getV1InstantFundingCorrespondentLimitsResponse200 = {
|
|
1926
|
+
data: CorrespondentLimit;
|
|
1927
|
+
status: 200;
|
|
1928
|
+
};
|
|
1929
|
+
export type getV1InstantFundingCorrespondentLimitsResponseDefault = {
|
|
1930
|
+
data: Error;
|
|
1931
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
1932
|
+
};
|
|
1933
|
+
export type getV1InstantFundingCorrespondentLimitsResponseSuccess = (getV1InstantFundingCorrespondentLimitsResponse200) & {
|
|
1934
|
+
headers: Headers;
|
|
1935
|
+
};
|
|
1936
|
+
export type getV1InstantFundingCorrespondentLimitsResponseError = (getV1InstantFundingCorrespondentLimitsResponseDefault) & {
|
|
1937
|
+
headers: Headers;
|
|
1938
|
+
};
|
|
1939
|
+
export type getV1InstantFundingCorrespondentLimitsResponse = (getV1InstantFundingCorrespondentLimitsResponseSuccess | getV1InstantFundingCorrespondentLimitsResponseError);
|
|
1940
|
+
export declare const getGetV1InstantFundingCorrespondentLimitsUrl: () => string;
|
|
1941
|
+
/**
|
|
1942
|
+
* Returns globally configured limits for the correspondent. These limits are used to determine
|
|
1943
|
+
* the maximum amount that can be extended to all accounts, and reaching this limit will result
|
|
1944
|
+
* in further requests to create instant funding requests being rejected.
|
|
1945
|
+
* @summary Get instant funding limits
|
|
1946
|
+
*/
|
|
1947
|
+
export declare const getV1InstantFundingCorrespondentLimits: (options?: RequestInit) => Promise<getV1InstantFundingCorrespondentLimitsResponse>;
|
|
1948
|
+
export type getV1InstantFundingAccountLimitsResponse200 = {
|
|
1949
|
+
data: AccountLimit[];
|
|
1950
|
+
status: 200;
|
|
1951
|
+
};
|
|
1952
|
+
export type getV1InstantFundingAccountLimitsResponseDefault = {
|
|
1953
|
+
data: Error;
|
|
1954
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
1955
|
+
};
|
|
1956
|
+
export type getV1InstantFundingAccountLimitsResponseSuccess = (getV1InstantFundingAccountLimitsResponse200) & {
|
|
1957
|
+
headers: Headers;
|
|
1958
|
+
};
|
|
1959
|
+
export type getV1InstantFundingAccountLimitsResponseError = (getV1InstantFundingAccountLimitsResponseDefault) & {
|
|
1960
|
+
headers: Headers;
|
|
1961
|
+
};
|
|
1962
|
+
export type getV1InstantFundingAccountLimitsResponse = (getV1InstantFundingAccountLimitsResponseSuccess | getV1InstantFundingAccountLimitsResponseError);
|
|
1963
|
+
export declare const getGetV1InstantFundingAccountLimitsUrl: (params: GetV1InstantFundingAccountLimitsParams) => string;
|
|
1964
|
+
/**
|
|
1965
|
+
* Returns the limits for individual partner accounts.
|
|
1966
|
+
* @summary Get instant funding account limits
|
|
1967
|
+
*/
|
|
1968
|
+
export declare const getV1InstantFundingAccountLimits: (params: GetV1InstantFundingAccountLimitsParams, options?: RequestInit) => Promise<getV1InstantFundingAccountLimitsResponse>;
|
|
1969
|
+
export type getV1InstantFundingReportsResponse200 = {
|
|
1970
|
+
data: ReportsResponse[];
|
|
1971
|
+
status: 200;
|
|
1972
|
+
};
|
|
1973
|
+
export type getV1InstantFundingReportsResponseDefault = {
|
|
1974
|
+
data: Error;
|
|
1975
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
1976
|
+
};
|
|
1977
|
+
export type getV1InstantFundingReportsResponseSuccess = (getV1InstantFundingReportsResponse200) & {
|
|
1978
|
+
headers: Headers;
|
|
1979
|
+
};
|
|
1980
|
+
export type getV1InstantFundingReportsResponseError = (getV1InstantFundingReportsResponseDefault) & {
|
|
1981
|
+
headers: Headers;
|
|
1982
|
+
};
|
|
1983
|
+
export type getV1InstantFundingReportsResponse = (getV1InstantFundingReportsResponseSuccess | getV1InstantFundingReportsResponseError);
|
|
1984
|
+
export declare const getGetV1InstantFundingReportsUrl: (params?: GetV1InstantFundingReportsParams) => string;
|
|
1985
|
+
/**
|
|
1986
|
+
* Returns instant funding reports which are to be used for daily reconciliation reporting.
|
|
1987
|
+
* @summary Get instant funding report
|
|
1988
|
+
*/
|
|
1989
|
+
export declare const getV1InstantFundingReports: (params?: GetV1InstantFundingReportsParams, options?: RequestInit) => Promise<getV1InstantFundingReportsResponse>;
|
|
1990
|
+
export type getV1InstantFundingSettlementsResponse200 = {
|
|
1991
|
+
data: SettlementsResponse;
|
|
1992
|
+
status: 200;
|
|
1993
|
+
};
|
|
1994
|
+
export type getV1InstantFundingSettlementsResponseDefault = {
|
|
1995
|
+
data: Error;
|
|
1996
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
1997
|
+
};
|
|
1998
|
+
export type getV1InstantFundingSettlementsResponseSuccess = (getV1InstantFundingSettlementsResponse200) & {
|
|
1999
|
+
headers: Headers;
|
|
2000
|
+
};
|
|
2001
|
+
export type getV1InstantFundingSettlementsResponseError = (getV1InstantFundingSettlementsResponseDefault) & {
|
|
2002
|
+
headers: Headers;
|
|
2003
|
+
};
|
|
2004
|
+
export type getV1InstantFundingSettlementsResponse = (getV1InstantFundingSettlementsResponseSuccess | getV1InstantFundingSettlementsResponseError);
|
|
2005
|
+
export declare const getGetV1InstantFundingSettlementsUrl: (params?: GetV1InstantFundingSettlementsParams) => string;
|
|
2006
|
+
/**
|
|
2007
|
+
* Returns all settlements filtered by status if provided.
|
|
2008
|
+
* @summary List settlements
|
|
2009
|
+
*/
|
|
2010
|
+
export declare const getV1InstantFundingSettlements: (params?: GetV1InstantFundingSettlementsParams, options?: RequestInit) => Promise<getV1InstantFundingSettlementsResponse>;
|
|
2011
|
+
export type postV1InstantFundingSettlementsResponse200 = {
|
|
2012
|
+
data: SettlementResponse;
|
|
2013
|
+
status: 200;
|
|
2014
|
+
};
|
|
2015
|
+
export type postV1InstantFundingSettlementsResponseDefault = {
|
|
2016
|
+
data: Error;
|
|
2017
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
2018
|
+
};
|
|
2019
|
+
export type postV1InstantFundingSettlementsResponseSuccess = (postV1InstantFundingSettlementsResponse200) & {
|
|
2020
|
+
headers: Headers;
|
|
2021
|
+
};
|
|
2022
|
+
export type postV1InstantFundingSettlementsResponseError = (postV1InstantFundingSettlementsResponseDefault) & {
|
|
2023
|
+
headers: Headers;
|
|
2024
|
+
};
|
|
2025
|
+
export type postV1InstantFundingSettlementsResponse = (postV1InstantFundingSettlementsResponseSuccess | postV1InstantFundingSettlementsResponseError);
|
|
2026
|
+
export declare const getPostV1InstantFundingSettlementsUrl: () => string;
|
|
2027
|
+
/**
|
|
2028
|
+
* Creates a new settlement, which will trigger the reconciliation process for all included
|
|
2029
|
+
* transfers and their interests. There is a limit of 50,000 transfers per settlement. If more
|
|
2030
|
+
* than 50,000 transfers need to be settled, they should be batched in multiple settlements.
|
|
2031
|
+
* @summary Create a new settlement
|
|
2032
|
+
*/
|
|
2033
|
+
export declare const postV1InstantFundingSettlements: (createSettlementRequest: CreateSettlementRequest, options?: RequestInit) => Promise<postV1InstantFundingSettlementsResponse>;
|
|
2034
|
+
export type getV1InstantFundingSettlementsSingleResponse200 = {
|
|
2035
|
+
data: SettlementResponse;
|
|
2036
|
+
status: 200;
|
|
2037
|
+
};
|
|
2038
|
+
export type getV1InstantFundingSettlementsSingleResponseDefault = {
|
|
2039
|
+
data: Error;
|
|
2040
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
2041
|
+
};
|
|
2042
|
+
export type getV1InstantFundingSettlementsSingleResponseSuccess = (getV1InstantFundingSettlementsSingleResponse200) & {
|
|
2043
|
+
headers: Headers;
|
|
2044
|
+
};
|
|
2045
|
+
export type getV1InstantFundingSettlementsSingleResponseError = (getV1InstantFundingSettlementsSingleResponseDefault) & {
|
|
2046
|
+
headers: Headers;
|
|
2047
|
+
};
|
|
2048
|
+
export type getV1InstantFundingSettlementsSingleResponse = (getV1InstantFundingSettlementsSingleResponseSuccess | getV1InstantFundingSettlementsSingleResponseError);
|
|
2049
|
+
export declare const getGetV1InstantFundingSettlementsSingleUrl: (settlementId: string) => string;
|
|
2050
|
+
/**
|
|
2051
|
+
* Returns the settlement specified by the path parameter.
|
|
2052
|
+
* @summary Get a single settlement
|
|
2053
|
+
*/
|
|
2054
|
+
export declare const getV1InstantFundingSettlementsSingle: (settlementId: string, options?: RequestInit) => Promise<getV1InstantFundingSettlementsSingleResponse>;
|
|
2055
|
+
export type listIPOOfferingsResponse200 = {
|
|
2056
|
+
data: IPOOfferingListResponse;
|
|
2057
|
+
status: 200;
|
|
2058
|
+
};
|
|
2059
|
+
export type listIPOOfferingsResponseSuccess = (listIPOOfferingsResponse200) & {
|
|
2060
|
+
headers: Headers;
|
|
2061
|
+
};
|
|
2062
|
+
export type listIPOOfferingsResponse = (listIPOOfferingsResponseSuccess);
|
|
2063
|
+
export declare const getListIPOOfferingsUrl: (params?: ListIPOOfferingsParams) => string;
|
|
2064
|
+
/**
|
|
2065
|
+
* Returns a paginated list of IPO offerings currently known to Alpaca.
|
|
2066
|
+
*
|
|
2067
|
+
* Use this endpoint to power IPO discovery surfaces (e.g. an "Upcoming IPOs" list). Real-time lifecycle changes (availability, prospectus, 60-minute mail, allocations, cancellations) are pushed over the [IPO Events Stream](#operation/subscribeToIPOEventsSSE).
|
|
2068
|
+
* @summary List IPO Offerings
|
|
2069
|
+
*/
|
|
2070
|
+
export declare const listIPOOfferings: (params?: ListIPOOfferingsParams, options?: RequestInit) => Promise<listIPOOfferingsResponse>;
|
|
2071
|
+
export type getIPOOfferingResponse200 = {
|
|
2072
|
+
data: IPOOfferingResponse;
|
|
2073
|
+
status: 200;
|
|
2074
|
+
};
|
|
2075
|
+
export type getIPOOfferingResponse404 = {
|
|
2076
|
+
data: void;
|
|
2077
|
+
status: 404;
|
|
2078
|
+
};
|
|
2079
|
+
export type getIPOOfferingResponseSuccess = (getIPOOfferingResponse200) & {
|
|
2080
|
+
headers: Headers;
|
|
2081
|
+
};
|
|
2082
|
+
export type getIPOOfferingResponseError = (getIPOOfferingResponse404) & {
|
|
2083
|
+
headers: Headers;
|
|
2084
|
+
};
|
|
2085
|
+
export type getIPOOfferingResponse = (getIPOOfferingResponseSuccess | getIPOOfferingResponseError);
|
|
2086
|
+
export declare const getGetIPOOfferingUrl: (offeringReference: string) => string;
|
|
2087
|
+
/**
|
|
2088
|
+
* Returns a single IPO offering by `offering_reference`.
|
|
2089
|
+
*
|
|
2090
|
+
* The `offering_reference` value matches the one delivered on the [IPO Events Stream](#operation/subscribeToIPOEventsSSE).
|
|
2091
|
+
* @summary Retrieve an IPO Offering
|
|
2092
|
+
*/
|
|
2093
|
+
export declare const getIPOOffering: (offeringReference: string, options?: RequestInit) => Promise<getIPOOfferingResponse>;
|
|
2094
|
+
export type getV1JitSettlementsResponse200 = {
|
|
2095
|
+
data: SettlementsResponse;
|
|
2096
|
+
status: 200;
|
|
2097
|
+
};
|
|
2098
|
+
export type getV1JitSettlementsResponseDefault = {
|
|
2099
|
+
data: Error;
|
|
2100
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
2101
|
+
};
|
|
2102
|
+
export type getV1JitSettlementsResponseSuccess = (getV1JitSettlementsResponse200) & {
|
|
2103
|
+
headers: Headers;
|
|
2104
|
+
};
|
|
2105
|
+
export type getV1JitSettlementsResponseError = (getV1JitSettlementsResponseDefault) & {
|
|
2106
|
+
headers: Headers;
|
|
2107
|
+
};
|
|
2108
|
+
export type getV1JitSettlementsResponse = (getV1JitSettlementsResponseSuccess | getV1JitSettlementsResponseError);
|
|
2109
|
+
export declare const getGetV1JitSettlementsUrl: (params?: GetV1JitSettlementsParams) => string;
|
|
2110
|
+
/**
|
|
2111
|
+
* Returns all JIT settlements filtered by status if provided.
|
|
2112
|
+
* @summary List all JIT Settlements
|
|
2113
|
+
*/
|
|
2114
|
+
export declare const getV1JitSettlements: (params?: GetV1JitSettlementsParams, options?: RequestInit) => Promise<getV1JitSettlementsResponse>;
|
|
2115
|
+
export type postV1JitSettlementsResponse200 = {
|
|
2116
|
+
data: SettlementResponse;
|
|
2117
|
+
status: 200;
|
|
2118
|
+
};
|
|
2119
|
+
export type postV1JitSettlementsResponseDefault = {
|
|
2120
|
+
data: Error;
|
|
2121
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
2122
|
+
};
|
|
2123
|
+
export type postV1JitSettlementsResponseSuccess = (postV1JitSettlementsResponse200) & {
|
|
2124
|
+
headers: Headers;
|
|
2125
|
+
};
|
|
2126
|
+
export type postV1JitSettlementsResponseError = (postV1JitSettlementsResponseDefault) & {
|
|
2127
|
+
headers: Headers;
|
|
2128
|
+
};
|
|
2129
|
+
export type postV1JitSettlementsResponse = (postV1JitSettlementsResponseSuccess | postV1JitSettlementsResponseError);
|
|
2130
|
+
export declare const getPostV1JitSettlementsUrl: () => string;
|
|
2131
|
+
/**
|
|
2132
|
+
* Creates a new JIT settlement, which will trigger the reconciliation process for all included accounts.
|
|
2133
|
+
* @summary Create a new JIT settlement
|
|
2134
|
+
*/
|
|
2135
|
+
export declare const postV1JitSettlements: (createJITSettlementRequest: CreateJITSettlementRequest, options?: RequestInit) => Promise<postV1JitSettlementsResponse>;
|
|
2136
|
+
export type getV1JitSettlementsSingleResponse200 = {
|
|
2137
|
+
data: SettlementResponse;
|
|
2138
|
+
status: 200;
|
|
2139
|
+
};
|
|
2140
|
+
export type getV1JitSettlementsSingleResponseDefault = {
|
|
2141
|
+
data: Error;
|
|
2142
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
2143
|
+
};
|
|
2144
|
+
export type getV1JitSettlementsSingleResponseSuccess = (getV1JitSettlementsSingleResponse200) & {
|
|
2145
|
+
headers: Headers;
|
|
2146
|
+
};
|
|
2147
|
+
export type getV1JitSettlementsSingleResponseError = (getV1JitSettlementsSingleResponseDefault) & {
|
|
2148
|
+
headers: Headers;
|
|
2149
|
+
};
|
|
2150
|
+
export type getV1JitSettlementsSingleResponse = (getV1JitSettlementsSingleResponseSuccess | getV1JitSettlementsSingleResponseError);
|
|
2151
|
+
export declare const getGetV1JitSettlementsSingleUrl: (settlementId: string) => string;
|
|
2152
|
+
/**
|
|
2153
|
+
* Returns the JIT settlement specified by the path parameter.
|
|
2154
|
+
* @summary Get a single JIT settlement
|
|
2155
|
+
*/
|
|
2156
|
+
export declare const getV1JitSettlementsSingle: (settlementId: string, options?: RequestInit) => Promise<getV1JitSettlementsSingleResponse>;
|
|
2157
|
+
export type getAllJournalsResponse200 = {
|
|
2158
|
+
data: Journal[];
|
|
2159
|
+
status: 200;
|
|
2160
|
+
};
|
|
2161
|
+
export type getAllJournalsResponse400 = {
|
|
2162
|
+
data: string;
|
|
2163
|
+
status: 400;
|
|
2164
|
+
};
|
|
2165
|
+
export type getAllJournalsResponse422 = {
|
|
2166
|
+
data: string;
|
|
2167
|
+
status: 422;
|
|
2168
|
+
};
|
|
2169
|
+
export type getAllJournalsResponseSuccess = (getAllJournalsResponse200) & {
|
|
2170
|
+
headers: Headers;
|
|
2171
|
+
};
|
|
2172
|
+
export type getAllJournalsResponseError = (getAllJournalsResponse400 | getAllJournalsResponse422) & {
|
|
2173
|
+
headers: Headers;
|
|
2174
|
+
};
|
|
2175
|
+
export type getAllJournalsResponse = (getAllJournalsResponseSuccess | getAllJournalsResponseError);
|
|
2176
|
+
export declare const getGetAllJournalsUrl: (params?: GetAllJournalsParams) => string;
|
|
2177
|
+
/**
|
|
2178
|
+
* Returns an array of journal objects.
|
|
2179
|
+
* @summary Retrieve a List Journals
|
|
2180
|
+
*/
|
|
2181
|
+
export declare const getAllJournals: (params?: GetAllJournalsParams, options?: RequestInit) => Promise<getAllJournalsResponse>;
|
|
2182
|
+
export type createJournalResponse200 = {
|
|
2183
|
+
data: Journal;
|
|
2184
|
+
status: 200;
|
|
2185
|
+
};
|
|
2186
|
+
export type createJournalResponse400 = {
|
|
2187
|
+
data: string;
|
|
2188
|
+
status: 400;
|
|
2189
|
+
};
|
|
2190
|
+
export type createJournalResponse403 = {
|
|
2191
|
+
data: string;
|
|
2192
|
+
status: 403;
|
|
2193
|
+
};
|
|
2194
|
+
export type createJournalResponse404 = {
|
|
2195
|
+
data: string;
|
|
2196
|
+
status: 404;
|
|
2197
|
+
};
|
|
2198
|
+
export type createJournalResponse422 = {
|
|
2199
|
+
data: Error;
|
|
2200
|
+
status: 422;
|
|
2201
|
+
};
|
|
2202
|
+
export type createJournalResponseSuccess = (createJournalResponse200) & {
|
|
2203
|
+
headers: Headers;
|
|
2204
|
+
};
|
|
2205
|
+
export type createJournalResponseError = (createJournalResponse400 | createJournalResponse403 | createJournalResponse404 | createJournalResponse422) & {
|
|
2206
|
+
headers: Headers;
|
|
2207
|
+
};
|
|
2208
|
+
export type createJournalResponse = (createJournalResponseSuccess | createJournalResponseError);
|
|
2209
|
+
export declare const getCreateJournalUrl: () => string;
|
|
2210
|
+
/**
|
|
2211
|
+
* A journal can be JNLC (move cash) or JNLS (move shares), dictated by `entry_type`. Generally, journal requests are subject to approval and starts from the `pending` status. The status changes are propagated through the Event API. Under certain conditions agreed for the partner, such journal transactions that meet the criteria are executed right away.
|
|
2212
|
+
*
|
|
2213
|
+
* **Idempotency**: When the `Idempotency-Key` header is supplied, this endpoint is
|
|
2214
|
+
* idempotent. Multiple requests with the same key and identical request body will
|
|
2215
|
+
* create only one journal. A subsequent request returns the previously created
|
|
2216
|
+
* journal with the same response (no duplicate is created). If the same key is used
|
|
2217
|
+
* with a different request body, the API returns `422 Unprocessable Entity`.
|
|
2218
|
+
*
|
|
2219
|
+
* **Recommended for production**: Always supply `Idempotency-Key` when creating
|
|
2220
|
+
* journals. This allows safe retries on timeouts, network errors, or 5xx responses
|
|
2221
|
+
* without risking duplicate journals. Use a client-generated unique value (e.g. UUID).
|
|
2222
|
+
* @summary Create a Journal
|
|
2223
|
+
*/
|
|
2224
|
+
export declare const createJournal: (createJournalRequest: CreateJournalRequest, options?: RequestInit) => Promise<createJournalResponse>;
|
|
2225
|
+
export type deleteJournalByIdResponse204 = {
|
|
2226
|
+
data: void;
|
|
2227
|
+
status: 204;
|
|
2228
|
+
};
|
|
2229
|
+
export type deleteJournalByIdResponse404 = {
|
|
2230
|
+
data: void;
|
|
2231
|
+
status: 404;
|
|
2232
|
+
};
|
|
2233
|
+
export type deleteJournalByIdResponse422 = {
|
|
2234
|
+
data: void;
|
|
2235
|
+
status: 422;
|
|
2236
|
+
};
|
|
2237
|
+
export type deleteJournalByIdResponseSuccess = (deleteJournalByIdResponse204) & {
|
|
2238
|
+
headers: Headers;
|
|
2239
|
+
};
|
|
2240
|
+
export type deleteJournalByIdResponseError = (deleteJournalByIdResponse404 | deleteJournalByIdResponse422) & {
|
|
2241
|
+
headers: Headers;
|
|
2242
|
+
};
|
|
2243
|
+
export type deleteJournalByIdResponse = (deleteJournalByIdResponseSuccess | deleteJournalByIdResponseError);
|
|
2244
|
+
export declare const getDeleteJournalByIdUrl: (journalId: string) => string;
|
|
2245
|
+
/**
|
|
2246
|
+
* You can only delete a journal if the journal is still in a pending state, if a journal is executed you will not be able to delete. The alternative is to create a mirror journal entry to reverse the flow of funds.
|
|
2247
|
+
* @summary Cancel a Pending Journal
|
|
2248
|
+
*/
|
|
2249
|
+
export declare const deleteJournalById: (journalId: string, options?: RequestInit) => Promise<deleteJournalByIdResponse>;
|
|
2250
|
+
export type getV1JournalsJournalIdResponse200 = {
|
|
2251
|
+
data: Journal;
|
|
2252
|
+
status: 200;
|
|
2253
|
+
};
|
|
2254
|
+
export type getV1JournalsJournalIdResponseSuccess = (getV1JournalsJournalIdResponse200) & {
|
|
2255
|
+
headers: Headers;
|
|
2256
|
+
};
|
|
2257
|
+
export type getV1JournalsJournalIdResponse = (getV1JournalsJournalIdResponseSuccess);
|
|
2258
|
+
export declare const getGetV1JournalsJournalIdUrl: (journalId: string) => string;
|
|
2259
|
+
/**
|
|
2260
|
+
* You can query a specific journal entry that you submitted to Alpaca by passing into the query the journal_id.
|
|
2261
|
+
*
|
|
2262
|
+
* Will return a journal entry if a journal entry with journal_id exists, otherwise will throw an error.
|
|
2263
|
+
* @summary Retrieve a Single Journal Entry
|
|
2264
|
+
*/
|
|
2265
|
+
export declare const getV1JournalsJournalId: (journalId: string, options?: RequestInit) => Promise<getV1JournalsJournalIdResponse>;
|
|
2266
|
+
export type createBatchJournalResponse200 = {
|
|
2267
|
+
data: BatchJournalResponse[];
|
|
2268
|
+
status: 200;
|
|
2269
|
+
};
|
|
2270
|
+
export type createBatchJournalResponse422 = {
|
|
2271
|
+
data: Error;
|
|
2272
|
+
status: 422;
|
|
2273
|
+
};
|
|
2274
|
+
export type createBatchJournalResponseSuccess = (createBatchJournalResponse200) & {
|
|
2275
|
+
headers: Headers;
|
|
2276
|
+
};
|
|
2277
|
+
export type createBatchJournalResponseError = (createBatchJournalResponse422) & {
|
|
2278
|
+
headers: Headers;
|
|
2279
|
+
};
|
|
2280
|
+
export type createBatchJournalResponse = (createBatchJournalResponseSuccess | createBatchJournalResponseError);
|
|
2281
|
+
export declare const getCreateBatchJournalUrl: () => string;
|
|
2282
|
+
/**
|
|
2283
|
+
* You can create a batch of journal requests by using this endpoint. This is enabled on JNLC type Journals for now only.
|
|
2284
|
+
*
|
|
2285
|
+
* Every single request must be valid for the entire batch operation to succeed.
|
|
2286
|
+
*
|
|
2287
|
+
* In the case of a successful request, the response will contain an array of journal objects with an extra attribute error_message in the case when a specific account fails to receive a journal.
|
|
2288
|
+
*
|
|
2289
|
+
* **Idempotency**: When the `Idempotency-Key` header is supplied, this endpoint is
|
|
2290
|
+
* idempotent. Multiple requests with the same key and identical request body will
|
|
2291
|
+
* create only one batch. A subsequent request returns the previously created
|
|
2292
|
+
* batch with the same response (no duplicate is created). If the same key is used
|
|
2293
|
+
* with a different request body, the API returns `422 Unprocessable Entity`.
|
|
2294
|
+
*
|
|
2295
|
+
* **Recommended for production**: Always supply `Idempotency-Key` when creating
|
|
2296
|
+
* journal batches. This allows safe retries on timeouts, network errors, or 5xx responses
|
|
2297
|
+
* without risking duplicate batches. Use a client-generated unique value (e.g. UUID).
|
|
2298
|
+
* @summary Create a Batch Journal Transaction (One-to-Many)
|
|
2299
|
+
*/
|
|
2300
|
+
export declare const createBatchJournal: (batchJournalRequest: BatchJournalRequest, options?: RequestInit) => Promise<createBatchJournalResponse>;
|
|
2301
|
+
export type postV1JournalsReverseBatchResponse200 = {
|
|
2302
|
+
data: BatchJournalResponse[];
|
|
2303
|
+
status: 200;
|
|
2304
|
+
};
|
|
2305
|
+
export type postV1JournalsReverseBatchResponse400 = {
|
|
2306
|
+
data: void;
|
|
2307
|
+
status: 400;
|
|
2308
|
+
};
|
|
2309
|
+
export type postV1JournalsReverseBatchResponse403 = {
|
|
2310
|
+
data: void;
|
|
2311
|
+
status: 403;
|
|
2312
|
+
};
|
|
2313
|
+
export type postV1JournalsReverseBatchResponse404 = {
|
|
2314
|
+
data: void;
|
|
2315
|
+
status: 404;
|
|
2316
|
+
};
|
|
2317
|
+
export type postV1JournalsReverseBatchResponseSuccess = (postV1JournalsReverseBatchResponse200) & {
|
|
2318
|
+
headers: Headers;
|
|
2319
|
+
};
|
|
2320
|
+
export type postV1JournalsReverseBatchResponseError = (postV1JournalsReverseBatchResponse400 | postV1JournalsReverseBatchResponse403 | postV1JournalsReverseBatchResponse404) & {
|
|
2321
|
+
headers: Headers;
|
|
2322
|
+
};
|
|
2323
|
+
export type postV1JournalsReverseBatchResponse = (postV1JournalsReverseBatchResponseSuccess | postV1JournalsReverseBatchResponseError);
|
|
2324
|
+
export declare const getPostV1JournalsReverseBatchUrl: () => string;
|
|
2325
|
+
/**
|
|
2326
|
+
* You can also create a batch journal request by using the following endpoint. This is enabled on JNLC for now only.
|
|
2327
|
+
*
|
|
2328
|
+
* Note that if there is an invalid account_id the whole batch operation will be canceled.
|
|
2329
|
+
* Every single request must be valid for the entire batch operation to succeed.
|
|
2330
|
+
*
|
|
2331
|
+
* In the case of a successful request, the response will contain an array of journal objects with an extra attribute error_message in the case when a specific account fails to submit a journal.
|
|
2332
|
+
* @summary Create a Reverse Batch Journal Transaction (Many-to-One)
|
|
2333
|
+
*/
|
|
2334
|
+
export declare const postV1JournalsReverseBatch: (reverseBatchJournalRequest?: ReverseBatchJournalRequest, options?: RequestInit) => Promise<postV1JournalsReverseBatchResponse>;
|
|
2335
|
+
export type authorizeOAuthTokenResponse200 = {
|
|
2336
|
+
data: AuthorizeOAuthTokenResponse;
|
|
2337
|
+
status: 200;
|
|
2338
|
+
};
|
|
2339
|
+
export type authorizeOAuthTokenResponse401 = {
|
|
2340
|
+
data: string;
|
|
2341
|
+
status: 401;
|
|
2342
|
+
};
|
|
2343
|
+
export type authorizeOAuthTokenResponse422 = {
|
|
2344
|
+
data: string;
|
|
2345
|
+
status: 422;
|
|
2346
|
+
};
|
|
2347
|
+
export type authorizeOAuthTokenResponseSuccess = (authorizeOAuthTokenResponse200) & {
|
|
2348
|
+
headers: Headers;
|
|
2349
|
+
};
|
|
2350
|
+
export type authorizeOAuthTokenResponseError = (authorizeOAuthTokenResponse401 | authorizeOAuthTokenResponse422) & {
|
|
2351
|
+
headers: Headers;
|
|
2352
|
+
};
|
|
2353
|
+
export type authorizeOAuthTokenResponse = (authorizeOAuthTokenResponseSuccess | authorizeOAuthTokenResponseError);
|
|
2354
|
+
export declare const getAuthorizeOAuthTokenUrl: () => string;
|
|
2355
|
+
/**
|
|
2356
|
+
* The operation issues an OAuth code which can be used in the OAuth code flow.
|
|
2357
|
+
* @summary Authorize an OAuth Token
|
|
2358
|
+
*/
|
|
2359
|
+
export declare const authorizeOAuthToken: (oAuthTokenRequest: OAuthTokenRequest, options?: RequestInit) => Promise<authorizeOAuthTokenResponse>;
|
|
2360
|
+
export type getOAuthClientResponse200 = {
|
|
2361
|
+
data: OathClientResponse;
|
|
2362
|
+
status: 200;
|
|
2363
|
+
};
|
|
2364
|
+
export type getOAuthClientResponse401 = {
|
|
2365
|
+
data: string;
|
|
2366
|
+
status: 401;
|
|
2367
|
+
};
|
|
2368
|
+
export type getOAuthClientResponseSuccess = (getOAuthClientResponse200) & {
|
|
2369
|
+
headers: Headers;
|
|
2370
|
+
};
|
|
2371
|
+
export type getOAuthClientResponseError = (getOAuthClientResponse401) & {
|
|
2372
|
+
headers: Headers;
|
|
2373
|
+
};
|
|
2374
|
+
export type getOAuthClientResponse = (getOAuthClientResponseSuccess | getOAuthClientResponseError);
|
|
2375
|
+
export declare const getGetOAuthClientUrl: (clientId: string, params?: GetOAuthClientParams) => string;
|
|
2376
|
+
/**
|
|
2377
|
+
* The endpoint returns the details of OAuth client to display in the authorization page.
|
|
2378
|
+
* @summary Get an OAuth client
|
|
2379
|
+
*/
|
|
2380
|
+
export declare const getOAuthClient: (clientId: string, params?: GetOAuthClientParams, options?: RequestInit) => Promise<getOAuthClientResponse>;
|
|
2381
|
+
export type issueOAuthTokenResponse200 = {
|
|
2382
|
+
data: IssueOAuthTokenResponse;
|
|
2383
|
+
status: 200;
|
|
2384
|
+
};
|
|
2385
|
+
export type issueOAuthTokenResponse401 = {
|
|
2386
|
+
data: string;
|
|
2387
|
+
status: 401;
|
|
2388
|
+
};
|
|
2389
|
+
export type issueOAuthTokenResponse422 = {
|
|
2390
|
+
data: string;
|
|
2391
|
+
status: 422;
|
|
2392
|
+
};
|
|
2393
|
+
export type issueOAuthTokenResponseSuccess = (issueOAuthTokenResponse200) & {
|
|
2394
|
+
headers: Headers;
|
|
2395
|
+
};
|
|
2396
|
+
export type issueOAuthTokenResponseError = (issueOAuthTokenResponse401 | issueOAuthTokenResponse422) & {
|
|
2397
|
+
headers: Headers;
|
|
2398
|
+
};
|
|
2399
|
+
export type issueOAuthTokenResponse = (issueOAuthTokenResponseSuccess | issueOAuthTokenResponseError);
|
|
2400
|
+
export declare const getIssueOAuthTokenUrl: () => string;
|
|
2401
|
+
/**
|
|
2402
|
+
* The operation issues an OAuth code which can be used in the OAuth code flow.
|
|
2403
|
+
* @summary Issue an OAuth token
|
|
2404
|
+
*/
|
|
2405
|
+
export declare const issueOAuthToken: (oAuthTokenRequest: OAuthTokenRequest, options?: RequestInit) => Promise<issueOAuthTokenResponse>;
|
|
2406
|
+
export type getOptionsContractsResponse200 = {
|
|
2407
|
+
data: GetOptionsContracts200;
|
|
2408
|
+
status: 200;
|
|
2409
|
+
};
|
|
2410
|
+
export type getOptionsContractsResponseSuccess = (getOptionsContractsResponse200) & {
|
|
2411
|
+
headers: Headers;
|
|
2412
|
+
};
|
|
2413
|
+
export type getOptionsContractsResponse = (getOptionsContractsResponseSuccess);
|
|
2414
|
+
export declare const getGetOptionsContractsUrl: (params?: GetOptionsContractsParams) => string;
|
|
2415
|
+
/**
|
|
2416
|
+
* This endpoint allows you to retrieve a list of option contracts based on various filtering criteria.
|
|
2417
|
+
* By default only active contracts that expire before the upcoming weekend are returned.
|
|
2418
|
+
* @summary Get Option Contracts (BETA)
|
|
2419
|
+
*/
|
|
2420
|
+
export declare const getOptionsContracts: (params?: GetOptionsContractsParams, options?: RequestInit) => Promise<getOptionsContractsResponse>;
|
|
2421
|
+
export type getOptionContractSymbolOrIdResponse200 = {
|
|
2422
|
+
data: OptionContract;
|
|
2423
|
+
status: 200;
|
|
2424
|
+
};
|
|
2425
|
+
export type getOptionContractSymbolOrIdResponse404 = {
|
|
2426
|
+
data: Error;
|
|
2427
|
+
status: 404;
|
|
2428
|
+
};
|
|
2429
|
+
export type getOptionContractSymbolOrIdResponseSuccess = (getOptionContractSymbolOrIdResponse200) & {
|
|
2430
|
+
headers: Headers;
|
|
2431
|
+
};
|
|
2432
|
+
export type getOptionContractSymbolOrIdResponseError = (getOptionContractSymbolOrIdResponse404) & {
|
|
2433
|
+
headers: Headers;
|
|
2434
|
+
};
|
|
2435
|
+
export type getOptionContractSymbolOrIdResponse = (getOptionContractSymbolOrIdResponseSuccess | getOptionContractSymbolOrIdResponseError);
|
|
2436
|
+
export declare const getGetOptionContractSymbolOrIdUrl: (symbolOrId: string) => string;
|
|
2437
|
+
/**
|
|
2438
|
+
* Get an option contract by symbol or contract ID. The symbol or id should be passed in as a path parameter.
|
|
2439
|
+
* @summary Get an option contract by ID or Symbol (BETA)
|
|
2440
|
+
*/
|
|
2441
|
+
export declare const getOptionContractSymbolOrId: (symbolOrId: string, options?: RequestInit) => Promise<getOptionContractSymbolOrIdResponse>;
|
|
2442
|
+
export type getV1RebalancingPortfoliosResponse200 = {
|
|
2443
|
+
data: Portfolio[];
|
|
2444
|
+
status: 200;
|
|
2445
|
+
};
|
|
2446
|
+
export type getV1RebalancingPortfoliosResponseSuccess = (getV1RebalancingPortfoliosResponse200) & {
|
|
2447
|
+
headers: Headers;
|
|
2448
|
+
};
|
|
2449
|
+
export type getV1RebalancingPortfoliosResponse = (getV1RebalancingPortfoliosResponseSuccess);
|
|
2450
|
+
export declare const getGetV1RebalancingPortfoliosUrl: (params?: GetV1RebalancingPortfoliosParams) => string;
|
|
2451
|
+
/**
|
|
2452
|
+
* Lists portfolios.
|
|
2453
|
+
*
|
|
2454
|
+
* When more than one query parameter is passed, only portfolios meeting all provided values will be returned (logical AND between parameter values).
|
|
2455
|
+
* @summary List Portfolios
|
|
2456
|
+
*/
|
|
2457
|
+
export declare const getV1RebalancingPortfolios: (params?: GetV1RebalancingPortfoliosParams, options?: RequestInit) => Promise<getV1RebalancingPortfoliosResponse>;
|
|
2458
|
+
export type postV1RebalancingPortfoliosResponse200 = {
|
|
2459
|
+
data: Portfolio;
|
|
2460
|
+
status: 200;
|
|
2461
|
+
};
|
|
2462
|
+
export type postV1RebalancingPortfoliosResponseSuccess = (postV1RebalancingPortfoliosResponse200) & {
|
|
2463
|
+
headers: Headers;
|
|
2464
|
+
};
|
|
2465
|
+
export type postV1RebalancingPortfoliosResponse = (postV1RebalancingPortfoliosResponseSuccess);
|
|
2466
|
+
export declare const getPostV1RebalancingPortfoliosUrl: () => string;
|
|
2467
|
+
/**
|
|
2468
|
+
* Creates a portfolio allocation containing securities and/or cash. Having no rebalancing conditions is allowed but the rebalance event would need to be triggered manually. Portfolios created with API may have multiple rebalance_conditions, but only one of type calendar.
|
|
2469
|
+
* @summary Create Portfolio
|
|
2470
|
+
*/
|
|
2471
|
+
export declare const postV1RebalancingPortfolios: (postV1RebalancingPortfoliosBody?: PostV1RebalancingPortfoliosBody, options?: RequestInit) => Promise<postV1RebalancingPortfoliosResponse>;
|
|
2472
|
+
export type deleteV1RebalancingPortfoliosPortfolioIdResponse204 = {
|
|
2473
|
+
data: void;
|
|
2474
|
+
status: 204;
|
|
2475
|
+
};
|
|
2476
|
+
export type deleteV1RebalancingPortfoliosPortfolioIdResponse400 = {
|
|
2477
|
+
data: void;
|
|
2478
|
+
status: 400;
|
|
2479
|
+
};
|
|
2480
|
+
export type deleteV1RebalancingPortfoliosPortfolioIdResponse422 = {
|
|
2481
|
+
data: void;
|
|
2482
|
+
status: 422;
|
|
2483
|
+
};
|
|
2484
|
+
export type deleteV1RebalancingPortfoliosPortfolioIdResponseSuccess = (deleteV1RebalancingPortfoliosPortfolioIdResponse204) & {
|
|
2485
|
+
headers: Headers;
|
|
2486
|
+
};
|
|
2487
|
+
export type deleteV1RebalancingPortfoliosPortfolioIdResponseError = (deleteV1RebalancingPortfoliosPortfolioIdResponse400 | deleteV1RebalancingPortfoliosPortfolioIdResponse422) & {
|
|
2488
|
+
headers: Headers;
|
|
2489
|
+
};
|
|
2490
|
+
export type deleteV1RebalancingPortfoliosPortfolioIdResponse = (deleteV1RebalancingPortfoliosPortfolioIdResponseSuccess | deleteV1RebalancingPortfoliosPortfolioIdResponseError);
|
|
2491
|
+
export declare const getDeleteV1RebalancingPortfoliosPortfolioIdUrl: (portfolioId: string) => string;
|
|
2492
|
+
/**
|
|
2493
|
+
* Sets a portfolio to "inactive", so it can be filtered out of the list request. Only permitted if there are no active subscriptions to this portfolio and this portfolio is not a listed in the weights of any active portfolios.
|
|
2494
|
+
*
|
|
2495
|
+
* Inactive portfolios cannot be linked in new subscriptions or added as weights to new portfolios.
|
|
2496
|
+
* @summary Inactivate Portfolio By ID
|
|
2497
|
+
*/
|
|
2498
|
+
export declare const deleteV1RebalancingPortfoliosPortfolioId: (portfolioId: string, options?: RequestInit) => Promise<deleteV1RebalancingPortfoliosPortfolioIdResponse>;
|
|
2499
|
+
export type getV1RebalancingPortfoliosPortfolioIdResponse200 = {
|
|
2500
|
+
data: Portfolio;
|
|
2501
|
+
status: 200;
|
|
2502
|
+
};
|
|
2503
|
+
export type getV1RebalancingPortfoliosPortfolioIdResponseSuccess = (getV1RebalancingPortfoliosPortfolioIdResponse200) & {
|
|
2504
|
+
headers: Headers;
|
|
2505
|
+
};
|
|
2506
|
+
export type getV1RebalancingPortfoliosPortfolioIdResponse = (getV1RebalancingPortfoliosPortfolioIdResponseSuccess);
|
|
2507
|
+
export declare const getGetV1RebalancingPortfoliosPortfolioIdUrl: (portfolioId: string) => string;
|
|
2508
|
+
/**
|
|
2509
|
+
* Get a portfolio by its ID.
|
|
2510
|
+
* @summary Get Portfolio by ID
|
|
2511
|
+
*/
|
|
2512
|
+
export declare const getV1RebalancingPortfoliosPortfolioId: (portfolioId: string, options?: RequestInit) => Promise<getV1RebalancingPortfoliosPortfolioIdResponse>;
|
|
2513
|
+
export type patchV1RebalancingPortfoliosPortfolioIdResponse200 = {
|
|
2514
|
+
data: Portfolio;
|
|
2515
|
+
status: 200;
|
|
2516
|
+
};
|
|
2517
|
+
export type patchV1RebalancingPortfoliosPortfolioIdResponseSuccess = (patchV1RebalancingPortfoliosPortfolioIdResponse200) & {
|
|
2518
|
+
headers: Headers;
|
|
2519
|
+
};
|
|
2520
|
+
export type patchV1RebalancingPortfoliosPortfolioIdResponse = (patchV1RebalancingPortfoliosPortfolioIdResponseSuccess);
|
|
2521
|
+
export declare const getPatchV1RebalancingPortfoliosPortfolioIdUrl: (portfolioId: string) => string;
|
|
2522
|
+
/**
|
|
2523
|
+
* Updates a portfolio. If weights or conditions are changed, all subscribed accounts will be evaluated for rebalancing at the next opportunity (normal market hours). If a cooldown is active on the portfolio, the rebalancing will occur after the cooldown expired.
|
|
2524
|
+
* @summary Update Portfolio by ID
|
|
2525
|
+
*/
|
|
2526
|
+
export declare const patchV1RebalancingPortfoliosPortfolioId: (portfolioId: string, patchV1RebalancingPortfoliosPortfolioIdBody?: PatchV1RebalancingPortfoliosPortfolioIdBody, options?: RequestInit) => Promise<patchV1RebalancingPortfoliosPortfolioIdResponse>;
|
|
2527
|
+
export type getV1RebalancingRunsResponse200 = {
|
|
2528
|
+
data: PortfolioRun[];
|
|
2529
|
+
status: 200;
|
|
2530
|
+
};
|
|
2531
|
+
export type getV1RebalancingRunsResponseSuccess = (getV1RebalancingRunsResponse200) & {
|
|
2532
|
+
headers: Headers;
|
|
2533
|
+
};
|
|
2534
|
+
export type getV1RebalancingRunsResponse = (getV1RebalancingRunsResponseSuccess);
|
|
2535
|
+
export declare const getGetV1RebalancingRunsUrl: (params?: GetV1RebalancingRunsParams) => string;
|
|
2536
|
+
/**
|
|
2537
|
+
* Lists runs.
|
|
2538
|
+
* @summary List All Runs.
|
|
2539
|
+
*/
|
|
2540
|
+
export declare const getV1RebalancingRuns: (params?: GetV1RebalancingRunsParams, options?: RequestInit) => Promise<getV1RebalancingRunsResponse>;
|
|
2541
|
+
export type postV1RebalancingRunsResponse200 = {
|
|
2542
|
+
data: void;
|
|
2543
|
+
status: 200;
|
|
2544
|
+
};
|
|
2545
|
+
export type postV1RebalancingRunsResponseSuccess = (postV1RebalancingRunsResponse200) & {
|
|
2546
|
+
headers: Headers;
|
|
2547
|
+
};
|
|
2548
|
+
export type postV1RebalancingRunsResponse = (postV1RebalancingRunsResponseSuccess);
|
|
2549
|
+
export declare const getPostV1RebalancingRunsUrl: () => string;
|
|
2550
|
+
/**
|
|
2551
|
+
* Manually creates a run.
|
|
2552
|
+
*
|
|
2553
|
+
* The determination of a run's orders and the execution of a run take place during normal market hours
|
|
2554
|
+
*
|
|
2555
|
+
* Runs can be initiated either by the system (when the system evaluates the rebalance conditions specified at the portfolio level) or by API call (manual run creation using POST /v1/rebalancing/runs). Runs can be initiated manually outside of the normal market hours but will remain in the QUEUED status until normal market hours
|
|
2556
|
+
*
|
|
2557
|
+
* Only 1 run in a non-terminal status is allowed at any time.
|
|
2558
|
+
*
|
|
2559
|
+
* Manually executing a run is currently only allowed for accounts who do not have an active subscription.
|
|
2560
|
+
* @summary Create Run (Manual rebalancing event)
|
|
2561
|
+
*/
|
|
2562
|
+
export declare const postV1RebalancingRuns: (postV1RebalancingRunsBody?: PostV1RebalancingRunsBody, options?: RequestInit) => Promise<postV1RebalancingRunsResponse>;
|
|
2563
|
+
export type deleteV1RebalancingRunsRunIdResponse204 = {
|
|
2564
|
+
data: void;
|
|
2565
|
+
status: 204;
|
|
2566
|
+
};
|
|
2567
|
+
export type deleteV1RebalancingRunsRunIdResponseSuccess = (deleteV1RebalancingRunsRunIdResponse204) & {
|
|
2568
|
+
headers: Headers;
|
|
2569
|
+
};
|
|
2570
|
+
export type deleteV1RebalancingRunsRunIdResponse = (deleteV1RebalancingRunsRunIdResponseSuccess);
|
|
2571
|
+
export declare const getDeleteV1RebalancingRunsRunIdUrl: (runId: string) => string;
|
|
2572
|
+
/**
|
|
2573
|
+
* Cancels a run. Only runs within certain statuses (QUEUED, CANCELED, SELLS_IN_PROGRESS, BUYS_IN_PROGRESS) are cancelable. If this endpoint is called after orders have been submitted, we'll attempt to cancel the orders.
|
|
2574
|
+
* @summary Cancel Run by ID
|
|
2575
|
+
*/
|
|
2576
|
+
export declare const deleteV1RebalancingRunsRunId: (runId: string, options?: RequestInit) => Promise<deleteV1RebalancingRunsRunIdResponse>;
|
|
2577
|
+
export type getV1RebalancingRunsRunIdResponse200 = {
|
|
2578
|
+
data: PortfolioRun;
|
|
2579
|
+
status: 200;
|
|
2580
|
+
};
|
|
2581
|
+
export type getV1RebalancingRunsRunIdResponseSuccess = (getV1RebalancingRunsRunIdResponse200) & {
|
|
2582
|
+
headers: Headers;
|
|
2583
|
+
};
|
|
2584
|
+
export type getV1RebalancingRunsRunIdResponse = (getV1RebalancingRunsRunIdResponseSuccess);
|
|
2585
|
+
export declare const getGetV1RebalancingRunsRunIdUrl: (runId: string) => string;
|
|
2586
|
+
/**
|
|
2587
|
+
* Get a run by its ID.
|
|
2588
|
+
* @summary Get Run by ID
|
|
2589
|
+
*/
|
|
2590
|
+
export declare const getV1RebalancingRunsRunId: (runId: string, options?: RequestInit) => Promise<getV1RebalancingRunsRunIdResponse>;
|
|
2591
|
+
export type getV1RebalancingSubscriptionsResponse200 = {
|
|
2592
|
+
data: GetV1RebalancingSubscriptions200;
|
|
2593
|
+
status: 200;
|
|
2594
|
+
};
|
|
2595
|
+
export type getV1RebalancingSubscriptionsResponseSuccess = (getV1RebalancingSubscriptionsResponse200) & {
|
|
2596
|
+
headers: Headers;
|
|
2597
|
+
};
|
|
2598
|
+
export type getV1RebalancingSubscriptionsResponse = (getV1RebalancingSubscriptionsResponseSuccess);
|
|
2599
|
+
export declare const getGetV1RebalancingSubscriptionsUrl: (params?: GetV1RebalancingSubscriptionsParams) => string;
|
|
2600
|
+
/**
|
|
2601
|
+
* Lists subscriptions
|
|
2602
|
+
* @summary List All Subscriptions
|
|
2603
|
+
*/
|
|
2604
|
+
export declare const getV1RebalancingSubscriptions: (params?: GetV1RebalancingSubscriptionsParams, options?: RequestInit) => Promise<getV1RebalancingSubscriptionsResponse>;
|
|
2605
|
+
export type postV1RebalancingSubscriptionsResponse200 = {
|
|
2606
|
+
data: PortfolioSubscription;
|
|
2607
|
+
status: 200;
|
|
2608
|
+
};
|
|
2609
|
+
export type postV1RebalancingSubscriptionsResponseSuccess = (postV1RebalancingSubscriptionsResponse200) & {
|
|
2610
|
+
headers: Headers;
|
|
2611
|
+
};
|
|
2612
|
+
export type postV1RebalancingSubscriptionsResponse = (postV1RebalancingSubscriptionsResponseSuccess);
|
|
2613
|
+
export declare const getPostV1RebalancingSubscriptionsUrl: () => string;
|
|
2614
|
+
/**
|
|
2615
|
+
* Creates a subscription between an account and a portfolio.
|
|
2616
|
+
* @summary Create Subscription
|
|
2617
|
+
*/
|
|
2618
|
+
export declare const postV1RebalancingSubscriptions: (postV1RebalancingSubscriptionsBody?: PostV1RebalancingSubscriptionsBody, options?: RequestInit) => Promise<postV1RebalancingSubscriptionsResponse>;
|
|
2619
|
+
export type deleteV1RebalancingSubscriptionsSubscriptionIdResponse204 = {
|
|
2620
|
+
data: void;
|
|
2621
|
+
status: 204;
|
|
2622
|
+
};
|
|
2623
|
+
export type deleteV1RebalancingSubscriptionsSubscriptionIdResponseSuccess = (deleteV1RebalancingSubscriptionsSubscriptionIdResponse204) & {
|
|
2624
|
+
headers: Headers;
|
|
2625
|
+
};
|
|
2626
|
+
export type deleteV1RebalancingSubscriptionsSubscriptionIdResponse = (deleteV1RebalancingSubscriptionsSubscriptionIdResponseSuccess);
|
|
2627
|
+
export declare const getDeleteV1RebalancingSubscriptionsSubscriptionIdUrl: (subscriptionId: string) => string;
|
|
2628
|
+
/**
|
|
2629
|
+
* Deletes the subscription which stops the rebalancing of an account.
|
|
2630
|
+
* @summary Unsubscribe Account (Delete Subscription)
|
|
2631
|
+
*/
|
|
2632
|
+
export declare const deleteV1RebalancingSubscriptionsSubscriptionId: (subscriptionId: string, options?: RequestInit) => Promise<deleteV1RebalancingSubscriptionsSubscriptionIdResponse>;
|
|
2633
|
+
export type getV1RebalancingSubscriptionsSubscriptionIdResponse200 = {
|
|
2634
|
+
data: PortfolioSubscription;
|
|
2635
|
+
status: 200;
|
|
2636
|
+
};
|
|
2637
|
+
export type getV1RebalancingSubscriptionsSubscriptionIdResponseSuccess = (getV1RebalancingSubscriptionsSubscriptionIdResponse200) & {
|
|
2638
|
+
headers: Headers;
|
|
2639
|
+
};
|
|
2640
|
+
export type getV1RebalancingSubscriptionsSubscriptionIdResponse = (getV1RebalancingSubscriptionsSubscriptionIdResponseSuccess);
|
|
2641
|
+
export declare const getGetV1RebalancingSubscriptionsSubscriptionIdUrl: (subscriptionId: string) => string;
|
|
2642
|
+
/**
|
|
2643
|
+
* Get a subscription by its ID.
|
|
2644
|
+
* @summary Get Subscription by ID
|
|
2645
|
+
*/
|
|
2646
|
+
export declare const getV1RebalancingSubscriptionsSubscriptionId: (subscriptionId: string, options?: RequestInit) => Promise<getV1RebalancingSubscriptionsSubscriptionIdResponse>;
|
|
2647
|
+
export type getV1ReportingEodAggregatePositionsResponse200 = {
|
|
2648
|
+
data: AggregatePositionResponse[];
|
|
2649
|
+
status: 200;
|
|
2650
|
+
};
|
|
2651
|
+
export type getV1ReportingEodAggregatePositionsResponseSuccess = (getV1ReportingEodAggregatePositionsResponse200) & {
|
|
2652
|
+
headers: Headers;
|
|
2653
|
+
};
|
|
2654
|
+
export type getV1ReportingEodAggregatePositionsResponse = (getV1ReportingEodAggregatePositionsResponseSuccess);
|
|
2655
|
+
export declare const getGetV1ReportingEodAggregatePositionsUrl: (params: GetV1ReportingEodAggregatePositionsParams) => string;
|
|
2656
|
+
/**
|
|
2657
|
+
* This API endpoint provides reporting data to partners for aggregate common stock and crypto positions across their account base. Partners can view historical snapshots of their holding across their entire account base. Please note that this API utilizes an 8:00 pm (EST) cutoff which aligns with the end of the Securities extended hours trading session as well as Alpaca's 24 hour Crypto trading window. Additionally, the endpoint supports indexing to help the partner efficiently filter by key information including date and symbol while being able to include or remove firm accounts.
|
|
2658
|
+
* @summary Retrieve Aggregate Positions
|
|
2659
|
+
*/
|
|
2660
|
+
export declare const getV1ReportingEodAggregatePositions: (params: GetV1ReportingEodAggregatePositionsParams, options?: RequestInit) => Promise<getV1ReportingEodAggregatePositionsResponse>;
|
|
2661
|
+
export type getV1GetEodCashInterestReportResponse200 = {
|
|
2662
|
+
data: EoDCashInterestReportResponse;
|
|
2663
|
+
status: 200;
|
|
2664
|
+
};
|
|
2665
|
+
export type getV1GetEodCashInterestReportResponse400 = {
|
|
2666
|
+
data: Error;
|
|
2667
|
+
status: 400;
|
|
2668
|
+
};
|
|
2669
|
+
export type getV1GetEodCashInterestReportResponse401 = {
|
|
2670
|
+
data: Error;
|
|
2671
|
+
status: 401;
|
|
2672
|
+
};
|
|
2673
|
+
export type getV1GetEodCashInterestReportResponse429 = {
|
|
2674
|
+
data: Error;
|
|
2675
|
+
status: 429;
|
|
2676
|
+
};
|
|
2677
|
+
export type getV1GetEodCashInterestReportResponse500 = {
|
|
2678
|
+
data: Error;
|
|
2679
|
+
status: 500;
|
|
2680
|
+
};
|
|
2681
|
+
export type getV1GetEodCashInterestReportResponseSuccess = (getV1GetEodCashInterestReportResponse200) & {
|
|
2682
|
+
headers: Headers;
|
|
2683
|
+
};
|
|
2684
|
+
export type getV1GetEodCashInterestReportResponseError = (getV1GetEodCashInterestReportResponse400 | getV1GetEodCashInterestReportResponse401 | getV1GetEodCashInterestReportResponse429 | getV1GetEodCashInterestReportResponse500) & {
|
|
2685
|
+
headers: Headers;
|
|
2686
|
+
};
|
|
2687
|
+
export type getV1GetEodCashInterestReportResponse = (getV1GetEodCashInterestReportResponseSuccess | getV1GetEodCashInterestReportResponseError);
|
|
2688
|
+
export declare const getGetV1GetEodCashInterestReportUrl: (params?: GetV1GetEodCashInterestReportParams) => string;
|
|
2689
|
+
/**
|
|
2690
|
+
* This API retrieves a list of cash interest details for the given date(s) for a single account or all accounts. End-of-day (EOD) details are typically accessible after 8:00pm Eastern Time (ET) and reflect that day's ending state across cash balances, accrued interest, accrued fees, as well as additional ancillary details.
|
|
2691
|
+
* @summary Retrieve EOD Cash Interest Details
|
|
2692
|
+
*/
|
|
2693
|
+
export declare const getV1GetEodCashInterestReport: (params?: GetV1GetEodCashInterestReportParams, options?: RequestInit) => Promise<getV1GetEodCashInterestReportResponse>;
|
|
2694
|
+
export type getV1ReportingEodPositionsResponse200 = {
|
|
2695
|
+
data: GetV1ReportingEodPositions200;
|
|
2696
|
+
status: 200;
|
|
2697
|
+
};
|
|
2698
|
+
export type getV1ReportingEodPositionsResponse422 = {
|
|
2699
|
+
data: void;
|
|
2700
|
+
status: 422;
|
|
2701
|
+
};
|
|
2702
|
+
export type getV1ReportingEodPositionsResponseSuccess = (getV1ReportingEodPositionsResponse200) & {
|
|
2703
|
+
headers: Headers;
|
|
2704
|
+
};
|
|
2705
|
+
export type getV1ReportingEodPositionsResponseError = (getV1ReportingEodPositionsResponse422) & {
|
|
2706
|
+
headers: Headers;
|
|
2707
|
+
};
|
|
2708
|
+
export type getV1ReportingEodPositionsResponse = (getV1ReportingEodPositionsResponseSuccess | getV1ReportingEodPositionsResponseError);
|
|
2709
|
+
export declare const getGetV1ReportingEodPositionsUrl: (params?: GetV1ReportingEodPositionsParams) => string;
|
|
2710
|
+
/**
|
|
2711
|
+
* This API retrieves a comprehensive list of end-of-day positions for all accounts. End-of-day (EOD) positions are typically accessible after 4:00 am Eastern Time (ET) on the following day, providing a comprehensive view of the day's closing positions across all accounts.
|
|
2712
|
+
* This API currently only supports retrieving EOD positions for the last trading date.
|
|
2713
|
+
* @summary Retrieve EOD Positions
|
|
2714
|
+
*/
|
|
2715
|
+
export declare const getV1ReportingEodPositions: (params?: GetV1ReportingEodPositionsParams, options?: RequestInit) => Promise<getV1ReportingEodPositionsResponse>;
|
|
2716
|
+
export type getTradingAccountResponse200 = {
|
|
2717
|
+
data: TradeAccount;
|
|
2718
|
+
status: 200;
|
|
2719
|
+
};
|
|
2720
|
+
export type getTradingAccountResponseSuccess = (getTradingAccountResponse200) & {
|
|
2721
|
+
headers: Headers;
|
|
2722
|
+
};
|
|
2723
|
+
export type getTradingAccountResponse = (getTradingAccountResponseSuccess);
|
|
2724
|
+
export declare const getGetTradingAccountUrl: (accountId: string) => string;
|
|
2725
|
+
/**
|
|
2726
|
+
* As a broker you can view more trading details about your users.
|
|
2727
|
+
*
|
|
2728
|
+
* The response is a Trading Account model.
|
|
2729
|
+
* @summary Retrieve Trading Details for an Account
|
|
2730
|
+
*/
|
|
2731
|
+
export declare const getTradingAccount: (accountId: string, options?: RequestInit) => Promise<getTradingAccountResponse>;
|
|
2732
|
+
export type patchPATCHV1TradingAccountsAccountIdAccountConfigurationsResponse200 = {
|
|
2733
|
+
data: AccountConfigurations;
|
|
2734
|
+
status: 200;
|
|
2735
|
+
};
|
|
2736
|
+
export type patchPATCHV1TradingAccountsAccountIdAccountConfigurationsResponseSuccess = (patchPATCHV1TradingAccountsAccountIdAccountConfigurationsResponse200) & {
|
|
2737
|
+
headers: Headers;
|
|
2738
|
+
};
|
|
2739
|
+
export type patchPATCHV1TradingAccountsAccountIdAccountConfigurationsResponse = (patchPATCHV1TradingAccountsAccountIdAccountConfigurationsResponseSuccess);
|
|
2740
|
+
export declare const getPatchPATCHV1TradingAccountsAccountIdAccountConfigurationsUrl: (accountId: string) => string;
|
|
2741
|
+
/**
|
|
2742
|
+
* You can also set the margin settings for your users' account by passing a PATCH request. By default any account with funds under $2,000 is set a margin multiplier of 1.0, and accounts with over $2,000 are set to 2.0.
|
|
2743
|
+
* @summary Update Trading Configurations for an Account
|
|
2744
|
+
*/
|
|
2745
|
+
export declare const patchPATCHV1TradingAccountsAccountIdAccountConfigurations: (accountId: string, accountConfigurations?: AccountConfigurations, options?: RequestInit) => Promise<patchPATCHV1TradingAccountsAccountIdAccountConfigurationsResponse>;
|
|
2746
|
+
export type pdtOneTimeRemovalResponse200 = {
|
|
2747
|
+
data: PDTRemoval;
|
|
2748
|
+
status: 200;
|
|
2749
|
+
};
|
|
2750
|
+
export type pdtOneTimeRemovalResponse403 = {
|
|
2751
|
+
data: Error;
|
|
2752
|
+
status: 403;
|
|
2753
|
+
};
|
|
2754
|
+
export type pdtOneTimeRemovalResponseSuccess = (pdtOneTimeRemovalResponse200) & {
|
|
2755
|
+
headers: Headers;
|
|
2756
|
+
};
|
|
2757
|
+
export type pdtOneTimeRemovalResponseError = (pdtOneTimeRemovalResponse403) & {
|
|
2758
|
+
headers: Headers;
|
|
2759
|
+
};
|
|
2760
|
+
export type pdtOneTimeRemovalResponse = (pdtOneTimeRemovalResponseSuccess | pdtOneTimeRemovalResponseError);
|
|
2761
|
+
export declare const getPdtOneTimeRemovalUrl: (accountId: string) => string;
|
|
2762
|
+
/**
|
|
2763
|
+
* **Deprecation notice**
|
|
2764
|
+
*
|
|
2765
|
+
* FINRA's revised Rule 4210 replaces the legacy Pattern Day Trading (PDT) framework with an intraday margin regime, so this endpoint no longer reflects current regulatory behavior. See https://docs.alpaca.markets/us/docs/understanding-finras-new-intraday-margin-rule-and-the-end-of-pdt
|
|
2766
|
+
*
|
|
2767
|
+
* This endpoint will be sunset July 6, 2026. Please remove calls to PDT-specific endpoints before this date.
|
|
2768
|
+
*
|
|
2769
|
+
* ---
|
|
2770
|
+
*
|
|
2771
|
+
* Requests the exercise of pattern day trader one time removal for given account
|
|
2772
|
+
* @deprecated
|
|
2773
|
+
* @summary Exercise PDT one time removal
|
|
2774
|
+
*/
|
|
2775
|
+
export declare const pdtOneTimeRemoval: (accountId: string, options?: RequestInit) => Promise<pdtOneTimeRemovalResponse>;
|
|
2776
|
+
export type pdtGetStatusResponse200 = {
|
|
2777
|
+
data: PDTStatus;
|
|
2778
|
+
status: 200;
|
|
2779
|
+
};
|
|
2780
|
+
export type pdtGetStatusResponseSuccess = (pdtGetStatusResponse200) & {
|
|
2781
|
+
headers: Headers;
|
|
2782
|
+
};
|
|
2783
|
+
export type pdtGetStatusResponse = (pdtGetStatusResponseSuccess);
|
|
2784
|
+
export declare const getPdtGetStatusUrl: (accountId: string) => string;
|
|
2785
|
+
/**
|
|
2786
|
+
* **Deprecation notice**
|
|
2787
|
+
*
|
|
2788
|
+
* FINRA's revised Rule 4210 replaces the legacy Pattern Day Trading (PDT) framework with an intraday margin regime, so this endpoint no longer reflects current regulatory behavior. See https://docs.alpaca.markets/us/docs/understanding-finras-new-intraday-margin-rule-and-the-end-of-pdt
|
|
2789
|
+
*
|
|
2790
|
+
* This endpoint will be sunset July 6, 2026. Please remove calls to PDT-specific endpoints before this date.
|
|
2791
|
+
*
|
|
2792
|
+
* ---
|
|
2793
|
+
*
|
|
2794
|
+
* Retrieves the account's pattern day trader status
|
|
2795
|
+
* @deprecated
|
|
2796
|
+
* @summary Get Pattern Day Trader Status for account
|
|
2797
|
+
*/
|
|
2798
|
+
export declare const pdtGetStatus: (accountId: string, options?: RequestInit) => Promise<pdtGetStatusResponse>;
|
|
2799
|
+
export type getV1TradingAccountsAccountIdAccountPortfolioHistoryResponse200 = {
|
|
2800
|
+
data: PortfolioHistory;
|
|
2801
|
+
status: 200;
|
|
2802
|
+
};
|
|
2803
|
+
export type getV1TradingAccountsAccountIdAccountPortfolioHistoryResponseSuccess = (getV1TradingAccountsAccountIdAccountPortfolioHistoryResponse200) & {
|
|
2804
|
+
headers: Headers;
|
|
2805
|
+
};
|
|
2806
|
+
export type getV1TradingAccountsAccountIdAccountPortfolioHistoryResponse = (getV1TradingAccountsAccountIdAccountPortfolioHistoryResponseSuccess);
|
|
2807
|
+
export declare const getGetV1TradingAccountsAccountIdAccountPortfolioHistoryUrl: (accountId: string, params?: GetV1TradingAccountsAccountIdAccountPortfolioHistoryParams) => string;
|
|
2808
|
+
/**
|
|
2809
|
+
* Returns timeseries data about equity and profit/loss (P/L) of the account in requested timespan.
|
|
2810
|
+
* @summary Get Account Portfolio History
|
|
2811
|
+
*/
|
|
2812
|
+
export declare const getV1TradingAccountsAccountIdAccountPortfolioHistory: (accountId: string, params?: GetV1TradingAccountsAccountIdAccountPortfolioHistoryParams, options?: RequestInit) => Promise<getV1TradingAccountsAccountIdAccountPortfolioHistoryResponse>;
|
|
2813
|
+
export type getV1AccountTradingLimitsResponse200 = {
|
|
2814
|
+
data: AccountTradingLimit;
|
|
2815
|
+
status: 200;
|
|
2816
|
+
};
|
|
2817
|
+
export type getV1AccountTradingLimitsResponse404 = {
|
|
2818
|
+
data: void;
|
|
2819
|
+
status: 404;
|
|
2820
|
+
};
|
|
2821
|
+
export type getV1AccountTradingLimitsResponseSuccess = (getV1AccountTradingLimitsResponse200) & {
|
|
2822
|
+
headers: Headers;
|
|
2823
|
+
};
|
|
2824
|
+
export type getV1AccountTradingLimitsResponseError = (getV1AccountTradingLimitsResponse404) & {
|
|
2825
|
+
headers: Headers;
|
|
2826
|
+
};
|
|
2827
|
+
export type getV1AccountTradingLimitsResponse = (getV1AccountTradingLimitsResponseSuccess | getV1AccountTradingLimitsResponseError);
|
|
2828
|
+
export declare const getGetV1AccountTradingLimitsUrl: (accountId: string) => string;
|
|
2829
|
+
/**
|
|
2830
|
+
* This endpoint is only available to accounts with the trading limits feature enabled, and not on JIT.
|
|
2831
|
+
* The daily trading limit is set at the correspondent level (or the account level) and is used as the limit for the total amount due to Alpaca on the date of settlement.
|
|
2832
|
+
* The limit in use returns the real time usage of this limit, based on the setup it uses the usage is calculated differently.
|
|
2833
|
+
* If the limit in use reaches the `daily_net_limit` or `available` is zero, further purchasing activity will be halted, however, the limit can be adjusted by reaching out to Alpaca with the proposed new limit and the reason for the change.
|
|
2834
|
+
* @summary Retrieve real-time Trading Limits for an Account
|
|
2835
|
+
*/
|
|
2836
|
+
export declare const getV1AccountTradingLimits: (accountId: string, options?: RequestInit) => Promise<getV1AccountTradingLimitsResponse>;
|
|
2837
|
+
export type deleteAllOrdersForAccountResponse207 = {
|
|
2838
|
+
data: OrderClosedResponse[];
|
|
2839
|
+
status: 207;
|
|
2840
|
+
};
|
|
2841
|
+
export type deleteAllOrdersForAccountResponse400 = {
|
|
2842
|
+
data: BadRequestResponse;
|
|
2843
|
+
status: 400;
|
|
2844
|
+
};
|
|
2845
|
+
export type deleteAllOrdersForAccountResponse404 = {
|
|
2846
|
+
data: NotFoundResponse;
|
|
2847
|
+
status: 404;
|
|
2848
|
+
};
|
|
2849
|
+
export type deleteAllOrdersForAccountResponseSuccess = (deleteAllOrdersForAccountResponse207) & {
|
|
2850
|
+
headers: Headers;
|
|
2851
|
+
};
|
|
2852
|
+
export type deleteAllOrdersForAccountResponseError = (deleteAllOrdersForAccountResponse400 | deleteAllOrdersForAccountResponse404) & {
|
|
2853
|
+
headers: Headers;
|
|
2854
|
+
};
|
|
2855
|
+
export type deleteAllOrdersForAccountResponse = (deleteAllOrdersForAccountResponseSuccess | deleteAllOrdersForAccountResponseError);
|
|
2856
|
+
export declare const getDeleteAllOrdersForAccountUrl: (accountId: string) => string;
|
|
2857
|
+
/**
|
|
2858
|
+
* Attempts to cancel all open orders. A response will be provided for each order that is attempted to be cancelled.
|
|
2859
|
+
* @summary Cancel all Open Orders For an Account
|
|
2860
|
+
*/
|
|
2861
|
+
export declare const deleteAllOrdersForAccount: (accountId: string, options?: RequestInit) => Promise<deleteAllOrdersForAccountResponse>;
|
|
2862
|
+
export type getAllOrdersForAccountResponse200 = {
|
|
2863
|
+
data: Order[];
|
|
2864
|
+
status: 200;
|
|
2865
|
+
};
|
|
2866
|
+
export type getAllOrdersForAccountResponse400 = {
|
|
2867
|
+
data: BadRequestResponse;
|
|
2868
|
+
status: 400;
|
|
2869
|
+
};
|
|
2870
|
+
export type getAllOrdersForAccountResponse404 = {
|
|
2871
|
+
data: NotFoundResponse;
|
|
2872
|
+
status: 404;
|
|
2873
|
+
};
|
|
2874
|
+
export type getAllOrdersForAccountResponseSuccess = (getAllOrdersForAccountResponse200) & {
|
|
2875
|
+
headers: Headers;
|
|
2876
|
+
};
|
|
2877
|
+
export type getAllOrdersForAccountResponseError = (getAllOrdersForAccountResponse400 | getAllOrdersForAccountResponse404) & {
|
|
2878
|
+
headers: Headers;
|
|
2879
|
+
};
|
|
2880
|
+
export type getAllOrdersForAccountResponse = (getAllOrdersForAccountResponseSuccess | getAllOrdersForAccountResponseError);
|
|
2881
|
+
export declare const getGetAllOrdersForAccountUrl: (accountId: string, params?: GetAllOrdersForAccountParams) => string;
|
|
2882
|
+
/**
|
|
2883
|
+
* Retrieves a list of orders for the account, filtered by the supplied query parameters.
|
|
2884
|
+
*
|
|
2885
|
+
* Endpoint defaults to open orders if no parameters are provided.
|
|
2886
|
+
* @summary Retrieve a List of Orders
|
|
2887
|
+
*/
|
|
2888
|
+
export declare const getAllOrdersForAccount: (accountId: string, params?: GetAllOrdersForAccountParams, options?: RequestInit) => Promise<getAllOrdersForAccountResponse>;
|
|
2889
|
+
export type createOrderForAccountResponse200 = {
|
|
2890
|
+
data: Order;
|
|
2891
|
+
status: 200;
|
|
2892
|
+
};
|
|
2893
|
+
export type createOrderForAccountResponse400 = {
|
|
2894
|
+
data: BadRequestResponse;
|
|
2895
|
+
status: 400;
|
|
2896
|
+
};
|
|
2897
|
+
export type createOrderForAccountResponse403 = {
|
|
2898
|
+
data: ForbiddenResponse;
|
|
2899
|
+
status: 403;
|
|
2900
|
+
};
|
|
2901
|
+
export type createOrderForAccountResponse404 = {
|
|
2902
|
+
data: NotFoundResponse;
|
|
2903
|
+
status: 404;
|
|
2904
|
+
};
|
|
2905
|
+
export type createOrderForAccountResponse422 = {
|
|
2906
|
+
data: void;
|
|
2907
|
+
status: 422;
|
|
2908
|
+
};
|
|
2909
|
+
export type createOrderForAccountResponseSuccess = (createOrderForAccountResponse200) & {
|
|
2910
|
+
headers: Headers;
|
|
2911
|
+
};
|
|
2912
|
+
export type createOrderForAccountResponseError = (createOrderForAccountResponse400 | createOrderForAccountResponse403 | createOrderForAccountResponse404 | createOrderForAccountResponse422) & {
|
|
2913
|
+
headers: Headers;
|
|
2914
|
+
};
|
|
2915
|
+
export type createOrderForAccountResponse = (createOrderForAccountResponseSuccess | createOrderForAccountResponseError);
|
|
2916
|
+
export declare const getCreateOrderForAccountUrl: (accountId: string) => string;
|
|
2917
|
+
/**
|
|
2918
|
+
* Creating an order for your end customer. Each trading request must pass in the account_id in the URL.
|
|
2919
|
+
*
|
|
2920
|
+
* - Note that when submitting crypto orders, `market`, `limit` and `stop_limit` orders are supported while the supported `time_in_force` values are `gtc`, and `ioc`.
|
|
2921
|
+
* - For equities and crypto we accept fractional orders as well with either `notional` or `qty` provided.
|
|
2922
|
+
* - Note that submitting an options order is only available for partners who have been enabled for Options BETA.
|
|
2923
|
+
* - In case of Fixed Income, only `market` and `limit` order types with `day` `time_in_force` are supported, and order replacement is not supported.
|
|
2924
|
+
* Note that submitting Fixed Income orders is only available for partners who have been enabled for Fixed Income.
|
|
2925
|
+
* - For IPO indications of interest (`asset_class: "ipo"`), the `symbol` is the offering reference returned by [`GET /v1/ipos`](#operation/listIPOOfferings) (e.g. `FI111225`). IPO orders are notional-only (`notional` required, `qty` must be omitted), buy-side, `market` type, and `gtc` time_in_force. Indications of interest can be replaced or canceled while the offering is open via [`PATCH /v1/trading/accounts/{account_id}/orders/{order_id}`](#operation/replaceOrderForAccount) and [`DELETE /v1/trading/accounts/{account_id}/orders/{order_id}`](#operation/deleteOrderForAccount).
|
|
2926
|
+
* @summary Create an Order for an Account
|
|
2927
|
+
*/
|
|
2928
|
+
export declare const createOrderForAccount: (accountId: string, createOrderRequest: CreateOrderRequest, options?: RequestInit) => Promise<createOrderForAccountResponse>;
|
|
2929
|
+
export type deleteOrderForAccountResponse204 = {
|
|
2930
|
+
data: void;
|
|
2931
|
+
status: 204;
|
|
2932
|
+
};
|
|
2933
|
+
export type deleteOrderForAccountResponse400 = {
|
|
2934
|
+
data: BadRequestResponse;
|
|
2935
|
+
status: 400;
|
|
2936
|
+
};
|
|
2937
|
+
export type deleteOrderForAccountResponse404 = {
|
|
2938
|
+
data: NotFoundResponse;
|
|
2939
|
+
status: 404;
|
|
2940
|
+
};
|
|
2941
|
+
export type deleteOrderForAccountResponseSuccess = (deleteOrderForAccountResponse204) & {
|
|
2942
|
+
headers: Headers;
|
|
2943
|
+
};
|
|
2944
|
+
export type deleteOrderForAccountResponseError = (deleteOrderForAccountResponse400 | deleteOrderForAccountResponse404) & {
|
|
2945
|
+
headers: Headers;
|
|
2946
|
+
};
|
|
2947
|
+
export type deleteOrderForAccountResponse = (deleteOrderForAccountResponseSuccess | deleteOrderForAccountResponseError);
|
|
2948
|
+
export declare const getDeleteOrderForAccountUrl: (accountId: string, orderId: string) => string;
|
|
2949
|
+
/**
|
|
2950
|
+
* Attempts to cancel an open order. If the order is no longer cancelable (for example if the status is "filled"), the server will respond with status 422, and reject the request.
|
|
2951
|
+
*
|
|
2952
|
+
* Upon acceptance of the cancel request, it returns status 204.
|
|
2953
|
+
* @summary Cancel an Open Order
|
|
2954
|
+
*/
|
|
2955
|
+
export declare const deleteOrderForAccount: (accountId: string, orderId: string, options?: RequestInit) => Promise<deleteOrderForAccountResponse>;
|
|
2956
|
+
export type getOrderForAccountResponse200 = {
|
|
2957
|
+
data: Order;
|
|
2958
|
+
status: 200;
|
|
2959
|
+
};
|
|
2960
|
+
export type getOrderForAccountResponse400 = {
|
|
2961
|
+
data: BadRequestResponse;
|
|
2962
|
+
status: 400;
|
|
2963
|
+
};
|
|
2964
|
+
export type getOrderForAccountResponse404 = {
|
|
2965
|
+
data: NotFoundResponse;
|
|
2966
|
+
status: 404;
|
|
2967
|
+
};
|
|
2968
|
+
export type getOrderForAccountResponseSuccess = (getOrderForAccountResponse200) & {
|
|
2969
|
+
headers: Headers;
|
|
2970
|
+
};
|
|
2971
|
+
export type getOrderForAccountResponseError = (getOrderForAccountResponse400 | getOrderForAccountResponse404) & {
|
|
2972
|
+
headers: Headers;
|
|
2973
|
+
};
|
|
2974
|
+
export type getOrderForAccountResponse = (getOrderForAccountResponseSuccess | getOrderForAccountResponseError);
|
|
2975
|
+
export declare const getGetOrderForAccountUrl: (accountId: string, orderId: string) => string;
|
|
2976
|
+
/**
|
|
2977
|
+
* Retrieves a single order for the given order_id.
|
|
2978
|
+
* @summary Retrieve an Order by its ID
|
|
2979
|
+
*/
|
|
2980
|
+
export declare const getOrderForAccount: (accountId: string, orderId: string, options?: RequestInit) => Promise<getOrderForAccountResponse>;
|
|
2981
|
+
export type replaceOrderForAccountResponse200 = {
|
|
2982
|
+
data: Order;
|
|
2983
|
+
status: 200;
|
|
2984
|
+
};
|
|
2985
|
+
export type replaceOrderForAccountResponse400 = {
|
|
2986
|
+
data: BadRequestResponse;
|
|
2987
|
+
status: 400;
|
|
2988
|
+
};
|
|
2989
|
+
export type replaceOrderForAccountResponse403 = {
|
|
2990
|
+
data: void;
|
|
2991
|
+
status: 403;
|
|
2992
|
+
};
|
|
2993
|
+
export type replaceOrderForAccountResponse404 = {
|
|
2994
|
+
data: NotFoundResponse;
|
|
2995
|
+
status: 404;
|
|
2996
|
+
};
|
|
2997
|
+
export type replaceOrderForAccountResponseSuccess = (replaceOrderForAccountResponse200) & {
|
|
2998
|
+
headers: Headers;
|
|
2999
|
+
};
|
|
3000
|
+
export type replaceOrderForAccountResponseError = (replaceOrderForAccountResponse400 | replaceOrderForAccountResponse403 | replaceOrderForAccountResponse404) & {
|
|
3001
|
+
headers: Headers;
|
|
3002
|
+
};
|
|
3003
|
+
export type replaceOrderForAccountResponse = (replaceOrderForAccountResponseSuccess | replaceOrderForAccountResponseError);
|
|
3004
|
+
export declare const getReplaceOrderForAccountUrl: (accountId: string, orderId: string) => string;
|
|
3005
|
+
/**
|
|
3006
|
+
* Replaces a single order with updated parameters. Each parameter overrides the corresponding attribute of the existing order. The other attributes remain the same as the existing order.
|
|
3007
|
+
*
|
|
3008
|
+
* A success return code from a replaced order does NOT guarantee the existing open order has been replaced. If the existing open order is filled before the replacing (new) order reaches the execution venue, the replacing (new) order is rejected, and these events are sent in the trade_updates stream channel found [here](https://docs.alpaca.markets/reference/subscribetotradev2sse).
|
|
3009
|
+
*
|
|
3010
|
+
* While an order is being replaced, the account's buying power is reduced by the larger of the two orders that have been placed (the old order being replaced, and the newly placed order to replace it). If you are replacing a buy entry order with a higher limit price than the original order, the buying power is calculated based on the newly placed order. If you are replacing it with a lower limit price, the buying power is calculated based on the old order.
|
|
3011
|
+
*
|
|
3012
|
+
* Note: Order cannot be replaced when the status is `accepted`, `pending_new`, `pending_cancel` or `pending_replace`.
|
|
3013
|
+
*
|
|
3014
|
+
* Note: Notional orders for non-IPO asset classes cannot be replaced. Any attempt to modify a non-IPO notional order via this endpoint will be rejected; cancel it and submit a new one instead.
|
|
3015
|
+
*
|
|
3016
|
+
* Note: IPO indications of interest (`asset_class: "ipo"`) **are** notional and **can** be replaced via this endpoint by providing a new `notional` value. `qty` and `notional` are mutually exclusive on a single replace request.
|
|
3017
|
+
* @summary Replace an Order
|
|
3018
|
+
*/
|
|
3019
|
+
export declare const replaceOrderForAccount: (accountId: string, orderId: string, updateOrderRequest: UpdateOrderRequest, options?: RequestInit) => Promise<replaceOrderForAccountResponse>;
|
|
3020
|
+
export type getV1TradingAccountsAccountIdOrdersEstimationResponse200 = {
|
|
3021
|
+
data: Order;
|
|
3022
|
+
status: 200;
|
|
3023
|
+
};
|
|
3024
|
+
export type getV1TradingAccountsAccountIdOrdersEstimationResponseSuccess = (getV1TradingAccountsAccountIdOrdersEstimationResponse200) & {
|
|
3025
|
+
headers: Headers;
|
|
3026
|
+
};
|
|
3027
|
+
export type getV1TradingAccountsAccountIdOrdersEstimationResponse = (getV1TradingAccountsAccountIdOrdersEstimationResponseSuccess);
|
|
3028
|
+
export declare const getGetV1TradingAccountsAccountIdOrdersEstimationUrl: (accountId: string) => string;
|
|
3029
|
+
/**
|
|
3030
|
+
* Order estimation endpoint will display, based on user's account balance, the estimated quantity and price they will receive for their notional order.
|
|
3031
|
+
*
|
|
3032
|
+
* For LCT - customer's order will include the Alpaca swap_fee, while correspondent side swap_fee is configurable in the API call. Utilising this API does not result in a real order and after the calculation - the user's buying power reverts to the previous state.
|
|
3033
|
+
*
|
|
3034
|
+
* Responses and Errors are the same as with the Orders API
|
|
3035
|
+
*
|
|
3036
|
+
* Please note that the estimation is based on the market condition at the time of submission and a live order will differ. The output should be considered indicative.
|
|
3037
|
+
*
|
|
3038
|
+
* **Note:** This does not support Crypto or non-market orders at this time.
|
|
3039
|
+
* @summary Estimate an Order
|
|
3040
|
+
*/
|
|
3041
|
+
export declare const getV1TradingAccountsAccountIdOrdersEstimation: (accountId: string, getV1TradingAccountsAccountIdOrdersEstimationBody?: GetV1TradingAccountsAccountIdOrdersEstimationBody, options?: RequestInit) => Promise<getV1TradingAccountsAccountIdOrdersEstimationResponse>;
|
|
3042
|
+
export type getOrderByClientOrderIdForAccountResponse200 = {
|
|
3043
|
+
data: Order;
|
|
3044
|
+
status: 200;
|
|
3045
|
+
};
|
|
3046
|
+
export type getOrderByClientOrderIdForAccountResponse400 = {
|
|
3047
|
+
data: BadRequestResponse;
|
|
3048
|
+
status: 400;
|
|
3049
|
+
};
|
|
3050
|
+
export type getOrderByClientOrderIdForAccountResponse404 = {
|
|
3051
|
+
data: NotFoundResponse;
|
|
3052
|
+
status: 404;
|
|
3053
|
+
};
|
|
3054
|
+
export type getOrderByClientOrderIdForAccountResponseSuccess = (getOrderByClientOrderIdForAccountResponse200) & {
|
|
3055
|
+
headers: Headers;
|
|
3056
|
+
};
|
|
3057
|
+
export type getOrderByClientOrderIdForAccountResponseError = (getOrderByClientOrderIdForAccountResponse400 | getOrderByClientOrderIdForAccountResponse404) & {
|
|
3058
|
+
headers: Headers;
|
|
3059
|
+
};
|
|
3060
|
+
export type getOrderByClientOrderIdForAccountResponse = (getOrderByClientOrderIdForAccountResponseSuccess | getOrderByClientOrderIdForAccountResponseError);
|
|
3061
|
+
export declare const getGetOrderByClientOrderIdForAccountUrl: (accountId: string, params: GetOrderByClientOrderIdForAccountParams) => string;
|
|
3062
|
+
/**
|
|
3063
|
+
* Retrieves a single order specified by the client order ID.
|
|
3064
|
+
* @summary Retrieves a single order specified by the client order ID.
|
|
3065
|
+
*/
|
|
3066
|
+
export declare const getOrderByClientOrderIdForAccount: (accountId: string, params: GetOrderByClientOrderIdForAccountParams, options?: RequestInit) => Promise<getOrderByClientOrderIdForAccountResponse>;
|
|
3067
|
+
export type closeAllPositionsForAccountResponse207 = {
|
|
3068
|
+
data: PositionClosedResponse[];
|
|
3069
|
+
status: 207;
|
|
3070
|
+
};
|
|
3071
|
+
export type closeAllPositionsForAccountResponse500 = {
|
|
3072
|
+
data: void;
|
|
3073
|
+
status: 500;
|
|
3074
|
+
};
|
|
3075
|
+
export type closeAllPositionsForAccountResponseSuccess = (closeAllPositionsForAccountResponse207) & {
|
|
3076
|
+
headers: Headers;
|
|
3077
|
+
};
|
|
3078
|
+
export type closeAllPositionsForAccountResponseError = (closeAllPositionsForAccountResponse500) & {
|
|
3079
|
+
headers: Headers;
|
|
3080
|
+
};
|
|
3081
|
+
export type closeAllPositionsForAccountResponse = (closeAllPositionsForAccountResponseSuccess | closeAllPositionsForAccountResponseError);
|
|
3082
|
+
export declare const getCloseAllPositionsForAccountUrl: (accountId: string, params?: CloseAllPositionsForAccountParams) => string;
|
|
3083
|
+
/**
|
|
3084
|
+
* Closes (liquidates) all of the account's open long and short positions. A response will be provided for each order that is attempted to be cancelled. If an order is no longer cancelable, the server will respond with status 500 and reject the request.
|
|
3085
|
+
* @summary Close All Positions for an Account
|
|
3086
|
+
*/
|
|
3087
|
+
export declare const closeAllPositionsForAccount: (accountId: string, params?: CloseAllPositionsForAccountParams, options?: RequestInit) => Promise<closeAllPositionsForAccountResponse>;
|
|
3088
|
+
export type getPositionsForAccountResponse200 = {
|
|
3089
|
+
data: Position[];
|
|
3090
|
+
status: 200;
|
|
3091
|
+
};
|
|
3092
|
+
export type getPositionsForAccountResponseSuccess = (getPositionsForAccountResponse200) & {
|
|
3093
|
+
headers: Headers;
|
|
3094
|
+
};
|
|
3095
|
+
export type getPositionsForAccountResponse = (getPositionsForAccountResponseSuccess);
|
|
3096
|
+
export declare const getGetPositionsForAccountUrl: (accountId: string) => string;
|
|
3097
|
+
/**
|
|
3098
|
+
* List open positions for an account
|
|
3099
|
+
* @summary List Open Positions for an Account
|
|
3100
|
+
*/
|
|
3101
|
+
export declare const getPositionsForAccount: (accountId: string, options?: RequestInit) => Promise<getPositionsForAccountResponse>;
|
|
3102
|
+
export type closePositionForAccountBySymbolResponse200 = {
|
|
3103
|
+
data: Order;
|
|
3104
|
+
status: 200;
|
|
3105
|
+
};
|
|
3106
|
+
export type closePositionForAccountBySymbolResponseSuccess = (closePositionForAccountBySymbolResponse200) & {
|
|
3107
|
+
headers: Headers;
|
|
3108
|
+
};
|
|
3109
|
+
export type closePositionForAccountBySymbolResponse = (closePositionForAccountBySymbolResponseSuccess);
|
|
3110
|
+
export declare const getClosePositionForAccountBySymbolUrl: (accountId: string, symbolOrAssetId: string, params?: ClosePositionForAccountBySymbolParams) => string;
|
|
3111
|
+
/**
|
|
3112
|
+
* Closes (liquidates) the account's open position for the given symbol. Works for both long and short positions.
|
|
3113
|
+
* @summary Close a Position for an Account
|
|
3114
|
+
*/
|
|
3115
|
+
export declare const closePositionForAccountBySymbol: (accountId: string, symbolOrAssetId: string, params?: ClosePositionForAccountBySymbolParams, options?: RequestInit) => Promise<closePositionForAccountBySymbolResponse>;
|
|
3116
|
+
export type getPositionsForAccountBySymbolResponse200 = {
|
|
3117
|
+
data: Position;
|
|
3118
|
+
status: 200;
|
|
3119
|
+
};
|
|
3120
|
+
export type getPositionsForAccountBySymbolResponse404 = {
|
|
3121
|
+
data: void;
|
|
3122
|
+
status: 404;
|
|
3123
|
+
};
|
|
3124
|
+
export type getPositionsForAccountBySymbolResponseSuccess = (getPositionsForAccountBySymbolResponse200) & {
|
|
3125
|
+
headers: Headers;
|
|
3126
|
+
};
|
|
3127
|
+
export type getPositionsForAccountBySymbolResponseError = (getPositionsForAccountBySymbolResponse404) & {
|
|
3128
|
+
headers: Headers;
|
|
3129
|
+
};
|
|
3130
|
+
export type getPositionsForAccountBySymbolResponse = (getPositionsForAccountBySymbolResponseSuccess | getPositionsForAccountBySymbolResponseError);
|
|
3131
|
+
export declare const getGetPositionsForAccountBySymbolUrl: (accountId: string, symbolOrAssetId: string) => string;
|
|
3132
|
+
/**
|
|
3133
|
+
* Retrieves the account's open position for the given symbol or asset_id.
|
|
3134
|
+
* @summary Get an Open Position for account by Symbol or AssetId
|
|
3135
|
+
*/
|
|
3136
|
+
export declare const getPositionsForAccountBySymbol: (accountId: string, symbolOrAssetId: string, options?: RequestInit) => Promise<getPositionsForAccountBySymbolResponse>;
|
|
3137
|
+
export type optionDoNotExerciseResponse200 = {
|
|
3138
|
+
data: DoNotExerciseResponse;
|
|
3139
|
+
status: 200;
|
|
3140
|
+
};
|
|
3141
|
+
export type optionDoNotExerciseResponse403 = {
|
|
3142
|
+
data: Error;
|
|
3143
|
+
status: 403;
|
|
3144
|
+
};
|
|
3145
|
+
export type optionDoNotExerciseResponse422 = {
|
|
3146
|
+
data: Error;
|
|
3147
|
+
status: 422;
|
|
3148
|
+
};
|
|
3149
|
+
export type optionDoNotExerciseResponseSuccess = (optionDoNotExerciseResponse200) & {
|
|
3150
|
+
headers: Headers;
|
|
3151
|
+
};
|
|
3152
|
+
export type optionDoNotExerciseResponseError = (optionDoNotExerciseResponse403 | optionDoNotExerciseResponse422) & {
|
|
3153
|
+
headers: Headers;
|
|
3154
|
+
};
|
|
3155
|
+
export type optionDoNotExerciseResponse = (optionDoNotExerciseResponseSuccess | optionDoNotExerciseResponseError);
|
|
3156
|
+
export declare const getOptionDoNotExerciseUrl: (accountId: string, symbolOrContractId: string) => string;
|
|
3157
|
+
/**
|
|
3158
|
+
* This endpoint enables users to submit a do-not-exercise (DNE) instruction for a held option contract, preventing automatic exercise at expiry.
|
|
3159
|
+
* By default, Alpaca will automatically exercise in-the-money (ITM) contracts at expiry. This endpoint allows users to override that behavior.
|
|
3160
|
+
* DNE requests will be processed immediately once received. DNE requests submitted between market close and midnight will be rejected to avoid any confusion about when the instruction will take effect.
|
|
3161
|
+
* To cancel a DNE request or to submit an exercise instruction, please contact our support team.
|
|
3162
|
+
* @summary Do Not Exercise an Options Position (BETA)
|
|
3163
|
+
*/
|
|
3164
|
+
export declare const optionDoNotExercise: (accountId: string, symbolOrContractId: string, doNotExerciseRequest?: DoNotExerciseRequest, options?: RequestInit) => Promise<optionDoNotExerciseResponse>;
|
|
3165
|
+
export type optionExerciseResponse200 = {
|
|
3166
|
+
data: ExerciseResponse;
|
|
3167
|
+
status: 200;
|
|
3168
|
+
};
|
|
3169
|
+
export type optionExerciseResponse403 = {
|
|
3170
|
+
data: Error;
|
|
3171
|
+
status: 403;
|
|
3172
|
+
};
|
|
3173
|
+
export type optionExerciseResponseSuccess = (optionExerciseResponse200) & {
|
|
3174
|
+
headers: Headers;
|
|
3175
|
+
};
|
|
3176
|
+
export type optionExerciseResponseError = (optionExerciseResponse403) & {
|
|
3177
|
+
headers: Headers;
|
|
3178
|
+
};
|
|
3179
|
+
export type optionExerciseResponse = (optionExerciseResponseSuccess | optionExerciseResponseError);
|
|
3180
|
+
export declare const getOptionExerciseUrl: (accountId: string, symbolOrContractId: string) => string;
|
|
3181
|
+
/**
|
|
3182
|
+
* This endpoint enables users to exercise a held option contract, converting it into the underlying asset based on the specified terms.
|
|
3183
|
+
* All available held shares of this option contract will be exercised.
|
|
3184
|
+
* By default, Alpaca will automatically exercise in-the-money (ITM) contracts at expiry.
|
|
3185
|
+
* Exercise requests will be processed immediately once received. Exercise requests submitted between market close and midnight will be rejected to avoid any confusion about when the exercise will settle.
|
|
3186
|
+
* To cancel an exercise request or to submit a Do-not-exercise (DNE) instruction, you can use the do-not-exercise endpoint or contact our support team.
|
|
3187
|
+
* @summary Exercise an Options Position (BETA)
|
|
3188
|
+
*/
|
|
3189
|
+
export declare const optionExercise: (accountId: string, symbolOrContractId: string, exerciseRequest?: ExerciseRequest, options?: RequestInit) => Promise<optionExerciseResponse>;
|
|
3190
|
+
export type getAllWatchlistsForAccountResponse200 = {
|
|
3191
|
+
data: WatchlistWithoutAsset[];
|
|
3192
|
+
status: 200;
|
|
3193
|
+
};
|
|
3194
|
+
export type getAllWatchlistsForAccountResponseSuccess = (getAllWatchlistsForAccountResponse200) & {
|
|
3195
|
+
headers: Headers;
|
|
3196
|
+
};
|
|
3197
|
+
export type getAllWatchlistsForAccountResponse = (getAllWatchlistsForAccountResponseSuccess);
|
|
3198
|
+
export declare const getGetAllWatchlistsForAccountUrl: (accountId: string) => string;
|
|
3199
|
+
/**
|
|
3200
|
+
* Fetch a list of all watchlists currently in an account.
|
|
3201
|
+
* @summary Retrieve all Watchlists for an Account
|
|
3202
|
+
*/
|
|
3203
|
+
export declare const getAllWatchlistsForAccount: (accountId: string, options?: RequestInit) => Promise<getAllWatchlistsForAccountResponse>;
|
|
3204
|
+
export type createWatchlistForAccountResponse200 = {
|
|
3205
|
+
data: Watchlist;
|
|
3206
|
+
status: 200;
|
|
3207
|
+
};
|
|
3208
|
+
export type createWatchlistForAccountResponseSuccess = (createWatchlistForAccountResponse200) & {
|
|
3209
|
+
headers: Headers;
|
|
3210
|
+
};
|
|
3211
|
+
export type createWatchlistForAccountResponse = (createWatchlistForAccountResponseSuccess);
|
|
3212
|
+
export declare const getCreateWatchlistForAccountUrl: (accountId: string) => string;
|
|
3213
|
+
/**
|
|
3214
|
+
* Returns the watchlist object
|
|
3215
|
+
* @summary Create a New Watchlist for an Account
|
|
3216
|
+
*/
|
|
3217
|
+
export declare const createWatchlistForAccount: (accountId: string, createWatchlistRequest?: CreateWatchlistRequest, options?: RequestInit) => Promise<createWatchlistForAccountResponse>;
|
|
3218
|
+
export type deleteWatchlistFromAccountByIdResponse200 = {
|
|
3219
|
+
data: void;
|
|
3220
|
+
status: 200;
|
|
3221
|
+
};
|
|
3222
|
+
export type deleteWatchlistFromAccountByIdResponseSuccess = (deleteWatchlistFromAccountByIdResponse200) & {
|
|
3223
|
+
headers: Headers;
|
|
3224
|
+
};
|
|
3225
|
+
export type deleteWatchlistFromAccountByIdResponse = (deleteWatchlistFromAccountByIdResponseSuccess);
|
|
3226
|
+
export declare const getDeleteWatchlistFromAccountByIdUrl: (accountId: string, watchlistId: string) => string;
|
|
3227
|
+
/**
|
|
3228
|
+
* Irrevocably delete a watchlist.
|
|
3229
|
+
* @summary Remove a Watchlist
|
|
3230
|
+
*/
|
|
3231
|
+
export declare const deleteWatchlistFromAccountById: (accountId: string, watchlistId: string, options?: RequestInit) => Promise<deleteWatchlistFromAccountByIdResponse>;
|
|
3232
|
+
export type getWatchlistForAccountByIdResponse200 = {
|
|
3233
|
+
data: Watchlist;
|
|
3234
|
+
status: 200;
|
|
3235
|
+
};
|
|
3236
|
+
export type getWatchlistForAccountByIdResponseSuccess = (getWatchlistForAccountByIdResponse200) & {
|
|
3237
|
+
headers: Headers;
|
|
3238
|
+
};
|
|
3239
|
+
export type getWatchlistForAccountByIdResponse = (getWatchlistForAccountByIdResponseSuccess);
|
|
3240
|
+
export declare const getGetWatchlistForAccountByIdUrl: (accountId: string, watchlistId: string) => string;
|
|
3241
|
+
/**
|
|
3242
|
+
* Retrieve Watchlist by ID
|
|
3243
|
+
* @summary Manage watchlists
|
|
3244
|
+
*/
|
|
3245
|
+
export declare const getWatchlistForAccountById: (accountId: string, watchlistId: string, options?: RequestInit) => Promise<getWatchlistForAccountByIdResponse>;
|
|
3246
|
+
export type postV1TradingAccountsAccountIdWatchlistsWatchlistIdResponse200 = {
|
|
3247
|
+
data: Watchlist;
|
|
3248
|
+
status: 200;
|
|
3249
|
+
};
|
|
3250
|
+
export type postV1TradingAccountsAccountIdWatchlistsWatchlistIdResponse404 = {
|
|
3251
|
+
data: void;
|
|
3252
|
+
status: 404;
|
|
3253
|
+
};
|
|
3254
|
+
export type postV1TradingAccountsAccountIdWatchlistsWatchlistIdResponse422 = {
|
|
3255
|
+
data: void;
|
|
3256
|
+
status: 422;
|
|
3257
|
+
};
|
|
3258
|
+
export type postV1TradingAccountsAccountIdWatchlistsWatchlistIdResponseSuccess = (postV1TradingAccountsAccountIdWatchlistsWatchlistIdResponse200) & {
|
|
3259
|
+
headers: Headers;
|
|
3260
|
+
};
|
|
3261
|
+
export type postV1TradingAccountsAccountIdWatchlistsWatchlistIdResponseError = (postV1TradingAccountsAccountIdWatchlistsWatchlistIdResponse404 | postV1TradingAccountsAccountIdWatchlistsWatchlistIdResponse422) & {
|
|
3262
|
+
headers: Headers;
|
|
3263
|
+
};
|
|
3264
|
+
export type postV1TradingAccountsAccountIdWatchlistsWatchlistIdResponse = (postV1TradingAccountsAccountIdWatchlistsWatchlistIdResponseSuccess | postV1TradingAccountsAccountIdWatchlistsWatchlistIdResponseError);
|
|
3265
|
+
export declare const getPostV1TradingAccountsAccountIdWatchlistsWatchlistIdUrl: (accountId: string, watchlistId: string) => string;
|
|
3266
|
+
/**
|
|
3267
|
+
* Adds an asset to an existing watchlist.
|
|
3268
|
+
* @summary Add an Asset to a Watchlist
|
|
3269
|
+
*/
|
|
3270
|
+
export declare const postV1TradingAccountsAccountIdWatchlistsWatchlistId: (accountId: string, watchlistId: string, postV1TradingAccountsAccountIdWatchlistsWatchlistIdBody?: PostV1TradingAccountsAccountIdWatchlistsWatchlistIdBody, options?: RequestInit) => Promise<postV1TradingAccountsAccountIdWatchlistsWatchlistIdResponse>;
|
|
3271
|
+
export type replaceWatchlistForAccountByIdResponse200 = {
|
|
3272
|
+
data: Watchlist;
|
|
3273
|
+
status: 200;
|
|
3274
|
+
};
|
|
3275
|
+
export type replaceWatchlistForAccountByIdResponseSuccess = (replaceWatchlistForAccountByIdResponse200) & {
|
|
3276
|
+
headers: Headers;
|
|
3277
|
+
};
|
|
3278
|
+
export type replaceWatchlistForAccountByIdResponse = (replaceWatchlistForAccountByIdResponseSuccess);
|
|
3279
|
+
export declare const getReplaceWatchlistForAccountByIdUrl: (accountId: string, watchlistId: string) => string;
|
|
3280
|
+
/**
|
|
3281
|
+
* Replace entirely the set of securities contained in the watchlist while optionally renaming it. Destructive operation.
|
|
3282
|
+
* @summary Update a Watchlist
|
|
3283
|
+
*/
|
|
3284
|
+
export declare const replaceWatchlistForAccountById: (accountId: string, watchlistId: string, createWatchlistRequest?: CreateWatchlistRequest, options?: RequestInit) => Promise<replaceWatchlistForAccountByIdResponse>;
|
|
3285
|
+
export type deleteDELETEV1TradingAccountsAccountIdWatchlistsWatchlistIdSymbolResponse200 = {
|
|
3286
|
+
data: void;
|
|
3287
|
+
status: 200;
|
|
3288
|
+
};
|
|
3289
|
+
export type deleteDELETEV1TradingAccountsAccountIdWatchlistsWatchlistIdSymbolResponse404 = {
|
|
3290
|
+
data: void;
|
|
3291
|
+
status: 404;
|
|
3292
|
+
};
|
|
3293
|
+
export type deleteDELETEV1TradingAccountsAccountIdWatchlistsWatchlistIdSymbolResponseSuccess = (deleteDELETEV1TradingAccountsAccountIdWatchlistsWatchlistIdSymbolResponse200) & {
|
|
3294
|
+
headers: Headers;
|
|
3295
|
+
};
|
|
3296
|
+
export type deleteDELETEV1TradingAccountsAccountIdWatchlistsWatchlistIdSymbolResponseError = (deleteDELETEV1TradingAccountsAccountIdWatchlistsWatchlistIdSymbolResponse404) & {
|
|
3297
|
+
headers: Headers;
|
|
3298
|
+
};
|
|
3299
|
+
export type deleteDELETEV1TradingAccountsAccountIdWatchlistsWatchlistIdSymbolResponse = (deleteDELETEV1TradingAccountsAccountIdWatchlistsWatchlistIdSymbolResponseSuccess | deleteDELETEV1TradingAccountsAccountIdWatchlistsWatchlistIdSymbolResponseError);
|
|
3300
|
+
export declare const getDeleteDELETEV1TradingAccountsAccountIdWatchlistsWatchlistIdSymbolUrl: (accountId: string, watchlistId: string, symbol: string) => string;
|
|
3301
|
+
/**
|
|
3302
|
+
* Delete one entry for an asset by symbol name
|
|
3303
|
+
* @summary Remove a Symbol from a Watchlist
|
|
3304
|
+
*/
|
|
3305
|
+
export declare const deleteDELETEV1TradingAccountsAccountIdWatchlistsWatchlistIdSymbol: (accountId: string, watchlistId: string, symbol: string, options?: RequestInit) => Promise<deleteDELETEV1TradingAccountsAccountIdWatchlistsWatchlistIdSymbolResponse>;
|
|
3306
|
+
export type getV1TransfersJitLedgerIdBalancesResponse200 = {
|
|
3307
|
+
data: GetV1TransfersJitLedgerIdBalances200;
|
|
3308
|
+
status: 200;
|
|
3309
|
+
};
|
|
3310
|
+
export type getV1TransfersJitLedgerIdBalancesResponseSuccess = (getV1TransfersJitLedgerIdBalancesResponse200) & {
|
|
3311
|
+
headers: Headers;
|
|
3312
|
+
};
|
|
3313
|
+
export type getV1TransfersJitLedgerIdBalancesResponse = (getV1TransfersJitLedgerIdBalancesResponseSuccess);
|
|
3314
|
+
export declare const getGetV1TransfersJitLedgerIdBalancesUrl: (ledgerId: string, params?: GetV1TransfersJitLedgerIdBalancesParams) => string;
|
|
3315
|
+
/**
|
|
3316
|
+
* Returns an array of objects that correspond to each ledger account.
|
|
3317
|
+
* @summary Retrieve JIT Ledger Balances
|
|
3318
|
+
*/
|
|
3319
|
+
export declare const getV1TransfersJitLedgerIdBalances: (ledgerId: string, params?: GetV1TransfersJitLedgerIdBalancesParams, options?: RequestInit) => Promise<getV1TransfersJitLedgerIdBalancesResponse>;
|
|
3320
|
+
export type getV1TransfersJitLedgersResponse200 = {
|
|
3321
|
+
data: JITLedgerAccount[];
|
|
3322
|
+
status: 200;
|
|
3323
|
+
};
|
|
3324
|
+
export type getV1TransfersJitLedgersResponseSuccess = (getV1TransfersJitLedgersResponse200) & {
|
|
3325
|
+
headers: Headers;
|
|
3326
|
+
};
|
|
3327
|
+
export type getV1TransfersJitLedgersResponse = (getV1TransfersJitLedgersResponseSuccess);
|
|
3328
|
+
export declare const getGetV1TransfersJitLedgersUrl: () => string;
|
|
3329
|
+
/**
|
|
3330
|
+
* Returns an array of objects that correspond to each ledger account, each of whichcontain the following attributes.
|
|
3331
|
+
* @summary Retrieve JIT Ledgers
|
|
3332
|
+
*/
|
|
3333
|
+
export declare const getV1TransfersJitLedgers: (options?: RequestInit) => Promise<getV1TransfersJitLedgersResponse>;
|
|
3334
|
+
export type getV1TransfersJitLimitsResponse200 = {
|
|
3335
|
+
data: DailyTradingLimit;
|
|
3336
|
+
status: 200;
|
|
3337
|
+
};
|
|
3338
|
+
export type getV1TransfersJitLimitsResponseSuccess = (getV1TransfersJitLimitsResponse200) & {
|
|
3339
|
+
headers: Headers;
|
|
3340
|
+
};
|
|
3341
|
+
export type getV1TransfersJitLimitsResponse = (getV1TransfersJitLimitsResponseSuccess);
|
|
3342
|
+
export declare const getGetV1TransfersJitLimitsUrl: () => string;
|
|
3343
|
+
/**
|
|
3344
|
+
* The JIT Securities daily trading limit is set at the correspondent level and is used as the limit for the total amount due to Alpaca on the date of settlement. The limit in use returns the real time usage of this limit and is calculated by taking the net of trade and non-trade activity inflows and outflows. If the limit in use reaches the daily net limit, further purchasing activity will be halted, however, the limit can be adjusted by reaching out to Alpaca with the proposed new limit and the reason for the change.
|
|
3345
|
+
* @summary Retrieve Daily Trading Limits
|
|
3346
|
+
*/
|
|
3347
|
+
export declare const getV1TransfersJitLimits: (options?: RequestInit) => Promise<getV1TransfersJitLimitsResponse>;
|
|
3348
|
+
export type getV1TransfersJitReportsResponse200 = {
|
|
3349
|
+
data: JITReport | JITReportDownloadURL;
|
|
3350
|
+
status: 200;
|
|
3351
|
+
};
|
|
3352
|
+
export type getV1TransfersJitReportsResponseSuccess = (getV1TransfersJitReportsResponse200) & {
|
|
3353
|
+
headers: Headers;
|
|
3354
|
+
};
|
|
3355
|
+
export type getV1TransfersJitReportsResponse = (getV1TransfersJitReportsResponseSuccess);
|
|
3356
|
+
export declare const getGetV1TransfersJitReportsUrl: (params: GetV1TransfersJitReportsParams) => string;
|
|
3357
|
+
/**
|
|
3358
|
+
* Retrieves a JIT report for the requested report type and system date. By default, the report is returned inline. For large reports, use response_type=download_url to receive a temporary signed download URL.
|
|
3359
|
+
* @summary Retrieve JIT Reports
|
|
3360
|
+
*/
|
|
3361
|
+
export declare const getV1TransfersJitReports: (params: GetV1TransfersJitReportsParams, options?: RequestInit) => Promise<getV1TransfersJitReportsResponse>;
|
|
3362
|
+
export type getCryptoTransferEstimateResponse200 = {
|
|
3363
|
+
data: GetCryptoTransferEstimate200;
|
|
3364
|
+
status: 200;
|
|
3365
|
+
};
|
|
3366
|
+
export type getCryptoTransferEstimateResponseDefault = {
|
|
3367
|
+
data: Error;
|
|
3368
|
+
status: Exclude<HTTPStatusCodes, 200>;
|
|
3369
|
+
};
|
|
3370
|
+
export type getCryptoTransferEstimateResponseSuccess = (getCryptoTransferEstimateResponse200) & {
|
|
3371
|
+
headers: Headers;
|
|
3372
|
+
};
|
|
3373
|
+
export type getCryptoTransferEstimateResponseError = (getCryptoTransferEstimateResponseDefault) & {
|
|
3374
|
+
headers: Headers;
|
|
3375
|
+
};
|
|
3376
|
+
export type getCryptoTransferEstimateResponse = (getCryptoTransferEstimateResponseSuccess | getCryptoTransferEstimateResponseError);
|
|
3377
|
+
export declare const getGetCryptoTransferEstimateUrl: (params?: GetCryptoTransferEstimateParams) => string;
|
|
3378
|
+
/**
|
|
3379
|
+
* Returns the estimated on-chain network (gas) fee for a proposed crypto withdrawal at current chain conditions. Pass the `asset`, `from_address`, `to_address`, and `amount` you intend to send; the response reports the network fee that would be charged for the corresponding transaction.
|
|
3380
|
+
* @summary Returns the estimated gas fee for a proposed transaction.
|
|
3381
|
+
*/
|
|
3382
|
+
export declare const getCryptoTransferEstimate: (params?: GetCryptoTransferEstimateParams, options?: RequestInit) => Promise<getCryptoTransferEstimateResponse>;
|
|
3383
|
+
export type getAccountActivityEventResponse200 = {
|
|
3384
|
+
data: ActivityEventV2;
|
|
3385
|
+
status: 200;
|
|
3386
|
+
};
|
|
3387
|
+
export type getAccountActivityEventResponseSuccess = (getAccountActivityEventResponse200) & {
|
|
3388
|
+
headers: Headers;
|
|
3389
|
+
};
|
|
3390
|
+
export type getAccountActivityEventResponse = (getAccountActivityEventResponseSuccess);
|
|
3391
|
+
export declare const getGetAccountActivityEventUrl: (accountId: string, eventId: string) => string;
|
|
3392
|
+
/**
|
|
3393
|
+
* Returns a single account activity (V2) event for the specified account by ULID `event_id`, delivered as a server-sent event message.
|
|
3394
|
+
*
|
|
3395
|
+
* This is the single-event counterpart to the `subscribeToActivitiesSSE` streaming endpoint, intended for re-fetching an individual activity that was previously observed on the activities stream.
|
|
3396
|
+
* @summary Get a single activity (V2) event by event_id ULID.
|
|
3397
|
+
*/
|
|
3398
|
+
export declare const getAccountActivityEvent: (accountId: string, eventId: string, options?: RequestInit) => Promise<getAccountActivityEventResponse>;
|
|
3399
|
+
export type subscribeToActivitiesSSEResponse200 = {
|
|
3400
|
+
data: ActivityEventV2[];
|
|
3401
|
+
status: 200;
|
|
3402
|
+
};
|
|
3403
|
+
export type subscribeToActivitiesSSEResponseSuccess = (subscribeToActivitiesSSEResponse200) & {
|
|
3404
|
+
headers: Headers;
|
|
3405
|
+
};
|
|
3406
|
+
export type subscribeToActivitiesSSEResponse = (subscribeToActivitiesSSEResponseSuccess);
|
|
3407
|
+
export declare const getSubscribeToActivitiesSSEUrl: (params?: SubscribeToActivitiesSSEParams) => string;
|
|
3408
|
+
/**
|
|
3409
|
+
* The Events API sends the real-time events and provides historical queries with SSE (Server Sent Events).
|
|
3410
|
+
*
|
|
3411
|
+
* This endpoint streams events on account activities.
|
|
3412
|
+
*
|
|
3413
|
+
* Historical events are streamed immediately if queried, and updates are pushed as events occur.
|
|
3414
|
+
*
|
|
3415
|
+
* Query parameter rules:
|
|
3416
|
+
* - If `until` is specified, `since` is required.
|
|
3417
|
+
* - If `until_id` is specified, `since_id` is required.
|
|
3418
|
+
* - You cannot use `since` and `since_id` together.
|
|
3419
|
+
* Behavior:
|
|
3420
|
+
* - If `since` or `since_id` is not specified, this will not return any historic data.
|
|
3421
|
+
* - If `until` or `until_id` is specified, stream will end at the specified point with status 200.
|
|
3422
|
+
*
|
|
3423
|
+
* ---
|
|
3424
|
+
*
|
|
3425
|
+
* Warning: Currently, OAS-3 does not fully support responses from an SSE API.
|
|
3426
|
+
*
|
|
3427
|
+
* In case the client code is generated from this OAS spec, please do not specify `since` and `until`, as the generated client may hang forever waiting for the response to end.
|
|
3428
|
+
*
|
|
3429
|
+
* If you require the streaming capabilities, we recommend not using the generated clients for this specific endpoint until the OAS-3 standards define how to represent this behavior.
|
|
3430
|
+
*
|
|
3431
|
+
* ---
|
|
3432
|
+
*
|
|
3433
|
+
* ### Comment messages
|
|
3434
|
+
* According to the SSE specification, any line that starts with a colon is a comment which does not contain data. It is typically a free text that does not follow any data schema. A few examples mentioned below for comment messages.
|
|
3435
|
+
*
|
|
3436
|
+
* ##### Slow client
|
|
3437
|
+
*
|
|
3438
|
+
* The server sends a comment when the client is not consuming messages fast enough. Example: `: you are reading too slowly, dropped 10000 messages`
|
|
3439
|
+
*
|
|
3440
|
+
* ##### Internal server error
|
|
3441
|
+
*
|
|
3442
|
+
* An error message is sent as a comment when the server closes the connection on an internal server error (only sent by the v2 and v2beta1 endpoints). Example: `: internal server error`
|
|
3443
|
+
*
|
|
3444
|
+
* ---
|
|
3445
|
+
* @summary Subscribe to Activity Events (SSE)
|
|
3446
|
+
*/
|
|
3447
|
+
export declare const subscribeToActivitiesSSE: (params?: SubscribeToActivitiesSSEParams, options?: RequestInit) => Promise<subscribeToActivitiesSSEResponse>;
|
|
3448
|
+
export type calendarResponse200 = {
|
|
3449
|
+
data: PublicCalendarResp;
|
|
3450
|
+
status: 200;
|
|
3451
|
+
};
|
|
3452
|
+
export type calendarResponse400 = {
|
|
3453
|
+
data: N400Response;
|
|
3454
|
+
status: 400;
|
|
3455
|
+
};
|
|
3456
|
+
export type calendarResponse429 = {
|
|
3457
|
+
data: N429Response;
|
|
3458
|
+
status: 429;
|
|
3459
|
+
};
|
|
3460
|
+
export type calendarResponse500 = {
|
|
3461
|
+
data: N500Response;
|
|
3462
|
+
status: 500;
|
|
3463
|
+
};
|
|
3464
|
+
export type calendarResponseSuccess = (calendarResponse200) & {
|
|
3465
|
+
headers: Headers;
|
|
3466
|
+
};
|
|
3467
|
+
export type calendarResponseError = (calendarResponse400 | calendarResponse429 | calendarResponse500) & {
|
|
3468
|
+
headers: Headers;
|
|
3469
|
+
};
|
|
3470
|
+
export type calendarResponse = (calendarResponseSuccess | calendarResponseError);
|
|
3471
|
+
export declare const getCalendarUrl: (market: "BMO" | "BNYM" | "BOATS" | "CEUX" | "CHIX" | "HKEX" | "IEX" | "IEXG" | "ISE" | "LSE" | "MTA" | "MTAA" | "NASDAQ" | "NYSE" | "OCEA" | "OPRA" | "OTC" | "OTCM" | "SIFMA" | "TADAWUL" | "XAMS" | "XBRU" | "XDUB" | "XETR" | "XETRA" | "XHKG" | "XLIS" | "XLON" | "XNAS" | "XNYS" | "XPAR" | "XSAU", params?: CalendarParams) => string;
|
|
3472
|
+
/**
|
|
3473
|
+
* This endpoint returns the market calendar.
|
|
3474
|
+
* @summary Get Market Calendar
|
|
3475
|
+
*/
|
|
3476
|
+
export declare const calendar: (market: "BMO" | "BNYM" | "BOATS" | "CEUX" | "CHIX" | "HKEX" | "IEX" | "IEXG" | "ISE" | "LSE" | "MTA" | "MTAA" | "NASDAQ" | "NYSE" | "OCEA" | "OPRA" | "OTC" | "OTCM" | "SIFMA" | "TADAWUL" | "XAMS" | "XBRU" | "XDUB" | "XETR" | "XETRA" | "XHKG" | "XLIS" | "XLON" | "XNAS" | "XNYS" | "XPAR" | "XSAU", params?: CalendarParams, options?: RequestInit) => Promise<calendarResponse>;
|
|
3477
|
+
export type clockResponse200 = {
|
|
3478
|
+
data: ClockResp;
|
|
3479
|
+
status: 200;
|
|
3480
|
+
};
|
|
3481
|
+
export type clockResponse400 = {
|
|
3482
|
+
data: N400Response;
|
|
3483
|
+
status: 400;
|
|
3484
|
+
};
|
|
3485
|
+
export type clockResponse429 = {
|
|
3486
|
+
data: N429Response;
|
|
3487
|
+
status: 429;
|
|
3488
|
+
};
|
|
3489
|
+
export type clockResponse500 = {
|
|
3490
|
+
data: N500Response;
|
|
3491
|
+
status: 500;
|
|
3492
|
+
};
|
|
3493
|
+
export type clockResponseSuccess = (clockResponse200) & {
|
|
3494
|
+
headers: Headers;
|
|
3495
|
+
};
|
|
3496
|
+
export type clockResponseError = (clockResponse400 | clockResponse429 | clockResponse500) & {
|
|
3497
|
+
headers: Headers;
|
|
3498
|
+
};
|
|
3499
|
+
export type clockResponse = (clockResponseSuccess | clockResponseError);
|
|
3500
|
+
export declare const getClockUrl: (params?: ClockParams) => string;
|
|
3501
|
+
/**
|
|
3502
|
+
* This API serves information about multiple markets: the current time, if it's a market day, the current phase of the market, etc.
|
|
3503
|
+
* @summary Get Market Clock
|
|
3504
|
+
*/
|
|
3505
|
+
export declare const clock: (params?: ClockParams, options?: RequestInit) => Promise<clockResponse>;
|
|
3506
|
+
export type subscribeToAdminActionSSEResponse200 = {
|
|
3507
|
+
data: (AdminActionLegacyNote | AdminActionLiquidation | AdminActionTransactionCancel)[];
|
|
3508
|
+
status: 200;
|
|
3509
|
+
};
|
|
3510
|
+
export type subscribeToAdminActionSSEResponseSuccess = (subscribeToAdminActionSSEResponse200) & {
|
|
3511
|
+
headers: Headers;
|
|
3512
|
+
};
|
|
3513
|
+
export type subscribeToAdminActionSSEResponse = (subscribeToAdminActionSSEResponseSuccess);
|
|
3514
|
+
export declare const getSubscribeToAdminActionSSEUrl: (params?: SubscribeToAdminActionSSEParams) => string;
|
|
3515
|
+
/**
|
|
3516
|
+
* The Events API provides event push as well as historical queries via SSE (server sent events).
|
|
3517
|
+
*
|
|
3518
|
+
* This endpoint streams events related to administrative actions performed by our systems.
|
|
3519
|
+
*
|
|
3520
|
+
* Historical events are streamed immediately if queried, and updates are pushed as events occur.
|
|
3521
|
+
*
|
|
3522
|
+
* Query Params Rules:
|
|
3523
|
+
* - `since` required if `until` specified
|
|
3524
|
+
* - `since_id` required if `until_id` specified
|
|
3525
|
+
* - `since` and `since_id` can't be used at the same time
|
|
3526
|
+
* Behavior:
|
|
3527
|
+
* - if `since` or `since_id` not specified this will not return any historic data
|
|
3528
|
+
* - if `until` or `until_id` reached stream will end (status 200)
|
|
3529
|
+
*
|
|
3530
|
+
* ---
|
|
3531
|
+
*
|
|
3532
|
+
* Warning: Currently OAS-3 doesn't have full support for representing SSE style responses from an API.
|
|
3533
|
+
*
|
|
3534
|
+
* In case the client code is generated from this OAS spec, don't specify a `since` and `until` there is a good chance the generated clients will hang forever waiting for the response to end.
|
|
3535
|
+
*
|
|
3536
|
+
* If you require the streaming capabilities we recommend not using the generated clients for this specific endpoint until the OAS-3 standards come to a consensus on how to represent this behavior in OAS-3.
|
|
3537
|
+
*
|
|
3538
|
+
* ---
|
|
3539
|
+
*
|
|
3540
|
+
* ### Comment messages
|
|
3541
|
+
* According to the SSE specification, any line that starts with a colon is a comment which does not contain data. It is typically a free text that does not follow any data schema. A few examples mentioned below for comment messages.
|
|
3542
|
+
*
|
|
3543
|
+
* ##### Slow client
|
|
3544
|
+
*
|
|
3545
|
+
* The server sends a comment when the client is not consuming messages fast enough. Example: `: you are reading too slowly, dropped 10000 messages`
|
|
3546
|
+
*
|
|
3547
|
+
* ##### Internal server error
|
|
3548
|
+
*
|
|
3549
|
+
* An error message is sent as a comment when the server closes the connection on an internal server error (only sent by the v2 and v2beta1 endpoints). Example: `: internal server error`
|
|
3550
|
+
*
|
|
3551
|
+
* ---
|
|
3552
|
+
*
|
|
3553
|
+
* **Event Types**
|
|
3554
|
+
*
|
|
3555
|
+
* - **LegacyNote:** Old free text based admin notes
|
|
3556
|
+
* - **Liquidation:** Event for a position liquidation which initialized by an admin
|
|
3557
|
+
* - **TransactionCancel:** Event for a manually cancelled transaction
|
|
3558
|
+
* @summary Subscribe to Admin Action Events (SSE)
|
|
3559
|
+
*/
|
|
3560
|
+
export declare const subscribeToAdminActionSSE: (params?: SubscribeToAdminActionSSEParams, options?: RequestInit) => Promise<subscribeToAdminActionSSEResponse>;
|
|
3561
|
+
export type subscribeToFundingStatusSSEResponse200 = {
|
|
3562
|
+
data: StatusFundingEvent[];
|
|
3563
|
+
status: 200;
|
|
3564
|
+
};
|
|
3565
|
+
export type subscribeToFundingStatusSSEResponseSuccess = (subscribeToFundingStatusSSEResponse200) & {
|
|
3566
|
+
headers: Headers;
|
|
3567
|
+
};
|
|
3568
|
+
export type subscribeToFundingStatusSSEResponse = (subscribeToFundingStatusSSEResponseSuccess);
|
|
3569
|
+
export declare const getSubscribeToFundingStatusSSEUrl: (params?: SubscribeToFundingStatusSSEParams) => string;
|
|
3570
|
+
/**
|
|
3571
|
+
* The Events API provides event push as well as historical queries via SSE (server sent events).
|
|
3572
|
+
*
|
|
3573
|
+
* You can listen to funding status updates as they get processed by our backoffice, for both end-user and firm accounts.
|
|
3574
|
+
*
|
|
3575
|
+
* Historical events are streamed immediately if queried, and updates are pushed as events occur.
|
|
3576
|
+
*
|
|
3577
|
+
* Query Params Rules:
|
|
3578
|
+
* - `since` required if `until` specified
|
|
3579
|
+
* - `since_id` required if `until_id` specified
|
|
3580
|
+
* - `since` and `since_id` can't be used at the same time
|
|
3581
|
+
* - `until` and `until_id` can't be used at the same time
|
|
3582
|
+
* Behavior:
|
|
3583
|
+
* - if `since` or `since_id` not specified this will not return any historic data
|
|
3584
|
+
* - if `until` or `until_id` reached stream will end (status 200)
|
|
3585
|
+
*
|
|
3586
|
+
* ---
|
|
3587
|
+
*
|
|
3588
|
+
* Note for people using the clients generated from this OAS spec. Currently OAS-3 doesn't have full support for representing SSE style responses from an API, so if you are using a generated client and don't specify a `since` and `until` there is a good chance the generated clients will hang waiting for the response to end.
|
|
3589
|
+
*
|
|
3590
|
+
* If you require the streaming capabilities we recommend not using the generated clients for this specific usecase until the OAS-3 standards come to a consensus on how to represent this correctly in OAS-3.
|
|
3591
|
+
* @summary Subscribe to Funding Status Events (SSE)
|
|
3592
|
+
*/
|
|
3593
|
+
export declare const subscribeToFundingStatusSSE: (params?: SubscribeToFundingStatusSSEParams, options?: RequestInit) => Promise<subscribeToFundingStatusSSEResponse>;
|
|
3594
|
+
export type subscribeToIPOEventsSSEResponse200 = {
|
|
3595
|
+
data: IPOEvent[];
|
|
3596
|
+
status: 200;
|
|
3597
|
+
};
|
|
3598
|
+
export type subscribeToIPOEventsSSEResponseSuccess = (subscribeToIPOEventsSSEResponse200) & {
|
|
3599
|
+
headers: Headers;
|
|
3600
|
+
};
|
|
3601
|
+
export type subscribeToIPOEventsSSEResponse = (subscribeToIPOEventsSSEResponseSuccess);
|
|
3602
|
+
export declare const getSubscribeToIPOEventsSSEUrl: (params?: SubscribeToIPOEventsSSEParams) => string;
|
|
3603
|
+
/**
|
|
3604
|
+
* The Events API provides event push as well as historical queries via SSE (server sent events).
|
|
3605
|
+
*
|
|
3606
|
+
* You can listen to IPO offering lifecycle updates as they happen - including new offerings, offering updates, prospectus availability, the 60-minute pricing window, account-scoped allocation results, and offering cancellations.
|
|
3607
|
+
*
|
|
3608
|
+
* Historical events are streamed immediately if queried, and updates are pushed as events occur.
|
|
3609
|
+
*
|
|
3610
|
+
* ---
|
|
3611
|
+
*
|
|
3612
|
+
* **Event types**
|
|
3613
|
+
*
|
|
3614
|
+
* Each event has a `verb` field that determines the shape of `payload`. See the `IPOEvent` schema for the full payload structure for each verb.
|
|
3615
|
+
*
|
|
3616
|
+
* - `Offering` - initial publication of an offering (system-wide).
|
|
3617
|
+
* - `OfferingUpdate` - update to a previously published offering (system-wide).
|
|
3618
|
+
* - `Prospectus` - prospectus document is now available (system-wide).
|
|
3619
|
+
* - `SixtyMinMail` - 60-minute pricing window has opened, no new orders accepted (system-wide).
|
|
3620
|
+
* - `Allocation` - final allocation result for a specific account. **Account-scoped** - `account_id` and `correspondent` are populated.
|
|
3621
|
+
* - `OfferingCancellation` - offering was cancelled. **No `payload` field is present.**
|
|
3622
|
+
*
|
|
3623
|
+
* Use the `offering_reference` field on each event to fetch the full offering metadata via [`GET /v1/ipos/{offering_reference}`](#operation/getIPOOffering).
|
|
3624
|
+
*
|
|
3625
|
+
* ---
|
|
3626
|
+
*
|
|
3627
|
+
* Query Params Rules:
|
|
3628
|
+
* - `since` required if `until` specified
|
|
3629
|
+
* - `since_id` required if `until_id` specified
|
|
3630
|
+
* - `since` and `since_id` can't be used at the same time
|
|
3631
|
+
* - `until` and `until_id` can't be used at the same time
|
|
3632
|
+
*
|
|
3633
|
+
* Behavior:
|
|
3634
|
+
* - if `since` or `since_id` not specified this will not return any historic data
|
|
3635
|
+
* - if `until` or `until_id` reached stream will end (status 200)
|
|
3636
|
+
*
|
|
3637
|
+
* ---
|
|
3638
|
+
*
|
|
3639
|
+
* Note for people using the clients generated from this OAS spec. Currently OAS-3 doesn't have full support for representing SSE style responses from an API, so if you are using a generated client and don't specify a `since` and `until` there is a good chance the generated clients will hang waiting for the response to end.
|
|
3640
|
+
*
|
|
3641
|
+
* If you require the streaming capabilities we recommend not using the generated clients for this specific usecase until the OAS-3 standards come to a consensus on how to represent this correctly in OAS-3.
|
|
3642
|
+
* @summary Subscribe to IPO Events (SSE)
|
|
3643
|
+
*/
|
|
3644
|
+
export declare const subscribeToIPOEventsSSE: (params?: SubscribeToIPOEventsSSEParams, options?: RequestInit) => Promise<subscribeToIPOEventsSSEResponse>;
|
|
3645
|
+
export type subscribeToJournalStatusV2SSEResponse200 = {
|
|
3646
|
+
data: JournalStatusEventV2[];
|
|
3647
|
+
status: 200;
|
|
3648
|
+
};
|
|
3649
|
+
export type subscribeToJournalStatusV2SSEResponseSuccess = (subscribeToJournalStatusV2SSEResponse200) & {
|
|
3650
|
+
headers: Headers;
|
|
3651
|
+
};
|
|
3652
|
+
export type subscribeToJournalStatusV2SSEResponse = (subscribeToJournalStatusV2SSEResponseSuccess);
|
|
3653
|
+
export declare const getSubscribeToJournalStatusV2SSEUrl: (params?: SubscribeToJournalStatusV2SSEParams) => string;
|
|
3654
|
+
/**
|
|
3655
|
+
* The Events API provides event push as well as historical queries via SSE (server sent events).
|
|
3656
|
+
*
|
|
3657
|
+
* You can listen to journal status updates as they get processed by our backoffice.
|
|
3658
|
+
*
|
|
3659
|
+
* Historical events are streamed immediately if queried, and updates are pushed as events occur.
|
|
3660
|
+
*
|
|
3661
|
+
* Query Params Rules:
|
|
3662
|
+
* - `since` required if `until` specified
|
|
3663
|
+
* - `since_id` required if `until_id` specified
|
|
3664
|
+
* - `since` and `since_id` can't be used at the same time
|
|
3665
|
+
* - `until` and `until_id` can't be used at the same time
|
|
3666
|
+
* Behavior:
|
|
3667
|
+
* - if `since` or `since_id` not specified this will not return any historic data
|
|
3668
|
+
* - if `until` or `until_id` reached stream will end (status 200)
|
|
3669
|
+
*
|
|
3670
|
+
* ---
|
|
3671
|
+
*
|
|
3672
|
+
* There is no compatibility between /v1/events/journals/status and /v2/events/journals/status, the ids (ulid) are always different, and the number of events might also different
|
|
3673
|
+
*
|
|
3674
|
+
* Please note that the new `/v2` endpoint, is the same as, and was originally available under `/v2beta1`.
|
|
3675
|
+
* We encourage all customers to adjust their codebase from that interim beta endpoint to the `/v2` stable endpoint.
|
|
3676
|
+
* In the near future we will setup permanent redirect from `/v2beta1` to `/v2` before we completely remove the beta endpoint.
|
|
3677
|
+
*
|
|
3678
|
+
* ---
|
|
3679
|
+
*
|
|
3680
|
+
* Note for people using the clients generated from this OAS spec. Currently OAS-3 doesn't have full support for representing SSE style responses from an API, so if you are using a generated client and don't specify a `since` and `until` there is a good chance the generated clients will hang waiting for the response to end.
|
|
3681
|
+
*
|
|
3682
|
+
* If you require the streaming capabilities we recommend not using the generated clients for this specific usecase until the OAS-3 standards come to a consensus on how to represent this correctly in OAS-3.
|
|
3683
|
+
* @summary Subscribe to Journal Events (SSE)
|
|
3684
|
+
*/
|
|
3685
|
+
export declare const subscribeToJournalStatusV2SSE: (params?: SubscribeToJournalStatusV2SSEParams, options?: RequestInit) => Promise<subscribeToJournalStatusV2SSEResponse>;
|
|
3686
|
+
export type subscribeToSystemEventV2SSEResponse200 = {
|
|
3687
|
+
data: SystemEventV2[];
|
|
3688
|
+
status: 200;
|
|
3689
|
+
};
|
|
3690
|
+
export type subscribeToSystemEventV2SSEResponseSuccess = (subscribeToSystemEventV2SSEResponse200) & {
|
|
3691
|
+
headers: Headers;
|
|
3692
|
+
};
|
|
3693
|
+
export type subscribeToSystemEventV2SSEResponse = (subscribeToSystemEventV2SSEResponseSuccess);
|
|
3694
|
+
export declare const getSubscribeToSystemEventV2SSEUrl: (params?: SubscribeToSystemEventV2SSEParams) => string;
|
|
3695
|
+
/**
|
|
3696
|
+
* The Events API provides event push as well as historical queries via SSE (server sent events).
|
|
3697
|
+
*
|
|
3698
|
+
* You can listen to system event updates as they happen in our backend.
|
|
3699
|
+
*
|
|
3700
|
+
* Historical events are streamed immediately if queried, and updates are pushed as events occur.
|
|
3701
|
+
*
|
|
3702
|
+
* Query Params Rules:
|
|
3703
|
+
* - `since` required if `until` specified
|
|
3704
|
+
* - `since_id` required if `until_id` specified
|
|
3705
|
+
* - `since` and `since_id` can't be used at the same time
|
|
3706
|
+
* - `until` and `until_id` can't be used at the same time
|
|
3707
|
+
* Behavior:
|
|
3708
|
+
* - if `since` or `since_id` not specified this will not return any historic data
|
|
3709
|
+
* - if `until` or `until_id` reached stream will end (status 200)
|
|
3710
|
+
*
|
|
3711
|
+
* ---
|
|
3712
|
+
*
|
|
3713
|
+
* Note for people using the clients generated from this OAS spec. Currently OAS-3 doesn't have full support for representing SSE style responses from an API, so if you are using a generated client and don't specify a `since` and `until` there is a good chance the generated clients will hang waiting for the response to end.
|
|
3714
|
+
*
|
|
3715
|
+
* If you require the streaming capabilities we recommend not using the generated clients for this specific usecase until the OAS-3 standards come to a consensus on how to represent this correctly in OAS-3.
|
|
3716
|
+
* @summary Subscribe to System Events (SSE)
|
|
3717
|
+
*/
|
|
3718
|
+
export declare const subscribeToSystemEventV2SSE: (params?: SubscribeToSystemEventV2SSEParams, options?: RequestInit) => Promise<subscribeToSystemEventV2SSEResponse>;
|
|
3719
|
+
export type subscribeToTradeV2SSEResponse200 = {
|
|
3720
|
+
data: TradeUpdateEventV2[];
|
|
3721
|
+
status: 200;
|
|
3722
|
+
};
|
|
3723
|
+
export type subscribeToTradeV2SSEResponseSuccess = (subscribeToTradeV2SSEResponse200) & {
|
|
3724
|
+
headers: Headers;
|
|
3725
|
+
};
|
|
3726
|
+
export type subscribeToTradeV2SSEResponse = (subscribeToTradeV2SSEResponseSuccess);
|
|
3727
|
+
export declare const getSubscribeToTradeV2SSEUrl: (params?: SubscribeToTradeV2SSEParams) => string;
|
|
3728
|
+
/**
|
|
3729
|
+
* The Events API provides event push as well as historical queries via SSE (server sent events).
|
|
3730
|
+
*
|
|
3731
|
+
* You can listen to events related to trade updates. Most market trades sent during market hours are filled instantly; you can listen to limit order updates through this endpoint.
|
|
3732
|
+
*
|
|
3733
|
+
* Historical events are streamed immediately if queried, and updates are pushed as events occur.
|
|
3734
|
+
*
|
|
3735
|
+
* Query Params Rules:
|
|
3736
|
+
* - `since` required if `until` specified
|
|
3737
|
+
* - `since_id` required if `until_id` specified
|
|
3738
|
+
* - `since` and `since_id` can't be used at the same time
|
|
3739
|
+
* Behavior:
|
|
3740
|
+
* - if `since` or `since_id` not specified this will not return any historic data
|
|
3741
|
+
* - if `until` or `until_id` reached stream will end (status 200)
|
|
3742
|
+
*
|
|
3743
|
+
* ---
|
|
3744
|
+
*
|
|
3745
|
+
* Note for people using the clients generated from this OAS spec. Currently OAS-3 doesn't have full support for representing SSE style responses from an API, so if you are using a generated client and don't specify a `since` and `until` there is a good chance the generated clients will hang waiting for the response to end.
|
|
3746
|
+
*
|
|
3747
|
+
* If you require the streaming capabilities we recommend not using the generated clients for this specific usecase until the OAS-3 standards come to a consensus on how to represent this correctly in OAS-3.
|
|
3748
|
+
*
|
|
3749
|
+
* ---
|
|
3750
|
+
*
|
|
3751
|
+
* **Legacy trade events API**
|
|
3752
|
+
*
|
|
3753
|
+
* **Deprecation notice**
|
|
3754
|
+
*
|
|
3755
|
+
* As part of the deprecation process,
|
|
3756
|
+
* the legacy trade events API is now only available for existing broker-partners at: `GET /v1/events/trades` only for compatibility reasons.
|
|
3757
|
+
*
|
|
3758
|
+
* All new broker partners will not have the option for the legacy trade event endpoint.
|
|
3759
|
+
*
|
|
3760
|
+
* All new broker partners will have to integrate with the new `/v2/events/trades` endpoint.
|
|
3761
|
+
*
|
|
3762
|
+
* Also, all existing broker partners are now recommended to upgrade to the `/v2/events/trades` endpoint, which provides faster event delivery times.
|
|
3763
|
+
*
|
|
3764
|
+
* The legacy trade events api works the same way as the new one with the exception of the event_id which is an integer except of an ULID. This results in the request's since_id and until_id are also being integers. This integer is monotonically increasing over time for events.
|
|
3765
|
+
*
|
|
3766
|
+
* Please note that the new `/v2` endpoint, is the same as, and was originally available under `/v2beta1`.
|
|
3767
|
+
* We encourage all customers to adjust their codebase from that interim beta endpoint to the `/v2` stable endpoint.
|
|
3768
|
+
* In the near future we will setup permanent redirect from `/v2beta1` to `/v2` before we completely remove the beta endpoint.
|
|
3769
|
+
*
|
|
3770
|
+
* ---
|
|
3771
|
+
*
|
|
3772
|
+
* ### Comment messages
|
|
3773
|
+
* According to the SSE specification, any line that starts with a colon is a comment which does not contain data. It is typically a free text that does not follow any data schema. A few examples mentioned below for comment messages.
|
|
3774
|
+
*
|
|
3775
|
+
* ##### Slow client
|
|
3776
|
+
*
|
|
3777
|
+
* The server sends a comment when the client is not consuming messages fast enough. Example: `: you are reading too slowly, dropped 10000 messages`
|
|
3778
|
+
*
|
|
3779
|
+
* ##### Internal server error
|
|
3780
|
+
*
|
|
3781
|
+
* An error message is sent as a comment when the server closes the connection on an internal server error (only sent by the v2 and v2beta1 endpoints). Example: `: internal server error`
|
|
3782
|
+
*
|
|
3783
|
+
* ---
|
|
3784
|
+
*
|
|
3785
|
+
* **Common events**
|
|
3786
|
+
*
|
|
3787
|
+
* These are the events that are the expected results of actions you may have taken by sending API requests.
|
|
3788
|
+
*
|
|
3789
|
+
* The meaning of the timestamp field changes for each type; the meanings have been specified here for which types the timestamp field will be present.
|
|
3790
|
+
*
|
|
3791
|
+
* - `accepted` Sent when an order is received and accepted by Alpaca
|
|
3792
|
+
* - `pending_new` Sent when the order has been received by Alpaca and routed to the exchanges, but has not yet been accepted for execution.
|
|
3793
|
+
* - `new` Sent when an order has been routed to exchanges for execution.
|
|
3794
|
+
* - `fill` Sent when your order has been completely filled.
|
|
3795
|
+
* - timestamp: The time at which the order was filled.
|
|
3796
|
+
* - `partial_fill` Sent when a number of shares less than the total remaining quantity on your order has been filled.
|
|
3797
|
+
* - timestamp: The time at which the shares were filled.
|
|
3798
|
+
* - `canceled` Sent when your requested cancellation of an order is processed.
|
|
3799
|
+
* - timestamp: The time at which the order was canceled.
|
|
3800
|
+
* - `expired` Sent when an order has reached the end of its lifespan, as determined by the order's time in force value.
|
|
3801
|
+
* - timestamp: The time at which the order expired.
|
|
3802
|
+
* - `done_for_day` Sent when the order is done executing for the day, and will not receive further updates until the next trading day.
|
|
3803
|
+
* - `replaced` Sent when your requested replacement of an order is processed.
|
|
3804
|
+
* - timestamp: The time at which the order was replaced.
|
|
3805
|
+
*
|
|
3806
|
+
* **Rarer events**
|
|
3807
|
+
*
|
|
3808
|
+
* These are events that may rarely be sent due to unexpected circumstances on the exchanges. It is unlikely you will need to design your code around them, but you may still wish to account for the possibility that they will occur.
|
|
3809
|
+
*
|
|
3810
|
+
* - `rejected` Sent when your order has been rejected.
|
|
3811
|
+
* - timestamp: The time at which the rejection occurred.
|
|
3812
|
+
* - `held` For multi-leg orders, the secondary orders (stop loss, take profit) will enter this state while waiting to be triggered.
|
|
3813
|
+
* - `stopped` Sent when your order has been stopped, and a trade is guaranteed for the order, usually at a stated price or better, but has not yet occurred.
|
|
3814
|
+
* - `pending_cancel` Sent when the order is awaiting cancellation. Most cancellations will occur without the order entering this state.
|
|
3815
|
+
* - `pending_replace` Sent when the order is awaiting replacement.
|
|
3816
|
+
* - `calculated` Sent when the order has been completed for the day - it is either filled or done_for_day - but remaining settlement calculations are still pending.
|
|
3817
|
+
* - `suspended` Sent when the order has been suspended and is not eligible for trading.
|
|
3818
|
+
* - `order_replace_rejected` Sent when the order replace has been rejected.
|
|
3819
|
+
* - `order_cancel_rejected` Sent when the order cancel has been rejected.
|
|
3820
|
+
* - `trade_bust`: Sent when a previously reported execution has been canceled ("busted") by the upstream exchange.
|
|
3821
|
+
* - `trade_correct`: Sent when a previously reported trade has been corrected. For example, the exchange may have updated the price, quantity, or another execution parameter after the trade was initially reported.
|
|
3822
|
+
* - `restated`: Sent when the order is manually modified.
|
|
3823
|
+
* @summary Subscribe to Trade Events (SSE)
|
|
3824
|
+
*/
|
|
3825
|
+
export declare const subscribeToTradeV2SSE: (params?: SubscribeToTradeV2SSEParams, options?: RequestInit) => Promise<subscribeToTradeV2SSEResponse>;
|