flashalpha 1.2.0__tar.gz → 1.2.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {flashalpha-1.2.0 → flashalpha-1.2.2}/PKG-INFO +28 -15
- {flashalpha-1.2.0 → flashalpha-1.2.2}/README.md +393 -380
- {flashalpha-1.2.0 → flashalpha-1.2.2}/pyproject.toml +99 -99
- {flashalpha-1.2.0 → flashalpha-1.2.2}/src/flashalpha/__init__.py +557 -557
- {flashalpha-1.2.0 → flashalpha-1.2.2}/.gitignore +0 -0
- {flashalpha-1.2.0 → flashalpha-1.2.2}/LICENSE +0 -0
- {flashalpha-1.2.0 → flashalpha-1.2.2}/src/flashalpha/client.py +0 -0
- {flashalpha-1.2.0 → flashalpha-1.2.2}/src/flashalpha/exceptions.py +0 -0
- {flashalpha-1.2.0 → flashalpha-1.2.2}/src/flashalpha/types.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: flashalpha
|
|
3
|
-
Version: 1.2.
|
|
3
|
+
Version: 1.2.2
|
|
4
4
|
Summary: Python SDK for the FlashAlpha options analytics API — live options screener, gamma exposure (GEX), VRP, delta, vanna, charm, greeks, 0DTE analytics, volatility surfaces, and more.
|
|
5
5
|
Project-URL: Homepage, https://flashalpha.com
|
|
6
6
|
Project-URL: Documentation, https://flashalpha.com/docs
|
|
@@ -291,8 +291,8 @@ except RateLimitError as e:
|
|
|
291
291
|
|
|
292
292
|
| Plan | Daily Requests | Access |
|
|
293
293
|
|------|---------------|--------|
|
|
294
|
-
| **Free** | 5 | Stock quotes, GEX
|
|
295
|
-
| **Basic** |
|
|
294
|
+
| **Free** | 5 | Stock quotes, single-expiry GEX (equities), key levels, BSM greeks, IV, IV surface, stock summary, historical quotes, tickers, options meta |
|
|
295
|
+
| **Basic** | 250 | + DEX/VEX/CHEX by strike, max pain, ETF & index symbols (SPX, VIX, RUT, etc.) |
|
|
296
296
|
| **Growth** | 2,500 | + Exposure summary, narrative, 0DTE analytics, volatility analytics, option quotes, full-chain GEX, Kelly sizing |
|
|
297
297
|
| **Alpha** | Unlimited | + Advanced volatility (SVI, variance surfaces, arbitrage detection, greeks surfaces, variance swap) |
|
|
298
298
|
|
|
@@ -303,9 +303,9 @@ Get your API key at **[flashalpha.com](https://flashalpha.com)**
|
|
|
303
303
|
| Method | Endpoint | Plan |
|
|
304
304
|
|--------|----------|------|
|
|
305
305
|
| `fa.gex(symbol)` | Gamma exposure by strike | Free+ |
|
|
306
|
-
| `fa.dex(symbol)` | Delta exposure by strike |
|
|
307
|
-
| `fa.vex(symbol)` | Vanna exposure by strike |
|
|
308
|
-
| `fa.chex(symbol)` | Charm exposure by strike |
|
|
306
|
+
| `fa.dex(symbol)` | Delta exposure by strike | Basic+ |
|
|
307
|
+
| `fa.vex(symbol)` | Vanna exposure by strike | Basic+ |
|
|
308
|
+
| `fa.chex(symbol)` | Charm exposure by strike | Basic+ |
|
|
309
309
|
| `fa.exposure_levels(symbol)` | Key levels (gamma flip, walls, max pain) | Free+ |
|
|
310
310
|
| `fa.exposure_summary(symbol)` | Full exposure summary with hedging | Growth+ |
|
|
311
311
|
| `fa.narrative(symbol)` | AI narrative analysis | Growth+ |
|
|
@@ -319,7 +319,7 @@ Get your API key at **[flashalpha.com](https://flashalpha.com)**
|
|
|
319
319
|
| `fa.greeks(...)` | BSM greeks (1st, 2nd, 3rd order) | Free+ |
|
|
320
320
|
| `fa.iv(...)` | Implied volatility solver | Free+ |
|
|
321
321
|
| `fa.kelly(...)` | Kelly criterion sizing | Growth+ |
|
|
322
|
-
| `fa.max_pain(symbol)` | Max pain analysis with dealer alignment, pain curve, pin probability |
|
|
322
|
+
| `fa.max_pain(symbol)` | Max pain analysis with dealer alignment, pain curve, pin probability | Basic+ |
|
|
323
323
|
| `fa.screener(...)` | **Live options screener** — filter/rank by GEX, VRP, IV, greeks, formulas | Growth+ |
|
|
324
324
|
| `fa.volatility(symbol)` | Comprehensive volatility analytics | Growth+ |
|
|
325
325
|
| `fa.adv_volatility(symbol)` | SVI, variance surface, arb detection | Alpha+ |
|
|
@@ -373,6 +373,17 @@ Get your API key at **[flashalpha.com](https://flashalpha.com)**
|
|
|
373
373
|
| `fa.structure_pnl(legs, ...)` | Multi-leg at-expiry P&L, breakevens, max P/L | Basic+ |
|
|
374
374
|
| `fa.structure_greeks(legs, spot=...)` | Aggregate multi-leg Black-Scholes greeks | Basic+ |
|
|
375
375
|
|
|
376
|
+
## Futures (CME equity-index)
|
|
377
|
+
|
|
378
|
+
FlashAlpha serves the full options-analytics stack for **CME equity-index futures** — **`ES=F`** (E-mini S&P 500) and **`NQ=F`** (E-mini Nasdaq-100). Options-on-futures are priced with **Black-76** (forward-priced) using the correct CME contract multipliers. Everything that works for an equity works for futures: gamma exposure (GEX), DEX, VEX, CHEX, key levels, max pain, the IV surface, exposure summary, narrative, and live flow.
|
|
379
|
+
|
|
380
|
+
```python
|
|
381
|
+
gex = fa.gex("ES=F") # Gamma exposure for the E-mini S&P 500 future
|
|
382
|
+
print(f"Net GEX: ${gex['net_gex']:,.0f}")
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
Use the `=F` suffix — bare `ES`/`NQ` are equities, not futures. In raw REST paths URL-encode the `=` as `%3D` (e.g. `GET /v1/exposure/gex/ES%3DF`); SDK methods take the plain string `"ES=F"`. Historical replay for futures is coming; live analytics are available now.
|
|
386
|
+
|
|
376
387
|
## Other SDKs
|
|
377
388
|
|
|
378
389
|
| Language | Package | Repository |
|
|
@@ -397,16 +408,18 @@ Get your API key at **[flashalpha.com](https://flashalpha.com)**
|
|
|
397
408
|
|
|
398
409
|
MIT
|
|
399
410
|
|
|
400
|
-
## What the
|
|
411
|
+
## What the paid tiers unlock
|
|
401
412
|
|
|
402
|
-
|
|
403
|
-
|
|
413
|
+
The free tier covers single-expiry GEX on equities, key levels, the BSM Greeks/IV
|
|
414
|
+
calculator and stock quotes. Paid tiers add:
|
|
404
415
|
|
|
405
|
-
- **
|
|
406
|
-
|
|
407
|
-
- **
|
|
408
|
-
|
|
409
|
-
|
|
416
|
+
- **DEX, VEX (vanna) and CHEX (charm) exposure, plus max pain** — from the **Basic tier**
|
|
417
|
+
($79/mo), with ETF and index symbols.
|
|
418
|
+
- **Full-chain GEX, 0DTE and flow analytics** — from the **Growth tier** ($299/mo).
|
|
419
|
+
- **Point-in-time replay since 2018, SVI vol surfaces, VRP analytics, higher-order Greeks**,
|
|
420
|
+
uncached and unlimited — the **Alpha tier** ($1,499/mo). FlashAlpha is one of the only
|
|
421
|
+
public APIs publishing aggregate vanna and charm exposure across the full universe, with
|
|
422
|
+
no look-ahead and no training-serving skew.
|
|
410
423
|
|
|
411
424
|
Built for quants, prop desks, and vol funds. See the full picture and get a key:
|
|
412
425
|
**[flashalpha.com/for-quant-teams](https://flashalpha.com/for-quant-teams?utm_source=github&utm_medium=readme&utm_campaign=repo-flashalpha-python)**
|