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

package/dist/generated/broker/model/agreement.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 { AgreementType } from './agreementType.js';
+export interface Agreement {
+    agreement: AgreementType;
+    /** The ip_address the signed agreements were sent from by the user. */
+    ip_address: string;
+    /**
+       * The agreement revision.
+       * The format is XX.YYYY.MM where XX is an incrementing revision number, YYYY is the year and MM is the month.
+       * If the revision is not specified in a POST or PATCH request, the active revision will be used, which will align with the [Alpaca Documents Library](https://alpaca.markets/disclosures).
+       */
+    revision?: string;
+    /** The timestamp the agreement was signed. */
+    signed_at: string;
+}

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

@@ -0,0 +1,23 @@
+/**
+ * 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
+ */
+/**
+ * - margin_agreement: Alpaca Margin Agreement
+ * - account_agreement: Alpaca Account Agreement
+ * - customer_agreement: Alpaca Customer Agreement
+ * - crypto_agreement: Alpaca Crypto agreement
+ * - options_agreement: Alpaca Option agreement
+ * - custodial_customer_agreement: Alpaca Custodial Customer agreement
+ */
+export type AgreementType = typeof AgreementType[keyof typeof AgreementType];
+export declare const AgreementType: {
+    readonly margin_agreement: "margin_agreement";
+    readonly account_agreement: "account_agreement";
+    readonly customer_agreement: "customer_agreement";
+    readonly crypto_agreement: "crypto_agreement";
+    readonly options_agreement: "options_agreement";
+};

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

@@ -0,0 +1,90 @@
+/**
+ * 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 { AnnouncementCASubType } from './announcementCASubType.js';
+import type { AnnouncementCAType } from './announcementCAType.js';
+/**
+ * The announcements endpoint contains public information on previous and upcoming dividends, mergers, spinoffs, and stock splits.
+ *
+ * Announcement data is made available through the API as soon as it is ingested by Alpaca, which is typically the following trading day after the declaration date. This provides insight into future account stock position and cash balance changes that will take effect on an announcement's payable date. Additionally, viewing previous announcement details can improve bookkeeping and reconciling previous account cash and position changes.
+ */
+export interface Announcement {
+    ca_sub_type: AnnouncementCASubType;
+    ca_type: AnnouncementCAType;
+    /**
+       * The amount of cash to be paid per share held by an account on the record date.
+       * @minLength 1
+       * @nullable
+       */
+    cash: string | null;
+    /**
+       * ID that remains consistent across all announcements for the same corporate action. Unlike 'id', this can be used to connect multiple announcements to see how the terms have changed throughout the lifecycle of the corporate action event.
+       * @minLength 1
+       */
+    corporate_action_id: string;
+    /**
+       * Date the corporate action or subsequent terms update was announced.
+       * @minLength 1
+       */
+    declaration_date: string;
+    /**
+       * The first date that purchasing a security will not result in a corporate action entitlement.
+       * @minLength 1
+       * @nullable
+       */
+    ex_date: string | null;
+    /**
+       * ID that is specific to a single announcement.
+       * @minLength 1
+       */
+    id: string;
+    /**
+       * CUSIP of the company initiating the announcement.
+       * @minLength 1
+       */
+    initiating_original_cusip: string;
+    /**
+       * Symbol of the company initiating the announcement.
+       * @minLength 1
+       */
+    initiating_symbol: string;
+    /**
+       * The numerator to determine any quantity change ratios in positions.
+       * @minLength 1
+       * @nullable
+       */
+    new_rate: string | null;
+    /**
+       * The denominator to determine any quantity change ratios in positions.
+       * @minLength 1
+       * @nullable
+       */
+    old_rate: string | null;
+    /**
+       * The date the announcement will take effect. On this date, account stock and cash balances are expected to be processed accordingly.
+       * @minLength 1
+       */
+    payable_date: string;
+    /**
+       * The date an account must hold a settled position in the security in order to receive the corporate action entitlement.
+       * @minLength 1
+       * @nullable
+       */
+    record_date: string | null;
+    /**
+       * CUSIP of the child company involved in the announcement.
+       * @minLength 1
+       * @nullable
+       */
+    target_original_cusip: string | null;
+    /**
+       * Symbol of the child company involved in the announcement.
+       * @minLength 1
+       * @nullable
+       */
+    target_symbol: string | null;
+}

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

