snaptrade-typescript-sdk 8.7.0 → 8.8.0

package/docs/TransactionsAndReportingApi.md

@@ -1,144 +0,0 @@
-# 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**
-
-#### **GET** /activities
-
-### Description
-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 getActivitiesResponse =
-  await snaptrade.transactionsAndReporting.getActivities({
-    startDate: "2022-01-24",
-    endDate: "2022-01-24",
-    accounts:
-      "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
-    brokerageAuthorizations:
-      "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
-    userId: "John.doe@snaptrade.com",
-    userSecret: "USERSECRET123",
-  });
-
-console.log(getActivitiesResponse);
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **userId** | [**string**] |  | defaults to undefined
- **userSecret** | [**string**] |  | defaults to undefined
- **startDate** | [**string | Date**] |  | (optional) defaults to undefined
- **endDate** | [**string | Date**] |  | (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
- **brokerageAuthorizations** | [**string**] | Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations | (optional) defaults to undefined
-
-
-### Return type
-
-**Array<UniversalActivity>**
-
-### 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**
-
-#### **GET** /performance/custom
-
-### Description
-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 getReportingCustomRangeResponse =
-  await snaptrade.transactionsAndReporting.getReportingCustomRange({
-    startDate: "2022-01-24",
-    endDate: "2022-01-24",
-    accounts:
-      "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
-    detailed: true,
-    frequency: "monthly",
-    userId: "John.doe@snaptrade.com",
-    userSecret: "USERSECRET123",
-  });
-
-console.log(getReportingCustomRangeResponse);
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **startDate** | [**string | Date**] |  | defaults to undefined
- **endDate** | [**string | Date**] |  | 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**
-
-### 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,177 +0,0 @@
-import { Snaptrade } from "./index";
-
-function uuid() {
-  var d = new Date().getTime(); //Timestamp
-  var d2 =
-    (typeof performance !== "undefined" &&
-      performance.now &&
-      performance.now() * 1000) ||
-    0; //Time in microseconds since page-load or 0 if unsupported
-  return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function (c) {
-    var r = Math.random() * 16; //random number between 0 and 16
-    if (d > 0) {
-      //Use timestamp until depleted
-      r = (d + r) % 16 | 0;
-      d = Math.floor(d / 16);
-    } else {
-      //Use microseconds since page-load if supported
-      r = (d2 + r) % 16 | 0;
-      d2 = Math.floor(d2 / 16);
-    }
-    return (c === "x" ? r : (r & 0x3) | 0x8).toString(16);
-  });
-}
-
-it("getting started", async () => {
-  // 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 status = await snaptrade.apiStatus.check();
-  console.log("status:", status.data);
-
-  // 3) Create a new user on SnapTrade
-  const userId = uuid();
-  const { userSecret } = (
-    await snaptrade.authentication.registerSnapTradeUser({
-      userId,
-    })
-  ).data;
-
-  // Note: A user secret is only generated once. It's required to access
-  // resources for certain endpoints.
-  console.log("userSecret:", userSecret);
-
-  // 4) Get a redirect URI. Users will need this to connect
-  const data = (
-    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 holdings = (
-    await snaptrade.accountInformation.getAllUserHoldings({
-      userId,
-      userSecret,
-    })
-  ).data;
-  console.log("holdings:", holdings);
-
-  // 6) Deleting a user
-  const deleteResponse = (
-    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("getActivities", 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;
-  let activities = await snaptrade.transactionsAndReporting.getActivities({
-    userId,
-    userSecret,
-  });
-  console.log(activities.data);
-  expect(activities).not.toBeNull();
-  // create two variables "startDate" and "endDate" that are strings representing 1 year ago and today in yyyy-mm-dd format using today's date
-  const startDate = "2020-01-01";
-  const endDate = "2020-12-31";
-  activities = await snaptrade.transactionsAndReporting.getActivities({
-    userId,
-    userSecret,
-    startDate,
-    endDate,
-  });
-  console.log(activities.data);
-  expect(activities).not.toBeNull();
-  // create two variables "startDate" and "endDate" that are Date instances representing 1 year ago and today
-  const endDate2 = new Date();
-  // create variable startDate2 which is 1 year before endDate2
-  const startDate2 = new Date(endDate2);
-  startDate2.setFullYear(startDate2.getFullYear() - 1);
-  activities = await snaptrade.transactionsAndReporting.getActivities({
-    userId,
-    userSecret,
-    startDate: startDate2,
-    endDate: endDate2,
-  });
-  console.log(activities.data);
-  expect(activities).not.toBeNull();
-});
-
-it("getUserHoldings", 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,
-  });
-  const holdings = await snaptrade.accountInformation.getUserHoldings({
-    userId,
-    userSecret,
-    accountId: accounts.data[0].id,
-  });
-  // assert holdings is not null with jest
-  expect(holdings).not.toBeNull();
-  console.log(holdings.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({
-    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

@@ -1,18 +0,0 @@
-/* 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 * from "./api";
-export * from "./configuration";
-export * from "./models";
-export * from "./client";

package/jest.config.ts

@@ -1,11 +0,0 @@
-import type { Config } from "@jest/types";
-const config: Config.InitialOptions = {
-  verbose: true,
-  preset: "ts-jest",
-  testEnvironment: "node",
-  testPathIgnorePatterns: ["dist/"],
-  transform: {
-    "^.+\\.ts?$": ["ts-jest", { tsconfig: "./tsconfig.test.json" }],
-  },
-};
-export default config;

package/models/account-holdings-account.ts

@@ -1,61 +0,0 @@
-/* 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 { SnapTradeHoldingsAccountAccountId } from './snap-trade-holdings-account-account-id';
-// May contain unused imports in some cases
-// @ts-ignore
-import { SnapTradeHoldingsTotalValue } from './snap-trade-holdings-total-value';
-
-/**
- * Account Holdings with Account ID
- * @export
- * @interface AccountHoldingsAccount
- */
-export interface AccountHoldingsAccount {
-    [key: string]: any;
-
-    /**
-     * 
-     * @type {SnapTradeHoldingsAccountAccountId}
-     * @memberof AccountHoldingsAccount
-     */
-    'account'?: SnapTradeHoldingsAccountAccountId;
-    /**
-     * 
-     * @type {Array<Balance>}
-     * @memberof AccountHoldingsAccount
-     */
-    'balances'?: Array<Balance>;
-    /**
-     * 
-     * @type {Array<Position>}
-     * @memberof AccountHoldingsAccount
-     */
-    'positions'?: Array<Position>;
-    /**
-     * 
-     * @type {SnapTradeHoldingsTotalValue}
-     * @memberof AccountHoldingsAccount
-     */
-    'total_value'?: SnapTradeHoldingsTotalValue;
-}
-

package/models/account-holdings.ts

@@ -1,61 +0,0 @@
-/* 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

@@ -1,48 +0,0 @@
-/* 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

@@ -1,151 +0,0 @@
-/* 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 { OptionsSymbol } from './options-symbol';
-// 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 {OptionsSymbol}
-     * @memberof AccountOrderRecord
-     */
-    'option_symbol'?: OptionsSymbol;
-    /**
-     * 
-     * @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;
-}
-