JSPM

  • Created
  • Published
  • Downloads 100
  • Score
    100M100P100Q71244F

node.js client for 1broker.com api

Package Exports

  • 1broker-client

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (1broker-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

1broker-client

A very simple 1broker api client, in case you have any suggestions or problems get in touch through github issues.

installing

npm install --save 1broker-client

Unfortunately new versions might break backwards compatibility so please make sure you specify a version on your package.json file.

Examples:

All functions take "callback" as last parameter:

OneBroker = require( "1broker-client" )

client = OneBroker( "YOU_API_KEY" )

client.account_overview( function( error, overview ) {
  if( error ) return console.error( error );

  console.log( overview );
} );

Functions which need parameters will take them as object, for instance:

client.market_quotes({
  symbols: "BTCUSD,GOLD"
}, function( error, quotes ) {
  console.log( quotes );
});

All methods from the API have been implemented

client.account_bitcoin_deposit_address( callback )
client.account_info( callback )
client.account_overview( callback )

client.market_detail( params, callback )
client.market_get_bars( params, callback )
client.market_list( callback )
client.market_quotes( params, callback )

client.order_cancel( params, callback )
client.order_create( params, callback )
client.order_list_open( params, callback )

client.position_edit( params, callback )
client.position_list_history( params, callback )
client.position_list_open( params, callback )

For full API documentation please refer to the Official API

TODO

  • Simple implementation
  • Tests
  • Parameters validation
  • Examples
  • Extra methods ( long, short, close, reverse, [...] )
  • Please create an issue if you think something else is needed

Contributing

The source code is also pretty simple and self explainatory so feel free to edit and submit a pull request.

In case you find an issue, have a request or recommendation feel free to open an issue, it will be highly appreciated.

You can also donate to support this library and more freebies!

Thank You!

Disclaimer

  • By default when creating an order this library will use my referral_id, which is a means i'll receive a small amount of BTC from 1broker! It would be great if you could keep it this way!

  • 1broker links on this documentation also constains my referral link