snaptrade-typescript-sdk 3.0.0 → 5.0.0

package/dist/models/symbol-query.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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/dist/models/symbol-query.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/symbol.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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.
+ */
+import { Currency } from './currency';
+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/dist/models/symbol.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/symbols-quotes.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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.
+ */
+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/dist/models/symbols-quotes.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/target-asset.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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.
+ */
+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/dist/models/target-asset.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/time-in-force.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 declare const TimeInForce: {
+    readonly Day: "Day";
+    readonly Fok: "FOK";
+    readonly Gtc: "GTC";
+};
+export type TimeInForce = typeof TimeInForce[keyof typeof TimeInForce];

package/dist/models/time-in-force.js

@@ -0,0 +1,26 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeInForce = void 0;
+/**
+ * Trade time in force:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled
+ * @export
+ * @enum {string}
+ */
+exports.TimeInForce = {
+    Day: 'Day',
+    Fok: 'FOK',
+    Gtc: 'GTC'
+};

package/dist/models/trade-execution-status.d.ts

@@ -0,0 +1,91 @@
+/**
+ * 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.
+ */
+import { BrokerageSymbol } from './brokerage-symbol';
+import { Trade } from './trade';
+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 declare const TradeExecutionStatusStateEnum: {
+    readonly Executed: "Executed";
+    readonly Canceled: "Canceled";
+    readonly Rejected: "Rejected";
+    readonly Failed: "Failed";
+    readonly NotExecuted: "Not Executed";
+};
+export type TradeExecutionStatusStateEnum = typeof TradeExecutionStatusStateEnum[keyof typeof TradeExecutionStatusStateEnum];
+export declare const TradeExecutionStatusActionEnum: {
+    readonly Buy: "BUY";
+    readonly Sell: "SELL";
+};
+export type TradeExecutionStatusActionEnum = typeof TradeExecutionStatusActionEnum[keyof typeof TradeExecutionStatusActionEnum];

package/dist/models/trade-execution-status.js

@@ -0,0 +1,27 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TradeExecutionStatusActionEnum = exports.TradeExecutionStatusStateEnum = void 0;
+exports.TradeExecutionStatusStateEnum = {
+    Executed: 'Executed',
+    Canceled: 'Canceled',
+    Rejected: 'Rejected',
+    Failed: 'Failed',
+    NotExecuted: 'Not Executed'
+};
+exports.TradeExecutionStatusActionEnum = {
+    Buy: 'BUY',
+    Sell: 'SELL'
+};

package/dist/models/trade-impact.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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.
+ */
+import { Account } from './account';
+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/dist/models/trade-impact.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/trade.d.ts

@@ -0,0 +1,74 @@
+/**
+ * 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.
+ */
+import { Account } from './account';
+import { BrokerageSymbol } from './brokerage-symbol';
+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 declare const TradeActionEnum: {
+    readonly Buy: "BUY";
+    readonly Sell: "SELL";
+};
+export type TradeActionEnum = typeof TradeActionEnum[keyof typeof TradeActionEnum];

package/dist/models/trade.js

@@ -0,0 +1,20 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TradeActionEnum = void 0;
+exports.TradeActionEnum = {
+    Buy: 'BUY',
+    Sell: 'SELL'
+};

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

@@ -0,0 +1,30 @@
+/**
+ * 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/dist/models/trading-place-ocoorder-request.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });