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

package/dist/generated/trading/model/commonJournalActivityV2.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { CommonNTAActivityV2 } from './commonNTAActivityV2.js';
+export type CommonJournalActivityV2 = CommonNTAActivityV2 & {
+    /** The journal's ID */
+    journal_id?: string;
+};

package/dist/generated/trading/model/commonMAActivityV2.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export interface CommonMAActivityV2 {
+    /** CUSIP of the acquiree */
+    acquiree_cusip: string;
+    /** Rate of the acquiree */
+    acquiree_rate?: string;
+    /** Symbol of the acquiree */
+    acquiree_symbol: string;
+    /** CUSIP of the acquirer */
+    acquirer_cusip?: string;
+    /** Rate of the acquirer */
+    acquirer_rate?: string;
+    /** Symbol of the acquirer */
+    acquirer_symbol?: string;
+    /**
+       * When the merger/acquisition becomes effective
+       * @minLength 1
+       */
+    effective_date: string;
+    /**
+       * The payable date
+       * @minLength 1
+       */
+    payable_date: string;
+}

package/dist/generated/trading/model/commonNCActivityV2.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export interface CommonNCActivityV2 {
+    /** New CUSIP for the name change */
+    new_cusip: string;
+    /** New symbol for the name change */
+    new_symbol: string;
+    /** Old CUSIP for the name change */
+    old_cusip: string;
+    /** Old symbol for the name change */
+    old_symbol: string;
+}

package/dist/generated/trading/model/commonNTAActivityV2.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export interface CommonNTAActivityV2 {
+    /** Optional group ID which can help grouping together related activities */
+    group_id?: string;
+    /**
+       * The date when the activity was booked
+       * @minLength 1
+       */
+    system_date: string;
+}

package/dist/generated/trading/model/commonOPCAActivityV2.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { CommonCaActivityV2 } from './commonCaActivityV2.js';
+export type CommonOPCAActivityV2 = CommonCaActivityV2 & {
+    /** The new contract symbol */
+    new_contract_symbol: string;
+    /** used when the old contract's quantity is not equal to the new contract's quantity. Mutually exclusive with 'qty'. */
+    new_qty?: string;
+    /** The old contract symbol */
+    old_contract_symbol: string;
+    /** used when the old contract's quantity is not equal to the new contract's quantity. Mutually exclusive with 'qty'. */
+    old_qty?: string;
+    /** used when the old contract's quantity is equal to the new contract's quantity. Mutually exclusive with 'old_qty' and 'new_qty' */
+    qty?: string;
+};

package/dist/generated/trading/model/commonOptionsActivityV2.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { CommonNTAActivityV2 } from './commonNTAActivityV2.js';
+export type CommonOptionsActivityV2 = CommonNTAActivityV2 & Required<Pick<CommonNTAActivityV2, 'group_id'>>;

package/dist/generated/trading/model/commonSDIVActivityV2.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export interface CommonSDIVActivityV2 {
+    /** The CUSIP of the security involved with the activity */
+    cusip: string;
+    /**
+       * The ex_date for this corporate action
+       * @minLength 1
+       */
+    ex_date?: string;
+    /**
+       * The payable_date for this corporate action
+       * @minLength 1
+       */
+    payable_date?: string;
+    /** Dividend rate per share */
+    rate: string;
+    /**
+       * The record_date for this corporate action
+       * @minLength 1
+       */
+    record_date?: string;
+    /** The symbol of the security involved with the activity */
+    symbol: string;
+}

package/dist/generated/trading/model/commonSpinoffActivityV2.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export interface CommonSpinoffActivityV2 {
+    /**
+       * When due bills related to the spinoff are redeemed
+       * @minLength 1
+       */
+    due_bill_redemption_date?: string;
+    /**
+       * The ex_date for this corporate action
+       * @minLength 1
+       */
+    ex_date?: string;
+    /** CUSIP of the new security */
+    new_cusip: string;
+    /** Market price of new shares after the spinoff */
+    new_price: string;
+    /** Ratio of new shares received */
+    new_rate: string;
+    /** Symbol of the new security */
+    new_symbol: string;
+    /**
+       * The payable_date for this corporate action
+       * @minLength 1
+       */
+    payable_date?: string;
+    /**
+       * The record_date for this corporate action
+       * @minLength 1
+       */
+    record_date?: string;
+    /** CUSIP of the parent security */
+    source_cusip: string;
+    /** Market price of parent shares before the spinoff */
+    source_price: string;
+    /** Ratio of parent shares */
+    source_rate: string;
+    /** Symbol of the parent security */
+    source_symbol: string;
+}

