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

package/dist/generated/broker/model/forwardSplitActivityV2.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 { CommonSplitStockActivityV2 } from './commonSplitStockActivityV2.js';
+/**
+ * Forward stock split
+ */
+export type ForwardSplitActivityV2 = CommonSplitStockActivityV2 & {
+    /**
+       * When due bills related to the split are redeemed
+       * @minLength 1
+       */
+    due_bill_redemption_date?: string;
+    /**
+       * The ex_date for this corporate action
+       * @minLength 1
+       */
+    ex_date?: string;
+    /**
+       * The record_date for this corporate action
+       * @minLength 1
+       */
+    record_date?: string;
+    /** The symbol of the security being split */
+    symbol: string;
+};

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

@@ -0,0 +1,24 @@
+/**
+ * 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 { FundingDetailPaymentType } from './fundingDetailPaymentType.js';
+import type { FundingDetailRoutingCodeType } from './fundingDetailRoutingCodeType.js';
+/**
+ * Gets funding details that can be used to settle and collect funds in each available currency.
+ */
+export interface FundingDetail {
+    account_holder_name?: string;
+    account_number?: string;
+    account_number_type?: string;
+    bank_address?: string;
+    bank_country?: string;
+    bank_name?: string;
+    currency?: string;
+    payment_type?: FundingDetailPaymentType;
+    routing_code?: string;
+    routing_code_type?: FundingDetailRoutingCodeType;
+}

package/dist/generated/broker/model/fundingDetailPaymentType.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
+ */
+/**
+ * Status:
+ *  * `swift_wire`: SWIFT wire
+ *  * `local_rails`: Local scheme
+ */
+export type FundingDetailPaymentType = typeof FundingDetailPaymentType[keyof typeof FundingDetailPaymentType];
+export declare const FundingDetailPaymentType: {
+    readonly swift_wire: "swift_wire";
+    readonly local_rails: "local_rails";
+};

package/dist/generated/broker/model/fundingDetailRoutingCodeType.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
+ */
+/**
+ * Status:
+ *  * `BIC`: bic_swift
+ *  * `ACH`: ach_routing_code
+ *  * `ABA`: aba
+ *  * `ROUTING`: routing_code
+ *  * `SORT_CODE`: sort_code
+ */
+export type FundingDetailRoutingCodeType = typeof FundingDetailRoutingCodeType[keyof typeof FundingDetailRoutingCodeType];
+export declare const FundingDetailRoutingCodeType: {
+    readonly BIC: "BIC";
+    readonly ACH_ROUTING: "ACH_ROUTING";
+    readonly ABA: "ABA";
+    readonly ROUTING: "ROUTING";
+    readonly SORT_CODE: "SORT_CODE";
+};

package/dist/generated/broker/model/fundingWallet.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
+ */
+import type { FundingWalletStatus } from './fundingWalletStatus.js';
+export interface FundingWallet {
+    account_id: string;
+    created_at: string;
+    status: FundingWalletStatus;
+}

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

@@ -0,0 +1,40 @@
+/**
+ * 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 { FundingDetailPaymentType } from './fundingDetailPaymentType.js';
+export interface FundingWalletRecipientBank {
+    /** Bank account number. */
+    account_number?: string;
+    /** BIC/SWIFT code */
+    bic_swift?: string;
+    /** City */
+    city?: string;
+    company_name?: string;
+    /** Two-letter ISO country code. */
+    country?: string;
+    /** Date the beneficiary record was created. */
+    created_at?: string;
+    /** Currency in which money is held in the beneficiary's bank account. Three-digit currency code. */
+    currency?: string;
+    first_name?: string;
+    /** IBAN code */
+    iban?: string;
+    id?: string;
+    last_name?: string;
+    payment_types?: FundingDetailPaymentType[];
+    /** Postal code */
+    postal_code?: string;
+    /** Value for "routing_code_type". */
+    routing_code?: string;
+    /** Local payment routing system. */
+    routing_code_type?: string;
+    /** State or province. */
+    state_or_province?: string;
+    street_address?: string;
+    /** Date the beneficiary record was last updated. */
+    updated_at?: string;
+}

