snaptrade-typescript-sdk 2.4.0 → 4.0.0

package/docs/TransactionsAndReportingApi.md

@@ -0,0 +1,141 @@
+# TransactionsAndReportingApi
+
+All URIs are relative to *https://api.snaptrade.com/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getActivities**](TransactionsAndReportingApi.md#getActivities) | **GET** /activities | Get transaction history for a user
+[**getReportingCustomRange**](TransactionsAndReportingApi.md#getReportingCustomRange) | **GET** /performance/custom | Get performance information for a specific timeframe
+
+
+# **getActivities**
+> Array<UniversalActivity> getActivities()
+
+Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+
+### Example
+
+
+```typescript
+import { Snaptrade } from "snaptrade-typescript-sdk"
+
+const snaptrade = new Snaptrade({
+    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+    // basePath: "https://api.snaptrade.com/api/v1",
+    consumerKey: "YOUR_CONSUMER_KEY",
+    clientId: "YOUR_CLIENT_ID",
+})
+
+const response = await snaptrade.transactionsAndReporting.getActivities({
+    'userId': "John.doe@snaptrade.com",
+    'userSecret': "USERSECRET123",
+    'startDate': "2022-01-24T00:00:00.000Z",
+    'endDate': "2022-01-24T00:00:00.000Z",
+    'accounts': "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
+})
+console.log(response)
+
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **userId** | [**string**] |  | defaults to undefined
+ **userSecret** | [**string**] |  | defaults to undefined
+ **startDate** | [**string**] |  | (optional) defaults to undefined
+ **endDate** | [**string**] |  | (optional) defaults to undefined
+ **accounts** | [**string**] | Optional comma seperated list of account IDs used to filter the request on specific accounts | (optional) defaults to undefined
+
+
+### Return type
+
+**Array<UniversalActivity>**
+
+### Authorization
+
+[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successfully retrieved transaction history |  -  |
+**0** | Unexpected error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+# **getReportingCustomRange**
+> PerformanceCustom getReportingCustomRange()
+
+Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+
+### Example
+
+
+```typescript
+import { Snaptrade } from "snaptrade-typescript-sdk"
+
+const snaptrade = new Snaptrade({
+    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+    // basePath: "https://api.snaptrade.com/api/v1",
+    consumerKey: "YOUR_CONSUMER_KEY",
+    clientId: "YOUR_CLIENT_ID",
+})
+
+const response = await snaptrade.transactionsAndReporting.getReportingCustomRange({
+    'startDate': "2022-01-24T00:00:00.000Z",
+    'endDate': "2022-01-24T00:00:00.000Z",
+    'userId': "John.doe@snaptrade.com",
+    'userSecret': "USERSECRET123",
+    'accounts': "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
+    'detailed': true,
+    'frequency': "monthly",
+})
+console.log(response)
+
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **startDate** | [**string**] |  | defaults to undefined
+ **endDate** | [**string**] |  | defaults to undefined
+ **userId** | [**string**] |  | defaults to undefined
+ **userSecret** | [**string**] |  | defaults to undefined
+ **accounts** | [**string**] | Optional comma seperated list of account IDs used to filter the request on specific accounts | (optional) defaults to undefined
+ **detailed** | [**boolean**] | Optional, increases frequency of data points for the total value and contribution charts if set to true | (optional) defaults to undefined
+ **frequency** | [**string**] | Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly. | (optional) defaults to undefined
+
+
+### Return type
+
+**PerformanceCustom**
+
+### Authorization
+
+[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successfully retrieved performance data |  -  |
+**0** | Unexpected error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

package/index.test.ts

@@ -1,5 +1,4 @@
-import { APIStatusApi, AuthenticationApi, AccountInformationApi } from "./api";
-import { Configuration } from "./configuration";
+import { Snaptrade } from "./index";
 
 function uuid() {
   var d = new Date().getTime(); //Timestamp
@@ -24,23 +23,23 @@ function uuid() {
 }
 
 it("getting started", async () => {
-  // 1) Initialize a configuration with your clientID and consumerKey.
-  const config = new Configuration({
+  // 1) Initialize a client with your clientID and consumerKey.
+  const snaptrade = new Snaptrade({
     consumerKey: process.env.SNAPTRADE_CONSUMER_KEY,
     clientId: process.env.SNAPTRADE_CLIENT_ID,
   });
 
   // 2) Check that the client is able to make a request to the API server.
-  const apiStatusApiInst = new APIStatusApi(config);
-  const status = await apiStatusApiInst.check();
+  const status = await snaptrade.apiStatus.check();
   console.log("status:", status.data);
 
   // 3) Create a new user on SnapTrade
   const userId = uuid();
-  const authenticationApiInst = new AuthenticationApi(config);
   const { userSecret } = (
-    await authenticationApiInst.registerSnapTradeUser({
-      userId,
+    await snaptrade.authentication.registerSnapTradeUser({
+      requestBody: {
+        userId,
+      },
     })
   ).data;
 
@@ -50,21 +49,71 @@ it("getting started", async () => {
 
   // 4) Get a redirect URI. Users will need this to connect
   const data = (
-    await authenticationApiInst.loginSnapTradeUser(userId, userSecret)
+    await snaptrade.authentication.loginSnapTradeUser({ userId, userSecret })
   ).data;
   if (!("redirectURI" in data)) throw Error("Should have gotten redirect URI");
   console.log("redirectURI:", data.redirectURI);
 
   // 5) Obtaining account holdings data
-  const accountInformationApi = new AccountInformationApi(config);
   const holdings = (
-    await accountInformationApi.getAllUserHoldings(userId, userSecret)
+    await snaptrade.accountInformation.getAllUserHoldings({
+      userId,
+      userSecret,
+    })
   ).data;
   console.log("holdings:", holdings);
 
   // 6) Deleting a user
   const deleteResponse = (
-    await authenticationApiInst.deleteSnapTradeUser(userId)
+    await snaptrade.authentication.deleteSnapTradeUser({ userId })
   ).data;
   console.log("deleteResponse:", deleteResponse);
 });
+
+it("getUserAccountBalance", async () => {
+  const snaptrade = new Snaptrade({
+    consumerKey: process.env.SNAPTRADE_CONSUMER_KEY,
+    clientId: process.env.SNAPTRADE_CLIENT_ID,
+  });
+  const userId = process.env.SNAPTRADE_TEST_USER_ID;
+  const userSecret = process.env.SNAPTRADE_TEST_USER_SECRET;
+  const accounts = await snaptrade.accountInformation.listUserAccounts({
+    userId,
+    userSecret,
+  });
+  console.log(accounts.data);
+  const response = await snaptrade.accountInformation.getUserAccountBalance({
+    accountId: accounts.data[0].id,
+    userId,
+    userSecret,
+  });
+  console.log(response.data);
+});
+
+it.skip("getOptionsChain", async () => {
+  const snaptrade = new Snaptrade({
+    consumerKey: process.env.SNAPTRADE_CONSUMER_KEY,
+    clientId: process.env.SNAPTRADE_CLIENT_ID,
+  });
+  const userId = process.env.SNAPTRADE_TEST_USER_ID;
+  const userSecret = process.env.SNAPTRADE_TEST_USER_SECRET;
+  const accounts = await snaptrade.accountInformation.listUserAccounts({
+    userId,
+    userSecret,
+  });
+  console.log(accounts.data);
+  const accountId = accounts.data[0].id;
+  const symbols = await snaptrade.referenceData.getSymbols({
+    requestBody: { substring: "apple" },
+  });
+  console.log(symbols);
+  const symbol = symbols.data[0].id;
+  console.log(symbol);
+  const response = await snaptrade.options.getOptionsChain({
+    accountId,
+    userId,
+    userSecret,
+    symbol,
+  });
+  console.log(response.data);
+});

package/index.ts

@@ -7,12 +7,12 @@
  * The version of the OpenAPI document: 1.0.0
  * Contact: api@snaptrade.com
  *
- * NOTE: This class is auto generated by Konfig (https://konfigthis.com).
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
  * https://konfigthis.com
  * Do not edit the class manually.
  */
 
-
 export * from "./api";
 export * from "./configuration";
-
+export * from "./models";
+export * from "./client";

package/models/account-holdings.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 { Balance } from './balance';
+// May contain unused imports in some cases
+// @ts-ignore
+import { Position } from './position';
+// May contain unused imports in some cases
+// @ts-ignore
+import { SnapTradeHoldingsAccount } from './snap-trade-holdings-account';
+// May contain unused imports in some cases
+// @ts-ignore
+import { SnapTradeHoldingsTotalValue } from './snap-trade-holdings-total-value';
+
+/**
+ * Account Holdings
+ * @export
+ * @interface AccountHoldings
+ */
+export interface AccountHoldings {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {SnapTradeHoldingsAccount}
+     * @memberof AccountHoldings
+     */
+    'account'?: SnapTradeHoldingsAccount;
+    /**
+     * 
+     * @type {Array<Balance>}
+     * @memberof AccountHoldings
+     */
+    'balances'?: Array<Balance>;
+    /**
+     * 
+     * @type {Array<Position>}
+     * @memberof AccountHoldings
+     */
+    'positions'?: Array<Position>;
+    /**
+     * 
+     * @type {SnapTradeHoldingsTotalValue}
+     * @memberof AccountHoldings
+     */
+    'total_value'?: SnapTradeHoldingsTotalValue;
+}
+

package/models/account-order-record-status.ts

@@ -0,0 +1,48 @@
+/* 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
+ * @enum {string}
+ */
+
+export const AccountOrderRecordStatus = {
+    None: 'NONE',
+    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 AccountOrderRecordStatus = typeof AccountOrderRecordStatus[keyof typeof AccountOrderRecordStatus];
+
+
+

package/models/account-order-record.ts

@@ -0,0 +1,142 @@
+/* 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 { AccountOrderRecordStatus } from './account-order-record-status';
+// May contain unused imports in some cases
+// @ts-ignore
+import { Action } from './action';
+// May contain unused imports in some cases
+// @ts-ignore
+import { OrderType } from './order-type';
+// May contain unused imports in some cases
+// @ts-ignore
+import { TimeInForce } from './time-in-force';
+// May contain unused imports in some cases
+// @ts-ignore
+import { UniversalSymbol } from './universal-symbol';
+
+/**
+ * Record of order in brokerageaccount
+ * @export
+ * @interface AccountOrderRecord
+ */
+export interface AccountOrderRecord {
+    [key: string]: any;
+
+    /**
+     * Order id returned by brokerage
+     * @type {string}
+     * @memberof AccountOrderRecord
+     */
+    'brokerage_order_id'?: string;
+    /**
+     * 
+     * @type {AccountOrderRecordStatus}
+     * @memberof AccountOrderRecord
+     */
+    'status'?: AccountOrderRecordStatus;
+    /**
+     * 
+     * @type {string}
+     * @memberof AccountOrderRecord
+     */
+    'symbol'?: string;
+    /**
+     * 
+     * @type {UniversalSymbol}
+     * @memberof AccountOrderRecord
+     */
+    'universal_symbol'?: UniversalSymbol;
+    /**
+     * 
+     * @type {Action}
+     * @memberof AccountOrderRecord
+     */
+    'action'?: Action;
+    /**
+     * Trade Units
+     * @type {number}
+     * @memberof AccountOrderRecord
+     */
+    'total_quantity'?: number;
+    /**
+     * Trade Units
+     * @type {number}
+     * @memberof AccountOrderRecord
+     */
+    'open_quantity'?: number;
+    /**
+     * Trade Units
+     * @type {number}
+     * @memberof AccountOrderRecord
+     */
+    'canceled_quantity'?: number;
+    /**
+     * Trade Units
+     * @type {number}
+     * @memberof AccountOrderRecord
+     */
+    'filled_quantity'?: number;
+    /**
+     * Trade Price if limit or stop limit order
+     * @type {number}
+     * @memberof AccountOrderRecord
+     */
+    'execution_price'?: number;
+    /**
+     * Trade Price if limit or stop limit order
+     * @type {number}
+     * @memberof AccountOrderRecord
+     */
+    'limit_price'?: number;
+    /**
+     * Trade Price if limit or stop limit order
+     * @type {number}
+     * @memberof AccountOrderRecord
+     */
+    'stop_price'?: number;
+    /**
+     * 
+     * @type {OrderType}
+     * @memberof AccountOrderRecord
+     */
+    'order_type'?: OrderType;
+    /**
+     * 
+     * @type {TimeInForce}
+     * @memberof AccountOrderRecord
+     */
+    'time_in_force'?: TimeInForce;
+    /**
+     * Time
+     * @type {string}
+     * @memberof AccountOrderRecord
+     */
+    'time_placed'?: string;
+    /**
+     * Time
+     * @type {string}
+     * @memberof AccountOrderRecord
+     */
+    'time_updated'?: string;
+    /**
+     * Time
+     * @type {string}
+     * @memberof AccountOrderRecord
+     */
+    'expiry_date'?: string;
+}
+

package/models/account-simple.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.
+ */
+
+
+/**
+ * SnapTradeUser Investment Account
+ * @export
+ * @interface AccountSimple
+ */
+export interface AccountSimple {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof AccountSimple
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AccountSimple
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AccountSimple
+     */
+    'number'?: string;
+}
+

package/models/account.ts

@@ -0,0 +1,82 @@
+/* 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 { CashRestriction } from './cash-restriction';
+
+/**
+ * SnapTradeUser Investment Account
+ * @export
+ * @interface Account
+ */
+export interface Account {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof Account
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Account
+     */
+    'brokerage_authorization'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Account
+     */
+    'portfolio_group'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Account
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Account
+     */
+    'number'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Account
+     */
+    'institution_name'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Account
+     */
+    'created_date'?: string;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof Account
+     */
+    'meta'?: { [key: string]: any; };
+    /**
+     * 
+     * @type {Array<CashRestriction>}
+     * @memberof Account
+     */
+    'cash_restrictions'?: Array<CashRestriction>;
+}
+

package/models/action.ts

@@ -0,0 +1,30 @@
+/* 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 Action
+ * @export
+ * @enum {string}
+ */
+
+export const Action = {
+    Buy: 'BUY',
+    Sell: 'SELL'
+} as const;
+
+export type Action = typeof Action[keyof typeof Action];
+
+
+