Metadata-Version: 2.4
Name: optionspace
Version: 0.7.1
Summary: Python client for the OptionSpace options-volatility data API: fitted smiles, option chains, constant-maturity histories, rates, as pandas DataFrames
Author: Options Universe Inc
License-Expression: LicenseRef-Proprietary
Project-URL: Homepage, https://optionspace.ai
Project-URL: Documentation, https://optionspace.ai/docs.html
Project-URL: Terms of Service, https://optionspace.ai/terms
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Office/Business :: Financial :: Investment
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.28
Requires-Dist: pandas>=1.5
Requires-Dist: keyring>=25
Provides-Extra: charts
Requires-Dist: plotly>=5.18; extra == "charts"
Requires-Dist: kaleido>=0.2; extra == "charts"
Requires-Dist: numpy>=1.24; extra == "charts"
Requires-Dist: pandas_market_calendars>=5.3; extra == "charts"
Provides-Extra: movies
Requires-Dist: plotly>=5.18; extra == "movies"
Requires-Dist: kaleido>=0.2; extra == "movies"
Requires-Dist: numpy>=1.24; extra == "movies"
Provides-Extra: mcp
Requires-Dist: mcp>=2.0; extra == "mcp"
Requires-Dist: pandas_market_calendars>=5.3; extra == "mcp"
Provides-Extra: dev
Requires-Dist: pytest>=7; extra == "dev"
Requires-Dist: plotly>=5.18; extra == "dev"
Requires-Dist: kaleido>=0.2; extra == "dev"
Requires-Dist: numpy>=1.24; extra == "dev"
Requires-Dist: mcp>=2.0; extra == "dev"
Requires-Dist: pandas_market_calendars>=5.3; extra == "dev"
Dynamic: license-file

# OptionSpace

Python access to OptionSpace volatility data and research tools.

- Historical fitted volatility and Greeks
- Charts and session replays
- Optional local MCP tools for agent-assisted research

Data access requires an OptionSpace account and an API key. Available data
depends on your account's access.

## Install

Python 3.10 or newer, on Windows, macOS or Linux. The quickest way is
[uv](https://docs.astral.sh/uv/), a free Python installer: it sets up the right
Python for you, keeps this installation separate from your other projects, and
needs nothing activated.

Install uv once (skip if you have it), then open a new terminal:

```powershell
# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

```bash
# macOS or Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
```

Then, the same on every system:

```bash
mkdir optionspace-research
cd optionspace-research
uv init --bare --python 3.12
uv add "optionspace[charts,mcp]"
uv run optionspace --version
```

The extras are optional: `uv add optionspace` installs the data client alone,
`[charts]` adds charts and session replays, and `[mcp]` the local server for AI
clients.

**Prefer pip?** In a virtual environment: `python3 -m venv .venv` then
`.venv/bin/python -m pip install "optionspace[charts,mcp]"` on macOS and Linux, or
`py -m venv .venv` then `.venv\Scripts\python -m pip install "optionspace[charts,mcp]"`
on Windows; use that Python wherever this page says `uv run`.

## Quick start

Save your API key once (paste it when asked; it is not shown):

```bash
uv run optionspace login
```

It is kept in your operating system's credential store (Windows Credential
Manager, macOS Keychain, or the Secret Service on Linux).

Query a historical smile:

```python
import optionspace as osp

client = osp.Client()
smile = client.smile(
    "SPY",
    "2025-04-10",
    expiration="2025-04-17",
)
```

Usage is counted in API credits against your plan's daily allowance: a
lookup costs 1, a research call the server time it uses (pass
`estimate=True` to see the cost first, free). A slow research call runs as a
background job on the server; the client waits for it.
See [what a call costs](https://optionspace.ai/docs-api.html#costs).

To use OptionSpace from Claude Code, Claude Desktop or Cursor, run
`uv run optionspace mcp --print-config` and follow what it prints.

Documentation: [optionspace.ai/docs.html](https://optionspace.ai/docs.html).
Questions: [info@optionspace.ai](mailto:info@optionspace.ai).

Proprietary software. Copyright (c) 2026 Options Universe Inc. (d/b/a OptionSpace).
By installing or using this package you agree to the
[OptionSpace Terms of Service](https://optionspace.ai/terms). It works only with an
OptionSpace account and API key, and only with OptionSpace data. See the LICENSE file
for what you may and may not do.
