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

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

@@ -0,0 +1,153 @@
+/**
+ * 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 { AccountConfigurations } from './accountConfigurations.js';
+import type { AccountStatus } from './accountStatus.js';
+import type { AdminConfigurations } from './adminConfigurations.js';
+import type { TradeAccountOptionsApprovedLevel } from './tradeAccountOptionsApprovedLevel.js';
+import type { TradeAccountOptionsTradingLevel } from './tradeAccountOptionsTradingLevel.js';
+/**
+ * This is an extended version of the Account model found [in the trading api](https://alpaca.markets/docs/api-references/trading-api/account/#account-entity).
+ *
+ * Extra data has been added that would be useful for brokers.
+ */
+export interface TradeAccount {
+    /** If true, the account activity by user is prohibited. */
+    account_blocked: boolean;
+    /**
+       * The account number
+       * @nullable
+       */
+    account_number: string | null;
+    /** Accrued fees */
+    accrued_fees: string;
+    admin_configurations: AdminConfigurations;
+    /** The date of the snapshot for `last_*` fields */
+    balance_asof: string;
+    /**
+       * bod_dtbp
+       * @deprecated
+       */
+    bod_dtbp: string;
+    /** Current available cash buying power. If multiplier = 2 then buying_power = max(equity-initial_margin(0) * 2). If multiplier = 1 then buying_power = cash. */
+    buying_power: string;
+    /** Cash balance */
+    cash: string;
+    /** Cash available for transfer (JNLC) */
+    cash_transferable?: string;
+    /** Cash available for withdrawal */
+    cash_withdrawable?: string;
+    /** Clearing broker */
+    clearing_broker?: string;
+    /** Timestamp this account was created at */
+    created_at: string;
+    crypto_status: AccountStatus;
+    /** Always USD */
+    currency: string;
+    /**
+       * The current number of daytrades that have been made in the last 5 trading days (inclusive of today)
+       * @deprecated
+       */
+    daytrade_count: number;
+    /**
+       * Your buying power for day trades (continuously updated value)
+       * @deprecated
+       */
+    daytrading_buying_power: string;
+    /** Effective buying power (duplicate of buying power) */
+    effective_buying_power: string;
+    /** cash + long_market_value + short_market_value */
+    equity: string;
+    /** The account ID */
+    id: string;
+    /** Reg T initial margin requirement (continuously updated value) */
+    initial_margin: string;
+    /** The intraday adjustment by non_trade_activities such as fund deposit/withdraw. */
+    intraday_adjustments?: string;
+    /** Value of buying_power as of previous trading day at 16:00:00 ET */
+    last_buying_power?: string;
+    /** Value of all cash as of previous trading day at 16:00:00 ET */
+    last_cash?: string;
+    /**
+       * Value of daytrade count as of previous trading day at 16:00:00 ET
+       * @deprecated
+       */
+    last_daytrade_count?: number;
+    /**
+       * Value of daytrading buying power as of previous trading day at 16:00:00 ET
+       * @deprecated
+       */
+    last_daytrading_buying_power?: string;
+    /** Equity as of previous trading day at 16:00:00 ET */
+    last_equity: string;
+    /** Value of Reg T margin as of previous trading day at 16:00:00 ET */
+    last_initial_margin?: string;
+    /** Value of all long positions as of previous trading day at 16:00:00 ET */
+    last_long_market_value?: string;
+    /** Maintenance margin requirement on the previous trading day */
+    last_maintenance_margin: string;
+    /** Value of option buying power as of previous trading day at 16:00:00 ET */
+    last_options_buying_power?: string;
+    /** Value of Reg T buying power as of previous trading day at 16:00:00 ET */
+    last_regt_buying_power?: string;
+    /** Value of all short positions as of previous trading day at 16:00:00 ET */
+    last_short_market_value?: string;
+    /** Real-time MtM value of all long positions held in the account */
+    long_market_value: string;
+    /** Maintenance margin requirement (continuously updated value) */
+    maintenance_margin: string;
+    /** Outstanding memopost value */
+    memoposts?: string;
+    /** "1", "2", "3", or "4" */
+    multiplier: string;
+    /** Non-marginable buying power (currently used for only crypto trading) */
+    non_marginable_buying_power: string;
+    /**
+       * The options trading level that was approved for this account.
+       * 0=disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles.
+       */
+    options_approved_level?: TradeAccountOptionsApprovedLevel;
+    /** Your buying power for options trading */
+    options_buying_power?: string;
+    /**
+       * The effective options trading level of the account.
+       * This is the minimum between account options_approved_level and account configurations max_options_trading_level.
+       * 0=disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles.
+       */
+    options_trading_level?: TradeAccountOptionsTradingLevel;
+    /**
+       * Whether account is flagged as pattern day trader or not
+       * @deprecated
+       */
+    pattern_day_trader: boolean;
+    /** Pending regulatory fees for the account. */
+    pending_reg_taf_fees?: string;
+    /** Cash pending transfer out */
+    pending_transfer_out?: string;
+    /** Total value of cash + holding positions. (This field is deprecated. It is equivalent to the equity field.) */
+    portfolio_value: string;
+    /** Real-time MtM value of all the positions held in the account */
+    position_market_value: string;
+    /** Previous sessions close time */
+    previous_close?: string;
+    /** User's buying power under Regulation T (excess equity - (equity - margin value) - * margin multiplier) */
+    regt_buying_power: string;
+    /** Real-time MtM value of all short positions held in the account */
+    short_market_value: string;
+    /** Flag to denote whether or not the account is permitted to short */
+    shorting_enabled: boolean;
+    /** Value of Special Memorandum Account (will be used at a later date to provide additional buying_power) */
+    sma: string;
+    status: AccountStatus;
+    /** If true, the account is not allowed to place orders. */
+    trade_suspended_by_user: boolean;
+    /** If true, the account is not allowed to place orders. */
+    trading_blocked: boolean;
+    /** If true, the account is not allowed to request money transfers. */
+    transfers_blocked: boolean;
+    user_configurations: AccountConfigurations;
+}

package/dist/generated/broker/model/tradeAccountOptionsApprovedLevel.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 options trading level that was approved for this account.
+ * 0=disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles.
+ */
+export type TradeAccountOptionsApprovedLevel = typeof TradeAccountOptionsApprovedLevel[keyof typeof TradeAccountOptionsApprovedLevel];
+export declare const TradeAccountOptionsApprovedLevel: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+    readonly NUMBER_3: 3;
+};

package/dist/generated/broker/model/tradeAccountOptionsTradingLevel.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
+ */
+/**
+ * The effective options trading level of the account.
+ * This is the minimum between account options_approved_level and account configurations max_options_trading_level.
+ * 0=disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles.
+ */
+export type TradeAccountOptionsTradingLevel = typeof TradeAccountOptionsTradingLevel[keyof typeof TradeAccountOptionsTradingLevel];
+export declare const TradeAccountOptionsTradingLevel: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+    readonly NUMBER_3: 3;
+};

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

@@ -0,0 +1,30 @@
+/**
+ * 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 { OrderSide } from './orderSide.js';
+import type { OrderStatus } from './orderStatus.js';
+import type { TradeActivityType } from './tradeActivityType.js';
+export interface TradeActivity {
+    /** Valid only for trading activity types. Null for non-trading activites. */
+    cum_qty?: string;
+    /** Valid only for trading activity types. Null for non-trading activites. */
+    leaves_qty?: string;
+    /** Valid only for trading activity types. Null for non-trading activites. */
+    order_id?: string;
+    order_status?: OrderStatus;
+    /** Valid only for trading activity types. Null for non-trading activites. */
+    price?: string;
+    /** Valid only for trading activity types. Null for non-trading activites. */
+    qty?: string;
+    side?: OrderSide;
+    /** Valid only for trading activity types. Null for non-trading activites. */
+    symbol?: string;
+    /** Valid only for trading activity types. Null for non-trading activites. */
+    transaction_time?: string;
+    /** Valid only for trading activity types. Null for non-trading activites. */
+    type?: TradeActivityType;
+}

package/dist/generated/broker/model/tradeActivityType.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
+ */
+/**
+ * Valid only for trading activity types. Null for non-trading activites.
+ */
+export type TradeActivityType = typeof TradeActivityType[keyof typeof TradeActivityType];
+export declare const TradeActivityType: {
+    readonly fill: "fill";
+    readonly partial_fill: "partial_fill";
+};

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

