Metadata-Version: 2.4
Name: cbfin
Version: 0.1.0
Summary: Python SDK for the hosted cbfin Cboe market-data API.
Project-URL: Homepage, https://api.cbfin.bluedoor.sh/v1/health
Project-URL: API, https://api.cbfin.bluedoor.sh/v1/openapi.json
Project-URL: Documentation, https://github.com/bluedoor-ai/cbfin#readme
Project-URL: Source, https://github.com/bluedoor-ai/cbfin
Project-URL: Endpoint Catalog, https://api.cbfin.bluedoor.sh/v1/endpoints
Author-email: BlueDoor <sam@bluedoor.sh>
License: MIT
Keywords: cbfin,cboe,finance,futures,market-data,options
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: certifi>=2024.2.2
Description-Content-Type: text/markdown

# cbfin

Python SDK for the hosted cbfin Cboe market-data API.

The hosted API wraps Cboe public market-data routes behind a cached, rate-limited
REST surface. It is not affiliated with, endorsed by, or sponsored by Cboe.

## Install

```bash
pip install cbfin
```

## Quick Start

```python
from cbfin import Client

client = Client(contact="you@example.com")

quote = client.quote("AAPL")
chain = client.options_chain("AAPL")
vx = client.futures_data("VX")
share = client.options_market_share()
status = client.system_status()
```

Convenience wrappers are also available:

```python
import cbfin

data = cbfin.options_chain("AAPL")
```

The compatibility import path `cbfin_client` is also included.

## Common Methods

- `Client.health()`, `Client.endpoints()`, and `Client.openapi()` expose API
  discovery and status metadata.
- `Client.quote(symbol)`, `Client.options_chain(symbol)`,
  `Client.chart_intraday(symbol)`, `Client.chart_one_month(symbol)`, and
  `Client.chart_historical(symbol)` wrap Cboe delayed quote routes.
- `Client.futures_data(root_symbol)`, `Client.futures_quotes_combined()`, and
  settlement helpers wrap Cboe futures routes.
- `Client.options_market_share()` and `Client.options_most_active()` wrap Cboe
  options market statistics.
- `Client.get(path, params=...)` is available for any public cbfin route.

Set `CBFIN_BASE_URL`, `CBFIN_CONTACT`, or `CBFIN_API_KEY` in the environment to
configure the default client.
