Skip to content

AlvinTheDeveloper/wallstreetbets-scanner

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
data/symbols
data/symbols
 
 
demo
demo
 
 
tests
tests
 
 
utils
utils
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
index.js
index.js
 
 
package.json
package.json
 
 
yarn.lock
yarn.lock
 
 

Repository files navigation

wallstreetbets-scanner

The wallstreetbets-scanner collects statistical data from Reddit (r/wallstreetbets). It tells us how many times do symbols (e.g. TSLA) occurs in x times of API calls, and how many times do different types of flairs were tagged to the posts.

Installation

Install dependencies with npm

npm i wallstreetbets-scanner --save

Or with yarn

yarn add wallstreetbets-scanner --save

Example

const wsbScanner=require('wallstreetbets-scanner')

wsbScanner({
    pages:10,
    retryOnError:true,
    retryTimes:3,
    retryAfter:3,
    hideIfNotMentioned:true,
    sortMethod:"new",
    symbols:["XPEV"]
})
    .then(data=>{
        fs.writeFileSync('output.json',JSON.stringify(data,null,2))
    })

Sample output

{
"MVIS": {
    "occurrence_count": 1336,
        "flair": {
            "News": 85,
            "Discussion": 657,
            "Meme": 58,
            "Mods": 4,
            "Gain": 132,
            "DD": 126,
            "YOLO": 201,
            "Loss": 15,
            "Chart": 18,
            "Daily Discussion": 3
        }
    }
}

Options

Option name Type Description Default value
pages number Number of page the scanner is going to fetch. 100
retryOnError boolean If "retryOnError" is set to "true", the scanner will call the API again if an error occurs. If will not retryOnError is set to "false". true
retryTimes number Maximum attempt to re-run the API call on error occurs. 3
retryAfter number Number of seconds to wait for re-run the API call after error occurs. 3
hideIfNotMentioned boolean Hide the result of a stock if occurrence_count=0. true
sortMethod string Reddit sorting method you want to use. hot
symbols array An array of symbol string you want to filter. []

About

This script collects statistical data from Reddit (r/wallstreetbets). It tells us how many times do symbols (e.g. TSLA) occurs in x times of API calls, and how many times do different types of flairs were tagged to the posts.

Topics

reddit gme wallstreetbets

Resources

Readme

License

MIT license
Activity

Stars

1 star

Watchers

1 watching

Forks

0 forks
Report repository

Releases 1

Initial release Latest
Jan 28, 2021

Packages

 
 
 

Contributors 1

Languages