trading-post v1.3.8

Trading Post

NPM module for interacting with the trading-post. Can be used as a library and/or a CLI tool

Credentials

To obtain the information you'll need to build a credentials.json, you'll want to visit https://trading-post.club. After login, copy paste just the refresh_token into a credentials.json like so:

{
  "refresh_token": "i-made-this-up"
}

Both the library & CLI tool will automatically exchange the refresh_token for an access_token when necessary and cache it back in the credentials.json file.

CLI

Install

yarn global add trading-post

Example Usage

trading-post buy --quantity 100 goog

Library

Install

yarn add trading-post

Usage

const TradingPost = require('trading-post')
const tradingPost = new TradingPost({
  baseUrl: 'https://trading-post.club',
  credentialsFile: '/path/to/credentials.json',
})

tradingPost.getUser((error, user) => {
  if (error) throw error
  console.log(JSON.stringify(user))
  // =>
  // {
  //   "name": "Roy van de Water",
  //   "riches": 0,
  //   "stocks": [
  //     {
  //       "quantity": 0,
  //       "ticker": "goog"
  //     }
  //   ]
  // }

Functions

Constructor

const tradingPost  = new TradingPost({
  baseUrl: 'https://trading-post.club',
  credentialsFile: './credentials.json'
})

createBuyOrder

tradingPost.createBuyOrder({ quantity: 1, ticker: 'goog' }, (error, buyOrder) => {
  if (error) throw error
  console.log(JSON.stringify(buyOrder, null, 2))
  // =>
  // {
  //   "id": "8c5989bb-400f-4232-877b-86b5de7ff5bb",
  //   "price": 920.29,
  //   "quantity": 1,
  //   "ticker": "goog",
  //   "timestamp": "2017-09-16T14:02:33.907049934Z"
  // }
})

createSellOrder

tradingPost.createSellOrder({ quantity: 1, ticker: 'goog' }, (error, sellOrder) => {
  if (error) throw error
  console.log(JSON.stringify(buyOrder, null, 2))
  // =>
  // {
  //   "id": "e85d1724-2e84-48cc-8d4a-331f4fbd8477",
  //   "price": 920.29,
  //   "quantity": 1,
  //   "ticker": "goog",
  //   "timestamp": "2017-09-16T14:03:32.312353738Z"
  // }
})

getUser

tradingPost.getUser((error, user) => {
  if (error) throw error
  console.log(JSON.stringify(user, null, 2))
  // =>
  // {
  //   "name": "Roy van de Water",
  //   "riches": 0,
  //   "stocks": [
  //     {
  //       "quantity": 0,
  //       "ticker": "goog"
  //     }
  //   ]
  // }
})