snaptrade-typescript-sdk 2.4.0 → 4.0.0

package/models/strategy-order-place-orders-inner-legs-inner.ts

@@ -0,0 +1,67 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * 
+ * @export
+ * @interface StrategyOrderPlaceOrdersInnerLegsInner
+ */
+export interface StrategyOrderPlaceOrdersInnerLegsInner {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInnerLegsInner
+     */
+    'legId'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInnerLegsInner
+     */
+    'symbol'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInnerLegsInner
+     */
+    'symbolId'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInnerLegsInner
+     */
+    'legRatioQuantity'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInnerLegsInner
+     */
+    'side'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInnerLegsInner
+     */
+    'avgExecPrice'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInnerLegsInner
+     */
+    'lastExecPrice'?: string;
+}
+

package/models/strategy-order-place-orders-inner.ts

@@ -0,0 +1,286 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+// May contain unused imports in some cases
+// @ts-ignore
+import { StrategyOrderPlaceOrdersInnerLegsInner } from './strategy-order-place-orders-inner-legs-inner';
+
+/**
+ * 
+ * @export
+ * @interface StrategyOrderPlaceOrdersInner
+ */
+export interface StrategyOrderPlaceOrdersInner {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'id'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'symbol'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'symbolId'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'totalQuantity'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'openQuantity'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'filledQuantity'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'canceledQuantity'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'side'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'orderType'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'limitPrice'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'stopPrice'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'isAllOrNone'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'isAnonymous'?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'icebergQuantity'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'minQuantity'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'avgExecPrice'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'lastExecPrice'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'source'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'timeInForce'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'gtdDate'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'state'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'rejectionReason'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'chainId'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'creationTime'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'updateTime'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'notes'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'primaryRoute'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'secondaryRoute'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'orderRoute'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'venueHoldingOrder'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'comissionCharged'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'exchangeOrderId'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'isSignificantShareHolder'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'isInsider'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'isLimitOffsetInDollar'?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'userId'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'placementCommission'?: string;
+    /**
+     * 
+     * @type {Array<StrategyOrderPlaceOrdersInnerLegsInner>}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'legs'?: Array<StrategyOrderPlaceOrdersInnerLegsInner>;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'strategyType'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'triggerStopPrice'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'orderGroupId'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'orderClass'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof StrategyOrderPlaceOrdersInner
+     */
+    'isCrossZero'?: boolean;
+}
+

package/models/strategy-order-place.ts

@@ -0,0 +1,40 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+// May contain unused imports in some cases
+// @ts-ignore
+import { StrategyOrderPlaceOrdersInner } from './strategy-order-place-orders-inner';
+
+/**
+ * The reponse for a correctly placed order
+ * @export
+ * @interface StrategyOrderPlace
+ */
+export interface StrategyOrderPlace {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderPlace
+     */
+    'orderId'?: number;
+    /**
+     * 
+     * @type {Array<StrategyOrderPlaceOrdersInner>}
+     * @memberof StrategyOrderPlace
+     */
+    'orders'?: Array<StrategyOrderPlaceOrdersInner>;
+}
+

package/models/strategy-order-record.ts

