Files
OpenBB/website/content/sdk/reference/stocks/options/unu.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
unu The documentation page provides details about the 'unu' command from openbb.stocks.options. It includes information on how to get unusual option activity data from fdscanner.com and display the unusual options table. It lists parameters, returns, and gives examples of usage.
stocks
options
unu
fdscanner.com
unusual option activity
dataframe
python code
parameters
returns
examples

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

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Get unusual option activity from fdscanner.com

Source Code: [link]

openbb.stocks.options.unu(limit: int = 100)

Parameters

Name Type Description Default Optional
limit int Number to show 100 True

Returns

Type Description
Tuple[pd.DataFrame, pd.Timestamp] Dataframe containing options information, Timestamp indicated when data was updated from website

Examples

from openbb_terminal.sdk import openbb
unu_df = openbb.stocks.options.unu()

Displays the unusual options table

Source Code: [link]

openbb.stocks.options.unu_chart(limit: int = 20, sortby: str = "Vol/OI", ascend: bool = False, calls_only: bool = False, puts_only: bool = False, export: str = "")

Parameters

Name Type Description Default Optional
limit int Number of rows to show 20 True
sortby str Data column to sort on Vol/OI True
ascend bool Whether to sort in ascend order False True
calls_only bool Flag to only show calls False True
puts_only bool Flag to show puts only False True
export str File type to export True

Returns

This function does not return anything