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

package/dist/generated/broker/model/iPOEventVerb.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 IPO event type. Determines the shape of `payload`.
+ */
+export type IPOEventVerb = typeof IPOEventVerb[keyof typeof IPOEventVerb];
+export declare const IPOEventVerb: {
+    readonly Allocation: "Allocation";
+    readonly Offering: "Offering";
+    readonly OfferingUpdate: "OfferingUpdate";
+    readonly Prospectus: "Prospectus";
+    readonly SixtyMinMail: "SixtyMinMail";
+    readonly OfferingCancellation: "OfferingCancellation";
+};

package/dist/generated/broker/model/iPOOffering.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
+ */
+import type { IPOOfferingAvailability } from './iPOOfferingAvailability.js';
+/**
+ * An IPO (Initial Public Offering) offering exposed via the IPO discovery REST API. Returned by `GET /v1/ipos` and `GET /v1/ipos/{offering_reference}`.
+ *
+ * Most IPO lifecycle changes (new offerings, prospectus availability, 60-minute mail, allocations, cancellations) are pushed in real time over the [IPO Events Stream](#operation/subscribeToIPOEventsSSE).
+ */
+export interface IPOOffering {
+    /** Anticipated total share count for the offering, when known. */
+    anticipated_shares?: number;
+    /**
+       * Whether the offering is currently accepting orders.
+       * - `available` - accepting new orders.
+       * - `not_available` - not yet open for orders.
+       * - `closed` - no longer accepting orders.
+       *
+       * Note: the IPO Events Stream uses a different casing for the analogous `payload.available_to_order` field on `Offering`/`OfferingUpdate` events (`Available`, `NotAvailable`, `Closed`).
+       */
+    availability: IPOOfferingAvailability;
+    /** CUSIP identifier of the offering. */
+    cusip_id?: string;
+    /** A longer human-readable description of the offering, when available. */
+    description?: string;
+    /** The unique offering identifier used across the IPO Events Stream and `/v1/ipos/{offering_reference}`. Note that this value is also used as the path parameter, where it is named `offering_reference`. */
+    ipo_reference: string;
+    /** URL to a small logo asset for the issuer. */
+    logo_small?: string;
+    /** Upper bound of the indicated price range. */
+    max_price: string;
+    /** Maximum allowed order amount. */
+    max_ticket_size?: string;
+    /** Lower bound of the indicated price range. */
+    min_price: string;
+    /** Minimum allowed order amount. */
+    min_ticket_size?: string;
+    /** The official name of the offering. */
+    name: string;
+    /** When `true`, the offering is in its 60-minute pricing window and is not accepting new orders. This mirrors the `SixtyMinMail` event on the IPO Events Stream. */
+    no_new_orders: boolean;
+    /** The type of offering. Currently always `IPO`. */
+    offering_type: string;
+    /** URL to the prospectus document. Mirrors the `prospectus_url` payload of the corresponding `Prospectus` event on the IPO Events Stream. */
+    prospectus_url?: string;
+    /** Anticipated settlement date. */
+    settlement_date?: string;
+    /** The ticker symbol that will be used once the security begins trading on the secondary market. */
+    ticker_symbol?: string;
+    /** Anticipated first trading date on the secondary market. */
+    trade_date?: string;
+    /** List of underwriter names participating in the offering. */
+    underwriters?: string[];
+    /** The minimum increment in which order quantities can be specified. */
+    unit_step_size?: string;
+}

package/dist/generated/broker/model/iPOOfferingAvailability.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
+ */
+/**
+ * Whether the offering is currently accepting orders.
+ * - `available` - accepting new orders.
+ * - `not_available` - not yet open for orders.
+ * - `closed` - no longer accepting orders.
+ *
+ * Note: the IPO Events Stream uses a different casing for the analogous `payload.available_to_order` field on `Offering`/`OfferingUpdate` events (`Available`, `NotAvailable`, `Closed`).
+ */
+export type IPOOfferingAvailability = typeof IPOOfferingAvailability[keyof typeof IPOOfferingAvailability];
+export declare const IPOOfferingAvailability: {
+    readonly available: "available";
+    readonly not_available: "not_available";
+    readonly closed: "closed";
+};