@@ -0,0 +1,60 @@
+/**
+ * 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
+ */
+/**
+ * Announcements have both a type and a subtype to categorize them. This model represents the lowever level abstract "sub types" of Announcement. Please see the AnnouncementCAType model for higher level descriptions of the possible types
+ *
+ * Possible values are:
+ *
+ * - from the `dividend` type:
+ *   - **cash**
+ *
+ *     A cash payment based on the number of shares the account holds on the record date.
+ *   - **stock**
+ *
+ *     A stock payment based on the number of shares the account holds on the record date.
+ *
+ * - from the `merger` type:
+ *   - **merger_update**
+ *
+ *     An update to the terms of an upcoming merger. This can happen any number of times before the merger is completed and can be tracked by using the id parameter.
+ *
+ *   - **merger_completion**
+ *
+ *     A final update in the terms of the merger in which the intiating_symbol will acquire the target_symbol. Any previous terms updates for this announcement will have the same id value.
+ *
+ * - from the `split` type:
+ *   - **stock_split**
+ *
+ *     An increase in the number of shares outstanding with a decrease in the dollar value of each share. The new_rate and old_rate parameters will be returned in order to derive the ratio of the split
+ *   - **until_split**
+ *
+ *     An increase in the number of shares outstanding with a decrease in the dollar value of each share. The new_rate and old_rate parameters will be returned in order to derive the ratio of the split.
+ *   - **reverse_split**
+ *
+ *     A decrease in the number of shares outstanding with an increase in the dollar value of each share. The new_rate and old_rate parameters will be returned in order to derive the ratio of the spli
+ *   - **recapitalization**
+ *
+ *     A stock recapitalization, typically used by a company to adjust debt and equity ratios.
+ *
+ * - from the `spinoff` type:
+ *   - **spinoff**
+ *
+ *     A disbursement of a newly tradable security when the intiating_symbol creates the target_symbol.
+ */
+export type AnnouncementCASubType = typeof AnnouncementCASubType[keyof typeof AnnouncementCASubType];
+export declare const AnnouncementCASubType: {
+    readonly cash: "cash";
+    readonly stock: "stock";
+    readonly merger_update: "merger_update";
+    readonly merger_completion: "merger_completion";
+    readonly stock_split: "stock_split";
+    readonly until_split: "until_split";
+    readonly reverse_split: "reverse_split";
+    readonly recapitalization: "recapitalization";
+    readonly spinoff: "spinoff";
+};

package/dist/generated/broker/model/announcementCAType.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
+ */
+/**
+ * Announcements have both a type and a subtype to categorize them. This model represents the higher level abstract "types" of Announcement. Please see the AnnouncementCASubType model for finer grain descriptions of the subtypes
+ *
+ * Possible values are:
+ * - dividend
+ *   can have `cash` and `stock` subtypes
+ * - merger
+ *   has `merger_update` and `merger_completion` sub types
+ * - split
+ *   has `stock_split`, `until_split`, `reverse_split`, and `recapitalization` sub types
+ * - spinoff
+ *   currently has only the `spinoff` subtype and thus is just this higher level category for now. A disbursement of a newly tradable security when the intiating_symbol creates the target_symbol.
+ */
+export type AnnouncementCAType = typeof AnnouncementCAType[keyof typeof AnnouncementCAType];
+export declare const AnnouncementCAType: {
+    readonly dividend: "dividend";
+    readonly merger: "merger";
+    readonly split: "split";
+    readonly spinoff: "spinoff";
+};

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