@@ -0,0 +1,133 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+// May contain unused imports in some cases
+// @ts-ignore
+import { OptionStrategy } from './option-strategy';
+
+/**
+ * Strategy order record
+ * @export
+ * @interface StrategyOrderRecord
+ */
+export interface StrategyOrderRecord {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {OptionStrategy}
+     * @memberof StrategyOrderRecord
+     */
+    'strategy'?: OptionStrategy;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderRecord
+     */
+    'status'?: StrategyOrderRecordStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderRecord
+     */
+    'filled_quantity'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderRecord
+     */
+    'open_quantity'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyOrderRecord
+     */
+    'closed_quantity'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderRecord
+     */
+    'order_type'?: StrategyOrderRecordOrderTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyOrderRecord
+     */
+    'time_in_force'?: StrategyOrderRecordTimeInForceEnum;
+    /**
+     * Trade Price if limit or stop limit order
+     * @type {number}
+     * @memberof StrategyOrderRecord
+     */
+    'limit_price'?: number;
+    /**
+     * Trade Price if limit or stop limit order
+     * @type {number}
+     * @memberof StrategyOrderRecord
+     */
+    'execution_price'?: number;
+    /**
+     * Time
+     * @type {string}
+     * @memberof StrategyOrderRecord
+     */
+    'time_placed'?: string;
+    /**
+     * Time
+     * @type {string}
+     * @memberof StrategyOrderRecord
+     */
+    'time_updated'?: string;
+}
+
+export const StrategyOrderRecordStatusEnum = {
+    Pending: 'PENDING',
+    Accepted: 'ACCEPTED',
+    Failed: 'FAILED',
+    Rejected: 'REJECTED',
+    Canceled: 'CANCELED',
+    PartialCanceled: 'PARTIAL_CANCELED',
+    CancelPending: 'CANCEL_PENDING',
+    Executed: 'EXECUTED',
+    Partial: 'PARTIAL',
+    ReplacePending: 'REPLACE_PENDING',
+    Replaced: 'REPLACED',
+    Stopped: 'STOPPED',
+    Suspended: 'SUSPENDED',
+    Expired: 'EXPIRED',
+    Queued: 'QUEUED',
+    Triggered: 'TRIGGERED',
+    Activated: 'ACTIVATED',
+    PendingRiskReview: 'PENDING_RISK_REVIEW',
+    ContingentOrder: 'CONTINGENT_ORDER'
+} as const;
+
+export type StrategyOrderRecordStatusEnum = typeof StrategyOrderRecordStatusEnum[keyof typeof StrategyOrderRecordStatusEnum];
+export const StrategyOrderRecordOrderTypeEnum = {
+    Limit: 'Limit',
+    Market: 'Market',
+    NetDebit: 'NetDebit',
+    NetCredit: 'NetCredit'
+} as const;
+
+export type StrategyOrderRecordOrderTypeEnum = typeof StrategyOrderRecordOrderTypeEnum[keyof typeof StrategyOrderRecordOrderTypeEnum];
+export const StrategyOrderRecordTimeInForceEnum = {
+    Day: 'DAY',
+    Gtc: 'GTC'
+} as const;
+
+export type StrategyOrderRecordTimeInForceEnum = typeof StrategyOrderRecordTimeInForceEnum[keyof typeof StrategyOrderRecordTimeInForceEnum];
+
+

package/models/strategy-quotes-greek.ts

@@ -0,0 +1,55 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * 
+ * @export
+ * @interface StrategyQuotesGreek
+ */
+export interface StrategyQuotesGreek {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyQuotesGreek
+     */
+    'delta'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyQuotesGreek
+     */
+    'gamma'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyQuotesGreek
+     */
+    'theta'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyQuotesGreek
+     */
+    'vega'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyQuotesGreek
+     */
+    'rho'?: number;
+}
+

package/models/strategy-quotes.ts

@@ -0,0 +1,67 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+// May contain unused imports in some cases
+// @ts-ignore
+import { OptionStrategy } from './option-strategy';
+// May contain unused imports in some cases
+// @ts-ignore
+import { StrategyQuotesGreek } from './strategy-quotes-greek';
+
+/**
+ * 
+ * @export
+ * @interface StrategyQuotes
+ */
+export interface StrategyQuotes {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {OptionStrategy}
+     * @memberof StrategyQuotes
+     */
+    'strategy'?: OptionStrategy;
+    /**
+     * Trade Price if limit or stop limit order
+     * @type {number}
+     * @memberof StrategyQuotes
+     */
+    'open_price'?: number;
+    /**
+     * Trade Price if limit or stop limit order
+     * @type {number}
+     * @memberof StrategyQuotes
+     */
+    'bid_price'?: number;
+    /**
+     * Trade Price if limit or stop limit order
+     * @type {number}
+     * @memberof StrategyQuotes
+     */
+    'ask_price'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyQuotes
+     */
+    'volatility'?: number;
+    /**
+     * 
+     * @type {StrategyQuotesGreek}
+     * @memberof StrategyQuotes
+     */
+    'greek'?: StrategyQuotesGreek;
+}
+

package/models/sub-period-return-rate.ts

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * 
+ * @export
+ * @interface SubPeriodReturnRate
+ */
+export interface SubPeriodReturnRate {
+    [key: string]: any;
+
+    /**
+     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+     * @type {string}
+     * @memberof SubPeriodReturnRate
+     */
+    'periodStart'?: string;
+    /**
+     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+     * @type {string}
+     * @memberof SubPeriodReturnRate
+     */
+    'periodEnd'?: string;
+    /**
+     * The return rate for the given period
+     * @type {number}
+     * @memberof SubPeriodReturnRate
+     */
+    'rateOfReturn'?: number | null;
+}
+