package/dist/generated/broker/model/iPOOfferingListResponse.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 { IPOOffering } from './iPOOffering.js';
+/**
+ * Wrapper response returned by `GET /v1/ipos`.
+ */
+export interface IPOOfferingListResponse {
+    /** The page of IPO offerings matching the query. */
+    data: IPOOffering[];
+    /**
+       * Opaque cursor for the next page of results. When `null`, there are no further pages. Pass this value back as the `page_token` query parameter to fetch the next page.
+       * @nullable
+       */
+    next_page_token: string | null;
+}

package/dist/generated/broker/model/iPOOfferingResponse.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
+ */
+import type { IPOOffering } from './iPOOffering.js';
+/**
+ * Wrapper response returned by `GET /v1/ipos/{offering_reference}`.
+ */
+export interface IPOOfferingResponse {
+    data: IPOOffering;
+}

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

@@ -0,0 +1,88 @@
+/**
+ * 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 { IdentityFundingSourceItem } from './identityFundingSourceItem.js';
+import type { IdentityInvestmentExperienceWithOptions } from './identityInvestmentExperienceWithOptions.js';
+import type { IdentityInvestmentExperienceWithStocks } from './identityInvestmentExperienceWithStocks.js';
+import type { IdentityInvestmentObjective } from './identityInvestmentObjective.js';
+import type { IdentityInvestmentTimeHorizon } from './identityInvestmentTimeHorizon.js';
+import type { IdentityLiquidityNeeds } from './identityLiquidityNeeds.js';
+import type { IdentityMaritalStatus } from './identityMaritalStatus.js';
+import type { IdentityRiskTolerance } from './identityRiskTolerance.js';
+import type { TaxIdType } from './taxIdType.js';
+/**
+ * Identity is the model to provide account owner's identity information.
+ */
+export interface Identity {
+    /** The upper bound of the user's annual income. */
+    annual_income_max?: number;
+    /** The lower bound of the user's annual income. */
+    annual_income_min?: number;
+    /** [ISO 3166-1 alpha-3](https://www.iso.org/iso-3166-country-codes.html). */
+    country_of_birth?: string;
+    /** [ISO 3166-1 alpha-3](https://www.iso.org/iso-3166-country-codes.html). */
+    country_of_citizenship?: string;
+    /** [ISO 3166-1 alpha-3](https://www.iso.org/iso-3166-country-codes.html). */
+    country_of_tax_residence: string;
+    /** The date of birth in "YYYY-MM-DD" format. */
+    date_of_birth: string;
+    /** Required if `visa_type` = B1 or B2 */
+    date_of_departure_from_usa?: string;
+    /** The last name (surname) of the user. */
+    family_name: string;
+    /** Can be one or more of the following: `employment_income`, `investments`, `inheritance`, `business_income`, `savings`, `family`. */
+    funding_source: IdentityFundingSourceItem[];
+    /** The first/given name of the user. */
+    given_name: string;
+    /** The user's level of expertise and familiarity with investing in Options. */
+    investment_experience_with_options?: IdentityInvestmentExperienceWithOptions;
+    /** The user's level of expertise and familiarity with investing in US Equities. */
+    investment_experience_with_stocks?: IdentityInvestmentExperienceWithStocks;
+    /**
+       * The user's investment objective. This field is deprecated. Please use the top level `investment_objective` field.
+       * @deprecated
+       */
+    investment_objective?: IdentityInvestmentObjective;
+    /**
+       * The expected period of time the user plan to invest to achieve his/her financial goal(s). This field is deprecated. Please use the top level `investment_time_horizon` field.
+       * @deprecated
+       */
+    investment_time_horizon?: IdentityInvestmentTimeHorizon;
+    /** The upper bound of the user's liquid net worth. */
+    liquid_net_worth_max?: number;
+    /** The lower bound of the user's liquid net worth. */
+    liquid_net_worth_min?: number;
+    /**
+       * The user's ability to quickly and easily convert all or part of their investments in this account to cash without significant loss in value. This field is deprecated. Please use the top level `liquidity_needs` field.
+       * @deprecated
+       */
+    liquidity_needs?: IdentityLiquidityNeeds;
+    /** The marital status of the user. */
+    marital_status?: IdentityMaritalStatus;
+    /** The middle name of the user. */
+    middle_name?: string;
+    /** The number of dependents the user has. */
+    number_of_dependents?: number;
+    /** Only used to collect permanent residence status in the USA. */
+    permanent_resident?: boolean;
+    /**
+       * The user's investment risk tolerance. This field is deprecated. Please use the top level `risk_tolerance` field.
+       * @deprecated
+       */
+    risk_tolerance?: IdentityRiskTolerance;
+    /** Required if tax_id_type is set. */
+    tax_id?: string;
+    tax_id_type: TaxIdType;
+    /** The upper bound of the user's total net worth. */
+    total_net_worth_max?: number;
+    /** The lower bound of the user's total net worth. */
+    total_net_worth_min?: number;
+    /** Required if `visa_type` is set. */
+    visa_expiration_date?: string;
+    /** Only used to collect visa types for users residing in the USA. */
+    visa_type?: string;
+}

