npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript.Learn more »

ir-client

1.0.3 • Public • Published

Build Status Coverage Status Dependencies

Independent Reserve Wrapper

Typescript / Node wrapper for the Data and Trading APIs offered by Independent Reserve

Setup

Install the dependancies with npm / yarn.

npm install ir-client --save

API Key

In order to utilise the private() method you'll need to generate an API Key.

Usage

The API wrapper exposes a Public and a Private method, which contain each of the endpoint functions.

Exposed Functions

Example

Examples for usage of each function can be found within the examples folder.

They can be run by the command line with ts-node.

npm install ts-node -g
ts-node examples/public/orderBook

A couple of simple examples are listed below.

import { IndependentReserve } from 'ir-client';
 
const ir = new IndependentReserve('public-key', 'private-key');
 
// Access Public API Methods
ir.public().GetMarketSummary('xbt', 'aud')
  .then(resp => {
    console.log(resp);
  });
 
/*
{
  DayHighestPrice: 10157.08,
  DayLowestPrice: 9800.1,
  DayAvgPrice: 9950.28,
  DayVolumeXbt: 29.02665049,
  DayVolumeXbtInSecondaryCurrrency: 28.29342014,
  CurrentLowestOfferPrice: 9993.1,
  CurrentHighestBidPrice: 9875.6,
  LastPrice: 9958.18,
  PrimaryCurrencyCode: 'Xbt',
  SecondaryCurrencyCode: 'Aud',
  CreatedTimestampUtc: '2018-05-26T07:10:09.6594524Z'
}
*/
 
// Access Private API Methods
ir.private().GetAccounts()
  .then(resp => {
    console.log(resp);
  });
 
/*
[
  {
    AccountGuid: '0a0578ba-60b4-11e8-9c2d-fa7ae01bbebc',
    AccountStatus: 'Active',
    AvailableBalance: 0,
    CurrencyCode: 'Aud',
    TotalBalance: 0
  },
  { AccountGuid: '0a057b62-60b4-11e8-9c2d-fa7ae01bbebc',
    AccountStatus: 'Active',
    AvailableBalance: 0,
    CurrencyCode: 'Usd',
    TotalBalance: 0
  },
  { AccountGuid: '0a057fae-60b4-11e8-9c2d-fa7ae01bbebc',
    AccountStatus: 'Active',
    AvailableBalance: 0,
    CurrencyCode: 'Nzd',
    TotalBalance: 0
  },
  { AccountGuid: '0a0581b6-60b4-11e8-9c2d-fa7ae01bbebc',
    AccountStatus: 'Active',
    AvailableBalance: 0,
    CurrencyCode: 'Xbt',
    TotalBalance: 0
  },
  { AccountGuid: '0a058300-60b4-11e8-9c2d-fa7ae01bbebc',
    AccountStatus: 'Active',
    AvailableBalance: 0,
    CurrencyCode: 'Eth',
    TotalBalance: 0
  },
  { AccountGuid: '20371896-60b4-11e8-9c2d-fa7ae01bbebc',
    AccountStatus: 'Active',
    AvailableBalance: 0,
    CurrencyCode: 'Bch',
    TotalBalance: 0
  },
  {
    AccountGuid: '20371bde-60b4-11e8-9c2d-fa7ae01bbebc',
    AccountStatus: 'Active',
    AvailableBalance: 0,
    CurrencyCode: 'Ltc',
    TotalBalance: 0
  }
]
*/

install

npm i ir-client

Downloadsweekly downloads

3

version

1.0.3

license

WTFPL

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability