Files
OpenBB/website/content/terminal/reference/stocks/options/binom.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

61 lines
1.6 KiB
Markdown
Vendored

---
title: binom
description: This page is an in-depth guide to using the binom function for binomial
option valuation. It details the usage, parameters, and provides examples to assist
users.
keywords:
- binom
- option valuation
- binomial option
- Strike price
- put value
- European option
- American option
- export excel
- plot values
- volatility
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="stocks/options/binom - Reference | OpenBB Terminal Docs" />
Gives the option value using binomial option valuation
### Usage
```python
binom [-s STRIKE] [-p] [-e] [-x] [--plot] [-v VOLATILITY]
```
---
## Parameters
| Name | Description | Default | Optional | Choices |
| ---- | ----------- | ------- | -------- | ------- |
| strike | Strike price for option shown | 0 | True | None |
| put | Value a put instead of a call | False | True | None |
| europe | Value a European option instead of an American one | False | True | None |
| export | Export an excel spreadsheet with binomial pricing data | False | True | None |
| plot | Plot expected ending values | False | True | None |
| volatility | Underlying asset annualized volatility. Historical volatility used if not supplied. | None | True | None |
---
## Examples
```python
2022 Feb 16, 08:40 (🦋) /stocks/options/ $ binom -s 3100 -e --plot
AMZN call at $3100.00 expiring on 2022-03-25 is worth $136.85
2022 Feb 16, 08:41 (🦋) /stocks/options/ $ binom -s 3500 -p --plot
AMZN put at $3500.00 expiring on 2022-03-25 is worth $389.72
```
![binom](https://user-images.githubusercontent.com/46355364/154276789-b6786517-3bea-4aa7-9d2e-e6669dd82587.png)
---