API ReferenceQuant Signals
Deflate
/api/v3/validation/deflate- Plan
- Starter and up
- Price
- 3 credits per call
- MCP tool
deflate
Deflates a supplied Sharpe ratio using the registry's lifetime trial count — no need to pass trials yourself. Call this for a multiple-testing-honest Sharpe on work tracked by this system; use deflated_sharpe when you have your own trials and moments. Refuses rather than deflating against a count it does not have: 503 dataset_unavailable (refunded) when the registry holds no trials, 409 insufficient_trials when the family has none (pass n_trials_override, >= 1). The registered count is a FLOOR on trials actually run; the registry block names the corpus publication it came from (corpus) and the archived earlier research-loop cycles merged behind it (archive), each trial counted once. The Sharpe is read as annualised over periods_per_year (default 252).
Request body
application/json, required.
strategy_familystringRequiredRegistry family key whose lifetime trial count deflates the Sharpe.
sharpenumberRequiredThe observed annualised Sharpe (pass periods_per_year 1 for a per-period Sharpe)
n_obsintegerOptionalNumber of return periods the Sharpe was measured on.
252skewnessnumberOptional0kurtosisnumberOptionalRaw (Pearson) kurtosis of the per-period returns: a normal distribution is 3.0; excess kurtosis (pandas .kurt(), scipy's default) is 3 lower.
31 to …periods_per_yearnumberOptionalPeriods per year of the returns behind sharpe and n_obs (252 daily, 52 weekly, 12 monthly); 1 if sharpe is per-period.
2521 to …n_trials_overrideinteger or nullOptionalBypass the registry count.
1 to …Response
A 200 is a JSON envelope: ok: true and this endpoint's own fields (see Quant Signals). It carries X-Request-ID, the credit headers (X-Credits-Cost, X-Credits-Remaining, X-Credits-Receipt, X-Credits-Settlement) and the rate-limit headers.
A 200 is billed even when it holds no data (an empty list, null, found: false), so check those fields. Pricing & credits explains the credit headers.
Errors
No error is billed. The body is { "ok": false, "error", "detail", "request_; read the code from error.
| Error | Meaning |
|---|---|
400 invalid_ticker | The request is malformed, for example a ticker that is not a symbol: invalid_ticker, refused before any credit is reserved, with param naming the parameter. Not billed. |
401 unauthorized | Missing or invalid API key. |
402 plan_required | Your plan does not include this tool, you are out of credits, or your workspace's spend cap paused its keys. plan_required names the plan that unlocks the tool; usage_exceeded means the credit balance is spent; spend_cap_reached means the key is paused until the cap resets or is raised: detail names the cap and the reset, cap_usd and resets_at (ISO 8601) carry them, and doc_url links pricing and credits. Not billed. |
403 scope_denied | This API key is limited to some products and this tool is not one of them. product names the tool's product and scopes the key's products. An upgrade does not change it: use a key whose scopes include the product, or change this key's scopes. Not billed. |
404 not_found | No such resource. Not billed. |
422 validation | A parameter is missing, out of range or the wrong type; param names it. Not billed. |
429 rate_limited | Your plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed. |
503 paid_ | The data could not be served completely right now; retry later. Not billed. |
504 request_timeout | The request ran past the server's time budget; retry. Not billed. |
This table lists what the spec declares for this route. Error responses lists every code FIRM sends, with when to retry.
Guides
Read the Quant Signals guide for this endpoint's fields and examples.