@alpaca-open-api/core 0.1.0-rc.0

package/dist/generated/broker/model/accountExtended.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { AccountCashInterestResponse } from './accountCashInterestResponse.js';
+import type { AccountConfigurations } from './accountConfigurations.js';
+import type { AccountExtendedInvestmentObjective } from './accountExtendedInvestmentObjective.js';
+import type { AccountExtendedInvestmentTimeHorizon } from './accountExtendedInvestmentTimeHorizon.js';
+import type { AccountExtendedLiquidityNeeds } from './accountExtendedLiquidityNeeds.js';
+import type { AccountExtendedRiskTolerance } from './accountExtendedRiskTolerance.js';
+import type { AccountExtendedUsd } from './accountExtendedUsd.js';
+import type { AccountFPSLResponse } from './accountFPSLResponse.js';
+import type { AccountStatus } from './accountStatus.js';
+import type { AccountSubType } from './accountSubType.js';
+import type { AccountType } from './accountType.js';
+import type { Agreement } from './agreement.js';
+import type { AssetClass } from './assetClass.js';
+import type { Beneficiary } from './beneficiary.js';
+import type { Contact } from './contact.js';
+import type { Currency } from './currency.js';
+import type { CustodialAccountMinorIdentity } from './custodialAccountMinorIdentity.js';
+import type { CustodialAccountType } from './custodialAccountType.js';
+import type { Disclosures } from './disclosures.js';
+import type { Identity } from './identity.js';
+import type { KYCResults } from './kYCResults.js';
+import type { OwnerDocument } from './ownerDocument.js';
+import type { TrustedContact } from './trustedContact.js';
+/**
+ * Represents an account with all data available. If your api response is missing some of these fields, there is a good chance you are using a route that returns `Account` instances instead of these.
+ */
+export interface AccountExtended {
+    account_name?: string;
+    /** @nullable */
+    account_number: string | null;
+    account_sub_type?: AccountSubType;
+    account_type: AccountType;
+    agreements?: Agreement[];
+    beneficiaries?: Beneficiary[];
+    cash_interest?: AccountCashInterestResponse;
+    contact?: Contact;
+    created_at: string;
+    crypto_status?: AccountStatus;
+    currency: Currency;
+    custodial_account_type?: CustodialAccountType;
+    disclosures?: Disclosures;
+    /** The documents associated with the primary owner of the account */
+    documents?: OwnerDocument[];
+    enabled_assets?: AssetClass[];
+    fpsl?: AccountFPSLResponse;
+    id: string;
+    identity?: Identity;
+    /** The user's investment objective. This field should be used instead of the deprecated `investment_objective` under identity. */
+    investment_objective?: AccountExtendedInvestmentObjective;
+    /** The expected period of time the user plan to invest to achieve his/her financial goal(s). This field should be used instead of the deprecated `investment_time_horizon` under identity. */
+    investment_time_horizon?: AccountExtendedInvestmentTimeHorizon;
+    kyc_results?: KYCResults;
+    last_equity: string;
+    /** The user's ability to quickly and easily convert to cash all or a portion of the investments in this account without experiencing significant loss in value. This field should be used instead of the deprecated `liquidity_needs` under identity. */
+    liquidity_needs?: AccountExtendedLiquidityNeeds;
+    minor_identity?: CustodialAccountMinorIdentity;
+    /**
+       * UUID that identifies the primary account holder (party) for accounts opened under the Multi-Live Accounts (MLA) flow.
+       * Only populated when the account was created by referencing an existing account holder via `primary_account_holder_id`
+       * on `POST /v1/accounts`. Otherwise `null`. Currently only supported for `account_type` of `trading` and `ira`.
+       * @nullable
+       */
+    primary_account_holder_id?: string | null;
+    /** The user's investment risk tolerance. This field should be used instead of the deprecated `risk_tolerance` under identity. */
+    risk_tolerance?: AccountExtendedRiskTolerance;
+    status: AccountStatus;
+    trading_configurations?: AccountConfigurations;
+    trusted_contact?: TrustedContact;
+    /** values in USD. This is returned for LCT (non-USD) accounts only. */
+    usd?: AccountExtendedUsd;
+}

