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
A node.js wrapper for 1broker api client.
Implements all API methods, also implements % Stop Loss and Take Profit when creating Market or Limit orders.
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.
Basics:
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
EXAMPLES
Simple examples are provided on the /examples folder, including the % Stop Loss and Take Profit syntax
I'm also developing extra functions, called "helpers" which will hopefully simplify the implementation of mechanical tasks.
TODO
- Simple implementation
- Examples
- Extra methods ( long, short, close, reverse, [...] )
- Documentation
- Tests
- Parameters validation
- Please create an issue if you need something else
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!
Feel free to send me a message on reddit, I'm flyingunicorn222
Thank You!