Metadata-Version: 2.4
Name: nubra_oi_walls
Version: 0.1.0
Summary: Options wall proximity scanner built on top of the Nubra Python SDK.
Keywords: nubra,options,open-interest,wall,scanner
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
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
Requires-Dist: nubra-sdk>=0.3.8
Provides-Extra: pretty
Requires-Dist: tabulate>=0.9; extra == "pretty"

# nubra_oi_walls

`nubra_oi_walls` packages the options wall proximity scanner as a reusable Python library on top of the official Nubra Python SDK.

## Install

```bash
python -m pip install nubra_oi_walls
```

For prettier terminal tables, you can also install:

```bash
python -m pip install "nubra_oi_walls[pretty]"
```

## Usage

```python
from nubra_oi_walls import print_results, print_wall_detail, run_wall_proximity_scan

STOCKS = [
    "NIFTY",
    "BANKNIFTY",
    "RELIANCE",
    "HDFCBANK",
]

results = run_wall_proximity_scan(
    stocks=STOCKS,
    mode="oi",
    normalize=False,
    min_wall_oi=500_000,
    top_n=1,
    exchange="NSE",
)

print_results(results)
print_wall_detail(results)
```

## Authentication and environment

The package initializes the Nubra SDK with `env_creds=True`, so your Nubra credentials should be available the same way the official SDK expects them.

The scanner defaults to the Nubra `UAT` environment. To switch to live usage, set:

```powershell
$env:NUBRA_OI_WALLS_ENV = "PROD"
```

## Import shape

```python
from nubra_oi_walls import run_wall_proximity_scan
```

## Returned data

`run_wall_proximity_scan(...)` returns a list of dictionaries sorted by `proximity_pct` ascending. Each item includes the symbol, price, call wall, put wall, dominant wall, wall OI, bias, and expiry.