package/dist/generated/trading/model/commonSplitActivityV2.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export interface CommonSplitActivityV2 {
+    /** CUSIP of the new security after the split */
+    new_cusip: string;
+    /** Ratio of new shares received */
+    new_rate: string;
+    /** CUSIP of the old security before the split */
+    old_cusip: string;
+    /** Ratio of old shares exchanged */
+    old_rate: string;
+    /**
+       * The payable_date for this corporate action
+       * @minLength 1
+       */
+    payable_date?: string;
+}

package/dist/generated/trading/model/commonSplitStockActivityV2.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { CommonCaActivityV2 } from './commonCaActivityV2.js';
+import type { CommonSplitActivityV2 } from './commonSplitActivityV2.js';
+export type CommonSplitStockActivityV2 = CommonCaActivityV2 & CommonSplitActivityV2 & {
+    /** The new quantity after the split */
+    new_qty: string;
+    /** The old quantity before the split */
+    old_qty: string;
+};

package/dist/generated/trading/model/commonVOFSubtypeActivityV2.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export interface CommonVOFSubtypeActivityV2 {
+    /** CUSIP of the new security */
+    new_cusip?: string;
+    /** Symbol of the new security */
+    new_symbol?: string;
+    /** CUSIP of the parent security */
+    source_cusip: string;
+    /** Symbol of the parent security */
+    source_symbol: string;
+}

package/dist/generated/trading/model/couponFrequency.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * How often the coupon is paid
+ */
+export type CouponFrequency = typeof CouponFrequency[keyof typeof CouponFrequency];
+export declare const CouponFrequency: {
+    readonly annual: "annual";
+    readonly semi_annual: "semi_annual";
+    readonly quarterly: "quarterly";
+    readonly monthly: "monthly";
+    readonly zero: "zero";
+};

package/dist/generated/trading/model/couponType.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * The type of the coupon rate
+ */
+export type CouponType = typeof CouponType[keyof typeof CouponType];
+export declare const CouponType: {
+    readonly fixed: "fixed";
+    readonly floating: "floating";
+    readonly zero: "zero";
+};

package/dist/generated/trading/model/createCryptoTransferRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { CreateCryptoTransferRequestChain } from './createCryptoTransferRequestChain.js';
+export interface CreateCryptoTransferRequest {
+    /** The destination wallet address */
+    address: string;
+    /** The amount, denoted in the specified asset, to be withdrawn from the user's wallet */
+    amount: string;
+    /** The crypto asset symbol, e.g. BTC, ETH, USDT. */
+    asset: string;
+    /** Optional chain identifier. The blockchain network used for the withdrawal. */
+    chain?: CreateCryptoTransferRequestChain;
+}

package/dist/generated/trading/model/createCryptoTransferRequestChain.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * Optional chain identifier. The blockchain network used for the withdrawal.
+ */
+export type CreateCryptoTransferRequestChain = typeof CreateCryptoTransferRequestChain[keyof typeof CreateCryptoTransferRequestChain];
+export declare const CreateCryptoTransferRequestChain: {
+    readonly SOL: "SOL";
+    readonly ETH: "ETH";
+    readonly BTC: "BTC";
+    readonly XRP: "XRP";
+    readonly ARB: "ARB";
+};

package/dist/generated/trading/model/createWhitelistedAddressBody.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { CreateWhitelistedAddressBodyChain } from './createWhitelistedAddressBodyChain.js';
+export type CreateWhitelistedAddressBody = {
+    /** The address to be whitelisted */
+    address?: string;
+    /** Symbol of underlying asset for the whitelisted address */
+    asset?: string;
+    /** Optional chain identifier. Use when the underlying asset for the whitelisted address is a multi-chain crypto asset. */
+    chain?: CreateWhitelistedAddressBodyChain;
+};

package/dist/generated/trading/model/createWhitelistedAddressBodyChain.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * Optional chain identifier. Use when the underlying asset for the whitelisted address is a multi-chain crypto asset.
+ */
+export type CreateWhitelistedAddressBodyChain = typeof CreateWhitelistedAddressBodyChain[keyof typeof CreateWhitelistedAddressBodyChain];
+export declare const CreateWhitelistedAddressBodyChain: {
+    readonly SOL: "SOL";
+    readonly ETH: "ETH";
+    readonly BTC: "BTC";
+    readonly XRP: "XRP";
+    readonly ARB: "ARB";
+};

package/dist/generated/trading/model/createWhitelistedPerpAddressBody.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export type CreateWhitelistedPerpAddressBody = {
+    /** The address to be whitelisted */
+    address?: string;
+    /** Symbol of underlying asset for the whitelisted address */
+    asset?: string;
+};

package/dist/generated/trading/model/cryptoTransfer.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { CryptoTransferStatus } from './cryptoTransferStatus.js';
+import type { TransferDirection } from './transferDirection.js';
+/**
+ * Transfers allow you to transfer assets into your end customer's account (deposits) or out (withdrawal).
+ */
+export interface CryptoTransfer {
+    /** Amount of transfer denominated in the underlying crypto asset */
+    amount?: string;
+    /** Symbol of crypto asset for given transfer (e.g. BTC) */
+    asset?: string;
+    /** Underlying network for given transfer */
+    chain?: string;
+    /** Timestamp when transfer was created */
+    created_at?: string;
+    direction?: TransferDirection;
+    fees?: string;
+    /** Originating address of the transfer */
+    from_address?: string;
+    /** The crypto transfer ID */
+    id?: string;
+    network_fee?: string;
+    status?: CryptoTransferStatus;
+    /** Destination address of the transfer */
+    to_address?: string;
+    /** On-chain transaction hash (e.g. 0xabc...xyz) */
+    tx_hash?: string;
+    /** Equivalent USD value at time of transfer */
+    usd_value?: string;
+}

package/dist/generated/trading/model/cryptoTransferStatus.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export type CryptoTransferStatus = typeof CryptoTransferStatus[keyof typeof CryptoTransferStatus];
+export declare const CryptoTransferStatus: {
+    readonly PROCESSING: "PROCESSING";
+    readonly FAILED: "FAILED";
+    readonly COMPLETE: "COMPLETE";
+};

package/dist/generated/trading/model/cryptoWallet.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export interface CryptoWallet {
+    address?: string;
+    chain?: string;
+    /** Timestamp (RFC3339) of account creation. */
+    created_at?: string;
+}

package/dist/generated/trading/model/dIVNRAActivityV2.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { CommonNTAActivityV2 } from './commonNTAActivityV2.js';
+/**
+ * Dividend withholding for non resident aliens
+ */
+export type DIVNRAActivityV2 = CommonNTAActivityV2 & {
+    /** The CUSIP of the security involved with the activity */
+    cusip: string;
+    /** The ref_id of the parent dividend */
+    parent_id: string;
+    /** The symbol of the security involved with the activity */
+    symbol: string;
+};

package/dist/generated/trading/model/dIVSPDActivityV2.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { CommonCaActivityV2 } from './commonCaActivityV2.js';
+/**
+ * Substitute payment in lieu of dividend
+ */
+export type DIVSPDActivityV2 = CommonCaActivityV2 & {
+    /** Total cash amount paid */
+    cash_payout: string;
+    /** The CUSIP of the security involved with the activity */
+    cusip: string;
+    /**
+       * When due bills stop applying for this event
+       * @minLength 1
+       */
+    due_bill_off_date?: string;
+    /**
+       * When due bills begin to apply for this event
+       * @minLength 1
+       */
+    due_bill_on_date?: string;
+    /** Quantity of shares entitled to receive cash in lieu */
+    entitled_qty: string;
+    /**
+       * The ex_date for this corporate action
+       * @minLength 1
+       */
+    ex_date?: string;
+    /** Indicates if related to a non-US security */
+    foreign: boolean;
+    /**
+       * The payable_date for this corporate action
+       * @minLength 1
+       */
+    payable_date?: string;
+    /** Cash payout per share */
+    rate: string;
+    /**
+       * The record_date for this corporate action
+       * @minLength 1
+       */
+    record_date?: string;
+    /** Indicates if this is a special dividend */
+    special: boolean;
+    /** The symbol of the security involved with the activity */
+    symbol: string;
+};

