Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Commit

Permalink
updating docs and contributors list
Browse files Browse the repository at this point in the history
  • Loading branch information
aurbano committed Sep 19, 2018
1 parent 344dbfb commit 5b03545
Showing 1 changed file with 34 additions and 24 deletions.
58 changes: 34 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,35 @@ $ npm install robinhood --save

To authenticate, you can either use your username and password to the Robinhood app or a previously authenticated Robinhood api token:

### Robinhood API Auth Token
```js
//A previously authenticated Robinhood API auth token

var credentials = {
token: ''
};
```

```js
var Robinhood = require('robinhood')(credentials, function(){

//Robinhood is connected and you may begin sending commands to the api.

Robinhood.quote_data('GOOG', function(error, response, body) {
if (error) {
console.error(error);
process.exit(1);
}
console.log(body);
});

});
```

### Username & Password

This type of login may have been deprecated in favor of the API Token above.

```js
//The username and password you use to sign into the robinhood app.

Expand All @@ -80,6 +108,10 @@ var credentials = {
```

### MFA code

Since the addition of the API Auth Token login, MFA may not work anymore. If you have any information regarding
this please open an issue to discuss it.

```js

var Robinhood = robinhood({
Expand All @@ -99,30 +131,7 @@ var Robinhood = robinhood({
})
```

### Robinhood API Auth Token
```js
//A previously authenticated Robinhood API auth token

var credentials = {
token: ''
};
```

```js
var Robinhood = require('robinhood')(credentials, function(){

//Robinhood is connected and you may begin sending commands to the api.

Robinhood.quote_data('GOOG', function(error, response, body) {
if (error) {
console.error(error);
process.exit(1);
}
console.log(body);
});

});
```

## API

Expand Down Expand Up @@ -885,6 +894,7 @@ Alejandro U. Alvarez ([@aurbano](https://github.com/aurbano))
* Jason Truluck ([@jasontruluck](https://github.com/jasontruluck))
* Matthew Herron ([@swimclan](https://github.com/swimclan))
* Chris Dituri ([@cdituri](https://github.com/cdituri))
* John Murphy ([@chiefsmurph](https://github.com/chiefsmurph))

------------------

Expand All @@ -901,4 +911,4 @@ Alejandro U. Alvarez ([@aurbano](https://github.com/aurbano))


## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Faurbano%2Frobinhood-node.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Faurbano%2Frobinhood-node?ref=badge_large)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Faurbano%2Frobinhood-node.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Faurbano%2Frobinhood-node?ref=badge_large)

0 comments on commit 5b03545

Please sign in to comment.