package/dist/generated/broker/model/fundingWalletStatus.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
+ */
+/**
+ * Status:
+ *  * `active`: The funding wallet is ready
+ *  * `pending`: The funding wallet is being processed
+ *  * `disabled`: The funding wallet is disabled
+ */
+export type FundingWalletStatus = typeof FundingWalletStatus[keyof typeof FundingWalletStatus];
+export declare const FundingWalletStatus: {
+    readonly active: "active";
+    readonly pending: "pending";
+    readonly disabled: "disabled";
+};

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

@@ -0,0 +1,29 @@
+/**
+ * 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 { FundingDetailPaymentType } from './fundingDetailPaymentType.js';
+import type { FundingWalletTransferDirection } from './fundingWalletTransferDirection.js';
+import type { FundingWalletTransferStatus } from './fundingWalletTransferStatus.js';
+import type { TransferFee } from './transferFee.js';
+import type { Usd } from './usd.js';
+export interface FundingWalletTransfer {
+    account_id?: string;
+    created_at?: string;
+    direction?: FundingWalletTransferDirection;
+    fees?: TransferFee[];
+    id?: string;
+    /** The amount you should expect to receive, calculated as requested amount - fees */
+    original_amount?: string;
+    /** The currency of the withdrawn amount, 3-letter ISO code */
+    original_currency?: string;
+    payment_type?: FundingDetailPaymentType;
+    /** The amount sent as part of the withdrawal creation */
+    requested_amount?: string;
+    status?: FundingWalletTransferStatus;
+    updated_at?: string;
+    usd?: Usd;
+}

package/dist/generated/broker/model/fundingWalletTransferDirection.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
+ */
+/**
+ * Status:
+ *  * `incoming`: incoming amount
+ *  * `outgoing`: outgoing amount
+ */
+export type FundingWalletTransferDirection = typeof FundingWalletTransferDirection[keyof typeof FundingWalletTransferDirection];
+export declare const FundingWalletTransferDirection: {
+    readonly incoming: "incoming";
+    readonly outgoing: "outgoing";
+};

package/dist/generated/broker/model/fundingWalletTransferStatus.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
+ */
+/**
+ * Status:
+ *  * `PENDING`: Created and waiting to be processed
+ *  * `CANCELED`: Canceled
+ *  * `FAILED`: Failed mostly due to technical reasons
+ *  * `COMPLETE`: Transfer has settled
+ */
+export type FundingWalletTransferStatus = typeof FundingWalletTransferStatus[keyof typeof FundingWalletTransferStatus];
+export declare const FundingWalletTransferStatus: {
+    readonly PENDING: "PENDING";
+    readonly CANCELED: "CANCELED";
+    readonly EXECUTED: "EXECUTED";
+    readonly FAILED: "FAILED";
+    readonly COMPLETE: "COMPLETE";
+};

package/dist/generated/broker/model/getAccountACHRelationshipsParams.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 type GetAccountACHRelationshipsParams = {
+    /**
+     * Comma-separated status values
+     */
+    statuses?: string;
+};

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

@@ -0,0 +1,40 @@
+/**
+ * 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 { DirectionParameter } from './directionParameter.js';
+export type GetAccountActivitiesByTypeParams = {
+    /**
+     * id of a single account to filter by
+     */
+    account_id?: string;
+    /**
+     * Filter activities by their creation date (created_at), not the activity's settlement date. For non-trade activities such as fees, the creation date is typically the day after the trade date (in UTC). Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ are supported.
+     */
+    date?: string;
+    /**
+     * Get activities created before this date. Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ are supported.
+     */
+    until?: string;
+    /**
+     * Get activities created after this date. Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ are supported.
+     */
+    after?: string;
+    /**
+     * The chronological order of response based on the submission time. asc or desc. Defaults to desc.
+     */
+    direction?: DirectionParameter;
+    /**
+     * The maximum number of entries to return in the response.
+     * @minimum 1
+     * @maximum 100
+     */
+    page_size?: number;
+    /**
+     * Token used for pagination. Provide the ID of the last activity from the last page to retrieve the next set of results.
+     */
+    page_token?: string;
+};

package/dist/generated/broker/model/getAccountActivitiesCategory.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
+ */
+export type GetAccountActivitiesCategory = typeof GetAccountActivitiesCategory[keyof typeof GetAccountActivitiesCategory];
+export declare const GetAccountActivitiesCategory: {
+    readonly trade_activity: "trade_activity";
+    readonly non_trade_activity: "non_trade_activity";
+};

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

