flashalpha 0.3.2__tar.gz → 0.3.4__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.
Files changed (31) hide show
  1. {flashalpha-0.3.2 → flashalpha-0.3.4}/.claude/settings.json +2 -1
  2. flashalpha-0.3.4/CHANGELOG.md +58 -0
  3. flashalpha-0.3.4/CLAUDE.md +67 -0
  4. {flashalpha-0.3.2 → flashalpha-0.3.4}/PKG-INFO +2 -1
  5. {flashalpha-0.3.2 → flashalpha-0.3.4}/README.md +1 -0
  6. flashalpha-0.3.4/docs/api.md +2021 -0
  7. {flashalpha-0.3.2 → flashalpha-0.3.4}/pyproject.toml +1 -1
  8. flashalpha-0.3.4/src/flashalpha/__init__.py +54 -0
  9. {flashalpha-0.3.2 → flashalpha-0.3.4}/src/flashalpha/client.py +38 -3
  10. flashalpha-0.3.4/src/flashalpha/types.py +215 -0
  11. flashalpha-0.3.4/tests/test_integration.py +822 -0
  12. flashalpha-0.3.2/CHANGELOG.md +0 -28
  13. flashalpha-0.3.2/src/flashalpha/__init__.py +0 -22
  14. flashalpha-0.3.2/tests/test_integration.py +0 -353
  15. {flashalpha-0.3.2 → flashalpha-0.3.4}/.github/workflows/ci.yml +0 -0
  16. {flashalpha-0.3.2 → flashalpha-0.3.4}/.gitignore +0 -0
  17. {flashalpha-0.3.2 → flashalpha-0.3.4}/CONTRIBUTING.md +0 -0
  18. {flashalpha-0.3.2 → flashalpha-0.3.4}/LICENSE +0 -0
  19. {flashalpha-0.3.2 → flashalpha-0.3.4}/article-flashalpha-python-sdk.md +0 -0
  20. {flashalpha-0.3.2 → flashalpha-0.3.4}/awesome-investing/CODE_OF_CONDUCT.md +0 -0
  21. {flashalpha-0.3.2 → flashalpha-0.3.4}/awesome-investing/LICENSE +0 -0
  22. {flashalpha-0.3.2 → flashalpha-0.3.4}/awesome-investing/PULL_REQUEST_TEMPLATE.md +0 -0
  23. {flashalpha-0.3.2 → flashalpha-0.3.4}/awesome-investing/README.md +0 -0
  24. {flashalpha-0.3.2 → flashalpha-0.3.4}/awesome-investing/contributing.md +0 -0
  25. {flashalpha-0.3.2 → flashalpha-0.3.4}/awesome_investing/README.md +0 -0
  26. {flashalpha-0.3.2 → flashalpha-0.3.4}/awesome_investing/src/static/img/.gitkeep +0 -0
  27. {flashalpha-0.3.2 → flashalpha-0.3.4}/awesome_investing/src/static/img/markus-spiske-5gGcn2PRrtc-unsplash.jpg +0 -0
  28. {flashalpha-0.3.2 → flashalpha-0.3.4}/examples/quickstart.py +0 -0
  29. {flashalpha-0.3.2 → flashalpha-0.3.4}/src/flashalpha/exceptions.py +0 -0
  30. {flashalpha-0.3.2 → flashalpha-0.3.4}/tests/__init__.py +0 -0
  31. {flashalpha-0.3.2 → flashalpha-0.3.4}/tests/test_client.py +0 -0
@@ -45,7 +45,8 @@
45
45
  "Bash(npm config:*)",
46
46
  "Bash(export PATH=\"$PATH:/c/Program Files/Go/bin\")",
47
47
  "Bash(go test:*)",
48
- "Bash(FLASHALPHA_API_KEY=\"ejbe0oW5f4n7C7drEg7Ggo6bPtFuFpaLPmvmkDrE\" \"C:/Users/disea/tools/apache-maven-3.9.14/bin/mvn.cmd\" test -Dtest=\"IntegrationTest#testMaxPain*\")"
48
+ "Bash(FLASHALPHA_API_KEY=\"ejbe0oW5f4n7C7drEg7Ggo6bPtFuFpaLPmvmkDrE\" \"C:/Users/disea/tools/apache-maven-3.9.14/bin/mvn.cmd\" test -Dtest=\"IntegrationTest#testMaxPain*\")",
49
+ "Bash(grep -iE \"ejbe0oW5|oy2fcywr|npm_UsjzA|npm_7rHFG|WfdTfVm|ujxFMb|pypi-AgEI|fa_[a-zA-Z0-9]{20,}|FLASHALPHA_API_KEY=.{10,}\")"
49
50
  ],
