libbux

v0.2.7

Published

3 years ago

Un-official Javascript/Node.js library for BUX trading platform.

Downloads

0High
0Medium
0Low

tree

finance trading market

libBUX

Un-official Javascript/Node.js library for BUX trading platform. Let's rock the world of finance!

It uses official REST & WebSockets APIs which are used for a BUX mobile applications. For these APIs, there is no public documentation and thus no official support from the BUX team. Keep in mind that any change in the interface may (temporarily) break this library.

Current version: 0.2.7
This is EXPERIMENTAL version. Use at your own risk.

Installation

Requires Node.js v4.0 or higher.

$ npm install libbux

Getting Started

Example: Show my profits

Source: examples/minimal.js

// Load library and get api interface
var BUX = require('libbux');
var bux = BUX.api();

// Specify account details
var account = {
  email: '[email protected]',
  password: 'your_bux_password'
};

// Do login
bux.login(account, function(err, data) {
  if (err) throw err;

  // Here is your access_token, you can use it later
  console.log('Your access_token: '+data.access_token);

  // Get your portfolio
  bux.portfolio(function(err, data) {
    if (err) throw err;

    // Traverse portfolio and print your current products and profits
    for (var pos in data.positions) {
      var p = data.positions[pos];
      console.log('%s .. %s', p.product.displayName, p.profitAndLoss.amount);
    }
  });
});

BUX Functionality

Implemented

Authentication - Login
User - Profile, Friends, Notifications
Products - List, Search, Detail, Favorite, Alert
Trading - Open position, Close position, Alerts, Auto-Close
Trading Fees - List
Positions - List, Detail, History
Portfolio - Cash Balance, Performance
News - List
Social Feed - List, Activities
Groups - List, Feed, Un/Follow, Post, Detail
Battles - List, Feed, Post, Detail, Create
Real-time Data (WebSockets) - Un/Subscribe
Users - Detail, Search
Transactions - List
Pincode - Lock, Unlock, Reset

TODO

Products - Statistics
Battles - Invitations, Notifications
Groups - Post image, Delete image, Add member, Remove member, Change avatar
User - Settings, Invitations
Pincode - Create
Transactions - Deposit, Withdrawal

User Guide

Why Use It?

TODO

Authentication

var account = {
  email: '[email protected]',
  password: 'your_bux_password'
}

bux.login(function(err, auth) {

  // Grab your token (for store)
  var token = data.access_token;

  // Your authenticated requests
  // ...
});

If you have access_token then you can setup library directly:

// passed as config option
var bux = BUX.api({ access_token: 'MY_TOKEN' });

// or later
// TODO

Understanding Data

TODO

Making Trades

TODO

Configuration

BUX.api options:

server (string) - BUX API server address (default: "https://api.bux.com")
no_symbols (boolean) - Dont resolve Products Symbols (default: false)
access_token (string) - Access Token

Symbols

TODO

API Reference

`BUX` methods and constants

api (config) - Create API interface
symbols - Built-in symbols
version - libbux version

`BUX.api` instance methods

