Skip to content

Commit 029078d

Browse files
tdobrowolski1claude
andcommitted
v0.3.3: add vrp() method + customer regression integration tests
Adds `vrp()` method to the SDK (was missing — customers had to build a REST fallback for /v1/vrp). Also adds 16 live-API regression tests guarding the exact response shapes and URL patterns reported by an Alpha user: - Nested VRP payload (vrp.z_score, gex_conditioned.harvest_score, regime.net_gex, directional.downside_vrp/upside_vrp) - exposure_summary nesting (exposures.net_gex) - URL prefix mix (/stockquote vs /v1/stock/{sym}/summary) - Canonical /v1/screener URL - docs/api.md — full endpoint reference Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent e6ddaa7 commit 029078d

5 files changed

Lines changed: 2294 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,35 @@
11
# Changelog
22

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+
333
## 0.2.0 (2026-03-26)
434

535
### Added

0 commit comments

Comments
 (0)