@@ -0,0 +1,50 @@
+/**
+ * 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 { DirectionParameter } from './directionParameter.js';
+import type { GetAccountActivitiesCategory } from './getAccountActivitiesCategory.js';
+export type GetAccountActivitiesParams = {
+    /**
+     * id of a single account to filter by
+     */
+    account_id?: string;
+    /**
+     * A comma-separated list of activity types used to filter the results.
+     */
+    activity_types?: ActivityType[];
+    /**
+     * The activity category. Cannot be used with "activity_types" parameter.
+     */
+    category?: GetAccountActivitiesCategory;
+    /**
+     * Filter activities by their creation date (created_at), not the activity's settlement date. For non-trade activities such as fees, the creation date is typically the day after the trade date (in UTC). Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ are supported.
+     */
+    date?: string;
+    /**
+     * Get activities created before this date. Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ are supported.
+     */
+    until?: string;
+    /**
+     * Get activities created after this date. Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ are supported.
+     */
+    after?: string;
+    /**
+     * The chronological order of response based on the submission time. asc or desc. Defaults to desc.
+     */
+    direction?: DirectionParameter;
+    /**
+     * The maximum number of entries to return in the response.
+     * @minimum 1
+     * @maximum 100
+     */
+    page_size?: number;
+    /**
+     * Token used for pagination. Provide the ID of the last activity from the last page to retrieve the next set of results.
+     */
+    page_token?: string;
+};

package/dist/generated/broker/model/getAllAccountsEntities.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 GetAllAccountsEntities = typeof GetAllAccountsEntities[keyof typeof GetAllAccountsEntities];
+export declare const GetAllAccountsEntities: {
+    readonly agreements: "agreements";
+    readonly contact: "contact";
+    readonly disclosures: "disclosures";
+    readonly documents: "documents";
+    readonly identity: "identity";
+    readonly trading_configurations: "trading_configurations";
+    readonly trusted_contact: "trusted_contact";
+};

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

@@ -0,0 +1,35 @@
+/**
+ * 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 { GetAllAccountsEntities } from './getAllAccountsEntities.js';
+import type { SortParameter } from './sortParameter.js';
+export type GetAllAccountsParams = {
+    /**
+     * A space-delimited list of tokens. The response will contain accounts that match with all of the tokens (i.e. a logical AND). A match means the token is present in either the account's associated account number, phone number, name, or e-mail address (logical OR).
+     */
+    query?: string;
+    /**
+     * Inclusive of timestamp. Example: 2019-10-12T07:20:50.52Z
+     */
+    created_after?: string;
+    /**
+     * Inclusive of timestamp. Example: 2019-10-12T07:20:50.52Z
+     */
+    created_before?: string;
+    /**
+     * See the AccountStatus model for values
+     */
+    status?: string;
+    /**
+     * The chronological order of response based on the submission time. asc or desc. Defaults to desc.
+     */
+    sort?: SortParameter;
+    /**
+     * Comma-delimited entity names to include in the response. If not specified, all entities are included.
+     */
+    entities?: GetAllAccountsEntities;
+};

package/dist/generated/broker/model/getAllJournalsEntryType.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
+ */
+export type GetAllJournalsEntryType = typeof GetAllJournalsEntryType[keyof typeof GetAllJournalsEntryType];
+export declare const GetAllJournalsEntryType: {
+    readonly JNLC: "JNLC";
+    readonly JNLS: "JNLS";
+};

package/dist/generated/broker/model/getAllJournalsParams.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
+ */
+import type { GetAllJournalsEntryType } from './getAllJournalsEntryType.js';
+import type { GetAllJournalsStatus } from './getAllJournalsStatus.js';
+export type GetAllJournalsParams = {
+    /**
+     * By journal creation date. Format: 2020-01-01
+     */
+    after?: string;
+    /**
+     * By journal creation date. Format: 2020-01-01
+     */
+    before?: string;
+    /**
+     * See the JournalStatus model for more info
+     */
+    status?: GetAllJournalsStatus;
+    /**
+     * JNLC or JNLS
+     */
+    entry_type?: GetAllJournalsEntryType;
+    /**
+     * The account id that received the journal
+     */
+    to_account?: string;
+    /**
+     * The account id that initiated the journal
+     */
+    from_account?: string;
+    /**
+     * The maximum number of results to return
+     */
+    limit?: number;
+};

