A node.js wrapper for 1broker api client, this library is used by @telebroker_bot for telegram!
Implements all 1broker API methods and also a couple extra features:
- % Stop Loss and Take Profit when creating Market or Limit orders.
- Option to use "MAX", "HALF" or "QUARTER" as leverage, so it will dynamically adjust based on market MAX leverage.
All this functionality from this library is available through @telebroker_bot for telegram.
I also created a thread on reddit to speak about it, i'll hopefully keep improving the bot and keeping reddit up to date with the features.
Feel free to contact me there or open a new issue!
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.
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
Simple examples are provided on the /examples folder, including the % Stop Loss and Take Profit syntax.
Before running the examples you will need:
-
Api Token ( Create one in Settings )
-
Coffee-Script
npm install coffee-script --global
-
Download the example files
$ git clone https://github.com/flyingunicorn222/1broker-client.git
$ cd 1broker-client/
$ npm install
$ cd examples
- Edit _key file and add your key between the quotes
# examples/_key.coffee
module.exports ='YOUR_TOKEN_GOES_HERE'
Now you can run examples, for instance:
$coffee long_eurusd.coffee
or
$coffee short_btcusd.coffee
Examples source code is pretty simple, please go ahead an explore!
===
I'm also developing more extra functions, called "helpers" which will hopefully simplify the implementation of mechanical tasks.
- Simple implementation
- Examples
- Extra methods ( long, short, close, reverse, [...] )
- Documentation
- Tests
- Parameters validation
- Please create an issue if you need something else
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!
Feel free to send me a message on reddit, I'm flyingunicorn222
Thank You!