robinhood-node - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "robinhood-node",
-  "version": "1.0.0",
-  "main": "RobinhoodNode.js",
+  "version": "1.0.1",
+  "main": "index.js",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/sagivo/robinhood-node.git"
+    "url": "https://github.com/sagivo/robinhood-node"
   },
@@ -10,0 +10,0 @@ "author": "Sagiv Ofek",

readme.md

@@ -1,5 +0,63 @@
-#Robinhood node library
-
+# Robinhood node
 Trade stocks for free with simple to use library.  
-WIP
 
+## Install
+```
+yarn add robinhood-node
+```
+
+## Use
+```js
+const RH = require('robinhood-node');
+const rh = new RH({ user: 'RH user', password: 'RH password' });
+// get account
+const account = new rh.Account();
+console.log(await account.user);;
+// get stock quote
+const stock = new rh.Stock('AMZN');
+console.log(await stock.quote);
+const orderResponse = await stock.marketOrder('buy', 1);
+// check order and cancel
+const order = new rh.Order(orderResponse.id);
+console.log(order.status());
+order.cancel();
+```
+
+## Interface
+Each class can be initiated from a robinhood-node instance.  
+
+### RobinhoodNode
+This is the main class to use. You can use it in anonymous mode. Some actions like selling/buying will require to login as a Robinhood user. There are 2 ways to login into the library:  
+#### user & password (&mfa key):  
+```js
+new RH({ user: 'your RH email', password: 'your RH password', mfa: 12345 });
+```
+`mfa` is optional and required only if your settings on Robinhood require it. In order to get the mfa try to leave it empty and then you should get the code on your first attempt.  
+#### token:
+```js
+new RH({ token: 'your RH token' });
+```
+Once you login with username&password youu should get a token in reponse. this token can be used to access RH API from now on.
+
+
+### Stock
+`constructor(symbols)` - symbols of stocks seperated by comma.  
+[`quote`](https://github.com/sanko/Robinhood/blob/master/Quote.md#gather-quote-data-by-ticker-symbol) - get latest quote for symbol(s).  
+[`marketOrder(orderType, quantity, extraParams = {})`](https://github.com/sanko/Robinhood/blob/master/Order.md#place-an-order) - orderType - `buy` or `sell`.  
+[`limitOrder(orderType, quantity, price, extraParams = {})`](https://github.com/sanko/Robinhood/blob/master/Order.md#place-an-order) orderType - `buy` or `sell`.  
+
+### Order
+`constructor(id)` - optional order id.  
+[`status(id)`](https://github.com/sanko/Robinhood/blob/master/Order.md#gather-order-information) - get order status. order id is optional (can be set up when initiated).  
+[`cancel(id)`](https://github.com/sanko/Robinhood/blob/master/Order.md#cancel-an-order) - cancel an order. order id is optional (can be set up when initiated).  
+[`recent`](https://github.com/sanko/Robinhood/blob/master/Order.md#gather-recent-orders) - get recent orders.  
+[`static place(params)`](https://github.com/sanko/Robinhood/blob/master/Order.md#place-an-order) - manually place an order. a better use will be to interact with Stock class in order to place an order.  
+
+### Account
+`constructor()`  
+[`positions`](https://github.com/sanko/Robinhood/blob/master/Account.md#gather-account-positions)  
+[`accounts`](https://github.com/sanko/Robinhood/blob/master/Account.md#gather-list-of-accounts)  
+[`user`](https://github.com/sanko/Robinhood/blob/master/Account.md#gather-basic-user-info)  
+[`basicInfo`](https://github.com/sanko/Robinhood/blob/master/Account.md#gather-basic-information-about-the-account-holder)  
+[`investment`](https://github.com/sanko/Robinhood/blob/master/Account.md#gather-investment-profile-data-about-the-account-holder)  
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8387

increased by180.97%

Number of package files

8

increased by14.29%

Lines of code

175

increased by90.22%

Number of lines in readme file

64

increased by966.67%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes