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

package/dist/generated/data/model/stockTradesParams.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Market Data API
+ * Access real-time and historical market data for US equities, options, crypto, and foreign exchange data through the Alpaca REST and WebSocket APIs. There are APIs for Stock Pricing, Option Pricing, Crypto Pricing, Forex, Logos, Fixed income, Corporate Actions, Screener, and News.
+ *
+ * OpenAPI spec version: 1.1
+ */
+import type { EndParameter } from './endParameter.js';
+import type { LimitParameter } from './limitParameter.js';
+import type { PageTokenParameter } from './pageTokenParameter.js';
+import type { SortParameter } from './sortParameter.js';
+import type { StartParameter } from './startParameter.js';
+import type { StockAsofParameter } from './stockAsofParameter.js';
+import type { StockCurrencyParameter } from './stockCurrencyParameter.js';
+import type { StockHistoricalFeedParameter } from './stockHistoricalFeedParameter.js';
+import type { StockSymbolsParameter } from './stockSymbolsParameter.js';
+export type StockTradesParams = {
+    /**
+     * A comma-separated list of stock symbols.
+     */
+    symbols: StockSymbolsParameter;
+    /**
+     * The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD.
+     * Default: the beginning of the current day, but at least 15 minutes ago if the user doesn't have real-time access for the feed.
+     */
+    start?: StartParameter;
+    /**
+     * The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD.
+     * Default: the current time if the user has a real-time access for the feed, otherwise 15 minutes before the current time.
+     */
+    end?: EndParameter;
+    /**
+     * The maximum number of data points to return in the response page.
+     * The API may return less, even if there are more available data points in the requested interval.
+     * Always check the `next_page_token` for more pages.
+     * The limit applies to the total number of data points, not per symbol!
+     * @minimum 1
+     * @maximum 10000
+     */
+    limit?: LimitParameter;
+    /**
+     * The as-of date of the queried stock symbol(s). Format: YYYY-MM-DD. Default: current day.
+     *
+     * This date is used to identify the underlying entity of the provided symbol(s), so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change.
+     *
+     * The special value of "-" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given `asof` date.
+     *
+     * Example: FB was renamed to META in 2022-06-09. Querying META with an `asof` date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an `asof` date after 2022-06-09 will only return data with the FB ticker, not with META. But with an `asof` date before 2022-06-09, META will also be returned (as FB).
+     */
+    asof?: StockAsofParameter;
+    /**
+     * The source feed of the data.
+     *  - `sip`: all US exchanges
+     *  - `iex`: Investors EXchange
+     *  - `boats`: Blue Ocean ATS, overnight US trading data
+     *  - `otc`: over-the-counter exchanges
+     */
+    feed?: StockHistoricalFeedParameter;
+    /**
+     * The currency of all prices in ISO 4217 format. Default: USD.
+     */
+    currency?: StockCurrencyParameter;
+    /**
+     * The pagination token from which to continue. The value to pass here is returned in specific requests when more data is available, usually because of a response result limit.
+     */
+    page_token?: PageTokenParameter;
+    /**
+     * Sort data in ascending or descending order.
+     */
+    sort?: SortParameter;
+};

package/dist/generated/data/model/stockTradesResp.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Market Data API
+ * Access real-time and historical market data for US equities, options, crypto, and foreign exchange data through the Alpaca REST and WebSocket APIs. There are APIs for Stock Pricing, Option Pricing, Crypto Pricing, Forex, Logos, Fixed income, Corporate Actions, Screener, and News.
+ *
+ * OpenAPI spec version: 1.1
+ */
+import type { NextPageToken } from './nextPageToken.js';
+import type { StockTradesRespTrades } from './stockTradesRespTrades.js';
+export interface StockTradesResp {
+    currency?: string;
+    next_page_token: NextPageToken | null;
+    trades: StockTradesRespTrades;
+}

package/dist/generated/data/model/stockTradesRespSingle.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Market Data API
+ * Access real-time and historical market data for US equities, options, crypto, and foreign exchange data through the Alpaca REST and WebSocket APIs. There are APIs for Stock Pricing, Option Pricing, Crypto Pricing, Forex, Logos, Fixed income, Corporate Actions, Screener, and News.
+ *
+ * OpenAPI spec version: 1.1
+ */
+import type { NextPageToken } from './nextPageToken.js';
+import type { StockTrade } from './stockTrade.js';
+export interface StockTradesRespSingle {
+    currency?: string;
+    next_page_token: NextPageToken | null;
+    symbol: string;
+    trades: StockTrade[];
+}