package/dist/generated/broker/model/accountExtendedInvestmentObjective.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * The user's investment objective. This field should be used instead of the deprecated `investment_objective` under identity.
+ */
+export type AccountExtendedInvestmentObjective = typeof AccountExtendedInvestmentObjective[keyof typeof AccountExtendedInvestmentObjective];
+export declare const AccountExtendedInvestmentObjective: {
+    readonly generate_income: "generate_income";
+    readonly preserve_wealth: "preserve_wealth";
+    readonly market_speculation: "market_speculation";
+    readonly growth: "growth";
+    readonly balance_preserve_wealth_with_growth: "balance_preserve_wealth_with_growth";
+};

package/dist/generated/broker/model/accountExtendedInvestmentTimeHorizon.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * The expected period of time the user plan to invest to achieve his/her financial goal(s). This field should be used instead of the deprecated `investment_time_horizon` under identity.
+ */
+export type AccountExtendedInvestmentTimeHorizon = typeof AccountExtendedInvestmentTimeHorizon[keyof typeof AccountExtendedInvestmentTimeHorizon];
+export declare const AccountExtendedInvestmentTimeHorizon: {
+    readonly less_than_1_year: "less_than_1_year";
+    readonly '1_to_2_years': "1_to_2_years";
+    readonly '3_to_5_years': "3_to_5_years";
+    readonly '6_to_10_years': "6_to_10_years";
+    readonly more_than_10_years: "more_than_10_years";
+};

package/dist/generated/broker/model/accountExtendedLiquidityNeeds.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * The user's ability to quickly and easily convert to cash all or a portion of the investments in this account without experiencing significant loss in value. This field should be used instead of the deprecated `liquidity_needs` under identity.
+ */
+export type AccountExtendedLiquidityNeeds = typeof AccountExtendedLiquidityNeeds[keyof typeof AccountExtendedLiquidityNeeds];
+export declare const AccountExtendedLiquidityNeeds: {
+    readonly very_important: "very_important";
+    readonly important: "important";
+    readonly somewhat_important: "somewhat_important";
+    readonly does_not_matter: "does_not_matter";
+};

package/dist/generated/broker/model/accountExtendedRiskTolerance.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * The user's investment risk tolerance. This field should be used instead of the deprecated `risk_tolerance` under identity.
+ */
+export type AccountExtendedRiskTolerance = typeof AccountExtendedRiskTolerance[keyof typeof AccountExtendedRiskTolerance];
+export declare const AccountExtendedRiskTolerance: {
+    readonly conservative: "conservative";
+    readonly moderate: "moderate";
+    readonly significant_risk: "significant_risk";
+};

package/dist/generated/broker/model/accountExtendedUsd.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * values in USD. This is returned for LCT (non-USD) accounts only.
+ */
+export type AccountExtendedUsd = {
+    last_equity?: string;
+};

package/dist/generated/broker/model/accountFPSLEvent.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { AccountFPSLEventUS } from './accountFPSLEventUS.js';
+/**
+ * This property is included when the account's FPSL information had changed due to an enrollment, tier change, or unenrollment.
+ * The from and to status or tier id will be included in the event, depending on the change.
+ */
+export interface AccountFPSLEvent {
+    US?: AccountFPSLEventUS;
+}

package/dist/generated/broker/model/accountFPSLEventUS.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type AccountFPSLEventUS = {
+    /** The FPSL program status of the account before the change */
+    status_from?: string;
+    /** The FPSL program status of the account after the change */
+    status_to?: string;
+    /** The tier id before the change */
+    tier_from?: string;
+    /** The tier id after the change */
+    tier_to?: string;
+};

