snaptrade-typescript-sdk

v9.0.166

Published

3 days ago

Client for SnapTrade

0High
0Medium
0Low

tma

snaptrade-ops

dphuang2

konfig-publisher

axios typescript konfig snaptrade-typescript-sdk

SnapTrade

Connect brokerage accounts to your app for live positions and trading

Installation

npm i snaptrade-typescript-sdk

pnpm i snaptrade-typescript-sdk

yarn add snaptrade-typescript-sdk

Getting Started

const { Snaptrade } = require("snaptrade-typescript-sdk");

async function main() {
  // 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);
}

// Should be replaced with function to get user ID
function getUserId() {
  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);
  });
}

main();

Reference

`snaptrade.accountInformation.getAccountActivities`

Returns all historical transactions for the specified account.

This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options.

Transaction are returned in reverse chronological order, using the trade_date field.

The data returned here is always cached and refreshed once a day.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see this guide on how to fix a disabled connection.

🛠️ Usage

const getAccountActivitiesResponse =
  await snaptrade.accountInformation.getAccountActivities({
    accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
    startDate: "2022-01-24",
    endDate: "2022-01-24",
    type: "BUY,SELL,DIVIDEND",
    userId: "snaptrade-user-123",
    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
  });

⚙️ Parameters

accountId: `string`

userId: `string`

userSecret: `string`

startDate: `string | Date`

The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on trade_date.

endDate: `string | Date`

The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on trade_date.

offset: `number`

An integer that specifies the starting point of the paginated results. Default is 0.

limit: `number`

An integer that specifies the maximum number of transactions to return. Default of 1000.

type: `string`

Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - BUY - Asset bought. - SELL - Asset sold. - DIVIDEND - Dividend payout. - CONTRIBUTION - Cash contribution. - WITHDRAWAL - Cash withdrawal. - REI - Dividend reinvestment. - STOCK_DIVIDEND - A type of dividend where a company distributes shares instead of cash - INTEREST - Interest deposited into the account. - FEE - Fee withdrawn from the account. - TAX - A tax related fee. - OPTIONEXPIRATION - Option expiration event. - OPTIONASSIGNMENT - Option assignment event. - OPTIONEXERCISE - Option exercise event. - TRANSFER - Transfer of assets from one account to another. - SPLIT - A stock share split.

🔄 Return

PaginatedUniversalActivity

🌐 Endpoint

/accounts/{accountId}/activities GET

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

SnapTrade

Table of Contents

Installation

Getting Started

Reference

snaptrade.accountInformation.getAccountActivities

🛠️ Usage

⚙️ Parameters

accountId: string

userId: string

userSecret: string

startDate: string | Date

endDate: string | Date

offset: number

limit: number

type: string

🔄 Return

🌐 Endpoint

snaptrade.accountInformation.getAllUserHoldings

🛠️ Usage

⚙️ Parameters

userId: string

userSecret: string

brokerageAuthorizations: string

🔄 Return

🌐 Endpoint

snaptrade.accountInformation.getUserAccountBalance

🛠️ Usage

⚙️ Parameters

userId: string

userSecret: string

accountId: string

🔄 Return

🌐 Endpoint

snaptrade.accountInformation.getUserAccountDetails

🛠️ Usage

⚙️ Parameters

userId: string

userSecret: string

accountId: string

🔄 Return

🌐 Endpoint

snaptrade.accountInformation.getUserAccountOrderDetail

🛠️ Usage

⚙️ Parameters

brokerage_order_id: string

accountId: string

userId: string

userSecret: string

🔄 Return

🌐 Endpoint

snaptrade.accountInformation.getUserAccountOrders

🛠️ Usage

⚙️ Parameters

userId: string

userSecret: string

accountId: string

state: 'all' | 'open' | 'executed'

days: number

🔄 Return

🌐 Endpoint

snaptrade.accountInformation.getUserAccountPositions

🛠️ Usage

⚙️ Parameters

userId: string

userSecret: string

accountId: string

🔄 Return

🌐 Endpoint

snaptrade.accountInformation.getUserAccountRecentOrders

🛠️ Usage

⚙️ Parameters

userId: string

userSecret: string

`snaptrade.accountInformation.getAccountActivities`

accountId: `string`

userId: `string`

userSecret: `string`

startDate: `string | Date`

endDate: `string | Date`

offset: `number`

limit: `number`

type: `string`

`snaptrade.accountInformation.getAllUserHoldings`

userId: `string`

userSecret: `string`

brokerageAuthorizations: `string`

`snaptrade.accountInformation.getUserAccountBalance`

userId: `string`

userSecret: `string`

accountId: `string`

`snaptrade.accountInformation.getUserAccountDetails`

userId: `string`

userSecret: `string`

accountId: `string`

`snaptrade.accountInformation.getUserAccountOrderDetail`

brokerage_order_id: `string`

accountId: `string`

userId: `string`

userSecret: `string`

`snaptrade.accountInformation.getUserAccountOrders`

userId: `string`

userSecret: `string`

accountId: `string`

state: `'all' | 'open' | 'executed'`

days: `number`

`snaptrade.accountInformation.getUserAccountPositions`

userId: `string`

userSecret: `string`

accountId: `string`

`snaptrade.accountInformation.getUserAccountRecentOrders`

userId: `string`

userSecret: `string`

accountId: `string`

onlyExecuted: `boolean`

`snaptrade.accountInformation.getUserAccountReturnRates`

userId: `string`

userSecret: `string`

accountId: `string`

`snaptrade.accountInformation.getUserHoldings`

accountId: `string`

userId: `string`

userSecret: `string`

`snaptrade.accountInformation.listUserAccounts`

userId: `string`

userSecret: `string`

`snaptrade.accountInformation.updateUserAccount`

userId: `string`

userSecret: `string`

accountId: `string`

`snaptrade.apiStatus.check`