package/dist/generated/data/model/stockTradesRespTrades.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Market Data API
+ * Access real-time and historical market data for US equities, options, crypto, and foreign exchange data through the Alpaca REST and WebSocket APIs. There are APIs for Stock Pricing, Option Pricing, Crypto Pricing, Forex, Logos, Fixed income, Corporate Actions, Screener, and News.
+ *
+ * OpenAPI spec version: 1.1
+ */
+import type { StockTrade } from './stockTrade.js';
+export type StockTradesRespTrades = {
+    [key: string]: StockTrade[];
+};

package/dist/generated/data/model/timeframeParameter.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Market Data API
+ * Access real-time and historical market data for US equities, options, crypto, and foreign exchange data through the Alpaca REST and WebSocket APIs. There are APIs for Stock Pricing, Option Pricing, Crypto Pricing, Forex, Logos, Fixed income, Corporate Actions, Screener, and News.
+ *
+ * OpenAPI spec version: 1.1
+ */
+/**
+ * The timeframe represented by each bar in aggregation.
+ * You can use any of the following values:
+ *  - `[1-59]Min` or `[1-59]T`, e.g. `5Min` or `5T` creates 5-minute aggregations
+ *  - `[1-23]Hour` or `[1-23]H`, e.g. `12Hour` or `12H` creates 12-hour aggregations
+ *  - `1Day` or `1D` creates 1-day aggregations
+ *  - `1Week` or `1W` creates 1-week aggregations
+ *  - `[1,2,3,4,6,12]Month` or `[1,2,3,4,6,12]M`, e.g. `3Month` or `3M` creates 3-month aggregations
+ */
+export type TimeframeParameter = string;

package/dist/generated/data/model/timestamp.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Market Data API
+ * Access real-time and historical market data for US equities, options, crypto, and foreign exchange data through the Alpaca REST and WebSocket APIs. There are APIs for Stock Pricing, Option Pricing, Crypto Pricing, Forex, Logos, Fixed income, Corporate Actions, Screener, and News.
+ *
+ * OpenAPI spec version: 1.1
+ */
+/**
+ * Timestamp in RFC-3339 format with nanosecond precision.
+ */
+export type Timestamp = string;

package/dist/generated/data/model/tradeSizeParameter.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Market Data API
+ * Access real-time and historical market data for US equities, options, crypto, and foreign exchange data through the Alpaca REST and WebSocket APIs. There are APIs for Stock Pricing, Option Pricing, Crypto Pricing, Forex, Logos, Fixed income, Corporate Actions, Screener, and News.
+ *
+ * OpenAPI spec version: 1.1
+ */
+/**
+ * Filters to best bid/ask where the minimum trade size is less than or equal to the given numeric value. For any negative value the best bid/ask will be returned for the smallest trade size on either side.
+ */
+export type TradeSizeParameter = number;

package/dist/generated/data/model/unitSplit.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Market Data API
+ * Access real-time and historical market data for US equities, options, crypto, and foreign exchange data through the Alpaca REST and WebSocket APIs. There are APIs for Stock Pricing, Option Pricing, Crypto Pricing, Forex, Logos, Fixed income, Corporate Actions, Screener, and News.
+ *
+ * OpenAPI spec version: 1.1
+ */
+import type { CaId } from './caId.js';
+import type { Currency } from './currency.js';
+import type { EffectiveDate } from './effectiveDate.js';
+import type { Isin } from './isin.js';
+import type { PayableDate } from './payableDate.js';
+import type { ProcessDate } from './processDate.js';
+/**
+ * Unit split.
+ */
+export interface UnitSplit {
+    alternate_cusip: string;
+    alternate_isin?: Isin;
+    alternate_rate: number;
+    alternate_symbol: string;
+    currency?: Currency;
+    effective_date: EffectiveDate;
+    id: CaId;
+    new_cusip: string;
+    new_isin?: Isin;
+    new_rate: number;
+    new_symbol: string;
+    old_cusip: string;
+    old_isin?: Isin;
+    old_rate: number;
+    old_symbol: string;
+    payable_date?: PayableDate;
+    process_date: ProcessDate;
+}

package/dist/generated/data/model/worthlessRemoval.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Market Data API
+ * Access real-time and historical market data for US equities, options, crypto, and foreign exchange data through the Alpaca REST and WebSocket APIs. There are APIs for Stock Pricing, Option Pricing, Crypto Pricing, Forex, Logos, Fixed income, Corporate Actions, Screener, and News.
+ *
+ * OpenAPI spec version: 1.1
+ */
+import type { CaId } from './caId.js';
+import type { Currency } from './currency.js';
+import type { Isin } from './isin.js';
+import type { ProcessDate } from './processDate.js';
+/**
+ * Worthless removal.
+ */
+export interface WorthlessRemoval {
+    currency?: Currency;
+    cusip: string;
+    id: CaId;
+    isin?: Isin;
+    process_date: ProcessDate;
+    symbol: string;
+}