package/dist/generated/broker/model/accountFPSLItem.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export interface AccountFPSLItem {
+    /**
+       * The status of the account for this FPSL market. One of:
+       * - **ACTIVE**
+       * The account is successfully enrolled for FPSL for this market.
+       * - **INACTIVE**
+       * The account is not enrolled for FPSL for this market due to it either not being eligible, an FPSL tier has not been assigned, or it has been unenrolled.
+       */
+    status?: string;
+    /** The id of the FPSL tier for this market */
+    tier_id?: string;
+}

package/dist/generated/broker/model/accountFPSLItemPost.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export interface AccountFPSLItemPost {
+    /** The id of the FPSL tier for this market */
+    tier_id?: string;
+}

package/dist/generated/broker/model/accountFPSLPatch.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { AccountFPSLItem } from './accountFPSLItem.js';
+/**
+ * The account's Fully Paid Securities Lending (FPSL) configuration.
+ * Use this property to change the account's configuration for the FPSL program.
+ * To enroll the account for a market, specify the tier_id. The status should not be specified on enrollment.
+ * To change the tier, specify the new tier_id. The status should not be specified on tier changes.
+ * To unenroll, set the status to INACTIVE.
+ * To re-enroll the account, set the status to ACTIVE. You can also specify the tier_id in case you want to change it.
+ * Currently only US market is supported.
+ */
+export interface AccountFPSLPatch {
+    US?: AccountFPSLItem;
+}

package/dist/generated/broker/model/accountFPSLPost.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { AccountFPSLItemPost } from './accountFPSLItemPost.js';
+/**
+ * The account's Fully Paid Securities Lending (FPSL) configuration.
+ * To enroll the account for a market, specify the tier_id. The status should not be specified on enrollment.
+ * Currently only the US market is supported.
+ */
+export interface AccountFPSLPost {
+    US?: AccountFPSLItemPost;
+}

package/dist/generated/broker/model/accountFPSLResponse.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { AccountFPSLItem } from './accountFPSLItem.js';
+/**
+ * The account's Fully Paid Securities Lending (FPSL) configuration.
+ * This is only returned for accounts that have FPSL enabled.
+ */
+export interface AccountFPSLResponse {
+    US?: AccountFPSLItem;
+}

package/dist/generated/broker/model/accountLimit.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export interface AccountLimit {
+    account_no: string;
+    amount_available: string;
+    amount_in_use: string;
+    amount_limit: string;
+}

package/dist/generated/broker/model/accountStatus.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * Designates the current status of this account
+ *
+ * Possible Values:
+ * - **INACTIVE**
+ * Account not set to trade given asset.
+ * - **ONBOARDING**
+ * An application is expected for this user, but has not been submitted yet.
+ * - **SUBMITTED**
+ * The application has been submitted and is being processed.
+ * - **SUBMISSION_FAILED**
+ * Used to display if failure on submission
+ * - **ACTION_REQUIRED**
+ * The application requires manual action.
+ * - **ACCOUNT_UPDATED**
+ * Used to display when Account has been modified by user
+ * - **APPROVAL_PENDING**
+ * Initial value. The application approval process is in progress.
+ * - **APPROVED**
+ * The account application has been approved, and waiting to be ACTIVE
+ * - **REJECTED**
+ * The account application is rejected for some reason
+ * - **ACTIVE**
+ * The account is fully active. Trading and funding are processed under this status.
+ * - **ACCOUNT_CLOSED**
+ * The account is closed.
+ */
+export type AccountStatus = typeof AccountStatus[keyof typeof AccountStatus];
+export declare const AccountStatus: {
+    readonly INACTIVE: "INACTIVE";
+    readonly ONBOARDING: "ONBOARDING";
+    readonly SUBMITTED: "SUBMITTED";
+    readonly SUBMISSION_FAILED: "SUBMISSION_FAILED";
+    readonly ACTION_REQUIRED: "ACTION_REQUIRED";
+    readonly ACCOUNT_UPDATED: "ACCOUNT_UPDATED";
+    readonly APPROVAL_PENDING: "APPROVAL_PENDING";
+    readonly APPROVED: "APPROVED";
+    readonly REJECTED: "REJECTED";
+    readonly ACTIVE: "ACTIVE";
+    readonly ACCOUNT_CLOSED: "ACCOUNT_CLOSED";
+};