login (account, callback) - Login
me (callback) - Basic info about account
lock (callback) - Lock sensitive operations (seriousBUX only)
lockStatus (callback) - Get lock status (seriousBUX only)
lockReset (callback) - Reset your pincode via email (seriousBUX only)
unlock (pincode, callback) - Unlock with pincode (seriousBUX only)
balance (callback) - Cash balance
transactions (callback) - Cash transactions
profile (callback) - Your profile
friends (callback) - Friends list
users (query, callback) - Search user
user (userId, callback) - User profile
notifications (callback) - List of pending notifications
news (callback) - News articles
feed (callback) - Social feed
products (callback) - Products list
product (productId, callback) - Product detail
productSearch (query, callback) - Product search
productAlert (productId, amount, callback) - Set product alert
productAlertDelete (productId, callback) - Remove product alert
favorite (productId, callback) - Set product as favorite
favoriteDelete (productId, callback) - Remove product from favorites
fees (callback) - Trading fees
portfolio (callback) - Opened positions
position (positionId, callback) - Position detail
alert (positionId, options, callback) - Set position alert
alertDelete (positionId, callback) - Remove alert from position
autoclose (positionId, options, callback) - Set position autoclose
autocloseDelete (positionId, callback) - Remove autoclose from position
performance (callback) - Basic performance info
trades (callback) - Trading history
trade (tradeId, callback) - Detailed info about trade from history
open (trade, callback) - Open position
close (positionId, callback) - Close position
subscribe (eventsArray, callback, [onReady]) - Subscribe for Realtime data
subscribeProducts (productsArray, callback, [onReady]) - Subscribe for Product price changes
unsubscribe (eventsArray, callback) - Unsubscribe
groups (callback) - Your following/participating groups
groupsAllowed (callback) - Get number of allowed groups
group (groupId, callback) - Group details
groupFollow (groupId, callback) - Follow group
groupUnfollow (groupId, callback) - Un-Follow group
groupFeed (groupId, callback) - Group feed items
groupFeedCursor (groupId, callback) - Group feed cursor
groupFeedCursorUpdate (groupId, lastReadFeedItemId, callback) - Set last read feed item
groupFeedAdd (groupId, message, callback) - Post message to group
groupFeedDelete (groupId, messageId, callback) - Delete message
groupRole (groupId, callback) - User group role
groupMemberPortfolio (groupId, memberId, callback) - Group member portfolio
groupFollowersPreview (groupId, callback) - Group followers overview (only public groups)
groupSettings (groupId, settings, callback) - Update group settings (notifications)
battles (callback) - List of your battles
battlesAllowed (callback) - Get number of allowed battles
battle (battleId, callback) - Battle info
battleCreate (options, callback) - Create new battle
battleFeed (battleId, callback) - Battle feed
battleFeedAdd (battleId, message, callback) - Post message to battle
battleSettings (battleId, settings, callback) - Group settings
battleTemplates (callback) - Battle templates
activities (callback) - Get global activities
activitiesFollowed (callback) - Get your activities
convertStatus (callback) - Info about seriousBUX status

Internal methods

exec (method, endpoint, data, callback) - Execute BUX API call
getSymbols ()
setSymbols (symbolsObject)
findSymbolByProduct (productId)
getEndpointUrl (endpoint)

login (account, callback)

account object properties:

{
  email: '[email protected]',
  password: 'your_bux_password'
}

alert (positionId, options, callback)

autoclose (positionId, options, callback)

options object properties:

{
  "upperLimit": 0.8,     // 8%
  "lowerLimit": -0.10,   // -10%
}

open (trade, callback)

trade object properties:

{
  product: '@DAX',    // productId or symbol
  direction: 'BUY',   // BUY or SELL
  size: 1000,         // Trade amount 
  multiplier: 5
}

exec (method, endpoint, data, callback)

Short version for GET requests: exec (method, endpoint, callback)

Executes all raw BUX API calls. For more informations about BUX API endpoints, see endpoints.yaml file.

bux.exec('get', 'users/me', function(err, me) {
  console.log(me.nickname);
});

subscribe (eventsArray, callback)

Subscribe to Realtime data, for example:

bux.subscribe([ 'portfolio.performance' ], function(res, type, data) {
  console.log('Got message: type=%s, data=%s', type, data);
});

Available events:

performance
product.{securityId} - (for example product.sb33927)
position.opened
battle.created
battle.finished
group.followed
notification

groupSettings (groupId, settings, callback)

settings object properties:

{
  "muteUntil": 31536000000000
}

battleCreate (options, callback)

options object properties:

{
  "battleName": "Battle name",
  "orientation": "LOCAL",
  "templateId": "2"
}

Related Projects

bitbar-bux - BUX Plugin for BitBar, application for customizing OS X Menu Bar

TODO

documentation
tests

Authors

Jan Stránský <[email protected]>

Donate

If you make profits and this work make you happy, you can donate any amount to my Bitcoin address: 1P1swvi7Y6tTYBgxBszr71CG3fc67C2oBD

Licence

MIT

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

libBUX

Table of contents

Installation

Getting Started

Example: Show my profits

BUX Functionality

Implemented

TODO

User Guide

Why Use It?

Authentication

Understanding Data

Making Trades

Configuration

Symbols

API Reference

BUX methods and constants

BUX.api instance methods

Internal methods

login (account, callback)

alert (positionId, options, callback)

autoclose (positionId, options, callback)

open (trade, callback)

exec (method, endpoint, data, callback)

subscribe (eventsArray, callback)

groupSettings (groupId, settings, callback)

battleCreate (options, callback)

Related Projects

TODO

Authors

Donate

Licence

`BUX` methods and constants

`BUX.api` instance methods