@@ -0,0 +1,71 @@
+/**
+ * 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 { AssetAttributesItem } from './assetAttributesItem.js';
+import type { AssetBorrowStatus } from './assetBorrowStatus.js';
+import type { AssetClass } from './assetClass.js';
+import type { AssetStatus } from './assetStatus.js';
+import type { Exchange } from './exchange.js';
+/**
+ * Assets are sorted by asset class, exchange and symbol. Some assets are not tradable with Alpaca. These assets will be marked with the flag tradable=false
+ */
+export interface Asset {
+    /**
+       * Unique characteristics of the asset. Supported values:
+       * - `ptp_no_exception`: Asset is a Publicly Traded Partnership (PTP) without a qualified notice; non-U.S. customers may incur 10% withholding on gross proceeds as per IRS guidance, and are blocked from being purchased by default.
+       * - `ptp_with_exception`: Users can open positions in these PTPs without general restrictions.
+       * - `ipo`: Accepting limit orders only before the stock begins trading on the secondary market.
+       * - `has_options`: The underlying equity has listed options available on the platform. Note: if the equity had inactive/expired contracts in the past, this will still show up.
+       * - `options_late_close`: Indicates the underlying asset's options contracts close at 4:15pm ET instead of the standard 4:00pm ET.
+       * - `fractional_eh_enabled`: Indicates the asset accepts fractional orders during extended hours sessions (pre-market, post-market, and overnight if enabled).
+       * - `overnight_tradable`: Asset is eligible for overnight (24x5) trading in supported venues on the platform.
+       * - `overnight_halted`: Asset is eligible for overnight trading but is currently halted/blocked for overnight sessions due to risk, corporate action, compliance, or venue constraints.
+       */
+    attributes?: AssetAttributesItem[];
+    /** Borrow status for US equity assets. This field is omitted for non-US-equity assets. */
+    borrow_status?: AssetBorrowStatus;
+    class: AssetClass;
+    /**
+       * **deprecated**: Please use borrow_status instead.
+       * Asset is easy-to-borrow or not (filtering for easy_to_borrow = True is the best way to check whether the name is currently available to short at Alpaca).
+       * @deprecated
+       */
+    easy_to_borrow: boolean;
+    exchange: Exchange;
+    /** Asset is fractionable or not */
+    fractionable: boolean;
+    /** Asset ID */
+    id: string;
+    /**
+       * **deprecated**: Please use margin_requirement_long or margin_requirement_short instead. Note that these fields are of type string.
+       * Shows the margin requirement percentage for the asset (equities only).
+       * @deprecated
+       */
+    maintenance_margin_requirement: number;
+    /** The margin requirement percentage for the asset's long positions (equities only). */
+    margin_requirement_long: string;
+    /** The margin requirement percentage for the asset's short positions (equities only). */
+    margin_requirement_short: string;
+    /** Asset is marginable or not */
+    marginable: boolean;
+    /** Minimum order size.  Field available for crypto only. */
+    min_order_size?: string;
+    /** Amount a trade quantity can be incremented by. Field available for crypto only. */
+    min_trade_increment?: string;
+    /** The official name of the asset */
+    name: string;
+    /** Amount the price can be incremented by. Field available for crypto only. */
+    price_increment?: string;
+    /** Asset is shortable or not */
+    shortable: boolean;
+    /** active or inactive */
+    status: AssetStatus;
+    /** The symbol of the asset */
+    symbol: string;
+    /** Asset is tradable on Alpaca or not */
+    tradable: boolean;
+}

package/dist/generated/broker/model/assetAttributesItem.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
+ */
+export type AssetAttributesItem = typeof AssetAttributesItem[keyof typeof AssetAttributesItem];
+export declare const AssetAttributesItem: {
+    readonly ptp_no_exception: "ptp_no_exception";
+    readonly ptp_with_exception: "ptp_with_exception";
+    readonly ipo: "ipo";
+    readonly has_options: "has_options";
+    readonly options_late_close: "options_late_close";
+    readonly fractional_eh_enabled: "fractional_eh_enabled";
+    readonly overnight_tradable: "overnight_tradable";
+    readonly overnight_halted: "overnight_halted";
+};

package/dist/generated/broker/model/assetBorrowStatus.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
+ */
+/**
+ * Borrow status for US equity assets. This field is omitted for non-US-equity assets.
+ */
+export type AssetBorrowStatus = typeof AssetBorrowStatus[keyof typeof AssetBorrowStatus];
+export declare const AssetBorrowStatus: {
+    readonly easy_to_borrow: "easy_to_borrow";
+    readonly hard_to_borrow: "hard_to_borrow";
+};

package/dist/generated/broker/model/assetClass.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
+ */
+/**
+ * This represents the category to which the asset belongs to. It serves to identify the nature of the financial instrument, with options including "us_equity" for U.S. equities, "us_option" for U.S. options, "crypto" for cryptocurrencies, and "ipo" for IPO indications of interest. This `asset_class: ipo` value is distinct from the assets API `attributes: ["ipo"]` flag.
+ */
+export type AssetClass = typeof AssetClass[keyof typeof AssetClass];
+export declare const AssetClass: {
+    readonly us_equity: "us_equity";
+    readonly us_option: "us_option";
+    readonly crypto: "crypto";
+    readonly ipo: "ipo";
+};

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

