Files
OpenBB/website/content/terminal/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

2.3 KiB
Vendored

title, description, keywords
title description keywords
redditsent Discover how to use the redditsent function to perform sentiment analysis on Reddit about a specific ticker or company. Learn to adjust search parameters like sorting type, subreddits, post limit, time period, and more for a comprehensive Reddit search.
redditsent
sentiment analysis
Reddit
search sorting
company search
subreddits
posts limit
time period
full search
graphic display
table of sentiment values

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

Determine general Reddit sentiment about a ticker. [Source: Reddit]

Usage

redditsent [-s {relevance,hot,top,new,comments}] [-c COMPANY] [--subreddits SUBREDDITS] [-l LIMIT] [-t {hour,day,week,month,year,all}] [--full] [-g] [-d]

Parameters

Name Description Default Optional Choices
sort search sorting type relevance True relevance, hot, top, new, comments
company explicit name of company to search for, will override ticker symbol None True None
subreddits comma-separated list of subreddits to search all True None
limit how many posts to gather from each subreddit 10 True None
time time period to get posts from -- all, year, month, week, or day; defaults to week week True hour, day, week, month, year, all
full_search enable comprehensive search False True None
graphic display graphic True True None
display Print table of sentiment values False True None

Examples

txt
redditsent -c Google --subreddits tech,stocks --full
Searching through subreddits for posts.
100%|█████████████████████████████████████████████████████████████████████████| 2/2 [00:0100:00,  1.84it/s]
Analyzing each post...
100%|███████████████████████████████████████████████████████████████████████| 10/10 [00:0400:00,  2.07it/s]
Sentiment Analysis for Google is 0.7552