@@ -0,0 +1,45 @@
+/**
+ * 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 { Order } from './order.js';
+import type { TradeUpdateEventType } from './tradeUpdateEventType.js';
+/**
+ * Represents an update to an order/trade, sent over the events streaming api.
+ */
+export interface TradeUpdateEvent {
+    /**
+       * Account UUID
+       * @minLength 1
+       */
+    account_id: string;
+    /**
+       * Timestamp of event
+       * @minLength 1
+       */
+    at: string;
+    event: TradeUpdateEventType;
+    /** Monotonically increasing 64bit integer */
+    event_id: number;
+    /** lexically sortable, monotonically increasing character array */
+    event_ulid: string;
+    /** Corresponding execution of an order. If an order gets filled over two executions (a partial_fill for example), you will receive two events with different IDs. */
+    execution_id: string;
+    order: Order;
+    /** Only present when event is either `fill` or `partial_fill`. The size of your total position, after this fill event, in shares. Positive for long positions, negative for short positions. */
+    position_qty?: string;
+    /** ID of the original execution that was busted or corrected (present only in trade_bust and trade_correct events). */
+    previous_execution_id?: string;
+    /** Only present when event is either `fill` or `partial_fill`. The average price per share at which the order was filled. */
+    price?: string;
+    /** Only present when event is either `fill` or `partial_fill`. The amount of shares this Trade order was for */
+    qty?: string;
+    /**
+       * Has various different meanings depending on the value of `event`, please see the [Trading Events](https://alpaca.markets/docs/api-references/broker-api/events/#trade-events)
+       * Enum in the documentation or the TradeUpdateEventType model for more details on when it means different things.
+       */
+    timestamp: string;
+}

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

@@ -0,0 +1,67 @@
+/**
+ * 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
+ */
+/**
+ * **Common events**
+ *
+ * These are the events that are the expected results of actions you may have taken by sending API requests.
+ *
+ * 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.
+ *
+ * - `new`: Sent when an order has been routed to exchanges for execution.
+ * - `fill`: Sent when your order has been completely filled.
+ *   - `timestamp`: The time at which the order was filled.
+ * - `partial_fill`: Sent when a number of shares less than the total remaining quantity on your order has been filled.
+ *   - `timestamp`: The time at which the shares were filled.
+ * - `canceled`: Sent when your requested cancellation of an order is processed.
+ *   - `timestamp`: The time at which the order was canceled.
+ * - `expired`: Sent when an order has reached the end of its lifespan, as determined by the order's time in force value.
+ *   - `timestamp`: The time at which the order expired.
+ * - `done_for_day`: Sent when the order is done executing for the day, and will not receive further updates until the next trading day.
+ * - `replaced`: Sent when your requested replacement of an order is processed.
+ *   - `timestamp`: The time at which the order was replaced.
+ *
+ * **Rarer events**
+ *
+ * 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.
+ *
+ * - `rejected`: Sent when your order has been rejected.
+ *   - `timestamp`: The time at which the rejection occurred.
+ * - `pending_new`: Sent when the order has been received by Alpaca and routed to the exchanges, but has not yet been accepted for execution.
+ * - `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.
+ * - `pending_cancel`: Sent when the order is awaiting cancellation. Most cancellations will occur without the order entering this state.
+ * - `pending_replace`: Sent when the order is awaiting replacement.
+ * - `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.
+ * - `suspended`: Sent when the order has been suspended and is not eligible for trading.
+ * - `order_replace_rejected`: Sent when the order replace has been rejected.
+ * - `order_cancel_rejected`: Sent when the order cancel has been rejected.
+ * - `trade_bust`: Sent when a previously reported execution has been canceled ("busted") by the upstream exchange.
+ * - `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.
+ * - `restated`: Sent when the order is manually modified.
+ */
+export type TradeUpdateEventType = typeof TradeUpdateEventType[keyof typeof TradeUpdateEventType];
+export declare const TradeUpdateEventType: {
+    readonly new: "new";
+    readonly fill: "fill";
+    readonly partial_fill: "partial_fill";
+    readonly canceled: "canceled";
+    readonly expired: "expired";
+    readonly done_for_day: "done_for_day";
+    readonly replaced: "replaced";
+    readonly rejected: "rejected";
+    readonly pending_new: "pending_new";
+    readonly stopped: "stopped";
+    readonly pending_cancel: "pending_cancel";
+    readonly pending_replace: "pending_replace";
+    readonly calculated: "calculated";
+    readonly suspended: "suspended";
+    readonly order_replace_rejected: "order_replace_rejected";
+    readonly order_cancel_rejected: "order_cancel_rejected";
+    readonly trade_bust: "trade_bust";
+    readonly trade_correct: "trade_correct";
+};

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