@@ -0,0 +1,12 @@
+/**
+ * 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 { AssetClassParameterItem } from './assetClassParameterItem.js';
+/**
+ * A comma-separated list of asset classes, the response will include only orders in the specified asset classes. By specifying `us_option` as the class, you can query option orders by underlying symbol using the symbols parameter.
+ */
+export type AssetClassParameter = AssetClassParameterItem[];

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

@@ -0,0 +1,14 @@
+/**
+ * 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 AssetClassParameterItem = typeof AssetClassParameterItem[keyof typeof AssetClassParameterItem];
+export declare const AssetClassParameterItem: {
+    readonly us_equity: "us_equity";
+    readonly us_option: "us_option";
+    readonly crypto: "crypto";
+    readonly all: "all";
+};

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

@@ -0,0 +1,28 @@
+/**
+ * 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
+ */
+/**
+ * Defines the necessary conditions that must be met to initiate a position for a specific asset
+ */
+export interface AssetEntryRequirements {
+    /**
+       * The percentage of the asset's market value required as Day Trading (4x) buying power to open a long position
+       * @deprecated
+       */
+    dtbp_long?: string;
+    /**
+       * The percentage of the asset's market value required as Day Trading (4x) buying power to open a short position
+       * @deprecated
+       */
+    dtbp_short?: string;
+    /** The percentage of the asset's market value required as Reg T (2x) buying power to open a long position */
+    regt_long?: string;
+    /** The percentage of the asset's market value required as Reg T (2x) buying power to open a short position */
+    regt_short?: string;
+    /** The symbol (or asset id) of the requested asset */
+    symbol: string;
+}

package/dist/generated/broker/model/assetStatus.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
+ */
+/**
+ * active or inactive
+ */
+export type AssetStatus = typeof AssetStatus[keyof typeof AssetStatus];
+export declare const AssetStatus: {
+    readonly active: "active";
+    readonly inactive: "inactive";
+};

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

@@ -0,0 +1,26 @@
+/**
+ * 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 AuthorizeOAuthTokenResponse {
+    /**
+       * OAuth `client_id`
+       * @minLength 1
+       */
+    client_id: string;
+    /**
+       * OAuth code to exchange with token
+       * @minLength 1
+       */
+    code: string;
+    /**
+       * Redirect URI of OAuth flow
+       * @minLength 1
+       */
+    redirect_uri: string;
+    /** Granted scopes */
+    scope: string;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * 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 { Error } from './error.js';
+/**
+ * Malformed input.
+ */
+export type BadRequestResponse = Error;

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

@@ -0,0 +1,38 @@
+/**
+ * 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 { BankAdditionalFields } from './bankAdditionalFields.js';
+import type { BankBankCodeType } from './bankBankCodeType.js';
+import type { BankStatus } from './bankStatus.js';
+export interface Bank {
+    account_id?: string;
+    account_number: string;
+    /** 9-Digit ABA RTN (Routing Number) or BIC */
+    bank_code: string;
+    /** ABA (Domestic) or BIC (International) */
+    bank_code_type: BankBankCodeType;
+    /** Only for international banks */
+    city?: string;
+    /** Only for international banks */
+    country?: string;
+    /** Format: 2020-01-01T01:01:01Z */
+    created_at: string;
+    extra_fields?: BankAdditionalFields;
+    id: string;
+    /** Name of recipient bank */
+    name: string;
+    /** Only for international banks */
+    postal_code?: string;
+    /** Only for international banks */
+    state_province?: string;
+    /** QUEUED, SENT_TO_CLEARING, APPROVED, REJECTED, CANCELED */
+    status?: BankStatus;
+    /** Only for international banks */
+    street_address?: string;
+    /** Format: 2020-01-01T01:01:01Z */
+    updated_at: string;
+}

