snaptrade-typescript-sdk 3.0.0 → 4.0.0

package/models/monthly-dividends.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 { DividendAtDate } from './dividend-at-date';
+
+/**
+ * 
+ * @export
+ * @interface MonthlyDividends
+ */
+export interface MonthlyDividends {
+    [key: string]: any;
+
+    /**
+     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+     * @type {string}
+     * @memberof MonthlyDividends
+     */
+    'date'?: string;
+    /**
+     * 
+     * @type {Array<DividendAtDate>}
+     * @memberof MonthlyDividends
+     */
+    'dividends'?: Array<DividendAtDate>;
+}
+

package/models/net-contributions.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 NetContributions
+ */
+export interface NetContributions {
+    [key: string]: any;
+
+    /**
+     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+     * @type {string}
+     * @memberof NetContributions
+     */
+    'date'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof NetContributions
+     */
+    'contributions'?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof NetContributions
+     */
+    'currency'?: string;
+}
+

package/models/net-dividend.ts

@@ -0,0 +1,46 @@
+/* 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 { UniversalSymbol } from './universal-symbol';
+
+/**
+ * Object representing total dividends received during a timeframe
+ * @export
+ * @interface NetDividend
+ */
+export interface NetDividend {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {UniversalSymbol}
+     * @memberof NetDividend
+     */
+    'symbol'?: UniversalSymbol;
+    /**
+     * 
+     * @type {number}
+     * @memberof NetDividend
+     */
+    'amount'?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof NetDividend
+     */
+    'currency'?: string;
+}
+

package/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.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 OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
+ */
+export interface OptionChainInnerChainPerRootInnerChainPerStrikePriceInner {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {number}
+     * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
+     */
+    'strikePrice'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
+     */
+    'callSymbolId'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
+     */
+    'putSymbolId'?: number | null;
+}
+

package/models/option-chain-inner-chain-per-root-inner.ts

@@ -0,0 +1,46 @@
+/* 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 { OptionChainInnerChainPerRootInnerChainPerStrikePriceInner } from './option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner';
+
+/**
+ * 
+ * @export
+ * @interface OptionChainInnerChainPerRootInner
+ */
+export interface OptionChainInnerChainPerRootInner {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionChainInnerChainPerRootInner
+     */
+    'optionRoot'?: string;
+    /**
+     * 
+     * @type {Array<OptionChainInnerChainPerRootInnerChainPerStrikePriceInner>}
+     * @memberof OptionChainInnerChainPerRootInner
+     */
+    'chainPerStrikePrice'?: Array<OptionChainInnerChainPerRootInnerChainPerStrikePriceInner>;
+    /**
+     * 
+     * @type {number}
+     * @memberof OptionChainInnerChainPerRootInner
+     */
+    'multiplier'?: number;
+}
+

package/models/option-chain-inner.ts

@@ -0,0 +1,58 @@
+/* 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 { OptionChainInnerChainPerRootInner } from './option-chain-inner-chain-per-root-inner';
+
+/**
+ * 
+ * @export
+ * @interface OptionChainInner
+ */
+export interface OptionChainInner {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionChainInner
+     */
+    'expiryDate'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionChainInner
+     */
+    'description'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionChainInner
+     */
+    'listingExchange'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionChainInner
+     */
+    'optionExerciseType'?: string;
+    /**
+     * 
+     * @type {Array<OptionChainInnerChainPerRootInner>}
+     * @memberof OptionChainInner
+     */
+    'chainPerRoot'?: Array<OptionChainInnerChainPerRootInner>;
+}
+

package/models/option-leg.ts

@@ -0,0 +1,53 @@
+/* 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.
+ */
+
+
+/**
+ * Option Leg
+ * @export
+ * @interface OptionLeg
+ */
+export interface OptionLeg {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionLeg
+     */
+    'action'?: OptionLegActionEnum;
+    /**
+     * Obtained from calling options chain endpoint (option_id)
+     * @type {string}
+     * @memberof OptionLeg
+     */
+    'option_symbol_id'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof OptionLeg
+     */
+    'quantity'?: number;
+}
+
+export const OptionLegActionEnum = {
+    BuyToOpen: 'BUY_TO_OPEN',
+    BuyToClose: 'BUY_TO_CLOSE',
+    SellToOpen: 'SELL_TO_OPEN',
+    SellToClose: 'SELL_TO_CLOSE'
+} as const;
+
+export type OptionLegActionEnum = typeof OptionLegActionEnum[keyof typeof OptionLegActionEnum];
+
+

package/models/option-strategy-legs-inner.ts

@@ -0,0 +1,47 @@
+/* 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 OptionStrategyLegsInner
+ */
+export interface OptionStrategyLegsInner {
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionStrategyLegsInner
+     */
+    'option_symbol_id'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof OptionStrategyLegsInner
+     */
+    'index'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionStrategyLegsInner
+     */
+    'action'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof OptionStrategyLegsInner
+     */
+    'quantity'?: number;
+}
+

package/models/option-strategy.ts

