jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-30 14:02:06 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/stocks/ba/redditsent.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.3 KiB
Vendored
Raw Blame History

title, description
title description
redditsent OpenBB SDK Function

redditsent

Finds posts related to a specific search term in Reddit.

Source Code: [link]

openbb.stocks.ba.redditsent(symbol: str, limit: int = 100, sortby: str = "relevance", time_frame: str = "week", full_search: bool = True, subreddits: str = "all")

Parameters

Name Type Description Default Optional
symbol str Ticker symbol to search for None False
limit int Number of posts to get per subreddit 100 True
sortby str Search type (Possibilities: "relevance", "hot", "top", "new", or "comments") relevance True
time_frame str Relative time of post (Possibilities: "hour", "day", "week", "month", "year", "all") week True
full_search bool Enable comprehensive search for ticker True True
subreddits str Comma-separated list of subreddits all True

Returns

Type Description
Dataframe of submissions related to the search term,
List of polarity scores,
Average polarity score.