flashalpha-java/llms.txt at main · FlashAlpha-lab/flashalpha-java · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# FlashAlpha Java SDK

> Java client library for the FlashAlpha options analytics API. Covers
> real-time gamma / delta / vanna / charm exposure (GEX/DEX/VEX/CHEX),
> 0DTE analytics, max pain, the live options screener, the volatility
> surface, Black-Scholes greeks (1st / 2nd / 3rd order), implied
> volatility, Kelly position sizing, the variance risk premium (VRP),
> verbal narrative summaries, and live stock + option quotes — from a
> single dependency-light Java 11+ package.

## What FlashAlpha is

FlashAlpha (https://flashalpha.com) is an options dealer-flow analytics
platform. The API computes the same dealer Greek exposures, key levels,
and 0DTE pin metrics that institutional desks watch — exposed as a flat
REST API at `https://api.flashalpha.com`. The interactive Swagger
playground lives at https://lab.flashalpha.com/swagger.

## What this SDK provides

- `FlashAlphaClient` — thin HTTP wrapper around the live REST API.
  Methods return `com.google.gson.JsonObject` so callers can navigate
  the response shape with no extra deserialization step.
- Strongly-typed response POCOs for the highest-ROI endpoints —
  `ExposureSummaryResponse`, `ZeroDteResponse`, `MaxPainResponse`,
  `VrpResponse`, `StockSummaryResponse`, `NarrativeResponse`,
  `ExposureLevelsResponse`, `PricingGreeksResponse`.
- Typed exception hierarchy — `AuthenticationException`,
  `TierRestrictedException`, `NotFoundException`, `RateLimitException`,
  `ServerException`, `FlashAlphaException`.

## Key endpoints

- `GET /v1/exposure/summary/{symbol}` — full GEX/DEX/VEX/CHEX, gamma
  flip, regime, hedging estimate, 0DTE share. (Growth+)
- `GET /v1/exposure/levels/{symbol}` — minimal key-levels view.
- `GET /v1/exposure/zero-dte/{symbol}` — same-day-expiration deep dive
  (pin risk, hedging buckets, decay, vol context, flow, levels). (Growth+)
- `GET /v1/exposure/narrative/{symbol}` — LLM-friendly verbal output.
  (Growth+)
- `GET /v1/maxpain/{symbol}` — max-pain strike, pain curve, dealer
  alignment, pin probability. (Growth+)
- `GET /v1/vrp/{symbol}` — variance risk premium with regime
  conditioning and strategy scores. (Alpha+)
- `GET /v1/stock/{symbol}/summary` — one-shot dashboard (price + vol +
  flow + exposure + macro). Authenticated = live; unauthenticated =
  previous-day cached snapshot.
- `GET /v1/pricing/greeks` — Black-Scholes theoretical + 1st/2nd/3rd
  order greeks + lambda + veta.
- `POST /v1/screener` — live options screener (filter/rank symbols by
  GEX, VRP, IV, greeks, harvest scores, custom formulas).

## Tiers (summary)

- **Free / Public** — health, surface, tickers, basic stock quotes.
- **Any** — GEX/DEX/VEX/CHEX, key levels, greeks, IV, stock summary.
- **Growth+** — exposure summary, 0DTE, narrative, max pain, option
  quotes, volatility, exposure history.
- **Alpha+** — VRP, advanced volatility (SVI, variance swap, arb checks).

Sign up for an API key at https://flashalpha.com.

## Links

- API playground: https://lab.flashalpha.com/swagger
- API key signup: https://flashalpha.com
- Other SDKs: Python (`pip install flashalpha`), JavaScript
  (`npm i flashalpha`), .NET (`dotnet add package FlashAlpha`), Go
  (`go get github.com/FlashAlpha-lab/flashalpha-go`), MCP server.