@@ -0,0 +1,61 @@
+/* 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 { OptionStrategyLegsInner } from './option-strategy-legs-inner';
+// May contain unused imports in some cases
+// @ts-ignore
+import { UniversalSymbol } from './universal-symbol';
+
+/**
+ * 
+ * @export
+ * @interface OptionStrategy
+ */
+export interface OptionStrategy {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionStrategy
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {UniversalSymbol}
+     * @memberof OptionStrategy
+     */
+    'underlying_symbol_id'?: UniversalSymbol;
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionStrategy
+     */
+    'strategy_type'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof OptionStrategy
+     */
+    'number_of_legs'?: number;
+    /**
+     * 
+     * @type {Array<OptionStrategyLegsInner>}
+     * @memberof OptionStrategy
+     */
+    'legs'?: Array<OptionStrategyLegsInner>;
+}
+

package/models/options-get-option-strategy-request.ts

@@ -0,0 +1,51 @@
+/* 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 { OptionLeg } from './option-leg';
+
+/**
+ * 
+ * @export
+ * @interface OptionsGetOptionStrategyRequest
+ */
+export interface OptionsGetOptionStrategyRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionsGetOptionStrategyRequest
+     */
+    'underlying_symbol_id': string;
+    /**
+     * 
+     * @type {Array<OptionLeg>}
+     * @memberof OptionsGetOptionStrategyRequest
+     */
+    'legs': Array<OptionLeg>;
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionsGetOptionStrategyRequest
+     */
+    'strategy_type': OptionsGetOptionStrategyRequestStrategyTypeEnum;
+}
+
+export const OptionsGetOptionStrategyRequestStrategyTypeEnum = {
+    Custom: 'CUSTOM'
+} as const;
+
+export type OptionsGetOptionStrategyRequestStrategyTypeEnum = typeof OptionsGetOptionStrategyRequestStrategyTypeEnum[keyof typeof OptionsGetOptionStrategyRequestStrategyTypeEnum];
+
+

package/models/options-holdings.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 { Currency } from './currency';
+// May contain unused imports in some cases
+// @ts-ignore
+import { OptionsSymbol } from './options-symbol';
+
+/**
+ * Option Holdings
+ * @export
+ * @interface OptionsHoldings
+ */
+export interface OptionsHoldings {
+    [key: string]: any;
+
+    /**
+     * Options information
+     * @type {string}
+     * @memberof OptionsHoldings
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionsHoldings
+     */
+    'symbol'?: string;
+    /**
+     * 
+     * @type {OptionsSymbol}
+     * @memberof OptionsHoldings
+     */
+    'option_symbol'?: OptionsSymbol;
+    /**
+     * Trade Price if limit or stop limit order
+     * @type {number}
+     * @memberof OptionsHoldings
+     */
+    'price'?: number;
+    /**
+     * 
+     * @type {Currency}
+     * @memberof OptionsHoldings
+     */
+    'currency'?: Currency;
+    /**
+     * Average purchase price for this position
+     * @type {number}
+     * @memberof OptionsHoldings
+     */
+    'average_purchase_price'?: number;
+}
+

package/models/options-place-option-strategy-request.ts

@@ -0,0 +1,57 @@
+/* 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 OptionsPlaceOptionStrategyRequest
+ */
+export interface OptionsPlaceOptionStrategyRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionsPlaceOptionStrategyRequest
+     */
+    'order_type': OptionsPlaceOptionStrategyRequestOrderTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionsPlaceOptionStrategyRequest
+     */
+    'time_in_force': OptionsPlaceOptionStrategyRequestTimeInForceEnum;
+    /**
+     * Trade Price if limit or stop limit order
+     * @type {number}
+     * @memberof OptionsPlaceOptionStrategyRequest
+     */
+    'price': number;
+}
+
+export const OptionsPlaceOptionStrategyRequestOrderTypeEnum = {
+    Limit: 'Limit',
+    Market: 'Market',
+    NetDebit: 'NetDebit',
+    NetCredit: 'NetCredit'
+} as const;
+
+export type OptionsPlaceOptionStrategyRequestOrderTypeEnum = typeof OptionsPlaceOptionStrategyRequestOrderTypeEnum[keyof typeof OptionsPlaceOptionStrategyRequestOrderTypeEnum];
+export const OptionsPlaceOptionStrategyRequestTimeInForceEnum = {
+    Day: 'DAY',
+    Gtc: 'GTC'
+} as const;
+
+export type OptionsPlaceOptionStrategyRequestTimeInForceEnum = typeof OptionsPlaceOptionStrategyRequestTimeInForceEnum[keyof typeof OptionsPlaceOptionStrategyRequestTimeInForceEnum];
+
+

package/models/options-position.ts

@@ -0,0 +1,73 @@
+/* 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 { Currency } from './currency';
+// May contain unused imports in some cases
+// @ts-ignore
+import { OptionsSymbol } from './options-symbol';
+
+/**
+ * Option Holdings
+ * @export
+ * @interface OptionsPosition
+ */
+export interface OptionsPosition {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionsPosition
+     */
+    'symbol'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionsPosition
+     */
+    'description'?: string;
+    /**
+     * 
+     * @type {OptionsSymbol}
+     * @memberof OptionsPosition
+     */
+    'option_symbol'?: OptionsSymbol;
+    /**
+     * Trade Price if limit or stop limit order
+     * @type {number}
+     * @memberof OptionsPosition
+     */
+    'price'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof OptionsPosition
+     */
+    'units'?: number;
+    /**
+     * 
+     * @type {Currency}
+     * @memberof OptionsPosition
+     */
+    'currency'?: Currency;
+    /**
+     * Average purchase price for this position
+     * @type {number}
+     * @memberof OptionsPosition
+     */
+    'average_purchase_price'?: number;
+}
+