package/dist/generated/broker/model/identityFundingSourceItem.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
+ */
+export type IdentityFundingSourceItem = typeof IdentityFundingSourceItem[keyof typeof IdentityFundingSourceItem];
+export declare const IdentityFundingSourceItem: {
+    readonly employment_income: "employment_income";
+    readonly investments: "investments";
+    readonly inheritance: "inheritance";
+    readonly business_income: "business_income";
+    readonly savings: "savings";
+    readonly family: "family";
+};

package/dist/generated/broker/model/identityInvestmentExperienceWithOptions.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 level of expertise and familiarity with investing in Options.
+ */
+export type IdentityInvestmentExperienceWithOptions = typeof IdentityInvestmentExperienceWithOptions[keyof typeof IdentityInvestmentExperienceWithOptions];
+export declare const IdentityInvestmentExperienceWithOptions: {
+    readonly none: "none";
+    readonly '1_to_5_years': "1_to_5_years";
+    readonly over_5_years: "over_5_years";
+};

package/dist/generated/broker/model/identityInvestmentExperienceWithStocks.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 level of expertise and familiarity with investing in US Equities.
+ */
+export type IdentityInvestmentExperienceWithStocks = typeof IdentityInvestmentExperienceWithStocks[keyof typeof IdentityInvestmentExperienceWithStocks];
+export declare const IdentityInvestmentExperienceWithStocks: {
+    readonly none: "none";
+    readonly '1_to_5_years': "1_to_5_years";
+    readonly over_5_years: "over_5_years";
+};

package/dist/generated/broker/model/identityInvestmentObjective.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 user's investment objective. This field is deprecated. Please use the top level `investment_objective` field.
+ * @deprecated
+ */
+export type IdentityInvestmentObjective = typeof IdentityInvestmentObjective[keyof typeof IdentityInvestmentObjective];
+export declare const IdentityInvestmentObjective: {
+    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/identityInvestmentTimeHorizon.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 expected period of time the user plan to invest to achieve his/her financial goal(s). This field is deprecated. Please use the top level `investment_time_horizon` field.
+ * @deprecated
+ */
+export type IdentityInvestmentTimeHorizon = typeof IdentityInvestmentTimeHorizon[keyof typeof IdentityInvestmentTimeHorizon];
+export declare const IdentityInvestmentTimeHorizon: {
+    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/identityLiquidityNeeds.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 ability to quickly and easily convert all or part of their investments in this account to cash without significant loss in value. This field is deprecated. Please use the top level `liquidity_needs` field.
+ * @deprecated
+ */
+export type IdentityLiquidityNeeds = typeof IdentityLiquidityNeeds[keyof typeof IdentityLiquidityNeeds];
+export declare const IdentityLiquidityNeeds: {
+    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/identityMaritalStatus.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 marital status of the user.
+ */
+export type IdentityMaritalStatus = typeof IdentityMaritalStatus[keyof typeof IdentityMaritalStatus];
+export declare const IdentityMaritalStatus: {
+    readonly SINGLE: "SINGLE";
+    readonly MARRIED: "MARRIED";
+    readonly DIVORCED: "DIVORCED";
+    readonly WIDOWED: "WIDOWED";
+};

package/dist/generated/broker/model/identityRiskTolerance.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 investment risk tolerance. This field is deprecated. Please use the top level `risk_tolerance` field.
+ * @deprecated
+ */
+export type IdentityRiskTolerance = typeof IdentityRiskTolerance[keyof typeof IdentityRiskTolerance];
+export declare const IdentityRiskTolerance: {
+    readonly conservative: "conservative";
+    readonly moderate: "moderate";
+    readonly significant_risk: "significant_risk";
+};