package/dist/generated/broker/model/accountStatusEvent.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { AccountCashInterestEvent } from './accountCashInterestEvent.js';
+import type { AccountFPSLEvent } from './accountFPSLEvent.js';
+import type { AdminConfigurations } from './adminConfigurations.js';
+import type { KYCResults } from './kYCResults.js';
+import type { OptionsApprovalEvent } from './optionsApprovalEvent.js';
+/**
+ * Represents a change to certain account properties, sent over the events streaming API.
+ */
+export interface AccountStatusEvent {
+    /** If true the account was blocked, if false, the account got unblocked */
+    account_blocked?: boolean;
+    /**
+       * The unique identifier of the account that was changed
+       * @minLength 1
+       */
+    account_id: string;
+    /**
+       * The account number of the account that was changed
+       * @minLength 1
+       */
+    account_number?: string;
+    admin_configurations?: AdminConfigurations;
+    /**
+       * timestamp of event
+       * @minLength 1
+       */
+    at: string;
+    cash_interest?: AccountCashInterestEvent;
+    /** account crypto_status changed from */
+    crypto_status_from?: string;
+    /** account crypto_status changed to */
+    crypto_status_to?: string;
+    /** monotonically increasing 64bit integer */
+    event_id: number;
+    /** lexically sortable, monotonically increasing character array */
+    event_ulid: string;
+    fpsl?: AccountFPSLEvent;
+    kyc_results?: KYCResults;
+    options?: OptionsApprovalEvent;
+    /**
+       * If true the pattern_day_trader flag was set for the account, if false, the flag was reset.
+       * @deprecated
+       */
+    pattern_day_trader?: boolean;
+    /**
+       * @deprecated
+       * @minLength 1
+       */
+    reason?: string;
+    /** The account status before the change */
+    status_from?: string;
+    /** The account status after the change */
+    status_to?: string;
+    /** If true the account cannot trade going forward, if false, the ban has been lifed */
+    trading_blocked?: boolean;
+}

package/dist/generated/broker/model/accountSubType.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * IRA Account only
+ *
+ * Possible values are:
+ *
+ * - traditional
+ * - roth
+ */
+export type AccountSubType = typeof AccountSubType[keyof typeof AccountSubType];
+export declare const AccountSubType: {
+    readonly traditional: "traditional";
+    readonly roth: "roth";
+};

package/dist/generated/broker/model/accountTradingLimit.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { USDAccountTradingLimit } from './uSDAccountTradingLimit.js';
+export interface AccountTradingLimit {
+    /** The remaining net buying limit that can be used for trading. */
+    available?: string;
+    /** The net buying limit that can be reached before further trading activity is restricted. Please reach out to learn more about how this limit is determined. */
+    daily_net_limit?: string;
+    /** The limit that is currently being held for open orders */
+    held?: string;
+    /** The swap rate is applicable for Local Currency Trading (LCT) accounts */
+    swap_rate?: string;
+    usd?: USDAccountTradingLimit;
+    /** The real time net value of cash inflows (buy trades, etc.) with cash outflows (sell trades, etc). This will be dynamic throughout the day based on user activity, with executed orders being reset at the start of the next trading day. */
+    used?: string;
+}

package/dist/generated/broker/model/accountType.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * Possible values are:
+ *
+ * - trading
+ * - custodial
+ * - donor_advised
+ * - ira
+ */
+export type AccountType = typeof AccountType[keyof typeof AccountType];
+export declare const AccountType: {
+    readonly trading: "trading";
+    readonly custodial: "custodial";
+    readonly donor_advised: "donor_advised";
+    readonly ira: "ira";
+};

