Metadata-Version: 2.1
Name: gvol
Version: 0.4.5
Summary: GVol is a Python library to access the GVol API
Home-page: https://github.com/genesis-volatility/gvol-py
Author: Denys Halenok
Author-email: denys.halenok@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: docs
Requires-Dist: gql[requests] (==3.0.0rc0)
Requires-Dist: sphinx (>=4.3.2,<5.0.0); extra == "docs"
Requires-Dist: sphinx-rtd-theme (>=1.0.0,<2.0.0); extra == "docs"
Requires-Dist: typing-extensions (>=4.0.1,<5.0.0); python_version >= "3.7" and python_version < "3.8"
Project-URL: Bug Tracker, https://github.com/genesis-volatility/gvol-py/issues
Project-URL: Documentation, https://gvol.readthedocs.io/
Project-URL: Repository, https://github.com/genesis-volatility/gvol-py
Description-Content-Type: text/markdown

# GVol

[![Latest Version](https://img.shields.io/pypi/v/gvol.svg)](https://pypi.org/project/gvol/)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/gvol.svg)](https://pypi.org/project/gvol/)
[![Main Workflow](https://github.com/genesis-volatility/gvol-py/actions/workflows/main.yml/badge.svg)](https://github.com/genesis-volatility/gvol-py/actions/workflows/main.yml)
[![Documentation Status](https://readthedocs.org/projects/gvol/badge/?version=latest)](https://gvol.readthedocs.io/en/latest/?badge=latest)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

GVol is a Python library to access the [GVol API](https://docs.gvol.io/).

---

**Documentation**: [https://gvol.readthedocs.io/en/latest/index.html](https://gvol.readthedocs.io/en/latest/index.html)

---

## Install

```bash
pip install gvol
```

## Demo

```python
from gvol import GVol
#Valid Headers: "x-oracle", "gvol-lite", "gvol-lite-plus"
gvol_client = GVol(header="gvol-lite", gvol_api_key="ENTER YOUR API KEY HERE")

options_orderbook = gvol_client.options_orderbook(
    symbol="BTC", exchange="deribit"
)

print(options_orderbook)
```

