snaptrade-typescript-sdk 3.0.0 → 4.0.0

package/models/symbol-query.ts

@@ -0,0 +1,29 @@
+/* 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.
+ */
+
+
+/**
+ * Symbol query for searching for symbols
+ * @export
+ * @interface SymbolQuery
+ */
+export interface SymbolQuery {
+    /**
+     * 
+     * @type {string}
+     * @memberof SymbolQuery
+     */
+    'substring'?: string;
+}
+

package/models/symbol.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 { Currency } from './currency';
+// May contain unused imports in some cases
+// @ts-ignore
+import { Exchange } from './exchange';
+
+/**
+ * Symbol
+ * @export
+ * @interface Symbol
+ */
+export interface Symbol {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof Symbol
+     */
+    'symbol'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Symbol
+     */
+    'raw_symbol'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Symbol
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {Currency}
+     * @memberof Symbol
+     */
+    'currency'?: Currency;
+    /**
+     * 
+     * @type {Exchange}
+     * @memberof Symbol
+     */
+    'exchange'?: Exchange;
+}
+

package/models/symbols-quotes.ts

@@ -0,0 +1,64 @@
+/* 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';
+
+/**
+ * Symbols and Tickers Quotes object
+ * @export
+ * @interface SymbolsQuotes
+ */
+export interface SymbolsQuotes {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {UniversalSymbol}
+     * @memberof SymbolsQuotes
+     */
+    'symbol'?: UniversalSymbol;
+    /**
+     * 
+     * @type {number}
+     * @memberof SymbolsQuotes
+     */
+    'bid_price'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SymbolsQuotes
+     */
+    'ask_price'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SymbolsQuotes
+     */
+    'last_trade_price'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SymbolsQuotes
+     */
+    'bid_size'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SymbolsQuotes
+     */
+    'ask_size'?: number;
+}
+

package/models/target-asset.ts

@@ -0,0 +1,62 @@
+/* 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';
+
+/**
+ * Target percentage of a certain asset
+ * @export
+ * @interface TargetAsset
+ */
+export interface TargetAsset {
+    /**
+     * 
+     * @type {string}
+     * @memberof TargetAsset
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {UniversalSymbol}
+     * @memberof TargetAsset
+     */
+    'symbol'?: UniversalSymbol;
+    /**
+     * 
+     * @type {number}
+     * @memberof TargetAsset
+     */
+    'percent'?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof TargetAsset
+     */
+    'is_supported'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof TargetAsset
+     */
+    'is_excluded'?: boolean;
+    /**
+     * 
+     * @type {object}
+     * @memberof TargetAsset
+     */
+    'meta'?: object | null;
+}
+

package/models/time-in-force.ts

@@ -0,0 +1,31 @@
+/* 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.
+ */
+
+
+/**
+ * Trade time in force:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled 
+ * @export
+ * @enum {string}
+ */
+
+export const TimeInForce = {
+    Day: 'Day',
+    Fok: 'FOK',
+    Gtc: 'GTC'
+} as const;
+
+export type TimeInForce = typeof TimeInForce[keyof typeof TimeInForce];
+
+
+

package/models/trade-execution-status.ts

@@ -0,0 +1,105 @@
+/* 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 { BrokerageSymbol } from './brokerage-symbol';
+// May contain unused imports in some cases
+// @ts-ignore
+import { Trade } from './trade';
+// May contain unused imports in some cases
+// @ts-ignore
+import { UniversalSymbol } from './universal-symbol';
+
+/**
+ * Execution status of a trade
+ * @export
+ * @interface TradeExecutionStatus
+ */
+export interface TradeExecutionStatus {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {BrokerageSymbol}
+     * @memberof TradeExecutionStatus
+     */
+    'symbol'?: BrokerageSymbol;
+    /**
+     * 
+     * @type {UniversalSymbol}
+     * @memberof TradeExecutionStatus
+     */
+    'universal_symbol'?: UniversalSymbol;
+    /**
+     * 
+     * @type {Trade}
+     * @memberof TradeExecutionStatus
+     */
+    'trade'?: Trade;
+    /**
+     * Execution state of a trade
+     * @type {string}
+     * @memberof TradeExecutionStatus
+     */
+    'state'?: TradeExecutionStatusStateEnum;
+    /**
+     * Number of filled units
+     * @type {number}
+     * @memberof TradeExecutionStatus
+     */
+    'filled_units'?: number;
+    /**
+     * Action of executed trade
+     * @type {string}
+     * @memberof TradeExecutionStatus
+     */
+    'action'?: TradeExecutionStatusActionEnum;
+    /**
+     * Price of execution
+     * @type {number}
+     * @memberof TradeExecutionStatus
+     */
+    'price'?: number;
+    /**
+     * Fees paid from executing trade
+     * @type {number}
+     * @memberof TradeExecutionStatus
+     */
+    'commissions'?: number;
+    /**
+     * Other misc. data
+     * @type {{ [key: string]: any; }}
+     * @memberof TradeExecutionStatus
+     */
+    'meta'?: { [key: string]: any; };
+}
+
+export const TradeExecutionStatusStateEnum = {
+    Executed: 'Executed',
+    Canceled: 'Canceled',
+    Rejected: 'Rejected',
+    Failed: 'Failed',
+    NotExecuted: 'Not Executed'
+} as const;
+
+export type TradeExecutionStatusStateEnum = typeof TradeExecutionStatusStateEnum[keyof typeof TradeExecutionStatusStateEnum];
+export const TradeExecutionStatusActionEnum = {
+    Buy: 'BUY',
+    Sell: 'SELL'
+} as const;
+
+export type TradeExecutionStatusActionEnum = typeof TradeExecutionStatusActionEnum[keyof typeof TradeExecutionStatusActionEnum];
+
+