package/dist/generated/broker/model/accountUpdateRequest.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { AccountCashInterestPatch } from './accountCashInterestPatch.js';
+import type { AccountFPSLPatch } from './accountFPSLPatch.js';
+import type { Agreement } from './agreement.js';
+import type { Beneficiary } from './beneficiary.js';
+import type { Contact } from './contact.js';
+import type { Disclosures } from './disclosures.js';
+import type { Identity } from './identity.js';
+import type { TrustedContact } from './trustedContact.js';
+export interface AccountUpdateRequest {
+    /** Additional agreements, or new revisions of existing agreements, read and signed by the account holder. */
+    agreements?: Agreement[];
+    beneficiaries?: Beneficiary[];
+    cash_interest?: AccountCashInterestPatch;
+    contact?: Contact;
+    disclosures?: Disclosures;
+    fpsl?: AccountFPSLPatch;
+    identity?: Identity;
+    /**
+       * The UUID of the primary account holder. This field is immutable after the account is created.
+       *
+       * - Omitting the field, or supplying the value already associated with the account, is a no-op.
+       * - Supplying a value different from the current primary account holder returns HTTP 400.
+       */
+    primary_account_holder_id?: string;
+    trusted_contact?: TrustedContact;
+}

package/dist/generated/broker/model/activity.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { ActivityType } from './activityType.js';
+import type { NonTradeActivity } from './nonTradeActivity.js';
+import type { TradeActivity } from './tradeActivity.js';
+/**
+ * Base for activity types
+ */
+export type Activity = (TradeActivity | NonTradeActivity) & {
+    account_id?: string;
+    activity_type: ActivityType;
+    id: string;
+};

package/dist/generated/broker/model/activityEventV2.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { ActivityEventV2CommonFields } from './activityEventV2CommonFields.js';
+import type { ActivityV2DetailNTA } from './activityV2DetailNTA.js';
+import type { ActivityV2DetailTRD } from './activityV2DetailTRD.js';
+/**
+ * Represents an account activity, sent over the Event Streaming API.
+ */
+export type ActivityEventV2 = ActivityEventV2CommonFields & ({
+    details: ActivityV2DetailTRD | ActivityV2DetailNTA;
+});

package/dist/generated/broker/model/activityEventV2CommonFields.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * Represents the common fields for all Activity V2 Events
+ */
+export interface ActivityEventV2CommonFields {
+    /** Account UUID */
+    account_id: string;
+    /** Sub category for activity type, if any */
+    activity_subtype?: string;
+    /** The type of the activity, which can be trade or any of the non trade activities */
+    activity_type: string;
+    /**
+       * Timestamp of event
+       * @minLength 1
+       */
+    at: string;
+    /** Currency code in ISO format */
+    currency: string;
+    /** Lexically sortable, monotonically increasing character string */
+    event_id: string;
+    /**
+       * Execution time for the activity event
+       * @minLength 1
+       */
+    executed_at: string;
+    /** The net amount of money (positive or negative) associated with the activity */
+    net_amount?: string;
+    /** Previous ID is presented if this activity corrects or cancels a previous trade or non trade activity. It contains execution_id or trns_id respectively */
+    previous_id?: string;
+    /** The price of the security involved with the activity */
+    price?: string;
+    /** The quantity of the security involved with the activity */
+    qty?: string;
+    /** The unique identifier for the activity. For trades, the execution_id is used, for other activities the trns_id is used. */
+    ref_id: string;
+    /**
+       * Date when the activity settled
+       * @minLength 1
+       */
+    settle_date: string;
+    /** Status of the activity */
+    status: string;
+    /** Currency conversion fee rate base-point in case of local currency activity */
+    swap_fee_bps?: string;
+    /** Conversion rate for local currency activities */
+    swap_rate?: string;
+}