jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 07:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/stocks/ba/redditsent.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

1.8 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
redditsent A documentation on redditsent function. It is used to find posts related to a specific search term from Reddit. The function provides comprehensive search and categorization of results based on user-preferences.
redditsent
Search function
Reddit posts
Behavioral analysis
Python function
Ticker symbol
post categorization
Comprehensive search
subreddits
dataframe
polarity scores
average polarity score

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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.