Metadata-Version: 2.4
Name: oxinion-finance
Version: 0.1.0
Summary: Python client for the Oxinion Finance API — live stock signals, quotes, fundamentals, and market indicators.
Project-URL: Homepage, https://github.com/oxinion/oxinion-finance-js
Project-URL: Repository, https://github.com/oxinion/oxinion-finance-js
Project-URL: Issues, https://github.com/oxinion/oxinion-finance-js/issues
Author-email: Brandon Ha <idevbrandon@gmail.com>
License: MIT
License-File: LICENSE
Keywords: api-client,fear-and-greed,finance,indicators,market,oxinion,quotes,rsi,sdk,stocks
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Office/Business :: Financial :: Investment
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# oxinion-finance (Python)

Python client for the **Oxinion Finance API** — live stock signals, quotes, fundamentals, and market indicators.

> ⚠️ **Early preview (v0.1.x).** The API surface and endpoints are still being finalized. Pin an exact version if you depend on it.

## Install

```bash
pip install oxinion-finance
```

## Usage

```python
from oxinion_finance import OxinionFinance

client = OxinionFinance(api_key="...")  # api_key optional for public endpoints

# Latest quote
quote = client.get_quote("AAPL")

# Oxinion signal: BUY / HOLD / SELL
signal = client.get_signal("AAPL")

# Fundamentals
fundamentals = client.get_fundamentals("AAPL")

# Market-wide indicators (Fear & Greed, RSI, VIX, DXY, ...)
indicators = client.get_market_indicators()
```

### Configuration

```python
OxinionFinance(
    api_key="...",                     # Bearer token, optional
    base_url="https://api.oxinion.com",  # override the API base URL
    timeout=30.0,                      # per-request timeout in seconds
)
```

### Error handling

Non-2xx responses raise `OxinionFinanceError`:

```python
from oxinion_finance import OxinionFinance, OxinionFinanceError

client = OxinionFinance()
try:
    client.get_quote("NOPE")
except OxinionFinanceError as err:
    print(err.status, err.body)
```

## Requirements

- Python **3.8+**
- No third-party runtime dependencies (uses the standard library only).

## License

[MIT](./LICENSE) © Brandon Ha / Oxinion