@@ -0,0 +1,55 @@
+/**
+ * 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 { Order } from './order.js';
+import type { TradeUpdateEventType } from './tradeUpdateEventType.js';
+import type { TradeUpdateEventV2Leg } from './tradeUpdateEventV2Leg.js';
+/**
+ * Represents an update to an order/trade, sent over the events streaming api.
+ */
+export interface TradeUpdateEventV2 {
+    /**
+       * Account UUID
+       * @minLength 1
+       */
+    account_id?: string;
+    /**
+       * Timestamp of event
+       * @minLength 1
+       */
+    at?: string;
+    event?: TradeUpdateEventType;
+    /** lexically sortable, monotonically increasing character array */
+    event_id?: string;
+    /**
+       * Corresponding execution of an order. If an order gets filled over two executions (a partial_fill for example), you will receive two events with different IDs.
+       * Not present for `MultilegOptions`
+       */
+    execution_id?: string;
+    /** Only present when event is for `MultilegOptions`. Represents filled qty/price of legs. */
+    legs?: TradeUpdateEventV2Leg[];
+    order?: Order;
+    /** Only present when event is either `fill` or `partial_fill` other than `MultilegOptions`. The size of your total position, after this fill event, in shares. Positive for long positions, negative for short positions. */
+    position_qty?: string;
+    /** Only present when event is either `fill` or `partial_fill` for `MultilegOptions`. The size of your total position, after this fill event, in shares. Positive for long positions, negative for short positions. */
+    position_qtys?: string;
+    /** ID of the original execution that was busted or corrected (present only in trade_bust and trade_correct events). */
+    previous_execution_id?: string;
+    /** Only present when event is either `fill` or `partial_fill`. The average price per share at which the order was filled. */
+    price?: string;
+    /** Only present when event is either `fill`, `partial_fill`, `trade_bust` and `trade_correct`. The amount of shares this Trade order was for. <br /> For `trade_bust` events, the qty field may be negative, representing a reversal of the original quantity. */
+    qty?: string;
+    /** Settlement date of the trade in format `YYYY-MM-DD` for `fill` and `partial_fill` events */
+    settle_date?: string;
+    /** Only present for `local currency trading account` or `crypto asset trade` when event is either `fill` or `partial_fill`. The swap rate at which the current trade was filled. */
+    swap_rate?: string;
+    /**
+       * Has various different meanings depending on the value of `event`, please see the [Trading Events](https://alpaca.markets/docs/api-references/broker-api/events/#trade-events)
+       * Enum in the documentation or the TradeUpdateEventType model for more details on when it means different things.
+       */
+    timestamp?: string;
+}

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

@@ -0,0 +1,27 @@
+/**
+ * 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 filled qty/price of legs.
+ */
+export interface TradeUpdateEventV2Leg {
+    /** Corresponding execution of an order. If an order gets filled over two executions (a partial_fill for example), you will receive two events with different IDs. */
+    execution_id?: string;
+    /**
+       * Order UUID
+       * @minLength 1
+       */
+    order_id?: string;
+    /** The average price per share for this event. */
+    price?: string;
+    /** The amount of shares filled for this event */
+    qty?: string;
+    /** Symbol of an asset */
+    symbol?: string;
+    /** Timestamp of this event leg */
+    timestamp?: string;
+}

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

@@ -0,0 +1,27 @@
+/**
+ * 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 Transaction {
+    /** The ledger ID */
+    account_id?: string;
+    /** The ledger name */
+    account_name?: string;
+    /** The ledger account number */
+    account_no?: string;
+    /** Total amount of the transaction */
+    amount?: string;
+    /** Ending balance after thetransaction has been applied */
+    balance?: string;
+    /** Contra account of transaction */
+    contra_account_name?: string;
+    /** Plain text overview of the transaction */
+    description?: string;
+    /** Type of transaction */
+    entry_type?: string;
+    /** Date of transaction */
+    system_date?: string;
+}

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