package/dist/generated/trading/model/dayCount.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * The day count convention used to calculate accrued interest.
+ *
+ * - `A/360`: calculates the daily interest using a 360-day year and then multiplies that by the actual number of days in each time period.
+ * - `A/365`: calculates the daily interest using a 365-day year and then multiplies that by the actual number of days in each time period.
+ * - `30/360`: calculates the daily interest using a 360-day year and then multiplies that by 30 (standardized month).
+ * - `30/365`: calculates the daily interest using a 365-day year and then multiplies that by 30 (standardized month).
+ * - `A/A`: calculates the daily interest using the actual number of days in the year and then multiplies that by the actual number of days in each time period.
+ * - `30E/360`: number of days equals to the actual number of days (for February). If the start date or the end date of the period is the 31st of a month, that date is set to the 30th. The number of days in a year is 360.
+ * - `B/252`: calculates the daily interest using a 252-business-day year and then multiplies that by the actual number of days in each time period.
+ * - `A/364`: calculates the daily interest using a 364-day year and then multiplies that by the actual number of days in each time period.
+ */
+export type DayCount = typeof DayCount[keyof typeof DayCount];
+export declare const DayCount: {
+    readonly 'A/360': "A/360";
+    readonly 'A/365': "A/365";
+    readonly '30/360': "30/360";
+    readonly '30/365': "30/365";
+    readonly 'A/A': "A/A";
+    readonly '30E/360': "30E/360";
+    readonly 'B/252': "B/252";
+    readonly 'A/364': "A/364";
+};

package/dist/generated/trading/model/deleteAllOpenPositionsParams.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export type DeleteAllOpenPositionsParams = {
+    /**
+     * If true is specified, cancel all open orders before liquidating all positions.
+     */
+    cancel_orders?: boolean;
+};

package/dist/generated/trading/model/deleteOpenPositionParams.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export type DeleteOpenPositionParams = {
+    /**
+     * the number of shares to liquidate. Can accept up to 9 decimal points. Cannot work with percentage
+     */
+    qty?: number;
+    /**
+     * percentage of position to liquidate. Must be between 0 and 100. Would only sell fractional if position is originally fractional. Can accept up to 9 decimal points. Cannot work with qty
+     */
+    percentage?: number;
+};

package/dist/generated/trading/model/deleteWatchlistByNameParams.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export type DeleteWatchlistByNameParams = {
+    /**
+     * name of the watchlist
+     */
+    name: string;
+};

package/dist/generated/trading/model/endParameter.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * The last date to retrieve data for (inclusive). Default: one week from the start date.
+ */
+export type EndParameter = string;

package/dist/generated/trading/model/error.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export interface Error {
+    code: number;
+    message: string;
+}

package/dist/generated/trading/model/exchange.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * Represents the current exchanges Alpaca supports. List is currently:
+ *
+ * - AMEX
+ * - ARCA
+ * - BATS
+ * - NYSE
+ * - NASDAQ
+ * - NYSEARCA
+ * - OTC
+ */
+export type Exchange = typeof Exchange[keyof typeof Exchange];
+export declare const Exchange: {
+    readonly AMEX: "AMEX";
+    readonly ARCA: "ARCA";
+    readonly BATS: "BATS";
+    readonly NYSE: "NYSE";
+    readonly NASDAQ: "NASDAQ";
+    readonly NYSEARCA: "NYSEARCA";
+    readonly OTC: "OTC";
+};