package/models/trade-impact.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 { Account } from './account';
+// May contain unused imports in some cases
+// @ts-ignore
+import { Currency } from './currency';
+
+/**
+ * Impact of a group of trade
+ * @export
+ * @interface TradeImpact
+ */
+export interface TradeImpact {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {Account}
+     * @memberof TradeImpact
+     */
+    'account'?: Account;
+    /**
+     * 
+     * @type {Currency}
+     * @memberof TradeImpact
+     */
+    'currency'?: Currency;
+    /**
+     * Remaining balance after executing all trades
+     * @type {number}
+     * @memberof TradeImpact
+     */
+    'remaining_cash'?: number;
+    /**
+     * Total estimated commissions across all trades to make
+     * @type {number}
+     * @memberof TradeImpact
+     */
+    'estimated_commissions'?: number;
+    /**
+     * Estimated forex fees to pay to excute trades
+     * @type {number}
+     * @memberof TradeImpact
+     */
+    'forex_fees'?: number;
+}
+

package/models/trade.ts

@@ -0,0 +1,88 @@
+/* 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 { Account } from './account';
+// May contain unused imports in some cases
+// @ts-ignore
+import { BrokerageSymbol } from './brokerage-symbol';
+// May contain unused imports in some cases
+// @ts-ignore
+import { UniversalSymbol } from './universal-symbol';
+
+/**
+ * A trade object
+ * @export
+ * @interface Trade
+ */
+export interface Trade {
+    /**
+     * 
+     * @type {string}
+     * @memberof Trade
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {Account}
+     * @memberof Trade
+     */
+    'account'?: Account;
+    /**
+     * 
+     * @type {BrokerageSymbol}
+     * @memberof Trade
+     */
+    'symbol'?: BrokerageSymbol;
+    /**
+     * 
+     * @type {UniversalSymbol}
+     * @memberof Trade
+     */
+    'universal_symbol'?: UniversalSymbol;
+    /**
+     * 
+     * @type {string}
+     * @memberof Trade
+     */
+    'action'?: TradeActionEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof Trade
+     */
+    'units'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof Trade
+     */
+    'price'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof Trade
+     */
+    'sequence'?: number;
+}
+
+export const TradeActionEnum = {
+    Buy: 'BUY',
+    Sell: 'SELL'
+} as const;
+
+export type TradeActionEnum = typeof TradeActionEnum[keyof typeof TradeActionEnum];
+
+

package/models/trading-place-ocoorder-request.ts

@@ -0,0 +1,35 @@
+/* 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 TradingPlaceOCOOrderRequest
+ */
+export interface TradingPlaceOCOOrderRequest {
+    /**
+     * The ID of first trade object obtained from trade/impact endpoint
+     * @type {any}
+     * @memberof TradingPlaceOCOOrderRequest
+     */
+    'first_trade_id'?: any;
+    /**
+     * The ID of second trade object obtained from trade/impact endpoint
+     * @type {any}
+     * @memberof TradingPlaceOCOOrderRequest
+     */
+    'second_trade_id'?: any;
+}
+

package/models/underlying-symbol.ts

@@ -0,0 +1,76 @@
+/* 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 { SecurityType } from './security-type';
+// May contain unused imports in some cases
+// @ts-ignore
+import { USExchange } from './usexchange';
+
+/**
+ * Underlying Symbol
+ * @export
+ * @interface UnderlyingSymbol
+ */
+export interface UnderlyingSymbol {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof UnderlyingSymbol
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UnderlyingSymbol
+     */
+    'symbol'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UnderlyingSymbol
+     */
+    'description'?: string | null;
+    /**
+     * 
+     * @type {Currency}
+     * @memberof UnderlyingSymbol
+     */
+    'currency'?: Currency;
+    /**
+     * 
+     * @type {USExchange}
+     * @memberof UnderlyingSymbol
+     */
+    'exchange'?: USExchange;
+    /**
+     * 
+     * @type {SecurityType}
+     * @memberof UnderlyingSymbol
+     */
+    'type'?: SecurityType;
+    /**
+     * 
+     * @type {Array<Currency>}
+     * @memberof UnderlyingSymbol
+     */
+    'currencies'?: Array<Currency>;
+}
+