mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 08:22:26 +00:00
4ad995fdd0
* 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>
45 lines
1.1 KiB
Markdown
Vendored
45 lines
1.1 KiB
Markdown
Vendored
---
|
|
title: vol
|
|
description: The 'vol' page provides command-line instructions for plotting volumes.
|
|
It deals with parameters like minimal and maximal strikes, calls, and puts. The
|
|
page is mainly focused on contracts traded today and the plotting of call or put
|
|
options only.
|
|
keywords:
|
|
- vol
|
|
- volume
|
|
- contracts traded
|
|
- plot volume
|
|
- min strike
|
|
- max strike
|
|
- calls
|
|
- puts
|
|
- options
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks/options/vol - Reference | OpenBB Terminal Docs" />
|
|
|
|
Plot volume. Volume refers to the number of contracts traded today.
|
|
|
|
### Usage
|
|
|
|
```python
|
|
vol [-m MIN] [-M MAX] [-c] [-p]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| min | Min strike to plot | -1 | True | None |
|
|
| max | Max strike to plot | -1 | True | None |
|
|
| calls | Flag to plot call options only | False | True | None |
|
|
| puts | Flag to plot put options only | False | True | None |
|
|
|
|
|
|
|
|
---
|