package/dist/generated/broker/model/getAllJournalsStatus.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 type GetAllJournalsStatus = typeof GetAllJournalsStatus[keyof typeof GetAllJournalsStatus];
+export declare const GetAllJournalsStatus: {
+    readonly pending: "pending";
+    readonly canceled: "canceled";
+    readonly executed: "executed";
+    readonly queued: "queued";
+    readonly rejected: "rejected";
+    readonly deleted: "deleted";
+    readonly refused: "refused";
+    readonly sent_to_clearing: "sent_to_clearing";
+    readonly correct: "correct";
+};

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

@@ -0,0 +1,50 @@
+/**
+ * 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 { AfterParameter } from './afterParameter.js';
+import type { AssetClassParameter } from './assetClassParameter.js';
+import type { DirectionParameter } from './directionParameter.js';
+import type { GetAllOrdersForAccountStatus } from './getAllOrdersForAccountStatus.js';
+import type { SymbolsParameter } from './symbolsParameter.js';
+import type { UntilParameter } from './untilParameter.js';
+export type GetAllOrdersForAccountParams = {
+    /**
+     * Order status to be queried. open, closed or all. Defaults to open.
+     */
+    status?: GetAllOrdersForAccountStatus;
+    /**
+     * The maximum number of orders in response. Defaults to 50 and max is 500.
+     */
+    limit?: number;
+    /**
+     * 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.
+     */
+    asset_class?: AssetClassParameter;
+    /**
+     * The response will include only ones submitted after this timestamp (exclusive)
+     */
+    after?: AfterParameter;
+    /**
+     * The response will include only ones submitted until this timestamp (exclusive)
+     */
+    until?: UntilParameter;
+    /**
+     * The chronological order of response based on the submission time. asc or desc. Defaults to desc.
+     */
+    direction?: DirectionParameter;
+    /**
+     * If true, the result will roll up multi-leg orders under the legs field of primary order.
+     */
+    nested?: boolean;
+    /**
+     * A comma-separated list of symbols to filter by.
+     */
+    symbols?: SymbolsParameter;
+    qty_above?: string;
+    qty_below?: string;
+    subtag?: string;
+};

package/dist/generated/broker/model/getAllOrdersForAccountStatus.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 type GetAllOrdersForAccountStatus = typeof GetAllOrdersForAccountStatus[keyof typeof GetAllOrdersForAccountStatus];
+export declare const GetAllOrdersForAccountStatus: {
+    readonly open: "open";
+    readonly closed: "closed";
+    readonly all: "all";
+};

package/dist/generated/broker/model/getAssetEntryRequirementsParams.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 type GetAssetEntryRequirementsParams = {
+    /**
+     * Comma-separated symbols or asset ids. The symbols (or asset ids) for which asset entry requirements are to be requested. Maximum number of symbols allowed is 500.
+     */
+    symbols: string;
+};

package/dist/generated/broker/model/getAssetsAssetClass.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
+ */
+export type GetAssetsAssetClass = typeof GetAssetsAssetClass[keyof typeof GetAssetsAssetClass];
+export declare const GetAssetsAssetClass: {
+    readonly us_equity: "us_equity";
+    readonly crypto: "crypto";
+};

package/dist/generated/broker/model/getAssetsAttributesItem.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 GetAssetsAttributesItem = typeof GetAssetsAttributesItem[keyof typeof GetAssetsAttributesItem];
+export declare const GetAssetsAttributesItem: {
+    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/getAssetsParams.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { GetAssetsAssetClass } from './getAssetsAssetClass.js';
+import type { GetAssetsAttributesItem } from './getAssetsAttributesItem.js';
+import type { GetAssetsStatus } from './getAssetsStatus.js';
+export type GetAssetsParams = {
+    /**
+     * Asset status to filter by, will default to `all`
+     */
+    status?: GetAssetsStatus;
+    /**
+     * Asset class to filter by, `us_equity` or `crypto`. Defaults to `us_equity`
+     */
+    asset_class?: GetAssetsAssetClass;
+    /**
+     * Comma separated values to query for more than one attribute. Assets which have any of the given attributes will be included.
+     *
+     * 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?: GetAssetsAttributesItem[];
+};

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