GET /v1/risk-return

Notional mid-cap risk-return research for locked breakout-band shortlists (top 3). Precomputed reward:risk coverage from 1:1.1 through 1:1000.0 in steps of 0.1 (9990 cells per hold window). Research / informational only; not financial advice.

GET /api/v1/risk-return

Daily research series for equal-weight locked top-3 shortlists in the CoinGecko rank 51-200 band. Each cell pairs a fixed stop with a take-profit at the stated reward multiple (TP = stop * rr). Coverage spans 1:1.1 through 1:1000.0 at step 0.1 (9990 precomputed points per hold window). Optional rr_min / rr_max slice the precomputed grid for smaller responses. Informational purposes only; not financial advice.

Query parameters

  • hold_days (integer, default 7, max 7|30): Hold window for the research series (7-day or 30-day grading horizon).
  • as_of (string, default latest, max YYYY-MM-DD): As-of UTC date for the research snapshot.
  • history_days (integer, default 30, max 365): Days of recommended risk-return history to include.
  • rr_min (number, default 1.1, max 1.1-1000): Optional lower bound when slicing the precomputed research grid (step 0.1).
  • rr_max (number, default 1000, max 1.1-1000): Optional upper bound when slicing the precomputed research grid (step 0.1).

Example

curl -s \
  -H "Authorization: Bearer brk_live_YOUR_KEY" \
  "https://app.breakflare.com/api/v1/risk-return?hold_days=7&history_days=30"

Response fields

meta

FieldTypeDescription
meta.productstringProduct identifier (Breakflare Data API).
meta.taglinestringShort product summary.
meta.attributionstringBreakflare attribution string.
meta.market_price_sourcestringHow thin market spot fields were sourced (CoinLore preferred when merged in the daily pipeline).
meta.docsstringURL to public API documentation.
meta.datasetsstringURL to Datasets overview (file exports; access by request).
meta.date_utcstringUTC date of the hosted daily pipeline snapshot (YYYY-MM-DD).
meta.generated_at_utcstringWhen the snapshot was generated (ISO 8601).
meta.hold_daysintegerHold window for this response.
meta.researchbooleanAlways true: notional research series.
meta.rr_coverageobjectFull research coverage: min 1.1, max 1000.0, step 0.1, points 9990.
meta.rr_minnumberLower bound of grid cells returned (after optional slice).
meta.rr_maxnumberUpper bound of grid cells returned (after optional slice).
meta.rr_stepnumberGrid step size (0.1).

grid / recommended / history

FieldTypeDescription
disclaimerstringResearch-only disclaimer (not financial advice).
grid[]object[]Risk-return cells: rr, stop_loss_pct, take_profit_pct, target_multiple, returns, vs BTC, and exit hit counts.
recommendedobject | nullBest vs-BTC cell for the as-of day within the returned slice.
history[]object[]Compact daily history of recommended risk-return cells.

Snapshot fields (price, cap, volume) align to the same UTC pipeline run as Breakflare scores. Intraday charting may need a separate live feed.