package/dist/generated/broker/model/bankAdditionalFields.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
+ */
+/**
+ * Additional wire instructions used to explicitly specify intermediary (correspondent) banks for international wire transfers. If omitted, intermediary banks may be automatically selected by downstream institutions, which can result in delays or additional charges.
+ */
+export interface BankAdditionalFields {
+    /** The primary intermediary (correspondent) bank to be used when routing the international wire transfer to the beneficiary bank. */
+    intermediary_bank1_bic?: string;
+    /** An additional intermediary bank to be used if the wire transfer requires multiple correspondent banks before reaching the beneficiary bank. */
+    intermediary_bank2_bic?: string;
+    /** A tertiary intermediary bank used in complex international wire routes that require three correspondent banks prior to reaching the beneficiary bank. */
+    intermediary_bank3_bic?: string;
+}

package/dist/generated/broker/model/bankBankCodeType.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
+ */
+/**
+ * ABA (Domestic) or BIC (International)
+ */
+export type BankBankCodeType = typeof BankBankCodeType[keyof typeof BankBankCodeType];
+export declare const BankBankCodeType: {
+    readonly ABA: "ABA";
+    readonly BIC: "BIC";
+};

package/dist/generated/broker/model/bankStatus.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
+ */
+/**
+ * QUEUED, SENT_TO_CLEARING, APPROVED, REJECTED, CANCELED
+ */
+export type BankStatus = typeof BankStatus[keyof typeof BankStatus];
+export declare const BankStatus: {
+    readonly QUEUED: "QUEUED";
+    readonly SENT_TO_CLEARING: "SENT_TO_CLEARING";
+    readonly APPROVED: "APPROVED";
+    readonly REJECTED: "REJECTED";
+    readonly CANCELED: "CANCELED";
+};

package/dist/generated/broker/model/batchCreateFundingWalletRequest.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 BatchCreateFundingWalletRequest {
+    /** list of UUID account ids which will have funding wallets created */
+    account_ids?: string[];
+}

package/dist/generated/broker/model/batchCreateFundingWalletResponse.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
+ */
+import type { FundingWallet } from './fundingWallet.js';
+export interface BatchCreateFundingWalletResponse {
+    funding_wallets?: FundingWallet[];
+}

package/dist/generated/broker/model/batchJournalRequest.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
+ */
+import type { BatchJournalRequestEntriesItem } from './batchJournalRequestEntriesItem.js';
+import type { BatchJournalRequestEntryType } from './batchJournalRequestEntryType.js';
+/**
+ * Journals API allows you to move cash or securities from one account to another.
+ *
+ * This model represents the fields you can specify when creating a request of many Journals out of one account to many others at once.
+ */
+export interface BatchJournalRequest {
+    /** Journal description, gets returned in the response */
+    description?: string;
+    /**
+       * An array of objects describing which accounts you want to move funds into and how much to move into each account
+       * @minItems 1
+       */
+    entries: BatchJournalRequestEntriesItem[];
+    /** Only supports `JNLC` for now */
+    entry_type: BatchJournalRequestEntryType;
+    /** The account id that is the originator of the funds being moved. Most likely is your Sweep Firm Account */
+    from_account: string;
+}

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

@@ -0,0 +1,26 @@
+/**
+ * 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 BatchJournalRequestEntriesItem = {
+    /** Journal amount in USD */
+    amount: string;
+    /** Currency */
+    currency?: string;
+    /** Journal entry description, gets returned in the response */
+    description?: string;
+    /** The ID of the account that you want to journal funds into */
+    to_account: string;
+    /** Only valid for JNLC journals. Null for JNLS.max 255 characters */
+    transmitter_account_number?: string;
+    /** Only valid for JNLC journals. Null for JNLS.max 255 characters */
+    transmitter_address?: string;
+    /** Only valid for JNLC journals. Null for JNLS.max 255 characters */
+    transmitter_financial_institution?: string;
+    /** Only valid for JNLC journals. Null for JNLS. Max 255 characters. */
+    transmitter_name?: string;
+    transmitter_timestamp?: string;
+};

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

@@ -0,0 +1,14 @@
+/**
+ * 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
+ */
+/**
+ * Only supports `JNLC` for now
+ */
+export type BatchJournalRequestEntryType = typeof BatchJournalRequestEntryType[keyof typeof BatchJournalRequestEntryType];
+export declare const BatchJournalRequestEntryType: {
+    readonly JNLC: "JNLC";
+};