Skip to main content

Download options call/put data for any ticker in a trader friendly format

Project description

optionsview

This library downloads option chain data for a given symbol from yahoo finance.

The data includes Calls and Puts for all future expiration dates and strike prices.

There are two formats provided:

  • Straddle view: Call and Put data for the same expiration and strike is side by side.

  • Stacked view: Call and Put data is stacked together.

Installation

The library requires Python 3.7 or later.

To install, type the following command on the python terminal:

pip install optionsview

Implementation

Here is a basic example of how to download options straddle view data:

from options.data import download_options_view

download_options_view('TSLA')

The following is an example of downloading the Call and Put data in a stacked format.

from options.data import download_options_view, View

folder = 'C:\Users\work\Documents'
download_options_view('TSLA', View.STACKED, folder)

To read the data into dataframes (and not create files) you can do the following:

from options.data import get_options_view_df

straddle_df, stacked_df = get_options_view_df('TSLA')

print(straddle_df.head())
print(stacked_df.head())

Examples

The folder 'samples' in this repository, has some examples of the output from the library.

Contributions

Contributions are welcome, all modifications should come with appropriate tests.

All tests can be run by doing the following:

from testing.tests import run_all_tests
run_all_tests()

Acknowledgements

This project makes use of the yfinance library.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

optionsview-0.0.4.tar.gz (18.6 kB view details)

Uploaded Source

Built Distribution

optionsview-0.0.4-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

Details for the file optionsview-0.0.4.tar.gz.

File metadata

  • Download URL: optionsview-0.0.4.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for optionsview-0.0.4.tar.gz
Algorithm Hash digest
SHA256 767df0cc6ab2654649079465b8a30d00d1be5084956aefd9378efd8403531cf1
MD5 1912857691508c867c01a18ecc8532c5
BLAKE2b-256 3970e62772a982569277fedfc3caf5a73b77967a99714de8a8e249742e85d362

See more details on using hashes here.

File details

Details for the file optionsview-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: optionsview-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 20.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for optionsview-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d9d3dd967921973d97a727ccfc04db6099d5b3d98fa77b04707ed3324740d109
MD5 443e6b3d758f58275ee35b7b9c3c3e22
BLAKE2b-256 bd3d9cd4e42ad897a763d6bfb35c62f9717096bee6b8a32205d415c3068596df

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page