mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-10 03:12:26 +00:00
2754be2620
* Improve overall docusaurus * update pypi on installation * fix merge conflicts * fix spelling * change CRLF to LF * improve docs installation for bot * more changes * few more * fix --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
38 lines
793 B
Markdown
Vendored
38 lines
793 B
Markdown
Vendored
---
|
|
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
|
|
title: vsurf
|
|
description: OpenBB Telegram Command
|
|
---
|
|
|
|
# vsurf
|
|
|
|
This command allows the user to retrieve an options volatility surface for the ticker symbol. Specifically, it will provide a surface based on implied volatilities calculated from options prices, indicating the relationship between the stock price and the implied volatility of options on the stock.
|
|
|
|
### Usage
|
|
|
|
```python wordwrap
|
|
/vsurf ticker z
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Optional | Choices |
|
|
| ---- | ----------- | -------- | ------- |
|
|
| ticker | Stock Ticker | False | None |
|
|
| z | iv: Volatility oi: Open Interest lp: Last Price | False | iv, oi, lp |
|
|
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```
|
|
/vsurf AMD iv
|
|
```
|
|
```
|
|
/vsurf AMD oi
|
|
```
|
|
---
|