50
51
  "additionalDirectories": [
51
52
  "C:\\Users\\disea"
@@ -0,0 +1,58 @@
1
+ # Changelog
2
+
3
+ ## Unreleased
4
+
5
+ ### Added
6
+ - `docs/api.md` — full endpoint reference, URL-prefix table, response schemas, and sample JSON for every endpoint (copied from flashalpha-api)
7
+ - 17 integration regression tests (`tests/test_integration.py`) guarding against response-shape and URL-pattern regressions reported by Alpha users:
8
+ - Nested VRP response (`vrp.z_score`, `gex_conditioned.harvest_score`, `regime.net_gex`, `directional.*`)
9
+ - `exposure_summary` nesting (`exposures.net_gex`)
10
+ - VRP directional field names (`downside_vrp`/`upside_vrp`, not `put_vrp`/`call_vrp`)
11
+ - URL-prefix mix — `/stockquote`, `/optionquote`, `/historical/*` without `/v1/`; everything else with
12
+ - `/v1/stock/{sym}/summary` canonical vs `/v1/summary/{sym}` 404
13
+ - Canonical `POST /v1/screener` + `/v1/screener/live` deprecation
14
+ - `/v1/vrp/{sym}` REST endpoint (until `vrp()` method ships)
15
+
16
+ ## 0.3.2 (2026-04-07)
17
+
18
+ ### Added
19
+ - `max_pain()` — max pain analysis with dealer alignment overlay, pain curve, OI breakdown, expected move context, pin probability, and multi-expiry calendar (Growth+)
20
+
21
+ ## 0.3.1 (2026-04-02)
22
+
23
+ ### Changed
24
+ - Screener endpoint renamed: `/v1/screener/live` → `/v1/screener` (canonical). The SDK's `screener()` method now POSTs to `/v1/screener`.
25
+
26
+ ## 0.3.0 (2026-03-30)
27
+
28
+ ### Added
29
+ - `screener()` — live options screener. Filter/rank symbols by gamma exposure, VRP, volatility, greeks, harvest scores, and custom formulas. Growth: 10-symbol universe, up to 10 rows. Alpha: ~250 symbols, up to 50 rows, formulas, and harvest/dealer-flow-risk scores.
30
+ - Recursive filter trees (leaf + `and`/`or` groups), cascading filters via `expiries.*` / `strikes.*` / `contracts.*` prefixes, multi-sort, pagination, inline and named formulas, `select=["*"]` for the full flat object.
31
+ - Unit + integration test coverage for screener filter tree, operators, formulas, and tier gating.
32
+
33
+ ## 0.2.0 (2026-03-26)
34
+
35
+ ### Added
36
+ - `zero_dte()` — real-time 0DTE analytics (regime, pin risk, expected move, hedging, decay)
37
+ - `exposure_history()` — daily exposure snapshots for trend analysis
38
+ - `adv_volatility()` — advanced volatility analytics (SVI parameters, variance surface, arbitrage detection, greeks surfaces, variance swap pricing)
39
+ - Comprehensive method reference table in README
40
+ - SEO-optimized keywords in PyPI metadata
41
+
42
+ ### Changed
43
+ - Updated API plans table to reflect current tiers (Free/Basic/Growth/Alpha)
44
+ - Improved README structure and documentation
45
+
46
+ ## 0.1.0 (2026-03-13)
47
+
48
+ ### Added
49
+ - Initial release
50
+ - Core client with all FlashAlpha API endpoints
51
+ - Exposure analytics: `gex()`, `dex()`, `vex()`, `chex()`, `exposure_levels()`, `exposure_summary()`, `narrative()`
52
+ - Market data: `stock_quote()`, `option_quote()`, `stock_summary()`, `surface()`
53
+ - Historical data: `historical_stock_quote()`, `historical_option_quote()`
54
+ - Pricing: `greeks()`, `iv()`, `kelly()`
55
+ - Volatility: `volatility()`
56
+ - Reference: `tickers()`, `options()`, `symbols()`, `account()`, `health()`
57
+ - Error handling: `AuthenticationError`, `TierRestrictedError`, `NotFoundError`, `RateLimitError`, `ServerError`
58
+ - 36 unit tests, 23 integration tests
@@ -0,0 +1,67 @@
1
+ # CLAUDE.md
2
+
3
+ Behavioral guidelines to reduce common LLM coding mistakes. Merge with project-specific instructions as needed.
4
+
5
+ **Tradeoff:** These guidelines bias toward caution over speed. For trivial tasks, use judgment.
6
+
7
+ ## 1. Think Before Coding
8
+
9
+ **Don't assume. Don't hide confusion. Surface tradeoffs.**
10
+
11
+ Before implementing:
12
+ - State your assumptions explicitly. If uncertain, ask.
13
+ - If multiple interpretations exist, present them - don't pick silently.
14
+ - If a simpler approach exists, say so. Push back when warranted.
15
+ - If something is unclear, stop. Name what's confusing. Ask.
16
+
17
+ ## 2. Simplicity First
18
+
19
+ **Minimum code that solves the problem. Nothing speculative.**
20
+
21
+ - No features beyond what was asked.
22
+ - No abstractions for single-use code.
23
+ - No "flexibility" or "configurability" that wasn't requested.
24
+ - No error handling for impossible scenarios.
25
+ - If you write 200 lines and it could be 50, rewrite it.
26
+
27
+ Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify.
28
+
29
+ ## 3. Surgical Changes
30
+
31
+ **Touch only what you must. Clean up only your own mess.**
32
+
33
+ When editing existing code:
34
+ - Don't "improve" adjacent code, comments, or formatting.
35
+ - Don't refactor things that aren't broken.
36
+ - Match existing style, even if you'd do it differently.
37
+ - If you notice unrelated dead code, mention it - don't delete it.
38
+
39
+ When your changes create orphans:
40
+ - Remove imports/variables/functions that YOUR changes made unused.
41
+ - Don't remove pre-existing dead code unless asked.
42
+
43
+ The test: Every changed line should trace directly to the user's request.
44
+
45
+ ## 4. Goal-Driven Execution
46
+
47
+ **Define success criteria. Loop until verified.**
48
+
49
+ Transform tasks into verifiable goals:
50
+ - "Add validation" → "Write tests for invalid inputs, then make them pass"
51
+ - "Fix the bug" → "Write a test that reproduces it, then make it pass"
52
+ - "Refactor X" → "Ensure tests pass before and after"
53
+
54
+ For multi-step tasks, state a brief plan:
55
+ ```
56
+ 1. [Step] → verify: [check]
57
+ 2. [Step] → verify: [check]
58
+ 3. [Step] → verify: [check]
59
+ ```
60
+
61
+ Strong success criteria let you loop independently. Weak criteria ("make it work") require constant clarification.
62
+
63
+ ---
64
+
65
+ **These guidelines are working if:** fewer unnecessary changes in diffs, fewer rewrites due to overcomplication, and clarifying questions come before implementation rather than after mistakes.
66
+
67
+ _Source: [forrestchang/andrej-karpathy-skills](https://github.com/forrestchang/andrej-karpathy-skills)_
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: flashalpha
3
- Version: 0.3.2
3
+ Version: 0.3.4
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
@@ -273,6 +273,7 @@ Get your API key at **[flashalpha.com](https://flashalpha.com)**
273
273
  | `fa.greeks(...)` | BSM greeks (1st, 2nd, 3rd order) | Free+ |
274
274
  | `fa.iv(...)` | Implied volatility solver | Free+ |
275
275
  | `fa.kelly(...)` | Kelly criterion sizing | Growth+ |
276
+ | `fa.max_pain(symbol)` | Max pain analysis with dealer alignment, pain curve, pin probability | Growth+ |
276
277
  | `fa.screener(...)` | **Live options screener** — filter/rank by GEX, VRP, IV, greeks, formulas | Growth+ |
277
278
  | `fa.volatility(symbol)` | Comprehensive volatility analytics | Growth+ |
278
279
  | `fa.adv_volatility(symbol)` | SVI, variance surface, arb detection | Alpha+ |
@@ -241,6 +241,7 @@ Get your API key at **[flashalpha.com](https://flashalpha.com)**
241
241
  | `fa.greeks(...)` | BSM greeks (1st, 2nd, 3rd order) | Free+ |
242
242
  | `fa.iv(...)` | Implied volatility solver | Free+ |
243
243
  | `fa.kelly(...)` | Kelly criterion sizing | Growth+ |
244
+ | `fa.max_pain(symbol)` | Max pain analysis with dealer alignment, pain curve, pin probability | Growth+ |
244
245
  | `fa.screener(...)` | **Live options screener** — filter/rank by GEX, VRP, IV, greeks, formulas | Growth+ |
245
246
  | `fa.volatility(symbol)` | Comprehensive volatility analytics | Growth+ |
246
247
  | `fa.adv_volatility(symbol)` | SVI, variance surface, arb detection | Alpha+ |