@@ -0,0 +1,65 @@
+/**
+ * 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 { TransferDirection } from './transferDirection.js';
+import type { TransferIRADetails } from './transferIRADetails.js';
+import type { TransferStatus } from './transferStatus.js';
+import type { TransferType } from './transferType.js';
+/**
+ * Transfers allow you to transfer money/balance into your end customers' account (deposits) or out (withdrawal).
+ *
+ * [Main docs here](https://alpaca.markets/docs/api-references/broker-api/funding/transfers/#the-transfer-object)
+ */
+export interface Transfer {
+    /** The account ID */
+    account_id: string;
+    /**
+       * Additional information. Only applies when type = "wire".
+       * @nullable
+       */
+    additional_information?: string | null;
+    /** Must be > 0.00 */
+    amount: string;
+    /** The ID of the Bank, only present if type = "wire" */
+    bank_id?: string;
+    /** Timestamp when transfer was created */
+    created_at: string;
+    direction: TransferDirection;
+    /** Timestamp when transfer expires */
+    expires_at?: string;
+    /**
+       * Fee amount to be collected. Only applies when type = "wire".
+       * @nullable
+       */
+    fee?: string | null;
+    /**
+       * Either "user" or "invoice". Only applies when type = "wire".
+       * @nullable
+       */
+    fee_payment_method?: string | null;
+    hold_until?: string;
+    /** The transfer ID */
+    id: string;
+    instant_amount?: string;
+    ira?: TransferIRADetails;
+    /**
+       * Cause of the status
+       * @nullable
+       */
+    reason?: string | null;
+    /** The ACH relationship ID only present if type = "ach" */
+    relationship_id?: string;
+    /**
+       * Must be > 0.00. Only applies when type = "wire".
+       * @nullable
+       */
+    requested_amount?: string | null;
+    status: TransferStatus;
+    type: TransferType;
+    /** Timestamp when transfer was updated */
+    updated_at?: string;
+}

package/dist/generated/broker/model/transferDirection.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
+ */
+/**
+ * - **INCOMING**
+ * Funds incoming to user's account (deposit).
+ * - **OUTGOING**
+ * Funds outgoing from user's account (withdrawal).
+ */
+export type TransferDirection = typeof TransferDirection[keyof typeof TransferDirection];
+export declare const TransferDirection: {
+    readonly INCOMING: "INCOMING";
+    readonly OUTGOING: "OUTGOING";
+};

package/dist/generated/broker/model/transferFee.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 { Currency } from './currency.js';
+import type { FeePaymentType } from './feePaymentType.js';
+import type { FeeType } from './feeType.js';
+export interface TransferFee {
+    amount: string;
+    currency: Currency;
+    payment_type: FeePaymentType;
+    type: FeeType;
+}

package/dist/generated/broker/model/transferIRA.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 { TransferIRATaxWithholding } from './transferIRATaxWithholding.js';
+/**
+ * This field is used for IRA Account only
+ */
+export interface TransferIRA {
+    distribution_reason?: string;
+    tax_withholding?: TransferIRATaxWithholding;
+    tax_year?: string;
+}

package/dist/generated/broker/model/transferIRADetails.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
+ */
+export interface TransferIRADetails {
+    distribution_reason?: string;
+    fed_withholding_amount?: string;
+    fed_withholding_pct?: string;
+    state_withholding_amount?: string;
+    state_withholding_pct?: string;
+    tax_year?: string;
+}

package/dist/generated/broker/model/transferIRATaxWithholding.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 TransferIRATaxWithholding {
+    fed_pct?: string;
+    state_pct?: string;
+}

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

@@ -0,0 +1,39 @@
+/**
+ * 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
+ */
+/**
+ * - **QUEUED**
+ * Transfer is in queue to be processed.
+ * - **APPROVAL_PENDING**
+ * Transfer is pending approval.
+ * - **PENDING**
+ * Transfer is pending processing.
+ * - **SENT_TO_CLEARING**
+ * Transfer is being processed by the clearing firm.
+ * - **REJECTED**
+ * Transfer is rejected.
+ * - **CANCELED**
+ * Client initiated transfer cancellation.
+ * - **APPROVED**
+ * Transfer is approved.
+ * - **COMPLETE**
+ * Transfer is completed.
+ * - **RETURNED**
+ * The bank issued an ACH return for the transfer.
+ */
+export type TransferStatus = typeof TransferStatus[keyof typeof TransferStatus];
+export declare const TransferStatus: {
+    readonly QUEUED: "QUEUED";
+    readonly APPROVAL_PENDING: "APPROVAL_PENDING";
+    readonly PENDING: "PENDING";
+    readonly SENT_TO_CLEARING: "SENT_TO_CLEARING";
+    readonly REJECTED: "REJECTED";
+    readonly CANCELED: "CANCELED";
+    readonly APPROVED: "APPROVED";
+    readonly COMPLETE: "COMPLETE";
+    readonly RETURNED: "RETURNED";
+};