cbfin 0.1.0

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

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

pip install cbfin

Quick Start

from cbfin import Client

client = Client(contact="[e-mail]")

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:

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.